CLclinicos
Templates

The backend-owned template variable catalog: every {{token}} the render pipeline knows, with label, description, applicable template types, and the sample value previews use. The editor's variable picker and autocomplete derive from this.

Changed on
get/templates/variables

Request

Query parameters

typestring

Optional filter to variables applicable to one template type (e.g. "labels")

categorystring

With type "client-message": only the variables offered for this category

Response

OK

namestring

The token between the braces, e.g. "patient_name".

tagstring

The full insertable token, e.g. "{{patient_name}}".

labelstring

Human-readable name shown in the editor's variable picker.

descriptionstring
typesstring[]

Template types whose render path populates this variable. Empty for legacy variables no current render path populates.

sampleValuestring nullable

Realistic value substituted in editor previews.

categoriesstring[] nullable

Client-message categories this variable is offered for (type "client-message" only). Null means every category.

smsSafeboolean

Short enough to offer in an SMS body (ITE-1589).

Changes

  • 099cf36186e0Revision changes
    • info

      added the new optional query request parameter category

    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)

    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)