Retrieve the details Of the given WorkItem.

Retrieve the details Of the given WorkItem.

Retrieve the details of the given WorkItem.

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

The workitem id.

Responses
200

successful operation

Returns WorkItem of type(s) */* 
{
    "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"
}
string As date-time As date-time
assignedDate
Optional

assignedDate

array of object
availableActions
Optional

availableActions

integer As int64 As int64
workItemNumber
Optional

workItemNumber

object
workItemType
Required

workItemType

string As date-time As date-time
assignedOrCompletedDate
Optional

assignedOrCompletedDate

array of object
assignees
Required

assignees

object
workItemRequest
Required

workItemRequest

integer As int64 As int64
version
Optional

version

string As date-time As date-time
completedDate
Optional

completedDate

string
subTenantId
Optional
Constraints: minLength: 0 maxLength: 255

subTenantId

string As date-time As date-time
createdDate
Optional

createdDate

string
formUrl
Optional
Constraints: minLength: 0 maxLength: 2083

formUrl

string
tenantId
Required
Constraints: minLength: 0 maxLength: 255

tenantId

string As uuid As uuid
id
Optional

id

string
serviceId
Required
Constraints: minLength: 0 maxLength: 40

serviceId

string
completedBy
Optional
Constraints: minLength: 0 maxLength: 255

completedBy

string
callbackEntityId
Required
Constraints: minLength: 0 maxLength: 40

callbackEntityId

string
status
Optional
Constraints: minLength: 0 maxLength: 255

status


Code Samples
COPY
                    curl -H 'Authorization: <value>' 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.