Skip to content
Omniglass Omniglass Omniglass

Update a command type

PATCH
/command-types/{name}
 
curl --request PATCH \
  --url https://example.com/api/v1/command-types/example \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "label": "example", "params_schema": "example", "settle_window_seconds": 1, "target_metric_type": "example", "target_property_type": "example" }'

Patches a custom command type’s label, description, params schema, settle window, or target on either arm (a nil field is unchanged; an empty target clears it; a non-empty arm clears the other). The name is fixed at creation. Official types are read-only. Gated by command_type:update.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
name
required

The command type’s name

string

The command type’s name

Request Body required

Section titled “Request Body required ”
Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
description

What the command does

string
label

A human label

string
params_schema

A JSON Schema fragment (replaces wholesale)

settle_window_seconds

The actuation window in seconds, floored at 0 (a duration has no negative; 0 means settle immediately)

integer format: int64
target_metric_type

The metric this command sets (empty clears it; a non-empty arm clears the other)

string
target_property_type

The property this command sets (empty clears it; a non-empty arm clears the other)

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
description
string
id
required

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

string
label
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_metric_type

The metric this command sets (the other arm of the arc; never set together with target_property_type)

string
target_property_type

The property this command sets (one arm of the exclusive target arc; empty for fire-and-forget or a metric target)

string
Example 
{
  "$schema": "/api/v1/schemas/CommandTypeBody.json"
}

default

Section titled “default ”

Error

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