Instruction API specification (e9254df3b900bc0a30ba2a4ce31d1f4dc91cb304)

Download OpenAPI specification:Download

The instruction service implements all instruction functions for GroupAlarm

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

instruction

CreateInstruction

Creates an instruction for the passed catalog

Request Body schema: application/json
activeID
integer <int64>
alarmID
integer <int64>
catalogID
integer <int64>
description
string
directAction
any
endTime
any
endUser
integer <int64>
id
integer <int64>
name
string
nextInstructions
Array of integers <int64> [ items <int64 > ]
previousInstructions
Array of integers <int64> [ items <int64 > ]
startTime
any
startUser
integer <int64>
userComment
string

Responses

Request samples

Content type
application/json
{
  • "activeID": 0,
  • "alarmID": 0,
  • "catalogID": 0,
  • "description": "string",
  • "directAction": null,
  • "endTime": null,
  • "endUser": 0,
  • "id": 0,
  • "name": "string",
  • "nextInstructions": [
    ],
  • "previousInstructions": [
    ],
  • "startTime": null,
  • "startUser": 0,
  • "userComment": "string"
}

Response samples

Content type
application/json
{
  • "activeID": 0,
  • "alarmID": 0,
  • "catalogID": 0,
  • "description": "string",
  • "directAction": null,
  • "endTime": null,
  • "endUser": 0,
  • "id": 0,
  • "name": "string",
  • "nextInstructions": [
    ],
  • "previousInstructions": [
    ],
  • "startTime": null,
  • "startUser": 0,
  • "userComment": "string"
}

GetInstruction

Returns the instruction with the passed id

path Parameters
id
required
integer

id of the requested instruction

Responses

Response samples

Content type
application/json
{
  • "activeID": 0,
  • "alarmID": 0,
  • "catalogID": 0,
  • "description": "string",
  • "directAction": null,
  • "endTime": null,
  • "endUser": 0,
  • "id": 0,
  • "name": "string",
  • "nextInstructions": [
    ],
  • "previousInstructions": [
    ],
  • "startTime": null,
  • "startUser": 0,
  • "userComment": "string"
}

UpdateInstruction

Updates the instruction with the passed id with the passed parameters

path Parameters
id
required
integer

id of the requested instruction

Request Body schema: application/json
activeID
integer <int64>
alarmID
integer <int64>
catalogID
integer <int64>
description
string
directAction
any
endTime
any
endUser
integer <int64>
id
integer <int64>
name
string
nextInstructions
Array of integers <int64> [ items <int64 > ]
previousInstructions
Array of integers <int64> [ items <int64 > ]
startTime
any
startUser
integer <int64>
userComment
string

Responses

Request samples

Content type
application/json
{
  • "activeID": 0,
  • "alarmID": 0,
  • "catalogID": 0,
  • "description": "string",
  • "directAction": null,
  • "endTime": null,
  • "endUser": 0,
  • "id": 0,
  • "name": "string",
  • "nextInstructions": [
    ],
  • "previousInstructions": [
    ],
  • "startTime": null,
  • "startUser": 0,
  • "userComment": "string"
}

DeleteInstruction

Deletes the instruction with the passed id

path Parameters
id
required
integer

id of the requested instruction

Responses

alarm

UpdateActiveInstruction

Deletes the catalog with the passed id

path Parameters
alarmID
required
integer

id of the alarm

instructionID
required
integer

id of the alarm

Request Body schema: application/json

updated instruction

activeID
integer <int64>
alarmID
integer <int64>
catalogID
integer <int64>
description
string
directAction
any
endTime
any
endUser
integer <int64>
id
integer <int64>
name
string
nextInstructions
Array of integers <int64> [ items <int64 > ]
previousInstructions
Array of integers <int64> [ items <int64 > ]
startTime
any
startUser
integer <int64>
userComment
string

Responses

Request samples

Content type
application/json
{
  • "activeID": 0,
  • "alarmID": 0,
  • "catalogID": 0,
  • "description": "string",
  • "directAction": null,
  • "endTime": null,
  • "endUser": 0,
  • "id": 0,
  • "name": "string",
  • "nextInstructions": [
    ],
  • "previousInstructions": [
    ],
  • "startTime": null,
  • "startUser": 0,
  • "userComment": "string"
}

GetActiveCatalog

Deletes the catalog with the passed id

path Parameters
id
required
integer

id of the alarm

Responses

Response samples

Content type
application/json
{
  • "activeInstructions": [
    ],
  • "alarmID": 0,
  • "instructionCatalogID": 0,
  • "scenarioID": 0
}

catalogs

CreateCatalog

Creates a new instruction catalog with the passed values

Request Body schema: application/json

catalog payload that should be created

description
string
id
integer <int64>
Array of objects (Instruction) [ items ]
name
string
organizationID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": 0,
  • "instructions": [
    ],
  • "name": "string",
  • "organizationID": 0
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": 0,
  • "instructions": [
    ],
  • "name": "string",
  • "organizationID": 0
}

GetCatalog

Returns all paginated catalogs for the passed organization

path Parameters
id
required
integer

id of the requested catalog

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": 0,
  • "instructions": [
    ],
  • "name": "string",
  • "organizationID": 0
}

UpdateCatalog

Updates the catalog with the passed id and passed parameters

path Parameters
id
required
integer

id of the catalag

Request Body schema: application/json

catalog payload that should be created

description
string
id
integer <int64>
Array of objects (Instruction) [ items ]
name
string
organizationID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": 0,
  • "instructions": [
    ],
  • "name": "string",
  • "organizationID": 0
}

DeleteCatalog

Deletes the catalog with the passed id

path Parameters
id
required
integer

id of the catalag

Responses

GetCatalogs

Returns all paginated catalogs for the passed organization

query Parameters
organization
required
integer
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
{
  • "catalogs": [
    ],
  • "totalCatalogs": 0
}