Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Template

Export Template

Use this API to export the metadata of a specific template in JSON format in order to migrate the template from one environment/tenant to another environment/tenant. The response body will be returned in JSON format and will include template details such as questions, rules, skip/show logic, etc.

🗒 Things to Know

  • The JSON response body returned by this API can be pasted within the Import Template API's request body to import the metadata of the template into the environment/tenant.
  • The templateRootVersionId must be passed as the value for the templateId parameter if you are passing the templateVersion query parameter in the request.
  • The response of this API will vary based on whether the templateVersion parameter is passed.
  • If this parameter is not passed, then the template corresponding to the templateId will be exported.
  • If a specific version value is passed for this parameter, then that version of the template will be exported.
  • If latest is passed for this parameter, then the latest version of the template will be exported.
get/api/template/v2/templates/{templateId}/export

Path parameters

templateIdstring uuid required

The UUID of the template to export

Example:7d271be5-0601-4190-96a7-65d7c427a725

The unique identifier of the template to export.

Query parameters

templateVersionstring

The version of the template to export. If not specified, exports the template corresponding to templateId. If 'latest' is passed, exports the latest version of the template.

Example:latest

The specific version of the template to export or 'latest' for newest version.

Response

OK

object required

Example response

{
  "template": {
    "id": "7d271be5-0601-4190-96a7-65d7c427a725",
    "name": "OnePIA",
    "status": "PUBLISHED"
  }
}