Skip to content

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.

Info

The generated token is only used for login purposes and cannot be used as a session token. You may pass this token to the auth parameter to authenticate users and system will issue a new session token for the user.

Example Call

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
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
      }
]