Automation API
From SpinetiX Support Wiki
Summary information and/or updates to the documentation can be found on this page.
Contents
Introduction
The ARYA Automation API enables users to automate actions on SpinetiX ARYA™. Authentication is managed via an API key, requiring the secret key value and the account ID for all operations.
This API is available to all SpinetiX ARYA™ Enterprise accounts.
Overview
This API provides functionality to manage alerts within the SpinetiX ARYA™ platform. This API can be currently used to retrieve information about alerts, as well as Activate and Deactivate Alerts.
The API supports various HTTP methods such as PUT and GET for interacting with alert states and data.
The list of target players for each alert are to be set on SpinetiX ARYA™, the API does not allow to modify the set of target players, but returns the current list of target players.
For complete details of the API see the attached API reference, also attached is the OpenAPI 3.0 specification which can used in compatible products to facilitate integration and automatically generate client code.
Example
Here is an example of how to set a new state for an alert:
PUT/alerts/{id}/state
Sets a new state for an alert. The current state of the alert on the screen will be updated to match the new state on all assigned targets.
Request
Path Parameters
id: The ID of the alert Request Body (application/json)
{
"enabled": true
}
Response Status Code 200 (Success)
{
"enabled": true
}
For a comprehensive overview and detailed instructions, please refer to the attached technical documentation and specification at the top of this page.
See Also