ListWorkflowRunsQueryParamProperties interface

Package:

@azure-rest/purview-workflow

Properties

maxpagesize	The maximum page size to get the items at one time.
orderby	The key word which used to sort the results.
runStatuses	Filter workflow runs by workflow run status.
timeWindow	Time window of filtering items.
workflowIds	Filter items by workflow id list.

Property Details

maxpagesize

The maximum page size to get the items at one time.

maxpagesize?: number

Property Value

number

orderby

The key word which used to sort the results.

orderby?: "status desc" | "status asc" | "requestor desc" | "requestor asc" | "startTime desc" | "startTime asc" | "createdTime desc" | "createdTime asc"

Property Value

"status desc" | "status asc" | "requestor desc" | "requestor asc" | "startTime desc" | "startTime asc" | "createdTime desc" | "createdTime asc"

runStatuses

Filter workflow runs by workflow run status.

runStatuses?: ("InProgress" | "Failed" | "Completed" | "NotStarted" | "Canceling" | "CancellationFailed" | "Canceled" | "Pending" | "Approved" | "Rejected" | "sent" | "received" | "history")[]

Property Value

("InProgress" | "Failed" | "Completed" | "NotStarted" | "Canceling" | "CancellationFailed" | "Canceled" | "Pending" | "Approved" | "Rejected" | "sent" | "received" | "history")[]

timeWindow

Time window of filtering items.

timeWindow?: "1d" | "7d" | "30d" | "90d"

Property Value

"1d" | "7d" | "30d" | "90d"

workflowIds

Filter items by workflow id list.

workflowIds?: string[]

Property Value

string[]