WorkflowTasksClient Class

Package:

com.azure.analytics.purview.workflow

Maven Artifact:

com.azure:azure-analytics-purview-workflow:1.0.0-beta.2

• java.lang.Object
• • com.azure.analytics.purview.workflow.WorkflowTasksClient

public final class WorkflowTasksClient

Initializes a new instance of the synchronous PurviewWorkflowClient type.

Method Summary

Modifier and Type	Method and Description
PagedIterable<BinaryData>	list(RequestOptions requestOptions) Get all workflow tasks.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

list

public PagedIterable<BinaryData> list(RequestOptions requestOptions)

Get all workflow tasks.

Query Parameters

| ------------------- | ------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Name                | Type         | Required | Description                                                                                                                                                                                            |
| viewMode            | String       | No       | To filter user's sent, received or history workflow tasks.                                                                                                                                             |
| workflowIds         | List<String> | No       | Filter items by workflow id list. In the form of "," separated string.                                                                                                                                 |
| timeWindow          | String       | No       | Time window of filtering items. Allowed values: "1d", "7d", "30d", "90d".                                                                                                                              |
| maxpagesize         | Integer      | No       | The maximum page size to get the items at one time. The default value is 100.                                                                                                                          |
| orderby             | String       | No       | The key word which used to sort the results. Allowed values: "status desc", "status asc", "requestor desc", "requestor asc", "startTime desc", "startTime asc", "createdTime desc", "createdTime asc". |
| taskTypes           | List<String> | No       | Filter items by workflow task type. In the form of "," separated string.                                                                                                                               |
| taskStatuses        | List<String> | No       | Filter workflow tasks by status. In the form of "," separated string.                                                                                                                                  |
| requestors          | List<String> | No       | Requestors' ids to filter. In the form of "," separated string.                                                                                                                                        |
| assignees           | List<String> | No       | Assignees' ids to filter. In the form of "," separated string.                                                                                                                                         |
| workflowNameKeyword | String       | No       | The key word which could used to filter workflow item with related workflow.                                                                                                                           |

You can add these to a request with RequestOptions#addQueryParam

Response Body Schema

{
     id: String (Required)
     title: String (Optional)
     workflowRunId: String (Required)
     workflowId: String (Required)
     requestor: String (Required)
     createdTime: OffsetDateTime (Required)
     lastUpdateTime: OffsetDateTime (Required)
     payload (Required): {
         type: String(CreateTerm/UpdateTerm/DeleteTerm/ImportTerms/UpdateAsset/GrantDataAccess) (Required)
         targetValue: String (Required)
         payload: Object (Optional)
     }
     reminderInfo (Optional): {
         lastRemindTime: OffsetDateTime (Optional)
         nextRemindTime: OffsetDateTime (Required)
         reminderSettings: Object (Required)
     }
     expiryInfo (Optional): {
         lastExpiryNotificationTime: OffsetDateTime (Optional)
         nextExpiryNotificationTime: OffsetDateTime (Required)
         expiryTime: OffsetDateTime (Required)
         expirySettings (Required): {
             expireAfter: Object (Required)
             notifyOnExpiration (Optional): [
                 String (Optional)
             ]
         }
     }
 }

Parameters:

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

all workflow tasks as paginated response with PagedIterable<T>.