Stage Runs

APIs to manage Stage Runs. Stage run status descriptions

  • PENDING - Stage run created.
  • QUEUED - Stage run queued for processing.
  • PROCESSING - Stage run received by scheduler for processing.(Processing a stage run can involve performing the operations required before starting a stage run. In this case creating the target runs for the stage.)
  • RUNNING - Stage run has started running.
  • COMPLETE - Stage run moves to complete if all target runs are complete (target runs are complete if they are in a terminal state).
  • SUCCESS - A completed stage run moves to success if all target runs are successful.
  • FAILURE - A completed stage moves to failure if all target runs are not successful.
  • CANCELLED - Stage run cancelled by user.
  • TIMEOUT - The stage run has a timed out. This happens when the stage run has not completed processing even after the timeout period (Default 7 days).
  • INVALID - A stage run moves to invalid state when a. The associated stage has no targets. b. The associated stage has no operations.

Get all Stage Runs for the Pipeline Run

SecuritySCAPIAuthToken
Request
path Parameters
pipeline_run_id
required
string

ID of the Pipeline Run

query Parameters
status
string

Status of stage run

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

All Stage Runs for the Pipeline Run

401

Stage run get error

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

Get Pipeline Stage run by stage run Id

SecuritySCAPIAuthToken
Request
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}
Request samples
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Update a Pipeline Stage Run

SecuritySCAPIAuthToken
Request
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
required
status
string
Enum: "pending" "queued" "processing" "running" "complete" "success" "failure" "cancelled" "invalid" "timeout"
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": "pending"
}
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Get all Operations for the Stage Run

SecuritySCAPIAuthToken
Request
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
Request samples
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Get single Operation for the Stage Run

SecuritySCAPIAuthToken
Request
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}
Request samples
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}