Network Service API Data Structures
{
"typeId": "string"
}
typeId
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"providerEntityId": "string"
}
providerEntityId
{
"dependencies": [
"string"
],
"facets": [
{}
]
}
dependencies
{
"propertyName": "string"
}
propertyName
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
}
extensionId
{
"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
Wraps a boolean value.
The boolean value.
Represents a rate of money over time.
{
"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
{
"loadBalancerTypeId": "string",
"description": "string",
"externalId": "string",
"pools": [
{
"persistenceExpiration": "integer",
"description": "string",
"healthCheckProtocol": "string",
"sslClientProfileName": "string",
"transparent": "boolean",
"persistenceCookieMode": "string",
"acceleration": "boolean",
"protocol": "string",
"memberMaxConnections": "integer",
"members": [
{
"address": "string",
"port": "integer",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
],
"algorithmParameter": "string",
"memberMinConnections": "integer",
"monitorIds": [
"string"
],
"id": "string",
"monitorPort": "integer",
"algorithm": "string",
"uniqueMonitorId": "string",
"sslDefaultCertificateName": "string",
"servicePortId": "string",
"persistenceCookieName": "string",
"externalId": "string",
"connectionRate": "integer",
"extensionData": {
"entries": [
{
"key": "string"
}
]
},
"connectionLimit": "integer",
"port": "integer",
"memberPort": "integer",
"persistenceMethod": "string",
"name": "string",
"tenantId": "string",
"memberProtocol": "string"
}
],
"vipNicIndex": "integer",
"tierNetwork": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
},
"virtualIps": [
{
"address": "string",
"name": "string",
"tenantId": "string",
"poolId": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
],
"name": "string",
"tenantId": "string",
"vipNetwork": "string",
"id": "string",
"tierNicIndex": "integer",
"loggingLevel": "string",
"monitors": [
{
"receive": "string",
"maxRetries": "integer",
"method": "string",
"newEntity": "boolean",
"interval": "integer",
"id": "string",
"monitorPath": "string",
"send": "string",
"timeout": "integer",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
]
}
loadBalancerTypeId
description
externalId
vipNicIndex
tierNetwork
name
tenantId
vipNetwork
id
tierNicIndex
loggingLevel
{
"address": "string",
"port": "integer",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
address
port
externalId
id
{
"receive": "string",
"maxRetries": "integer",
"method": "string",
"newEntity": "boolean",
"interval": "integer",
"id": "string",
"monitorPath": "string",
"send": "string",
"timeout": "integer",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
receive
maxRetries
method
newEntity
interval
id
monitorPath
send
timeout
{
"persistenceExpiration": "integer",
"description": "string",
"healthCheckProtocol": "string",
"sslClientProfileName": "string",
"transparent": "boolean",
"persistenceCookieMode": "string",
"acceleration": "boolean",
"protocol": "string",
"memberMaxConnections": "integer",
"members": [
{
"address": "string",
"port": "integer",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
],
"algorithmParameter": "string",
"memberMinConnections": "integer",
"monitorIds": [
"string"
],
"id": "string",
"monitorPort": "integer",
"algorithm": "string",
"uniqueMonitorId": "string",
"sslDefaultCertificateName": "string",
"servicePortId": "string",
"persistenceCookieName": "string",
"externalId": "string",
"connectionRate": "integer",
"extensionData": {
"entries": [
{
"key": "string"
}
]
},
"connectionLimit": "integer",
"port": "integer",
"memberPort": "integer",
"persistenceMethod": "string",
"name": "string",
"tenantId": "string",
"memberProtocol": "string"
}
persistenceExpiration
description
healthCheckProtocol
sslClientProfileName
transparent
persistenceCookieMode
acceleration
protocol
memberMaxConnections
algorithmParameter
memberMinConnections
monitorIds
id
monitorPort
algorithm
uniqueMonitorId
sslDefaultCertificateName
servicePortId
persistenceCookieName
externalId
connectionRate
connectionLimit
port
memberPort
persistenceMethod
name
tenantId
memberProtocol
{
"schema": [
{
"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": [
{}
]
}
}
]
},
"lastUpdated": "string",
"schemaClassId": "string",
"createdDate": "string",
"id": "string",
"version": "integer"
}
],
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"serviceTypeId": "string",
"description": "string",
"id": "string",
"version": "integer",
"allocationRelatedResourceTypes": [
"string"
]
}
lastUpdated
createdDate
name
serviceTypeId
description
id
version
allocationRelatedResourceTypes
{
"address": "string",
"name": "string",
"tenantId": "string",
"poolId": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
address
name
tenantId
poolId
description
externalId
id
{
"networkInterfaceId": "string",
"translatedAddress": "string",
"componentId": "string",
"userDefined": "boolean",
"externalId": "string",
"description": "string",
"targetType": "string",
"type": "string",
"enabled": "boolean",
"protocol": "string",
"edgeId": "string",
"machineId": "string",
"originalAddress": "string",
"name": "string",
"peerInterfaceIndex": "integer",
"action": "string",
"translatedPort": "string",
"interfaceIndex": "integer",
"id": "string",
"tag": "string",
"componentName": "string",
"order": "integer",
"originalPort": "string"
}
networkInterfaceId
translatedAddress
componentId
userDefined
externalId
description
targetType
type
enabled
protocol
edgeId
machineId
originalAddress
name
peerInterfaceIndex
action
translatedPort
interfaceIndex
id
tag
componentName
order
originalPort
{
"networkBackings": [
{
"computeResourceName": "string",
"externalId": "string",
"id": "string",
"computeResourceNetworkId": "string",
"computeResourceId": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
],
"machineIdCollection": [
"string"
],
"name": "string",
"tenantId": "string",
"description": "string",
"externalId": "string",
"networkTypeId": "string",
"networkProfileType": "string",
"id": "string",
"natRules": [
{
"networkInterfaceId": "string",
"translatedAddress": "string",
"componentId": "string",
"userDefined": "boolean",
"externalId": "string",
"description": "string",
"targetType": "string",
"type": "string",
"enabled": "boolean",
"protocol": "string",
"edgeId": "string",
"machineId": "string",
"originalAddress": "string",
"name": "string",
"peerInterfaceIndex": "integer",
"action": "string",
"translatedPort": "string",
"interfaceIndex": "integer",
"id": "string",
"tag": "string",
"componentName": "string",
"order": "integer",
"originalPort": "string"
}
],
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
machineIdCollection
name
tenantId
description
externalId
networkTypeId
networkProfileType
id
{
"computeResourceName": "string",
"externalId": "string",
"id": "string",
"computeResourceNetworkId": "string",
"computeResourceId": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
computeResourceName
externalId
id
computeResourceNetworkId
computeResourceId
{
"name": "string",
"tenantId": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
name
tenantId
description
externalId
id
{
"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": [
{}
]
}
}
]
},
"lastUpdated": "string",
"schemaClassId": "string",
"createdDate": "string",
"id": "string",
"version": "integer"
}
lastUpdated
schemaClassId
createdDate
id
version
{
"schema": [
{
"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": [
{}
]
}
}
]
},
"lastUpdated": "string",
"schemaClassId": "string",
"createdDate": "string",
"id": "string",
"version": "integer"
}
],
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"serviceTypeId": "string",
"description": "string",
"id": "string",
"version": "integer",
"allocationRelatedResourceTypes": [
"string"
]
}
lastUpdated
createdDate
name
serviceTypeId
description
id
version
allocationRelatedResourceTypes
{
"expand": [
{
"propertyName": "string"
}
],
"select": [
{
"propertyName": "string"
}
],
"top": "integer",
"skipToken": "string",
"inlineCount": "string",
"orderBy": [
{
"direction": "string"
}
],
"skip": "integer",
"rawFilter": "string",
"rawOrderBy": "string"
}
top
skipToken
customOptions
inlineCount
skip
rawFilter
rawOrderBy
{
"direction": "string"
}
direction
{
"pageNumber": "integer",
"offset": "integer",
"pageSize": "integer",
"queryInfo": {
"expand": [
{
"propertyName": "string"
}
],
"select": [
{
"propertyName": "string"
}
],
"top": "integer",
"skipToken": "string",
"inlineCount": "string",
"orderBy": [
{
"direction": "string"
}
],
"skip": "integer",
"rawFilter": "string",
"rawOrderBy": "string"
}
}
pageNumber
offset
pageSize
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"loadBalancerTypeId": "string",
"description": "string",
"externalId": "string",
"pools": [
{
"persistenceExpiration": "integer",
"description": "string",
"healthCheckProtocol": "string",
"sslClientProfileName": "string",
"transparent": "boolean",
"persistenceCookieMode": "string",
"acceleration": "boolean",
"protocol": "string",
"memberMaxConnections": "integer",
"members": [
{
"address": "string",
"port": "integer",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
],
"algorithmParameter": "string",
"memberMinConnections": "integer",
"monitorIds": [
"string"
],
"id": "string",
"monitorPort": "integer",
"algorithm": "string",
"uniqueMonitorId": "string",
"sslDefaultCertificateName": "string",
"servicePortId": "string",
"persistenceCookieName": "string",
"externalId": "string",
"connectionRate": "integer",
"extensionData": {
"entries": [
{
"key": "string"
}
]
},
"connectionLimit": "integer",
"port": "integer",
"memberPort": "integer",
"persistenceMethod": "string",
"name": "string",
"tenantId": "string",
"memberProtocol": "string"
}
],
"vipNicIndex": "integer",
"tierNetwork": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
},
"virtualIps": [
{
"address": "string",
"name": "string",
"tenantId": "string",
"poolId": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
],
"name": "string",
"tenantId": "string",
"vipNetwork": "string",
"id": "string",
"tierNicIndex": "integer",
"loggingLevel": "string",
"monitors": [
{
"receive": "string",
"maxRetries": "integer",
"method": "string",
"newEntity": "boolean",
"interval": "integer",
"id": "string",
"monitorPath": "string",
"send": "string",
"timeout": "integer",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
]
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"schema": [
{
"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": [
{}
]
}
}
]
},
"lastUpdated": "string",
"schemaClassId": "string",
"createdDate": "string",
"id": "string",
"version": "integer"
}
],
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"serviceTypeId": "string",
"description": "string",
"id": "string",
"version": "integer",
"allocationRelatedResourceTypes": [
"string"
]
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"networkBackings": [
{
"computeResourceName": "string",
"externalId": "string",
"id": "string",
"computeResourceNetworkId": "string",
"computeResourceId": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
],
"machineIdCollection": [
"string"
],
"name": "string",
"tenantId": "string",
"description": "string",
"externalId": "string",
"networkTypeId": "string",
"networkProfileType": "string",
"id": "string",
"natRules": [
{
"networkInterfaceId": "string",
"translatedAddress": "string",
"componentId": "string",
"userDefined": "boolean",
"externalId": "string",
"description": "string",
"targetType": "string",
"type": "string",
"enabled": "boolean",
"protocol": "string",
"edgeId": "string",
"machineId": "string",
"originalAddress": "string",
"name": "string",
"peerInterfaceIndex": "integer",
"action": "string",
"translatedPort": "string",
"interfaceIndex": "integer",
"id": "string",
"tag": "string",
"componentName": "string",
"order": "integer",
"originalPort": "string"
}
],
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"schema": [
{
"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": [
{}
]
}
}
]
},
"lastUpdated": "string",
"schemaClassId": "string",
"createdDate": "string",
"id": "string",
"version": "integer"
}
],
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"serviceTypeId": "string",
"description": "string",
"id": "string",
"version": "integer",
"allocationRelatedResourceTypes": [
"string"
]
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"internal": "boolean",
"ipAddressCollection": [
"string"
],
"machineIdCollection": [
"string"
],
"name": "string",
"tenantId": "string",
"securityGroupTypeId": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"schema": [
{
"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": [
{}
]
}
}
]
},
"lastUpdated": "string",
"schemaClassId": "string",
"createdDate": "string",
"id": "string",
"version": "integer"
}
],
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"serviceTypeId": "string",
"description": "string",
"id": "string",
"version": "integer",
"allocationRelatedResourceTypes": [
"string"
]
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"internal": "boolean",
"name": "string",
"tenantId": "string",
"securityPolicyTypeId": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"schema": [
{
"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": [
{}
]
}
}
]
},
"lastUpdated": "string",
"schemaClassId": "string",
"createdDate": "string",
"id": "string",
"version": "integer"
}
],
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"serviceTypeId": "string",
"description": "string",
"id": "string",
"version": "integer",
"allocationRelatedResourceTypes": [
"string"
]
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"securityTagTypeId": "string",
"name": "string",
"tenantId": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"schema": [
{
"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": [
{}
]
}
}
]
},
"lastUpdated": "string",
"schemaClassId": "string",
"createdDate": "string",
"id": "string",
"version": "integer"
}
],
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"serviceTypeId": "string",
"description": "string",
"id": "string",
"version": "integer",
"allocationRelatedResourceTypes": [
"string"
]
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"key": "string"
}
key
{
"params": [
{
"key": "string"
}
]
}
{
"customAllowed": "boolean"
}
customAllowed
{
"leasePeriod": {
"unit": "string",
"amount": "integer"
},
"basis": {
"unit": "string",
"amount": "integer"
}
}
{
"statusCode": "string"
}
headers
body
statusCode
{
"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": [
{}
]
}
}
]
}
{
"internal": "boolean",
"ipAddressCollection": [
"string"
],
"machineIdCollection": [
"string"
],
"name": "string",
"tenantId": "string",
"securityGroupTypeId": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
internal
ipAddressCollection
machineIdCollection
name
tenantId
securityGroupTypeId
description
externalId
id
{
"schema": [
{
"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": [
{}
]
}
}
]
},
"lastUpdated": "string",
"schemaClassId": "string",
"createdDate": "string",
"id": "string",
"version": "integer"
}
],
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"serviceTypeId": "string",
"description": "string",
"id": "string",
"version": "integer",
"allocationRelatedResourceTypes": [
"string"
]
}
lastUpdated
createdDate
name
serviceTypeId
description
id
version
allocationRelatedResourceTypes
{
"internal": "boolean",
"name": "string",
"tenantId": "string",
"securityPolicyTypeId": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
internal
name
tenantId
securityPolicyTypeId
description
externalId
id
{
"schema": [
{
"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": [
{}
]
}
}
]
},
"lastUpdated": "string",
"schemaClassId": "string",
"createdDate": "string",
"id": "string",
"version": "integer"
}
],
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"serviceTypeId": "string",
"description": "string",
"id": "string",
"version": "integer",
"allocationRelatedResourceTypes": [
"string"
]
}
lastUpdated
createdDate
name
serviceTypeId
description
id
version
allocationRelatedResourceTypes
{
"securityTagTypeId": "string",
"name": "string",
"tenantId": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
securityTagTypeId
name
tenantId
description
externalId
id
{
"schema": [
{
"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": [
{}
]
}
}
]
},
"lastUpdated": "string",
"schemaClassId": "string",
"createdDate": "string",
"id": "string",
"version": "integer"
}
],
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"serviceTypeId": "string",
"description": "string",
"id": "string",
"version": "integer",
"allocationRelatedResourceTypes": [
"string"
]
}
lastUpdated
createdDate
name
serviceTypeId
description
id
version
allocationRelatedResourceTypes
{
"blueprintRequestId": "string",
"rootCafeDeploymentId": "string",
"targetResourceId": "string",
"rootCafeRequestId": "string",
"requestType": "string",
"blueprintName": "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"
},
"blueprintId": "string",
"callbackAdditionalUrlPath": "string",
"allocationConstraint": {
"filter": "string"
}
}
{
"filter": "string"
}
filter
{
"allocationResult": {
"entries": [
{
"key": "string"
}
]
},
"requestId": "string",
"serviceCallbackId": "string",
"errMsg": "string",
"requestCallbackAdditionalUrlPath": "string"
}
requestId
serviceCallbackId
errMsg
requestCallbackAdditionalUrlPath
{
"value": "boolean"
}
{
"tenantRef": "string",
"subtenantRef": "string",
"tenantLabel": "string",
"subtenantLabel": "string"
}
tenantRef
subtenantRef
tenantLabel
subtenantLabel
{
"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
{
"blueprintRequestId": "string",
"rootCafeDeploymentId": "string",
"targetResourceId": "string",
"rootCafeRequestId": "string",
"requestType": "string",
"blueprintName": "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"
},
"blueprintId": "string",
"callbackAdditionalUrlPath": "string"
}
blueprintRequestId
rootCafeDeploymentId
targetResourceId
rootCafeRequestId
requestType
blueprintName
requestId
callbackServiceId
blueprintId
callbackAdditionalUrlPath
{
"requestId": "string",
"serviceCallbackId": "string",
"errMsg": "string",
"requestCallbackAdditionalUrlPath": "string"
}
requestId
serviceCallbackId
errMsg
requestCallbackAdditionalUrlPath
{
"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"
}
]
}
{
"basis": {
"unit": "string",
"amount": "integer"
}
}
{
"resourceId": "string",
"rootCafeRequestId": "string",
"completionDetails": "string",
"requestSuccessful": "boolean",
"networkObject": {
"name": "string",
"tenantId": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
},
"tenantId": "string",
"subtenantId": "string",
"originalCallbackServiceId": "string",
"operationType": "string"
}
resourceId
rootCafeRequestId
completionDetails
requestSuccessful
tenantId
subtenantId
originalCallbackServiceId
operationType
{
"requestedFor": "string",
"catalogItemTypeId": "string",
"reasons": "string",
"requestType": "string",
"requestBindingId": "string",
"description": "string",
"targetCafeResourceId": "string",
"targetResourceId": "string",
"requestedBy": "string",
"rootCafeResourceId": "string",
"requestNumber": "integer",
"targetResourceTypeId": "string",
"requestedObjectId": "string",
"solution": "boolean",
"targetResourceProviderId": "string",
"catalogRequestId": "string",
"organization": {
"tenantRef": "string",
"subtenantRef": "string",
"tenantLabel": "string",
"subtenantLabel": "string"
},
"callbackServiceId": "string",
"requestData": {
"entries": [
{
"key": "string"
}
]
}
}
requestedFor
catalogItemTypeId
reasons
requestType
requestBindingId
description
targetCafeResourceId
targetResourceId
requestedBy
rootCafeResourceId
requestNumber
targetResourceTypeId
requestedObjectId
solution
targetResourceProviderId
catalogRequestId
callbackServiceId
{
"requestCompletionState": "string",
"resourceBindingIds": [
"string"
],
"completionDetails": "string"
}
requestCompletionState
resourceBindingIds
completionDetails
{
"requestedFor": "string",
"requestedBy": "string",
"reasons": "string",
"tenantId": "string",
"subtenantId": "string",
"description": "string"
}
requestedFor
requestedBy
reasons
tenantId
subtenantId
description
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.
{
"errorMessage": "string",
"errorCode": "integer"
}
errorMessage
errorCode
{
"errors": [
{
"errorMessage": "string",
"errorCode": "integer"
}
]
}
{
"label": "string"
}
label