Document Templates

Get template field positions

GET/document-templates/{id}/positions
document-templates:readget_document_template_positionsRead-only

Returns every field placement of the template in one unpaginated response, ordered by page, then vertical position, then id. Each has an integer id; the ids change every time the set is replaced with PUT .../positions. Like that write, this is a whole-set read, so it takes no limit or cursor. An unknown or malformed id returns 404.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Responses

200

OK

DocumentTemplatePosition[]
{
  "data": [
    {
      "id": 4182,
      "reference": "full_name",
      "kind": "field",
      "element_type": "text",
      "element_id": null,
      "required": true,
      "conditions": [],
      "page": 1,
      "x": 120.5,
      "y": 640,
      "width": 200,
      "height": 24,
      "style": {}
    }
  ]
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/document-templates/{id}/positions\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"