Work-item Service API Data Structures
Clause
This data structure has no properties.
Column
JSON Example
{
"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"
}boolean
filterable
Optional
filterable
string
displayAdvice
Optional
displayAdvice
boolean
isMultiValued
Optional
isMultiValued
string
description
Optional
description
integer As int32 As int32
orderIndex
Optional
orderIndex
string
id
Optional
id
string
label
Optional
label
boolean
sortable
Optional
sortable
CriteriaOperator
This data structure has no properties.
DynamicValueContext
JSON Example
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"providerEntityId": "string"
}string
providerEntityId
Optional
providerEntityId
ElementState
JSON Example
{
"dependencies": [
"string"
],
"facets": [
{}
]
}array of string
dependencies
Optional
dependencies
ElementValuesPagingInfo
JSON Example
{
"offset": "integer",
"count": "integer"
}integer As int32 As int32
offset
Optional
offset
integer As int32 As int32
count
Optional
count
Evaluator
This data structure has no properties.
ExtensionRendererContext
JSON Example
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
}string
extensionId
Optional
extensionId
FacetValueMap
JSON Example
{
"facets": [
{
"type": "string"
}
]
}
FacetValueMapEntry
JSON Example
{
"type": "string"
}string
type
Optional
type
Field
JSON Example
{
"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": [
{}
]
}
}string
displayAdvice
Optional
displayAdvice
boolean
isMultiValued
Optional
isMultiValued
string
description
Optional
description
integer As int32 As int32
orderIndex
Optional
orderIndex
string
id
Optional
id
string
label
Optional
label
FormReference
This data structure has no properties.
InlineLayoutField1
This data structure has no properties.
boolean
isMultiValued
Optional
isMultiValued
string
description
Optional
description
string
label
Optional
label
integer As int32 As int32
labelSize
Optional
labelSize
string
displayAdvice
Optional
displayAdvice
integer As int32 As int32
orderIndex
Optional
orderIndex
string
id
Optional
id
InlineLayoutFlowElement1
This data structure has no properties.
LayoutCell
JSON Example
{
"size": "integer"
}integer As int32 As int32
size
Optional
size
LayoutField
AllOf
JSON Example
{
"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": [
{}
]
}
}
LayoutFlowElement
AllOf
JSON Example
{
"size": "integer"
}
LayoutPage
JSON Example
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}string
id
Optional
id
string
label
Optional
label
LayoutReference
This data structure has no properties.
LayoutRow
JSON Example
{
"items": [
{
"size": "integer"
}
]
}
LayoutSection
JSON Example
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}string
id
Optional
id
string
label
Optional
label
Link
JSON Example
{
"rel": "string",
"href": "string"
}string
rel
Optional
rel
string
href
Optional
href
LiteralMapEntry
JSON Example
{
"key": "string"
}string
key
Optional
key
PageWorkItem
JSON Example
{
"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"
}integer As int32 As int32
number
Optional
number
integer As int32 As int32
size
Optional
size
boolean
last
Optional
last
integer As int32 As int32
numberOfElements
Optional
numberOfElements
integer As int32 As int32
totalPages
Optional
totalPages
boolean
first
Optional
first
integer As int64 As int64
totalElements
Optional
totalElements
ParameterMapping
JSON Example
{
"key": "string"
}string
key
Optional
key
ParameterMappingCollection
JSON Example
{
"params": [
{
"key": "string"
}
]
}
Schema
JSON Example
{
"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": [
{}
]
}
}
]
}
Sort
This data structure has no properties.
TableView
JSON Example
{
"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"
]
}array of string
defaultSequence
Optional
defaultSequence
WorkItem
JSON Example
{
"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
WorkItemAction
JSON Example
{
"stateNameId": "string",
"stateName": "string",
"name": "string",
"icon": {
"image": [
"string"
],
"name": "string",
"id": "string",
"contentType": "string"
},
"id": "string"
}string
stateNameId
Optional
stateNameId
string
stateName
Optional
stateName
string
name
Optional
name
string
id
Required
id
WorkItemActionComplete
JSON Example
{
"workItemActionId": "string",
"formData": {
"entries": [
{
"key": "string"
}
]
},
"workItemId": "string"
}string
workItemActionId
Optional
workItemActionId
string As uuid As uuid
workItemId
Optional
workItemId
WorkItemActionIcon
JSON Example
{
"image": [
"string"
],
"name": "string",
"id": "string",
"contentType": "string"
}array of string
image
Required
image
string
name
Optional
name
string As uuid As uuid
id
Optional
id
string
contentType
Optional
contentType
WorkItemAssignee
JSON Example
{
"delegates": [
{
"displayName": "string",
"principalId": "string",
"principalType": "string"
}
]
}
WorkItemForms
This data structure has no properties.
WorkItemPrincipal
JSON Example
{
"displayName": "string",
"principalId": "string",
"principalType": "string"
}string
displayName
Optional
displayName
string
principalId
Required
principalId
string
principalType
Required
principalType
WorkItemRequest
JSON Example
{
"itemId": "string",
"itemName": "string",
"itemRequestor": "string",
"itemData": {
"entries": [
{
"key": "string"
}
]
},
"itemCost": "number",
"itemDescription": "string"
}string
itemId
Required
itemId
string
itemName
Required
itemName
string
itemRequestor
Required
itemRequestor
number As double As double
itemCost
Optional
itemCost
string
itemDescription
Required
itemDescription
WorkItemType
JSON Example
{
"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": {}
}string
pluralizedName
Optional
pluralizedName
string
commentsField
Optional
commentsField
boolean
completeByEmail
Optional
completeByEmail
string
name
Required
name
string
description
Optional
description
string
serviceTypeId
Optional
serviceTypeId
string
id
Optional
id
integer As int64 As int64
version
Optional
version
batchElementUpdateRequest
JSON Example
{
"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"
]
}string
trigger
Optional
trigger
array of string
affectedElements
Optional
affectedElements
booleanLiteral
Wraps a boolean value.
JSON Example
{
"value": "boolean"
}boolean
value
Optional
The boolean value.
elementValues
JSON Example
{
"values": [
{
"label": "string"
}
]
}
elementValuesRequest
JSON Example
{
"pagingInfo": {
"offset": "integer",
"count": "integer"
},
"headers": {
"entries": [
{
"key": "string"
}
]
},
"tenantId": "string",
"text": "string",
"userId": "string",
"dependencyValues": {
"entries": [
{
"key": "string"
}
]
}
}string
tenantId
Optional
tenantId
string
text
Optional
text
string
userId
Optional
userId
entities
JSON Example
{
"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"
}
]
}
form
JSON Example
{
"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"
}
]
}
}array of string
fieldPrefixes
Optional
fieldPrefixes
formUpdateResponse
JSON Example
{
"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"
]
}
]
}
layout
JSON Example
{
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
}
literal
Wraps a value such that values of different types can be treated generically.
This data structure has no properties.
literalMap
Equivalent of java.util.Map
JSON Example
{
"entries": [
{
"key": "string"
}
]
}
notificationStatus
JSON Example
{
"action": "string",
"comment": "string",
"entityId": "string",
"notificationId": "string",
"userId": "string"
}string
action
Optional
action
string
comment
Optional
comment
string
entityId
Optional
entityId
string
notificationId
Optional
notificationId
string
userId
Optional
userId
timeSpan
A literal defining period of time. This period is represented some integral number of a specified timeUnit.e.g. 6 days.
JSON Example
{
"unit": "string",
"amount": "integer"
}string
unit
Optional
The unit of measure for the time span. e.g: days.
integer As int64 As int64
amount
Optional
The amount for the time span.
updateElementEntry
JSON Example
{
"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"
]
}string
id
Optional
id
array of string
errors
Optional
errors
value
JSON Example
{
"label": "string"
}string
label
Optional
label
Node: apidepo-liferay-dxp-v1-be-w-1:8080: