GetWorklist
Returns the list of work items on the user's worklist. The tag parameter specifies the identifier for the specific list to be returned.
Required Scope
worklist_read
Parameters
| Parameter Name | Description |
apiKey | A unique key used to authenticate and authorise the calling system. |
logonId | User’s logon Id. |
logonProvider | The authentication provider used for user login (e.g., 'Organization' for Emakin's default login system). |
tag | Identifier for the worklist. If set to null, the default inbox is returned. |
start | Starting point for the list. Use 0 to begin from the first item. |
maxLength | Limit on the number of rows to return. Use -1 to retrieve all rows. |
queryXml | Optional parameter for specifying query XML. See worklist query for more details. |
Tag Parameter
Tag parameter can be used to filter the worklist. If the tag is not specified, the default 'Inbox' is returned. Following tags are available:
| Tag Value | Tag Description |
| E7F4670A-4B3A-4ce3-986D-E9B4F8D8267D | Inbox |
| 00000000-94C3-4888-ADBE-34EED6DE4BEB | Sent |
| 00000000-9133-45b7-b322-e563f8388201 | Initiated |
| 00000000-627B-4d38-948F-3329106A9A71 | All |
Example Call
| POST https://mydomain.emakin.com/rest/v1/getWorklist
{
"apiKey": "xxxx",
"logonId": "[email protected]",
"logonProvider": "Organization",
"tag": null,
"start": 0,
"maxLength": 30,
"queryXml" : ""
}
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23 | HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"Id":"e5134318-88bd-4a33-b561-4d78380734ce",
"Caption":"A new task",
"Start":"/Date(1445812020394)/",
"End":null,
"Instructions":"Please complete.",
"State":"Waiting",
"Number":12471
},
{
"Id":"796a34c6-fd2e-450e-a2af-8124ea68f8ca",
"Caption":"A new other task",
"Start":"/Date(1445512843034)/",
"End":null,
"Instructions":"Please complete.",
"State":"Waiting",
"Number":12468
}
]
|