List a template's variables

GET

/v1/templates/{id}/variables

curl -H "X-Api-Key: $KEY" "http://localhost:9027/v1/templates/$ID/variables"

const response = await fetch(`http://localhost:9027/v1/templates/${process.env.ID}/variables`, {
  headers: { 'X-Api-Key': process.env.KEY },
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

import os

import requests

response = requests.get(
    f"http://localhost:9027/v1/templates/{os.environ['ID']}/variables",
    headers={"X-Api-Key": os.environ["KEY"]},
)
response.raise_for_status()
print(response.json())

package main

import (
  "io"
  "log"
  "net/http"
  "os"
)

func main() {
  url := "http://localhost:9027/v1/templates/" + os.Getenv("ID") + "/variables"
  request, err := http.NewRequest("GET", url, nil)
  if err != nil {
    log.Fatal(err)
  }
  request.Header.Set("X-Api-Key", os.Getenv("KEY"))

  response, err := http.DefaultClient.Do(request)
  if err != nil {
    log.Fatal(err)
  }
  defer response.Body.Close()
  if response.StatusCode >= 300 {
    message, _ := io.ReadAll(response.Body)
    log.Fatalf("%s: %s", response.Status, message)
  }
  if _, err := io.Copy(os.Stdout, response.Body); err != nil {
    log.Fatal(err)
  }
}

Lists the data a template reads: each path, which paths are arrays it loops over, and the fields it reads from their items, with a skeleton of data. Read from the template’s tags, so a path built at render time, such as row[column], is listed only as far as it is written.

Authorizations

api_key
bearer
basic

Parameters

Path Parameters

required

string

The template’s id, or an alias as name or name@version

Responses

200

What the template reads

application/json

What a stored template reads from its data.

object

example

required

Data of the right shape, with empty strings where values go.

object

format

required

string

templateId

required

The template’s id, also when it was asked for by alias.

string

variables

required

Every path the template reads, parents first: customer.name, items (an array), items[].price. For a PDF form, its fields’ names and the tags in their values; tags in annotations are not listed.

Array<object>

One path the template reads.

object

path

required

Dotted, with [] for each item of an array: items[].price. items[] itself says what each item is.

string

type

required

What a template does with a path.

string

Allowed values: value object array

Example

{
  "format": "docx",
  "variables": [
    {
      "path": "items[].price",
      "type": "value"
    }
  ]
}

404

This caller has no such template

application/json

The JSON body of every error response.

object

error

required

A stable, machine-readable kind.

string

message

required

What went wrong, for a person.

string

Example

{
  "error": "invalid_request",
  "message": "unknown step 'teleport'"
}

422

The template has syntax errors

application/json

The JSON body of every error response.

object

error

required

A stable, machine-readable kind.

string

message

required

What went wrong, for a person.

string

Example

{
  "error": "invalid_request",
  "message": "unknown step 'teleport'"
}

501

RUSTICDOC_STORE is not set

application/json

The JSON body of every error response.

object

error

required

A stable, machine-readable kind.

string

message

required

What went wrong, for a person.

string

Example

{
  "error": "invalid_request",
  "message": "unknown step 'teleport'"
}

503

The store cannot be reached

application/json

The JSON body of every error response.

object

error

required

A stable, machine-readable kind.

string

message

required

What went wrong, for a person.

string

Example

{
  "error": "invalid_request",
  "message": "unknown step 'teleport'"
}