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

GET /document-strings

Get list of DocumentStrings

Description

Returns list of DocumentStrings

Parameters (query)

Name Required Description Values
sortBy optional Field to sort by. Without sort specified it will sort first by ref and then name. name, ref, created_at, updated_at
sortDirection optional Direction of sort. asc, desc
keyword[ct] optional Search for services by keyword. Allowed expression(s): ct  
include optional The resources that can be included in this request, delimited by a comma: translations  

Responses

200

successful operation

406

not acceptable

500

internal server error

POST /document-strings

Create new DocumentString

Description

Create a new DocumentString

Request body

Description

Target DocumentString.

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

{
  "required": [
    "selector"
  ],
  "properties": {
    "id": {
      "description": "Id of the DocumentString record",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "default_text": {
      "description": "The default text if no translation exists",
      "type": "string",
      "format": "string",
      "example": "Super customer discount"
    },
    "selector": {
      "description": "Alphanumeric selector to be used for the document string. Must be unique.",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "translations": {
      "description": "Translations of the DocumentString entity. \nTranslations should be an object where the property name is the ISO 639-1 Code 2 letter language code and the value is the translation\nNotice that these will only be included if *translations* are included in the include parameter",
      "properties": {
        "da": {
          "type": "string",
          "format": "string",
          "example": "Rabat"
        },
        "de": {
          "type": "string",
          "format": "string",
          "example": "Rabatt"
        }
      },
      "type": "object"
    },
    "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

200

successful operation

Response content 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

{
  "properties": {
    "required": [
      "selector"
    ],
    "properties": {
      "id": {
        "description": "Id of the DocumentString record",
        "type": "string",
        "format": "uuid",
        "readOnly": true,
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "default_text": {
        "description": "The default text if no translation exists",
        "type": "string",
        "format": "string",
        "example": "Super customer discount"
      },
      "selector": {
        "description": "Alphanumeric selector to be used for the document string. Must be unique.",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "translations": {
        "description": "Translations of the DocumentString entity. \nTranslations should be an object where the property name is the ISO 639-1 Code 2 letter language code and the value is the translation\nNotice that these will only be included if *translations* are included in the include parameter",
        "properties": {
          "da": {
            "type": "string",
            "format": "string",
            "example": "Rabat"
          },
          "de": {
            "type": "string",
            "format": "string",
            "example": "Rabatt"
          }
        },
        "type": "object"
      },
      "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"
  },
  "type": "object"
}

406

not acceptable

500

internal server error