Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Template

Retrieve full details for a single template

Returns the complete record for the template identified by {id} within the requesting tenant.

When to use: Call this after creating a template (via either upload flow) to check its status, retrieve download URLs for its artifacts, or inspect its metadata. To browse or filter all templates use GET /templates; for the ordered column definitions of a scratch-built template use GET /templates/{id}/columns.

How: Supply {id} (the template ID returned by the create endpoints) and the required tenant-id header.

Returns: The template record whose data object carries the template's name, description, status (in-progress, success, or failure), type, and the GCS object paths of its artifacts. For each artifact that exists in GCS, a V4-signed download URL valid for 7 days is generated at request time (never stored) and injected into data: templateUrl (template CSV), mappingsUrl (column-mappings CSV), and schemaUrl (generated validation schema). Read-only; no state is changed.

get/templates/{id}

Path parameters

idstring required

Server-generated ID of the template to fetch, as returned by the create endpoints.

Headers

tenant-idstring required

Tenant that owns the template; scopes the lookup.

Response

The template record, with request-time signed download URLs injected into data for every artifact that exists in GCS.

idstring

Server-generated unique identifier of the template.

tenantIdstring

Tenant that owns the template.

createdAtstring date-time
createdBystring

ID of the user who created the template.

updatedAtstring date-time
updatedBystring

ID of the user who last updated the template.

dataobject

Template payload. Persisted keys: templateName, description, status (in-progress while awaiting mapping confirmation/approval, success once approved, failure when a re-approval's schema generation failed), type (PRACTITIONER, FACILITY, or GROUP), plus - once approved - template and schema (GCS object paths of the template CSV and generated JSON schema). Responses additionally inject short-lived signed download URLs generated at request time and never stored: mappingsUrl on both list and detail reads, and templateUrl/schemaUrl on the detail read when the underlying objects exist. Signed URLs are V4-signed and valid for 7 days.

Example response

{
  "id": "3f8e2b6c-9d41-4a7b-b6a0-5e2f8c1d9a37",
  "tenantId": "tenant_001",
  "createdAt": "2022-03-10T16:15:50Z",
  "createdBy": "auth0|64f1c2d3e4b5a6",
  "updatedAt": "2022-03-10T16:15:50Z",
  "updatedBy": "auth0|64f1c2d3e4b5a6"
}