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

GET /documents/{documentId}

Get document

Description

Returns document resource

Parameters (path)

Name Required Description Values
documentId required Target document.  

Responses

200

successful operation

406

not acceptable

500

internal server error

PUT /documents/{documentId}

Update existing document

Parameters (path)

Name Required Description Values
documentId required Target document.  

Request body

Description

Target order.

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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

{
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "created_by_id": {
      "description": "No description is available",
      "type": "integer",
      "format": "int32",
      "example": 1234
    },
    "document_data": {
      "description": "No description is available",
      "format": "",
      "example": ""
    },
    "filters": {
      "description": "No description is available",
      "format": "",
      "example": ""
    },
    "language": {
      "description": "ISO 639-1 Code 2 letter language code",
      "type": "string",
      "format": "string",
      "example": "da"
    },
    "last_sent_at": {
      "description": "No description is available",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "last_sent_by_id": {
      "description": "No description is available",
      "type": "integer",
      "format": "int32",
      "example": 1234
    },
    "last_sent_note": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "last_sent_using": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "locked": {
      "description": "No description is available",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "number": {
      "description": "No description is available",
      "type": "integer",
      "format": "int32",
      "example": 1234
    },
    "origin_entity_id": {
      "description": "No description is available",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "origin_model_name": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "recipient_location_id": {
      "description": "No description is available",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "recipient_partner_id": {
      "description": "No description is available",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "status": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "type": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "version": {
      "description": "No description is available",
      "type": "integer",
      "format": "int32",
      "example": 1234
    },
    "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