Update the WorkItem which corresponds To the given Id.

Update the WorkItem which corresponds To the given Id.

Update the WorkItem which corresponds to the given Id.

  • A work item may be updated by:
    • One of its assignees
    • A delegate of one of its assignees
  • The application that created the work item is notified of all updates.
  • Client applications must provide a REST service to receive these updates. This service will be passed:
    • The updated form data for the work item as a property map
    • Useful metadata (e.g. who updated the work item and when) in a fixed schema

Sequence Diagram

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

Request
URI
PUT
https://{api_host}/work-item-service/api/workitems/{id}
COPY
Path Parameters
string
id
Required

The workitem id.

Request Body
WorkItem of type(s) application/json
Optional 
{
    "assignedDate": "string",
    "availableActions": [
        {
            "stateNameId": "string",
            "stateName": "string",
            "name": "string",
            "icon": {
                "image": [
                    "string"
                ],
                "name": "string",
                "id": "string",
                "contentType": "string"
            },
            "id": "string"
        }
    ],
    "workItemNumber": 0,
    "workItemType": {
        "pluralizedName": "string",
        "commentsField": "string",
        "completeByEmail": false,
        "listView": {
            "columns": [
                {
                    "filterable": false,
                    "permissibleValues": {
                        "customAllowed": false
                    },
                    "displayAdvice": "string",
                    "dataType": {
                        "typeId": "string"
                    },
                    "isMultiValued": false,
                    "description": "string",
                    "orderIndex": 0,
                    "id": "string",
                    "label": "string",
                    "state": {
                        "dependencies": [
                            "string"
                        ],
                        "facets": [
                            {}
                        ]
                    },
                    "sortable": false
                }
            ],
            "defaultSequence": [
                "string"
            ]
        },
        "name": "string",
        "description": "string",
        "serviceTypeId": "string",
        "id": "string",
        "actions": [
            {
                "stateNameId": "string",
                "stateName": "string",
                "name": "string",
                "icon": {
                    "image": [
                        "string"
                    ],
                    "name": "string",
                    "id": "string",
                    "contentType": "string"
                },
                "id": "string"
            }
        ],
        "version": 0,
        "forms": {}
    },
    "assignedOrCompletedDate": "string",
    "assignees": [
        {
            "displayName": "string",
            "principalId": "string",
            "principalType": "string"
        }
    ],
    "workItemRequest": {
        "itemId": "string",
        "itemName": "string",
        "itemRequestor": "string",
        "itemData": {
            "entries": [
                {
                    "key": "string"
                }
            ]
        },
        "itemCost": "number",
        "itemDescription": "string"
    },
    "version": 0,
    "completedDate": "string",
    "subTenantId": "string",
    "createdDate": "string",
    "formUrl": "string",
    "tenantId": "string",
    "id": "string",
    "serviceId": "string",
    "completedBy": "string",
    "callbackEntityId": "string",
    "status": "string"
}
string As date-time As date-time
assignedDate
Optional

assignedDate

array of WorkItemAction
availableActions
Optional

availableActions

integer As int64 As int64
workItemNumber
Optional

workItemNumber

WorkItemType
workItemType
Required

workItemType

string As date-time As date-time
assignedOrCompletedDate
Optional

assignedOrCompletedDate

array of WorkItemPrincipal
assignees
Required

assignees

WorkItemRequest
workItemRequest
Required

workItemRequest

integer As int64 As int64
version
Optional

version

string As date-time As date-time
completedDate
Optional

completedDate

string
subTenantId
Optional

subTenantId

string As date-time As date-time
createdDate
Optional

createdDate

string
formUrl
Optional

formUrl

string
tenantId
Required

tenantId

string As uuid As uuid
id
Optional

id

string
serviceId
Required

serviceId

string
completedBy
Optional

completedBy

string
callbackEntityId
Required

callbackEntityId

string
status
Optional

status

Responses
200
Operation doesn't return any data structure

On This Page
Work Item Operations
POST
Cancel the specified WorkItem.
POST
Complete A WorkItem.
POST
Completes the WorkItem If It Is still active.
POST
Create A new WorkItem for the given service.
PUT
Create A set Of WorkItems
DELETE
Delete the WorkItem corresponding To the given id.
GET
Retrieve A list Of WorkItem.
GET
Retrieve A list Of WorkItem.
POST
Retrieve A set Of form data for the specified workItem and formElement.
GET
Retrieve the details Of the given WorkItem.
GET
Retrieve the WorkItem Form from for the selected WorkItem from the corresponding Service Provider.
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.
PUT
Update the WorkItem which corresponds To the given Id.