CAcarbone
Template

Download a template or a specific version.

Fetches a specific template or version of a template from the Carbone storage. It supports retrieving the latest deployed version of a template using the templateId, as well as individual versions via versionId. This endpoint also allows downloading JSON data samples associated with templates or specific versions, which are used in the Studio for testing and development purposes.

Features

  • Template Retrieval: Downloads the template file or its associated JSON sample based on the provided ID.
  • Version Specificity: Retrieve specific versions of a template using versionId, or fetch the latest deployed template using templateId.
  • Data Samples: Access data samples stored with templates or versions, which are useful for testing and development in the Carbone Studio environment.

Parameters

The id of the template or version to download, can also be specified as {templateId}_sample.json or {versionId}_sample.json to download associated data samples.

Use Cases

Ideal for accessing templates and their associated data samples for testing, integration, or deployment purposes. Supports scenarios requiring version-specific template retrieval or the latest deployed template versions.

get/template/{templateId-or-versionId}

Request

Path parameters

templateId-or-versionIdstring required

Unique identifier of the template or version ID

Headers

carbone-version'5' | '4' | '3' | 'staging' required

Carbone API major version to use. Only a major version can be specified: it automatically includes all future minor versions and patches.

  • 5: latest version, recommended.
  • 4: default when the header is not provided.
  • 3: legacy.
  • staging: not intended for production environments.

It is strongly recommended to always set this header explicitly to avoid unexpected behavior. See API versioning documentation

Response

Stream of the file content

Changes

No recorded changes to this operation across all 1 revision of this API.