Sign in
WorkflowRuns

Get a workflow run.

get/workflowruns/{workflowRunId}

Path parameters

workflowRunIdstring uuid required

The workflow run id.

Query parameters

api-versionstring required

Version of Purview APIs

Response

OK

idstring uuid

The workflow run id.

workflowIdstring uuid

The workflow id.

startTimestring date-time

Workflow run start time.

requestorstring uuid

The person who submitted the user request.

userRequestIdstring uuid

The user request id.

status'NotStarted' | 'InProgress' | 'Failed' | 'Completed' | 'Canceling' | 'CancellationFailed' | 'Canceled'

The status.

endTimestring date-time

The time of workflow run completed.

cancelTimestring date-time

The time of workflow run be canceled.

cancelCommentstring

The comment when cancel a workflow run.

actionDagobject required

The action DAG(Directed Acyclic Graph), it defines actual flow.

Changes