List command types

GET

/command-types

const url = 'https://example.com/api/v1/command-types';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/command-types

Lists every registered command type (official and custom). Estate-wide reference data. Gated by command_type:read.

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

command_types

required

Array<object> | null

object

$schema

A URL to the JSON Schema for this object.

string format: uri

description

string

display_name

string

required

The command type’s uuid, the stable form of name

string

name

required

string

official

required

boolean

params_schema

A JSON Schema fragment for the invocation params

settle_window_seconds

required

How long the device is given to actuate before a mismatch is a failed command

integer format: int64

target_property_type

The property this command sets (empty for a fire-and-forget command)

string

Example

{
  "$schema": "/api/v1/schemas/ListCommandTypesOutputBody.json",
  "command_types": [
    {
      "$schema": "/api/v1/schemas/CommandTypeBody.json"
    }
  ]
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}