Skip to content

Create an command processor request for Target Run
Stable

Request

Issues the device command processor request for a Target Run.

Triggers dispatch of the underlying device command associated with this Target Run, typically as part of the pipeline engine's normal execution flow.

About Target Run Command Each Target Run corresponds to a command dispatched to a device. This endpoint creates that command-processor request; it is primarily used internally by the pipeline execution flow rather than called ad hoc.

Key Fields / Query Parameters

  • stage_run_id — UUID of the parent Stage Run
  • target_run_id — UUID of the Target Run to dispatch a command for
Security
pipelines_SCAPIAuthToken
Path
stage_run_idstringrequired

ID of the stage run

target_run_idstringrequired

Id of the target run

Bodyapplication/jsonrequired
object(pipelines_PipelineRun_POST)
cURL
curl -i -X POST \
  'https://develop-api.esper.io/_mock/openapi/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Created command processor request

Bodyapplication/json
codeinteger
messagestring
contentobject(pipelines_CommandResponse)
Response
{
  "code": 0,
  "message": "string",
  "content": {
    "target_run_id": "0f2ab1df-1de3-4f85-b0b8-63282bf0d88f",
    "operation_id": "cb4ede3c-a5d1-45e3-a9d2-fe83accbce52",
    "enterprise_id": "2dbe425a-b3bc-4170-8bae-9e5391aafea6",
    "command": "string",
    "command_type": "DEVICE",
    "device_type": "all",
    "device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940",
    "schedule": "IMMEDIATE",
    "args": {},
    "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
    "request_status": "string",
    "request_status_reason": "string"
  }
}