This page was automatically generated from tracezilla’s Swagger API documentation 2026-07-17

GET /document-template-settings/variables/{documentVariableId}

Get document

Description

Returns document

Parameters (path)

Name Required Description Values
documentVariableId required Target document.  

Responses

200

successful operation

406

not acceptable

500

internal server error

PUT /document-template-settings/variables/{documentVariableId}

Update existing DocumentVariable

Description

Update the specified resource in storage.

Parameters (path)

Name Required Description Values
documentVariableId required Target document.  

Request body

Description

Target DocumentVariable.

Required

This parameter is required.

Request body JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

{
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "content": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "input_format": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "name": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "created_at": {
      "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "updated_at": {
      "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2020-01-01T13:25:32.312Z"
    }
  },
  "type": "object"
}

Responses

403

Unauthorized request

406

not acceptable

500

Internal server error

DELETE /document-template-settings/variables/{documentVariableId}

Delete DocumentVariable

Description

Remove the specified resource from storage.

Parameters (path)

Name Required Description Values
documentVariableId required Target document.  

Responses

403

Unauthorized request

406

not acceptable

500

Internal server error