Composition Service API Data Structures
AllocateRequestCompletion
JSON Example
{
"result": {
"data": {
"entries": [
{
"key": "string"
}
]
}
},
"success": "boolean",
"completionDetails": "string"
}boolean
success
Optional
success
string
completionDetails
Optional
completionDetails
AllocationConstraint
JSON Example
{
"filter": "string"
}string
filter
Optional
filter
BlueprintDocument
JSON Example
{
"name": "string",
"description": "string",
"id": "string",
"status": "string",
"propertyGroups": [
"string"
]
}object
layout
Optional
layout
object
components
Optional
components
string
name
Optional
name
string
description
Optional
description
string
id
Optional
id
object
properties
Optional
properties
string
status
Optional
status
array of string
propertyGroups
Optional
propertyGroups
Clause
This data structure has no properties.
ComponentAllocationInfo
JSON Example
{
"data": {
"entries": [
{
"key": "string"
}
]
}
}
ComponentDeclaration
JSON Example
{
"dependson": [
"string"
],
"componentProfiles": [
{
"permissibleValueNames": [
"string"
],
"defaultValueName": "string",
"id": "string"
}
],
"type": "string",
"propertyGroups": [
"string"
]
}object
data
Optional
data
array of string
dependson
Optional
dependson
string
type
Optional
type
array of string
propertyGroups
Optional
propertyGroups
ComponentFieldValue
JSON Example
{
"permittedValues": {
"customAllowed": "boolean"
}
}object
data
Optional
data
object
facets
Optional
facets
ComponentInfo
JSON Example
{
"dependsOn": [
"string"
],
"componentProfiles": [
{
"permissibleValueNames": [
"string"
],
"defaultValueName": "string",
"id": "string"
}
],
"type": "string",
"propertyGroups": [
"string"
]
}array of string
dependsOn
Optional
dependsOn
object
data
Optional
data
string
type
Optional
type
array of string
propertyGroups
Optional
propertyGroups
ComponentProfileInfo
JSON Example
{
"permissibleValueNames": [
"string"
],
"defaultValueName": "string",
"id": "string"
}array of string
permissibleValueNames
Optional
permissibleValueNames
string
defaultValueName
Optional
defaultValueName
string
id
Optional
id
ComponentRequestInfo
JSON Example
{
"resourceId": "string",
"componentId": "string",
"componentTypeId": "string",
"requestInputData": {
"entries": [
{
"key": "string"
}
]
},
"previousComponentData": {
"entries": [
{
"key": "string"
}
]
},
"componentSchema": {
"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": [
{}
]
}
}
]
},
"componentData": {
"entries": [
{
"key": "string"
}
]
}
}string
resourceId
Optional
resourceId
string
componentId
Optional
componentId
string
componentTypeId
Optional
componentTypeId
ComponentType
JSON Example
{
"iconId": "string",
"schema": {
"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": [
{}
]
}
}
]
},
"catalogItemTypeId": "string",
"supportLenientDestroy": "boolean",
"description": "string",
"callbacks": {
"rollback": "boolean",
"allocate": "boolean",
"requestDetails": "boolean",
"listOffers": "boolean",
"destroy": "boolean",
"clusterBehavior": "string",
"validate": "boolean"
},
"outputResourceTypeId": "string",
"version": "integer",
"idForEntitlements": "string",
"lastUpdated": "string",
"classId": "string",
"createdDate": "string",
"name": "string",
"tenantId": "string",
"requiredPermissionIds": [
"string"
],
"serviceTypeId": "string",
"allocationRelatedResourceTypeIds": [
"string"
],
"id": "string",
"serviceId": "string",
"forms": {},
"categoryId": "string",
"containerFieldId": "string"
}string
iconId
Optional
iconId
string
catalogItemTypeId
Optional
catalogItemTypeId
boolean
supportLenientDestroy
Optional
supportLenientDestroy
string
description
Optional
description
string
outputResourceTypeId
Optional
outputResourceTypeId
integer As int64 As int64
version
Optional
version
string
idForEntitlements
Optional
idForEntitlements
string As date-time As date-time
lastUpdated
Optional
lastUpdated
string
classId
Optional
classId
string As date-time As date-time
createdDate
Optional
createdDate
string
name
Optional
name
string
tenantId
Optional
tenantId
array of string
requiredPermissionIds
Optional
requiredPermissionIds
string
serviceTypeId
Optional
serviceTypeId
array of string
allocationRelatedResourceTypeIds
Optional
allocationRelatedResourceTypeIds
string
id
Optional
id
string
serviceId
Optional
serviceId
string
categoryId
Optional
categoryId
string
containerFieldId
Optional
containerFieldId
Property Of
ComponentTypeCallbackSupport
JSON Example
{
"rollback": "boolean",
"allocate": "boolean",
"requestDetails": "boolean",
"listOffers": "boolean",
"destroy": "boolean",
"clusterBehavior": "string",
"validate": "boolean"
}boolean
rollback
Optional
rollback
boolean
allocate
Optional
allocate
boolean
requestDetails
Optional
requestDetails
boolean
listOffers
Optional
listOffers
boolean
destroy
Optional
destroy
string
clusterBehavior
Required
clusterBehavior
boolean
validate
Optional
validate
ComponentTypeCategory
An instance of the available categories on the CBP Editor
JSON Example
{
"iconId": "string",
"name": "string",
"description": "string",
"id": "string",
"type": "string",
"properties": "string",
"order": "integer"
}string
iconId
Optional
ID of the icon of the category
string
name
Optional
Localization key of the name of the category
string
description
Optional
Localization key of the description of the category
string
id
Optional
ID of the composition category
string
type
Optional
Type of the category
string
properties
Optional
JSON serialized string of extra properties of the categories such as permissions or if it should be hidden etc.
integer As int32 As int32
order
Optional
The order of the category in which it should appear on the UI
ComponentTypeExtension
JSON Example
{
"componentType": {
"iconId": "string",
"schema": {
"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": [
{}
]
}
}
]
},
"catalogItemTypeId": "string",
"supportLenientDestroy": "boolean",
"description": "string",
"callbacks": {
"rollback": "boolean",
"allocate": "boolean",
"requestDetails": "boolean",
"listOffers": "boolean",
"destroy": "boolean",
"clusterBehavior": "string",
"validate": "boolean"
},
"outputResourceTypeId": "string",
"version": "integer",
"idForEntitlements": "string",
"lastUpdated": "string",
"classId": "string",
"createdDate": "string",
"name": "string",
"tenantId": "string",
"requiredPermissionIds": [
"string"
],
"serviceTypeId": "string",
"allocationRelatedResourceTypeIds": [
"string"
],
"id": "string",
"serviceId": "string",
"forms": {},
"categoryId": "string",
"containerFieldId": "string"
},
"lastUpdated": "string",
"createdDate": "string",
"tenantId": "string",
"name": "string",
"description": "string",
"id": "string",
"version": "integer",
"fieldIds": [
"string"
]
}string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
string
tenantId
Optional
tenantId
string
name
Optional
name
string
description
Optional
description
string
id
Optional
id
integer As int64 As int64
version
Optional
version
array of string
fieldIds
Optional
fieldIds
Returned By
ComponentTypeExtensionValue
JSON Example
{
"lastUpdated": "string",
"valuesMap": {
"entries": [
{
"key": "string"
}
]
},
"componentTypeExtension": {
"componentType": {
"iconId": "string",
"schema": {
"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": [
{}
]
}
}
]
},
"catalogItemTypeId": "string",
"supportLenientDestroy": "boolean",
"description": "string",
"callbacks": {
"rollback": "boolean",
"allocate": "boolean",
"requestDetails": "boolean",
"listOffers": "boolean",
"destroy": "boolean",
"clusterBehavior": "string",
"validate": "boolean"
},
"outputResourceTypeId": "string",
"version": "integer",
"idForEntitlements": "string",
"lastUpdated": "string",
"classId": "string",
"createdDate": "string",
"name": "string",
"tenantId": "string",
"requiredPermissionIds": [
"string"
],
"serviceTypeId": "string",
"allocationRelatedResourceTypeIds": [
"string"
],
"id": "string",
"serviceId": "string",
"forms": {},
"categoryId": "string",
"containerFieldId": "string"
},
"lastUpdated": "string",
"createdDate": "string",
"tenantId": "string",
"name": "string",
"description": "string",
"id": "string",
"version": "integer",
"fieldIds": [
"string"
]
},
"createdDate": "string",
"isEnabled": "boolean",
"name": "string",
"tenantId": "string",
"description": "string",
"label": "string",
"version": "integer"
}string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
boolean
isEnabled
Optional
isEnabled
string
name
Optional
name
string
tenantId
Optional
tenantId
string
description
Optional
description
string
label
Optional
label
integer As int64 As int64
version
Optional
version
ComponentTypeForms
This data structure has no properties.
object
formsByScenario
Optional
formsByScenario
CompositeBlueprint
JSON Example
{
"catalogItemTypeId": "string",
"description": "string",
"externalId": "string",
"version": "integer",
"propertyGroups": [
"string"
],
"lastUpdated": "string",
"createdDate": "string",
"tenantId": "string",
"name": "string",
"publishStatusName": "string",
"snapshotVersion": "string",
"customFormStatusName": "string",
"id": "string",
"publishStatus": "string",
"customFormStatus": "string"
}object
components
Optional
components
string
catalogItemTypeId
Optional
catalogItemTypeId
string
description
Optional
description
string
externalId
Optional
externalId
integer As int64 As int64
version
Optional
version
array of string
propertyGroups
Optional
propertyGroups
object
layout
Optional
layout
string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
string
tenantId
Optional
tenantId
string
name
Required
name
string
publishStatusName
Optional
publishStatusName
string As uuid As uuid
snapshotVersion
Optional
snapshotVersion
string
customFormStatusName
Optional
customFormStatusName
string
id
Optional
id
string
publishStatus
Required
publishStatus
object
properties
Optional
properties
string
customFormStatus
Required
customFormStatus
CompositeBlueprintComponentProfile
JSON Example
{
"permissibleValueNames": [
"string"
],
"defaultValueName": "string",
"id": "string"
}array of string
permissibleValueNames
Optional
permissibleValueNames
string
defaultValueName
Optional
defaultValueName
string
id
Optional
id
CompositeBlueprintInfo
JSON Example
{
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"description": "string",
"publishStatusName": "string",
"id": "string",
"customFormStatusName": "string",
"version": "integer",
"publishStatus": "string",
"customFormStatus": "string"
}string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
string
name
Optional
name
string
description
Optional
description
string
publishStatusName
Optional
publishStatusName
string
id
Optional
id
string
customFormStatusName
Optional
customFormStatusName
integer As int64 As int64
version
Optional
version
string
publishStatus
Optional
publishStatus
string
customFormStatus
Optional
customFormStatus
CompositionProviderRequest
JSON Example
{
"blueprintRequestId": "string",
"rootCafeRequestId": "string",
"requestType": "string",
"blueprintName": "string",
"blueprintId": "string",
"cafeResourceId": "string",
"rootCafeDeploymentId": "string",
"targetResourceId": "string",
"targetResourceTypeId": "string",
"targetResourceProviderId": "string",
"requestId": "string",
"callbackServiceId": "string",
"componentInfo": {
"resourceId": "string",
"componentId": "string",
"componentTypeId": "string",
"requestInputData": {
"entries": [
{
"key": "string"
}
]
},
"previousComponentData": {
"entries": [
{
"key": "string"
}
]
},
"componentSchema": {
"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": [
{}
]
}
}
]
},
"componentData": {
"entries": [
{
"key": "string"
}
]
}
},
"userContext": {
"requestedFor": "string",
"requestedBy": "string",
"reasons": "string",
"tenantId": "string",
"subtenantId": "string",
"description": "string"
},
"callbackAdditionalUrlPath": "string"
}string
blueprintRequestId
Optional
blueprintRequestId
string
rootCafeRequestId
Optional
rootCafeRequestId
string
requestType
Optional
requestType
string
blueprintName
Optional
blueprintName
string
blueprintId
Optional
blueprintId
string
cafeResourceId
Optional
cafeResourceId
string
rootCafeDeploymentId
Optional
rootCafeDeploymentId
string
targetResourceId
Optional
targetResourceId
string
targetResourceTypeId
Optional
targetResourceTypeId
string
targetResourceProviderId
Optional
targetResourceProviderId
string
requestId
Optional
requestId
string
callbackServiceId
Optional
callbackServiceId
string
callbackAdditionalUrlPath
Optional
callbackAdditionalUrlPath
CriteriaOperator
This data structure has no properties.
DataType
JSON Example
{
"typeId": "string"
}string
typeId
Optional
typeId
DeallocateRequestCompletion
JSON Example
{
"success": "boolean",
"completionDetails": "string"
}boolean
success
Optional
success
string
completionDetails
Optional
completionDetails
DynamicDataRequest
JSON Example
{
"ignoreUnknownFields": "boolean",
"tenantId": "string",
"ids": [
"string"
]
}boolean
ignoreUnknownFields
Optional
ignoreUnknownFields
string
tenantId
Optional
tenantId
array of string
ids
Optional
ids
DynamicDataResponse
JSON Example
{
"values": {
"entries": [
{
"key": "string"
}
]
}
}
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
LiteralMapEntry
JSON Example
{
"key": "string"
}string
key
Optional
key
PageComponentTypeExtension
JSON Example
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"componentType": {
"iconId": "string",
"schema": {
"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": [
{}
]
}
}
]
},
"catalogItemTypeId": "string",
"supportLenientDestroy": "boolean",
"description": "string",
"callbacks": {
"rollback": "boolean",
"allocate": "boolean",
"requestDetails": "boolean",
"listOffers": "boolean",
"destroy": "boolean",
"clusterBehavior": "string",
"validate": "boolean"
},
"outputResourceTypeId": "string",
"version": "integer",
"idForEntitlements": "string",
"lastUpdated": "string",
"classId": "string",
"createdDate": "string",
"name": "string",
"tenantId": "string",
"requiredPermissionIds": [
"string"
],
"serviceTypeId": "string",
"allocationRelatedResourceTypeIds": [
"string"
],
"id": "string",
"serviceId": "string",
"forms": {},
"categoryId": "string",
"containerFieldId": "string"
},
"lastUpdated": "string",
"createdDate": "string",
"tenantId": "string",
"name": "string",
"description": "string",
"id": "string",
"version": "integer",
"fieldIds": [
"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
PageResourceDetails
JSON Example
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"resourceId": "string",
"blueprintName": "string",
"resourceName": "string",
"blueprintSnapshotId": "string",
"providerBindingId": "string",
"blueprintId": "string",
"cafeResourceId": "string",
"blueprintComponentId": "string",
"subTenantId": "string",
"componentTypeId": "string",
"providerId": "string",
"deploymentId": "string",
"tenantId": "string",
"deploymentName": "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"
}
]
}
PermissibleValueList
JSON Example
{
"customAllowed": "boolean"
}boolean
customAllowed
Optional
customAllowed
RequestUserContext
JSON Example
{
"requestedFor": "string",
"requestedBy": "string",
"reasons": "string",
"tenantId": "string",
"subtenantId": "string",
"description": "string"
}string
requestedFor
Optional
requestedFor
string
requestedBy
Optional
requestedBy
string
reasons
Optional
reasons
string
tenantId
Optional
tenantId
string
subtenantId
Optional
subtenantId
string
description
Optional
description
ResourceDetails
JSON Example
{
"resourceId": "string",
"blueprintName": "string",
"resourceName": "string",
"blueprintSnapshotId": "string",
"providerBindingId": "string",
"blueprintId": "string",
"cafeResourceId": "string",
"blueprintComponentId": "string",
"subTenantId": "string",
"componentTypeId": "string",
"providerId": "string",
"deploymentId": "string",
"tenantId": "string",
"deploymentName": "string"
}string
resourceId
Optional
resourceId
string
blueprintName
Optional
blueprintName
string
resourceName
Optional
resourceName
string
blueprintSnapshotId
Optional
blueprintSnapshotId
string
providerBindingId
Optional
providerBindingId
string
blueprintId
Optional
blueprintId
string
cafeResourceId
Optional
cafeResourceId
string
blueprintComponentId
Optional
blueprintComponentId
string
subTenantId
Optional
subTenantId
string
componentTypeId
Optional
componentTypeId
string
providerId
Optional
providerId
string
deploymentId
Optional
deploymentId
string
tenantId
Optional
tenantId
string
deploymentName
Optional
deploymentName
RestEntity
JSON Example
{
"setLocation": "boolean",
"httpStatus": "string"
}boolean
setLocation
Optional
setLocation
string
httpStatus
Optional
httpStatus
object
httpHeaders
Optional
httpHeaders
object
body
Optional
body
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
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"
}
]
}
requestCompletion
JSON Example
{
"requestCompletionState": "string",
"resourceBindingIds": [
"string"
],
"completionDetails": "string"
}string
requestCompletionState
Optional
requestCompletionState
array of string
resourceBindingIds
Optional
resourceBindingIds
string
completionDetails
Optional
completionDetails
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: