Work-item Service API Data Structures
{
"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"
}
filterable
displayAdvice
isMultiValued
description
orderIndex
id
label
sortable
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"providerEntityId": "string"
}
providerEntityId
{
"dependencies": [
"string"
],
"facets": [
{}
]
}
dependencies
{
"offset": "integer",
"count": "integer"
}
offset
count
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
}
extensionId
{
"facets": [
{
"type": "string"
}
]
}
{
"type": "string"
}
type
{
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"columns": [
"Field Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"orderIndex": "integer",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
displayAdvice
isMultiValued
description
orderIndex
id
label
isMultiValued
description
label
labelSize
displayAdvice
orderIndex
id
{
"size": "integer"
}
size
{
"size": "integer",
"extensionRendererContext": {
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
},
"columns": [
"LayoutField Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"label": "string",
"labelSize": "integer",
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"orderIndex": "integer",
"id": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
{
"size": "integer"
}
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
id
label
{
"items": [
{
"size": "integer"
}
]
}
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
id
label
{
"rel": "string",
"href": "string"
}
rel
href
{
"key": "string"
}
key
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"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"
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"key": "string"
}
key
{
"params": [
{
"key": "string"
}
]
}
{
"fields": [
{
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"columns": [
"Field Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"orderIndex": "integer",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
]
}
{
"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"
]
}
defaultSequence
{
"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"
}
assignedDate
workItemNumber
assignedOrCompletedDate
version
completedDate
subTenantId
createdDate
formUrl
tenantId
id
serviceId
completedBy
callbackEntityId
status
{
"stateNameId": "string",
"stateName": "string",
"name": "string",
"icon": {
"image": [
"string"
],
"name": "string",
"id": "string",
"contentType": "string"
},
"id": "string"
}
stateNameId
stateName
name
id
{
"workItemActionId": "string",
"formData": {
"entries": [
{
"key": "string"
}
]
},
"workItemId": "string"
}
workItemActionId
workItemId
{
"image": [
"string"
],
"name": "string",
"id": "string",
"contentType": "string"
}
image
name
id
contentType
{
"delegates": [
{
"displayName": "string",
"principalId": "string",
"principalType": "string"
}
]
}
{
"displayName": "string",
"principalId": "string",
"principalType": "string"
}
displayName
principalId
principalType
{
"itemId": "string",
"itemName": "string",
"itemRequestor": "string",
"itemData": {
"entries": [
{
"key": "string"
}
]
},
"itemCost": "number",
"itemDescription": "string"
}
itemId
itemName
itemRequestor
itemCost
itemDescription
{
"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": {}
}
pluralizedName
commentsField
completeByEmail
name
description
serviceTypeId
id
version
{
"formValues": {
"entries": [
{
"key": "string"
}
]
},
"headers": {
"entries": [
{
"key": "string"
}
]
},
"trigger": "string",
"triggeredDetailsLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"affectedElements": [
"string"
]
}
trigger
affectedElements
Wraps a boolean value.
{
"value": "boolean"
}
The boolean value.
{
"values": [
{
"label": "string"
}
]
}
{
"pagingInfo": {
"offset": "integer",
"count": "integer"
},
"headers": {
"entries": [
{
"key": "string"
}
]
},
"tenantId": "string",
"text": "string",
"userId": "string",
"dependencyValues": {
"entries": [
{
"key": "string"
}
]
}
}
tenantId
text
userId
{
"links": [
{
"rel": "string",
"href": "string"
}
],
"content": [
{
"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"
}
]
}
{
"layout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"fieldPrefixes": [
"string"
],
"values": {
"entries": [
{
"key": "string"
}
]
}
}
fieldPrefixes
{
"elementUpdates": [
{
"permissibleValues": [
{
"label": "string"
}
],
"extensionRendererContext": {
"entries": [
{
"key": "string"
}
]
},
"facetValues": {
"facets": [
{
"type": "string"
}
]
},
"id": "string",
"detailLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"errors": [
"string"
]
}
]
}
{
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
}
Wraps a value such that values of different types can be treated generically.
Equivalent of java.util.Map
{
"entries": [
{
"key": "string"
}
]
}
{
"action": "string",
"comment": "string",
"entityId": "string",
"notificationId": "string",
"userId": "string"
}
action
comment
entityId
notificationId
userId
A literal defining period of time. This period is represented some integral number of a specified timeUnit.e.g. 6 days.
{
"unit": "string",
"amount": "integer"
}
The unit of measure for the time span. e.g: days.
The amount for the time span.
{
"permissibleValues": [
{
"label": "string"
}
],
"extensionRendererContext": {
"entries": [
{
"key": "string"
}
]
},
"facetValues": {
"facets": [
{
"type": "string"
}
]
},
"id": "string",
"detailLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"errors": [
"string"
]
}
id
errors
{
"label": "string"
}
label