Create A new WorkItem for the given service.
Create a new WorkItem for the given service.
Request
URI
POST
https:///work-item-service/api/workitems
COPY
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": "integer",
"workItemType": {
"pluralizedName": "string",
"commentsField": "string",
"completeByEmail": "boolean",
"listView": {
"columns": [
{
"filterable": "boolean",
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"orderIndex": "integer",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sortable": "boolean"
}
],
"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": "integer",
"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": "integer",
"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
integer As int64 As int64
workItemNumber
Optional
workItemNumber
string As date-time As date-time
assignedOrCompletedDate
Optional
assignedOrCompletedDate
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
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": "integer",
"workItemType": {
"pluralizedName": "string",
"commentsField": "string",
"completeByEmail": "boolean",
"listView": {
"columns": [
{
"filterable": "boolean",
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"orderIndex": "integer",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sortable": "boolean"
}
],
"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": "integer",
"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": "integer",
"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
integer As int64 As int64
workItemNumber
Optional
workItemNumber
string As date-time As date-time
assignedOrCompletedDate
Optional
assignedOrCompletedDate
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
201
Operation doesn't return any data structure
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 WorkItem Form from for the selected WorkItem from the corresponding Service Provider.
GET
Retrieve the details Of the given WorkItem.
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.