REST API - getWorkListItems

GET <baseurl>/worklist/items/<entitytype>/<entityguid>/<start>/<count>

• entitytype: one of these enumerated values, defining the type of the organization model entity.
• entityguid: Globally unique ID of the organization model entity.
• start: Position in the work item list from which to start this page. (The list is zero-based. To start at the first item, specify 0.)
• count: Number of work items (in the work item list) to include in this page.

• btotalreq=boolean (optional, default=true). Boolean defining whether BRM builds a count of the total number of work items in the work item list. If ‘false’ is passed in this attribute, and:
  • there is at least one item in the list, the totalItems value returned in the response is -1.
  • there are no work items in the list, the totalItems value returned in the response is 0 (zero).

    If ’true’ is passed in this attribute, count must be set to one or more to provide a correct total. The total count of work items is only available when you are fetching one or more work items.

• entityver=integer (optional, default =-1). Major version number of the organization model in which an organization model entity resides.

  If not specified, the default value will be the latest version of the organization model.

• filterstring=string (optional). Specification of filter criteria to be applied to a work item list.
• orderstring=string (optional). Specification of sort criteria to be applied to a work item list.

  See Sorting and Filtering Work Lists for details of the syntax and content of these criteria.

GET <baseurl>/worklist/items/POSITION/_r5mKcbhOEeCV8vd_S2VPhQ/0/1

{

    "xml-fragment": {

        "startPosition": 0,

        "endPosition": 0,

        "totalItems": 3,

        "workItems": {

            "id": {

                "@id": "51",

                "@version": "0"

            },

            "header": {

                "@distributionStrategy": "OFFER",

                "@priority": "50",

                "@startDate": "2013-01-16T15:37:57.770Z",

                "name": "DisplayMessage",

                "description": "Display Message",

                "flags": {

                    "scheduleStatus": "DURING"

                },

                "itemContext": {

                    "activityID": "pvm:001i3b",

                    "activityName": "DisplayMessage",

                    "appInstance": "pvm:0a1236",

                    "appName": "WelcomeUsers",

                    "appID": "_-fPYwCIVEeCnP8eZZTCDGg"

                }

            },

            "state": "OFFERED",

            "visible": true

        }

    }

}