POST /deployment-manager/deployment_templates

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.

Servers

https://rest.test.zuora.com
https://rest.sandbox.na.zuora.com
https://rest.apisandbox.zuora.com
https://rest.na.zuora.com
https://rest.zuora.com
https://rest.test.eu.zuora.com
https://rest.sandbox.eu.zuora.com
https://rest.eu.zuora.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Content-Encoding`	String	No	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-Track-Id`	String	No	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 (`'`).
`Authorization`	String	Yes	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	No	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.
`Zuora-Entity-Ids`	String	No	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	No	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.
`Accept-Encoding`	String	No	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.

Request body fields

Name	Type	Required	Description
`customObjects`	Boolean	No	Selected custom objects component or not.
`customFields`	Boolean	No	Selected custom fields component or not.
`name`	String	Yes	Name of the Template.
`description`	String	Yes	Creates template description.
`workflows`	Boolean	No	Selected Workflow component or not.
`selectedComponents[]`	Array	No	ConfigurationTemplateContent object contains the selected meta data information.
`selectedComponents[].id`	String	No	Id of Each component.
`selectedComponents[].method`	String	No	Http method which is used to retrieve the particular component.
`selectedComponents[].templateId`	String	No	Id of the Template.
`selectedComponents[].key`	String	No	Key value of fields inside component.
`selectedComponents[].url`	String	No	Metadata is retrieved from this URL.
`selectedComponents[].payload`	Object	No	Json node object contains metadata.
`selectedComponents[].error`	String	No	Error Information.
`selectedComponents[].segregationKey`	String	No	Gives the difference between components and sub components.
`selectedComponents[].componentType`	String	No	Type of Component.
`selectedComponents[].result`	String	No	Contains the response of details fetched regarding selected component.
`content`	Object	No	Provides details about the different components that need to be compared and deployed.
`content.customObjects[]`	Array	No
`content.customObjects[].response[]`	Array	No
`content.customObjects[].response[].id`	String	No	Id of Each component.
`content.customObjects[].response[].method`	String	No	Http method which is used to retrieve the particular component.
`content.customObjects[].response[].templateId`	String	No	Id of the Template.
`content.customObjects[].response[].key`	String	No	Key value of fields inside component.
`content.customObjects[].response[].url`	String	No	Metadata is retrieved from this URL.
`content.customObjects[].response[].payload`	Object	No	Json node object contains metadata.
`content.customObjects[].response[].error`	String	No	Error Information.
`content.customObjects[].response[].segregationKey`	String	No	Gives the difference between components and sub components.
`content.customObjects[].response[].componentType`	String	No	Type of Component.
`content.customObjects[].response[].result`	String	No	Contains the response of details fetched regarding selected component.
`content.customObjects[].segregationKeys[]`	Array	No
`content.customObjects[].errors[]`	Array	No
`content.customObjects[].originalPayload`	Object	No	Json node object contains metadata.
`content.customFields[]`	Array	No
`content.customFields[].response[]`	Array	No
`content.customFields[].response[].id`	String	No	Id of Each component.
`content.customFields[].response[].method`	String	No	Http method which is used to retrieve the particular component.
`content.customFields[].response[].templateId`	String	No	Id of the Template.
`content.customFields[].response[].key`	String	No	Key value of fields inside component.
`content.customFields[].response[].url`	String	No	Metadata is retrieved from this URL.
`content.customFields[].response[].payload`	Object	No	Json node object contains metadata.
`content.customFields[].response[].error`	String	No	Error Information.
`content.customFields[].response[].segregationKey`	String	No	Gives the difference between components and sub components.
`content.customFields[].response[].componentType`	String	No	Type of Component.
`content.customFields[].response[].result`	String	No	Contains the response of details fetched regarding selected component.
`content.customFields[].segregationKeys[]`	Array	No
`content.customFields[].errors[]`	Array	No
`content.customFields[].originalPayload`	Object	No	Json node object contains metadata.
`content.workflows[]`	Array	No
`content.workflows[].response[]`	Array	No
`content.workflows[].response[].id`	String	No	Id of Each component.
`content.workflows[].response[].method`	String	No	Http method which is used to retrieve the particular component.
`content.workflows[].response[].templateId`	String	No	Id of the Template.
`content.workflows[].response[].key`	String	No	Key value of fields inside component.
`content.workflows[].response[].url`	String	No	Metadata is retrieved from this URL.
`content.workflows[].response[].payload`	Object	No	Json node object contains metadata.
`content.workflows[].response[].error`	String	No	Error Information.
`content.workflows[].response[].segregationKey`	String	No	Gives the difference between components and sub components.
`content.workflows[].response[].componentType`	String	No	Type of Component.
`content.workflows[].response[].result`	String	No	Contains the response of details fetched regarding selected component.
`content.workflows[].segregationKeys[]`	Array	No
`content.workflows[].errors[]`	Array	No
`content.workflows[].originalPayload`	Object	No	Json node object contains metadata.
`content.dataAccessControl[]`	Array	No
`content.dataAccessControl[].response[]`	Array	No
`content.dataAccessControl[].response[].id`	String	No	Id of Each component.
`content.dataAccessControl[].response[].method`	String	No	Http method which is used to retrieve the particular component.
`content.dataAccessControl[].response[].templateId`	String	No	Id of the Template.
`content.dataAccessControl[].response[].key`	String	No	Key value of fields inside component.
`content.dataAccessControl[].response[].url`	String	No	Metadata is retrieved from this URL.
`content.dataAccessControl[].response[].payload`	Object	No	Json node object contains metadata.
`content.dataAccessControl[].response[].error`	String	No	Error Information.
`content.dataAccessControl[].response[].segregationKey`	String	No	Gives the difference between components and sub components.
`content.dataAccessControl[].response[].componentType`	String	No	Type of Component.
`content.dataAccessControl[].response[].result`	String	No	Contains the response of details fetched regarding selected component.
`content.dataAccessControl[].segregationKeys[]`	Array	No
`content.dataAccessControl[].errors[]`	Array	No
`content.dataAccessControl[].originalPayload`	Object	No	Json node object contains metadata.
`content.productCatalog[]`	Array	No
`content.productCatalog[].response[]`	Array	No
`content.productCatalog[].response[].id`	String	No	Id of Each component.
`content.productCatalog[].response[].method`	String	No	Http method which is used to retrieve the particular component.
`content.productCatalog[].response[].templateId`	String	No	Id of the Template.
`content.productCatalog[].response[].key`	String	No	Key value of fields inside component.
`content.productCatalog[].response[].url`	String	No	Metadata is retrieved from this URL.
`content.productCatalog[].response[].payload`	Object	No	Json node object contains metadata.
`content.productCatalog[].response[].error`	String	No	Error Information.
`content.productCatalog[].response[].segregationKey`	String	No	Gives the difference between components and sub components.
`content.productCatalog[].response[].componentType`	String	No	Type of Component.
`content.productCatalog[].response[].result`	String	No	Contains the response of details fetched regarding selected component.
`content.productCatalog[].segregationKeys[]`	Array	No
`content.productCatalog[].errors[]`	Array	No
`content.productCatalog[].originalPayload`	Object	No	Json node object contains metadata.
`content.settings[]`	Array	No
`content.settings[].response[]`	Array	No
`content.settings[].response[].id`	String	No	Id of Each component.
`content.settings[].response[].method`	String	No	Http method which is used to retrieve the particular component.
`content.settings[].response[].templateId`	String	No	Id of the Template.
`content.settings[].response[].key`	String	No	Key value of fields inside component.
`content.settings[].response[].url`	String	No	Metadata is retrieved from this URL.
`content.settings[].response[].payload`	Object	No	Json node object contains metadata.
`content.settings[].response[].error`	String	No	Error Information.
`content.settings[].response[].segregationKey`	String	No	Gives the difference between components and sub components.
`content.settings[].response[].componentType`	String	No	Type of Component.
`content.settings[].response[].result`	String	No	Contains the response of details fetched regarding selected component.
`content.settings[].segregationKeys[]`	Array	No
`content.settings[].errors[]`	Array	No
`content.settings[].originalPayload`	Object	No	Json node object contains metadata.
`content.notifications[]`	Array	No
`content.notifications[].response[]`	Array	No
`content.notifications[].response[].id`	String	No	Id of Each component.
`content.notifications[].response[].method`	String	No	Http method which is used to retrieve the particular component.
`content.notifications[].response[].templateId`	String	No	Id of the Template.
`content.notifications[].response[].key`	String	No	Key value of fields inside component.
`content.notifications[].response[].url`	String	No	Metadata is retrieved from this URL.
`content.notifications[].response[].payload`	Object	No	Json node object contains metadata.
`content.notifications[].response[].error`	String	No	Error Information.
`content.notifications[].response[].segregationKey`	String	No	Gives the difference between components and sub components.
`content.notifications[].response[].componentType`	String	No	Type of Component.
`content.notifications[].response[].result`	String	No	Contains the response of details fetched regarding selected component.
`content.notifications[].segregationKeys[]`	Array	No
`content.notifications[].errors[]`	Array	No
`content.notifications[].originalPayload`	Object	No	Json node object contains metadata.
`settings`	Boolean	No	Selected Settings component or not.
`templateTenant`	String	Yes	ID of the template tenant.
`notifications`	Boolean	No	Selected Notification component or not.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.