Last updated 29 days ago
Was this helpful?
Returns information about all arrays
GET /psapi/arrays HTTP/1.1 Host: aaa-1234.local Accept: */*
OK
{ "ANY_ADDITIONAL_PROPERTY": { "health": { "message": "Okay", "status": "okay" }, "modules": { "ANY_ADDITIONAL_PROPERTY": "text" }, "name": "Stage Left", "power_status": "awake" } }
Returns information for a specific array
Array ID
GET /psapi/arrays/{arrayID} HTTP/1.1 Host: aaa-1234.local Accept: */*
{ "health": { "message": "Okay", "status": "okay" }, "modules": { "ANY_ADDITIONAL_PROPERTY": "text" }, "name": "Stage Left", "power_status": "awake" }
Returns information about all modules.If a module is not paired, the field "name" will be an empty string.
GET /psapi/modules HTTP/1.1 Host: aaa-1234.local Accept: */*
{ "ANY_ADDITIONAL_PROPERTY": { "blinking": false, "manufacturer": "HOLOPLOT", "name": "ABC-1234", "position": { "front_direction": { "x": 1, "y": 2, "z": 3 }, "position": { "x": 1, "y": 2, "z": 3 }, "up_direction": { "x": 1, "y": 2, "z": 3 } }, "power_status": "awake", "product": "X1", "type": "MD96" } }
Returns information for a specific module.If a module is not paired, the field "name" will be an empty string.
Module ID
GET /psapi/modules/{moduleID} HTTP/1.1 Host: aaa-1234.local Accept: */*
{ "blinking": false, "manufacturer": "HOLOPLOT", "name": "ABC-1234", "position": { "front_direction": { "x": 1, "y": 2, "z": 3 }, "position": { "x": 1, "y": 2, "z": 3 }, "up_direction": { "x": 1, "y": 2, "z": 3 } }, "power_status": "awake", "product": "X1", "type": "MD96" }
Changes the blink state for a specific array
PUT /psapi/arrays/{arrayID}/blink HTTP/1.1 Host: aaa-1234.local Content-Type: application/json Accept: */* Content-Length: 11 { "on": true }
No Content
No content
Changes the target power state for the array, allowed values are "on" and "sleep"
on
unknown
sleep
PUT /psapi/arrays/{arrayID}/power HTTP/1.1 Host: aaa-1234.local Content-Type: application/json Accept: */* Content-Length: 15 { "target": "on" }
Changes the blink state for a specific module
PUT /psapi/modules/{moduleID}/blink HTTP/1.1 Host: aaa-1234.local Content-Type: application/json Accept: */* Content-Length: 11 { "on": true }
Changes the target power state for the module, allowed values are "on" and "sleep"
PUT /psapi/modules/{moduleID}/power HTTP/1.1 Host: aaa-1234.local Content-Type: application/json Accept: */* Content-Length: 15 { "target": "on" }