Arrays and modules

Get Arrays

get

Returns information about all arrays

Responses

200

OK

application/json

500

Internal server error

application/json

get/arrays

HTTPcURLJavaScriptPython

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

Get Array

get

Returns information for a specific array

Path parameters

arrayIDstringRequired

Array ID

Responses

200

OK

application/json

namestringOptionalExample: Stage Left

power_statusstring · enumOptionalPossible values:

400

Bad request

application/json

404

Array not found

application/json

500

Internal server error

application/json

get/arrays/{arrayID}

HTTPcURLJavaScriptPython

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

Set Array Blink

put

Changes the blink state for a specific array

Path parameters

arrayIDstringRequired

Array ID

Body

application/json

onbooleanRequired

Responses

204

No Content

No content

400

Bad request

application/json

500

Internal server error

application/json

put/arrays/{arrayID}/blink

HTTPcURLJavaScriptPython

PUT /psapi/arrays/{arrayID}/blink HTTP/1.1
Host: AAA-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "on": true
}

No content

Set Array Power State

put

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

Path parameters

arrayIDstringRequired

Array ID

Body

application/json

targetstring · enumRequiredPossible values:

Responses

204

No Content

No content

400

Bad request

application/json

500

Internal server error

application/json

put/arrays/{arrayID}/power

HTTPcURLJavaScriptPython

PUT /psapi/arrays/{arrayID}/power HTTP/1.1
Host: AAA-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "target": "on"
}

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

200

OK

application/json

500

Internal server error

application/json

get/modules

HTTPcURLJavaScriptPython

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

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

moduleIDstringRequired

Module ID

Responses

200

OK

application/json

blinkingbooleanOptional

manufacturerstringOptionalExample: HOLOPLOT

namestringOptionalExample: ABC-1234

power_statusstring · enumOptionalPossible values:

productstringOptionalExample: X1

typestringOptionalExample: MD96

400

Bad request

application/json

404

Module not found

application/json

500

Internal server error

application/json

get/modules/{moduleID}

HTTPcURLJavaScriptPython

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

Set Module Blink

put

Changes the blink state for a specific module

Path parameters

moduleIDstringRequired

Module ID

Body

application/json

onbooleanRequired

Responses

204

No Content

No content

400

Bad request

application/json

500

Internal server error

application/json

put/modules/{moduleID}/blink

HTTPcURLJavaScriptPython

PUT /psapi/modules/{moduleID}/blink HTTP/1.1
Host: AAA-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "on": true
}

No content

Set Module Power State

put

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

Path parameters

moduleIDstringRequired

Module ID

Body

application/json

targetstring · enumRequiredPossible values:

Responses

204

No Content

No content

400

Bad request

application/json

500

Internal server error

application/json

put/modules/{moduleID}/power

HTTPcURLJavaScriptPython

PUT /psapi/modules/{moduleID}/power HTTP/1.1
Host: AAA-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "target": "on"
}

No content