Arrays and modules
Returns information about all arrays
Responses
200
OK
application/json
500
Internal server error
application/json
get
GET /psapi/arrays HTTP/1.1
Host: aaa-1234.local
Accept: */*
{
"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
Path parameters
arrayIDstringRequired
Array ID
Responses
200
OK
application/json
400
Bad request
application/json
404
Array not found
application/json
500
Internal server error
application/json
get
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"
}
Changes the blink state for a specific array
Path parameters
arrayIDstringRequired
Array ID
Body
onbooleanRequired
Responses
204
No Content
400
Bad request
application/json
500
Internal server error
application/json
put
PUT /psapi/arrays/{arrayID}/blink HTTP/1.1
Host: aaa-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 11
{
"on": true
}
No content
Changes the target power state for the array, allowed values are "on" and "sleep"
Path parameters
arrayIDstringRequired
Array ID
Body
targetall ofRequiredExample:
on
Possible values: string · enumOptionalPossible values:
Responses
204
No Content
400
Bad request
application/json
500
Internal server error
application/json
put
PUT /psapi/arrays/{arrayID}/power HTTP/1.1
Host: aaa-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"target": "on"
}
No content
Returns information about all modules.If a module is not paired, the field "name" will be an empty string.
Responses
200
OK
application/json
500
Internal server error
application/json
get
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.
Path parameters
moduleIDstringRequired
Module ID
Responses
200
OK
application/json
400
Bad request
application/json
404
Module not found
application/json
500
Internal server error
application/json
get
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 module
Path parameters
moduleIDstringRequired
Module ID
Body
onbooleanRequired
Responses
204
No Content
400
Bad request
application/json
500
Internal server error
application/json
put
PUT /psapi/modules/{moduleID}/blink HTTP/1.1
Host: aaa-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 11
{
"on": true
}
No content
Changes the target power state for the module, allowed values are "on" and "sleep"
Path parameters
moduleIDstringRequired
Module ID
Body
targetall ofRequiredExample:
on
Possible values: string · enumOptionalPossible values:
Responses
204
No Content
400
Bad request
application/json
500
Internal server error
application/json
put
PUT /psapi/modules/{moduleID}/power HTTP/1.1
Host: aaa-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"target": "on"
}
No content
Last updated
Was this helpful?