Composition Service API Data Structures
{
"result": {
"data": {
"entries": [
{
"key": "string"
}
]
}
},
"success": "boolean",
"completionDetails": "string"
}
success
completionDetails
{
"filter": "string"
}
filter
{
"name": "string",
"description": "string",
"id": "string",
"status": "string",
"propertyGroups": [
"string"
]
}
layout
components
name
description
id
properties
status
propertyGroups
{
"data": {
"entries": [
{
"key": "string"
}
]
}
}
{
"dependson": [
"string"
],
"componentProfiles": [
{
"permissibleValueNames": [
"string"
],
"defaultValueName": "string",
"id": "string"
}
],
"type": "string",
"propertyGroups": [
"string"
]
}
data
dependson
type
propertyGroups
{
"permittedValues": {
"customAllowed": "boolean"
}
}
data
facets
{
"dependsOn": [
"string"
],
"componentProfiles": [
{
"permissibleValueNames": [
"string"
],
"defaultValueName": "string",
"id": "string"
}
],
"type": "string",
"propertyGroups": [
"string"
]
}
dependsOn
data
type
propertyGroups
{
"permissibleValueNames": [
"string"
],
"defaultValueName": "string",
"id": "string"
}
permissibleValueNames
defaultValueName
id
{
"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"
}
]
}
}
resourceId
componentId
componentTypeId
{
"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"
}
iconId
catalogItemTypeId
supportLenientDestroy
description
outputResourceTypeId
version
idForEntitlements
lastUpdated
classId
createdDate
name
tenantId
requiredPermissionIds
serviceTypeId
allocationRelatedResourceTypeIds
id
serviceId
categoryId
containerFieldId
{
"rollback": "boolean",
"allocate": "boolean",
"requestDetails": "boolean",
"listOffers": "boolean",
"destroy": "boolean",
"clusterBehavior": "string",
"validate": "boolean"
}
rollback
allocate
requestDetails
listOffers
destroy
clusterBehavior
validate
An instance of the available categories on the CBP Editor
{
"iconId": "string",
"name": "string",
"description": "string",
"id": "string",
"type": "string",
"properties": "string",
"order": "integer"
}
ID of the icon of the category
Localization key of the name of the category
Localization key of the description of the category
ID of the composition category
Type of the category
JSON serialized string of extra properties of the categories such as permissions or if it should be hidden etc.
The order of the category in which it should appear on the UI
{
"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"
]
}
lastUpdated
createdDate
tenantId
name
description
id
version
fieldIds
{
"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"
}
lastUpdated
createdDate
isEnabled
name
tenantId
description
label
version
formsByScenario
{
"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"
}
components
catalogItemTypeId
description
externalId
version
propertyGroups
layout
lastUpdated
createdDate
tenantId
name
publishStatusName
snapshotVersion
customFormStatusName
id
publishStatus
properties
customFormStatus
{
"permissibleValueNames": [
"string"
],
"defaultValueName": "string",
"id": "string"
}
permissibleValueNames
defaultValueName
id
{
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"description": "string",
"publishStatusName": "string",
"id": "string",
"customFormStatusName": "string",
"version": "integer",
"publishStatus": "string",
"customFormStatus": "string"
}
lastUpdated
createdDate
name
description
publishStatusName
id
customFormStatusName
version
publishStatus
customFormStatus
{
"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"
}
blueprintRequestId
rootCafeRequestId
requestType
blueprintName
blueprintId
cafeResourceId
rootCafeDeploymentId
targetResourceId
targetResourceTypeId
targetResourceProviderId
requestId
callbackServiceId
callbackAdditionalUrlPath
{
"typeId": "string"
}
typeId
{
"success": "boolean",
"completionDetails": "string"
}
success
completionDetails
{
"ignoreUnknownFields": "boolean",
"tenantId": "string",
"ids": [
"string"
]
}
ignoreUnknownFields
tenantId
ids
{
"values": {
"entries": [
{
"key": "string"
}
]
}
}
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"providerEntityId": "string"
}
providerEntityId
{
"dependencies": [
"string"
],
"facets": [
{}
]
}
dependencies
{
"offset": "integer",
"count": "integer"
}
offset
count
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
}
extensionId
{
"facets": [
{
"type": "string"
}
]
}
{
"type": "string"
}
type
{
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"columns": [
"Field Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"orderIndex": "integer",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
displayAdvice
isMultiValued
description
orderIndex
id
label
isMultiValued
description
label
labelSize
displayAdvice
orderIndex
id
{
"size": "integer"
}
size
{
"size": "integer",
"extensionRendererContext": {
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
},
"columns": [
"LayoutField Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"label": "string",
"labelSize": "integer",
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"orderIndex": "integer",
"id": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
{
"size": "integer"
}
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
id
label
{
"items": [
{
"size": "integer"
}
]
}
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
id
label
{
"key": "string"
}
key
{
"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"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"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"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"key": "string"
}
key
{
"params": [
{
"key": "string"
}
]
}
{
"customAllowed": "boolean"
}
customAllowed
{
"requestedFor": "string",
"requestedBy": "string",
"reasons": "string",
"tenantId": "string",
"subtenantId": "string",
"description": "string"
}
requestedFor
requestedBy
reasons
tenantId
subtenantId
description
{
"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"
}
resourceId
blueprintName
resourceName
blueprintSnapshotId
providerBindingId
blueprintId
cafeResourceId
blueprintComponentId
subTenantId
componentTypeId
providerId
deploymentId
tenantId
deploymentName
{
"setLocation": "boolean",
"httpStatus": "string"
}
setLocation
httpStatus
httpHeaders
body
{
"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": [
{}
]
}
}
]
}
{
"formValues": {
"entries": [
{
"key": "string"
}
]
},
"headers": {
"entries": [
{
"key": "string"
}
]
},
"trigger": "string",
"triggeredDetailsLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"affectedElements": [
"string"
]
}
trigger
affectedElements
Wraps a boolean value.
{
"value": "boolean"
}
The boolean value.
{
"values": [
{
"label": "string"
}
]
}
{
"pagingInfo": {
"offset": "integer",
"count": "integer"
},
"headers": {
"entries": [
{
"key": "string"
}
]
},
"tenantId": "string",
"text": "string",
"userId": "string",
"dependencyValues": {
"entries": [
{
"key": "string"
}
]
}
}
tenantId
text
userId
{
"layout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"fieldPrefixes": [
"string"
],
"values": {
"entries": [
{
"key": "string"
}
]
}
}
fieldPrefixes
{
"elementUpdates": [
{
"permissibleValues": [
{
"label": "string"
}
],
"extensionRendererContext": {
"entries": [
{
"key": "string"
}
]
},
"facetValues": {
"facets": [
{
"type": "string"
}
]
},
"id": "string",
"detailLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"errors": [
"string"
]
}
]
}
{
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
}
Wraps a value such that values of different types can be treated generically.
Equivalent of java.util.Map
{
"entries": [
{
"key": "string"
}
]
}
{
"requestCompletionState": "string",
"resourceBindingIds": [
"string"
],
"completionDetails": "string"
}
requestCompletionState
resourceBindingIds
completionDetails
A literal defining period of time. This period is represented some integral number of a specified timeUnit.e.g. 6 days.
{
"unit": "string",
"amount": "integer"
}
The unit of measure for the time span. e.g: days.
The amount for the time span.
{
"permissibleValues": [
{
"label": "string"
}
],
"extensionRendererContext": {
"entries": [
{
"key": "string"
}
]
},
"facetValues": {
"facets": [
{
"type": "string"
}
]
},
"id": "string",
"detailLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"errors": [
"string"
]
}
id
errors
{
"label": "string"
}
label