Flow API specification (9e074e34355a5facbece3910d74e59e0e26c61fd)

Download OpenAPI specification:Download

The flow service implements the user defined GroupAlarm flow logic

Authentication

API_Token

To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

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

Personal-Access-Token

To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

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": [