logo
Documentation Powered by Redocly

Flow API specification (887cf3d4f37487346e33ee5d2c4aee5e8f74aa6e)

Download OpenAPI specification:Download

The flow service implements the user defined GroupAlarm flow logic

Authentication

API_Token

You can generate an API-Token in the permissions-settings of your organization. All requests will be performed in the scope of this organization. Requests regarding users will fail.

Security Scheme Type API Key
Header parameter name: API-TOKEN

Personal-Access-Token

You can generate a Personal Access Token in your profile settings. All requests will be performed as the user who created the token, with permissions as configured in each organization.

Security Scheme Type API Key
Header parameter name: Personal-Access-Token

flow

CreateFlow

Creates a flow with the passed parameters

Request Body schema: application/json
description
string
object (FlowFunction)
id
integer <int64>
Array of objects (InheritParameterConfiguration) [ items ]
isActive
boolean
isInheritable
boolean
isValid
boolean
name
string
organizationID
integer <int64>
Array of objects (InheritParameterConfiguration) [ items ]
parentID
integer <int64>
validationError
string

Responses

Request samples

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

Response samples

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

GetFlow

Returns the flow with the passed id

path Parameters
flowID
required
integer

Responses

Response samples

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

UpdateFlow

Updates a flow with the passed parameters

path Parameters
flowID
required
integer
Request Body schema: application/json
description
string
object (FlowFunction)
id
integer <int64>
Array of objects (InheritParameterConfiguration) [ items ]
isActive
boolean
isInheritable
boolean
isValid
boolean
name
string
organizationID
integer <int64>
Array of objects (InheritParameterConfiguration) [ items ]
parentID
integer <int64>
validationError
string

Responses

Request samples

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

DeleteFlow

deletes a flow with the passed id

path Parameters
flowID
required
integer

Responses

inheritance

GetInheritFlows

Returns the inherit flows as paginated list

path Parameters
flowID
required
integer

Responses

Response samples

Content type
application/json
{
  • "flows": [