Saltar al contenido

Get a template version

Módulo Platform

GET/template-versions/{id}templateVersions.get

A version of a template (1032): the project defaults and ordered items. Edited while a draft; publishing (templateVersions.publish) freezes it and makes it the template's current version. Returns one template version with its `ETag`. A template version the caller may not see returns 404.

  • Requiere la capacidad projects.project.read.
  • Alcances de OAuth: projects.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

templateVersions.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the template version.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Respuesta 200: TemplateVersion

templateVersions.get: TemplateVersion
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the template version.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row.
template_idstring (uuid)SíIdentifier of the template.
version_numberintegerSíVersion number, issued in order, 1 first.Restricciones: range 1 to any
notesstring | nullSíWhat changed in this version.Restricciones: length 1 to 20000
default_time_zonestring | nullSíIANA time zone a new project starts with.Restricciones: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$
default_tier_codestring | nullSíCanon tier a new project starts with.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
default_region_codestring | nullSíCanon region a new project starts with.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
default_jurisdiction_idstring | nullSíCanon jurisdiction a new project starts with.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
default_currency_codestring | nullSíISO 4217 currency a new project starts with.Restricciones: pattern ^[A-Z]{3}$
duration_daysinteger | nullSíLength of the project in days.Restricciones: range 1 to any
published_atstring (date-time) | nullSíWhen the version was published; null while a draft.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "version_number": 1,
  "notes": "Adds the load-out records.",
  "default_time_zone": "America/New_York",
  "default_tier_code": "05",
  "default_region_code": "SE",
  "default_jurisdiction_id": "US-FL-MIAMI-DADE",
  "default_currency_code": "USD",
  "duration_days": 3,
  "published_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/template-versions/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.templateVersions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.template_versions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos template-versions get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f