REST API - getWorkListItemsForGlobalData

The table summarizes the REST API - getWorkListItemsForGlobalData.

Request

Format 
GET <baseurl>/worklist/workitemsforglobaldata/<startPosition>/<numberOfItems>/<globalDataRef>
Path Parameter
  • startPosition: The position in the work list to start the page of results. The list is zero-based. To start at the first item, specify 0.
  • numberOfItems: The number of items to include in the work list.
  • globalDataRef: Can be obtained from findCaseByCID or findCaseByCriteria.
Query Parameters
  • filterstring=string (optional). Filter criteria to apply to the work item list.
  • orderstring=string (optional). Sort criteria to apply to the work item list.

For details of the syntax and content for filter and sort criteria, see Sorting and Filtering Work Lists.

Response

JSON Returns a JSON representation of the contents of a getWorkListItemsForGlobalDataResponse element.
XML Returns the contents of a getWorkListItemsForGlobalDataResponse element (from the WorkListService schema).

Example

Request 
GET <baseurl>/worklist/workitemsforglobaldata/0/5/BDS-1-com.example.hastings.Customer-1-0?filterstring=state=OFFERED&orderstring=id%20ASC
Response 
{
    "xml-fragment":
    {
        "startPosition": 0,
        "endPosition": 0,
        "workItems":
        {
            "id":
            {
                "@id": "1",
                "@version": "0"
            },
            "header":
            {
                "@distributionStrategy": "OFFER",
                "@priority": "50",
                "@startDate": "2015-04-16T21:40:42.937Z",
                "name": "VerifyEmployment",
                "description": "VerifyEmployment",
                "flags":
                {
                    "scheduleStatus": "DURING"
                },
                "itemContext":
                {
                    "activityID": "pvm:001ia",
                    "activityName": "VerifyEmployment",
                    "appInstance": "pvm:0a122",
                    "appName": "AutoLoanProcess",
                    "appID": "_0dRZQJ8OEeOgg76Ol2bTHw"
                }
            },
            "state": "OFFERED",
            "visible": true
        }
    }
}