v1

latestOpenAPI 3.1.0raw.githubusercontent.com2024-09-27192307552.2 KB
pipelines

List Pipeline Runs

Get pipeline runs according to query filters.

Args: pipeline_run_filter_model: Filter model used for pagination, sorting, filtering hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: The pipeline runs according to query filters.

get/api/v1/pipelines/{pipeline_id}/runs

Path parameters

string uuid required
OR
string required

Query parameters

hydrateboolean
sort_bystring
logical_operator'or' | 'and'

Logical Ops to use to combine filters on list methods.

pageinteger
sizeinteger
string uuid
OR
string
string date-time
OR
string
string date-time
OR
string
scope_workspacestring uuid nullable
tagstring nullable
namestring nullable
orchestrator_run_idstring nullable
pipeline_namestring nullable
string uuid
OR
string
string uuid
OR
string
string uuid
OR
string
string uuid
OR
string
string uuid
OR
string
string uuid
OR
string
string uuid
OR
string
string uuid
OR
string
statusstring nullable
string date-time
OR
string
string date-time
OR
string
unlistedboolean nullable

Response

Successful Response

indexinteger required
max_sizeinteger required
total_pagesinteger required
totalinteger required