Target Runs

APIs to manage Target Runs

Get all Target Runs for the Stage Run

Request
Security:
path Parameters
stage_run_id
required
string

Stage run Id

query Parameters
status
string

Status of target run

Enum: "queued" "processing" "dispatched" "running" "complete" "success" "failure" "cancelled" "invalid"
stage_run_operation_id
string <uuid>

Stage run Operation Id to filter on

Responses
200

All Target runs for the Stage Run

401

Target run get error

get/v0/stageruns/{stage_run_id}/targetruns/
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Create a Target Runs for Stage Run

Request
Security:
path Parameters
stage_run_id
required
string

Stage run Id

Request Body schema: application/json
target_id
required
string <uuid>
device_name
string
device_alias
string
Responses
200

Created Target Runs

401

Target Run create error

post/v0/stageruns/{stage_run_id}/targetruns/
Request samples
application/json
{
  • "target_id": "d3bcdc92-4191-401b-ad0c-42056c6efab9",
  • "device_name": "string",
  • "device_alias": "string"
}
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": [
    ]
}

Get Target Run by Target Run ID

Request
Security:
path Parameters
stage_run_id
required
string

Stage run Id

target_run_id
required
string

Id of the Target Run

Responses
200

Get target run

401

Operation get error

get/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Update a Target Run

Request
Security:
path Parameters
stage_run_id
required
string

Stage run Id

target_run_id
required
string

Id of the target run

Request Body schema: application/json
status
string
Enum: "queued" "processing" "dispatched" "running" "complete" "success" "failure" "cancelled" "invalid"
device_name
string
Responses
200

Updated Target Run run information

400

Target Run update error

401

Target Run update error

put/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/
Request samples
application/json
{
  • "status": "queued",
  • "device_name": "string"
}
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Get status of the command running for Target run

Request
Security:
path Parameters
stage_run_id
required
string

ID of the stage run

target_run_id
required
string

Id of the target run

Responses
200

command processor request status

401

Command request create error

get/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": { }
}

Create an command processor request for Target Run

Request
Security:
path Parameters
stage_run_id
required
string

ID of the stage run

target_run_id
required
string

Id of the target run

Request Body schema: application/json
object (CommandRequest)
Responses
200

Created command processor request

401

Command request create error

post/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/
Request samples
application/json
{ }
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": { }
}