Arrays and modules

Get Arrays

get

Returns information about all arrays

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://AAA-1234.local/psapi/arrays'

200

500

200

{
  "ANY_ADDITIONAL_PROPERTY": {
    "health": {
      "message": "Okay",
      "status": "okay"
    },
    "modules": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "Stage Left",
    "power_status": "awake"
  }
}

OK

Get Array

get

Returns information for a specific array

Path parameters

arrayIDanyrequired

Array ID

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://AAA-1234.local/psapi/arrays/{arrayID}'

200

400

404

500

200

{
  "health": {
    "message": "Okay",
    "status": "okay"
  },
  "modules": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "name": "Stage Left",
  "power_status": "awake"
}

OK

Set Array Blink

put

Changes the blink state for a specific array

Path parameters

arrayIDanyrequired

Array ID

Body

onbooleanrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'http://AAA-1234.local/psapi/arrays/{arrayID}/blink' \
  --header 'Content-Type: application/json' \
  --data '{
    "on": true
  }'

204

400

500

204

No body

No Content

Set Array Power State

put

Changes the target power state for the array, allowed values are "on" and "sleep"

Path parameters

arrayIDanyrequired

Array ID

Body

targetall ofrequired

Example: on

Available options:

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'http://AAA-1234.local/psapi/arrays/{arrayID}/power' \
  --header 'Content-Type: application/json' \
  --data '{
    "target": "on"
  }'

204

400

500

204

No body

No Content

Get Modules

get

Returns information about all modules.If a module is not paired, the field "name" will be an empty string.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://AAA-1234.local/psapi/modules'

200

500

200

{
  "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"
  }
}

OK

Get Module

get

Returns information for a specific module.If a module is not paired, the field "name" will be an empty string.

Path parameters

moduleIDanyrequired

Module ID

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://AAA-1234.local/psapi/modules/{moduleID}'

200

400

404

500

200

{
  "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"
}

OK

Set Module Blink

put

Changes the blink state for a specific module

Path parameters

moduleIDanyrequired

Module ID

Body

onbooleanrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'http://AAA-1234.local/psapi/modules/{moduleID}/blink' \
  --header 'Content-Type: application/json' \
  --data '{
    "on": true
  }'

204

400

500

204

No body

No Content

Set Module Power State

put

Changes the target power state for the module, allowed values are "on" and "sleep"

Path parameters

moduleIDanyrequired

Module ID

Body

targetall ofrequired

Example: on

Available options:

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'http://AAA-1234.local/psapi/modules/{moduleID}/power' \
  --header 'Content-Type: application/json' \
  --data '{
    "target": "on"
  }'

204

400

500

204

No body

No Content