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.

Operations

Get all Stage Runs for the Pipeline Run
Stable

Request

Security

SCAPIAuthToken

Path

pipeline_run_idstringrequired

ID of the Pipeline Run

Query

statusstring

Status of stage run

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

cURL

curl -i -X GET \
  'https://develop-api.esper.io/_mock/openapi/pipelines/v0/runs/{pipeline_run_id}/stageruns/?status=pending' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

All Stage Runs for the Pipeline Run

Bodyapplication/json

codeinteger

messagestring

contentobject

Response

{
  "code": 0,
  "message": "string",
  "content": {
    "count": 0,
    "previous": "string",
    "next": "string",
    "results": [ … ]
  }
}