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

GET /tasks-and-controls/controls

Get list of Controls

Description

Returns list of Controls

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 controls by keyword. Allowed expression(s): ct  
tags[eq] optional Search for controls with a specific tag. Allowed expression(s): eq, in  

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
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "name",
          "value_type"
        ],
        "properties": {
          "id": {
            "description": "Id of the record",
            "type": "string",
            "format": "uuid",
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "allowed_values": {
            "description": "The values that are considered ok. For multiple values seperate by ;",
            "type": "string",
            "format": "string",
            "example": "valueA;valueB"
          },
          "description": {
            "description": "A description of the control point visible upon task completion",
            "type": "string",
            "format": "string",
            "example": "A string"
          },
          "disable_user_input": {
            "description": "If this a control point that is not meant to be filled from the UI\nCan be used with API-integrations, Connect",
            "type": "boolean",
            "format": "boolean",
            "example": true
          },
          "documentation_url": {
            "description": "Url of external documentation",
            "type": "string",
            "format": "string",
            "example": "https://you-will-find-external-documentation.here"
          },
          "field_type": {
            "description": "The field type that should be used in the UI for this control value",
            "type": "string",
            "format": "string",
            "enum": [
              "sku",
              "partner",
              "list",
              "date_time"
            ],
            "example": "list"
          },
          "list_values": {
            "description": "Values to show in list when *field_type* is *list* and *value_type* is *text*. \nOne per line in the format *key|Presented value*",
            "type": "string",
            "format": "string",
            "example": "A string"
          },
          "name": {
            "description": "Name of the control",
            "type": "string",
            "format": "string",
            "example": "A string"
          },
          "ref": {
            "description": "Reference code of the control",
            "type": "string",
            "format": "string",
            "example": "XYZ345"
          },
          "template_url": {
            "description": "Url of external template when the *value_type* is *file*",
            "type": "string",
            "format": "string",
            "example": "https://you-will-find-some-document-template.here"
          },
          "tolerance_lower": {
            "description": "Lower tolerance",
            "type": "number",
            "format": "double",
            "example": 1234.123
          },
          "tolerance_upper": {
            "description": "Upper tolerance",
            "type": "number",
            "format": "double",
            "example": 1234.123
          },
          "unit": {
            "description": "Unit of control value. Use *image* for file controls if you want a the file uploaded to be an image",
            "type": "string",
            "format": "string",
            "example": "Degrees Celcius"
          },
          "value_type": {
            "description": "Type of value to store in field",
            "type": "string",
            "format": "string",
            "enum": [
              "bool",
              "float",
              "integer",
              "text",
              "date",
              "file"
            ],
            "example": "A string"
          },
          "active": {
            "description": "Boolean indicating if the record is active and could be referenced from other entities",
            "type": "boolean",
            "format": "boolean",
            "example": true
          },
          "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"
      }
    },
    "links": {
      "description": "Links",
      "properties": {
        "first": {
          "description": "Link to the first page",
          "type": "string"
        },
        "last": {
          "description": "Link to the last page",
          "type": "string"
        },
        "next": {
          "description": "Link to the next page",
          "type": "string"
        },
        "prev": {
          "description": "Link to the previous page",
          "type": "string"
        }
      },
      "type": "object"
    },
    "meta": {
      "description": "Meta with pagination",
      "properties": {
        "current_page": {
          "description": "The current page",
          "type": "integer"
        },
        "from": {
          "description": "The starting position of the current page results",
          "type": "integer"
        },
        "last_page": {
          "description": "The last page",
          "type": "integer"
        },
        "path": {
          "description": "The current path of the request",
          "type": "string"
        },
        "per_page": {
          "description": "Records that are displayed pr request",
          "type": "integer"
        },
        "to": {
          "description": "The ending position of the current page results",
          "type": "integer"
        },
        "total": {
          "description": "Number of records that are matched by the current query",
          "type": "integer"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

406

not acceptable

500

internal server error

POST /tasks-and-controls/controls

Create new Control

Description

Create a new Control

Request body

Description

Target Control.

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
124
125

{
  "required": [
    "name",
    "value_type"
  ],
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "allowed_values": {
      "description": "The values that are considered ok. For multiple values seperate by ;",
      "type": "string",
      "format": "string",
      "example": "valueA;valueB"
    },
    "description": {
      "description": "A description of the control point visible upon task completion",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "disable_user_input": {
      "description": "If this a control point that is not meant to be filled from the UI\nCan be used with API-integrations, Connect",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "documentation_url": {
      "description": "Url of external documentation",
      "type": "string",
      "format": "string",
      "example": "https://you-will-find-external-documentation.here"
    },
    "field_type": {
      "description": "The field type that should be used in the UI for this control value",
      "type": "string",
      "format": "string",
      "enum": [
        "sku",
        "partner",
        "list",
        "date_time"
      ],
      "example": "list"
    },
    "list_values": {
      "description": "Values to show in list when *field_type* is *list* and *value_type* is *text*. \nOne per line in the format *key|Presented value*",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "name": {
      "description": "Name of the control",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "ref": {
      "description": "Reference code of the control",
      "type": "string",
      "format": "string",
      "example": "XYZ345"
    },
    "template_url": {
      "description": "Url of external template when the *value_type* is *file*",
      "type": "string",
      "format": "string",
      "example": "https://you-will-find-some-document-template.here"
    },
    "tolerance_lower": {
      "description": "Lower tolerance",
      "type": "number",
      "format": "double",
      "example": 1234.123
    },
    "tolerance_upper": {
      "description": "Upper tolerance",
      "type": "number",
      "format": "double",
      "example": 1234.123
    },
    "unit": {
      "description": "Unit of control value. Use *image* for file controls if you want a the file uploaded to be an image",
      "type": "string",
      "format": "string",
      "example": "Degrees Celcius"
    },
    "value_type": {
      "description": "Type of value to store in field",
      "type": "string",
      "format": "string",
      "enum": [
        "bool",
        "float",
        "integer",
        "text",
        "date",
        "file"
      ],
      "example": "A string"
    },
    "active": {
      "description": "Boolean indicating if the record is active and could be referenced from other entities",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "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

406

not acceptable

500

internal server error