logo
API docs by Redocly

Flow API specification (8afb13268130ba7f8973da2cf1f3708a2f1d88f0)

Download OpenAPI specification:

The flow service implements the user defined GroupAlarm flow logic

flow

CreateFlow

Creates a flow with the passed parameters

Authorizations:
API-TOKENPersonal-Access-Token
Request Body schema: application/json
required
description
string
object (FlowFunction)
id
integer <int64>
Array of objects (InheritParameterConfiguration)
isActive
boolean
isInheritable
boolean
isPrivate
boolean
isValid
boolean
name
string
organizationID
integer <int64>
Array of objects (InheritParameterConfiguration)
parentID
integer <int64>
validationError
string
validationKey
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "graph": {
    },
  • "id": 0,
  • "inheritConfiguration": [
    ],
  • "isActive": true,
  • "isInheritable": true,
  • "isPrivate": true,
  • "isValid": true,
  • "name": "string",
  • "organizationID": 0,
  • "parentConfiguration": [
    ],
  • "parentID": 0,
  • "validationError": "string",
  • "validationKey": "string"
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "graph": {
    },
  • "id": 0,
  • "inheritConfiguration": [
    ],
  • "isActive": true,
  • "isInheritable": true,
  • "isPrivate": true,
  • "isValid": true,
  • "name": "string",
  • "organizationID": 0,
  • "parentConfiguration": [
    ],
  • "parentID": 0,
  • "validationError": "string",
  • "validationKey": "string"
}

GetFlow

Returns the flow with the passed id

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
flowID
required
integer

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "graph": {
    },
  • "id": 0,
  • "inheritConfiguration": [
    ],
  • "isActive": true,
  • "isInheritable": true,
  • "isPrivate": true,
  • "isValid": true,
  • "name": "string",
  • "organizationID": 0,
  • "parentConfiguration": [
    ],
  • "parentID": 0,
  • "validationError": "string",
  • "validationKey": "string"
}

UpdateFlow

Updates a flow with the passed parameters

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
flowID
required
integer
Request Body schema: application/json
description
string
object (FlowFunction)
id
integer <int64>
Array of objects (InheritParameterConfiguration)
isActive
boolean
isInheritable
boolean
isPrivate
boolean
isValid
boolean
name
string
organizationID
integer <int64>
Array of objects (InheritParameterConfiguration)
parentID
integer <int64>
validationError
string
validationKey
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "graph": {
    },
  • "id": 0,
  • "inheritConfiguration": [
    ],
  • "isActive": true,
  • "isInheritable": true,
  • "isPrivate": true,
  • "isValid": true,
  • "name": "string",
  • "organizationID": 0,
  • "parentConfiguration": [
    ],
  • "parentID": 0,
  • "validationError": "string",
  • "validationKey": "string"
}

DeleteFlow

deletes a flow with the passed id

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
flowID
required
integer

Responses

inheritance

GetInheritFlows

Returns the inherit flows as paginated list

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
flowID
required
integer

Responses

Response samples

Content type
application/json
{
  • "flows": [
    ],
  • "totalFlows": 0
}

flows

GetPaginatedFlows

Returns all paginated flows for the passed organization

Authorizations:
API-TOKENPersonal-Access-Token
query Parameters
organizationID
required
integer

id of organization

limit
integer [ 1 .. 50 ]
Default: 10

limits alarm list output to passed amount.

offset
integer
Default: 0

defines the offset for pagination

Responses

Response samples

Content type
application/json
{
  • "flows": [
    ],
  • "totalFlows": 0
}

insights

GetPaginatedInsights

Returns the paginated insights for the passed flow id

Authorizations:
API-TOKENPersonal-Access-Token
query Parameters
flowID
required
integer
limit
integer
offset
integer

Responses

Response samples

Content type
application/json
{
  • "totalFlows": 0,
  • "triggeredFlows": [
    ]
}

GetInsight

Returns the insight for the passed id

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
insightsID
required
integer

Responses

Response samples

Content type
application/json
{
  • "configuredFlowID": 0,
  • "endDate": null,
  • "graph": {
    },
  • "id": 0,
  • "organizationID": 0,
  • "startDate": null,
  • "triggeredFunctions": [
    ]
}

GetInsightUpdates

Open a secure websocket connection to receive immediate updates about insight updates

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
insightsID
required
integer

Responses

notification

Returns the stored set of notification email-addresses for this organization.

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
organizationID
required
integer

Responses

Response samples

Content type
application/json
{
  • "emails": [
    ]
}

Creates or updates the stored set of notification email-addresses for this organization.

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
organizationID
required
integer
Request Body schema: application/json
required
emails
Array of strings

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ]
}

registry

GetFunctionRegistry

Returns all available functions for the flow builder

Authorizations:
API-TOKENPersonal-Access-Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

trigger

GetTriggerConfiguration

Returns the system configuration for uuid-based triggers

Authorizations:
API-TOKENPersonal-Access-Token
query Parameters
flowID
required
integer
trigger
required
string
Enum: "http" "email"

e.g. http or email

Responses

TestIMAPConfiguration

Tests the passed imap configuration mailbox

Authorizations:
API-TOKENPersonal-Access-Token
Request Body schema: application/json
required

mailbox configuration

creationDate
any
deleteMailAfterProcessing
boolean
flowID
integer <int64>
id
integer <int64>
mailboxName
string
password
string
port
integer <int64>
server
string
username
string

Responses

Request samples

Content type
application/json
{
  • "creationDate": null,
  • "deleteMailAfterProcessing": true,
  • "flowID": 0,
  • "id": 0,
  • "mailboxName": "string",
  • "password": "string",
  • "port": 0,
  • "server": "string",
  • "username": "string"
}

TestWebsocketConfiguration

Tests the passed websocket configuration

Authorizations:
API-TOKENPersonal-Access-Token
Request Body schema: application/json
required

websocket configuration

certificateCert
string
certificateKey
string
certificatesCA
string
creationDate
any
flowID
integer <int64>
Array of objects (WebsocketHeaderField)
id
integer <int64>
skipTLSVerification
boolean
url
string

Responses

Request samples

Content type
application/json
{
  • "certificateCert": "string",
  • "certificateKey": "string",
  • "certificatesCA": "string",
  • "creationDate": null,
  • "flowID": 0,
  • "headers": [
    ],
  • "id": 0,
  • "skipTLSVerification": true,
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "connectionError": "string",
  • "receivedMessages": [
    ],
  • "receivingError": "string"
}

events

GetEvents

Returns an array of strings naming the requested events for the given service name

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
serviceName
required
string

serviceName from which the events to return

Responses