Skip to content

Target Runs

APIs to manage Target Runs. Target run status descriptions

  • PENDING - Target run created.
  • QUEUED - Target run queued for processing.
  • PROCESSING - Target run received by scheduler for processing (During target run processing the command request for the target run is created).
  • DISPATCHED - Target run moves to dispatched when a command is successfully queued for the target run. (Command status - QUEUED)
  • RUNNING - Target run moves to running state when the command has been sent to the device (Command status - INITIATED, ACKNOWLEDGED, INPROGRESS)
  • COMPLETE - Target run moves to complete state when it has completed running (Command status - FAILURE, SUCCESS, TIMEOUT, CANCELLED)
  • SUCCESS - A completed target run moves to success when the associated command is successful (Command status - SUCCESS)
  • FAILURE - A completed target run moves to success when the associated command is unsuccessful (Command status - FAILED, TIMEOUT, CANCELLED)
  • CANCELLED - Target run cancelled by the user (Target runs ind Pending, Queued and Processing state can be cancelled by the user)
  • TIMEOUT - The target run has a timed out. This happens when the target run has not completed processing even after the timeout period (7 days).
  • INVALID - Target run is invalid.
Operations

Get all Target Runs for the Stage Run
Stable

Request

Security
SCAPIAuthToken
Path
stage_run_idstringrequired

Stage run Id

Query
statusstring

Status of target run

Enum:"pending""queued""processing""dispatched""running""complete""success""failure""cancelled""invalid"
stage_run_operation_idstring, (uuid)

Stage run Operation Id to filter on

orderingstring

Sorting target runs based on status field

Enum:"status""-status"
cURL
curl -i -X GET \
  'https://develop-api.esper.io/_mock/openapi/pipelines/v0/stageruns/{stage_run_id}/targetruns/?status=pending&stage_run_operation_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&ordering=status' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

All Target runs for the Stage Run

Bodyapplication/json
codeinteger
messagestring
contentobject
Response
{
  "code": 0,
  "message": "string",
  "content": {
    "count": 0,
    "previous": "string",
    "next": "string",
    "results": [ … ]
  }
}