Api Documentation Data Structures
A group of resources such as machines, network, software, etc... typically provisioned together to deliver a complete/workable application.
{
"blueprintId": "string",
"blueprintVersion": "string",
"catalogItemId": "string",
"catalogItemVersion": "string",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"expense": {
"additionalExpense": "number",
"code": "string",
"computeExpense": "number",
"lastUpdatedTime": "string",
"message": "string",
"networkExpense": "number",
"storageExpense": "number",
"totalExpense": "number",
"unit": "string"
},
"iconId": "string",
"id": "string",
"lastRequest": {
"actionId": "string",
"blueprintId": "string",
"catalogItemId": "string",
"completedTasks": "integer",
"createdAt": "string",
"deploymentId": "string",
"details": "string",
"id": "string",
"name": "string",
"parentId": "string",
"requestedBy": "string",
"requester": "string",
"resourceName": "string",
"resourceType": "string",
"status": "string",
"statusDetails": "string",
"totalTasks": "integer",
"updatedAt": "string"
},
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"leaseExpireAt": "string",
"name": "string",
"project": {
"id": "string",
"link": "string",
"name": "string"
},
"projectId": "string",
"resources": [
{
"createdAt": "string",
"dependsOn": [
"string"
],
"description": "string",
"expense": {
"additionalExpense": "number",
"code": "string",
"computeExpense": "number",
"lastUpdatedTime": "string",
"message": "string",
"networkExpense": "number",
"storageExpense": "number",
"totalExpense": "number",
"unit": "string"
},
"id": "string",
"name": "string",
"state": "string",
"syncStatus": "string",
"type": "string"
}
],
"simulated": "boolean",
"status": "string"
}
Deployment blueprint id
Deployment blueprint version
Deployment catalog item id
Deployment catalog version
Creation time
Created by
Description of the deployment
Deployment icon id
Id of the deployment
The inputs that were used to request this deployment
Update time
Updated by
Lease expiration time
Name of the deployment
Deployment project id
Expanded resources for the deployment. Content of this property will not be maintained backward compatible
simulated
Deployment status.
Represents deployment events.
{
"createdAt": "string",
"deploymentId": "string",
"details": "string",
"id": "string",
"name": "string",
"parentId": "string",
"resourceName": "string",
"resourceType": "string",
"updatedAt": "string"
}
Creation time (e.g. date format '2019-07-13T23:16:49.310Z').
Deployment id to which the event applies to
Longer user-friendly details of the event.
Event identifier
Short user-friendly label of the event (e.g. 'shuting down myVM')
Parent event/request identifier
Optional resource name to which the event applies to
Optional resource type to which the event applies to
Last update time (e.g. date format '2019-07-13T23:16:49.310Z').
A deployment user request.
{
"actionId": "string",
"blueprintId": "string",
"catalogItemId": "string",
"completedTasks": "integer",
"createdAt": "string",
"deploymentId": "string",
"details": "string",
"id": "string",
"name": "string",
"parentId": "string",
"requestedBy": "string",
"requester": "string",
"resourceName": "string",
"resourceType": "string",
"status": "string",
"statusDetails": "string",
"totalTasks": "integer",
"updatedAt": "string"
}
Identifier of the requested action
Identifier of the requested blueprint in the form 'UUID:version'
Identifier of the requested catalog item in the form 'UUID:version'
The number of tasks completed while fulfilling this request.
Creation time (e.g. date format '2019-07-13T23:16:49.310Z').
Deployment id to which the event applies to
Longer user-friendly details of the event.
Event identifier
Request inputs
Short user-friendly label of the event (e.g. 'shuting down myVM')
Parent event/request identifier
User that initiated the request
requester
Optional resource name to which the event applies to
Optional resource type to which the event applies to
Request overall execution status.
statusDetails
The total number of tasks need to be completed to fulfil this request.
Last update time (e.g. date format '2019-07-13T23:16:49.310Z').
A deployment update request
{
"description": "string",
"name": "string"
}
New description of the deployment
New name of the deployment
{
"additionalExpense": "number",
"code": "string",
"computeExpense": "number",
"lastUpdatedTime": "string",
"message": "string",
"networkExpense": "number",
"storageExpense": "number",
"totalExpense": "number",
"unit": "string"
}
Additional expense incurred for the resource.
Expense sync message code if any.
Compute expense of the resource.
Last expense sync time.
Expense sync message if any.
Network expense of the resource.
Storage expense of the resource.
Total expense of the resource.
Monetary unit.
{
"content": [
{
"count": "integer",
"id": "string",
"name": "string"
}
],
"empty": "boolean",
"first": "boolean",
"id": "string",
"last": "boolean",
"name": "string",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
id
last
name
number
numberOfElements
size
totalElements
totalPages
{
"count": "integer",
"id": "string",
"name": "string"
}
count
id
name
{
"filters": [
{
"content": [
{
"count": "integer",
"id": "string",
"name": "string"
}
],
"empty": "boolean",
"first": "boolean",
"id": "string",
"last": "boolean",
"name": "string",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
]
}
{
"formURI": "string"
}
formURI
Project callback response containing count of deployments
{
"totalElements": "integer"
}
Count of the deployments
{
"content": [
{
"blueprintId": "string",
"blueprintVersion": "string",
"catalogItemId": "string",
"catalogItemVersion": "string",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"expense": {
"additionalExpense": "number",
"code": "string",
"computeExpense": "number",
"lastUpdatedTime": "string",
"message": "string",
"networkExpense": "number",
"storageExpense": "number",
"totalExpense": "number",
"unit": "string"
},
"iconId": "string",
"id": "string",
"lastRequest": {
"actionId": "string",
"blueprintId": "string",
"catalogItemId": "string",
"completedTasks": "integer",
"createdAt": "string",
"deploymentId": "string",
"details": "string",
"id": "string",
"name": "string",
"parentId": "string",
"requestedBy": "string",
"requester": "string",
"resourceName": "string",
"resourceType": "string",
"status": "string",
"statusDetails": "string",
"totalTasks": "integer",
"updatedAt": "string"
},
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"leaseExpireAt": "string",
"name": "string",
"project": {
"id": "string",
"link": "string",
"name": "string"
},
"projectId": "string",
"resources": [
{
"createdAt": "string",
"dependsOn": [
"string"
],
"description": "string",
"expense": {
"additionalExpense": "number",
"code": "string",
"computeExpense": "number",
"lastUpdatedTime": "string",
"message": "string",
"networkExpense": "number",
"storageExpense": "number",
"totalExpense": "number",
"unit": "string"
},
"id": "string",
"name": "string",
"state": "string",
"syncStatus": "string",
"type": "string"
}
],
"simulated": "boolean",
"status": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
{
"content": [
{
"createdAt": "string",
"deploymentId": "string",
"details": "string",
"id": "string",
"name": "string",
"parentId": "string",
"resourceName": "string",
"resourceType": "string",
"updatedAt": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
{
"content": [
{
"count": "integer",
"id": "string",
"name": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
{
"content": [
{
"createdAt": "string",
"dependsOn": [
"string"
],
"description": "string",
"expense": {
"additionalExpense": "number",
"code": "string",
"computeExpense": "number",
"lastUpdatedTime": "string",
"message": "string",
"networkExpense": "number",
"storageExpense": "number",
"totalExpense": "number",
"unit": "string"
},
"id": "string",
"name": "string",
"state": "string",
"syncStatus": "string",
"type": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}
empty
first
last
number
numberOfElements
size
totalElements
totalPages
A resource part of a deployment.
{
"createdAt": "string",
"dependsOn": [
"string"
],
"description": "string",
"expense": {
"additionalExpense": "number",
"code": "string",
"computeExpense": "number",
"lastUpdatedTime": "string",
"message": "string",
"networkExpense": "number",
"storageExpense": "number",
"totalExpense": "number",
"unit": "string"
},
"id": "string",
"name": "string",
"state": "string",
"syncStatus": "string",
"type": "string"
}
Creation time
A list of other resources this resource depends on
A description of the resource
Unique identifier of the resource
metadata
Name of the resource
properties
The current state of the resource
The current sync status
Type of the resource
{
"actionType": "string",
"dependents": [
"string"
],
"description": "string",
"displayName": "string",
"formDefinition": {
"formURI": "string"
},
"id": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"valid": "boolean"
}
Resource action type
Dependent resources
Resource action description
Resource action display name
Resource action id
Resource action name
Resource action org ID
Resource action project ID
Resource action input schema
Resource action is valid for current state
Represents a resource day-two request
{
"actionId": "string",
"reason": "string"
}
The id of the action to perform.
Resource action request inputs
Reason for requesting a day2 operation
{
"id": "string",
"link": "string",
"name": "string"
}
id
link
name
{
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
}
empty
sorted
unsorted