Cancel the specified WorkItem.

Cancel the specified WorkItem.

Cancel the specified WorkItem.

  • Prevents a work item from being updated or completed The work item enters the 'ancelled'' state
  • A work item may only be cancelled by a solution user. I.e. the application that created the work item.
  • A work item would be cancelled when it is no longer required
    • This would be determined by the client application based on its rules
    • For example: the approval service may cancel any outstanding 'Approval' work items once one of the approvers has rejected the approval.
  • Work items may not be cancelled by non-solution users.
  • Once aborted a work item may not be:
    • Reactivated
    • Updated
  • A cancelled work item is not deleted
  • A work item's data may not be updated when aborting a work item
  • The client application will not be notified when a work item is cancelled.
  • An audit trail message is written when a work item is cancelled. The cancellation API should support passing a reason why a work item has been cancelled which is also part of the audit trail.
If an application wished to offer a 'Cancel' action for a work item, it would need to:
  • Define such an action on the work item type
  • Respond to this action when the item is completed

Request
URI
POST
https://{api_host}/work-item-service/api/workitems/{workItemId}/actions/cancel
COPY
Path Parameters
string
workItemId
Required

The workitem id.

Request Body
WorkItemActionComplete of type(s) application/json
Optional 
{
    "workItemActionId": "string",
    "formData": {
        "entries": [
            {
                "value": {},
                "key": "string"
            }
        ]
    },
    "workItemId": "string"
}
Responses
200
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/work-item-service/api/workitems/{workItemId}/actions/cancel
On This Page
Work Item Operations
POST
Create A new WorkItem for the given service.
GET
Retrieve A list Of WorkItem.
PUT
Create A set Of WorkItems
POST
Complete A WorkItem.
POST
Completes the WorkItem If It Is still active.
GET
Retrieve the details Of the given WorkItem.
DELETE
Delete the WorkItem corresponding To the given id.
PUT
Update the WorkItem which corresponds To the given Id.
GET
Retrieve the WorkItem Form from for the selected WorkItem from the corresponding Service Provider.
GET
Retrieve A list Of WorkItem.
POST
Retrieve A set Of form data for the specified workItem and formElement.
POST
Retrieves the metadata Of multiple dynamic elements In single call. It combines the retrieval Of element's ElementState and the list Of permissible values for each element.
POST
Cancel the specified WorkItem.