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

GET /tasks-and-controls/occurrences

Get list of Task occurrences

Description

Returns list of Task occurrences

Parameters (query)

Name Required Description Values
sortBy optional Field to sort by. Without sort specified it will sort first by ref and then name.  
sortDirection optional Direction of sort. asc, desc
task[eq] optional Search for task occurrences by task. Allowed expression(s): eq, in  
status[eq] optional Search for task occurrences by status. Allowed expression(s): eq completed, pending, trashed, all_but_trashed
start_time[gte] optional Search for task occurrences by start date & time. Allowed expression(s): gte, lte, gt, lt, eq  
end_time[gte] optional Search for task occurrences by end date & time. Allowed expression(s): gte, lte, gt, lt, eq  
assigned_to[eq] optional Search for task occurrences by the id of the user. Allowed expression(s): eq, in  
collection_model[eq] optional Search for task occurrences by collection. Allowed expression(s): eq Order, Partner, Sku, Recipe, Lot, Expense
collection_entity[eq] optional Search for task occurrences by collection. Allowed expression(s): eq, in  
related_model[eq] optional Search for task occurrences by related model. Allowed expression(s): eq Order, Partner, Sku, Recipe, Lot, Expense
related_entity[eq] optional Search for task occurrences by related entity. Allowed expression(s): eq, in  
include optional The resources that can be included in this request, delimited by a comma: task, parent, children, control_bools, control_texts, control_integers, control_floats, control_dates, control_files, collection_order, related_order_lot_inbound, related_lot, related_sku, related_expense, related_partner, related_recipe, related_order_recipe, assigned_to, completed_by, ext_completed_by, ext_partner, sender_team, created_by  

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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "task_id",
          "start_time",
          "end_time",
          "related_model_name",
          "related_entity_id"
        ],
        "properties": {
          "id": {
            "description": "Id of the record",
            "type": "string",
            "format": "uuid",
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "occurrence_key": {
            "description": "A custom key that can be used to identify the task occurrence",
            "type": "string",
            "format": "string",
            "example": "ABC34535"
          },
          "assigned_to_id": {
            "description": "Who this task is assigned to",
            "type": "integer",
            "format": "int32",
            "example": 1234
          },
          "comment": {
            "description": "A comment entered by the user",
            "type": "string",
            "format": "string",
            "example": "A string"
          },
          "completed": {
            "description": "Boolean indicating if the occurrence was completed",
            "type": "boolean",
            "format": "boolean",
            "example": true
          },
          "completed_by_id": {
            "description": "Id of the user that completed the task",
            "type": "integer",
            "format": "int32",
            "readOnly": true,
            "example": 1234
          },
          "created_by_id": {
            "description": "Id of the user that created the task",
            "type": "integer",
            "format": "int32",
            "readOnly": true,
            "example": 1234
          },
          "duration": {
            "description": "Duration in minutes",
            "type": "integer",
            "format": "int32",
            "readOnly": true,
            "example": 1234
          },
          "end_time": {
            "description": "The end date & time of the occurrence",
            "type": "string",
            "format": "date-time",
            "example": "2019-01-01T13:25:32.312Z"
          },
          "ext_collection_description": {
            "description": "A text describing the collection of the task occurrence towards an external partner",
            "type": "string",
            "format": "string",
            "readOnly": true,
            "example": "Purchase # 34545"
          },
          "ext_entity_description": {
            "description": "A text describing the entity of the task occurrence towards an external partner",
            "type": "string",
            "format": "string",
            "readOnly": true,
            "example": "Lot # 1234-00004"
          },
          "ext_completed": {
            "description": "Boolean indicating if the occurrence was completed by the external partner",
            "type": "boolean",
            "format": "boolean",
            "readOnly": true,
            "example": true
          },
          "ext_completed_at": {
            "description": "Timestamp of when the external partner completed the task",
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "example": "2019-01-01T13:25:32.312Z"
          },
          "ext_completed_by_id": {
            "description": "Id of the user that completed the task on behalf of the external partner",
            "type": "integer",
            "format": "int32",
            "readOnly": true,
            "example": 1234
          },
          "ext_notified_at": {
            "description": "Timestamp of when the external partner was notified of the task occurrence",
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "example": "2019-01-01T13:25:32.312Z"
          },
          "ext_partner_id": {
            "description": "Id of a partner that should complete this task",
            "type": "string",
            "format": "uuid",
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "is_external_partner": {
            "description": "Boolean indicating if the team viewing the task occurrence is different from the team that owns the occurrence",
            "type": "boolean",
            "format": "boolean",
            "readOnly": true,
            "example": true
          },
          "related_entity_id": {
            "description": "Id of the related entity",
            "type": "string",
            "format": "uuid",
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "related_model_name": {
            "description": "Model name of the related entity",
            "type": "string",
            "format": "string",
            "enum": [
              "Order",
              "OrderLotInbound",
              "Lot",
              "Sku",
              "Partner",
              "Recipe",
              "Expense"
            ],
            "example": "Order"
          },
          "collection_entity_id": {
            "description": "Id of the related collection entity",
            "type": "string",
            "format": "uuid",
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "collection_model_name": {
            "description": "Model name of the related collection",
            "type": "string",
            "format": "string",
            "enum": [
              "Order",
              "Lot",
              "Sku",
              "Partner",
              "Recipe",
              "Expense"
            ],
            "example": "Order"
          },
          "parent_id": {
            "description": "Id of the parent occurrence",
            "type": "string",
            "format": "uuid",
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "start_time": {
            "description": "Start date & time of the task occurrence started",
            "type": "string",
            "format": "date-time",
            "example": "2019-01-01T13:25:32.312Z"
          },
          "task_id": {
            "description": "Id of the related task",
            "type": "string",
            "format": "uuid",
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "deleted_at": {
            "description": "The time when the record was deleted in UTC date & time (Iso8601 ZuluString).\nTo see trashed occurrences you must use the *status[eq]=trashed*-filter",
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "example": "2019-01-01T13:25:32.312Z"
          },
          "created_at": {
            "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "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",
            "readOnly": true,
            "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/occurrences

Create new Task Occurrence

Description

Create a new Task Occurrence

Request body

Description

Target Task Occurrence.

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
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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204

{
  "required": [
    "task_id",
    "start_time",
    "end_time",
    "related_model_name",
    "related_entity_id"
  ],
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "occurrence_key": {
      "description": "A custom key that can be used to identify the task occurrence",
      "type": "string",
      "format": "string",
      "example": "ABC34535"
    },
    "assigned_to_id": {
      "description": "Who this task is assigned to",
      "type": "integer",
      "format": "int32",
      "example": 1234
    },
    "comment": {
      "description": "A comment entered by the user",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "completed": {
      "description": "Boolean indicating if the occurrence was completed",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "completed_by_id": {
      "description": "Id of the user that completed the task",
      "type": "integer",
      "format": "int32",
      "readOnly": true,
      "example": 1234
    },
    "created_by_id": {
      "description": "Id of the user that created the task",
      "type": "integer",
      "format": "int32",
      "readOnly": true,
      "example": 1234
    },
    "duration": {
      "description": "Duration in minutes",
      "type": "integer",
      "format": "int32",
      "readOnly": true,
      "example": 1234
    },
    "end_time": {
      "description": "The end date & time of the occurrence",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "ext_collection_description": {
      "description": "A text describing the collection of the task occurrence towards an external partner",
      "type": "string",
      "format": "string",
      "readOnly": true,
      "example": "Purchase # 34545"
    },
    "ext_entity_description": {
      "description": "A text describing the entity of the task occurrence towards an external partner",
      "type": "string",
      "format": "string",
      "readOnly": true,
      "example": "Lot # 1234-00004"
    },
    "ext_completed": {
      "description": "Boolean indicating if the occurrence was completed by the external partner",
      "type": "boolean",
      "format": "boolean",
      "readOnly": true,
      "example": true
    },
    "ext_completed_at": {
      "description": "Timestamp of when the external partner completed the task",
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "example": "2019-01-01T13:25:32.312Z"
    },
    "ext_completed_by_id": {
      "description": "Id of the user that completed the task on behalf of the external partner",
      "type": "integer",
      "format": "int32",
      "readOnly": true,
      "example": 1234
    },
    "ext_notified_at": {
      "description": "Timestamp of when the external partner was notified of the task occurrence",
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "example": "2019-01-01T13:25:32.312Z"
    },
    "ext_partner_id": {
      "description": "Id of a partner that should complete this task",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "is_external_partner": {
      "description": "Boolean indicating if the team viewing the task occurrence is different from the team that owns the occurrence",
      "type": "boolean",
      "format": "boolean",
      "readOnly": true,
      "example": true
    },
    "related_entity_id": {
      "description": "Id of the related entity",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "related_model_name": {
      "description": "Model name of the related entity",
      "type": "string",
      "format": "string",
      "enum": [
        "Order",
        "OrderLotInbound",
        "Lot",
        "Sku",
        "Partner",
        "Recipe",
        "Expense"
      ],
      "example": "Order"
    },
    "collection_entity_id": {
      "description": "Id of the related collection entity",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "collection_model_name": {
      "description": "Model name of the related collection",
      "type": "string",
      "format": "string",
      "enum": [
        "Order",
        "Lot",
        "Sku",
        "Partner",
        "Recipe",
        "Expense"
      ],
      "example": "Order"
    },
    "parent_id": {
      "description": "Id of the parent occurrence",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "start_time": {
      "description": "Start date & time of the task occurrence started",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "task_id": {
      "description": "Id of the related task",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "deleted_at": {
      "description": "The time when the record was deleted in UTC date & time (Iso8601 ZuluString).\nTo see trashed occurrences you must use the *status[eq]=trashed*-filter",
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "example": "2019-01-01T13:25:32.312Z"
    },
    "created_at": {
      "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "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",
      "readOnly": true,
      "example": "2020-01-01T13:25:32.312Z"
    }
  },
  "type": "object"
}

Responses

406

not acceptable

500

internal server error