Complete A WorkItem.

Complete A WorkItem.

Complete a WorkItem.

  • A work item may only be completed by:
    • One of its assignees
    • A delegate of one of its assignees
    • A privileged, administrator user
  • A work item may be completed by any of the actions associated with its work item type
  • Work items may be completed via an incoming notification (e.g. email) This may be done by replying to an email sent by the work item queue.
  • The client application will be notified when a work item is completed.
  • The client application must provide a REST service to be notified of completion. The service will be passed:
    • The form data of the work item that has been completed
    • The action that completed the work item
    • Useful work item metadata

Sequence Diagram

<img src='../../workitem-service/api/docs/complete-workitem.png'>

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

The workitem id.

string
actionId
Required

The action 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/{actionId}
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.