System API
Description
TLs in Kaizen can be grouped together to form systems. Querying Systems can be used to retrieve Subordinate_Tags, and Subordinate_List, amongst other information detailed below. To know more about systems, click here.
Query Type
GET
Query Header
| Key | | Value | Description |
| Authorization | Required | Bearer access_token_ | This Query requires the JWT token. To know how to get JWT token, click here |
Query Parameters
| Key | | Value | Description |
| building | Required | 1234 | This is the ID of the building whose system is being queried. Click here to identify the id of the building. |
| group-subordinates | Required | false | This key requires a boolean value. Set this key to false if you want the subordinates in raw format and true if you want the subordinates grouped. Navigate to the queries given below to see how this parameter can be used. |
| paginated | Optional | true | This key requires a boolean value as well. Set this key to true when using queries with multiple pages. |
| page_size | Optional | 100 | Kaizen’s API uses pagination, by default the page size is set to 50. To change the number of pages per query, set this field to the required number. The maximum size of the page is 1000. |
| page_number | Required for queries with count>page_size | 3 | If the number of buildings is greater than the page size, to reach all the buildings, use the page number to reach all points. |
| include-points | Optional | False | This is a boolean field that is set to True by default. Queries include point names and details. If only system names are required, set include points to false. |
Query URL
To retrieve all systems in raw format from Kaizen:
https://kaizen.coppertreeanalytics.com/yana/mongo/systems/?paginated=true&group-subordinates=false&building=<building_id>&page_size=10&page=1
To retrieve all systems in raw format from Kaizen-east:
https://kaizen-east.coppertreeanalytics.com/yana/mongo/systems/?paginated=true&group-subordinates=false&building=<building_id>&page_size=10&page=1
To retrieve systems with grouped subordinates from Kaizen:
https://kaizen.coppertreeanalytics.com/yana/mongo/systems/?paginated=true&group-subordinates=true&building=<building_id>&page_size=10&page=1
To retrieve systems with grouped subordinates from Kaizen-east:
https://kaizen-east.coppertreeanalytics.com/yana/mongo/systems/?paginated=true&group-subordinates=true&building=<building_id>&page_size=10&page=1
To retrieve systems in a tree format from Kaizen:
https://kaizen.coppertreeanalytics.com/yana/mongo/systems-tree/?building=<building_id>&include-points=False
To retrieve systems in a tree format from Kaizen-east:
https://kaizen-east.coppertreeanalytics.com/yana/mongo/systems-tree/?building=<building_id>&include-points=False
To retrieve all systems with subordinates in the tree format from Kaizen:
https://kaizen.coppertreeanalytics.com/yana/mongo/systems-tree/?building=<building_id>&include-points=True
To retrieve all systems with subordinates in the tree format from Kaizen-east:
https://kaizen-east.coppertreeanalytics.com/yana/mongo/systems-tree/?building=<building_id>&include-points=True
Response
The response depends on the query posted, but the following are the main components of the response.
| Field | Description |
| links | Contains URLs for the first page, the last page and the next page of the query. |
| meta | Contains pagination data, the total count of results, the current page number, the page size, and the total number of pages |
| results | This field contains a description, the name of the node the system is a part of, the object name, the object identifier, the subordinate information (Depending on the query used), the tags for the system, the ID of the system used, the building ID denoted in ‘d’, the time stamp and the value. |
Related Queries
From the system query, the subordinates, TL, and building information are available. This can be used to query other endpoints.