---
title: "Compare settings between a source tenant and a target tenant"
method: POST
path: "/deployment-manager/deployment_artifacts/compare"
tags: ["Configuration Templates"]
---

# Compare settings between a source tenant and a target tenant

`POST /deployment-manager/deployment_artifacts/compare`

To Compare the configurations from the template downloaded and used in deployment manager for migration which is available in source and target tenant.

## Query parameters

- `tenant` string, required

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Track-Id` string

## Response `200`

OK

- CompareSchemaInfoResponse — When Tenant's Compare API returns a result, this object is used to send the response to UI.
  - `customFields` CompareSchemaKeyValue[]
    - `difference` object — Returns the different components list.
    - `response` MigrationComponentContent[] — Provides the total reponse of the components.
      - `attribute` string
      - `componentType` string — Type of selected components to be migrated.
      - `currentTargetResponse` JsonNode, nullable — Json node object contains metadata.
      - `description` string
      - `disabled` string
      - `errorMessage` string — Error information.
      - `httpMethods` string
      - `id` string
      - `key` string
      - `migratedOn` string, date-time — It is the time when migration is triggered.
      - `migrationId` string — Migration ID. It is generated at the time of triggering deployment.
      - `pathPattern` string — PathPattern of component.
      - `previousTargetResponse` JsonNode, nullable — Json node object contains metadata.
      - `result` string — Returns the result details of Components.
      - `segregationKey` string — Displays the differences between components.
      - `sourceResponse` JsonNode, nullable — Json node object contains metadata.
      - `status` string — Returns the status of each component.
      - `updateStatus` string — Updated Status.
    - `segregationKeys` string[] — Provides separation of components.
  - `customObjects` CompareSchemaKeyValue[]
    - `difference` object — Returns the different components list.
    - `response` MigrationComponentContent[] — Provides the total reponse of the components.
      - `attribute` string
      - `componentType` string — Type of selected components to be migrated.
      - `currentTargetResponse` JsonNode, nullable — Json node object contains metadata.
      - `description` string
      - `disabled` string
      - `errorMessage` string — Error information.
      - `httpMethods` string
      - `id` string
      - `key` string
      - `migratedOn` string, date-time — It is the time when migration is triggered.
      - `migrationId` string — Migration ID. It is generated at the time of triggering deployment.
      - `pathPattern` string — PathPattern of component.
      - `previousTargetResponse` JsonNode, nullable — Json node object contains metadata.
      - `result` string — Returns the result details of Components.
      - `segregationKey` string — Displays the differences between components.
      - `sourceResponse` JsonNode, nullable — Json node object contains metadata.
      - `status` string — Returns the status of each component.
      - `updateStatus` string — Updated Status.
    - `segregationKeys` string[] — Provides separation of components.
  - `dataAccessControl` CompareSchemaKeyValue[]
    - `difference` object — Returns the different components list.
    - `response` MigrationComponentContent[] — Provides the total reponse of the components.
      - `attribute` string
      - `componentType` string — Type of selected components to be migrated.
      - `currentTargetResponse` JsonNode, nullable — Json node object contains metadata.
      - `description` string
      - `disabled` string
      - `errorMessage` string — Error information.
      - `httpMethods` string
      - `id` string
      - `key` string
      - `migratedOn` string, date-time — It is the time when migration is triggered.
      - `migrationId` string — Migration ID. It is generated at the time of triggering deployment.
      - `pathPattern` string — PathPattern of component.
      - `previousTargetResponse` JsonNode, nullable — Json node object contains metadata.
      - `result` string — Returns the result details of Components.
      - `segregationKey` string — Displays the differences between components.
      - `sourceResponse` JsonNode, nullable — Json node object contains metadata.
      - `status` string — Returns the status of each component.
      - `updateStatus` string — Updated Status.
    - `segregationKeys` string[] — Provides separation of components.
  - `metaData` JsonNode, nullable — Json node object contains metadata.
  - `notifications` CompareSchemaKeyValue[]
    - `difference` object — Returns the different components list.
    - `response` MigrationComponentContent[] — Provides the total reponse of the components.
      - `attribute` string
      - `componentType` string — Type of selected components to be migrated.
      - `currentTargetResponse` JsonNode, nullable — Json node object contains metadata.
      - `description` string
      - `disabled` string
      - `errorMessage` string — Error information.
      - `httpMethods` string
      - `id` string
      - `key` string
      - `migratedOn` string, date-time — It is the time when migration is triggered.
      - `migrationId` string — Migration ID. It is generated at the time of triggering deployment.
      - `pathPattern` string — PathPattern of component.
      - `previousTargetResponse` JsonNode, nullable — Json node object contains metadata.
      - `result` string — Returns the result details of Components.
      - `segregationKey` string — Displays the differences between components.
      - `sourceResponse` JsonNode, nullable — Json node object contains metadata.
      - `status` string — Returns the status of each component.
      - `updateStatus` string — Updated Status.
    - `segregationKeys` string[] — Provides separation of components.
  - `productCatalog` CompareSchemaKeyValue[]
    - `difference` object — Returns the different components list.
    - `response` MigrationComponentContent[] — Provides the total reponse of the components.
      - `attribute` string
      - `componentType` string — Type of selected components to be migrated.
      - `currentTargetResponse` JsonNode, nullable — Json node object contains metadata.
      - `description` string
      - `disabled` string
      - `errorMessage` string — Error information.
      - `httpMethods` string
      - `id` string
      - `key` string
      - `migratedOn` string, date-time — It is the time when migration is triggered.
      - `migrationId` string — Migration ID. It is generated at the time of triggering deployment.
      - `pathPattern` string — PathPattern of component.
      - `previousTargetResponse` JsonNode, nullable — Json node object contains metadata.
      - `result` string — Returns the result details of Components.
      - `segregationKey` string — Displays the differences between components.
      - `sourceResponse` JsonNode, nullable — Json node object contains metadata.
      - `status` string — Returns the status of each component.
      - `updateStatus` string — Updated Status.
    - `segregationKeys` string[] — Provides separation of components.
  - `settings` CompareSchemaKeyValue[]
    - `difference` object — Returns the different components list.
    - `response` MigrationComponentContent[] — Provides the total reponse of the components.
      - `attribute` string
      - `componentType` string — Type of selected components to be migrated.
      - `currentTargetResponse` JsonNode, nullable — Json node object contains metadata.
      - `description` string
      - `disabled` string
      - `errorMessage` string — Error information.
      - `httpMethods` string
      - `id` string
      - `key` string
      - `migratedOn` string, date-time — It is the time when migration is triggered.
      - `migrationId` string — Migration ID. It is generated at the time of triggering deployment.
      - `pathPattern` string — PathPattern of component.
      - `previousTargetResponse` JsonNode, nullable — Json node object contains metadata.
      - `result` string — Returns the result details of Components.
      - `segregationKey` string — Displays the differences between components.
      - `sourceResponse` JsonNode, nullable — Json node object contains metadata.
      - `status` string — Returns the status of each component.
      - `updateStatus` string — Updated Status.
    - `segregationKeys` string[] — Provides separation of components.
  - `workflows` CompareSchemaKeyValue[]
    - `difference` object — Returns the different components list.
    - `response` MigrationComponentContent[] — Provides the total reponse of the components.
      - `attribute` string
      - `componentType` string — Type of selected components to be migrated.
      - `currentTargetResponse` JsonNode, nullable — Json node object contains metadata.
      - `description` string
      - `disabled` string
      - `errorMessage` string — Error information.
      - `httpMethods` string
      - `id` string
      - `key` string
      - `migratedOn` string, date-time — It is the time when migration is triggered.
      - `migrationId` string — Migration ID. It is generated at the time of triggering deployment.
      - `pathPattern` string — PathPattern of component.
      - `previousTargetResponse` JsonNode, nullable — Json node object contains metadata.
      - `result` string — Returns the result details of Components.
      - `segregationKey` string — Displays the differences between components.
      - `sourceResponse` JsonNode, nullable — Json node object contains metadata.
      - `status` string — Returns the status of each component.
      - `updateStatus` string — Updated Status.
    - `segregationKeys` string[] — Provides separation of components.

## Other responses

- `201` — created. The request has been fulfilled and resulted in a new resource being created. The newly created resource can be referenced by the URL(s) returned in the entity of the response, with the most specific URL for the resource given by a Location header field.
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)