REST API - cancelWorkItem

The table summarizes the REST API - cancelWorkItem.

Request

Format 
PUT <baseurl>/workitem/presentation/cancel/<id>/<userid>
Path parameters
  • id: ID of the work item to be cancelled.
  • userid: GUID of the resource that wants to cancel the work item.
Query parameters
  • channelid=string (optional, default=openspaceGWTPull_DefaultChannel): Identifier of the channel to which the requesting client application is bound.
  • channeltype=string (optional, default=openspaceChannel): Enumerated value defining the channel type (technology) associated with the specified channelid. For a list of available enumerations, see channeltype enumerations.

    See Identifying the Client Channel in a Service Call for more information.

  • version=long (optional, default = -1): Version number of the work item to be opened. If set to -1 or omitted, the latest version of the work item is used.
  • responsetype=string (optional, default = JSON): Enumerated value defining the format of the data payload to be used in the response message - either XML or JSON.
  • getGlobalValues=boolean (optional, default=false) If you require the values or just the goref itself.

Response

JSON Returns a JSON representation of the contents of a workResponseelement.
XML Returns a workResponseelement (from the WorkPresentationService schema)

Example

Request 
PUT <baseurl>/workitem/presentation/cancel/51/812935E2-06D5-4504-8621-6E5B901702C4
Response 
{
    "xml-fragment": {
        "@isSuccessful": "true"
    }
}