Relocation API Data Structures
{
"documentCountAdded": "integer",
"documentCountDeleted": "integer",
"documentCountUpdated": "integer"
}
documentCountAdded
documentCountDeleted
documentCountUpdated
{
"planLink": "string",
"deploymentLink": "string",
"name": "string",
"description": "string",
"resources": [
{
"link": "string",
"name": "string",
"tagLinks": [
"string"
],
"ruleLinks": [
"string"
]
}
],
"createBlueprint": "boolean",
"documentSelfLink": "string"
}
Link to a plan. Clients need not set this field, as it is automatically taken care of by the DeploymentBulkCreatorService
Link to an existing deployment. Only set this field when adding resources to an existing deployment.
Desired deployment name. If omitted, a name will be automatically generated
Deployment description
createBlueprint
documentSelfLink
{
"link": "string",
"name": "string",
"tagLinks": [
"string"
],
"ruleLinks": [
"string"
]
}
link
name
tagLinks
ruleLinks
{
"deploymentLink": "string",
"executionId": "string",
"failureMessage": "string",
"taskInfo": {
"durationMicros": "integer",
"failure": {
"details": [
"string"
],
"message": "string",
"messageId": "string",
"stackTrace": [
"string"
],
"statusCode": "integer"
},
"isDirect": "boolean",
"stage": "string"
},
"tenantLink": "string",
"documentSelfLink": "string"
}
deploymentLink
executionId
failureMessage
Link to a tenant
documentSelfLink
{
"autoGenerate": "boolean",
"deploymentLink": "string",
"name": "string",
"planLink": "string",
"templateLink": "string",
"tenantLink": "string",
"documentSelfLink": "string"
}
Automatically generate a Tango blueprint if set.
Link to onboarding deployment.
Name of the auto-generated Tango blueprint.
Link to the parent onboarding plan.
Link to existing Tango blueprint.
Link to a tenant
documentSelfLink
{
"name": "string",
"description": "string",
"tag": "string",
"consumerDeploymentLink": "string",
"planLink": "string",
"tenantLink": "string",
"documentSelfLink": "string"
}
name
description
tag
consumerDeploymentLink
planLink
Link to a tenant
documentSelfLink
{
"description": "string",
"endpointId": "string",
"endpointName": "string",
"name": "string",
"projectId": "string",
"projectName": "string",
"deploymentTagName": "string",
"deploymentTagType": "string",
"tenantLink": "string",
"lastRunTimeMicros": "number",
"documentSelfLink": "string"
}
description
endpointId
endpointName
name
projectId
projectName
deploymentTagName
deploymentTagType
Link to a tenant
lastRunTimeMicros
documentSelfLink
{
"deploymentLink": "string",
"planLink": "string",
"resourceLink": "string",
"resourceName": "string",
"ruleLinks": [
"string"
],
"tagLinks": [
"string"
],
"tenantLink": "string",
"documentSelfLink": "string"
}
deploymentLink
planLink
resourceLink
resourceName
ruleLinks
tagLinks
Link to a tenant
documentSelfLink
{
"disabled": "boolean",
"filters": [
{
"field": "string",
"values": [
"string"
]
}
],
"status": "string",
"name": "string",
"planLink": "string",
"tenantLink": "string",
"documentSelfLink": "string"
}
Rule disabled or not. False by default
Rule status.
Rule name.
Link to the parent onboarding plan.
Link to a tenant
documentSelfLink
{
"failureMessage": "string",
"planLink": "string",
"taskInfo": {
"durationMicros": "integer",
"failure": {
"details": [
"string"
],
"message": "string",
"messageId": "string",
"stackTrace": [
"string"
],
"statusCode": "integer"
},
"isDirect": "boolean",
"stage": "string"
},
"tenantLink": "string",
"documentSelfLink": "string"
}
failureMessage
planLink
Link to a tenant
documentSelfLink
{
"field": "string",
"values": [
"string"
]
}
field
values
{
"continuousResults": {
"documentCountAdded": "integer",
"documentCountDeleted": "integer",
"documentCountUpdated": "integer"
},
"documentCount": "integer",
"documentLinks": [
"string"
],
"nextPageLink": "string",
"prevPageLink": "string",
"queryTimeMicros": "integer",
"selectedLinks": [
"string"
]
}
documentCount
documentLinks
documents
nextPageLink
nextPageLinksPerGroup
prevPageLink
queryTimeMicros
selectedDocuments
selectedLinks
selectedLinksPerDocument
{
"details": [
"string"
],
"message": "string",
"messageId": "string",
"stackTrace": [
"string"
],
"statusCode": "integer"
}
details
message
messageId
stackTrace
statusCode
{
"durationMicros": "integer",
"failure": {
"details": [
"string"
],
"message": "string",
"messageId": "string",
"stackTrace": [
"string"
],
"statusCode": "integer"
},
"isDirect": "boolean",
"stage": "string"
}
durationMicros
isDirect
stage