Software Service API Data Structures
{
"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"
}
]
}
}
}
lastUpdated
createdDate
id
version
{
"typeId": "string"
}
typeId
{
"ignoreUnknownFields": "boolean",
"tenantId": "string",
"ids": [
"string"
]
}
ignoreUnknownFields
tenantId
ids
{
"values": {
"entries": [
{
"key": "string"
}
]
}
}
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"providerEntityId": "string"
}
providerEntityId
{
"dependencies": [
"string"
],
"facets": [
{}
]
}
dependencies
{
"offset": "integer",
"count": "integer"
}
offset
count
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
}
extensionId
{
"facets": [
{
"type": "string"
}
]
}
{
"type": "string"
}
type
{
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"columns": [
"Field Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"orderIndex": "integer",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
displayAdvice
isMultiValued
description
orderIndex
id
label
isMultiValued
description
label
labelSize
displayAdvice
orderIndex
id
{
"size": "integer"
}
size
{
"size": "integer",
"extensionRendererContext": {
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
},
"columns": [
"LayoutField Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"label": "string",
"labelSize": "integer",
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"orderIndex": "integer",
"id": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
{
"size": "integer"
}
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
id
label
{
"items": [
{
"size": "integer"
}
]
}
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
id
label
{
"key": "string"
}
key
{
"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"
}
agentId
osFamily
machineResourceId
version
lastUpdated
subTenantId
createdDate
name
tenantId
agentVersion
lastAgentPingDate
id
registrationState
subscriptionEndpoint
{
"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"
}
lastUpdated
createdDate
displayName
description
lifecycleAction
id
version
{
"taskDescriptorRef": {
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"description": "string",
"id": "string",
"version": "integer"
},
"order": "integer"
}
order
{
"key": "string"
}
key
{
"params": [
{
"key": "string"
}
]
}
{
"customAllowed": "boolean"
}
customAllowed
{
"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": [
{}
]
}
}
]
}
{
"scriptContent": "string",
"isRebootAfter": "boolean",
"scriptTypeId": {
"name": "string",
"supportedOsDetails": [
{
"execCommand": "string",
"osFamily": "string",
"execScript": "string",
"supportsOutputProps": "boolean",
"fileExtension": "string",
"execScriptExtension": "string"
}
]
}
}
scriptContent
isRebootAfter
{
"name": "string",
"supportedOsDetails": [
{
"execCommand": "string",
"osFamily": "string",
"execScript": "string",
"supportsOutputProps": "boolean",
"fileExtension": "string",
"execScriptExtension": "string"
}
]
}
name
{
"execCommand": "string",
"osFamily": "string",
"execScript": "string",
"supportsOutputProps": "boolean",
"fileExtension": "string",
"execScriptExtension": "string"
}
execCommand
osFamily
execScript
supportsOutputProps
fileExtension
execScriptExtension
{
"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"
}
description
version
lastUpdated
createdDate
name
tenantId
publishStatusName
id
catalogResourceTypeId
containerResourceTypeId
publishStatus
containerFieldId
{
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"tenantId": "string",
"description": "string",
"publishStatusName": "string",
"id": "string",
"version": "integer",
"publishStatus": "string"
}
lastUpdated
createdDate
name
tenantId
description
publishStatusName
id
version
publishStatus
{
"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"
}
requestedFor
resourceId
rootCafeRequestId
externalServiceId
version
statusMessage
lastUpdated
requestedBy
subTenantId
createdDate
stateName
dateCompleted
tenantId
id
state
dateSubmitted
{
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"description": "string",
"id": "string",
"version": "integer"
}
lastUpdated
createdDate
name
description
id
version
{
"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"
}
logDescription
log
version
lastUpdated
createdDate
stateName
dateStarted
dateCompleted
id
state
{
"formValues": {
"entries": [
{
"key": "string"
}
]
},
"headers": {
"entries": [
{
"key": "string"
}
]
},
"trigger": "string",
"triggeredDetailsLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"affectedElements": [
"string"
]
}
trigger
affectedElements
Wraps a boolean value.
{
"value": "boolean"
}
The boolean value.
{
"dateStarted": "string",
"requestId": "string",
"dateCompleted": "string",
"details": [
{
"logDescription": "string",
"dateStarted": "string",
"log": "string",
"dateCompleted": "string",
"label": "string",
"status": "string"
}
],
"status": "string"
}
dateStarted
requestId
dateCompleted
status
{
"values": [
{
"label": "string"
}
]
}
{
"pagingInfo": {
"offset": "integer",
"count": "integer"
},
"headers": {
"entries": [
{
"key": "string"
}
]
},
"tenantId": "string",
"text": "string",
"userId": "string",
"dependencyValues": {
"entries": [
{
"key": "string"
}
]
}
}
tenantId
text
userId
{
"elementUpdates": [
{
"permissibleValues": [
{
"label": "string"
}
],
"extensionRendererContext": {
"entries": [
{
"key": "string"
}
]
},
"facetValues": {
"facets": [
{
"type": "string"
}
]
},
"id": "string",
"detailLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"errors": [
"string"
]
}
]
}
{
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
}
Wraps a value such that values of different types can be treated generically.
Equivalent of java.util.Map
{
"entries": [
{
"key": "string"
}
]
}
{
"logDescription": "string",
"dateStarted": "string",
"log": "string",
"dateCompleted": "string",
"label": "string",
"status": "string"
}
logDescription
dateStarted
log
dateCompleted
label
status
A literal defining period of time. This period is represented some integral number of a specified timeUnit.e.g. 6 days.
{
"unit": "string",
"amount": "integer"
}
The unit of measure for the time span. e.g: days.
The amount for the time span.
{
"permissibleValues": [
{
"label": "string"
}
],
"extensionRendererContext": {
"entries": [
{
"key": "string"
}
]
},
"facetValues": {
"facets": [
{
"type": "string"
}
]
},
"id": "string",
"detailLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"errors": [
"string"
]
}
id
errors
{
"label": "string"
}
label