REST API - getAllocatedWorkListItems

The table summarizes the REST API - getAllocatedWorkListItems.

Request

Format 
GET <baseurl>/worklist/allocateditems/<entitytype>/<entityguid>/<start>/<count>
Path parameters
  • 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.
Query parameters
  • 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).
  • 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.
  • enhancedattributes=Boolean (optional, default=false). If true, all 40 work item attributes are returned with the work item; if false, only work item attributes 1-14 are returned with the work item.

Response

JSON Returns a JSON representation of the content of the getWorkListItemsResponseelement.
XML Returns the content of the getWorkListItemsResponseelement (from the WorkListService schema)

Example

Request 
GET <baseurl>/worklist/allocateditems/POSITION/_r5mKcbhOEeCV8vd_S2VPhQ/0/1
Response 
{
    "xml-fragment": {
        "startPosition": 0,
        "endPosition": -1,
        "totalItems": 0
    }
}