WorkflowRunOutput interface

Package:

@azure-rest/purview-workflow

The execution of a workflow. It includes workflow action DAG at run time (action DAG snapshot), run payload, status of the entire run and other properties of a run.

Properties

actionDag	The action DAG(Directed Acyclic Graph), it defines actual flow.
cancelComment	The comment when cancel a workflow run.
cancelTime	The time of workflow run be canceled.
detail	It refers to the "detail" property of a workflow run object, which contains run context and runtime information of actions.
endTime	The time of workflow run completed.
id	The workflow run id. Value may contain a UUID
requestor	The person who submitted the user request. Value may contain a UUID
runPayload	The input of a workflow run. Align with operation in user request.
startTime	Workflow run start time.
status	The status.
userRequestId	The user request id. Value may contain a UUID
workflowId	The workflow id. Value may contain a UUID

Property Details

actionDag

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

actionDag: Record<string, unknown>

Property Value

Record<string, unknown>

cancelComment

The comment when cancel a workflow run.

cancelComment?: string

Property Value

string

cancelTime

The time of workflow run be canceled.

cancelTime?: string

Property Value

string

detail

It refers to the "detail" property of a workflow run object, which contains run context and runtime information of actions.

detail: WorkflowRunDetailOutput

Property Value

WorkflowRunDetailOutput

endTime

The time of workflow run completed.

endTime?: string

Property Value

string

id

The workflow run id.

Value may contain a UUID

id?: string

Property Value

string

requestor

The person who submitted the user request.

Value may contain a UUID

requestor?: string

Property Value

string

runPayload

The input of a workflow run. Align with operation in user request.

runPayload?: WorkflowRunRunPayloadOutput

Property Value

WorkflowRunRunPayloadOutput

startTime

Workflow run start time.

startTime?: string

Property Value

string

status

The status.

status?: "InProgress" | "Failed" | "Completed" | "NotStarted" | "Canceling" | "CancellationFailed" | "Canceled"

Property Value

"InProgress" | "Failed" | "Completed" | "NotStarted" | "Canceling" | "CancellationFailed" | "Canceled"

userRequestId

The user request id.

Value may contain a UUID

userRequestId?: string

Property Value

string

workflowId

The workflow id.

Value may contain a UUID

workflowId?: string

Property Value

string