Stage Runs

APIs to manage Stage Runs

Get all Stage Runs for the Pipeline Run

Request
Security:
path Parameters
pipeline_run_id
required
string

ID of the Pipeline Run

query Parameters
status
string

Status of stage run

Enum: "queued" "processing" "dispatched" "running" "complete" "success" "failure" "cancelled" "invalid"
Responses
200

All Stage Runs for the Pipeline Run

401

Stage run get error

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

Get Pipeline Stage run by stage run Id

Request
Security:
path Parameters
pipeline_run_id
required
string

ID of the Pipeline Run

stage_run_id
required
string

ID of pipeline stage run

Responses
200

Get pipeline run stage run

401

Operation get error

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

Update a Pipeline Stage Run

Request
Security:
path Parameters
pipeline_run_id
required
string

ID of the Pipeline Run

stage_run_id
required
string

id of pipeline stage run

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

Updated Pipeline Stage run information

400

Pipeline Stage Run update error

401

Pipeline Stage Run update error

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

Get all Operations for the Stage Run

Request
Security:
path Parameters
stage_run_id
required
string

Stage run Id

Responses
200

All Operations for the Stage Run

401

Stage run operation get error

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

Get single Operation for the Stage Run

Request
Security:
path Parameters
stage_run_id
required
string

Stage run Id

stage_run_operation_id
required
string

Stage run operation Id

Responses
200

Operation for the Stage Run

401

Stage run operation get error

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