ListWorkflowTasksQueryParamProperties 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.
taskStatuses	Filter workflow tasks by status.
taskTypes	Filter items by workflow task type.
timeWindow	Time window of filtering items.
viewMode	To filter user's sent, received or history workflow tasks.
workflowIds	Filter items by workflow id list.
workflowNameKeyword	The key word which could used to filter workflow item with related workflow.

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"

taskStatuses

Filter workflow tasks by status.

taskStatuses?: ("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")[]

taskTypes

Filter items by workflow task type.

taskTypes?: ("Approval" | "SimpleTask" | "approval" | "simpleTask")[]

Property Value

("Approval" | "SimpleTask" | "approval" | "simpleTask")[]

timeWindow

Time window of filtering items.

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

Property Value

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

viewMode

To filter user's sent, received or history workflow tasks.

viewMode?: string

Property Value

string

workflowIds

Filter items by workflow id list.

workflowIds?: string[]

Property Value

string[]

workflowNameKeyword

The key word which could used to filter workflow item with related workflow.

workflowNameKeyword?: string

Property Value

string