Advanced Designer Service API Data Structures
CSResourceType
JSON Example
{
"externalTypeName": "string",
"access": "string",
"reservationTypeId": "string",
"mappingWorkflowId": "string",
"builtIn": "boolean",
"externalTypeId": "string",
"description": "string",
"mappingScriptActionFqn": "string",
"version": {
"major": "integer",
"minor": "integer",
"micro": "integer",
"version": "string",
"revision": "integer"
},
"vcoType": "string",
"listLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"detailsForm": {
"form": {
"designerLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"name": "string"
},
"scenario": {
"usageClass": "string",
"id": "string"
},
"id": "string"
},
"providerId": "string",
"mappingWorkflow": {
"name": "string",
"description": "string",
"id": "string",
"inputParameters": [
{
"name": "string",
"type": "string"
}
],
"outputParameters": [
{
"name": "string",
"type": "string"
}
]
},
"name": "string",
"tenantId": "string",
"id": {
"id": "string",
"tenant": "string"
},
"mappingScriptAction": {
"fqn": "string",
"name": "string",
"description": "string",
"resultContentType": {
"typeId": "string"
},
"inputParameters": [
{
"name": "string",
"type": "string"
}
],
"resultType": "string"
},
"categoryId": "string"
}string
externalTypeName
Optional
externalTypeName
string
access
Optional
access
string
reservationTypeId
Optional
reservationTypeId
string
mappingWorkflowId
Optional
mappingWorkflowId
boolean
builtIn
Optional
builtIn
string
externalTypeId
Optional
externalTypeId
string
description
Optional
description
string
mappingScriptActionFqn
Optional
mappingScriptActionFqn
string
vcoType
Optional
vcoType
string
providerId
Optional
providerId
string
name
Optional
name
string
tenantId
Optional
tenantId
string
categoryId
Optional
categoryId
Property Of
Parameter To
Returned By
Clause
This data structure has no properties.
ConfigurationResources
JSON Example
{
"links": [
{
"rel": "string",
"href": "string"
}
],
"content": [
{
"systemDefault": "boolean",
"password": "string",
"port": "integer",
"name": "string",
"host": "string",
"ssoMode": "boolean",
"tenantId": "string",
"certificate": "string",
"description": "string",
"id": "string",
"embedded": "boolean",
"username": "string"
}
]
}
CriteriaOperator
This data structure has no properties.
CsEndpointData
JSON Example
{
"values": {
"entries": [
{
"key": "string"
}
]
},
"namespace": "string",
"name": "string",
"description": "string"
}string
namespace
Required
namespace
string
name
Required
name
string
description
Optional
description
CsParameter
JSON Example
{
"name": "string",
"id": "string",
"resourceType": {
"externalTypeName": "string",
"access": "string",
"reservationTypeId": "string",
"mappingWorkflowId": "string",
"builtIn": "boolean",
"externalTypeId": "string",
"description": "string",
"mappingScriptActionFqn": "string",
"version": {
"major": "integer",
"minor": "integer",
"micro": "integer",
"version": "string",
"revision": "integer"
},
"vcoType": "string",
"listLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"detailsForm": {
"form": {
"designerLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"name": "string"
},
"scenario": {
"usageClass": "string",
"id": "string"
},
"id": "string"
},
"providerId": "string",
"mappingWorkflow": {
"name": "string",
"description": "string",
"id": "string",
"inputParameters": [
{
"name": "string",
"type": "string"
}
],
"outputParameters": [
{
"name": "string",
"type": "string"
}
]
},
"name": "string",
"tenantId": "string",
"id": {
"id": "string",
"tenant": "string"
},
"mappingScriptAction": {
"fqn": "string",
"name": "string",
"description": "string",
"resultContentType": {
"typeId": "string"
},
"inputParameters": [
{
"name": "string",
"type": "string"
}
],
"resultType": "string"
},
"categoryId": "string"
}
}string
name
Optional
name
string As uuid As uuid
id
Optional
id
Parameter To
CsResource
JSON Example
{
"vcoId": "string",
"id": "string",
"vcoType": "string"
}string
vcoId
Required
vcoId
string As uuid As uuid
id
Optional
id
string
vcoType
Required
vcoType
CsResourceOperation
JSON Example
{
"iconId": "string",
"access": "string",
"inputParameter": {
"name": "string",
"id": "string",
"resourceType": {
"externalTypeName": "string",
"access": "string",
"reservationTypeId": "string",
"mappingWorkflowId": "string",
"builtIn": "boolean",
"externalTypeId": "string",
"description": "string",
"mappingScriptActionFqn": "string",
"version": {
"major": "integer",
"minor": "integer",
"micro": "integer",
"version": "string",
"revision": "integer"
},
"vcoType": "string",
"listLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"detailsForm": {
"form": {
"designerLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"name": "string"
},
"scenario": {
"usageClass": "string",
"id": "string"
},
"id": "string"
},
"providerId": "string",
"mappingWorkflow": {
"name": "string",
"description": "string",
"id": "string",
"inputParameters": [
{
"name": "string",
"type": "string"
}
],
"outputParameters": [
{
"name": "string",
"type": "string"
}
]
},
"name": "string",
"tenantId": "string",
"id": {
"id": "string",
"tenant": "string"
},
"mappingScriptAction": {
"fqn": "string",
"name": "string",
"description": "string",
"resultContentType": {
"typeId": "string"
},
"inputParameters": [
{
"name": "string",
"type": "string"
}
],
"resultType": "string"
},
"categoryId": "string"
}
},
"builtIn": "boolean",
"description": "string",
"version": {
"major": "integer",
"minor": "integer",
"micro": "integer",
"version": "string",
"revision": "integer"
},
"disposal": "boolean",
"name": "string",
"statusName": "string",
"provisionAsChild": "boolean",
"id": {
"id": "string",
"tenant": "string"
},
"outputParameter": {
"name": "string",
"id": "string",
"resourceType": {
"externalTypeName": "string",
"access": "string",
"reservationTypeId": "string",
"mappingWorkflowId": "string",
"builtIn": "boolean",
"externalTypeId": "string",
"description": "string",
"mappingScriptActionFqn": "string",
"version": {
"major": "integer",
"minor": "integer",
"micro": "integer",
"version": "string",
"revision": "integer"
},
"vcoType": "string",
"listLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"detailsForm": {
"form": {
"designerLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"name": "string"
},
"scenario": {
"usageClass": "string",
"id": "string"
},
"id": "string"
},
"providerId": "string",
"mappingWorkflow": {
"name": "string",
"description": "string",
"id": "string",
"inputParameters": [
{
"name": "string",
"type": "string"
}
],
"outputParameters": [
{
"name": "string",
"type": "string"
}
]
},
"name": "string",
"tenantId": "string",
"id": {
"id": "string",
"tenant": "string"
},
"mappingScriptAction": {
"fqn": "string",
"name": "string",
"description": "string",
"resultContentType": {
"typeId": "string"
},
"inputParameters": [
{
"name": "string",
"type": "string"
}
],
"resultType": "string"
},
"categoryId": "string"
}
},
"workflowId": "string",
"catalogRequestInfoHidden": "boolean",
"forms": [
{
"form": {
"designerLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"name": "string"
},
"scenario": {
"usageClass": "string",
"id": "string"
},
"id": "string"
}
],
"status": "string"
}string
iconId
Optional
iconId
string
access
Optional
access
boolean
builtIn
Optional
builtIn
string
description
Optional
description
boolean
disposal
Optional
disposal
string
name
Required
name
string
statusName
Optional
statusName
boolean
provisionAsChild
Optional
provisionAsChild
string
workflowId
Required
workflowId
boolean
catalogRequestInfoHidden
Optional
catalogRequestInfoHidden
string
status
Required
status
Returned By
DataType
JSON Example
{
"typeId": "string"
}string
typeId
Optional
typeId
DesignerLayout
JSON Example
{
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
}
DesignerLayoutCell
JSON Example
{
"size": "integer"
}integer As int32 As int32
size
Optional
size
DesignerLayoutField
AllOf
JSON Example
{
"size": "integer",
"labelDisplaySize": "integer",
"extensionRendererContext": {
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
},
"columns": [
"DesignerLayoutField Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"label": "string",
"permissibleValuesContext": {
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"providerEntityId": "string"
},
"customField": "boolean",
"staticField": "boolean",
"permissibleValues": {
"customAllowed": "boolean"
},
"initialStaticState": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"displayAdvice": "string",
"orderIndex": "integer",
"id": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"refreshOnChange": "boolean",
"errors": [
"string"
]
}
DesignerLayoutPage
JSON Example
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}string
id
Optional
id
string
label
Optional
label
DesignerLayoutReference
This data structure has no properties.
DesignerLayoutRow
JSON Example
{
"items": [
{
"size": "integer"
}
]
}
DesignerLayoutSection
JSON Example
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}boolean
designerHidden
Optional
designerHidden
string
id
Optional
id
string
label
Optional
label
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
FormsScope
JSON Example
{
"level": "string"
}string
level
Required
level
GenericForm
JSON Example
{
"layout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"name": "string",
"description": "string",
"id": "string",
"tenant": "string"
}string
name
Required
name
string
description
Optional
description
string As uuid As uuid
id
Optional
id
string
tenant
Required
tenant
InlineDesignerLayoutField1
This data structure has no properties.
integer As int32 As int32
labelDisplaySize
Optional
labelDisplaySize
boolean
isMultiValued
Optional
isMultiValued
string
description
Optional
description
string
label
Optional
label
boolean
customField
Optional
customField
boolean
staticField
Optional
staticField
string
displayAdvice
Optional
displayAdvice
integer As int32 As int32
orderIndex
Optional
orderIndex
string
id
Optional
id
boolean
refreshOnChange
Optional
refreshOnChange
array of string
errors
Optional
errors
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.
InlineintegerLiteral1
Wraps a signed 64-bit integer value.
This data structure has no properties.
integer As int64 As int64
value
Optional
The integer value.
InventoryType
JSON Example
{
"pluginType": "string",
"pluginName": "string",
"name": "string",
"description": "string",
"id": "string",
"properties": [
{
"displayName": "string",
"name": "string",
"description": "string",
"id": "string"
}
]
}string
pluginType
Optional
pluginType
string
pluginName
Optional
pluginName
string
name
Optional
name
string
description
Optional
description
string As uuid As uuid
id
Optional
id
InventoryTypeProperty
JSON Example
{
"displayName": "string",
"name": "string",
"description": "string",
"id": "string"
}string
displayName
Optional
displayName
string
name
Optional
name
string
description
Optional
description
string As uuid As uuid
id
Optional
id
LayoutCell
JSON Example
{
"size": "integer"
}integer As int32 As int32
size
Optional
size
LayoutField
AllOf
JSON Example
{
"size": "integer",
"extensionRendererContext": {
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
},
"columns": [
"LayoutField Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"label": "string",
"labelSize": "integer",
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"orderIndex": "integer",
"id": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
LayoutFlowElement
AllOf
JSON Example
{
"size": "integer"
}
LayoutPage
JSON Example
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}string
id
Optional
id
string
label
Optional
label
LayoutReference
This data structure has no properties.
LayoutRow
JSON Example
{
"items": [
{
"size": "integer"
}
]
}
LayoutSection
JSON Example
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}string
id
Optional
id
string
label
Optional
label
Link
JSON Example
{
"rel": "string",
"href": "string"
}string
rel
Optional
rel
string
href
Optional
href
LiteralMapEntry
JSON Example
{
"key": "string"
}string
key
Optional
key
Page
JSON Example
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{}
],
"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
array of object
content
Optional
content
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
ResourceIntegerLiteral
JSON Example
{
"links": [
{
"rel": "string",
"href": "string"
}
],
"value": "integer"
}
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": [
{}
]
}
}
]
}
ServiceBlueprint
JSON Example
{
"access": "string",
"builtIn": "boolean",
"description": "string",
"version": {
"major": "integer",
"minor": "integer",
"micro": "integer",
"version": "string",
"revision": "integer"
},
"component": "boolean",
"name": "string",
"statusName": "string",
"componentConfiguration": {
"scalable": "boolean",
"operations": [
{
"inputParameterName": "string",
"lifecycleType": "string",
"routineId": "string"
}
],
"categoryId": "string"
},
"id": {
"id": "string",
"tenant": "string"
},
"outputParameter": {
"name": "string",
"id": "string",
"resourceType": {
"externalTypeName": "string",
"access": "string",
"reservationTypeId": "string",
"mappingWorkflowId": "string",
"builtIn": "boolean",
"externalTypeId": "string",
"description": "string",
"mappingScriptActionFqn": "string",
"version": {
"major": "integer",
"minor": "integer",
"micro": "integer",
"version": "string",
"revision": "integer"
},
"vcoType": "string",
"listLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"detailsForm": {
"form": {
"designerLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"name": "string"
},
"scenario": {
"usageClass": "string",
"id": "string"
},
"id": "string"
},
"providerId": "string",
"mappingWorkflow": {
"name": "string",
"description": "string",
"id": "string",
"inputParameters": [
{
"name": "string",
"type": "string"
}
],
"outputParameters": [
{
"name": "string",
"type": "string"
}
]
},
"name": "string",
"tenantId": "string",
"id": {
"id": "string",
"tenant": "string"
},
"mappingScriptAction": {
"fqn": "string",
"name": "string",
"description": "string",
"resultContentType": {
"typeId": "string"
},
"inputParameters": [
{
"name": "string",
"type": "string"
}
],
"resultType": "string"
},
"categoryId": "string"
}
},
"workflowId": "string",
"catalogRequestInfoHidden": "boolean",
"forms": [
{
"form": {
"designerLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"name": "string"
},
"scenario": {
"usageClass": "string",
"id": "string"
},
"id": "string"
}
],
"status": "string"
}string
access
Optional
access
boolean
builtIn
Optional
builtIn
string
description
Optional
description
boolean
component
Optional
component
string
name
Required
name
string
statusName
Optional
statusName
string
workflowId
Required
workflowId
boolean
catalogRequestInfoHidden
Optional
catalogRequestInfoHidden
string
status
Required
status
Sort
This data structure has no properties.
TagInstanceList
JSON Example
{
"userTags": {
"entries": [
{
"key": "string"
}
]
},
"id": "string",
"globalTags": {
"entries": [
{
"key": "string"
}
]
}
}string
id
Optional
id
TenantedUuid
JSON Example
{
"id": "string",
"tenant": "string"
}string As uuid As uuid
id
Optional
id
string
tenant
Optional
tenant
ValueDefinition
JSON Example
{
"dataType": {
"typeId": "string"
},
"scope": {
"level": "string"
},
"name": "string",
"description": "string",
"id": "string",
"key": "string",
"multi": "boolean"
}string
name
Required
name
string
description
Optional
description
string As uuid As uuid
id
Optional
id
string
key
Optional
key
boolean
multi
Optional
multi
Version
JSON Example
{
"major": "integer",
"minor": "integer",
"micro": "integer",
"version": "string",
"revision": "integer"
}integer As int64 As int64
major
Optional
major
integer As int64 As int64
minor
Optional
minor
integer As int64 As int64
micro
Optional
micro
string As ^\d{1,10}\.\d{1,10}\.\d{1,10}(?:\-\d{1,10})?$
version
Optional
version
integer As int64 As int64
revision
Optional
revision
WorkflowSubscription
JSON Example
{
"description": "string",
"eventTopicId": "string",
"priority": "integer",
"failOnError": "boolean",
"version": {
"major": "integer",
"minor": "integer",
"micro": "integer",
"version": "string",
"revision": "integer"
},
"timeout": "integer",
"blocking": "boolean",
"tenantId": "string",
"name": "string",
"statusName": "string",
"id": "string",
"reply": "boolean",
"workflowId": "string",
"status": "string"
}string
description
Optional
description
string
eventTopicId
Optional
eventTopicId
integer As int32 As int32
priority
Optional
priority
boolean
failOnError
Optional
failOnError
integer As int32 As int32
timeout
Optional
timeout
boolean
blocking
Optional
blocking
string
tenantId
Optional
tenantId
string
name
Optional
name
string
statusName
Optional
statusName
string As uuid As uuid
id
Optional
id
boolean
reply
Optional
reply
string
workflowId
Required
workflowId
string
status
Required
status
XaaSComponentConfiguration
JSON Example
{
"scalable": "boolean",
"operations": [
{
"inputParameterName": "string",
"lifecycleType": "string",
"routineId": "string"
}
],
"categoryId": "string"
}boolean
scalable
Optional
scalable
string
categoryId
Optional
categoryId
XaasRequestWorkflowInfo
JSON Example
{
"executionState": "string",
"completionDate": "string",
"workflowName": "string",
"id": "string",
"provisionSourceType": "string",
"startDate": "string",
"errorDetails": "string"
}string
executionState
Optional
executionState
string As date-time As date-time
completionDate
Optional
completionDate
string
workflowName
Optional
workflowName
string
id
Optional
id
string
provisionSourceType
Optional
provisionSourceType
string As date-time As date-time
startDate
Optional
startDate
string
errorDetails
Optional
errorDetails
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
blueprintForm
JSON Example
{
"designerLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"name": "string"
}string
name
Required
name
booleanLiteral
Wraps a boolean value.
JSON Example
{
"value": "boolean"
}boolean
value
Optional
The boolean value.
catalogItemResource
JSON Example
{
"catalogId": "string",
"csResource": {
"vcoId": "string",
"id": "string",
"vcoType": "string"
},
"displayName": "string",
"csResourceTypeId": "string",
"tenantId": "string",
"description": "string",
"subtenantId": "string",
"owners": [
"string"
]
}string
catalogId
Optional
catalogId
string
displayName
Required
displayName
string
csResourceTypeId
Required
csResourceTypeId
string
tenantId
Optional
tenantId
string
description
Optional
description
string
subtenantId
Required
subtenantId
array of string
owners
Required
owners
configuration
JSON Example
{
"systemDefault": "boolean",
"password": "string",
"port": "integer",
"name": "string",
"host": "string",
"ssoMode": "boolean",
"tenantId": "string",
"certificate": "string",
"description": "string",
"id": "string",
"embedded": "boolean",
"username": "string"
}boolean
systemDefault
Optional
systemDefault
string
password
Optional
password
integer As int32 As int32
port
Optional
port
string
name
Required
name
string
host
Required
host
boolean
ssoMode
Optional
ssoMode
string
tenantId
Required
tenantId
string
certificate
Optional
certificate
string
description
Optional
description
string As uuid As uuid
id
Optional
id
boolean
embedded
Optional
embedded
string
username
Optional
username
Property Of
Parameter To
Returned By
elementValues
JSON Example
{
"values": [
{
"label": "string"
}
]
}
elementValuesRequest
JSON Example
{
"pagingInfo": {
"offset": "integer",
"count": "integer"
},
"headers": {
"entries": [
{
"key": "string"
}
]
},
"tenantId": "string",
"text": "string",
"userId": "string",
"dependencyValues": {
"entries": [
{
"key": "string"
}
]
}
}string
tenantId
Optional
tenantId
string
text
Optional
text
string
userId
Optional
userId
formScenario
JSON Example
{
"form": {
"designerLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"designerHidden": "boolean",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"name": "string"
},
"scenario": {
"usageClass": "string",
"id": "string"
},
"id": "string"
}string As uuid As uuid
id
Optional
id
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"
]
}
]
}
integerLiteral
AllOf
JSON Example
{
"value": "integer"
}
interactionWorkItem
JSON Example
{
"requestedBy": "string",
"subtenantRef": "string",
"assignees": [
"string"
],
"workflowExecutionId": "string",
"workflowId": "string"
}string
requestedBy
Required
requestedBy
string
subtenantRef
Optional
subtenantRef
array of string
assignees
Optional
assignees
string
workflowExecutionId
Required
workflowExecutionId
string
workflowId
Required
workflowId
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"
}
]
}
]
}
]
}
]
}
layoutScenario
JSON Example
{
"usageClass": "string",
"id": "string"
}string
usageClass
Optional
usageClass
string
id
Optional
id
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"
}
]
}
Property Of
Parameter To
policyDefinition
JSON Example
{
"hrid": "string",
"tenantId": "string",
"description": "string",
"id": "string",
"properties": {
"entries": [
{
"key": "string"
}
]
}
}string As ^\w+$
hrid
Optional
hrid
string
tenantId
Optional
tenantId
string
description
Optional
description
string As uuid As uuid
id
Optional
id
scriptAction
JSON Example
{
"fqn": "string",
"name": "string",
"description": "string",
"resultContentType": {
"typeId": "string"
},
"inputParameters": [
{
"name": "string",
"type": "string"
}
],
"resultType": "string"
}string
fqn
Required
fqn
string
name
Required
name
string
description
Required
description
string
resultType
Optional
resultType
scriptActionParameter
JSON Example
{
"name": "string",
"type": "string"
}string
name
Required
name
string
type
Required
type
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
workflow
JSON Example
{
"name": "string",
"description": "string",
"id": "string",
"inputParameters": [
{
"name": "string",
"type": "string"
}
],
"outputParameters": [
{
"name": "string",
"type": "string"
}
]
}string
name
Required
name
string
description
Required
description
string
id
Required
id
workflowParameter
JSON Example
{
"name": "string",
"type": "string"
}string
name
Required
name
string
type
Required
type
xaasComponentOperation
JSON Example
{
"inputParameterName": "string",
"lifecycleType": "string",
"routineId": "string"
}string
inputParameterName
Required
inputParameterName
string
lifecycleType
Required
lifecycleType
string
routineId
Required
routineId
Node: apidepo-liferay-dxp-v1-be-w-1:8080: