VMware Cloud Assembly Blueprint API Data Structures
Blueprint
JSON Example
{
"content": "string",
"contentSourceId": "string",
"contentSourcePath": "string",
"contentSourceSyncAt": "string",
"contentSourceSyncMessages": [
"string"
],
"contentSourceSyncStatus": "string",
"contentSourceType": "string",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"id": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"projectName": "string",
"requestScopeOrg": "boolean",
"selfLink": "string",
"status": "string",
"totalReleasedVersions": "integer",
"totalVersions": "integer",
"updatedAt": "string",
"updatedBy": "string",
"valid": "boolean",
"validationMessages": [
{
"message": "string",
"path": "string",
"resourceName": "string",
"type": "string"
}
]
}string
content
Optional
Blueprint YAML content
string
contentSourceId
Optional
Content source id
string
contentSourcePath
Optional
Content source path
string As date-time As date-time
contentSourceSyncAt
Optional
Content source last sync time
array of string
contentSourceSyncMessages
Optional
Content source last sync messages
string
contentSourceSyncStatus
Optional
Content source last sync status
string
contentSourceType
Optional
Content source type
string As date-time As date-time
createdAt
Optional
Created time
string
createdBy
Optional
Created by
string
description
Optional
Blueprint description
string
id
Optional
Object ID
string
name
Optional
Blueprint name
string
orgId
Optional
Org ID
string
projectId
Optional
Project ID
string
projectName
Optional
Project Name
boolean
requestScopeOrg
Optional
Flag to indicate blueprint can be requested from any project in org
string
selfLink
Optional
Blueprint self link
string
status
Optional
Blueprint status
integer As int32 As int32
totalReleasedVersions
Optional
Total released versions
integer As int32 As int32
totalVersions
Optional
Total versions
string As date-time As date-time
updatedAt
Optional
Updated time
string
updatedBy
Optional
Updated by
boolean
valid
Optional
Validation result on update
BlueprintAbout
JSON Example
{
"latestApiVersion": "string",
"supportedApis": [
{
"apiVersion": "string"
}
]
}string
latestApiVersion
Optional
Latest API Version
BlueprintPlan
JSON Example
{
"tasks": [
{
"dependsOnTasks": [
"string"
],
"name": "string",
"resourceName": "string",
"resourceReason": "string",
"resourceType": "string"
}
]
}object
inputProperties
Optional
Blueprint plan input properties
object
outputProperties
Optional
Blueprint plan output properties
BlueprintPlanResource
JSON Example
{
"dependsOnResources": [
"string"
],
"resourceName": "string",
"resourceReason": "string",
"resourceType": "string",
"taskNames": [
"string"
]
}array of string
dependsOnResources
Optional
Resource depends on other resources in the plan
object
newProperties
Optional
Resource new properties
object
oldProperties
Optional
Resource old properties
string
resourceName
Optional
Resource name
string
resourceReason
Optional
Resource reason
string
resourceType
Optional
Resource type
array of string
taskNames
Optional
List of task names
BlueprintPlanTask
JSON Example
{
"dependsOnTasks": [
"string"
],
"name": "string",
"resourceName": "string",
"resourceReason": "string",
"resourceType": "string"
}array of string
dependsOnTasks
Optional
Tasks depends on other tasks
object
inputProperties
Optional
Task input properties
string
name
Optional
Task name
string
resourceName
Optional
Resource name
string
resourceReason
Optional
Resource reason
string
resourceType
Optional
Resource type
BlueprintRequest
JSON Example
{
"blueprintId": "string",
"blueprintVersion": "string",
"cancelRequestedAt": "string",
"cancelRequestedBy": "string",
"content": "string",
"createdAt": "string",
"createdBy": "string",
"deploymentId": "string",
"deploymentName": "string",
"description": "string",
"destroy": "boolean",
"failureMessage": "string",
"flowExecutionId": "string",
"flowId": "string",
"id": "string",
"ignoreDeleteFailures": "boolean",
"orgId": "string",
"plan": "boolean",
"projectId": "string",
"projectName": "string",
"reason": "string",
"requestTrackerId": "string",
"simulate": "boolean",
"status": "string",
"updatedAt": "string",
"updatedBy": "string",
"validationMessages": [
{
"message": "string",
"path": "string",
"resourceName": "string",
"type": "string"
}
]
}string As uuid As uuid
blueprintId
Optional
Blueprint Id
string
blueprintVersion
Optional
Blueprint version
string As date-time As date-time
cancelRequestedAt
Optional
Cancel request time
string
cancelRequestedBy
Optional
Cancel requested by
string
content
Optional
Blueprint YAML content
string As date-time As date-time
createdAt
Optional
Created time
string
createdBy
Optional
Created by
string
deploymentId
Optional
Existing deployment Id
string
deploymentName
Optional
Name for the new deployment
string
description
Optional
Description for the new request
boolean
destroy
Optional
Destroy existing deployment
string
failureMessage
Optional
Failure message
string
flowExecutionId
Optional
Flow execution Id
string
flowId
Optional
Flow Id
string
id
Optional
Object ID
boolean
ignoreDeleteFailures
Optional
Ignore delete failures in blueprint request
object
inputs
Optional
Blueprint request inputs
string
orgId
Optional
Org ID
boolean
plan
Optional
Plan only without affecting existing deployment
string
projectId
Optional
Project ID
string
projectName
Optional
Project Name
string
reason
Optional
Reason for requesting a blueprint
string
requestTrackerId
Optional
Request tracker Id
boolean
simulate
Optional
Simulate blueprint request with providers
string
status
Optional
Status
string As date-time As date-time
updatedAt
Optional
Updated time
string
updatedBy
Optional
Updated by
Property Of
Parameter To
BlueprintResourcesPlan
JSON Example
{
"resources": [
{
"dependsOnResources": [
"string"
],
"resourceName": "string",
"resourceReason": "string",
"resourceType": "string",
"taskNames": [
"string"
]
}
]
}
BlueprintTaskExecution
JSON Example
{
"dependsOnTasks": [
"string"
],
"failureMessage": "string",
"resourceName": "string",
"resourceType": "string",
"status": "string",
"taskName": "string"
}array of string
dependsOnTasks
Optional
Tasks depends on other tasks
string
failureMessage
Optional
Task failure message
object
inputProperties
Optional
Task input properties
object
outputProperties
Optional
Task output properties
string
resourceName
Optional
Resource name
string
resourceType
Optional
Resource type
string
status
Optional
Task status
string
taskName
Optional
Task name
BlueprintValidationMessage
JSON Example
{
"message": "string",
"path": "string",
"resourceName": "string",
"type": "string"
}string
message
Optional
Validation message
object
metadata
Optional
Metadata
string
path
Optional
Validation path
string
resourceName
Optional
Resource name
string
type
Optional
Message type
BlueprintValidationRequest
JSON Example
{
"blueprintId": "string",
"content": "string",
"projectId": "string"
}string As uuid As uuid
blueprintId
Optional
Blueprint Id
string
content
Optional
Blueprint YAML content
object
inputs
Optional
Blueprint request inputs
string
projectId
Optional
Project Id
BlueprintValidationResponse
JSON Example
{
"valid": "boolean",
"validationMessages": [
{
"message": "string",
"path": "string",
"resourceName": "string",
"type": "string"
}
]
}boolean
valid
Optional
Is blueprint valid
BlueprintVersion
JSON Example
{
"blueprintId": "string",
"content": "string",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"id": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"projectName": "string",
"selfLink": "string",
"status": "string",
"updatedAt": "string",
"updatedBy": "string",
"valid": "boolean",
"version": "string",
"versionChangeLog": "string",
"versionDescription": "string"
}string
blueprintId
Optional
Draft blueprint ID
string
content
Optional
Blueprint YAML content
string As date-time As date-time
createdAt
Optional
Created time
string
createdBy
Optional
Created by
string
description
Optional
Draft blueprint description
string
id
Optional
Object ID
string
name
Optional
Blueprint name
string
orgId
Optional
Org ID
string
projectId
Optional
Project ID
string
projectName
Optional
Project Name
string
selfLink
Optional
Blueprint version self link
string
status
Optional
Blueprint status
string As date-time As date-time
updatedAt
Optional
Updated time
string
updatedBy
Optional
Updated by
boolean
valid
Optional
Validation result
string
version
Optional
Blueprint version
string
versionChangeLog
Optional
Blueprint version change log
string
versionDescription
Optional
Blueprint version description
BlueprintVersionRequest
JSON Example
{
"changeLog": "string",
"description": "string",
"release": "boolean",
"version": "string"
}string
changeLog
Optional
Blueprint version change log
string
description
Optional
Blueprint version description
boolean
release
Optional
Flag indicating to release version
string
version
Required
Blueprint version
DeploymentResource
JSON Example
{
"dependsOn": [
"string"
],
"id": "string",
"name": "string",
"state": "string",
"type": "string"
}array of string
dependsOn
Optional
Resource dependency on other resources
string
id
Optional
Resource ID
object
metadata
Optional
Resource metadata
string
name
Optional
Resource name
object
properties
Optional
Resource properties
string
state
Optional
Resource state
string
type
Optional
Resource type
PageOfBlueprint
JSON Example
{
"content": [
{
"content": "string",
"contentSourceId": "string",
"contentSourcePath": "string",
"contentSourceSyncAt": "string",
"contentSourceSyncMessages": [
"string"
],
"contentSourceSyncStatus": "string",
"contentSourceType": "string",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"id": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"projectName": "string",
"requestScopeOrg": "boolean",
"selfLink": "string",
"status": "string",
"totalReleasedVersions": "integer",
"totalVersions": "integer",
"updatedAt": "string",
"updatedBy": "string",
"valid": "boolean",
"validationMessages": [
{
"message": "string",
"path": "string",
"resourceName": "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"
}boolean
empty
Optional
empty
boolean
first
Optional
first
boolean
last
Optional
last
integer As int32 As int32
number
Optional
number
integer As int32 As int32
numberOfElements
Optional
numberOfElements
integer As int32 As int32
size
Optional
size
integer As int64 As int64
totalElements
Optional
totalElements
integer As int32 As int32
totalPages
Optional
totalPages
PageOfBlueprintRequest
JSON Example
{
"content": [
{
"blueprintId": "string",
"blueprintVersion": "string",
"cancelRequestedAt": "string",
"cancelRequestedBy": "string",
"content": "string",
"createdAt": "string",
"createdBy": "string",
"deploymentId": "string",
"deploymentName": "string",
"description": "string",
"destroy": "boolean",
"failureMessage": "string",
"flowExecutionId": "string",
"flowId": "string",
"id": "string",
"ignoreDeleteFailures": "boolean",
"orgId": "string",
"plan": "boolean",
"projectId": "string",
"projectName": "string",
"reason": "string",
"requestTrackerId": "string",
"simulate": "boolean",
"status": "string",
"updatedAt": "string",
"updatedBy": "string",
"validationMessages": [
{
"message": "string",
"path": "string",
"resourceName": "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"
}boolean
empty
Optional
empty
boolean
first
Optional
first
boolean
last
Optional
last
integer As int32 As int32
number
Optional
number
integer As int32 As int32
numberOfElements
Optional
numberOfElements
integer As int32 As int32
size
Optional
size
integer As int64 As int64
totalElements
Optional
totalElements
integer As int32 As int32
totalPages
Optional
totalPages
PageOfBlueprintVersion
JSON Example
{
"content": [
{
"blueprintId": "string",
"content": "string",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"id": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"projectName": "string",
"selfLink": "string",
"status": "string",
"updatedAt": "string",
"updatedBy": "string",
"valid": "boolean",
"version": "string",
"versionChangeLog": "string",
"versionDescription": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}boolean
empty
Optional
empty
boolean
first
Optional
first
boolean
last
Optional
last
integer As int32 As int32
number
Optional
number
integer As int32 As int32
numberOfElements
Optional
numberOfElements
integer As int32 As int32
size
Optional
size
integer As int64 As int64
totalElements
Optional
totalElements
integer As int32 As int32
totalPages
Optional
totalPages
PageOfResourceType
JSON Example
{
"content": [
{
"createdAt": "string",
"createdBy": "string",
"description": "string",
"displayName": "string",
"id": "string",
"name": "string",
"orgId": "string",
"providerId": "string",
"providerName": "string",
"providerVersion": "string",
"schema": {
"allOf": [
"PropertyDefinition Object"
],
"computed": "boolean",
"description": "string",
"encrypted": "boolean",
"enum": [
{}
],
"ignoreCaseOnDiff": "boolean",
"ignoreOnUpdate": "boolean",
"items": "PropertyDefinition Object",
"maxLength": "integer",
"maximum": "integer",
"minItems": "integer",
"minLength": "integer",
"minimum": "integer",
"notAllowed": [
"string"
],
"oneOf": [
"PropertyDefinition Object"
],
"pattern": "string",
"readOnly": "boolean",
"recreateOnUpdate": "boolean",
"required": [
"string"
],
"title": "string",
"type": "string",
"uniqueItems": "boolean",
"writeOnly": "boolean"
},
"updatedAt": "string",
"updatedBy": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"totalElements": "integer",
"totalPages": "integer"
}boolean
empty
Optional
empty
boolean
first
Optional
first
boolean
last
Optional
last
integer As int32 As int32
number
Optional
number
integer As int32 As int32
numberOfElements
Optional
numberOfElements
integer As int32 As int32
size
Optional
size
integer As int64 As int64
totalElements
Optional
totalElements
integer As int32 As int32
totalPages
Optional
totalPages
PropertyDefinition
JSON Example
{
"allOf": [
"PropertyDefinition Object"
],
"computed": "boolean",
"description": "string",
"encrypted": "boolean",
"enum": [
{}
],
"ignoreCaseOnDiff": "boolean",
"ignoreOnUpdate": "boolean",
"items": "PropertyDefinition Object",
"maxLength": "integer",
"maximum": "integer",
"minItems": "integer",
"minLength": "integer",
"minimum": "integer",
"notAllowed": [
"string"
],
"oneOf": [
"PropertyDefinition Object"
],
"pattern": "string",
"readOnly": "boolean",
"recreateOnUpdate": "boolean",
"required": [
"string"
],
"title": "string",
"type": "string",
"uniqueItems": "boolean",
"writeOnly": "boolean"
}boolean
computed
Optional
computed
object
const
Optional
const
object
default
Optional
default
object
dependencies
Optional
dependencies
string
description
Optional
description
boolean
encrypted
Optional
encrypted
array of object
enum
Optional
enum
boolean
ignoreCaseOnDiff
Optional
ignoreCaseOnDiff
boolean
ignoreOnUpdate
Optional
ignoreOnUpdate
integer As int32 As int32
maxLength
Optional
maxLength
integer As int64 As int64
maximum
Optional
maximum
integer As int64 As int64
minItems
Optional
minItems
integer As int32 As int32
minLength
Optional
minLength
integer As int64 As int64
minimum
Optional
minimum
array of string
notAllowed
Optional
notAllowed
string
pattern
Optional
pattern
object
properties
Optional
properties
boolean
readOnly
Optional
readOnly
boolean
recreateOnUpdate
Optional
recreateOnUpdate
array of string
required
Optional
required
string
title
Optional
title
string
type
Optional
type
boolean
uniqueItems
Optional
uniqueItems
boolean
writeOnly
Optional
writeOnly
ResourceType
JSON Example
{
"createdAt": "string",
"createdBy": "string",
"description": "string",
"displayName": "string",
"id": "string",
"name": "string",
"orgId": "string",
"providerId": "string",
"providerName": "string",
"providerVersion": "string",
"schema": {
"allOf": [
"PropertyDefinition Object"
],
"computed": "boolean",
"description": "string",
"encrypted": "boolean",
"enum": [
{}
],
"ignoreCaseOnDiff": "boolean",
"ignoreOnUpdate": "boolean",
"items": "PropertyDefinition Object",
"maxLength": "integer",
"maximum": "integer",
"minItems": "integer",
"minLength": "integer",
"minimum": "integer",
"notAllowed": [
"string"
],
"oneOf": [
"PropertyDefinition Object"
],
"pattern": "string",
"readOnly": "boolean",
"recreateOnUpdate": "boolean",
"required": [
"string"
],
"title": "string",
"type": "string",
"uniqueItems": "boolean",
"writeOnly": "boolean"
},
"updatedAt": "string",
"updatedBy": "string"
}string As date-time As date-time
createdAt
Optional
Created time
string
createdBy
Optional
Created by
string
description
Optional
Resource type description
string
displayName
Optional
Resource type display name
string
id
Optional
Object ID
string
name
Optional
Resource type name
object
operations
Optional
Provider resource operations
string
orgId
Optional
Org ID
string
providerId
Optional
Provider Id
string
providerName
Optional
Provider name
string
providerVersion
Optional
Provider version
string As date-time As date-time
updatedAt
Optional
Updated time
string
updatedBy
Optional
Updated by
Sort
JSON Example
{
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
}boolean
empty
Optional
empty
boolean
sorted
Optional
sorted
boolean
unsorted
Optional
unsorted
SupportedApi
JSON Example
{
"apiVersion": "string"
}string
apiVersion
Optional
apiVersion
Node: apidepo-liferay-dxp-v1-be-w-1:8080: