REST API - allocateAndOpenWorkItem

The table summarizes the REST API - allocateAndOpenWorkItem.

Request

Format 
PUT <baseurl>/workitem/allocateandopen
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: Name 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 allocateAndOpenWorkItemResponse element.
XML Returns the content of the allocateAndOpenWorkItemResponse element (from the WorkItemManagementService schema)

Example

Request 
PUT <baseurl>/workitem/allocateandopen?id=8&version=0&resources=tibco-admin
Response 
{
    "workItem": {
        "id": {
            "@id": "8",
            "@version": "1"
        },
        "header": {
            "@distributionStrategy": "OFFER",
            "@priority": "50",
            "@startDate": "2013-01-22T14:24:20.077Z",
            "name": "GetUsersName",
            "description": "Get User's Name",
            "flags": {
                "scheduleStatus": "DURING"
            },
            "itemContext": {
                "activityID": "pvm:001i27",
                "activityName": "GetUsersName",
                "appInstance": "pvm:0a129",
                "appName": "WelcomeUsersChained",
                "appID": "_h3SuNATvEd-PnpTAZS_CFw"
            }
        },
        "body": {
            "dataModel": {
                "outputs": {
                    "@name": "UserName",
                    "@type": "String",
                    "@array": "false",
                    "simpleSpec": ""
                }
            }
        },
        "workType": {
            "@workTypeID": "WT__D1uKcCoHEeCmTZqrA21YZg",
            "@workTypeDescription": "GetUsersName",
            "@version": "1.0.0.201301221404"
        },
        "state": "OPENED",
        "visible": true
    }
}