ContentSets

Backflow Compatibility between source and target environments

Returns the compatibility between source and target environments

post/api/program/{programId}/contentFlow/checkCompatibility

Request

  • Base URL: https://cloudmanager.adobe.io
  • URL: https://cloudmanager.adobe.io/api/program/{programId}/contentFlow/checkCompatibility
  • Auth: none declared. Required headers: x-gw-ims-org-id, Authorization, x-api-key, Content-Type

Path parameters

programIdstring required

Identifier of the program

Headers

x-gw-ims-org-idstring required

IMS organization ID that the request is being made under.

Authorizationstring required

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-keystring required

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Typestring required

Must always be application/json

Request body

sourceEnvironmentIdstring required
destinationEnvironmentIdstring required
tier'PUBLISH' | 'AUTHOR'

Response

Big Bear Topology Compatibility Response

sourceEnvironmentIdstring

The source environment ID

sourceTopologyIdstring

The source topology ID

destinationEnvironmentIdstring

The destination environment ID

destinationTopologyIdstring

The destination topology ID

tierstring

tier

overallResultstring

The overall result of the compatibility check

overallMessagestring

The overall response message of the compatibility check

failedValidation'SOURCE_DISK_ORG' | 'TARGET_DISK_ORG' | 'SOURCE_REPO_TYPE' | 'TARGET_REPO_TYPE' | 'DATASTORE_TYPE' | 'BLOCK_TYPE' | 'TARGET_ENV' | 'REGION_CRITERIA' | 'CONNECTION_ERROR' | 'UNSUPPORTED_SKYLINE_ENV' | 'BAD_REQUEST' | 'ENVIRONMENT_NOT_FOUND' | 'PROGRAM_NOT_FOUND' | 'TIER_NOT_ALLOWED' | 'UNKNOWN'

Error Code for the Failed Compatibility Check

responseStatusCodeinteger

Example response

{
  "sourceEnvironmentId": "1234",
  "sourceTopologyId": "1a2b3cd4",
  "destinationEnvironmentId": "5678",
  "destinationTopologyId": "1a2b3cd4",
  "tier": "author",
  "overallResult": "PASS",
  "overallMessage": "Destination Topology cannot be prod.",
  "failedValidation": "TIER_NOT_ALLOWED"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.