logo
API docs by Redocly

Instruction API specification (8463bfe9046a41ee0886be3bdd26fb7f58972a3c)

Download OpenAPI specification:Download

The instruction-service is used to configure and manage instructions in alarms.

instruction

CreateInstruction

Creates an instruction for the passed catalog

Authorizations:
API_TokenPersonal-Access-Token
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

Authorizations:
API_TokenPersonal-Access-Token
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

Authorizations:
API_TokenPersonal-Access-Token
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

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of the requested instruction

Responses

alarm

UpdateActiveInstruction

Deletes the catalog with the passed id

Authorizations:
API_TokenPersonal-Access-Token
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

Authorizations:
API_TokenPersonal-Access-Token
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

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json

catalog payload that should be created

description
string
id
integer <int64>
Array of objects (Instruction)
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

Authorizations:
API_TokenPersonal-Access-Token
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

Authorizations:
API_TokenPersonal-Access-Token
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)
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

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of the catalag

Responses

GetCatalogs

Returns all paginated catalogs for the passed organization

Authorizations:
API_TokenPersonal-Access-Token
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
}