Get a list of workflow tasks

get/processes/tasks

Internal-Use Only

Retrieves a list of workflow tasks. The returned items are of type application/vnd.sas.investigation.workflow.task+json.

Request Samples

Response Samples

200
application/vnd.sas.collection+json
1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "self",
6      "href": "/svi-datahub/workflows/processes/tasks",
7      "uri": "/svi-datahub/workflows/processes/tasks",
8      "type": "application/vnd.sas.collection"
9    }
10  ],
11  "name": "workflowTasks",
12  "accept": "application/vnd.sas.investigation.workflow.task",
13  "start": 0,
14  "count": 2,
15  "items": [
16    {
17      "links": [
18        {
19          "method": "GET",
20          "rel": "self",
21          "href": "/svi-datahub/workflows/processes/tasks/tasks/94e54bb5-32d2-11ee-9999-8ae1ba173534",
22          "uri": "/svi-datahub/workflows/processes/tasks/tasks/94e54bb5-32d2-11ee-9999-8ae1ba173534",
23          "type": "application/vnd.sas.investigation.workflow.task",
24          "responseType": "application/vnd.sas.investigation.workflow.task+json"
25        },
26        {
27          "method": "PUT",
28          "rel": "claim",
29          "href": "/svi-datahub/workflows/processes/tasks/tasks/94e54bb5-32d2-11ee-9999-8ae1ba173534/claimed",
30          "uri": "/svi-datahub/workflows/processes/tasks/tasks/94e54bb5-32d2-11ee-9999-8ae1ba173534/claimed",
31          "type": "application/vnd.sas.investigation.workflow.task"
32        },
33        {
34          "method": "PUT",
35          "rel": "release",
36          "href": "/svi-datahub/workflows/processes/tasks/tasks/94e54bb5-32d2-11ee-9999-8ae1ba173534/claimReleased",
37          "uri": "/svi-datahub/workflows/processes/tasks/tasks/94e54bb5-32d2-11ee-9999-8ae1ba173534/claimReleased"
38        },
39        {
40          "method": "PUT",
41          "rel": "assign",
42          "href": "/svi-datahub/workflows/processes/tasks/tasks/%25s/assigned",
43          "uri": "/svi-datahub/workflows/processes/tasks/tasks/%25s/assigned",
44          "type": "application/vnd.sas.investigation.workflow.task"
45        },
46        {
47          "method": "PUT",
48          "rel": "complete",
49          "href": "/svi-datahub/workflows/processes/tasks/tasks/94e54bb5-32d2-11ee-9999-8ae1ba173534/completed",
50          "uri": "/svi-datahub/workflows/processes/tasks/tasks/94e54bb5-32d2-11ee-9999-8ae1ba173534/completed",
51          "type": "application/vnd.sas.investigation.workflow.action"
52        }
53      ],
54      "version": 1,
55      "entityId": 100932,
56      "entityName": "TestEntity",
57      "entityLabel": "Perf Test",
58      "solutionName": "sas_visual_investigator_default",
59      "solutionLabel": "SAS Visual Investigator",
60      "workflowDefinitionId": "TestEntity_workflow:1:74c5d56f-30da-11ee-9b68-c6e83977fdb1",
61      "workflowName": "TestEntity_workflow",
62      "workflowLabel": "Perf Test Workflow",
63      "workflowLabelResource": "svi.workflow.TestEntity.1690942531204.label.txt",
64      "workflowDescriptionResource": "svi.workflow.TestEntity.1690942531204.description.txt",
65      "workflowVersion": 1,
66      "entityInstanceId": "7b404733-404b-4c03-895e-b3486bef7d4a",
67      "entityInstanceLabel": "7b404733-404b-4c03-895e-b3486bef7d4a",
68      "id": "94e54bb5-32d2-11ee-9999-8ae1ba173534",
69      "name": "Sample User Task",
70      "definitionId": "UserTask1675090585240",
71      "assignee": "testUser",
72      "processInstanceId": "94e4885c-32d2-11ee-9999-8ae1ba173534",
73      "claimedAt": "2023-08-04T14:46:43.991Z",
74      "participants": [
75        {
76          "id": "sviusrs",
77          "type": "GROUP",
78          "name": "sviusrs"
79        }
80      ],
81      "isProcessInstanceSuspended": true,
82      "createdAt": "2023-08-04T14:46:43.991Z",
83      "actions": [
84        {
85          "id": "taskOption1675090585241",
86          "name": "Completed",
87          "pagePrompt": {
88            "defaults": [
89              {
90                "id": "dd9fb065-0121-4f9e-b7d3-9a48016e3ea6",
91                "name": "TestEntityPage"
92              }
93            ]
94          }
95        }
96      ]
97    }
98  ],
99  "limit": 1,
100  "version": 2
101}

Query Parameters

Name	Type	Required	Description
fields	string	false	The comma-separated list of resource members to return in the collection.
filter	string	false	Filters the collection using prefix function syntax using selected resource members.
includeOnlyWorkableTasks	boolean	false	Returns only the tasks the calling user is allowed to work.
limit	integer<int32>	false	The number of items that were requested for the collection. Default: 20
sortBy	string	false	The sorting preference for selected resource members in the returned collection. Default: id:ascending
start	integer<int64>	false	The zero-based index of the first item in the collection. Default: 0

Header Parameters

Name	Type	Required	Description
VI-Client-Application	string	false	Indicates which client is issuing the request. Accepted values include desktop and mobile. Default: desktop

Responses

Status	Meaning	Description
200	OK	The request succeeded.		Schema