Steps

List Run Steps

get

Get run steps according to query filters.

Args: step_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. auth_context: Authentication context.

Returns: The run steps according to query filters.

Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
hydratebooleanOptionalDefault: false
sort_bystringOptionalDefault: created
logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:
pageinteger · min: 1OptionalDefault: 1
sizeinteger · min: 1 · max: 10000OptionalDefault: 20
idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
createdany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
updatedany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
run_metadataany ofOptional
string[]Optional
or
nullOptional
scope_userany ofOptional
string · uuidOptional
or
nullOptional
userany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
projectany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
nameany ofOptional
stringOptional
or
nullOptional
code_hashany ofOptional
stringOptional
or
nullOptional
cache_keyany ofOptional
stringOptional
or
nullOptional
statusany ofOptional
stringOptional
or
nullOptional
start_timeany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
end_timeany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
pipeline_run_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
snapshot_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
original_step_run_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
model_version_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
modelany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
exclude_retriedany ofOptional
booleanOptional
or
nullOptional
cache_expires_atany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
cache_expiredany ofOptional
booleanOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
get
/api/v1/steps

Create Run Step

post

Create a run step.

Args: step: The run step to create. _: Authentication context.

Returns: The created run step.

Authorizations
OAuth2passwordRequired
Token URL:
Body

Request model for step runs.

userany ofOptional
string · uuidOptional
or
nullOptional
projectstring · uuidRequired
namestring · max: 255Required
start_timestring · date-timeRequired
end_timeany ofOptional
string · date-timeOptional
or
nullOptional
statusstring · enumRequired

Enum that represents the execution status of a step or pipeline run.

Possible values:
cache_keyany ofOptional
string · max: 255Optional
or
nullOptional
cache_expires_atany ofOptional
string · date-timeOptional
or
nullOptional
code_hashany ofOptional
string · max: 255Optional
or
nullOptional
docstringany ofOptional
string · max: 65535Optional
or
nullOptional
source_codeany ofOptional
string · max: 65535Optional
or
nullOptional
pipeline_run_idstring · uuidRequired
original_step_run_idany ofOptional
string · uuidOptional
or
nullOptional
parent_step_idsstring · uuid[]OptionalDeprecated
logsany ofOptional
or
nullOptional
exception_infoany ofOptional
or
nullOptional
dynamic_configany ofOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
post
/api/v1/steps

Get Step

get

Get one specific step.

Args: step_id: ID of the step to get. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: The step.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
step_idstring · uuidRequired
Query parameters
hydratebooleanOptionalDefault: true
Responses
chevron-right
200

Successful Response

application/json
get
/api/v1/steps/{step_id}

Update Step

put

Updates a step.

Args: step_id: ID of the step. step_model: Step model to use for the update.

Returns: The updated step model.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
step_idstring · uuidRequired
Body

Update model for step runs.

statusany ofOptional
string · enumOptional

Enum that represents the execution status of a step or pipeline run.

Possible values:
or
nullOptional
end_timeany ofOptional
string · date-timeOptional
or
nullOptional
exception_infoany ofOptional
or
nullOptional
cache_expires_atany ofOptional
string · date-timeOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
put
/api/v1/steps/{step_id}

Last updated

Was this helpful?