Approval Service API Data Structures
ApprovableItem
JSON Example
{
"typeFilter": "string",
"name": "string",
"description": "string",
"id": "string",
"policyTypeId": "string",
"resourceType": "string"
}string
typeFilter
Optional
typeFilter
string
name
Optional
name
string
description
Optional
description
string
id
Optional
id
string
policyTypeId
Optional
policyTypeId
string
resourceType
Optional
resourceType
Approval
JSON Example
{
"requestedFor": "string",
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": "integer"
},
"quoteProvided": "boolean",
"lease": {
"unit": "string",
"amount": "integer"
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": "integer"
}
}
},
"requestInstanceId": "string",
"requestedItemName": "string",
"requestReasons": "string",
"requestingServiceId": "string",
"version": "integer",
"requestDescription": "string",
"requestedItemDescription": "string",
"completionTime": "string",
"requestedBy": "string",
"requestRef": "string",
"subTenantId": "string",
"createdDate": "string",
"tenantId": "string",
"cancelled": "boolean",
"startTime": "string",
"requestClassId": "string",
"id": "string",
"state": "string",
"lastModified": "string",
"requestedItemApprovals": [
{
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": "integer"
},
"quoteProvided": "boolean",
"lease": {
"unit": "string",
"amount": "integer"
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": "integer"
}
}
},
"requestInstanceId": "string",
"phaseDecision": {
"phase": {
"name": "string",
"description": "string",
"id": "string",
"levels": [
{
"approvalMode": "string",
"external": "boolean",
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": "integer",
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
}
],
"phasetype": {
"phaseOrder": "integer",
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": "boolean"
}
},
"completionTime": "string",
"phaseNumber": "integer",
"startTime": "string",
"decisions": [
{
"completionTime": "string",
"approvalMode": "string",
"level": {
"approvalMode": "string",
"external": "boolean",
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": "integer",
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
},
"approvalRequests": [
{
"creationTime": "string",
"workItemNumber": "integer",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"workItemId": "string",
"version": "integer",
"completionTime": "string",
"tenantId": "string",
"action": "string",
"wiqServiceId": "string",
"id": "string",
"businessJustification": "string",
"state": "string",
"assignTime": "string",
"completedBy": "string"
}
],
"phaseNumber": "integer",
"startTime": "string",
"id": "string",
"state": "string"
}
],
"id": "string",
"state": "string"
},
"requestedItemName": "string",
"phaseId": "string",
"phaseNumber": "integer",
"version": "integer",
"requestedItemDescription": "string",
"completionTime": "string",
"createdDate": "string",
"cancelled": "boolean",
"startTime": "string",
"requestClassId": "string",
"id": "string",
"state": "string",
"lastModified": "string",
"policy": {
"lastModifiedBy": "string",
"description": "string",
"version": "integer",
"createdDate": "string",
"approvableItemId": "string",
"typeFilter": "string",
"stateName": "string",
"createdBy": "string",
"policyType": {
"phaseTypes": [
{
"phaseOrder": "integer",
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": "boolean"
}
],
"classId": "string",
"typeFilter": "string",
"name": "string",
"description": "string",
"serviceTypeId": "string",
"id": "string"
},
"name": "string",
"id": "string",
"state": "string",
"lastModified": "string",
"approvableItemName": "string",
"approvableItemServiceTypeId": "string",
"phases": [
{
"name": "string",
"description": "string",
"id": "string",
"levels": [
{
"approvalMode": "string",
"external": "boolean",
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": "integer",
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
}
],
"phasetype": {
"phaseOrder": "integer",
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": "boolean"
}
}
]
}
}
]
}string
requestedFor
Optional
requestedFor
string
requestInstanceId
Optional
requestInstanceId
string
requestedItemName
Optional
requestedItemName
string
requestReasons
Optional
requestReasons
string
requestingServiceId
Required
requestingServiceId
integer As int64 As int64
version
Optional
version
string
requestDescription
Optional
requestDescription
string
requestedItemDescription
Optional
requestedItemDescription
string As date-time As date-time
completionTime
Optional
completionTime
string
requestedBy
Optional
requestedBy
string
requestRef
Optional
requestRef
string
subTenantId
Optional
subTenantId
string As date-time As date-time
createdDate
Optional
createdDate
string
tenantId
Optional
tenantId
boolean
cancelled
Optional
cancelled
string As date-time As date-time
startTime
Optional
startTime
string
requestClassId
Optional
requestClassId
string As uuid As uuid
id
Optional
id
string
state
Required
state
string As date-time As date-time
lastModified
Optional
lastModified
ApprovalDescriptiveReference
JSON Example
{
"name": "string",
"description": "string",
"id": "string"
}string
name
Optional
name
string
description
Optional
description
string
id
Optional
id
ApprovalForms
This data structure has no properties.
ApprovalInfo
JSON Example
{
"requestedFor": "string",
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": "integer"
},
"quoteProvided": "boolean",
"lease": {
"unit": "string",
"amount": "integer"
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": "integer"
}
}
},
"requestInstanceId": "string",
"requestedItemName": "string",
"requestReasons": "string",
"requestingServiceId": "string",
"requestDescription": "string",
"requestedItemDescription": "string",
"requestedBy": "string",
"requestRef": "string",
"subTenantId": "string",
"requestClassId": "string",
"id": "string",
"state": "string",
"requestedItemApprovals": [
{
"phase": {
"name": "string",
"description": "string",
"id": "string"
},
"requestedFor": "string",
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": "integer"
},
"quoteProvided": "boolean",
"lease": {
"unit": "string",
"amount": "integer"
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": "integer"
}
}
},
"requestInstanceId": "string",
"hasSourceDetailsForm": "boolean",
"requestedItemName": "string",
"requestReasons": "string",
"requestingServiceId": "string",
"requestDescription": "string",
"requestedItemDescription": "string",
"currentLevel": {
"mode": "string",
"completionTime": "string",
"request": [
{
"completionAction": "string",
"assignDate": "string",
"workItemNumber": "integer",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"completionDate": "string",
"businessJustification": "string",
"id": "string",
"workItemId": "string",
"state": "string",
"completedBy": "string"
}
],
"level": {
"name": "string",
"description": "string",
"id": "string"
},
"currentApprover": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"startTime": "string",
"id": "string",
"state": "string"
},
"requestedBy": "string",
"completionTime": "string",
"pastLevel": [
{
"mode": "string",
"completionTime": "string",
"request": [
{
"completionAction": "string",
"assignDate": "string",
"workItemNumber": "integer",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"completionDate": "string",
"businessJustification": "string",
"id": "string",
"workItemId": "string",
"state": "string",
"completedBy": "string"
}
],
"level": {
"name": "string",
"description": "string",
"id": "string"
},
"currentApprover": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"startTime": "string",
"id": "string",
"state": "string"
}
],
"requestRef": "string",
"subTenantId": "string",
"policyType": {
"name": "string",
"description": "string",
"id": "string"
},
"requestClassId": "string",
"startTime": "string",
"futureLevel": [
{
"mode": "string",
"completionTime": "string",
"request": [
{
"completionAction": "string",
"assignDate": "string",
"workItemNumber": "integer",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"completionDate": "string",
"businessJustification": "string",
"id": "string",
"workItemId": "string",
"state": "string",
"completedBy": "string"
}
],
"level": {
"name": "string",
"description": "string",
"id": "string"
},
"currentApprover": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"startTime": "string",
"id": "string",
"state": "string"
}
],
"id": "string",
"state": "string",
"policy": {
"name": "string",
"description": "string",
"id": "string"
}
}
]
}string
requestedFor
Optional
requestedFor
string
requestInstanceId
Required
requestInstanceId
string
requestedItemName
Required
requestedItemName
string
requestReasons
Optional
requestReasons
string
requestingServiceId
Required
requestingServiceId
string
requestDescription
Optional
requestDescription
string
requestedItemDescription
Optional
requestedItemDescription
string
requestedBy
Optional
requestedBy
string
requestRef
Optional
requestRef
string
subTenantId
Optional
subTenantId
string
requestClassId
Required
requestClassId
string
id
Optional
id
string
state
Optional
state
ApprovalLevel
JSON Example
{
"approvalMode": "string",
"external": "boolean",
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": "integer",
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
}string
approvalMode
Required
approvalMode
boolean
external
Optional
external
string
name
Required
name
integer As int32 As int32
levelNumber
Optional
levelNumber
string
description
Optional
description
string As uuid As uuid
id
Optional
id
ApprovalLevelDecision
JSON Example
{
"completionTime": "string",
"approvalMode": "string",
"level": {
"approvalMode": "string",
"external": "boolean",
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": "integer",
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
},
"approvalRequests": [
{
"creationTime": "string",
"workItemNumber": "integer",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"workItemId": "string",
"version": "integer",
"completionTime": "string",
"tenantId": "string",
"action": "string",
"wiqServiceId": "string",
"id": "string",
"businessJustification": "string",
"state": "string",
"assignTime": "string",
"completedBy": "string"
}
],
"phaseNumber": "integer",
"startTime": "string",
"id": "string",
"state": "string"
}string As date-time As date-time
completionTime
Optional
completionTime
string
approvalMode
Optional
approvalMode
integer As int32 As int32
phaseNumber
Optional
phaseNumber
string As date-time As date-time
startTime
Optional
startTime
string As uuid As uuid
id
Optional
id
string
state
Optional
state
ApprovalLevelStatusInfo
JSON Example
{
"mode": "string",
"completionTime": "string",
"request": [
{
"completionAction": "string",
"assignDate": "string",
"workItemNumber": "integer",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"completionDate": "string",
"businessJustification": "string",
"id": "string",
"workItemId": "string",
"state": "string",
"completedBy": "string"
}
],
"level": {
"name": "string",
"description": "string",
"id": "string"
},
"currentApprover": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"startTime": "string",
"id": "string",
"state": "string"
}string
mode
Optional
mode
string As date-time As date-time
completionTime
Optional
completionTime
string As date-time As date-time
startTime
Optional
startTime
string
id
Optional
id
string
state
Optional
state
ApprovalPhaseType
JSON Example
{
"phaseOrder": "integer",
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": "boolean"
}integer As int32 As int32
phaseOrder
Optional
phaseOrder
string
name
Optional
name
string
description
Optional
description
string
id
Required
id
boolean
allowUpdates
Optional
allowUpdates
ApprovalPolicy
JSON Example
{
"lastModifiedBy": "string",
"description": "string",
"version": "integer",
"createdDate": "string",
"approvableItemId": "string",
"typeFilter": "string",
"stateName": "string",
"createdBy": "string",
"policyType": {
"phaseTypes": [
{
"phaseOrder": "integer",
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": "boolean"
}
],
"classId": "string",
"typeFilter": "string",
"name": "string",
"description": "string",
"serviceTypeId": "string",
"id": "string"
},
"name": "string",
"id": "string",
"state": "string",
"lastModified": "string",
"approvableItemName": "string",
"approvableItemServiceTypeId": "string",
"phases": [
{
"name": "string",
"description": "string",
"id": "string",
"levels": [
{
"approvalMode": "string",
"external": "boolean",
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": "integer",
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
}
],
"phasetype": {
"phaseOrder": "integer",
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": "boolean"
}
}
]
}string
lastModifiedBy
Optional
lastModifiedBy
string
description
Optional
description
integer As int64 As int64
version
Optional
version
string As date-time As date-time
createdDate
Optional
createdDate
string
approvableItemId
Optional
approvableItemId
string
typeFilter
Optional
typeFilter
string
stateName
Optional
stateName
string
createdBy
Optional
createdBy
string
name
Required
name
string As uuid As uuid
id
Optional
id
string
state
Required
state
string As date-time As date-time
lastModified
Optional
lastModified
string
approvableItemName
Optional
approvableItemName
string
approvableItemServiceTypeId
Optional
approvableItemServiceTypeId
Property Of
Parameter To
ApprovalPolicyEvaluationSpec
JSON Example
{
"requestedFor": "string",
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": "integer"
},
"quoteProvided": "boolean",
"lease": {
"unit": "string",
"amount": "integer"
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": "integer"
}
}
},
"requestInstanceId": "string",
"requestedItemName": "string",
"requestReasons": "string",
"requestedItems": [
{
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": "integer"
},
"quoteProvided": "boolean",
"lease": {
"unit": "string",
"amount": "integer"
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": "integer"
}
}
},
"requestInstanceId": "string",
"policyId": "string",
"phaseId": "string",
"requestedItemName": "string",
"requestClassId": "string",
"requestedItemDescription": "string"
}
],
"requestingServiceId": "string",
"requestDescription": "string",
"requestedItemDescription": "string",
"requestedBy": "string",
"requestRef": "string",
"subTenantId": "string",
"requestClassId": "string"
}string
requestedFor
Optional
requestedFor
string
requestInstanceId
Required
requestInstanceId
string
requestedItemName
Optional
requestedItemName
string
requestReasons
Optional
requestReasons
string
requestingServiceId
Required
requestingServiceId
string
requestDescription
Optional
requestDescription
string
requestedItemDescription
Optional
requestedItemDescription
string
requestedBy
Optional
requestedBy
string
requestRef
Optional
requestRef
string
subTenantId
Optional
subTenantId
string
requestClassId
Required
requestClassId
ApprovalPolicyType
JSON Example
{
"phaseTypes": [
{
"phaseOrder": "integer",
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": "boolean"
}
],
"classId": "string",
"typeFilter": "string",
"name": "string",
"description": "string",
"serviceTypeId": "string",
"id": "string"
}string
classId
Optional
classId
string
typeFilter
Optional
typeFilter
string
name
Optional
name
string
description
Optional
description
string
serviceTypeId
Optional
serviceTypeId
string
id
Optional
id
Property Of
ApprovalPrincipal
JSON Example
{
"displayName": "string",
"type": "string",
"value": "string"
}string
displayName
Optional
displayName
string
type
Required
type
string
value
Required
value
ApprovalRequest
JSON Example
{
"creationTime": "string",
"workItemNumber": "integer",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"workItemId": "string",
"version": "integer",
"completionTime": "string",
"tenantId": "string",
"action": "string",
"wiqServiceId": "string",
"id": "string",
"businessJustification": "string",
"state": "string",
"assignTime": "string",
"completedBy": "string"
}string As date-time As date-time
creationTime
Optional
creationTime
integer As int64 As int64
workItemNumber
Optional
workItemNumber
string
workItemId
Optional
workItemId
integer As int64 As int64
version
Optional
version
string As date-time As date-time
completionTime
Optional
completionTime
string
tenantId
Optional
tenantId
string
action
Optional
action
string
wiqServiceId
Optional
wiqServiceId
string As uuid As uuid
id
Optional
id
string
businessJustification
Optional
businessJustification
string
state
Optional
state
string As date-time As date-time
assignTime
Optional
assignTime
string
completedBy
Optional
completedBy
ApprovalRequestCosts
JSON Example
{
"leaseForDisplay": {
"unit": "string",
"amount": "integer"
},
"quoteProvided": "boolean",
"lease": {
"unit": "string",
"amount": "integer"
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": "integer"
}
}
}boolean
quoteProvided
Optional
quoteProvided
ApprovalRequestInfo
JSON Example
{
"requestedItemApproval": {
"phase": {
"name": "string",
"description": "string",
"id": "string"
},
"requestedFor": "string",
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": "integer"
},
"quoteProvided": "boolean",
"lease": {
"unit": "string",
"amount": "integer"
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": "integer"
}
}
},
"requestInstanceId": "string",
"hasSourceDetailsForm": "boolean",
"requestedItemName": "string",
"requestReasons": "string",
"requestingServiceId": "string",
"requestDescription": "string",
"requestedItemDescription": "string",
"requestedBy": "string",
"completionTime": "string",
"requestRef": "string",
"subTenantId": "string",
"policyType": {
"name": "string",
"description": "string",
"id": "string"
},
"requestClassId": "string",
"startTime": "string",
"id": "string",
"state": "string",
"policy": {
"name": "string",
"description": "string",
"id": "string"
}
},
"approver": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"infoItems": [
{
"approver": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"level": {
"name": "string",
"description": "string",
"id": "string"
},
"approval": {
"phase": {
"name": "string",
"description": "string",
"id": "string"
},
"requestedFor": "string",
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": "integer"
},
"quoteProvided": "boolean",
"lease": {
"unit": "string",
"amount": "integer"
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": "integer"
}
}
},
"requestInstanceId": "string",
"hasSourceDetailsForm": "boolean",
"requestedItemName": "string",
"requestReasons": "string",
"requestingServiceId": "string",
"requestDescription": "string",
"requestedItemDescription": "string",
"requestedBy": "string",
"completionTime": "string",
"requestRef": "string",
"subTenantId": "string",
"policyType": {
"name": "string",
"description": "string",
"id": "string"
},
"requestClassId": "string",
"startTime": "string",
"id": "string",
"state": "string",
"policy": {
"name": "string",
"description": "string",
"id": "string"
}
},
"businessJustification": "string",
"id": "string"
}
],
"completionAction": "string",
"level": {
"name": "string",
"description": "string",
"id": "string"
},
"tenantId": "string",
"workItem": {
"assignedDate": "string",
"number": "integer",
"createdDate": "string",
"id": "string",
"assignedTo": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"completedDate": "string",
"completedBy": "string",
"status": "string"
},
"businessJustification": "string",
"id": "string",
"state": "string"
}string
completionAction
Optional
completionAction
string
tenantId
Optional
tenantId
string
businessJustification
Optional
businessJustification
string
id
Optional
id
string
state
Optional
state
ApprovalRequestItemInfo
JSON Example
{
"approver": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"level": {
"name": "string",
"description": "string",
"id": "string"
},
"approval": {
"phase": {
"name": "string",
"description": "string",
"id": "string"
},
"requestedFor": "string",
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": "integer"
},
"quoteProvided": "boolean",
"lease": {
"unit": "string",
"amount": "integer"
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": "integer"
}
}
},
"requestInstanceId": "string",
"hasSourceDetailsForm": "boolean",
"requestedItemName": "string",
"requestReasons": "string",
"requestingServiceId": "string",
"requestDescription": "string",
"requestedItemDescription": "string",
"requestedBy": "string",
"completionTime": "string",
"requestRef": "string",
"subTenantId": "string",
"policyType": {
"name": "string",
"description": "string",
"id": "string"
},
"requestClassId": "string",
"startTime": "string",
"id": "string",
"state": "string",
"policy": {
"name": "string",
"description": "string",
"id": "string"
}
},
"businessJustification": "string",
"id": "string"
}string
businessJustification
Optional
businessJustification
string
id
Optional
id
ApprovalRequestStatusInfo
JSON Example
{
"completionAction": "string",
"assignDate": "string",
"workItemNumber": "integer",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"completionDate": "string",
"businessJustification": "string",
"id": "string",
"workItemId": "string",
"state": "string",
"completedBy": "string"
}string
completionAction
Optional
completionAction
string As date-time As date-time
assignDate
Optional
assignDate
integer As int64 As int64
workItemNumber
Optional
workItemNumber
string As date-time As date-time
completionDate
Optional
completionDate
string
businessJustification
Optional
businessJustification
string
id
Optional
id
string
workItemId
Optional
workItemId
string
state
Optional
state
string
completedBy
Optional
completedBy
ApprovalWorkItemInfo
JSON Example
{
"assignedDate": "string",
"number": "integer",
"createdDate": "string",
"id": "string",
"assignedTo": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"completedDate": "string",
"completedBy": "string",
"status": "string"
}string As date-time As date-time
assignedDate
Optional
assignedDate
integer As int64 As int64
number
Optional
number
string As date-time As date-time
createdDate
Optional
createdDate
string
id
Optional
id
string As date-time As date-time
completedDate
Optional
completedDate
string
completedBy
Optional
completedBy
string
status
Optional
status
Clause
This data structure has no properties.
CriteriaOperator
This data structure has no properties.
DataContext
This data structure has no properties.
DataType
JSON Example
{
"typeId": "string"
}string
typeId
Optional
typeId
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
FieldInsinuation
This data structure has no properties.
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.
InlineMonetaryValue1
Base type for representing monetary values, encapsulating both some kind of quantity and a currency.
This data structure has no properties.
string
currencyCode
Optional
The ISO 4217 code used to identify the currency (if any) associated with this value.
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
LiteralMapEntry
JSON Example
{
"key": "string"
}string
key
Optional
key
MonetaryValue
AllOf
JSON Example
{
"currencyCode": "string"
}
PageApprovableItem
JSON Example
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"typeFilter": "string",
"name": "string",
"description": "string",
"id": "string",
"policyTypeId": "string",
"resourceType": "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
PageApproval
JSON Example
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"requestedFor": "string",
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": "integer"
},
"quoteProvided": "boolean",
"lease": {
"unit": "string",
"amount": "integer"
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": "integer"
}
}
},
"requestInstanceId": "string",
"requestedItemName": "string",
"requestReasons": "string",
"requestingServiceId": "string",
"version": "integer",
"requestDescription": "string",
"requestedItemDescription": "string",
"completionTime": "string",
"requestedBy": "string",
"requestRef": "string",
"subTenantId": "string",
"createdDate": "string",
"tenantId": "string",
"cancelled": "boolean",
"startTime": "string",
"requestClassId": "string",
"id": "string",
"state": "string",
"lastModified": "string",
"requestedItemApprovals": [
{
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": "integer"
},
"quoteProvided": "boolean",
"lease": {
"unit": "string",
"amount": "integer"
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": "integer"
}
}
},
"requestInstanceId": "string",
"phaseDecision": {
"phase": {
"name": "string",
"description": "string",
"id": "string",
"levels": [
{
"approvalMode": "string",
"external": "boolean",
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": "integer",
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
}
],
"phasetype": {
"phaseOrder": "integer",
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": "boolean"
}
},
"completionTime": "string",
"phaseNumber": "integer",
"startTime": "string",
"decisions": [
{
"completionTime": "string",
"approvalMode": "string",
"level": {
"approvalMode": "string",
"external": "boolean",
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": "integer",
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
},
"approvalRequests": [
{
"creationTime": "string",
"workItemNumber": "integer",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"workItemId": "string",
"version": "integer",
"completionTime": "string",
"tenantId": "string",
"action": "string",
"wiqServiceId": "string",
"id": "string",
"businessJustification": "string",
"state": "string",
"assignTime": "string",
"completedBy": "string"
}
],
"phaseNumber": "integer",
"startTime": "string",
"id": "string",
"state": "string"
}
],
"id": "string",
"state": "string"
},
"requestedItemName": "string",
"phaseId": "string",
"phaseNumber": "integer",
"version": "integer",
"requestedItemDescription": "string",
"completionTime": "string",
"createdDate": "string",
"cancelled": "boolean",
"startTime": "string",
"requestClassId": "string",
"id": "string",
"state": "string",
"lastModified": "string",
"policy": {
"lastModifiedBy": "string",
"description": "string",
"version": "integer",
"createdDate": "string",
"approvableItemId": "string",
"typeFilter": "string",
"stateName": "string",
"createdBy": "string",
"policyType": {
"phaseTypes": [
{
"phaseOrder": "integer",
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": "boolean"
}
],
"classId": "string",
"typeFilter": "string",
"name": "string",
"description": "string",
"serviceTypeId": "string",
"id": "string"
},
"name": "string",
"id": "string",
"state": "string",
"lastModified": "string",
"approvableItemName": "string",
"approvableItemServiceTypeId": "string",
"phases": [
{
"name": "string",
"description": "string",
"id": "string",
"levels": [
{
"approvalMode": "string",
"external": "boolean",
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": "integer",
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
}
],
"phasetype": {
"phaseOrder": "integer",
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": "boolean"
}
}
]
}
}
]
}
],
"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"
}
]
}
PermissibleValueList
JSON Example
{
"customAllowed": "boolean"
}boolean
customAllowed
Optional
customAllowed
Phase
JSON Example
{
"name": "string",
"description": "string",
"id": "string",
"levels": [
{
"approvalMode": "string",
"external": "boolean",
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": "integer",
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
}
],
"phasetype": {
"phaseOrder": "integer",
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": "boolean"
}
}string
name
Optional
name
string
description
Optional
description
string As uuid As uuid
id
Optional
id
PhaseDecision
JSON Example
{
"phase": {
"name": "string",
"description": "string",
"id": "string",
"levels": [
{
"approvalMode": "string",
"external": "boolean",
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": "integer",
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
}
],
"phasetype": {
"phaseOrder": "integer",
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": "boolean"
}
},
"completionTime": "string",
"phaseNumber": "integer",
"startTime": "string",
"decisions": [
{
"completionTime": "string",
"approvalMode": "string",
"level": {
"approvalMode": "string",
"external": "boolean",
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": "integer",
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
},
"approvalRequests": [
{
"creationTime": "string",
"workItemNumber": "integer",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"workItemId": "string",
"version": "integer",
"completionTime": "string",
"tenantId": "string",
"action": "string",
"wiqServiceId": "string",
"id": "string",
"businessJustification": "string",
"state": "string",
"assignTime": "string",
"completedBy": "string"
}
],
"phaseNumber": "integer",
"startTime": "string",
"id": "string",
"state": "string"
}
],
"id": "string",
"state": "string"
}string As date-time As date-time
completionTime
Optional
completionTime
integer As int32 As int32
phaseNumber
Optional
phaseNumber
string As date-time As date-time
startTime
Optional
startTime
string As uuid As uuid
id
Optional
id
string
state
Optional
state
RequestedItem
JSON Example
{
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": "integer"
},
"quoteProvided": "boolean",
"lease": {
"unit": "string",
"amount": "integer"
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": "integer"
}
}
},
"requestInstanceId": "string",
"policyId": "string",
"phaseId": "string",
"requestedItemName": "string",
"requestClassId": "string",
"requestedItemDescription": "string"
}string
requestInstanceId
Required
requestInstanceId
string
policyId
Required
policyId
string
phaseId
Required
phaseId
string
requestedItemName
Required
requestedItemName
string
requestClassId
Required
requestClassId
string
requestedItemDescription
Optional
requestedItemDescription
RequestedItemApproval
JSON Example
{
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": "integer"
},
"quoteProvided": "boolean",
"lease": {
"unit": "string",
"amount": "integer"
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": "integer"
}
}
},
"requestInstanceId": "string",
"phaseDecision": {
"phase": {
"name": "string",
"description": "string",
"id": "string",
"levels": [
{
"approvalMode": "string",
"external": "boolean",
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": "integer",
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
}
],
"phasetype": {
"phaseOrder": "integer",
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": "boolean"
}
},
"completionTime": "string",
"phaseNumber": "integer",
"startTime": "string",
"decisions": [
{
"completionTime": "string",
"approvalMode": "string",
"level": {
"approvalMode": "string",
"external": "boolean",
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": "integer",
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
},
"approvalRequests": [
{
"creationTime": "string",
"workItemNumber": "integer",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"workItemId": "string",
"version": "integer",
"completionTime": "string",
"tenantId": "string",
"action": "string",
"wiqServiceId": "string",
"id": "string",
"businessJustification": "string",
"state": "string",
"assignTime": "string",
"completedBy": "string"
}
],
"phaseNumber": "integer",
"startTime": "string",
"id": "string",
"state": "string"
}
],
"id": "string",
"state": "string"
},
"requestedItemName": "string",
"phaseId": "string",
"phaseNumber": "integer",
"version": "integer",
"requestedItemDescription": "string",
"completionTime": "string",
"createdDate": "string",
"cancelled": "boolean",
"startTime": "string",
"requestClassId": "string",
"id": "string",
"state": "string",
"lastModified": "string",
"policy": {
"lastModifiedBy": "string",
"description": "string",
"version": "integer",
"createdDate": "string",
"approvableItemId": "string",
"typeFilter": "string",
"stateName": "string",
"createdBy": "string",
"policyType": {
"phaseTypes": [
{
"phaseOrder": "integer",
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": "boolean"
}
],
"classId": "string",
"typeFilter": "string",
"name": "string",
"description": "string",
"serviceTypeId": "string",
"id": "string"
},
"name": "string",
"id": "string",
"state": "string",
"lastModified": "string",
"approvableItemName": "string",
"approvableItemServiceTypeId": "string",
"phases": [
{
"name": "string",
"description": "string",
"id": "string",
"levels": [
{
"approvalMode": "string",
"external": "boolean",
"editSchema": {
"fields": [
{}
]
},
"name": "string",
"levelNumber": "integer",
"description": "string",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"id": "string"
}
],
"phasetype": {
"phaseOrder": "integer",
"name": "string",
"description": "string",
"id": "string",
"forms": {},
"allowUpdates": "boolean"
}
}
]
}
}string
requestInstanceId
Required
requestInstanceId
string
requestedItemName
Required
requestedItemName
string
phaseId
Required
phaseId
integer As int32 As int32
phaseNumber
Optional
phaseNumber
integer As int64 As int64
version
Optional
version
string
requestedItemDescription
Optional
requestedItemDescription
string As date-time As date-time
completionTime
Optional
completionTime
string As date-time As date-time
createdDate
Optional
createdDate
boolean
cancelled
Optional
cancelled
string As date-time As date-time
startTime
Optional
startTime
string
requestClassId
Required
requestClassId
string As uuid As uuid
id
Optional
id
string
state
Required
state
string As date-time As date-time
lastModified
Optional
lastModified
RequestedItemApprovalInfo
JSON Example
{
"phase": {
"name": "string",
"description": "string",
"id": "string"
},
"requestedFor": "string",
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": "integer"
},
"quoteProvided": "boolean",
"lease": {
"unit": "string",
"amount": "integer"
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": "integer"
}
}
},
"requestInstanceId": "string",
"hasSourceDetailsForm": "boolean",
"requestedItemName": "string",
"requestReasons": "string",
"requestingServiceId": "string",
"requestDescription": "string",
"requestedItemDescription": "string",
"currentLevel": {
"mode": "string",
"completionTime": "string",
"request": [
{
"completionAction": "string",
"assignDate": "string",
"workItemNumber": "integer",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"completionDate": "string",
"businessJustification": "string",
"id": "string",
"workItemId": "string",
"state": "string",
"completedBy": "string"
}
],
"level": {
"name": "string",
"description": "string",
"id": "string"
},
"currentApprover": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"startTime": "string",
"id": "string",
"state": "string"
},
"requestedBy": "string",
"completionTime": "string",
"pastLevel": [
{
"mode": "string",
"completionTime": "string",
"request": [
{
"completionAction": "string",
"assignDate": "string",
"workItemNumber": "integer",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"completionDate": "string",
"businessJustification": "string",
"id": "string",
"workItemId": "string",
"state": "string",
"completedBy": "string"
}
],
"level": {
"name": "string",
"description": "string",
"id": "string"
},
"currentApprover": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"startTime": "string",
"id": "string",
"state": "string"
}
],
"requestRef": "string",
"subTenantId": "string",
"policyType": {
"name": "string",
"description": "string",
"id": "string"
},
"requestClassId": "string",
"startTime": "string",
"futureLevel": [
{
"mode": "string",
"completionTime": "string",
"request": [
{
"completionAction": "string",
"assignDate": "string",
"workItemNumber": "integer",
"approvers": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"completionDate": "string",
"businessJustification": "string",
"id": "string",
"workItemId": "string",
"state": "string",
"completedBy": "string"
}
],
"level": {
"name": "string",
"description": "string",
"id": "string"
},
"currentApprover": [
{
"displayName": "string",
"type": "string",
"value": "string"
}
],
"startTime": "string",
"id": "string",
"state": "string"
}
],
"id": "string",
"state": "string",
"policy": {
"name": "string",
"description": "string",
"id": "string"
}
}string
requestedFor
Optional
requestedFor
string
requestInstanceId
Required
requestInstanceId
boolean
hasSourceDetailsForm
Optional
hasSourceDetailsForm
string
requestedItemName
Required
requestedItemName
string
requestReasons
Optional
requestReasons
string
requestingServiceId
Required
requestingServiceId
string
requestDescription
Optional
requestDescription
string
requestedItemDescription
Optional
requestedItemDescription
string
requestedBy
Optional
requestedBy
string As date-time As date-time
completionTime
Optional
completionTime
string
requestRef
Optional
requestRef
string
subTenantId
Optional
subTenantId
string
requestClassId
Required
requestClassId
string As date-time As date-time
startTime
Optional
startTime
string
id
Optional
id
string
state
Optional
state
RequestedItemApprovalStatusInfo
JSON Example
{
"phase": {
"name": "string",
"description": "string",
"id": "string"
},
"requestedFor": "string",
"costs": {
"leaseForDisplay": {
"unit": "string",
"amount": "integer"
},
"quoteProvided": "boolean",
"lease": {
"unit": "string",
"amount": "integer"
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": "integer"
}
}
},
"requestInstanceId": "string",
"hasSourceDetailsForm": "boolean",
"requestedItemName": "string",
"requestReasons": "string",
"requestingServiceId": "string",
"requestDescription": "string",
"requestedItemDescription": "string",
"requestedBy": "string",
"completionTime": "string",
"requestRef": "string",
"subTenantId": "string",
"policyType": {
"name": "string",
"description": "string",
"id": "string"
},
"requestClassId": "string",
"startTime": "string",
"id": "string",
"state": "string",
"policy": {
"name": "string",
"description": "string",
"id": "string"
}
}string
requestedFor
Optional
requestedFor
string
requestInstanceId
Required
requestInstanceId
boolean
hasSourceDetailsForm
Optional
hasSourceDetailsForm
string
requestedItemName
Required
requestedItemName
string
requestReasons
Optional
requestReasons
string
requestingServiceId
Required
requestingServiceId
string
requestDescription
Optional
requestDescription
string
requestedItemDescription
Optional
requestedItemDescription
string
requestedBy
Optional
requestedBy
string As date-time As date-time
completionTime
Optional
completionTime
string
requestRef
Optional
requestRef
string
subTenantId
Optional
subTenantId
string
requestClassId
Required
requestClassId
string As date-time As date-time
startTime
Optional
startTime
string
id
Optional
id
string
state
Optional
state
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.
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"
}
]
}
Returned By
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
Parameter To
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"
}
]
}
moneyTimeRate
Represents a rate of money over time.
JSON Example
{
"basis": {
"unit": "string",
"amount": "integer"
}
}
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
workItemCallbackAction
JSON Example
{
"targetId": "string",
"workItemTypeId": "string",
"formData": {
"entries": [
{
"key": "string"
}
]
},
"workItemId": "string",
"assignee": "string",
"completeActionId": "string",
"completedDate": "string"
}string
targetId
Optional
targetId
string
workItemTypeId
Optional
workItemTypeId
string
workItemId
Optional
workItemId
string
assignee
Optional
assignee
string
completeActionId
Optional
completeActionId
string As date-time As date-time
completedDate
Optional
completedDate
Node: apidepo-liferay-dxp-v1-be-w-0:8080: