Skip to content
Omniglass Omniglass Omniglass

Issue a command to a component

POST
/components/{name}/commands:issue
 
curl --request POST \
  --url https://example.com/api/v1/components/example/commands:issue \
  --header 'Content-Type: application/json' \
  --data '{ "command_type": "example", "instance": "example", "params": "example", "value": "example" }'

Records a command invocation, writes a caused event, and (for a settleable command) opens an intended value the observed value settles against. Returns the computed settlement verdict. Gated by command:issue, whose scope is resolved on the component tier from that permission (not from component:read); a component outside the caller’s component:read is a non-disclosing 404, and one it can read but not command is a 403.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
name
required

The component’s name, or a dotted address (e.g. boi.17c.415a.$comp.display-1)

string

The component’s name, or a dotted address (e.g. boi.17c.415a.$comp.display-1)

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
command_type
required

The command_type to invoke

string
>= 1 characters
instance

The series discriminator (e.g. an interface), when the target is instanced

string
params

The invocation params, stored on the command and the caused event

value

The intended value for the target property (a settleable command)

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
caused_event_id
required

The caused event this command recorded

integer format: int64
command_type
required
string
id
required
integer format: int64
instance
string
settlement
required

The computed settlement verdict (none/pending/settled/failed)

string
status
required

The recorded command status (issued/settled/failed/timed-out); issued until a settle-check records the terminal outcome

string
Example 
{
  "$schema": "/api/v1/schemas/CommandOutputBody.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"
}