Messaging API specification (887cf3d4f37487346e33ee5d2c4aee5e8f74aa6e)

Download OpenAPI specification:Download

The message service is used to manage messages.

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

user

SetUserEscalation

Creates or updates an existing escalation configuration for the passed user

Request Body schema: application/json

new escalation configuration

required	Array of objects (Escalation) [ items ] configured escalations
organizationID	integer <int64> organization id for editing escalation as an organization administrator
userID	integer <int64> assigned user for this escalation configuration for organization administrator editing

Responses

Request samples

Payload

Content type

application/json

{"escalations": [{"delay": 0,
"wayofalarm": "string"
}
],
"organizationID": 0,
"userID": 0
}

Response samples

200

Content type

application/json

{"message": "escalation saved"
}

GetUserEscalation

Returns the escalation configuration for the passed user

path Parameters

userID

required

integer

user id for the requested escalation

query Parameters

organization_id

integer

has to be set if you want to edit a user as admin of an organization

Responses

Response samples

200

Content type

application/json

{"escalations": [{"delay": 0,
"wayofalarm": "string"
}
],
"organizationID": 0,
"userID": 0
}

escalation

SetOrganizationEscalation

Sets the escalation configuration for the given organization

Request Body schema: application/json

new escalation configuration

required	Array of objects (Escalation) [ items ] configured escalations
organizationID	integer <int64> organization id for editing escalation as an organization administrator
userID	integer <int64> assigned user for this escalation configuration for organization administrator editing

Responses

Request samples

Payload

Content type

application/json

{"escalations": [{"delay": 0,
"wayofalarm": "string"
}
],
"organizationID": 0,
"userID": 0
}

GetOrganizationEscalation

Returns the escalation configuration for the given organization

path Parameters

organizationID

required

integer

organizationID for the requested escalation

Responses

Response samples

200

Content type

application/json

{"escalations": [{"delay": 0,
"wayofalarm": "string"
}
],
"organizationID": 0,
"userID": 0
}

RemoveOrganizationEscalation

Removes the escalation configuration for the given organization

path Parameters

organizationID

required

integer

organizationID for the requested escalation

Responses

Response samples

200

Content type

application/json

{"escalations": [{"delay": 0,
"wayofalarm": "string"
}
],
"organizationID": 0,
"userID": 0
}

alarm

GetAlarmMessageStatus

Returns the current alarm message status for the user in the given alarm

path Parameters

alarm_id

required

integer

alarmID this request is about

query Parameters

organization_id required	integer associated organization requesting the information (used for rbac-check)
user_id required	integer requested user status

Responses

Response samples

200

Content type

application/json

{"devices": [{"date": null,
"name": "string",
"noDate": null,
"status": 0,
"type": "string",
"yesDate": null
}
],
"messageId": "string"
}

feedback

Sets the user feedback for a specific alarm or organization using the api.

You can use a JWT Token or Personal Access Token to update a specific user's feedback in an alarm or organization. You can also use an organization api token to update any user's feedback in an alarm or your organization.

Request Body schema: application/json

the users feedback

alarmID	integer <int64> AlarmID associated to the feedback
organizationID	integer <int64> OrganizationID associated to the feedback
response required	boolean Response should be `true` if the user gave positive feedback and `false` if not
userID required	integer <int64> UserID of the user that is sending this feedback

Responses

Request samples

Payload

Content type

application/json

{"alarmID": 0,
"organizationID": 0,
"response": true,
"userID": 0
}

Response samples

200

Content type

application/json

{"success": true
}

organization

Returns the response-timeout after which a notified user times out and can no longer answer an alarm in the organization.

path Parameters

organizationID

required

integer

Responses

Response samples

200

Content type

application/json

{"timeout": 10
}

Sets the response-timeout after which a notified user times out and can no longer answer an alarm in the organization.

path Parameters

organizationID

required

integer

Request Body schema: application/json

organization timeout configuration

timeout

required

integer <int64> [ 10 .. 86400 ]

Time in seconds after which a notified user times out and can no longer answer an alarm.

Responses

Request samples

Payload

Content type

application/json

{"timeout": 10
}

Response samples

200

Content type

application/json

{"timeout": 10
}