Relocation API Data Structures
ContinuousResult
JSON Example
{
"documentCountAdded": "integer",
"documentCountDeleted": "integer",
"documentCountUpdated": "integer"
}integer As int64 As int64
documentCountAdded
Optional
documentCountAdded
integer As int64 As int64
documentCountDeleted
Optional
documentCountDeleted
integer As int64 As int64
documentCountUpdated
Optional
documentCountUpdated
CreateDeploymentRequest
JSON Example
{
"planLink": "string",
"deploymentLink": "string",
"name": "string",
"description": "string",
"resources": [
{
"link": "string",
"name": "string",
"tagLinks": [
"string"
],
"ruleLinks": [
"string"
]
}
],
"createBlueprint": "boolean",
"documentSelfLink": "string"
}string
planLink
Optional
Link to a plan. Clients need not set this field, as it is automatically taken care of by the DeploymentBulkCreatorService
string
deploymentLink
Optional
Link to an existing deployment. Only set this field when adding resources to an existing deployment.
string
name
Optional
Desired deployment name. If omitted, a name will be automatically generated
string
description
Optional
Deployment description
boolean
createBlueprint
Optional
createBlueprint
string
documentSelfLink
Optional
documentSelfLink
CreateResourceRequest
JSON Example
{
"link": "string",
"name": "string",
"tagLinks": [
"string"
],
"ruleLinks": [
"string"
]
}string
link
Optional
link
string
name
Optional
name
array of string
tagLinks
Optional
tagLinks
array of string
ruleLinks
Optional
ruleLinks
DeploymentExecutionState
JSON Example
{
"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"
}string
deploymentLink
Optional
deploymentLink
string
executionId
Optional
executionId
string
failureMessage
Optional
failureMessage
string
tenantLink
Optional
Link to a tenant
string
documentSelfLink
Optional
documentSelfLink
OnboardingBlueprintState
JSON Example
{
"autoGenerate": "boolean",
"deploymentLink": "string",
"name": "string",
"planLink": "string",
"templateLink": "string",
"tenantLink": "string",
"documentSelfLink": "string"
}boolean
autoGenerate
Optional
Automatically generate a Tango blueprint if set.
string
deploymentLink
Optional
Link to onboarding deployment.
string
name
Optional
Name of the auto-generated Tango blueprint.
string
planLink
Optional
Link to the parent onboarding plan.
string
templateLink
Optional
Link to existing Tango blueprint.
string
tenantLink
Optional
Link to a tenant
string
documentSelfLink
Optional
documentSelfLink
OnboardingDeploymentState
JSON Example
{
"name": "string",
"description": "string",
"tag": "string",
"consumerDeploymentLink": "string",
"planLink": "string",
"tenantLink": "string",
"documentSelfLink": "string"
}string
name
Optional
name
string
description
Optional
description
string
tag
Optional
tag
string
consumerDeploymentLink
Optional
consumerDeploymentLink
string
planLink
Optional
planLink
string
tenantLink
Optional
Link to a tenant
string
documentSelfLink
Optional
documentSelfLink
OnboardingPlanState
JSON Example
{
"description": "string",
"endpointId": "string",
"endpointName": "string",
"name": "string",
"projectId": "string",
"projectName": "string",
"deploymentTagName": "string",
"deploymentTagType": "string",
"tenantLink": "string",
"lastRunTimeMicros": "number",
"documentSelfLink": "string"
}string
description
Optional
description
string
endpointId
Optional
endpointId
string
endpointName
Optional
endpointName
string
name
Optional
name
string
projectId
Optional
projectId
string
projectName
Optional
projectName
string
deploymentTagName
Optional
deploymentTagName
string
deploymentTagType
Optional
deploymentTagType
string
tenantLink
Optional
Link to a tenant
number
lastRunTimeMicros
Optional
lastRunTimeMicros
string
documentSelfLink
Optional
documentSelfLink
Parameter To
OnboardingResourceState
JSON Example
{
"deploymentLink": "string",
"planLink": "string",
"resourceLink": "string",
"resourceName": "string",
"ruleLinks": [
"string"
],
"tagLinks": [
"string"
],
"tenantLink": "string",
"documentSelfLink": "string"
}string
deploymentLink
Optional
deploymentLink
string
planLink
Optional
planLink
string
resourceLink
Optional
resourceLink
string
resourceName
Optional
resourceName
array of string
ruleLinks
Optional
ruleLinks
array of string
tagLinks
Optional
tagLinks
string
tenantLink
Optional
Link to a tenant
string
documentSelfLink
Optional
documentSelfLink
OnboardingRuleState
JSON Example
{
"disabled": "boolean",
"filters": [
{
"field": "string",
"values": [
"string"
]
}
],
"status": "string",
"name": "string",
"planLink": "string",
"tenantLink": "string",
"documentSelfLink": "string"
}boolean
disabled
Optional
Rule disabled or not. False by default
string
status
Optional
Rule status.
string
name
Optional
Rule name.
string
planLink
Optional
Link to the parent onboarding plan.
string
tenantLink
Optional
Link to a tenant
string
documentSelfLink
Optional
documentSelfLink
Parameter To
PlanExecutionState
JSON Example
{
"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"
}string
failureMessage
Optional
failureMessage
string
planLink
Optional
planLink
string
tenantLink
Optional
Link to a tenant
string
documentSelfLink
Optional
documentSelfLink
ResourceFieldFilter
JSON Example
{
"field": "string",
"values": [
"string"
]
}string
field
Optional
field
array of string
values
Optional
values
ServiceDocumentQueryResult
JSON Example
{
"continuousResults": {
"documentCountAdded": "integer",
"documentCountDeleted": "integer",
"documentCountUpdated": "integer"
},
"documentCount": "integer",
"documentLinks": [
"string"
],
"nextPageLink": "string",
"prevPageLink": "string",
"queryTimeMicros": "integer",
"selectedLinks": [
"string"
]
}integer As int64 As int64
documentCount
Optional
documentCount
array of string
documentLinks
Optional
documentLinks
object
documents
Optional
documents
string
nextPageLink
Optional
nextPageLink
object
nextPageLinksPerGroup
Optional
nextPageLinksPerGroup
string
prevPageLink
Optional
prevPageLink
integer As int64 As int64
queryTimeMicros
Optional
queryTimeMicros
object
selectedDocuments
Optional
selectedDocuments
array of string
selectedLinks
Optional
selectedLinks
object
selectedLinksPerDocument
Optional
selectedLinksPerDocument
ServiceErrorResponse
JSON Example
{
"details": [
"string"
],
"message": "string",
"messageId": "string",
"stackTrace": [
"string"
],
"statusCode": "integer"
}array of string
details
Optional
details
string
message
Optional
message
string
messageId
Optional
messageId
array of string
stackTrace
Optional
stackTrace
integer As int64 As int64
statusCode
Optional
statusCode
Property Of
Returned By
TaskState
JSON Example
{
"durationMicros": "integer",
"failure": {
"details": [
"string"
],
"message": "string",
"messageId": "string",
"stackTrace": [
"string"
],
"statusCode": "integer"
},
"isDirect": "boolean",
"stage": "string"
}integer As int64 As int64
durationMicros
Optional
durationMicros
boolean
isDirect
Optional
isDirect
string
stage
Optional
stage
Node: apidepo-liferay-dxp-v1-be-w-0:8080: