Create a deployment template

Creates templates based on user preference. There are 2 ways to select components.

  • Selecting the whole component.
  • Advanced Options -> which helps user to select specific components to be migrated.

It takes the enviroment details from the logged in user automatically, while creating the template.

Request
header Parameters
Authorization
required
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Idempotency-Key
string <= 255 characters

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encoding
string

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Entity-Ids
string

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora-Org-Ids
string

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Track-Id
string <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Request Body schema: application/json
required

CreateTemplateRequestContent JSON object which contains the details to create a template.

description
required
string

Creates template description.

name
required
string

Name of the Template.

templateTenant
required
string

ID of the template tenant.

object (SettingSourceComponentResponse)

Provides details about the different components that need to be compared and deployed.

customFields
boolean

Selected custom fields component or not.

customObjects
boolean

Selected custom objects component or not.

notifications
boolean

Selected Notification component or not.

Array of objects (ConfigurationTemplateContent)

ConfigurationTemplateContent object contains the selected meta data information.

settings
boolean

Selected Settings component or not.

workflows
boolean

Selected Workflow component or not.

Responses
200

Successfully created the template.

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.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/deployment-manager/deployment_templates
Request samples
application/json
{
  • "content": {
    },
  • "customFields": true,
  • "customObjects": true,
  • "description": "string",
  • "name": "string",
  • "notifications": true,
  • "selectedComponents": [
    ],
  • "settings": true,
  • "templateTenant": "80b3f8cd-5801-4ed7-bee7-ad1569916c2f",
  • "workflows": true
}
Response samples
application/json
{
  • "active": true,
  • "content": null,
  • "createdBy": "Daco user",
  • "createdOn": "2022-09-14T16:06:43.155Z",
  • "description": "",
  • "entityName": "Global",
  • "environment": "US-API-Sandbox-Staging",
  • "errors": "-",
  • "id": "210656b3-0d89-4bc6-92b9-634653e729af",
  • "name": "Test_Template",
  • "status": "Inprogress",
  • "tenantName": "Data Connect"
}