Flow API specification (2.22.1)

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
graph
object (FlowFunction)
id
integer <int64>
inheritConfiguration
Array of objects (InheritParameterConfiguration)
isActive
boolean
isInheritable
boolean
isValid
boolean
name
string
organizationID
integer <int64>
parentConfiguration
Array of objects (InheritParameterConfiguration)
parentID
integer <int64>
validationError
string

Responses

201

Flow was created successfully

400

Passed flow is in the wrong format or is missing

500

Unexpected database error

post /flow
https://app.groupalarm.com/api/v1/flow

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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
Copy
Expand all Collapse all
{
  • "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
int64

Responses

200

the requested flow

500

Unexpected database error

get /flow/{flowID}
https://app.groupalarm.com/api/v1/flow/{flowID}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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
int64
Request Body schema: application/json
description
string
graph
object (FlowFunction)
id
integer <int64>
inheritConfiguration
Array of objects (InheritParameterConfiguration)
isActive
boolean
isInheritable
boolean
isValid
boolean
name
string
organizationID
integer <int64>
parentConfiguration
Array of objects (InheritParameterConfiguration)
parentID
integer <int64>
validationError
string

Responses

200

Flow was updated successfully

400

Passed flow is in the wrong format or is missing

500

Unexpected database error

put /flow/{flowID}
https://app.groupalarm.com/api/v1/flow/{flowID}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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
int64

Responses

200

Flow was deleted successfully

500

Unexpected database error

delete /flow/{flowID}
https://app.groupalarm.com/api/v1/flow/{flowID}

inheritance

GetInheritFlows

Returns the inherit flows as paginated list

path Parameters
flowID
required
int64

Responses

200

Paginated list of inherit flows

500

Unexpected database error

get /flow/{flowID}/inherit
https://app.groupalarm.com/api/v1/flow/{flowID}/inherit

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "flows":