Skip to content

GetWorklistCount

Returns the total number of records in the worklist. This method can be used to define paging parameters for the * GetWorklist* method.

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.
queryXml Optional parameter for specifying query XML. See 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

1
2
3
4
5
6
7
8
9
POST https://mydomain.emakin.com/rest/v1/getWorklistCount

{
     "apiKey": "xxxx",
     "logonId": "[email protected]",
     "logonProvider": "Organization",
     "tag": null,
     "queryXml" : ""
}
1
2
3
4
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

50