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

Show optional properties

{
    "workItemType": {
        "name": "string"
    },
    "assignees": [
        {
            "principalId": "string",
            "principalType": "string"
        }
    ],
    "workItemRequest": {
        "itemId": "string",
        "itemName": "string",
        "itemRequestor": "string",
        "itemDescription": "string"
    },
    "tenantId": "string",
    "serviceId": "string",
    "callbackEntityId": "string"
}
{
    "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": [
                            {
                                "value": {}
                            }
                        ]
                    },
                    "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": {
            "workItemNotification": {},
            "workItemSubmission": {},
            "workItemDetails": {}
        }
    },
    "assignedOrCompletedDate": "string",
    "assignees": [
        {
            "displayName": "string",
            "principalId": "string",
            "principalType": "string"
        }
    ],
    "workItemRequest": {
        "itemId": "string",
        "itemName": "string",
        "itemRequestor": "string",
        "itemData": {
            "entries": [
                {
                    "value": {},
                    "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"
}
Responses
200
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"assignees":["object"],"callbackEntityId:"string","serviceId:"string","tenantId:"string","workItemRequest:"object","workItemType:"object"}' https://{api_host}/work-item-service/api/workitems/{id}
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.