Software Service API Data Structures
Clause
This data structure has no properties.
ComponentLifecycleTask
JSON Example
{
"lastUpdated": "string",
"createdDate": "string",
"taskDescriptorRef": {
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"description": "string",
"id": "string",
"version": "integer"
},
"id": "string",
"version": "integer",
"script": {
"scriptContent": "string",
"isRebootAfter": "boolean",
"scriptTypeId": {
"name": "string",
"supportedOsDetails": [
{
"execCommand": "string",
"osFamily": "string",
"execScript": "string",
"supportsOutputProps": "boolean",
"fileExtension": "string",
"execScriptExtension": "string"
}
]
}
}
}string As date-time As date-time
lastUpdated
Optional
lastUpdated
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
CriteriaOperator
This data structure has no properties.
DataType
JSON Example
{
"typeId": "string"
}string
typeId
Optional
typeId
DynamicDataRequest
JSON Example
{
"ignoreUnknownFields": "boolean",
"tenantId": "string",
"ids": [
"string"
]
}boolean
ignoreUnknownFields
Optional
ignoreUnknownFields
string
tenantId
Optional
tenantId
array of string
ids
Optional
ids
DynamicDataResponse
JSON Example
{
"values": {
"entries": [
{
"key": "string"
}
]
}
}
DynamicValueContext
JSON Example
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"providerEntityId": "string"
}string
providerEntityId
Optional
providerEntityId
ElementState
JSON Example
{
"dependencies": [
"string"
],
"facets": [
{}
]
}array of string
dependencies
Optional
dependencies
ElementValuesPagingInfo
JSON Example
{
"offset": "integer",
"count": "integer"
}integer As int32 As int32
offset
Optional
offset
integer As int32 As int32
count
Optional
count
Evaluator
This data structure has no properties.
ExtensionRendererContext
JSON Example
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
}string
extensionId
Optional
extensionId
FacetValueMap
JSON Example
{
"facets": [
{
"type": "string"
}
]
}
FacetValueMapEntry
JSON Example
{
"type": "string"
}string
type
Optional
type
Field
JSON Example
{
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"columns": [
"Field Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"orderIndex": "integer",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}string
displayAdvice
Optional
displayAdvice
boolean
isMultiValued
Optional
isMultiValued
string
description
Optional
description
integer As int32 As int32
orderIndex
Optional
orderIndex
string
id
Optional
id
string
label
Optional
label
InlineLayoutField1
This data structure has no properties.
boolean
isMultiValued
Optional
isMultiValued
string
description
Optional
description
string
label
Optional
label
integer As int32 As int32
labelSize
Optional
labelSize
string
displayAdvice
Optional
displayAdvice
integer As int32 As int32
orderIndex
Optional
orderIndex
string
id
Optional
id
InlineLayoutFlowElement1
This data structure has no properties.
LayoutCell
JSON Example
{
"size": "integer"
}integer As int32 As int32
size
Optional
size
LayoutField
AllOf
JSON Example
{
"size": "integer",
"extensionRendererContext": {
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
},
"columns": [
"LayoutField Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"label": "string",
"labelSize": "integer",
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"orderIndex": "integer",
"id": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
LayoutFlowElement
AllOf
JSON Example
{
"size": "integer"
}
LayoutPage
JSON Example
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}string
id
Optional
id
string
label
Optional
label
LayoutReference
This data structure has no properties.
LayoutRow
JSON Example
{
"items": [
{
"size": "integer"
}
]
}
LayoutSection
JSON Example
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}string
id
Optional
id
string
label
Optional
label
LiteralMapEntry
JSON Example
{
"key": "string"
}string
key
Optional
key
Node
JSON Example
{
"agentId": "string",
"proxyConfig": {
"entries": [
{
"key": "string"
}
]
},
"osFamily": "string",
"machineResourceId": "string",
"version": "integer",
"lastUpdated": "string",
"subTenantId": "string",
"createdDate": "string",
"name": "string",
"tenantId": "string",
"agentVersion": "string",
"lastAgentPingDate": "string",
"id": "string",
"registrationState": "string",
"subscriptionEndpoint": "string"
}string
agentId
Optional
agentId
string
osFamily
Optional
osFamily
string
machineResourceId
Optional
machineResourceId
integer As int64 As int64
version
Optional
version
string As date-time As date-time
lastUpdated
Optional
lastUpdated
string
subTenantId
Optional
subTenantId
string As date-time As date-time
createdDate
Optional
createdDate
string
name
Optional
name
string
tenantId
Optional
tenantId
string
agentVersion
Optional
agentVersion
string As date-time As date-time
lastAgentPingDate
Optional
lastAgentPingDate
string As uuid As uuid
id
Optional
id
string
registrationState
Optional
registrationState
string
subscriptionEndpoint
Optional
subscriptionEndpoint
OperationDescriptor
JSON Example
{
"lastUpdated": "string",
"createdDate": "string",
"displayName": "string",
"defaultTaskMappings": [
{
"taskDescriptorRef": {
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"description": "string",
"id": "string",
"version": "integer"
},
"order": "integer"
}
],
"appearsAfterRef": "OperationDescriptor Object",
"description": "string",
"lifecycleAction": "string",
"id": "string",
"version": "integer"
}string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
string
displayName
Optional
displayName
string
description
Optional
description
string
lifecycleAction
Optional
lifecycleAction
string
id
Optional
id
integer As int64 As int64
version
Optional
version
OperationTaskMapping
JSON Example
{
"taskDescriptorRef": {
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"description": "string",
"id": "string",
"version": "integer"
},
"order": "integer"
}integer As int32 As int32
order
Optional
order
ParameterMapping
JSON Example
{
"key": "string"
}string
key
Optional
key
ParameterMappingCollection
JSON Example
{
"params": [
{
"key": "string"
}
]
}
PermissibleValueList
JSON Example
{
"customAllowed": "boolean"
}boolean
customAllowed
Optional
customAllowed
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": [
{}
]
}
}
]
}
Script
JSON Example
{
"scriptContent": "string",
"isRebootAfter": "boolean",
"scriptTypeId": {
"name": "string",
"supportedOsDetails": [
{
"execCommand": "string",
"osFamily": "string",
"execScript": "string",
"supportsOutputProps": "boolean",
"fileExtension": "string",
"execScriptExtension": "string"
}
]
}
}string
scriptContent
Optional
scriptContent
boolean
isRebootAfter
Optional
isRebootAfter
ScriptType
JSON Example
{
"name": "string",
"supportedOsDetails": [
{
"execCommand": "string",
"osFamily": "string",
"execScript": "string",
"supportsOutputProps": "boolean",
"fileExtension": "string",
"execScriptExtension": "string"
}
]
}string
name
Optional
name
ScriptTypeOsDetails
JSON Example
{
"execCommand": "string",
"osFamily": "string",
"execScript": "string",
"supportsOutputProps": "boolean",
"fileExtension": "string",
"execScriptExtension": "string"
}string
execCommand
Optional
execCommand
string
osFamily
Required
osFamily
string
execScript
Optional
execScript
boolean
supportsOutputProps
Optional
supportsOutputProps
string
fileExtension
Optional
fileExtension
string
execScriptExtension
Optional
execScriptExtension
SoftwareComponentType
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": [
{}
]
}
}
]
},
"lifecycleTasks": [
{
"lastUpdated": "string",
"createdDate": "string",
"taskDescriptorRef": {
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"description": "string",
"id": "string",
"version": "integer"
},
"id": "string",
"version": "integer",
"script": {
"scriptContent": "string",
"isRebootAfter": "boolean",
"scriptTypeId": {
"name": "string",
"supportedOsDetails": [
{
"execCommand": "string",
"osFamily": "string",
"execScript": "string",
"supportsOutputProps": "boolean",
"fileExtension": "string",
"execScriptExtension": "string"
}
]
}
}
}
],
"description": "string",
"version": "integer",
"lastUpdated": "string",
"createdDate": "string",
"derivesFromRef": "SoftwareComponentType Object",
"name": "string",
"tenantId": "string",
"publishStatusName": "string",
"id": "string",
"catalogResourceTypeId": "string",
"containerResourceTypeId": "string",
"publishStatus": "string",
"containerFieldId": "string"
}string
description
Optional
description
integer As int64 As int64
version
Optional
version
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
tenantId
Optional
tenantId
string
publishStatusName
Optional
publishStatusName
string
id
Optional
id
string
catalogResourceTypeId
Optional
catalogResourceTypeId
string
containerResourceTypeId
Optional
containerResourceTypeId
string
publishStatus
Required
publishStatus
string
containerFieldId
Optional
containerFieldId
SoftwareComponentTypeInfo
JSON Example
{
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"tenantId": "string",
"description": "string",
"publishStatusName": "string",
"id": "string",
"version": "integer",
"publishStatus": "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
tenantId
Optional
tenantId
string
description
Optional
description
string
publishStatusName
Optional
publishStatusName
string
id
Optional
id
integer As int64 As int64
version
Optional
version
string
publishStatus
Required
publishStatus
SoftwareResourceRequest
JSON Example
{
"requestedFor": "string",
"taskRequests": [
{
"logDescription": "string",
"log": "string",
"taskDescriptorRef": {
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"description": "string",
"id": "string",
"version": "integer"
},
"version": "integer",
"script": {
"scriptContent": "string",
"isRebootAfter": "boolean",
"scriptTypeId": {
"name": "string",
"supportedOsDetails": [
{
"execCommand": "string",
"osFamily": "string",
"execScript": "string",
"supportsOutputProps": "boolean",
"fileExtension": "string",
"execScriptExtension": "string"
}
]
}
},
"lastUpdated": "string",
"createdDate": "string",
"stateName": "string",
"dateStarted": "string",
"dateCompleted": "string",
"nodeRef": {
"agentId": "string",
"proxyConfig": {
"entries": [
{
"key": "string"
}
]
},
"osFamily": "string",
"machineResourceId": "string",
"version": "integer",
"lastUpdated": "string",
"subTenantId": "string",
"createdDate": "string",
"name": "string",
"tenantId": "string",
"agentVersion": "string",
"lastAgentPingDate": "string",
"id": "string",
"registrationState": "string",
"subscriptionEndpoint": "string"
},
"id": "string",
"state": "string"
}
],
"operationDescriptorRef": {
"lastUpdated": "string",
"createdDate": "string",
"displayName": "string",
"defaultTaskMappings": [
{
"taskDescriptorRef": {
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"description": "string",
"id": "string",
"version": "integer"
},
"order": "integer"
}
],
"appearsAfterRef": "OperationDescriptor Object",
"description": "string",
"lifecycleAction": "string",
"id": "string",
"version": "integer"
},
"resourceId": "string",
"rootCafeRequestId": "string",
"externalServiceId": "string",
"version": "integer",
"statusMessage": "string",
"lastUpdated": "string",
"requestedBy": "string",
"subTenantId": "string",
"createdDate": "string",
"softwareComponentTypeRef": {
"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": [
{}
]
}
}
]
},
"lifecycleTasks": [
{
"lastUpdated": "string",
"createdDate": "string",
"taskDescriptorRef": {
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"description": "string",
"id": "string",
"version": "integer"
},
"id": "string",
"version": "integer",
"script": {
"scriptContent": "string",
"isRebootAfter": "boolean",
"scriptTypeId": {
"name": "string",
"supportedOsDetails": [
{
"execCommand": "string",
"osFamily": "string",
"execScript": "string",
"supportsOutputProps": "boolean",
"fileExtension": "string",
"execScriptExtension": "string"
}
]
}
}
}
],
"description": "string",
"version": "integer",
"lastUpdated": "string",
"createdDate": "string",
"derivesFromRef": "SoftwareComponentType Object",
"name": "string",
"tenantId": "string",
"publishStatusName": "string",
"id": "string",
"catalogResourceTypeId": "string",
"containerResourceTypeId": "string",
"publishStatus": "string",
"containerFieldId": "string"
},
"stateName": "string",
"dateCompleted": "string",
"resourceData": {
"entries": [
{
"key": "string"
}
]
},
"tenantId": "string",
"id": "string",
"state": "string",
"requestData": {
"entries": [
{
"key": "string"
}
]
},
"previousResourceData": {
"entries": [
{
"key": "string"
}
]
},
"dateSubmitted": "string"
}string
requestedFor
Optional
requestedFor
string
resourceId
Optional
resourceId
string
rootCafeRequestId
Optional
rootCafeRequestId
string
externalServiceId
Optional
externalServiceId
integer As int64 As int64
version
Optional
version
string
statusMessage
Optional
statusMessage
string As date-time As date-time
lastUpdated
Optional
lastUpdated
string
requestedBy
Optional
requestedBy
string
subTenantId
Optional
subTenantId
string As date-time As date-time
createdDate
Optional
createdDate
string
stateName
Optional
stateName
string As date-time As date-time
dateCompleted
Optional
dateCompleted
string
tenantId
Optional
tenantId
string As uuid As uuid
id
Optional
id
string
state
Required
state
string As date-time As date-time
dateSubmitted
Optional
dateSubmitted
TaskDescriptor
JSON Example
{
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"description": "string",
"id": "string",
"version": "integer"
}string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
string
name
Optional
name
string
description
Optional
description
string
id
Optional
id
integer As int64 As int64
version
Optional
version
TaskRequest
JSON Example
{
"logDescription": "string",
"log": "string",
"taskDescriptorRef": {
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"description": "string",
"id": "string",
"version": "integer"
},
"version": "integer",
"script": {
"scriptContent": "string",
"isRebootAfter": "boolean",
"scriptTypeId": {
"name": "string",
"supportedOsDetails": [
{
"execCommand": "string",
"osFamily": "string",
"execScript": "string",
"supportsOutputProps": "boolean",
"fileExtension": "string",
"execScriptExtension": "string"
}
]
}
},
"lastUpdated": "string",
"createdDate": "string",
"stateName": "string",
"dateStarted": "string",
"dateCompleted": "string",
"nodeRef": {
"agentId": "string",
"proxyConfig": {
"entries": [
{
"key": "string"
}
]
},
"osFamily": "string",
"machineResourceId": "string",
"version": "integer",
"lastUpdated": "string",
"subTenantId": "string",
"createdDate": "string",
"name": "string",
"tenantId": "string",
"agentVersion": "string",
"lastAgentPingDate": "string",
"id": "string",
"registrationState": "string",
"subscriptionEndpoint": "string"
},
"id": "string",
"state": "string"
}string
logDescription
Optional
logDescription
string
log
Optional
log
integer As int64 As int64
version
Optional
version
string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
string
stateName
Optional
stateName
string As date-time As date-time
dateStarted
Optional
dateStarted
string As date-time As date-time
dateCompleted
Optional
dateCompleted
string As uuid As uuid
id
Optional
id
string
state
Optional
state
batchElementUpdateRequest
JSON Example
{
"formValues": {
"entries": [
{
"key": "string"
}
]
},
"headers": {
"entries": [
{
"key": "string"
}
]
},
"trigger": "string",
"triggeredDetailsLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"affectedElements": [
"string"
]
}string
trigger
Optional
trigger
array of string
affectedElements
Optional
affectedElements
booleanLiteral
Wraps a boolean value.
JSON Example
{
"value": "boolean"
}boolean
value
Optional
The boolean value.
componentRequestStatusDetails
JSON Example
{
"dateStarted": "string",
"requestId": "string",
"dateCompleted": "string",
"details": [
{
"logDescription": "string",
"dateStarted": "string",
"log": "string",
"dateCompleted": "string",
"label": "string",
"status": "string"
}
],
"status": "string"
}string As date-time As date-time
dateStarted
Optional
dateStarted
string
requestId
Optional
requestId
string As date-time As date-time
dateCompleted
Optional
dateCompleted
string
status
Optional
status
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
formUpdateResponse
JSON Example
{
"elementUpdates": [
{
"permissibleValues": [
{
"label": "string"
}
],
"extensionRendererContext": {
"entries": [
{
"key": "string"
}
]
},
"facetValues": {
"facets": [
{
"type": "string"
}
]
},
"id": "string",
"detailLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"errors": [
"string"
]
}
]
}
layout
JSON Example
{
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
}
literal
Wraps a value such that values of different types can be treated generically.
This data structure has no properties.
literalMap
Equivalent of java.util.Map
JSON Example
{
"entries": [
{
"key": "string"
}
]
}
taskStatusDetail
JSON Example
{
"logDescription": "string",
"dateStarted": "string",
"log": "string",
"dateCompleted": "string",
"label": "string",
"status": "string"
}string
logDescription
Optional
logDescription
string As date-time As date-time
dateStarted
Optional
dateStarted
string
log
Optional
log
string As date-time As date-time
dateCompleted
Optional
dateCompleted
string
label
Optional
label
string
status
Optional
status
timeSpan
A literal defining period of time. This period is represented some integral number of a specified timeUnit.e.g. 6 days.
JSON Example
{
"unit": "string",
"amount": "integer"
}string
unit
Optional
The unit of measure for the time span. e.g: days.
integer As int64 As int64
amount
Optional
The amount for the time span.
updateElementEntry
JSON Example
{
"permissibleValues": [
{
"label": "string"
}
],
"extensionRendererContext": {
"entries": [
{
"key": "string"
}
]
},
"facetValues": {
"facets": [
{
"type": "string"
}
]
},
"id": "string",
"detailLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"errors": [
"string"
]
}string
id
Optional
id
array of string
errors
Optional
errors
value
JSON Example
{
"label": "string"
}string
label
Optional
label
Node: apidepo-liferay-dxp-v1-be-w-0:8080: