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": [
                            {}
                        ]
                    },
                    "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

availableActions
Optional

availableActions

integer As int64 As int64
workItemNumber
Optional

workItemNumber

workItemType
Required

workItemType

string As date-time As date-time
assignedOrCompletedDate
Optional

assignedOrCompletedDate

assignees
Required

assignees

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