Network Service API Data Structures
BoolCommonExpression
This data structure has no properties.
Clause
This data structure has no properties.
CommonExpression
This data structure has no properties.
CriteriaOperator
This data structure has no properties.
DataType
JSON Example
{
"typeId": "string"
}string
typeId
Optional
typeId
DynamicValueContext
JSON Example
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"providerEntityId": "string"
}string
providerEntityId
Optional
providerEntityId
ElementState
JSON Example
{
"dependencies": [
"string"
],
"facets": [
{}
]
}array of string
dependencies
Optional
dependencies
EntitySimpleProperty
JSON Example
{
"propertyName": "string"
}string
propertyName
Optional
propertyName
Evaluator
This data structure has no properties.
ExtensionRendererContext
JSON Example
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
}string
extensionId
Optional
extensionId
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.
InlineallocateComponentRequest1
This data structure has no properties.
InlineallocateComponentRequest1
This data structure has no properties.
InlinebooleanLiteral1
Wraps a boolean value.
This data structure has no properties.
boolean
value
Optional
The boolean value.
InlinemoneyTimeRate1
Represents a rate of money over time.
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
LoadBalancer
JSON Example
{
"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"
}
]
}
}
]
}string
loadBalancerTypeId
Optional
loadBalancerTypeId
string
description
Optional
description
string
externalId
Optional
externalId
integer As int32 As int32
vipNicIndex
Optional
vipNicIndex
string
tierNetwork
Optional
tierNetwork
string
name
Optional
name
string
tenantId
Optional
tenantId
string
vipNetwork
Optional
vipNetwork
string
id
Optional
id
integer As int32 As int32
tierNicIndex
Optional
tierNicIndex
string
loggingLevel
Optional
loggingLevel
LoadBalancerMember
JSON Example
{
"address": "string",
"port": "integer",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}string
address
Optional
address
integer As int32 As int32
port
Optional
port
string
externalId
Optional
externalId
string
id
Optional
id
LoadBalancerMonitor
JSON Example
{
"receive": "string",
"maxRetries": "integer",
"method": "string",
"newEntity": "boolean",
"interval": "integer",
"id": "string",
"monitorPath": "string",
"send": "string",
"timeout": "integer",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}string
receive
Optional
receive
integer As int32 As int32
maxRetries
Optional
maxRetries
string
method
Optional
method
boolean
newEntity
Optional
newEntity
integer As int32 As int32
interval
Optional
interval
string
id
Optional
id
string
monitorPath
Optional
monitorPath
string
send
Optional
send
integer As int32 As int32
timeout
Optional
timeout
LoadBalancerPool
JSON Example
{
"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"
}integer As int32 As int32
persistenceExpiration
Optional
persistenceExpiration
string
description
Optional
description
string
healthCheckProtocol
Optional
healthCheckProtocol
string
sslClientProfileName
Optional
sslClientProfileName
boolean
transparent
Optional
transparent
string
persistenceCookieMode
Optional
persistenceCookieMode
boolean
acceleration
Optional
acceleration
string
protocol
Optional
protocol
integer As int32 As int32
memberMaxConnections
Optional
memberMaxConnections
string
algorithmParameter
Optional
algorithmParameter
integer As int32 As int32
memberMinConnections
Optional
memberMinConnections
array of string
monitorIds
Required
monitorIds
string
id
Optional
id
integer As int32 As int32
monitorPort
Optional
monitorPort
string
algorithm
Optional
algorithm
string
uniqueMonitorId
Optional
uniqueMonitorId
string
sslDefaultCertificateName
Optional
sslDefaultCertificateName
string
servicePortId
Optional
servicePortId
string
persistenceCookieName
Optional
persistenceCookieName
string
externalId
Optional
externalId
integer As int32 As int32
connectionRate
Optional
connectionRate
integer As int32 As int32
connectionLimit
Optional
connectionLimit
integer As int32 As int32
port
Optional
port
integer As int32 As int32
memberPort
Optional
memberPort
string
persistenceMethod
Optional
persistenceMethod
string
name
Optional
name
string
tenantId
Optional
tenantId
string
memberProtocol
Optional
memberProtocol
LoadBalancerType
JSON Example
{
"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"
]
}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
serviceTypeId
Optional
serviceTypeId
string
description
Optional
description
string
id
Optional
id
integer As int64 As int64
version
Optional
version
array of string
allocationRelatedResourceTypes
Optional
allocationRelatedResourceTypes
Property Of
LoadBalancerVirtualIp
JSON Example
{
"address": "string",
"name": "string",
"tenantId": "string",
"poolId": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}string
address
Optional
address
string
name
Optional
name
string
tenantId
Optional
tenantId
string
poolId
Optional
poolId
string
description
Optional
description
string
externalId
Optional
externalId
string
id
Optional
id
NatRule
JSON Example
{
"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"
}string
networkInterfaceId
Optional
networkInterfaceId
string
translatedAddress
Optional
translatedAddress
string
componentId
Optional
componentId
boolean
userDefined
Optional
userDefined
string
externalId
Optional
externalId
string
description
Optional
description
string
targetType
Optional
targetType
string
type
Optional
type
boolean
enabled
Optional
enabled
string
protocol
Optional
protocol
string
edgeId
Optional
edgeId
string
machineId
Optional
machineId
string
originalAddress
Optional
originalAddress
string
name
Optional
name
integer As int32 As int32
peerInterfaceIndex
Optional
peerInterfaceIndex
string
action
Optional
action
string
translatedPort
Optional
translatedPort
integer As int32 As int32
interfaceIndex
Optional
interfaceIndex
string
id
Optional
id
string
tag
Optional
tag
string
componentName
Optional
componentName
integer As int64 As int64
order
Optional
order
string
originalPort
Optional
originalPort
Network
JSON Example
{
"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"
}
]
}
}array of string
machineIdCollection
Optional
machineIdCollection
string
name
Optional
name
string
tenantId
Optional
tenantId
string
description
Optional
description
string
externalId
Optional
externalId
string
networkTypeId
Optional
networkTypeId
string
networkProfileType
Required
networkProfileType
string
id
Optional
id
NetworkBacking
JSON Example
{
"computeResourceName": "string",
"externalId": "string",
"id": "string",
"computeResourceNetworkId": "string",
"computeResourceId": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}string
computeResourceName
Optional
computeResourceName
string
externalId
Optional
externalId
string
id
Optional
id
string
computeResourceNetworkId
Optional
computeResourceNetworkId
string
computeResourceId
Optional
computeResourceId
NetworkObject
JSON Example
{
"name": "string",
"tenantId": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}string
name
Optional
name
string
tenantId
Optional
tenantId
string
description
Optional
description
string
externalId
Optional
externalId
string
id
Optional
id
NetworkObjectSchema
JSON Example
{
"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"
}string As date-time As date-time
lastUpdated
Optional
lastUpdated
string
schemaClassId
Optional
schemaClassId
string As date-time As date-time
createdDate
Optional
createdDate
string As uuid As uuid
id
Optional
id
integer As int64 As int64
version
Optional
version
NetworkType
JSON Example
{
"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"
]
}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
serviceTypeId
Optional
serviceTypeId
string
description
Optional
description
string
id
Optional
id
integer As int64 As int64
version
Optional
version
array of string
allocationRelatedResourceTypes
Optional
allocationRelatedResourceTypes
Property Of
OdataQueryInfo
JSON Example
{
"expand": [
{
"propertyName": "string"
}
],
"select": [
{
"propertyName": "string"
}
],
"top": "integer",
"skipToken": "string",
"inlineCount": "string",
"orderBy": [
{
"direction": "string"
}
],
"skip": "integer",
"rawFilter": "string",
"rawOrderBy": "string"
}integer As int32 As int32
top
Optional
top
string
skipToken
Optional
skipToken
object
customOptions
Optional
customOptions
string
inlineCount
Optional
inlineCount
integer As int32 As int32
skip
Optional
skip
string
rawFilter
Optional
rawFilter
string
rawOrderBy
Optional
rawOrderBy
OrderByExpression
JSON Example
{
"direction": "string"
}string
direction
Optional
direction
PageAndSortRequest
JSON Example
{
"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"
}
}integer As int32 As int32
pageNumber
Optional
pageNumber
integer As int32 As int32
offset
Optional
offset
integer As int32 As int32
pageSize
Optional
pageSize
PageLoadBalancer
JSON Example
{
"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"
}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
PageLoadBalancerType
JSON Example
{
"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"
}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
PageNetwork
JSON Example
{
"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"
}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
PageNetworkType
JSON Example
{
"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"
}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
PageSecurityGroup
JSON Example
{
"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"
}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
PageSecurityGroupType
JSON Example
{
"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"
}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
PageSecurityPolicy
JSON Example
{
"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"
}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
PageSecurityPolicyType
JSON Example
{
"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"
}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
PageSecurityTag
JSON Example
{
"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"
}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
PageSecurityTagType
JSON Example
{
"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"
}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
RequestQuote
JSON Example
{
"leasePeriod": {
"unit": "string",
"amount": "integer"
},
"basis": {
"unit": "string",
"amount": "integer"
}
}
ResponseEntity
JSON Example
{
"statusCode": "string"
}object
headers
Optional
headers
object
body
Optional
body
string
statusCode
Optional
statusCode
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": [
{}
]
}
}
]
}
SecurityGroup
JSON Example
{
"internal": "boolean",
"ipAddressCollection": [
"string"
],
"machineIdCollection": [
"string"
],
"name": "string",
"tenantId": "string",
"securityGroupTypeId": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}boolean
internal
Optional
internal
array of string
ipAddressCollection
Optional
ipAddressCollection
array of string
machineIdCollection
Optional
machineIdCollection
string
name
Optional
name
string
tenantId
Optional
tenantId
string
securityGroupTypeId
Optional
securityGroupTypeId
string
description
Optional
description
string
externalId
Optional
externalId
string
id
Optional
id
Property Of
SecurityGroupType
JSON Example
{
"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"
]
}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
serviceTypeId
Optional
serviceTypeId
string
description
Optional
description
string
id
Optional
id
integer As int64 As int64
version
Optional
version
array of string
allocationRelatedResourceTypes
Optional
allocationRelatedResourceTypes
Property Of
SecurityPolicy
JSON Example
{
"internal": "boolean",
"name": "string",
"tenantId": "string",
"securityPolicyTypeId": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}boolean
internal
Optional
internal
string
name
Optional
name
string
tenantId
Optional
tenantId
string
securityPolicyTypeId
Optional
securityPolicyTypeId
string
description
Optional
description
string
externalId
Optional
externalId
string
id
Optional
id
SecurityPolicyType
JSON Example
{
"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"
]
}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
serviceTypeId
Optional
serviceTypeId
string
description
Optional
description
string
id
Optional
id
integer As int64 As int64
version
Optional
version
array of string
allocationRelatedResourceTypes
Optional
allocationRelatedResourceTypes
Property Of
SecurityTag
JSON Example
{
"securityTagTypeId": "string",
"name": "string",
"tenantId": "string",
"description": "string",
"externalId": "string",
"id": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}string
securityTagTypeId
Optional
securityTagTypeId
string
name
Optional
name
string
tenantId
Optional
tenantId
string
description
Optional
description
string
externalId
Optional
externalId
string
id
Optional
id
SecurityTagType
JSON Example
{
"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"
]
}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
serviceTypeId
Optional
serviceTypeId
string
description
Optional
description
string
id
Optional
id
integer As int64 As int64
version
Optional
version
array of string
allocationRelatedResourceTypes
Optional
allocationRelatedResourceTypes
Property Of
Sort
This data structure has no properties.
allocateComponentRequest
AllOf
This class requires all of the following:
JSON Example
{
"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"
}
}
allocationConstraint
JSON Example
{
"filter": "string"
}string
filter
Optional
filter
allocationRequestCompletion
JSON Example
{
"allocationResult": {
"entries": [
{
"key": "string"
}
]
},
"requestId": "string",
"serviceCallbackId": "string",
"errMsg": "string",
"requestCallbackAdditionalUrlPath": "string"
}string
requestId
Optional
requestId
string
serviceCallbackId
Optional
serviceCallbackId
string
errMsg
Optional
errMsg
string
requestCallbackAdditionalUrlPath
Optional
requestCallbackAdditionalUrlPath
booleanLiteral
AllOf
JSON Example
{
"value": "boolean"
}
catalogOrganizationReference
JSON Example
{
"tenantRef": "string",
"subtenantRef": "string",
"tenantLabel": "string",
"subtenantLabel": "string"
}string
tenantRef
Optional
tenantRef
string
subtenantRef
Optional
subtenantRef
string
tenantLabel
Optional
tenantLabel
string
subtenantLabel
Optional
subtenantLabel
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
compositionProviderRequest
JSON Example
{
"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"
}string
blueprintRequestId
Optional
blueprintRequestId
string
rootCafeDeploymentId
Optional
rootCafeDeploymentId
string
targetResourceId
Optional
targetResourceId
string
rootCafeRequestId
Optional
rootCafeRequestId
string
requestType
Optional
requestType
string
blueprintName
Optional
blueprintName
string
requestId
Optional
requestId
string
callbackServiceId
Optional
callbackServiceId
string
blueprintId
Optional
blueprintId
string
callbackAdditionalUrlPath
Optional
callbackAdditionalUrlPath
deallocationRequestCompletion
JSON Example
{
"requestId": "string",
"serviceCallbackId": "string",
"errMsg": "string",
"requestCallbackAdditionalUrlPath": "string"
}string
requestId
Optional
requestId
string
serviceCallbackId
Optional
serviceCallbackId
string
errMsg
Optional
errMsg
string
requestCallbackAdditionalUrlPath
Optional
requestCallbackAdditionalUrlPath
layout
JSON Example
{
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
}
literal
Wraps a value such that values of different types can be treated generically.
This data structure has no properties.
literalMap
Equivalent of java.util.Map
JSON Example
{
"entries": [
{
"key": "string"
}
]
}
moneyTimeRate
AllOf
JSON Example
{
"basis": {
"unit": "string",
"amount": "integer"
}
}
networkRequestCompletion
JSON Example
{
"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"
}string
resourceId
Optional
resourceId
string
rootCafeRequestId
Optional
rootCafeRequestId
string
completionDetails
Optional
completionDetails
boolean
requestSuccessful
Optional
requestSuccessful
string
tenantId
Optional
tenantId
string
subtenantId
Optional
subtenantId
string
originalCallbackServiceId
Optional
originalCallbackServiceId
string
operationType
Optional
operationType
providerRequest
JSON Example
{
"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"
}
]
}
}string
requestedFor
Optional
requestedFor
string
catalogItemTypeId
Optional
catalogItemTypeId
string
reasons
Optional
reasons
string
requestType
Optional
requestType
string
requestBindingId
Optional
requestBindingId
string
description
Optional
description
string
targetCafeResourceId
Optional
targetCafeResourceId
string
targetResourceId
Optional
targetResourceId
string
requestedBy
Optional
requestedBy
string
rootCafeResourceId
Optional
rootCafeResourceId
integer As int64 As int64
requestNumber
Optional
requestNumber
string
targetResourceTypeId
Optional
targetResourceTypeId
string
requestedObjectId
Optional
requestedObjectId
boolean
solution
Optional
solution
string
targetResourceProviderId
Optional
targetResourceProviderId
string
catalogRequestId
Optional
catalogRequestId
string
callbackServiceId
Optional
callbackServiceId
requestCompletion
JSON Example
{
"requestCompletionState": "string",
"resourceBindingIds": [
"string"
],
"completionDetails": "string"
}string
requestCompletionState
Optional
requestCompletionState
array of string
resourceBindingIds
Optional
resourceBindingIds
string
completionDetails
Optional
completionDetails
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
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.
validationError
JSON Example
{
"errorMessage": "string",
"errorCode": "integer"
}string
errorMessage
Optional
errorMessage
integer As int32 As int32
errorCode
Optional
errorCode
validationResponse
JSON Example
{
"errors": [
{
"errorMessage": "string",
"errorCode": "integer"
}
]
}
value
JSON Example
{
"label": "string"
}string
label
Optional
label
Node: apidepo-liferay-dxp-v1-be-w-0:8080: