REST API - allocateWorkItem

The table summarizes the REST API - allocateWorkItem.

Request

Format 
PUT <baseurl>/workitem/allocate
Query parameters
  • id= long(1..n): Unique ID of the work item.
  • version=long (1..n): Version of the work item. If not set, the latest version will be used.
  • resources=string: GUID of the resource to whom the work item should be allocated.

Note: All these parameters can be multiples. Id and version must be pairs. For example: 

id=1&id=2&id=3&version=1&version=2&version=3

Response

JSON Returns a JSON representation of the content of the allocateWorkItemResponse element.
XML Returns the content of the allocateWorkItemResponse element (from the WorkItemManagementService schema).

Example

Request 
PUT <baseurl>/workitem/allocate?id=5&version=0&resources=A4AE84F2-893A-4E39-8FE4-A8981872538E
Response 
{
    "workItem": {
        "id": {
            "@id": "5",
            "@version": "1"
        },
        "header": {
            "@distributionStrategy": "OFFER",
            "@priority": "50",
            "@startDate": "2013-01-22T14:15:10.137Z",
            "name": "GetUsersName",
            "description": "Get User's Name",
            "flags": {
                "scheduleStatus": "DURING"
            },
            "itemContext": {
                "activityID": "pvm:001i1c",
                "activityName": "GetUsersName",
                "appInstance": "pvm:0a126",
                "appName": "WelcomeUsersChained",
                "appID": "_h3SuNATvEd-PnpTAZS_CFw"
            }
        },
        "state": "ALLOCATED",
        "visible": true
    }
}