REST API - unallocateWorkItem

The table summarizes the REST API - unallocateWorkItem.

Request

Format
PUT <baseurl>/workitem/unallocate
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.

Response

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

Example

Request
PUT <baseurl>/workitem/unallocate?id=5&version=2
Response
{

    "workItem": {

        "id": {

            "@id": "5",

            "@version": "2"

        },

        "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": "OFFERED",

        "visible": true

    }

}