Sign in

v2

latestOpenAPI 3.1.0raw.githubusercontent.com2024-09-26192307950.1 KB
workspaces

Get Or Create Pipeline Run

Get or create a pipeline run.

Args: workspace_name_or_id: Name or ID of the workspace. pipeline_run: Pipeline run to create. auth_context: Authentication context.

Returns: The pipeline run and a boolean indicating whether the run was created or not.

Raises: IllegalOperationError: If the workspace or user specified in the pipeline run does not match the current workspace or authenticated user.

post/api/v1/workspaces/{workspace_name_or_id}/runs/get-or-create

Path parameters

string required
OR
string uuid required

Request body

userstring uuid required
workspacestring uuid required
namestring required
deploymentstring uuid required
pipelinestring uuid nullable
orchestrator_run_idstring nullable
start_timestring date-time nullable
end_timestring date-time nullable
status'initializing' | 'failed' | 'completed' | 'running' | 'cached' required

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

client_environmentobject
orchestrator_environmentobject
trigger_execution_idstring uuid nullable
tagsstring[] nullable
model_version_idstring uuid nullable

Response

Successful Response

{"stackTrail":"paths:/api/v1/workspaces/{workspace_name_or_id}/runs/get-or-create:post:responses:200:content:application/json:schema:items","oasType":"schema","type":"unknown"}