Workflow Status API (0.1)

Download OpenAPI specification:Download

Provides the statuses of asynchronous workflow jobs throughout the Model-Prime platform. Jobs may have one or more stages.

See our Getting Started guide for more detailed information on how to use our APIs.

status

Obtains the status of a workflow job or job stage.

Lists the statuses of workflow jobs and job stages.

Lists a page of stages for workflow jobs which are themselves paginated. Any jobs with more than one page of stages will only return the first page of job stages.

query Parameters

job_name	string The job name used to filter results.
page_number	integer >= 1 Default: 1 The page offset of the job stage results.
page_size	integer >= 0 Default: 50 The maximum number of job stages to return.
attribute	string The name of the attribute used to filter results.
value	string The value(s) of the attribute used to filter results. This can be a comma separated list of values.
period	string A duration of time to be used as the size of each bin in the response. A period is formatted as a sequence of decimal numbers with a unit suffix, such as "300ms", "1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", or "w".

Responses

Response samples

200

Content type

application/json

{"count": 0,
"items": [{"attributes": {"property1": "string",
"property2": "string"
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"stages": [{"error": {"message": "string",
"resolution": "string"
},
"finished_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parents": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"started_at": "2019-08-24T14:15:22Z",
"status": "initializing"
}
],
"status": "initializing"
}
]
}

Lists a page of workflow jobs and job stages with the specified status.

Lists a page of jobs and stages with the specified status. Any jobs with more than one page of stages will only return the first page of stages.

path Parameters

status

string (JobStatusCode)

Enum: "initializing" "pending" "running" "paused" "failed" "succeeded" "cancelled" "skipped"

The job status used to filter results.

query Parameters

job_name	string The job name used to filter results.
period	string A duration of time to be used as the size of each bin in the response. A period is formatted as a sequence of decimal numbers with a unit suffix, such as "300ms", "1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", or "w".
page_number	integer >= 1 Default: 1 The page offset of the job stage results.
page_size	integer >= 0 Default: 50 The maximum number of job stages to return.

Responses

Response samples

200

Content type

application/json

{"count": 0,
"items": [{"attributes": {"property1": "string",
"property2": "string"
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"stages": [{"error": {"message": "string",
"resolution": "string"
},
"finished_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parents": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"started_at": "2019-08-24T14:15:22Z",
"status": "initializing"
}
],
"status": "initializing"
}
]
}

Returns the status for the specified workflow job.

Returns the status for the specified workflow job. The status of a job is determined by the aggregate status of the stages defined for the job. If all stages are complete, the job is complete. If any stage is in progress, the job is in progress. If all stages are pending, the job is pending. If any stage is failed, the job is failed.

path Parameters

id

required

string <uuid>

The ID of the specified job.

Responses

Response samples

200

Content type

application/json

{"attributes": {"property1": "string",
"property2": "string"
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"stages": [{"error": {"message": "string",
"resolution": "string"
},
"finished_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parents": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"started_at": "2019-08-24T14:15:22Z",
"status": "initializing"
}
],
"status": "initializing"
}

Returns the status of the specified job stage.

Returns the status of the specified job stage. Once a stage is marked as started/in progress, it will not change status until it succeeds or fails. Failures and their resolutions are reported in the error field of the stage status.

path Parameters

id required	string <uuid> The ID of the specified job.
stage_id required	string <uuid> The ID of the specified job stage.

Responses

Response samples

200

Content type

application/json

{"error": {"message": "string",
"resolution": "string"
},
"finished_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"parents": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"started_at": "2019-08-24T14:15:22Z",
"status": "initializing"
}

statistics

Gets the statistics for jobs within periods

Lists the statistics for jobs and stages for the specified period.

query Parameters

job_name	string The job name used to filter results.
period	string A duration of time to be used as the size of each bin in the response. A period is formatted as a sequence of decimal numbers with a unit suffix, such as "300ms", "1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", or "w".
page_number	integer >= 1 Default: 1 The page offset of the job stage results.
page_size	integer >= 0 Default: 50 The maximum number of job stages to return.

Responses

Response samples

200

Content type

application/json

{"count": 0,
"items": [{"ending_at": "2019-08-24T14:15:22Z",
"failed": 0,
"running": 0,
"starting_at": "2019-08-24T14:15:22Z",
"succeeded": 0,
"total": 0
}
]
}