{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference Accounting Codes Configuration Templates API",
    "version": "2023-12-15"
  },
  "items": [
    {
      "info": {
        "name": "Configuration Templates",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all templates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/deployment-manager/deployment_templates",
            "headers": [
              {
                "name": "Accept-Encoding",
                "value": ""
              },
              {
                "name": "Content-Encoding",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "Zuora-Entity-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Org-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Track-Id",
                "value": ""
              }
            ]
          },
          "docs": "Retrieves all the templates and their details which are created already.\n"
        },
        {
          "info": {
            "name": "Create a deployment template",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/deployment-manager/deployment_templates",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              },
              {
                "name": "Accept-Encoding",
                "value": ""
              },
              {
                "name": "Content-Encoding",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "Zuora-Entity-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Org-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Track-Id",
                "value": ""
              }
            ]
          },
          "docs": "Creates templates based on user preference.\nThere are 2 ways to select components.\n  - Selecting the whole component.\n  - Advanced Options -> which helps user to select specific components to be migrated.\n\nIt takes the enviroment details from the logged in user automatically, while creating the template.\n"
        },
        {
          "info": {
            "name": "List all details of a template",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/deployment-manager/deployment_templates/:id",
            "headers": [
              {
                "name": "Accept-Encoding",
                "value": ""
              },
              {
                "name": "Content-Encoding",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "Zuora-Entity-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Org-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Track-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the template that needs to be retrieved."
              }
            ]
          },
          "docs": "Returns the detailed information of a specific template by passing its template ID.\n"
        },
        {
          "info": {
            "name": "Delete a template",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/deployment-manager/deployment_templates/:id",
            "headers": [
              {
                "name": "Accept-Encoding",
                "value": ""
              },
              {
                "name": "Content-Encoding",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "Zuora-Entity-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Org-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Track-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the template that needs to be deleted."
              }
            ]
          },
          "docs": "Deletes a specific template by passing the ID.\n"
        },
        {
          "info": {
            "name": "Download a template",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/deployment-manager/deployment_artifacts",
            "headers": [
              {
                "name": "Accept-Encoding",
                "value": ""
              },
              {
                "name": "Content-Encoding",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "Zuora-Entity-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Org-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Track-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "deployment_template_id",
                "value": "",
                "type": "query",
                "description": "Id which template needs to be downloaded."
              }
            ]
          },
          "docs": "Download a template for migration in the Deployment manager from the source tenant to the target tenant.\n"
        },
        {
          "info": {
            "name": "List all details of source components",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/deployment-manager/deployment_artifacts/retrieve-settings",
            "headers": [
              {
                "name": "Accept-Encoding",
                "value": ""
              },
              {
                "name": "Content-Encoding",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "Zuora-Entity-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Org-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Track-Id",
                "value": ""
              }
            ]
          },
          "docs": "When the advanced option is clicked, get the details/metadata of the components, such as settings, notifications, workflow, etc.\n"
        },
        {
          "info": {
            "name": "Compare settings between a source tenant and a target tenant",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/deployment-manager/deployment_artifacts/compare",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              },
              {
                "name": "Accept-Encoding",
                "value": ""
              },
              {
                "name": "Content-Encoding",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "Zuora-Entity-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Org-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Track-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "tenant",
                "value": "",
                "type": "query",
                "description": "Customers need to specify tenant ID."
              }
            ]
          },
          "docs": "To Compare the configurations from the template downloaded and used in deployment manager for migration which is available in source and target tenant.\n"
        },
        {
          "info": {
            "name": "Migrate settings from source tenant to target tenant",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/deployment-manager/deployment_artifacts/deploy",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              },
              {
                "name": "Accept-Encoding",
                "value": ""
              },
              {
                "name": "Content-Encoding",
                "value": ""
              },
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "Zuora-Entity-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Org-Ids",
                "value": ""
              },
              {
                "name": "Zuora-Track-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "tenant",
                "value": "",
                "type": "query",
                "description": "Customers need to specify tenant ID in query parameter."
              }
            ]
          },
          "docs": "To migrate the selected configuration of a tenant in Deployment Manager migration while using template from the compare screen.\n"
        }
      ]
    }
  ],
  "bundled": true
}