Worker Incident Resource¶
Get Worker Incident¶
HTTP Request
GET /api/workerIncidents/{id}
📋 Description: Retrieves detailed information about a specific worker incident identified by the provided ID, enabling organizations to assess and address workplace safety and compliance issues effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "title": "string",
7 "description": "string",
8 "reportDate": "2019-08-24",
9 "statusName": "string",
10 "workOrder": {
11 "id": 0,
12 "createdBy": "string",
13 "createdAt": "2019-08-24T14:15:22Z",
14 "displayId": "string",
15 "name": "string",
16 "imageId": 0,
17 "description": "string",
18 "vendorRating": 0,
19 "premiseId": 0,
20 "premiseDto": {
21 "id": 0,
22 "createdBy": "string",
23 "createdAt": "2019-08-24T14:15:22Z",
24 "displayId": "string",
25 "premiseName": "string",
26 "description": "string",
27 "address": "string",
28 "internalTeamNames": [
29 "string"
30 ],
31 "internalTeamIds": [
32 0
33 ],
34 "premiseAvailable": true,
35 "premiseFromNrm": true,
36 "nlmId": 0,
37 "nlmDisplayId": "string",
38 "nlmUsed": true,
39 "manager": 0,
40 "managerName": "string",
41 "imageId": 0,
42 "area": "string",
43 "modifiedAt": "2019-08-24T14:15:22Z"
44 },
45 "premiseFromNrm": true,
46 "premiseDisplayId": "string",
47 "nssProjectId": 0,
48 "nssTaskId": 0,
49 "nssTaskDisplayId": "string",
50 "orderDate": "2019-08-24",
51 "dueDate": "2019-08-24",
52 "startDate": "2019-08-24",
53 "endDate": "2019-08-24",
54 "startTime": {
55 "hour": 0,
56 "minute": 0,
57 "second": 0,
58 "nano": 0
59 },
60 "endTime": {
61 "hour": 0,
62 "minute": 0,
63 "second": 0,
64 "nano": 0
65 },
66 "modifiedAt": "2019-08-24T14:15:22Z",
67 "estimatedCost": "81.08",
68 "finalCost": "81.08",
69 "duration": 0,
70 "estimatedDayTime": 0,
71 "finalHourTime": "2.5",
72 "estimatedHourTime": "2.5",
73 "closeDate": "2019-08-24",
74 "inspection": "string",
75 "workOrderTypeId": 0,
76 "workOrderTypeName": "string",
77 "workOrderType": "string",
78 "workOrderPriorityId": 0,
79 "workOrderPriority": "string",
80 "workOrderPriorityType": "string",
81 "isTemplate": true,
82 "isWorkOrderTemplate": true,
83 "templateId": 0,
84 "isPartsInSufficient": true,
85 "partQuantityInfoList": [
86 {
87 "partId": 0,
88 "partDisplayId": "string",
89 "requestedQuantity": 0,
90 "availableQuantity": 0,
91 "usedQuantity": 0,
92 "sufficient": true,
93 "partial": true
94 }
95 ],
96 "parentWorkOrderId": 0,
97 "parentWorkOrderDisplayId": "string",
98 "parentWorkOrder": "string",
99 "mainAssetIds": [
100 0
101 ],
102 "mainAssetDto": {
103 "id": 0,
104 "createdBy": "string",
105 "createdAt": "2019-08-24T14:15:22Z",
106 "displayId": "string",
107 "name": "string",
108 "description": "string",
109 "qrCode": "string",
110 "barCode": "string",
111 "imageId": 0,
112 "model": "string",
113 "manufacturer": "string",
114 "serialNumber": "string",
115 "cost": "81.08",
116 "premiseId": 0,
117 "premiseDisplayId": "string",
118 "premiseDto": {
119 "id": 0,
120 "createdBy": "string",
121 "createdAt": "2019-08-24T14:15:22Z",
122 "displayId": "string",
123 "premiseName": "string",
124 "description": "string",
125 "address": "string",
126 "internalTeamNames": [
127 "string"
128 ],
129 "internalTeamIds": [
130 0
131 ],
132 "premiseAvailable": true,
133 "premiseFromNrm": true,
134 "nlmId": 0,
135 "nlmDisplayId": "string",
136 "nlmUsed": true,
137 "manager": 0,
138 "managerName": "string",
139 "imageId": 0,
140 "area": "string",
141 "modifiedAt": "2019-08-24T14:15:22Z"
142 },
143 "acquisitionDate": "2019-08-24",
144 "endOfLife": "2019-08-24",
145 "assetStatusId": 0,
146 "assetStatus": "string",
147 "assetStatusType": "string",
148 "parentAssetId": 0,
149 "parentAssetDisplayId": "string",
150 "parentAsset": "string",
151 "parentAssetDto": {},
152 "upcomingMaintenanceDate": "2019-08-24",
153 "assetCategoryIds": [
154 0
155 ],
156 "assetCategories": [
157 "string"
158 ],
159 "internalTeamIds": [
160 0
161 ],
162 "internalTeamDtos": [
163 {
164 "id": 0,
165 "createdBy": "string",
166 "createdAt": "2019-08-24T14:15:22Z",
167 "displayId": "string",
168 "name": "string",
169 "email": "string",
170 "phone": "string",
171 "manager": "string",
172 "requestCategoryName": [
173 "string"
174 ],
175 "requestCategoryId": [
176 0
177 ],
178 "requestCategoryDisplayId": [
179 "string"
180 ],
181 "description": "string",
182 "internalTeamUser": [
183 0
184 ],
185 "members": 0,
186 "mainAssets": [
187 0
188 ],
189 "premiseNames": [
190 "string"
191 ],
192 "internalTeamAvailable": true,
193 "premiseIds": [
194 0
195 ]
196 }
197 ],
198 "internalTeams": [
199 "string"
200 ],
201 "assignedUserIds": [
202 0
203 ],
204 "assignedUserDtos": [
205 {
206 "id": 0,
207 "createdBy": "string",
208 "createdAt": "2019-08-24T14:15:22Z",
209 "userName": "string",
210 "firstName": "string",
211 "lastName": "string",
212 "email": "string",
213 "roleIds": [
214 {
215 "id": 0,
216 "createdBy": "string",
217 "createdAt": "2019-08-24T14:15:22Z",
218 "modifiedBy": "string",
219 "modifiedAt": "2019-08-24T14:15:22Z",
220 "roleName": "string",
221 "entity": "string",
222 "new": true
223 }
224 ],
225 "internalTeamNames": [
226 "string"
227 ],
228 "internalTeamIds": [
229 0
230 ],
231 "internalTeamDisplayIds": [
232 "string"
233 ],
234 "premiseIds": [
235 0
236 ],
237 "premiseNames": [
238 "string"
239 ],
240 "userAvailable": true,
241 "temporaryWorkload": 0,
242 "preferredCultureCode": "string"
243 }
244 ],
245 "assignedUsers": [
246 "string"
247 ],
248 "assetPriority": "string",
249 "assetPriorityId": 0,
250 "assetPriorityDisplayId": "string",
251 "assetPriorityType": "string",
252 "assetAvailable": true,
253 "exactPlacement": "string",
254 "fosId": 0,
255 "downtimeStatus": "string",
256 "premiseFromNrm": true,
257 "modifiedAt": "2019-08-24T14:15:22Z"
258 },
259 "mainAssetDisplayId": "string",
260 "workOrderStatusId": 0,
261 "workOrderStatus": "string",
262 "workOrderStatusType": "string",
263 "requestIds": [
264 0
265 ],
266 "internalTeamIds": [
267 0
268 ],
269 "internalTeamDtos": [
270 {
271 "id": 0,
272 "createdBy": "string",
273 "createdAt": "2019-08-24T14:15:22Z",
274 "displayId": "string",
275 "name": "string",
276 "email": "string",
277 "phone": "string",
278 "manager": "string",
279 "requestCategoryName": [
280 "string"
281 ],
282 "requestCategoryId": [
283 0
284 ],
285 "requestCategoryDisplayId": [
286 "string"
287 ],
288 "description": "string",
289 "internalTeamUser": [
290 0
291 ],
292 "members": 0,
293 "mainAssets": [
294 0
295 ],
296 "premiseNames": [
297 "string"
298 ],
299 "internalTeamAvailable": true,
300 "premiseIds": [
301 0
302 ]
303 }
304 ],
305 "internalTeams": [
306 "string"
307 ],
308 "vendorId": 0,
309 "vendorDto": {
310 "id": 0,
311 "createdBy": "string",
312 "createdAt": "2019-08-24T14:15:22Z",
313 "displayId": "string",
314 "name": "string",
315 "description": "string",
316 "address": "string",
317 "contractEndDate": "2019-08-24",
318 "services": "string",
319 "vendorType": "string",
320 "vendorStatusId": 0,
321 "vendorStatus": "string",
322 "vendorStatusType": "string",
323 "businessTypeId": 0,
324 "businessType": "string",
325 "vendorRateId": 0,
326 "vendorRate": "string",
327 "vendorContactIds": [
328 0
329 ],
330 "premiseIds": [
331 0
332 ],
333 "firstPremiseDisplayId": "string",
334 "ownerUserName": "string",
335 "ownerDto": {
336 "id": 0,
337 "createdBy": "string",
338 "createdAt": "2019-08-24T14:15:22Z",
339 "userName": "string",
340 "firstName": "string",
341 "lastName": "string",
342 "email": "string",
343 "roleIds": [
344 {
345 "id": 0,
346 "createdBy": "string",
347 "createdAt": "2019-08-24T14:15:22Z",
348 "modifiedBy": "string",
349 "modifiedAt": "2019-08-24T14:15:22Z",
350 "roleName": "string",
351 "entity": "string",
352 "new": true
353 }
354 ],
355 "internalTeamNames": [
356 "string"
357 ],
358 "internalTeamIds": [
359 0
360 ],
361 "internalTeamDisplayIds": [
362 "string"
363 ],
364 "premiseIds": [
365 0
366 ],
367 "premiseNames": [
368 "string"
369 ],
370 "userAvailable": true,
371 "temporaryWorkload": 0,
372 "preferredCultureCode": "string"
373 },
374 "vendorAvailable": true,
375 "vendorRating": 0.1,
376 "premiseDisplayIds": [
377 "string"
378 ]
379 },
380 "vendorName": "string",
381 "workOrderTemplateSettings": {
382 "id": 0,
383 "createdBy": "string",
384 "createdAt": "2019-08-24T14:15:22Z",
385 "workOrderId": 0,
386 "startDate": "2019-08-24",
387 "dueDuration": 0,
388 "dueMonths": 0,
389 "endDate": "2019-08-24",
390 "recurringWOPriorityId": 0,
391 "recurringWOPriority": "string",
392 "recurringWOPriorityType": "string",
393 "isTemplate": true,
394 "isRemoveByDate": true,
395 "triggerByWorkOrderStatusId": 0,
396 "triggerByWorkOrderStatus": "string",
397 "triggerByWorkOrderStatusType": "string",
398 "removeByWorkOrderStatusId": 0,
399 "removeByWorkOrderStatus": "string",
400 "removeByWorkOrderStatusType": "string"
401 },
402 "assignedUserIds": [
403 0
404 ],
405 "assignedUserDtos": [
406 {
407 "id": 0,
408 "createdBy": "string",
409 "createdAt": "2019-08-24T14:15:22Z",
410 "userName": "string",
411 "firstName": "string",
412 "lastName": "string",
413 "email": "string",
414 "roleIds": [
415 {
416 "id": 0,
417 "createdBy": "string",
418 "createdAt": "2019-08-24T14:15:22Z",
419 "modifiedBy": "string",
420 "modifiedAt": "2019-08-24T14:15:22Z",
421 "roleName": "string",
422 "entity": "string",
423 "new": true
424 }
425 ],
426 "internalTeamNames": [
427 "string"
428 ],
429 "internalTeamIds": [
430 0
431 ],
432 "internalTeamDisplayIds": [
433 "string"
434 ],
435 "premiseIds": [
436 0
437 ],
438 "premiseNames": [
439 "string"
440 ],
441 "userAvailable": true,
442 "temporaryWorkload": 0,
443 "preferredCultureCode": "string"
444 }
445 ],
446 "assignedUsers": [
447 "string"
448 ],
449 "variableQuantity": 0,
450 "workOrderAvailable": true,
451 "exactPlacement": "string",
452 "primaryWorkOrderId": 0,
453 "primaryWorkOrderDto": {},
454 "primaryWorkOrderDisplayId": "string",
455 "isPrimary": true,
456 "invoiceIds": [
457 0
458 ],
459 "createdByTrigger": true,
460 "internalCosts": "81.08",
461 "invoiceTotal": "81.08",
462 "partsTotal": "81.08",
463 "inspectionItemId": 0,
464 "partIdToAttach": 0
465 },
466 "workOrderDisplayId": "string",
467 "reporterDto": {
468 "id": 0,
469 "createdBy": "string",
470 "createdAt": "2019-08-24T14:15:22Z",
471 "userName": "string",
472 "firstName": "string",
473 "lastName": "string",
474 "email": "string",
475 "roleIds": [
476 {
477 "id": 0,
478 "createdBy": "string",
479 "createdAt": "2019-08-24T14:15:22Z",
480 "modifiedBy": "string",
481 "modifiedAt": "2019-08-24T14:15:22Z",
482 "roleName": "string",
483 "entity": "string",
484 "new": true
485 }
486 ],
487 "internalTeamNames": [
488 "string"
489 ],
490 "internalTeamIds": [
491 0
492 ],
493 "internalTeamDisplayIds": [
494 "string"
495 ],
496 "premiseIds": [
497 0
498 ],
499 "premiseNames": [
500 "string"
501 ],
502 "userAvailable": true,
503 "temporaryWorkload": 0,
504 "preferredCultureCode": "string"
505 },
506 "username": "string",
507 "injuredPersonName": "string",
508 "exactLocation": "string",
509 "injuredPersonRole": "string",
510 "incidentTime": {
511 "hour": 0,
512 "minute": 0,
513 "second": 0,
514 "nano": 0
515 },
516 "injuryTypeAndBodyPartAffected": "string",
517 "severity": "string",
518 "premiseId": 0,
519 "premisesDisplayId": "string",
520 "premisesDto": {
521 "id": 0,
522 "createdBy": "string",
523 "createdAt": "2019-08-24T14:15:22Z",
524 "displayId": "string",
525 "premiseName": "string",
526 "description": "string",
527 "address": "string",
528 "internalTeamNames": [
529 "string"
530 ],
531 "internalTeamIds": [
532 0
533 ],
534 "premiseAvailable": true,
535 "premiseFromNrm": true,
536 "nlmId": 0,
537 "nlmDisplayId": "string",
538 "nlmUsed": true,
539 "manager": 0,
540 "managerName": "string",
541 "imageId": 0,
542 "area": "string",
543 "modifiedAt": "2019-08-24T14:15:22Z"
544 },
545 "workerIncidentAvailable": true,
546 "modifiedAt": "2019-08-24T14:15:22Z",
547 "statusId": 0
548}
Update Worker Incident¶
HTTP Request
PUT /api/workerIncidents/{id}
📋 Description: Updates the details of a specific worker incident identified by the provided ID, enabling organizations to maintain accurate records and ensure compliance with safety protocols.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated details of the worker incident, including incident description, status, and relevant timestamps for effective incident management. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "title": "string",
7 "description": "string",
8 "reportDate": "2019-08-24",
9 "statusName": "string",
10 "workOrder": {
11 "id": 0,
12 "createdBy": "string",
13 "createdAt": "2019-08-24T14:15:22Z",
14 "displayId": "string",
15 "name": "string",
16 "imageId": 0,
17 "description": "string",
18 "vendorRating": 0,
19 "premiseId": 0,
20 "premiseDto": {
21 "id": 0,
22 "createdBy": "string",
23 "createdAt": "2019-08-24T14:15:22Z",
24 "displayId": "string",
25 "premiseName": "string",
26 "description": "string",
27 "address": "string",
28 "internalTeamNames": [
29 "string"
30 ],
31 "internalTeamIds": [
32 0
33 ],
34 "premiseAvailable": true,
35 "premiseFromNrm": true,
36 "nlmId": 0,
37 "nlmDisplayId": "string",
38 "nlmUsed": true,
39 "manager": 0,
40 "managerName": "string",
41 "imageId": 0,
42 "area": "string",
43 "modifiedAt": "2019-08-24T14:15:22Z"
44 },
45 "premiseFromNrm": true,
46 "premiseDisplayId": "string",
47 "nssProjectId": 0,
48 "nssTaskId": 0,
49 "nssTaskDisplayId": "string",
50 "orderDate": "2019-08-24",
51 "dueDate": "2019-08-24",
52 "startDate": "2019-08-24",
53 "endDate": "2019-08-24",
54 "startTime": {
55 "hour": 0,
56 "minute": 0,
57 "second": 0,
58 "nano": 0
59 },
60 "endTime": {
61 "hour": 0,
62 "minute": 0,
63 "second": 0,
64 "nano": 0
65 },
66 "modifiedAt": "2019-08-24T14:15:22Z",
67 "estimatedCost": "81.08",
68 "finalCost": "81.08",
69 "duration": 0,
70 "estimatedDayTime": 0,
71 "finalHourTime": "2.5",
72 "estimatedHourTime": "2.5",
73 "closeDate": "2019-08-24",
74 "inspection": "string",
75 "workOrderTypeId": 0,
76 "workOrderTypeName": "string",
77 "workOrderType": "string",
78 "workOrderPriorityId": 0,
79 "workOrderPriority": "string",
80 "workOrderPriorityType": "string",
81 "isTemplate": true,
82 "isWorkOrderTemplate": true,
83 "templateId": 0,
84 "isPartsInSufficient": true,
85 "partQuantityInfoList": [
86 {
87 "partId": 0,
88 "partDisplayId": "string",
89 "requestedQuantity": 0,
90 "availableQuantity": 0,
91 "usedQuantity": 0,
92 "sufficient": true,
93 "partial": true
94 }
95 ],
96 "parentWorkOrderId": 0,
97 "parentWorkOrderDisplayId": "string",
98 "parentWorkOrder": "string",
99 "mainAssetIds": [
100 0
101 ],
102 "mainAssetDto": {
103 "id": 0,
104 "createdBy": "string",
105 "createdAt": "2019-08-24T14:15:22Z",
106 "displayId": "string",
107 "name": "string",
108 "description": "string",
109 "qrCode": "string",
110 "barCode": "string",
111 "imageId": 0,
112 "model": "string",
113 "manufacturer": "string",
114 "serialNumber": "string",
115 "cost": "81.08",
116 "premiseId": 0,
117 "premiseDisplayId": "string",
118 "premiseDto": {
119 "id": 0,
120 "createdBy": "string",
121 "createdAt": "2019-08-24T14:15:22Z",
122 "displayId": "string",
123 "premiseName": "string",
124 "description": "string",
125 "address": "string",
126 "internalTeamNames": [
127 "string"
128 ],
129 "internalTeamIds": [
130 0
131 ],
132 "premiseAvailable": true,
133 "premiseFromNrm": true,
134 "nlmId": 0,
135 "nlmDisplayId": "string",
136 "nlmUsed": true,
137 "manager": 0,
138 "managerName": "string",
139 "imageId": 0,
140 "area": "string",
141 "modifiedAt": "2019-08-24T14:15:22Z"
142 },
143 "acquisitionDate": "2019-08-24",
144 "endOfLife": "2019-08-24",
145 "assetStatusId": 0,
146 "assetStatus": "string",
147 "assetStatusType": "string",
148 "parentAssetId": 0,
149 "parentAssetDisplayId": "string",
150 "parentAsset": "string",
151 "parentAssetDto": {},
152 "upcomingMaintenanceDate": "2019-08-24",
153 "assetCategoryIds": [
154 0
155 ],
156 "assetCategories": [
157 "string"
158 ],
159 "internalTeamIds": [
160 0
161 ],
162 "internalTeamDtos": [
163 {
164 "id": 0,
165 "createdBy": "string",
166 "createdAt": "2019-08-24T14:15:22Z",
167 "displayId": "string",
168 "name": "string",
169 "email": "string",
170 "phone": "string",
171 "manager": "string",
172 "requestCategoryName": [
173 "string"
174 ],
175 "requestCategoryId": [
176 0
177 ],
178 "requestCategoryDisplayId": [
179 "string"
180 ],
181 "description": "string",
182 "internalTeamUser": [
183 0
184 ],
185 "members": 0,
186 "mainAssets": [
187 0
188 ],
189 "premiseNames": [
190 "string"
191 ],
192 "internalTeamAvailable": true,
193 "premiseIds": [
194 0
195 ]
196 }
197 ],
198 "internalTeams": [
199 "string"
200 ],
201 "assignedUserIds": [
202 0
203 ],
204 "assignedUserDtos": [
205 {
206 "id": 0,
207 "createdBy": "string",
208 "createdAt": "2019-08-24T14:15:22Z",
209 "userName": "string",
210 "firstName": "string",
211 "lastName": "string",
212 "email": "string",
213 "roleIds": [
214 {
215 "id": 0,
216 "createdBy": "string",
217 "createdAt": "2019-08-24T14:15:22Z",
218 "modifiedBy": "string",
219 "modifiedAt": "2019-08-24T14:15:22Z",
220 "roleName": "string",
221 "entity": "string",
222 "new": true
223 }
224 ],
225 "internalTeamNames": [
226 "string"
227 ],
228 "internalTeamIds": [
229 0
230 ],
231 "internalTeamDisplayIds": [
232 "string"
233 ],
234 "premiseIds": [
235 0
236 ],
237 "premiseNames": [
238 "string"
239 ],
240 "userAvailable": true,
241 "temporaryWorkload": 0,
242 "preferredCultureCode": "string"
243 }
244 ],
245 "assignedUsers": [
246 "string"
247 ],
248 "assetPriority": "string",
249 "assetPriorityId": 0,
250 "assetPriorityDisplayId": "string",
251 "assetPriorityType": "string",
252 "assetAvailable": true,
253 "exactPlacement": "string",
254 "fosId": 0,
255 "downtimeStatus": "string",
256 "premiseFromNrm": true,
257 "modifiedAt": "2019-08-24T14:15:22Z"
258 },
259 "mainAssetDisplayId": "string",
260 "workOrderStatusId": 0,
261 "workOrderStatus": "string",
262 "workOrderStatusType": "string",
263 "requestIds": [
264 0
265 ],
266 "internalTeamIds": [
267 0
268 ],
269 "internalTeamDtos": [
270 {
271 "id": 0,
272 "createdBy": "string",
273 "createdAt": "2019-08-24T14:15:22Z",
274 "displayId": "string",
275 "name": "string",
276 "email": "string",
277 "phone": "string",
278 "manager": "string",
279 "requestCategoryName": [
280 "string"
281 ],
282 "requestCategoryId": [
283 0
284 ],
285 "requestCategoryDisplayId": [
286 "string"
287 ],
288 "description": "string",
289 "internalTeamUser": [
290 0
291 ],
292 "members": 0,
293 "mainAssets": [
294 0
295 ],
296 "premiseNames": [
297 "string"
298 ],
299 "internalTeamAvailable": true,
300 "premiseIds": [
301 0
302 ]
303 }
304 ],
305 "internalTeams": [
306 "string"
307 ],
308 "vendorId": 0,
309 "vendorDto": {
310 "id": 0,
311 "createdBy": "string",
312 "createdAt": "2019-08-24T14:15:22Z",
313 "displayId": "string",
314 "name": "string",
315 "description": "string",
316 "address": "string",
317 "contractEndDate": "2019-08-24",
318 "services": "string",
319 "vendorType": "string",
320 "vendorStatusId": 0,
321 "vendorStatus": "string",
322 "vendorStatusType": "string",
323 "businessTypeId": 0,
324 "businessType": "string",
325 "vendorRateId": 0,
326 "vendorRate": "string",
327 "vendorContactIds": [
328 0
329 ],
330 "premiseIds": [
331 0
332 ],
333 "firstPremiseDisplayId": "string",
334 "ownerUserName": "string",
335 "ownerDto": {
336 "id": 0,
337 "createdBy": "string",
338 "createdAt": "2019-08-24T14:15:22Z",
339 "userName": "string",
340 "firstName": "string",
341 "lastName": "string",
342 "email": "string",
343 "roleIds": [
344 {
345 "id": 0,
346 "createdBy": "string",
347 "createdAt": "2019-08-24T14:15:22Z",
348 "modifiedBy": "string",
349 "modifiedAt": "2019-08-24T14:15:22Z",
350 "roleName": "string",
351 "entity": "string",
352 "new": true
353 }
354 ],
355 "internalTeamNames": [
356 "string"
357 ],
358 "internalTeamIds": [
359 0
360 ],
361 "internalTeamDisplayIds": [
362 "string"
363 ],
364 "premiseIds": [
365 0
366 ],
367 "premiseNames": [
368 "string"
369 ],
370 "userAvailable": true,
371 "temporaryWorkload": 0,
372 "preferredCultureCode": "string"
373 },
374 "vendorAvailable": true,
375 "vendorRating": 0.1,
376 "premiseDisplayIds": [
377 "string"
378 ]
379 },
380 "vendorName": "string",
381 "workOrderTemplateSettings": {
382 "id": 0,
383 "createdBy": "string",
384 "createdAt": "2019-08-24T14:15:22Z",
385 "workOrderId": 0,
386 "startDate": "2019-08-24",
387 "dueDuration": 0,
388 "dueMonths": 0,
389 "endDate": "2019-08-24",
390 "recurringWOPriorityId": 0,
391 "recurringWOPriority": "string",
392 "recurringWOPriorityType": "string",
393 "isTemplate": true,
394 "isRemoveByDate": true,
395 "triggerByWorkOrderStatusId": 0,
396 "triggerByWorkOrderStatus": "string",
397 "triggerByWorkOrderStatusType": "string",
398 "removeByWorkOrderStatusId": 0,
399 "removeByWorkOrderStatus": "string",
400 "removeByWorkOrderStatusType": "string"
401 },
402 "assignedUserIds": [
403 0
404 ],
405 "assignedUserDtos": [
406 {
407 "id": 0,
408 "createdBy": "string",
409 "createdAt": "2019-08-24T14:15:22Z",
410 "userName": "string",
411 "firstName": "string",
412 "lastName": "string",
413 "email": "string",
414 "roleIds": [
415 {
416 "id": 0,
417 "createdBy": "string",
418 "createdAt": "2019-08-24T14:15:22Z",
419 "modifiedBy": "string",
420 "modifiedAt": "2019-08-24T14:15:22Z",
421 "roleName": "string",
422 "entity": "string",
423 "new": true
424 }
425 ],
426 "internalTeamNames": [
427 "string"
428 ],
429 "internalTeamIds": [
430 0
431 ],
432 "internalTeamDisplayIds": [
433 "string"
434 ],
435 "premiseIds": [
436 0
437 ],
438 "premiseNames": [
439 "string"
440 ],
441 "userAvailable": true,
442 "temporaryWorkload": 0,
443 "preferredCultureCode": "string"
444 }
445 ],
446 "assignedUsers": [
447 "string"
448 ],
449 "variableQuantity": 0,
450 "workOrderAvailable": true,
451 "exactPlacement": "string",
452 "primaryWorkOrderId": 0,
453 "primaryWorkOrderDto": {},
454 "primaryWorkOrderDisplayId": "string",
455 "isPrimary": true,
456 "invoiceIds": [
457 0
458 ],
459 "createdByTrigger": true,
460 "internalCosts": "81.08",
461 "invoiceTotal": "81.08",
462 "partsTotal": "81.08",
463 "inspectionItemId": 0,
464 "partIdToAttach": 0,
465 "recurringWOIsTemplate": true,
466 "recurringWOStartDate": "2019-08-24",
467 "recurringWOEndDate": "2019-08-24",
468 "recurringWODueDuration": 0,
469 "recurringWODueMonths": 0,
470 "recurringWOPriority": "string",
471 "recurringWOIsRemoveByDate": true,
472 "triggerByWorkOrderStatus": "string",
473 "removeByWorkOrderStatus": "string",
474 "recurringWOPriorityType": "string",
475 "triggerByWorkOrderStatusType": "string",
476 "removeByWorkOrderStatusType": "string",
477 "recurringWOPriorityId": 0,
478 "triggerByWorkOrderStatusId": 0,
479 "removeByWorkOrderStatusId": 0
480 },
481 "workOrderDisplayId": "string",
482 "reporterDto": {
483 "id": 0,
484 "createdBy": "string",
485 "createdAt": "2019-08-24T14:15:22Z",
486 "userName": "string",
487 "firstName": "string",
488 "lastName": "string",
489 "email": "string",
490 "roleIds": [
491 {
492 "id": 0,
493 "createdBy": "string",
494 "createdAt": "2019-08-24T14:15:22Z",
495 "modifiedBy": "string",
496 "modifiedAt": "2019-08-24T14:15:22Z",
497 "roleName": "string",
498 "entity": "string",
499 "new": true
500 }
501 ],
502 "internalTeamNames": [
503 "string"
504 ],
505 "internalTeamIds": [
506 0
507 ],
508 "internalTeamDisplayIds": [
509 "string"
510 ],
511 "premiseIds": [
512 0
513 ],
514 "premiseNames": [
515 "string"
516 ],
517 "userAvailable": true,
518 "temporaryWorkload": 0,
519 "preferredCultureCode": "string"
520 },
521 "username": "string",
522 "injuredPersonName": "string",
523 "exactLocation": "string",
524 "injuredPersonRole": "string",
525 "incidentTime": {
526 "hour": 0,
527 "minute": 0,
528 "second": 0,
529 "nano": 0
530 },
531 "injuryTypeAndBodyPartAffected": "string",
532 "severity": "string",
533 "premiseId": 0,
534 "premisesDisplayId": "string",
535 "premisesDto": {
536 "id": 0,
537 "createdBy": "string",
538 "createdAt": "2019-08-24T14:15:22Z",
539 "displayId": "string",
540 "premiseName": "string",
541 "description": "string",
542 "address": "string",
543 "internalTeamNames": [
544 "string"
545 ],
546 "internalTeamIds": [
547 0
548 ],
549 "premiseAvailable": true,
550 "premiseFromNrm": true,
551 "nlmId": 0,
552 "nlmDisplayId": "string",
553 "nlmUsed": true,
554 "manager": 0,
555 "managerName": "string",
556 "imageId": 0,
557 "area": "string",
558 "modifiedAt": "2019-08-24T14:15:22Z"
559 },
560 "workerIncidentAvailable": true,
561 "modifiedAt": "2019-08-24T14:15:22Z",
562 "statusId": 0
563}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Worker Incident¶
HTTP Request
DELETE /api/workerIncidents/{id}
📋 Description: Deletes a specific worker incident identified by the provided ID, ensuring the removal of outdated or irrelevant records from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get All Worker Incidents¶
HTTP Request
GET /api/workerIncidents
📋 Description: Retrieves a list of worker incidents, providing insights into workforce safety and operational efficiency.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "title": "string",
8 "description": "string",
9 "reportDate": "2019-08-24",
10 "statusName": "string",
11 "workOrder": {
12 "id": 0,
13 "createdBy": "string",
14 "createdAt": "2019-08-24T14:15:22Z",
15 "displayId": "string",
16 "name": "string",
17 "imageId": 0,
18 "description": "string",
19 "vendorRating": 0,
20 "premiseId": 0,
21 "premiseDto": {
22 "id": 0,
23 "createdBy": "string",
24 "createdAt": "2019-08-24T14:15:22Z",
25 "displayId": "string",
26 "premiseName": "string",
27 "description": "string",
28 "address": "string",
29 "internalTeamNames": [
30 "string"
31 ],
32 "internalTeamIds": [
33 0
34 ],
35 "premiseAvailable": true,
36 "premiseFromNrm": true,
37 "nlmId": 0,
38 "nlmDisplayId": "string",
39 "nlmUsed": true,
40 "manager": 0,
41 "managerName": "string",
42 "imageId": 0,
43 "area": "string",
44 "modifiedAt": "2019-08-24T14:15:22Z"
45 },
46 "premiseFromNrm": true,
47 "premiseDisplayId": "string",
48 "nssProjectId": 0,
49 "nssTaskId": 0,
50 "nssTaskDisplayId": "string",
51 "orderDate": "2019-08-24",
52 "dueDate": "2019-08-24",
53 "startDate": "2019-08-24",
54 "endDate": "2019-08-24",
55 "startTime": {
56 "hour": 0,
57 "minute": 0,
58 "second": 0,
59 "nano": 0
60 },
61 "endTime": {
62 "hour": 0,
63 "minute": 0,
64 "second": 0,
65 "nano": 0
66 },
67 "modifiedAt": "2019-08-24T14:15:22Z",
68 "estimatedCost": "81.08",
69 "finalCost": "81.08",
70 "duration": 0,
71 "estimatedDayTime": 0,
72 "finalHourTime": "2.5",
73 "estimatedHourTime": "2.5",
74 "closeDate": "2019-08-24",
75 "inspection": "string",
76 "workOrderTypeId": 0,
77 "workOrderTypeName": "string",
78 "workOrderType": "string",
79 "workOrderPriorityId": 0,
80 "workOrderPriority": "string",
81 "workOrderPriorityType": "string",
82 "isTemplate": true,
83 "isWorkOrderTemplate": true,
84 "templateId": 0,
85 "isPartsInSufficient": true,
86 "partQuantityInfoList": [
87 {
88 "partId": 0,
89 "partDisplayId": "string",
90 "requestedQuantity": 0,
91 "availableQuantity": 0,
92 "usedQuantity": 0,
93 "sufficient": true,
94 "partial": true
95 }
96 ],
97 "parentWorkOrderId": 0,
98 "parentWorkOrderDisplayId": "string",
99 "parentWorkOrder": "string",
100 "mainAssetIds": [
101 0
102 ],
103 "mainAssetDto": {
104 "id": 0,
105 "createdBy": "string",
106 "createdAt": "2019-08-24T14:15:22Z",
107 "displayId": "string",
108 "name": "string",
109 "description": "string",
110 "qrCode": "string",
111 "barCode": "string",
112 "imageId": 0,
113 "model": "string",
114 "manufacturer": "string",
115 "serialNumber": "string",
116 "cost": "81.08",
117 "premiseId": 0,
118 "premiseDisplayId": "string",
119 "premiseDto": {
120 "id": 0,
121 "createdBy": "string",
122 "createdAt": "2019-08-24T14:15:22Z",
123 "displayId": "string",
124 "premiseName": "string",
125 "description": "string",
126 "address": "string",
127 "internalTeamNames": [
128 "string"
129 ],
130 "internalTeamIds": [
131 0
132 ],
133 "premiseAvailable": true,
134 "premiseFromNrm": true,
135 "nlmId": 0,
136 "nlmDisplayId": "string",
137 "nlmUsed": true,
138 "manager": 0,
139 "managerName": "string",
140 "imageId": 0,
141 "area": "string",
142 "modifiedAt": "2019-08-24T14:15:22Z"
143 },
144 "acquisitionDate": "2019-08-24",
145 "endOfLife": "2019-08-24",
146 "assetStatusId": 0,
147 "assetStatus": "string",
148 "assetStatusType": "string",
149 "parentAssetId": 0,
150 "parentAssetDisplayId": "string",
151 "parentAsset": "string",
152 "parentAssetDto": {},
153 "upcomingMaintenanceDate": "2019-08-24",
154 "assetCategoryIds": [
155 0
156 ],
157 "assetCategories": [
158 "string"
159 ],
160 "internalTeamIds": [
161 0
162 ],
163 "internalTeamDtos": [
164 {
165 "id": 0,
166 "createdBy": "string",
167 "createdAt": "2019-08-24T14:15:22Z",
168 "displayId": "string",
169 "name": "string",
170 "email": "string",
171 "phone": "string",
172 "manager": "string",
173 "requestCategoryName": [
174 "string"
175 ],
176 "requestCategoryId": [
177 0
178 ],
179 "requestCategoryDisplayId": [
180 "string"
181 ],
182 "description": "string",
183 "internalTeamUser": [
184 0
185 ],
186 "members": 0,
187 "mainAssets": [
188 0
189 ],
190 "premiseNames": [
191 "string"
192 ],
193 "internalTeamAvailable": true,
194 "premiseIds": [
195 0
196 ]
197 }
198 ],
199 "internalTeams": [
200 "string"
201 ],
202 "assignedUserIds": [
203 0
204 ],
205 "assignedUserDtos": [
206 {
207 "id": 0,
208 "createdBy": "string",
209 "createdAt": "2019-08-24T14:15:22Z",
210 "userName": "string",
211 "firstName": "string",
212 "lastName": "string",
213 "email": "string",
214 "roleIds": [
215 {
216 "id": 0,
217 "createdBy": "string",
218 "createdAt": "2019-08-24T14:15:22Z",
219 "modifiedBy": "string",
220 "modifiedAt": "2019-08-24T14:15:22Z",
221 "roleName": "string",
222 "entity": "string",
223 "new": true
224 }
225 ],
226 "internalTeamNames": [
227 "string"
228 ],
229 "internalTeamIds": [
230 0
231 ],
232 "internalTeamDisplayIds": [
233 "string"
234 ],
235 "premiseIds": [
236 0
237 ],
238 "premiseNames": [
239 "string"
240 ],
241 "userAvailable": true,
242 "temporaryWorkload": 0,
243 "preferredCultureCode": "string"
244 }
245 ],
246 "assignedUsers": [
247 "string"
248 ],
249 "assetPriority": "string",
250 "assetPriorityId": 0,
251 "assetPriorityDisplayId": "string",
252 "assetPriorityType": "string",
253 "assetAvailable": true,
254 "exactPlacement": "string",
255 "fosId": 0,
256 "downtimeStatus": "string",
257 "premiseFromNrm": true,
258 "modifiedAt": "2019-08-24T14:15:22Z"
259 },
260 "mainAssetDisplayId": "string",
261 "workOrderStatusId": 0,
262 "workOrderStatus": "string",
263 "workOrderStatusType": "string",
264 "requestIds": [
265 0
266 ],
267 "internalTeamIds": [
268 0
269 ],
270 "internalTeamDtos": [
271 {
272 "id": 0,
273 "createdBy": "string",
274 "createdAt": "2019-08-24T14:15:22Z",
275 "displayId": "string",
276 "name": "string",
277 "email": "string",
278 "phone": "string",
279 "manager": "string",
280 "requestCategoryName": [
281 "string"
282 ],
283 "requestCategoryId": [
284 0
285 ],
286 "requestCategoryDisplayId": [
287 "string"
288 ],
289 "description": "string",
290 "internalTeamUser": [
291 0
292 ],
293 "members": 0,
294 "mainAssets": [
295 0
296 ],
297 "premiseNames": [
298 "string"
299 ],
300 "internalTeamAvailable": true,
301 "premiseIds": [
302 0
303 ]
304 }
305 ],
306 "internalTeams": [
307 "string"
308 ],
309 "vendorId": 0,
310 "vendorDto": {
311 "id": 0,
312 "createdBy": "string",
313 "createdAt": "2019-08-24T14:15:22Z",
314 "displayId": "string",
315 "name": "string",
316 "description": "string",
317 "address": "string",
318 "contractEndDate": "2019-08-24",
319 "services": "string",
320 "vendorType": "string",
321 "vendorStatusId": 0,
322 "vendorStatus": "string",
323 "vendorStatusType": "string",
324 "businessTypeId": 0,
325 "businessType": "string",
326 "vendorRateId": 0,
327 "vendorRate": "string",
328 "vendorContactIds": [
329 0
330 ],
331 "premiseIds": [
332 0
333 ],
334 "firstPremiseDisplayId": "string",
335 "ownerUserName": "string",
336 "ownerDto": {
337 "id": 0,
338 "createdBy": "string",
339 "createdAt": "2019-08-24T14:15:22Z",
340 "userName": "string",
341 "firstName": "string",
342 "lastName": "string",
343 "email": "string",
344 "roleIds": [
345 {
346 "id": 0,
347 "createdBy": "string",
348 "createdAt": "2019-08-24T14:15:22Z",
349 "modifiedBy": "string",
350 "modifiedAt": "2019-08-24T14:15:22Z",
351 "roleName": "string",
352 "entity": "string",
353 "new": true
354 }
355 ],
356 "internalTeamNames": [
357 "string"
358 ],
359 "internalTeamIds": [
360 0
361 ],
362 "internalTeamDisplayIds": [
363 "string"
364 ],
365 "premiseIds": [
366 0
367 ],
368 "premiseNames": [
369 "string"
370 ],
371 "userAvailable": true,
372 "temporaryWorkload": 0,
373 "preferredCultureCode": "string"
374 },
375 "vendorAvailable": true,
376 "vendorRating": 0.1,
377 "premiseDisplayIds": [
378 "string"
379 ]
380 },
381 "vendorName": "string",
382 "workOrderTemplateSettings": {
383 "id": 0,
384 "createdBy": "string",
385 "createdAt": "2019-08-24T14:15:22Z",
386 "workOrderId": 0,
387 "startDate": "2019-08-24",
388 "dueDuration": 0,
389 "dueMonths": 0,
390 "endDate": "2019-08-24",
391 "recurringWOPriorityId": 0,
392 "recurringWOPriority": "string",
393 "recurringWOPriorityType": "string",
394 "isTemplate": true,
395 "isRemoveByDate": true,
396 "triggerByWorkOrderStatusId": 0,
397 "triggerByWorkOrderStatus": "string",
398 "triggerByWorkOrderStatusType": "string",
399 "removeByWorkOrderStatusId": 0,
400 "removeByWorkOrderStatus": "string",
401 "removeByWorkOrderStatusType": "string"
402 },
403 "assignedUserIds": [
404 0
405 ],
406 "assignedUserDtos": [
407 {
408 "id": 0,
409 "createdBy": "string",
410 "createdAt": "2019-08-24T14:15:22Z",
411 "userName": "string",
412 "firstName": "string",
413 "lastName": "string",
414 "email": "string",
415 "roleIds": [
416 {
417 "id": 0,
418 "createdBy": "string",
419 "createdAt": "2019-08-24T14:15:22Z",
420 "modifiedBy": "string",
421 "modifiedAt": "2019-08-24T14:15:22Z",
422 "roleName": "string",
423 "entity": "string",
424 "new": true
425 }
426 ],
427 "internalTeamNames": [
428 "string"
429 ],
430 "internalTeamIds": [
431 0
432 ],
433 "internalTeamDisplayIds": [
434 "string"
435 ],
436 "premiseIds": [
437 0
438 ],
439 "premiseNames": [
440 "string"
441 ],
442 "userAvailable": true,
443 "temporaryWorkload": 0,
444 "preferredCultureCode": "string"
445 }
446 ],
447 "assignedUsers": [
448 "string"
449 ],
450 "variableQuantity": 0,
451 "workOrderAvailable": true,
452 "exactPlacement": "string",
453 "primaryWorkOrderId": 0,
454 "primaryWorkOrderDto": {},
455 "primaryWorkOrderDisplayId": "string",
456 "isPrimary": true,
457 "invoiceIds": [
458 0
459 ],
460 "createdByTrigger": true,
461 "internalCosts": "81.08",
462 "invoiceTotal": "81.08",
463 "partsTotal": "81.08",
464 "inspectionItemId": 0,
465 "partIdToAttach": 0
466 },
467 "workOrderDisplayId": "string",
468 "reporterDto": {
469 "id": 0,
470 "createdBy": "string",
471 "createdAt": "2019-08-24T14:15:22Z",
472 "userName": "string",
473 "firstName": "string",
474 "lastName": "string",
475 "email": "string",
476 "roleIds": [
477 {
478 "id": 0,
479 "createdBy": "string",
480 "createdAt": "2019-08-24T14:15:22Z",
481 "modifiedBy": "string",
482 "modifiedAt": "2019-08-24T14:15:22Z",
483 "roleName": "string",
484 "entity": "string",
485 "new": true
486 }
487 ],
488 "internalTeamNames": [
489 "string"
490 ],
491 "internalTeamIds": [
492 0
493 ],
494 "internalTeamDisplayIds": [
495 "string"
496 ],
497 "premiseIds": [
498 0
499 ],
500 "premiseNames": [
501 "string"
502 ],
503 "userAvailable": true,
504 "temporaryWorkload": 0,
505 "preferredCultureCode": "string"
506 },
507 "username": "string",
508 "injuredPersonName": "string",
509 "exactLocation": "string",
510 "injuredPersonRole": "string",
511 "incidentTime": {
512 "hour": 0,
513 "minute": 0,
514 "second": 0,
515 "nano": 0
516 },
517 "injuryTypeAndBodyPartAffected": "string",
518 "severity": "string",
519 "premiseId": 0,
520 "premisesDisplayId": "string",
521 "premisesDto": {
522 "id": 0,
523 "createdBy": "string",
524 "createdAt": "2019-08-24T14:15:22Z",
525 "displayId": "string",
526 "premiseName": "string",
527 "description": "string",
528 "address": "string",
529 "internalTeamNames": [
530 "string"
531 ],
532 "internalTeamIds": [
533 0
534 ],
535 "premiseAvailable": true,
536 "premiseFromNrm": true,
537 "nlmId": 0,
538 "nlmDisplayId": "string",
539 "nlmUsed": true,
540 "manager": 0,
541 "managerName": "string",
542 "imageId": 0,
543 "area": "string",
544 "modifiedAt": "2019-08-24T14:15:22Z"
545 },
546 "workerIncidentAvailable": true,
547 "modifiedAt": "2019-08-24T14:15:22Z",
548 "statusId": 0
549 }
550]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an incident involving a worker, encapsulating relevant details such as incident type, date, and associated metadata for effective incident management and reporting.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» title |
string |
false |
none |
Title of the resource |
» description |
string |
false |
none |
Description of the resource |
» reportDate |
string(date) |
false |
none |
Date of the report |
» statusName |
string |
false |
none |
Name of the status |
» workOrder |
false |
none |
Data transfer object representing a work order, encapsulating essential details such as task specifications, assigned resources, and status updates to facilitate efficient project management and operational workflow. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» name |
string |
false |
none |
Name of the resource |
»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»» description |
string |
false |
none |
Description of the resource |
»» vendorRating |
integer(int32) |
false |
none |
Represents the numerical rating assigned to a vendor, reflecting their performance and reliability in fulfilling work orders. |
»» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
»» premiseDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» premiseName |
string |
false |
none |
Name of the premise |
»»» description |
string |
false |
none |
Description of the resource |
»»» address |
string |
true |
none |
Represents the physical location associated with the premise, essential for logistics and service delivery. |
»»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation within the organization. |
»»» internalTeamIds |
[integer] |
false |
none |
List of unique identifiers representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation. |
»»» premiseAvailable |
boolean |
false |
none |
Indicates whether the premise is available for use within the specified context. |
»»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the premise is sourced from the National Resource Management (NRM) framework, facilitating compliance and reporting within environmental management processes. |
»»» nlmId |
integer(int64) |
false |
none |
Unique identifier for the nlm |
»»» nlmDisplayId |
string |
false |
none |
Unique identifier for the nlm display |
»»» nlmUsed |
boolean |
false |
none |
Indicates whether the National Labor Market (NLM) resources have been utilized in the premise evaluation process. |
»»» manager |
integer(int64) |
false |
none |
Unique identifier for the manager associated with the premise, facilitating effective organizational hierarchy and resource management. |
»»» managerName |
string |
false |
none |
Name of the manager |
»»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»»» area |
string |
false |
none |
Represents the geographic area associated with the premise, providing essential context for location-based services and analysis. |
»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the work order is derived from the National Resource Management system. |
»» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
»» nssProjectId |
integer(int64) |
false |
none |
Unique identifier for the nss project |
»» nssTaskId |
integer(int64) |
false |
none |
Unique identifier for the nss task |
»» nssTaskDisplayId |
string |
false |
none |
Unique identifier for the nss task display |
»» orderDate |
string(date) |
false |
none |
Date of the order |
»» dueDate |
string(date) |
false |
none |
Due date of the resource |
»» startDate |
string(date) |
false |
none |
Start date of the resource |
»» endDate |
string(date) |
false |
none |
End date of the resource |
»» startTime |
false |
none |
Data transfer object representing the local time settings relevant to business operations, ensuring accurate scheduling and time management across various regions. |
|
»»» hour |
integer(int32) |
false |
none |
Represents the hour component of a time value, facilitating precise scheduling and time management within the application. |
»»» minute |
integer(int32) |
false |
none |
Represents the minute component of a local time value, facilitating precise time tracking and scheduling within the application. |
»»» second |
integer(int32) |
false |
none |
Represents the seconds component of a local time value, facilitating precise time tracking and scheduling within the application. |
»»» nano |
integer(int32) |
false |
none |
Represents the nanosecond component of a local time value, facilitating precise time tracking and scheduling within the application. |
»» endTime |
false |
none |
Data transfer object representing the local time settings relevant to business operations, ensuring accurate scheduling and time management across various regions. |
|
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»» estimatedCost |
string |
false |
none |
Estimated cost associated with the work order, providing a financial projection for budgeting and resource allocation. |
»» finalCost |
string |
false |
none |
The finalCost field represents the total cost associated with the completion of a work order, providing essential financial insights for project budgeting and resource allocation. |
»» duration |
integer(int32) |
false |
none |
Represents the total time, in minutes, allocated for the completion of the work order. |
»» estimatedDayTime |
integer(int32) |
false |
none |
Time of the estimated day |
»» finalHourTime |
string |
false |
none |
Time of the final hour |
»» estimatedHourTime |
string |
false |
none |
Time of the estimated hour |
»» closeDate |
string(date) |
false |
none |
Date of the close |
»» inspection |
string |
false |
none |
Describes the specific inspection details associated with the work order, ensuring clarity in task requirements and compliance standards. |
»» workOrderTypeId |
integer(int64) |
false |
none |
Unique identifier for the work order type |
»» workOrderTypeName |
string |
false |
none |
Name of the work order type |
»» workOrderType |
string |
false |
none |
Type of the work order |
»» workOrderPriorityId |
integer(int64) |
false |
none |
Unique identifier for the work order priority |
»» workOrderPriority |
string |
false |
none |
Priority of the work order |
»» workOrderPriorityType |
string |
false |
none |
Type of the work order priority |
»» isTemplate |
boolean |
false |
none |
Whether the resource is template |
»» isWorkOrderTemplate |
boolean |
false |
none |
Whether the resource is work order template |
»» templateId |
integer(int64) |
false |
none |
Unique identifier for the template |
»» isPartsInSufficient |
boolean |
false |
none |
Whether the resource is parts in sufficient |
»» partQuantityInfoList |
false |
none |
List of quantities for each part associated with the work order, providing essential details for inventory management and resource allocation. |
|
»»» partId |
integer(int64) |
false |
none |
Unique identifier for the part |
»»» partDisplayId |
string |
false |
none |
Unique identifier for the part display |
»»» requestedQuantity |
integer(int64) |
false |
none |
Quantity of requested quantity |
»»» availableQuantity |
integer(int64) |
false |
none |
Quantity of available quantity |
»»» usedQuantity |
integer(int64) |
false |
none |
Quantity of used quantity |
»»» sufficient |
boolean |
false |
none |
Indicates whether the quantity of parts available meets the required threshold for operational needs. |
»»» partial |
boolean |
false |
none |
Indicates whether the quantity of parts is partially fulfilled, providing insight into inventory status and order fulfillment. |
»» parentWorkOrderId |
integer(int64) |
false |
none |
Unique identifier for the parent work order |
»» parentWorkOrderDisplayId |
string |
false |
none |
Unique identifier for the parent work order display |
»» parentWorkOrder |
string |
false |
none |
Identifier for the parent work order, establishing a hierarchical relationship within the work order management system. |
»» mainAssetIds |
[integer] |
false |
none |
Array of unique identifiers for the primary assets associated with the work order, facilitating effective asset management and tracking. |
»» mainAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» name |
string |
false |
none |
Name of the resource |
»»» description |
string |
false |
none |
Description of the resource |
»»» qrCode |
string |
false |
none |
Code for the qr |
»»» barCode |
string |
false |
none |
Code for the bar |
»»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»»» model |
string |
false |
none |
Specifies the model associated with the main asset, providing essential context for asset classification and management. |
»»» manufacturer |
string |
false |
none |
Name of the manufacturer associated with the asset, providing essential information for inventory management and supplier relations. |
»»» serialNumber |
string |
false |
none |
Unique identifier for the asset, used to track and manage inventory within the system. |
»»» cost |
string |
false |
none |
Represents the total cost associated with the main asset, providing essential financial information for budgeting and resource allocation. |
»»» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
»»» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
»»» premiseDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
»»» acquisitionDate |
string(date) |
false |
none |
Date of the acquisition |
»»» endOfLife |
string(date) |
false |
none |
Indicates the end-of-life date for the asset, providing critical information for lifecycle management and planning. |
»»» assetStatusId |
integer(int64) |
false |
none |
Unique identifier for the asset status |
»»» assetStatus |
string |
false |
none |
Status of the asset |
»»» assetStatusType |
string |
false |
none |
Type of the asset status |
»»» parentAssetId |
integer(int64) |
false |
none |
Unique identifier for the parent asset |
»»» parentAssetDisplayId |
string |
false |
none |
Unique identifier for the parent asset display |
»»» parentAsset |
string |
false |
none |
Identifier for the parent asset associated with the main asset, facilitating hierarchical relationships within asset management. |
»»» parentAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»»» upcomingMaintenanceDate |
string(date) |
false |
none |
Date of the upcoming maintenance |
»»» assetCategoryIds |
[integer] |
false |
none |
Array of unique identifiers representing the categories to which the asset belongs, facilitating effective asset classification and management. |
»»» assetCategories |
[string] |
false |
none |
Array of asset categories that classify the main assets within the system, facilitating better organization and management of asset data. |
»»» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the main asset, facilitating streamlined collaboration and resource allocation. |
»»» internalTeamDtos |
false |
none |
An array of MainAssetDTO objects representing the internal teams associated with the asset, facilitating effective resource management and collaboration within the organization. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»»» name |
string |
false |
none |
Name of the resource |
string |
false |
none |
Email address of the internal team member, used for communication and notifications within the organization. |
|
»»»» phone |
string |
false |
none |
Contact number for the internal team, facilitating communication and collaboration within the organization. |
»»»» manager |
string |
false |
none |
Represents the name or identifier of the team manager responsible for overseeing the internal team. |
»»»» requestCategoryName |
[string] |
false |
none |
Name of the request category |
»»»» requestCategoryId |
[integer] |
false |
none |
Unique identifier for the request category |
»»»» requestCategoryDisplayId |
[string] |
false |
none |
Unique identifier for the request category display |
»»»» description |
string |
false |
none |
Description of the resource |
»»»» internalTeamUser |
[integer] |
false |
none |
An array of InternalTeamDTO objects representing the users within the internal team, facilitating collaboration and resource management. |
»»»» members |
integer(int32) |
false |
none |
Represents the total number of members within the internal team, providing insight into team size for resource allocation and management. |
»»»» mainAssets |
[integer] |
false |
none |
An array of internal team assets that represent the key resources and capabilities utilized within the organization. |
»»»» premiseNames |
[string] |
false |
none |
List of names associated with the premises relevant to the internal team, facilitating efficient identification and management of locations within the organization. |
»»»» internalTeamAvailable |
boolean |
false |
none |
Indicates the availability of the internal team for project allocation and resource planning. |
»»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the internal team. |
»»» internalTeams |
[string] |
false |
none |
An array of internal teams associated with the main asset, facilitating collaboration and resource allocation within the organization. |
»»» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers representing users assigned to the main asset, facilitating effective resource management and accountability. |
»»» assignedUserDtos |
false |
none |
Array of user assignments associated with the main asset, providing insights into resource allocation and accountability. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»»» userName |
string |
false |
none |
Name of the user |
»»»» firstName |
string |
false |
none |
Name of the first |
»»»» lastName |
string |
false |
none |
Name of the last |
string |
false |
none |
Email address of the user, used for communication and account verification purposes within the system. |
|
»»»» roleIds |
false |
none |
Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system. |
|
»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»»»» modifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»»»»» roleName |
string |
false |
none |
Name of the role |
»»»»» entity |
string |
false |
none |
Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management. |
»»»»» new |
boolean |
false |
none |
Indicates whether the role is newly created within the system, facilitating effective management of organizational changes. |
»»»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization. |
»»»» internalTeamIds |
[integer] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization. |
»»»» internalTeamDisplayIds |
[string] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration. |
»»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations. |
»»»» premiseNames |
[string] |
false |
none |
List of names associated with the user’s premises, providing essential context for location-based services and operations. |
»»»» userAvailable |
boolean |
false |
none |
Indicates whether the user is available for assignment or engagement within the system. |
»»»» temporaryWorkload |
integer(int32) |
false |
none |
Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning. |
»»»» preferredCultureCode |
string |
false |
none |
Code for the preferred culture |
»»» assignedUsers |
[string] |
false |
none |
List of users assigned to the main asset, facilitating effective resource management and collaboration within the organization. |
»»» assetPriority |
string |
false |
none |
Priority of the asset |
»»» assetPriorityId |
integer(int64) |
false |
none |
Unique identifier for the asset priority |
»»» assetPriorityDisplayId |
string |
false |
none |
Unique identifier for the asset priority display |
»»» assetPriorityType |
string |
false |
none |
Type of the asset priority |
»»» assetAvailable |
boolean |
false |
none |
Indicates whether the asset is currently available for allocation or use within the system. |
»»» exactPlacement |
string |
false |
none |
Specifies the precise location or context in which the main asset is intended to be utilized within the business framework. |
»»» fosId |
integer(int64) |
false |
none |
Unique identifier for the fos |
»»» downtimeStatus |
string |
false |
none |
Status of the downtime |
»»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the asset is sourced from the National Resource Management (NRM) framework, facilitating compliance and resource tracking. |
»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»» mainAssetDisplayId |
string |
false |
none |
Unique identifier for the main asset display |
»» workOrderStatusId |
integer(int64) |
false |
none |
Unique identifier for the work order status |
»» workOrderStatus |
string |
false |
none |
Status of the work order |
»» workOrderStatusType |
string |
false |
none |
Type of the work order status |
»» requestIds |
[integer] |
false |
none |
An array of unique identifiers for the associated work orders, facilitating tracking and management within the system. |
»» internalTeamIds |
[integer] |
false |
none |
List of unique identifiers representing the internal teams associated with the work order, facilitating effective resource allocation and collaboration. |
»» internalTeamDtos |
false |
none |
An array of WorkOrderDTO objects representing the internal teams associated with the work order, facilitating efficient resource allocation and management. |
|
»» internalTeams |
[string] |
false |
none |
List of internal teams associated with the work order, facilitating collaboration and resource allocation within the organization. |
»» vendorId |
integer(int64) |
false |
none |
Unique identifier for the vendor |
»» vendorDto |
false |
none |
Data transfer object representing a vendor, encapsulating essential details such as vendor identification, contact information, and service offerings to facilitate effective supplier management and collaboration. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» name |
string |
false |
none |
Name of the resource |
»»» description |
string |
false |
none |
Description of the resource |
»»» address |
string |
false |
none |
Represents the physical location of the vendor, essential for logistical coordination and service delivery. |
»»» contractEndDate |
string(date) |
false |
none |
Date of the contract end |
»»» services |
string |
false |
none |
Represents the list of services offered by the vendor, essential for evaluating vendor capabilities and aligning them with business needs. |
»»» vendorType |
string |
false |
none |
Type of the vendor |
»»» vendorStatusId |
integer(int64) |
false |
none |
Unique identifier for the vendor status |
»»» vendorStatus |
string |
false |
none |
Status of the vendor |
»»» vendorStatusType |
string |
false |
none |
Type of the vendor status |
»»» businessTypeId |
integer(int64) |
false |
none |
Unique identifier for the business type |
»»» businessType |
string |
false |
none |
Type of the business |
»»» vendorRateId |
integer(int64) |
false |
none |
Unique identifier for the vendor rate |
»»» vendorRate |
string |
false |
none |
Rate of vendor |
»»» vendorContactIds |
[integer] |
false |
none |
Array of unique identifiers for vendor contacts associated with the vendor, facilitating streamlined communication and management of vendor relationships. |
»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the vendor, facilitating streamlined management and tracking of vendor relationships. |
»»» firstPremiseDisplayId |
string |
false |
none |
Unique identifier for the first premise display |
»»» ownerUserName |
string |
false |
none |
Name of the owner user |
»»» ownerDto |
false |
none |
Data transfer object representing a user profile within the system, encapsulating essential user information and attributes for effective management and interaction across business applications. |
|
»»» vendorAvailable |
boolean |
false |
none |
Indicates whether the vendor is currently available for new engagements. |
»»» vendorRating |
number(double) |
false |
none |
Numeric representation of the vendor’s performance rating, used to assess and compare vendor quality within the procurement process. |
»»» premiseDisplayIds |
[string] |
false |
none |
Array of unique identifiers for the premises associated with the vendor, facilitating streamlined management and reference within the system. |
»» vendorName |
string |
false |
none |
Name of the vendor |
»» workOrderTemplateSettings |
false |
none |
Data transfer object representing the settings and configurations for work order templates, facilitating streamlined management and customization of work orders within the enterprise workflow. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» workOrderId |
integer(int64) |
false |
none |
Unique identifier for the work order |
»»» startDate |
string(date) |
false |
none |
Start date of the resource |
»»» dueDuration |
integer(int32) |
false |
none |
Specifies the duration, in minutes, for which a work order is due, facilitating effective scheduling and resource allocation. |
»»» dueMonths |
integer(int32) |
false |
none |
Specifies the number of months until the work order is due, facilitating effective scheduling and resource allocation. |
»»» endDate |
string(date) |
false |
none |
End date of the resource |
»»» recurringWOPriorityId |
integer(int64) |
false |
none |
Unique identifier for the recurring w o priority |
»»» recurringWOPriority |
string |
false |
none |
Priority of the recurring w o |
»»» recurringWOPriorityType |
string |
false |
none |
Type of the recurring w o priority |
»»» isTemplate |
boolean |
false |
none |
Whether the resource is template |
»»» isRemoveByDate |
boolean |
false |
none |
Whether the resource is remove by |
»»» triggerByWorkOrderStatusId |
integer(int64) |
false |
none |
Unique identifier for the trigger by work order status |
»»» triggerByWorkOrderStatus |
string |
false |
none |
Status of the trigger by work order |
»»» triggerByWorkOrderStatusType |
string |
false |
none |
Type of the trigger by work order status |
»»» removeByWorkOrderStatusId |
integer(int64) |
false |
none |
Unique identifier for the remove by work order status |
»»» removeByWorkOrderStatus |
string |
false |
none |
Status of the remove by work order |
»»» removeByWorkOrderStatusType |
string |
false |
none |
Type of the remove by work order status |
»» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers for users assigned to the work order, facilitating effective resource allocation and management. |
»» assignedUserDtos |
false |
none |
Array of user assignments associated with the work order, providing visibility into the personnel responsible for its execution. |
|
»» assignedUsers |
[string] |
false |
none |
List of users assigned to the work order, facilitating effective task management and resource allocation. |
»» variableQuantity |
integer(int64) |
false |
none |
Quantity of variable quantity |
»» workOrderAvailable |
boolean |
false |
none |
Indicates whether a work order is currently available for processing within the system. |
»» exactPlacement |
string |
false |
none |
Specifies the precise location or arrangement for the execution of the work order, ensuring clarity in task assignment and resource allocation. |
»» primaryWorkOrderId |
integer(int64) |
false |
none |
Unique identifier for the primary work order |
»» primaryWorkOrderDto |
false |
none |
Data transfer object representing a work order, encapsulating essential details such as task specifications, assigned resources, and status updates to facilitate efficient project management and operational workflow. |
|
»» primaryWorkOrderDisplayId |
string |
false |
none |
Unique identifier for the primary work order display |
»» isPrimary |
boolean |
false |
none |
Whether the resource is primary |
»» invoiceIds |
[integer] |
false |
none |
Array of unique identifiers for invoices associated with the work order, facilitating efficient tracking and management of financial transactions. |
»» createdByTrigger |
boolean |
false |
none |
Indicates whether the work order was created automatically by a trigger event within the system. |
»» internalCosts |
string |
false |
none |
Represents the internal costs associated with the work order, providing essential financial insights for effective budget management. |
»» invoiceTotal |
string |
false |
none |
Total invoice |
»» partsTotal |
string |
false |
none |
Total parts |
»» inspectionItemId |
integer(int64) |
false |
none |
Unique identifier for the inspection item |
»» partIdToAttach |
integer(int64) |
false |
none |
Unique identifier for the part to be attached to the work order, facilitating efficient tracking and management of resources. |
»» recurringWOIsTemplate |
boolean |
false |
write-only |
Indicates whether the work order is based on a recurring template, facilitating streamlined management of repeat tasks. |
»» recurringWOStartDate |
string(date) |
false |
write-only |
Date of the recurring w o start |
»» recurringWOEndDate |
string(date) |
false |
write-only |
Date of the recurring w o end |
»» recurringWODueDuration |
integer(int32) |
false |
write-only |
Specifies the duration, in days, for which a work order is set to recur, facilitating effective scheduling and resource allocation. |
»» recurringWODueMonths |
integer(int32) |
false |
write-only |
Specifies the number of months for which the work order is set to recur, facilitating effective scheduling and resource allocation. |
»» recurringWOPriority |
string |
false |
write-only |
Priority of the recurring w o |
»» recurringWOIsRemoveByDate |
boolean |
false |
write-only |
Date of the recurring w o is remove by |
»» triggerByWorkOrderStatus |
string |
false |
write-only |
Status of the trigger by work order |
»» removeByWorkOrderStatus |
string |
false |
write-only |
Status of the remove by work order |
»» recurringWOPriorityType |
string |
false |
write-only |
Type of the recurring w o priority |
»» triggerByWorkOrderStatusType |
string |
false |
write-only |
Type of the trigger by work order status |
»» removeByWorkOrderStatusType |
string |
false |
write-only |
Type of the remove by work order status |
»» recurringWOPriorityId |
integer(int64) |
false |
write-only |
Unique identifier for the recurring w o priority |
»» triggerByWorkOrderStatusId |
integer(int64) |
false |
write-only |
Unique identifier for the trigger by work order status |
»» removeByWorkOrderStatusId |
integer(int64) |
false |
write-only |
Unique identifier for the remove by work order status |
» workOrderDisplayId |
string |
false |
none |
Unique identifier for the work order display |
» reporterDto |
false |
none |
Data transfer object representing a user profile within the system, encapsulating essential user information and attributes for effective management and interaction across business applications. |
|
» username |
string |
false |
none |
Represents the unique identifier for the user within the system, facilitating user-specific incident tracking and management. |
» injuredPersonName |
string |
false |
none |
Name of the injured person |
» exactLocation |
string |
false |
none |
Represents the precise geographical location associated with a worker incident, facilitating accurate reporting and analysis. |
» injuredPersonRole |
string |
false |
none |
Indicates the role of the individual involved in the incident, providing essential context for incident reporting and analysis. |
» incidentTime |
false |
none |
Data transfer object representing the local time settings relevant to business operations, ensuring accurate scheduling and time management across various regions. |
|
» injuryTypeAndBodyPartAffected |
string |
false |
none |
Describes the specific type of injury and the body part affected, facilitating accurate reporting and analysis of worker incidents. |
» severity |
string |
false |
none |
Indicates the level of seriousness associated with a worker incident, facilitating prioritization and response in incident management. |
» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
» premisesDisplayId |
string |
false |
none |
Unique identifier for the premises display |
» premisesDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
» workerIncidentAvailable |
boolean |
false |
none |
Indicates whether there are any available incidents reported for the worker, facilitating effective incident management and response. |
» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
Create Worker Incident¶
HTTP Request
POST /api/workerIncidents
📋 Description: Creates a new worker incident record, enabling organizations to efficiently document and manage workplace incidents for improved safety and compliance.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing detailed information about worker incidents, including incident type, description, date, and associated employee data for effective incident management and reporting. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "title": "string",
7 "description": "string",
8 "reportDate": "2019-08-24",
9 "statusName": "string",
10 "workOrder": {
11 "id": 0,
12 "createdBy": "string",
13 "createdAt": "2019-08-24T14:15:22Z",
14 "displayId": "string",
15 "name": "string",
16 "imageId": 0,
17 "description": "string",
18 "vendorRating": 0,
19 "premiseId": 0,
20 "premiseDto": {
21 "id": 0,
22 "createdBy": "string",
23 "createdAt": "2019-08-24T14:15:22Z",
24 "displayId": "string",
25 "premiseName": "string",
26 "description": "string",
27 "address": "string",
28 "internalTeamNames": [
29 "string"
30 ],
31 "internalTeamIds": [
32 0
33 ],
34 "premiseAvailable": true,
35 "premiseFromNrm": true,
36 "nlmId": 0,
37 "nlmDisplayId": "string",
38 "nlmUsed": true,
39 "manager": 0,
40 "managerName": "string",
41 "imageId": 0,
42 "area": "string",
43 "modifiedAt": "2019-08-24T14:15:22Z"
44 },
45 "premiseFromNrm": true,
46 "premiseDisplayId": "string",
47 "nssProjectId": 0,
48 "nssTaskId": 0,
49 "nssTaskDisplayId": "string",
50 "orderDate": "2019-08-24",
51 "dueDate": "2019-08-24",
52 "startDate": "2019-08-24",
53 "endDate": "2019-08-24",
54 "startTime": {
55 "hour": 0,
56 "minute": 0,
57 "second": 0,
58 "nano": 0
59 },
60 "endTime": {
61 "hour": 0,
62 "minute": 0,
63 "second": 0,
64 "nano": 0
65 },
66 "modifiedAt": "2019-08-24T14:15:22Z",
67 "estimatedCost": "81.08",
68 "finalCost": "81.08",
69 "duration": 0,
70 "estimatedDayTime": 0,
71 "finalHourTime": "2.5",
72 "estimatedHourTime": "2.5",
73 "closeDate": "2019-08-24",
74 "inspection": "string",
75 "workOrderTypeId": 0,
76 "workOrderTypeName": "string",
77 "workOrderType": "string",
78 "workOrderPriorityId": 0,
79 "workOrderPriority": "string",
80 "workOrderPriorityType": "string",
81 "isTemplate": true,
82 "isWorkOrderTemplate": true,
83 "templateId": 0,
84 "isPartsInSufficient": true,
85 "partQuantityInfoList": [
86 {
87 "partId": 0,
88 "partDisplayId": "string",
89 "requestedQuantity": 0,
90 "availableQuantity": 0,
91 "usedQuantity": 0,
92 "sufficient": true,
93 "partial": true
94 }
95 ],
96 "parentWorkOrderId": 0,
97 "parentWorkOrderDisplayId": "string",
98 "parentWorkOrder": "string",
99 "mainAssetIds": [
100 0
101 ],
102 "mainAssetDto": {
103 "id": 0,
104 "createdBy": "string",
105 "createdAt": "2019-08-24T14:15:22Z",
106 "displayId": "string",
107 "name": "string",
108 "description": "string",
109 "qrCode": "string",
110 "barCode": "string",
111 "imageId": 0,
112 "model": "string",
113 "manufacturer": "string",
114 "serialNumber": "string",
115 "cost": "81.08",
116 "premiseId": 0,
117 "premiseDisplayId": "string",
118 "premiseDto": {
119 "id": 0,
120 "createdBy": "string",
121 "createdAt": "2019-08-24T14:15:22Z",
122 "displayId": "string",
123 "premiseName": "string",
124 "description": "string",
125 "address": "string",
126 "internalTeamNames": [
127 "string"
128 ],
129 "internalTeamIds": [
130 0
131 ],
132 "premiseAvailable": true,
133 "premiseFromNrm": true,
134 "nlmId": 0,
135 "nlmDisplayId": "string",
136 "nlmUsed": true,
137 "manager": 0,
138 "managerName": "string",
139 "imageId": 0,
140 "area": "string",
141 "modifiedAt": "2019-08-24T14:15:22Z"
142 },
143 "acquisitionDate": "2019-08-24",
144 "endOfLife": "2019-08-24",
145 "assetStatusId": 0,
146 "assetStatus": "string",
147 "assetStatusType": "string",
148 "parentAssetId": 0,
149 "parentAssetDisplayId": "string",
150 "parentAsset": "string",
151 "parentAssetDto": {},
152 "upcomingMaintenanceDate": "2019-08-24",
153 "assetCategoryIds": [
154 0
155 ],
156 "assetCategories": [
157 "string"
158 ],
159 "internalTeamIds": [
160 0
161 ],
162 "internalTeamDtos": [
163 {
164 "id": 0,
165 "createdBy": "string",
166 "createdAt": "2019-08-24T14:15:22Z",
167 "displayId": "string",
168 "name": "string",
169 "email": "string",
170 "phone": "string",
171 "manager": "string",
172 "requestCategoryName": [
173 "string"
174 ],
175 "requestCategoryId": [
176 0
177 ],
178 "requestCategoryDisplayId": [
179 "string"
180 ],
181 "description": "string",
182 "internalTeamUser": [
183 0
184 ],
185 "members": 0,
186 "mainAssets": [
187 0
188 ],
189 "premiseNames": [
190 "string"
191 ],
192 "internalTeamAvailable": true,
193 "premiseIds": [
194 0
195 ]
196 }
197 ],
198 "internalTeams": [
199 "string"
200 ],
201 "assignedUserIds": [
202 0
203 ],
204 "assignedUserDtos": [
205 {
206 "id": 0,
207 "createdBy": "string",
208 "createdAt": "2019-08-24T14:15:22Z",
209 "userName": "string",
210 "firstName": "string",
211 "lastName": "string",
212 "email": "string",
213 "roleIds": [
214 {
215 "id": 0,
216 "createdBy": "string",
217 "createdAt": "2019-08-24T14:15:22Z",
218 "modifiedBy": "string",
219 "modifiedAt": "2019-08-24T14:15:22Z",
220 "roleName": "string",
221 "entity": "string",
222 "new": true
223 }
224 ],
225 "internalTeamNames": [
226 "string"
227 ],
228 "internalTeamIds": [
229 0
230 ],
231 "internalTeamDisplayIds": [
232 "string"
233 ],
234 "premiseIds": [
235 0
236 ],
237 "premiseNames": [
238 "string"
239 ],
240 "userAvailable": true,
241 "temporaryWorkload": 0,
242 "preferredCultureCode": "string"
243 }
244 ],
245 "assignedUsers": [
246 "string"
247 ],
248 "assetPriority": "string",
249 "assetPriorityId": 0,
250 "assetPriorityDisplayId": "string",
251 "assetPriorityType": "string",
252 "assetAvailable": true,
253 "exactPlacement": "string",
254 "fosId": 0,
255 "downtimeStatus": "string",
256 "premiseFromNrm": true,
257 "modifiedAt": "2019-08-24T14:15:22Z"
258 },
259 "mainAssetDisplayId": "string",
260 "workOrderStatusId": 0,
261 "workOrderStatus": "string",
262 "workOrderStatusType": "string",
263 "requestIds": [
264 0
265 ],
266 "internalTeamIds": [
267 0
268 ],
269 "internalTeamDtos": [
270 {
271 "id": 0,
272 "createdBy": "string",
273 "createdAt": "2019-08-24T14:15:22Z",
274 "displayId": "string",
275 "name": "string",
276 "email": "string",
277 "phone": "string",
278 "manager": "string",
279 "requestCategoryName": [
280 "string"
281 ],
282 "requestCategoryId": [
283 0
284 ],
285 "requestCategoryDisplayId": [
286 "string"
287 ],
288 "description": "string",
289 "internalTeamUser": [
290 0
291 ],
292 "members": 0,
293 "mainAssets": [
294 0
295 ],
296 "premiseNames": [
297 "string"
298 ],
299 "internalTeamAvailable": true,
300 "premiseIds": [
301 0
302 ]
303 }
304 ],
305 "internalTeams": [
306 "string"
307 ],
308 "vendorId": 0,
309 "vendorDto": {
310 "id": 0,
311 "createdBy": "string",
312 "createdAt": "2019-08-24T14:15:22Z",
313 "displayId": "string",
314 "name": "string",
315 "description": "string",
316 "address": "string",
317 "contractEndDate": "2019-08-24",
318 "services": "string",
319 "vendorType": "string",
320 "vendorStatusId": 0,
321 "vendorStatus": "string",
322 "vendorStatusType": "string",
323 "businessTypeId": 0,
324 "businessType": "string",
325 "vendorRateId": 0,
326 "vendorRate": "string",
327 "vendorContactIds": [
328 0
329 ],
330 "premiseIds": [
331 0
332 ],
333 "firstPremiseDisplayId": "string",
334 "ownerUserName": "string",
335 "ownerDto": {
336 "id": 0,
337 "createdBy": "string",
338 "createdAt": "2019-08-24T14:15:22Z",
339 "userName": "string",
340 "firstName": "string",
341 "lastName": "string",
342 "email": "string",
343 "roleIds": [
344 {
345 "id": 0,
346 "createdBy": "string",
347 "createdAt": "2019-08-24T14:15:22Z",
348 "modifiedBy": "string",
349 "modifiedAt": "2019-08-24T14:15:22Z",
350 "roleName": "string",
351 "entity": "string",
352 "new": true
353 }
354 ],
355 "internalTeamNames": [
356 "string"
357 ],
358 "internalTeamIds": [
359 0
360 ],
361 "internalTeamDisplayIds": [
362 "string"
363 ],
364 "premiseIds": [
365 0
366 ],
367 "premiseNames": [
368 "string"
369 ],
370 "userAvailable": true,
371 "temporaryWorkload": 0,
372 "preferredCultureCode": "string"
373 },
374 "vendorAvailable": true,
375 "vendorRating": 0.1,
376 "premiseDisplayIds": [
377 "string"
378 ]
379 },
380 "vendorName": "string",
381 "workOrderTemplateSettings": {
382 "id": 0,
383 "createdBy": "string",
384 "createdAt": "2019-08-24T14:15:22Z",
385 "workOrderId": 0,
386 "startDate": "2019-08-24",
387 "dueDuration": 0,
388 "dueMonths": 0,
389 "endDate": "2019-08-24",
390 "recurringWOPriorityId": 0,
391 "recurringWOPriority": "string",
392 "recurringWOPriorityType": "string",
393 "isTemplate": true,
394 "isRemoveByDate": true,
395 "triggerByWorkOrderStatusId": 0,
396 "triggerByWorkOrderStatus": "string",
397 "triggerByWorkOrderStatusType": "string",
398 "removeByWorkOrderStatusId": 0,
399 "removeByWorkOrderStatus": "string",
400 "removeByWorkOrderStatusType": "string"
401 },
402 "assignedUserIds": [
403 0
404 ],
405 "assignedUserDtos": [
406 {
407 "id": 0,
408 "createdBy": "string",
409 "createdAt": "2019-08-24T14:15:22Z",
410 "userName": "string",
411 "firstName": "string",
412 "lastName": "string",
413 "email": "string",
414 "roleIds": [
415 {
416 "id": 0,
417 "createdBy": "string",
418 "createdAt": "2019-08-24T14:15:22Z",
419 "modifiedBy": "string",
420 "modifiedAt": "2019-08-24T14:15:22Z",
421 "roleName": "string",
422 "entity": "string",
423 "new": true
424 }
425 ],
426 "internalTeamNames": [
427 "string"
428 ],
429 "internalTeamIds": [
430 0
431 ],
432 "internalTeamDisplayIds": [
433 "string"
434 ],
435 "premiseIds": [
436 0
437 ],
438 "premiseNames": [
439 "string"
440 ],
441 "userAvailable": true,
442 "temporaryWorkload": 0,
443 "preferredCultureCode": "string"
444 }
445 ],
446 "assignedUsers": [
447 "string"
448 ],
449 "variableQuantity": 0,
450 "workOrderAvailable": true,
451 "exactPlacement": "string",
452 "primaryWorkOrderId": 0,
453 "primaryWorkOrderDto": {},
454 "primaryWorkOrderDisplayId": "string",
455 "isPrimary": true,
456 "invoiceIds": [
457 0
458 ],
459 "createdByTrigger": true,
460 "internalCosts": "81.08",
461 "invoiceTotal": "81.08",
462 "partsTotal": "81.08",
463 "inspectionItemId": 0,
464 "partIdToAttach": 0,
465 "recurringWOIsTemplate": true,
466 "recurringWOStartDate": "2019-08-24",
467 "recurringWOEndDate": "2019-08-24",
468 "recurringWODueDuration": 0,
469 "recurringWODueMonths": 0,
470 "recurringWOPriority": "string",
471 "recurringWOIsRemoveByDate": true,
472 "triggerByWorkOrderStatus": "string",
473 "removeByWorkOrderStatus": "string",
474 "recurringWOPriorityType": "string",
475 "triggerByWorkOrderStatusType": "string",
476 "removeByWorkOrderStatusType": "string",
477 "recurringWOPriorityId": 0,
478 "triggerByWorkOrderStatusId": 0,
479 "removeByWorkOrderStatusId": 0
480 },
481 "workOrderDisplayId": "string",
482 "reporterDto": {
483 "id": 0,
484 "createdBy": "string",
485 "createdAt": "2019-08-24T14:15:22Z",
486 "userName": "string",
487 "firstName": "string",
488 "lastName": "string",
489 "email": "string",
490 "roleIds": [
491 {
492 "id": 0,
493 "createdBy": "string",
494 "createdAt": "2019-08-24T14:15:22Z",
495 "modifiedBy": "string",
496 "modifiedAt": "2019-08-24T14:15:22Z",
497 "roleName": "string",
498 "entity": "string",
499 "new": true
500 }
501 ],
502 "internalTeamNames": [
503 "string"
504 ],
505 "internalTeamIds": [
506 0
507 ],
508 "internalTeamDisplayIds": [
509 "string"
510 ],
511 "premiseIds": [
512 0
513 ],
514 "premiseNames": [
515 "string"
516 ],
517 "userAvailable": true,
518 "temporaryWorkload": 0,
519 "preferredCultureCode": "string"
520 },
521 "username": "string",
522 "injuredPersonName": "string",
523 "exactLocation": "string",
524 "injuredPersonRole": "string",
525 "incidentTime": {
526 "hour": 0,
527 "minute": 0,
528 "second": 0,
529 "nano": 0
530 },
531 "injuryTypeAndBodyPartAffected": "string",
532 "severity": "string",
533 "premiseId": 0,
534 "premisesDisplayId": "string",
535 "premisesDto": {
536 "id": 0,
537 "createdBy": "string",
538 "createdAt": "2019-08-24T14:15:22Z",
539 "displayId": "string",
540 "premiseName": "string",
541 "description": "string",
542 "address": "string",
543 "internalTeamNames": [
544 "string"
545 ],
546 "internalTeamIds": [
547 0
548 ],
549 "premiseAvailable": true,
550 "premiseFromNrm": true,
551 "nlmId": 0,
552 "nlmDisplayId": "string",
553 "nlmUsed": true,
554 "manager": 0,
555 "managerName": "string",
556 "imageId": 0,
557 "area": "string",
558 "modifiedAt": "2019-08-24T14:15:22Z"
559 },
560 "workerIncidentAvailable": true,
561 "modifiedAt": "2019-08-24T14:15:22Z",
562 "statusId": 0
563}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "title": "string",
7 "description": "string",
8 "reportDate": "2019-08-24",
9 "statusName": "string",
10 "workOrder": {
11 "id": 0,
12 "createdBy": "string",
13 "createdAt": "2019-08-24T14:15:22Z",
14 "displayId": "string",
15 "name": "string",
16 "imageId": 0,
17 "description": "string",
18 "vendorRating": 0,
19 "premiseId": 0,
20 "premiseDto": {
21 "id": 0,
22 "createdBy": "string",
23 "createdAt": "2019-08-24T14:15:22Z",
24 "displayId": "string",
25 "premiseName": "string",
26 "description": "string",
27 "address": "string",
28 "internalTeamNames": [
29 "string"
30 ],
31 "internalTeamIds": [
32 0
33 ],
34 "premiseAvailable": true,
35 "premiseFromNrm": true,
36 "nlmId": 0,
37 "nlmDisplayId": "string",
38 "nlmUsed": true,
39 "manager": 0,
40 "managerName": "string",
41 "imageId": 0,
42 "area": "string",
43 "modifiedAt": "2019-08-24T14:15:22Z"
44 },
45 "premiseFromNrm": true,
46 "premiseDisplayId": "string",
47 "nssProjectId": 0,
48 "nssTaskId": 0,
49 "nssTaskDisplayId": "string",
50 "orderDate": "2019-08-24",
51 "dueDate": "2019-08-24",
52 "startDate": "2019-08-24",
53 "endDate": "2019-08-24",
54 "startTime": {
55 "hour": 0,
56 "minute": 0,
57 "second": 0,
58 "nano": 0
59 },
60 "endTime": {
61 "hour": 0,
62 "minute": 0,
63 "second": 0,
64 "nano": 0
65 },
66 "modifiedAt": "2019-08-24T14:15:22Z",
67 "estimatedCost": "81.08",
68 "finalCost": "81.08",
69 "duration": 0,
70 "estimatedDayTime": 0,
71 "finalHourTime": "2.5",
72 "estimatedHourTime": "2.5",
73 "closeDate": "2019-08-24",
74 "inspection": "string",
75 "workOrderTypeId": 0,
76 "workOrderTypeName": "string",
77 "workOrderType": "string",
78 "workOrderPriorityId": 0,
79 "workOrderPriority": "string",
80 "workOrderPriorityType": "string",
81 "isTemplate": true,
82 "isWorkOrderTemplate": true,
83 "templateId": 0,
84 "isPartsInSufficient": true,
85 "partQuantityInfoList": [
86 {
87 "partId": 0,
88 "partDisplayId": "string",
89 "requestedQuantity": 0,
90 "availableQuantity": 0,
91 "usedQuantity": 0,
92 "sufficient": true,
93 "partial": true
94 }
95 ],
96 "parentWorkOrderId": 0,
97 "parentWorkOrderDisplayId": "string",
98 "parentWorkOrder": "string",
99 "mainAssetIds": [
100 0
101 ],
102 "mainAssetDto": {
103 "id": 0,
104 "createdBy": "string",
105 "createdAt": "2019-08-24T14:15:22Z",
106 "displayId": "string",
107 "name": "string",
108 "description": "string",
109 "qrCode": "string",
110 "barCode": "string",
111 "imageId": 0,
112 "model": "string",
113 "manufacturer": "string",
114 "serialNumber": "string",
115 "cost": "81.08",
116 "premiseId": 0,
117 "premiseDisplayId": "string",
118 "premiseDto": {
119 "id": 0,
120 "createdBy": "string",
121 "createdAt": "2019-08-24T14:15:22Z",
122 "displayId": "string",
123 "premiseName": "string",
124 "description": "string",
125 "address": "string",
126 "internalTeamNames": [
127 "string"
128 ],
129 "internalTeamIds": [
130 0
131 ],
132 "premiseAvailable": true,
133 "premiseFromNrm": true,
134 "nlmId": 0,
135 "nlmDisplayId": "string",
136 "nlmUsed": true,
137 "manager": 0,
138 "managerName": "string",
139 "imageId": 0,
140 "area": "string",
141 "modifiedAt": "2019-08-24T14:15:22Z"
142 },
143 "acquisitionDate": "2019-08-24",
144 "endOfLife": "2019-08-24",
145 "assetStatusId": 0,
146 "assetStatus": "string",
147 "assetStatusType": "string",
148 "parentAssetId": 0,
149 "parentAssetDisplayId": "string",
150 "parentAsset": "string",
151 "parentAssetDto": {},
152 "upcomingMaintenanceDate": "2019-08-24",
153 "assetCategoryIds": [
154 0
155 ],
156 "assetCategories": [
157 "string"
158 ],
159 "internalTeamIds": [
160 0
161 ],
162 "internalTeamDtos": [
163 {
164 "id": 0,
165 "createdBy": "string",
166 "createdAt": "2019-08-24T14:15:22Z",
167 "displayId": "string",
168 "name": "string",
169 "email": "string",
170 "phone": "string",
171 "manager": "string",
172 "requestCategoryName": [
173 "string"
174 ],
175 "requestCategoryId": [
176 0
177 ],
178 "requestCategoryDisplayId": [
179 "string"
180 ],
181 "description": "string",
182 "internalTeamUser": [
183 0
184 ],
185 "members": 0,
186 "mainAssets": [
187 0
188 ],
189 "premiseNames": [
190 "string"
191 ],
192 "internalTeamAvailable": true,
193 "premiseIds": [
194 0
195 ]
196 }
197 ],
198 "internalTeams": [
199 "string"
200 ],
201 "assignedUserIds": [
202 0
203 ],
204 "assignedUserDtos": [
205 {
206 "id": 0,
207 "createdBy": "string",
208 "createdAt": "2019-08-24T14:15:22Z",
209 "userName": "string",
210 "firstName": "string",
211 "lastName": "string",
212 "email": "string",
213 "roleIds": [
214 {
215 "id": 0,
216 "createdBy": "string",
217 "createdAt": "2019-08-24T14:15:22Z",
218 "modifiedBy": "string",
219 "modifiedAt": "2019-08-24T14:15:22Z",
220 "roleName": "string",
221 "entity": "string",
222 "new": true
223 }
224 ],
225 "internalTeamNames": [
226 "string"
227 ],
228 "internalTeamIds": [
229 0
230 ],
231 "internalTeamDisplayIds": [
232 "string"
233 ],
234 "premiseIds": [
235 0
236 ],
237 "premiseNames": [
238 "string"
239 ],
240 "userAvailable": true,
241 "temporaryWorkload": 0,
242 "preferredCultureCode": "string"
243 }
244 ],
245 "assignedUsers": [
246 "string"
247 ],
248 "assetPriority": "string",
249 "assetPriorityId": 0,
250 "assetPriorityDisplayId": "string",
251 "assetPriorityType": "string",
252 "assetAvailable": true,
253 "exactPlacement": "string",
254 "fosId": 0,
255 "downtimeStatus": "string",
256 "premiseFromNrm": true,
257 "modifiedAt": "2019-08-24T14:15:22Z"
258 },
259 "mainAssetDisplayId": "string",
260 "workOrderStatusId": 0,
261 "workOrderStatus": "string",
262 "workOrderStatusType": "string",
263 "requestIds": [
264 0
265 ],
266 "internalTeamIds": [
267 0
268 ],
269 "internalTeamDtos": [
270 {
271 "id": 0,
272 "createdBy": "string",
273 "createdAt": "2019-08-24T14:15:22Z",
274 "displayId": "string",
275 "name": "string",
276 "email": "string",
277 "phone": "string",
278 "manager": "string",
279 "requestCategoryName": [
280 "string"
281 ],
282 "requestCategoryId": [
283 0
284 ],
285 "requestCategoryDisplayId": [
286 "string"
287 ],
288 "description": "string",
289 "internalTeamUser": [
290 0
291 ],
292 "members": 0,
293 "mainAssets": [
294 0
295 ],
296 "premiseNames": [
297 "string"
298 ],
299 "internalTeamAvailable": true,
300 "premiseIds": [
301 0
302 ]
303 }
304 ],
305 "internalTeams": [
306 "string"
307 ],
308 "vendorId": 0,
309 "vendorDto": {
310 "id": 0,
311 "createdBy": "string",
312 "createdAt": "2019-08-24T14:15:22Z",
313 "displayId": "string",
314 "name": "string",
315 "description": "string",
316 "address": "string",
317 "contractEndDate": "2019-08-24",
318 "services": "string",
319 "vendorType": "string",
320 "vendorStatusId": 0,
321 "vendorStatus": "string",
322 "vendorStatusType": "string",
323 "businessTypeId": 0,
324 "businessType": "string",
325 "vendorRateId": 0,
326 "vendorRate": "string",
327 "vendorContactIds": [
328 0
329 ],
330 "premiseIds": [
331 0
332 ],
333 "firstPremiseDisplayId": "string",
334 "ownerUserName": "string",
335 "ownerDto": {
336 "id": 0,
337 "createdBy": "string",
338 "createdAt": "2019-08-24T14:15:22Z",
339 "userName": "string",
340 "firstName": "string",
341 "lastName": "string",
342 "email": "string",
343 "roleIds": [
344 {
345 "id": 0,
346 "createdBy": "string",
347 "createdAt": "2019-08-24T14:15:22Z",
348 "modifiedBy": "string",
349 "modifiedAt": "2019-08-24T14:15:22Z",
350 "roleName": "string",
351 "entity": "string",
352 "new": true
353 }
354 ],
355 "internalTeamNames": [
356 "string"
357 ],
358 "internalTeamIds": [
359 0
360 ],
361 "internalTeamDisplayIds": [
362 "string"
363 ],
364 "premiseIds": [
365 0
366 ],
367 "premiseNames": [
368 "string"
369 ],
370 "userAvailable": true,
371 "temporaryWorkload": 0,
372 "preferredCultureCode": "string"
373 },
374 "vendorAvailable": true,
375 "vendorRating": 0.1,
376 "premiseDisplayIds": [
377 "string"
378 ]
379 },
380 "vendorName": "string",
381 "workOrderTemplateSettings": {
382 "id": 0,
383 "createdBy": "string",
384 "createdAt": "2019-08-24T14:15:22Z",
385 "workOrderId": 0,
386 "startDate": "2019-08-24",
387 "dueDuration": 0,
388 "dueMonths": 0,
389 "endDate": "2019-08-24",
390 "recurringWOPriorityId": 0,
391 "recurringWOPriority": "string",
392 "recurringWOPriorityType": "string",
393 "isTemplate": true,
394 "isRemoveByDate": true,
395 "triggerByWorkOrderStatusId": 0,
396 "triggerByWorkOrderStatus": "string",
397 "triggerByWorkOrderStatusType": "string",
398 "removeByWorkOrderStatusId": 0,
399 "removeByWorkOrderStatus": "string",
400 "removeByWorkOrderStatusType": "string"
401 },
402 "assignedUserIds": [
403 0
404 ],
405 "assignedUserDtos": [
406 {
407 "id": 0,
408 "createdBy": "string",
409 "createdAt": "2019-08-24T14:15:22Z",
410 "userName": "string",
411 "firstName": "string",
412 "lastName": "string",
413 "email": "string",
414 "roleIds": [
415 {
416 "id": 0,
417 "createdBy": "string",
418 "createdAt": "2019-08-24T14:15:22Z",
419 "modifiedBy": "string",
420 "modifiedAt": "2019-08-24T14:15:22Z",
421 "roleName": "string",
422 "entity": "string",
423 "new": true
424 }
425 ],
426 "internalTeamNames": [
427 "string"
428 ],
429 "internalTeamIds": [
430 0
431 ],
432 "internalTeamDisplayIds": [
433 "string"
434 ],
435 "premiseIds": [
436 0
437 ],
438 "premiseNames": [
439 "string"
440 ],
441 "userAvailable": true,
442 "temporaryWorkload": 0,
443 "preferredCultureCode": "string"
444 }
445 ],
446 "assignedUsers": [
447 "string"
448 ],
449 "variableQuantity": 0,
450 "workOrderAvailable": true,
451 "exactPlacement": "string",
452 "primaryWorkOrderId": 0,
453 "primaryWorkOrderDto": {},
454 "primaryWorkOrderDisplayId": "string",
455 "isPrimary": true,
456 "invoiceIds": [
457 0
458 ],
459 "createdByTrigger": true,
460 "internalCosts": "81.08",
461 "invoiceTotal": "81.08",
462 "partsTotal": "81.08",
463 "inspectionItemId": 0,
464 "partIdToAttach": 0
465 },
466 "workOrderDisplayId": "string",
467 "reporterDto": {
468 "id": 0,
469 "createdBy": "string",
470 "createdAt": "2019-08-24T14:15:22Z",
471 "userName": "string",
472 "firstName": "string",
473 "lastName": "string",
474 "email": "string",
475 "roleIds": [
476 {
477 "id": 0,
478 "createdBy": "string",
479 "createdAt": "2019-08-24T14:15:22Z",
480 "modifiedBy": "string",
481 "modifiedAt": "2019-08-24T14:15:22Z",
482 "roleName": "string",
483 "entity": "string",
484 "new": true
485 }
486 ],
487 "internalTeamNames": [
488 "string"
489 ],
490 "internalTeamIds": [
491 0
492 ],
493 "internalTeamDisplayIds": [
494 "string"
495 ],
496 "premiseIds": [
497 0
498 ],
499 "premiseNames": [
500 "string"
501 ],
502 "userAvailable": true,
503 "temporaryWorkload": 0,
504 "preferredCultureCode": "string"
505 },
506 "username": "string",
507 "injuredPersonName": "string",
508 "exactLocation": "string",
509 "injuredPersonRole": "string",
510 "incidentTime": {
511 "hour": 0,
512 "minute": 0,
513 "second": 0,
514 "nano": 0
515 },
516 "injuryTypeAndBodyPartAffected": "string",
517 "severity": "string",
518 "premiseId": 0,
519 "premisesDisplayId": "string",
520 "premisesDto": {
521 "id": 0,
522 "createdBy": "string",
523 "createdAt": "2019-08-24T14:15:22Z",
524 "displayId": "string",
525 "premiseName": "string",
526 "description": "string",
527 "address": "string",
528 "internalTeamNames": [
529 "string"
530 ],
531 "internalTeamIds": [
532 0
533 ],
534 "premiseAvailable": true,
535 "premiseFromNrm": true,
536 "nlmId": 0,
537 "nlmDisplayId": "string",
538 "nlmUsed": true,
539 "manager": 0,
540 "managerName": "string",
541 "imageId": 0,
542 "area": "string",
543 "modifiedAt": "2019-08-24T14:15:22Z"
544 },
545 "workerIncidentAvailable": true,
546 "modifiedAt": "2019-08-24T14:15:22Z",
547 "statusId": 0
548}
Get All Documents By Worker Incident¶
HTTP Request
GET /api/workerIncidents/{id}/documents
📋 Description: Retrieves all documents associated with a specific worker incident identified by the provided ID, enabling users to access relevant documentation for incident management and review.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "name": "string",
7 "contentType": "string",
8 "documentTypeName": "string",
9 "documentTypeId": 0,
10 "description": "string",
11 "data": "string",
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "documentStatusId": 0,
15 "documentStatus": "string",
16 "documentStatusType": "string",
17 "parentEntityId": 0,
18 "link": "string",
19 "parentEntityName": "string"
20 }
21]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a document within the enterprise system, encapsulating essential attributes such as title, content, and metadata for effective document management and retrieval.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» name |
string |
false |
none |
Name of the resource |
» contentType |
string |
false |
none |
Type of the content |
» documentTypeName |
string |
false |
none |
Name of the document type |
» documentTypeId |
integer(int64) |
false |
none |
Unique identifier for the document type |
» description |
string |
false |
none |
Description of the resource |
» data |
string(byte) |
false |
none |
Contains the primary content of the document, providing essential information relevant to the associated business process. |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» endDate |
string(date) |
false |
none |
End date of the resource |
» documentStatusId |
integer(int64) |
false |
none |
Unique identifier for the document status |
» documentStatus |
string |
false |
none |
Status of the document |
» documentStatusType |
string |
false |
none |
Type of the document status |
» parentEntityId |
integer(int64) |
true |
none |
Unique identifier for the parent entity |
» link |
string |
false |
none |
URL reference to the associated document, facilitating easy access and retrieval within the system. |
» parentEntityName |
string |
true |
none |
Name of the parent entity |
Get All Worker Incidents By Work Order ID¶
HTTP Request
GET /api/workerIncidents/workOrder/{id}
📋 Description: Fetches detailed information about a specific worker incident associated with the provided work order ID, enabling effective incident management and resolution tracking.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "title": "string",
8 "description": "string",
9 "reportDate": "2019-08-24",
10 "statusName": "string",
11 "workOrder": {
12 "id": 0,
13 "createdBy": "string",
14 "createdAt": "2019-08-24T14:15:22Z",
15 "displayId": "string",
16 "name": "string",
17 "imageId": 0,
18 "description": "string",
19 "vendorRating": 0,
20 "premiseId": 0,
21 "premiseDto": {
22 "id": 0,
23 "createdBy": "string",
24 "createdAt": "2019-08-24T14:15:22Z",
25 "displayId": "string",
26 "premiseName": "string",
27 "description": "string",
28 "address": "string",
29 "internalTeamNames": [
30 "string"
31 ],
32 "internalTeamIds": [
33 0
34 ],
35 "premiseAvailable": true,
36 "premiseFromNrm": true,
37 "nlmId": 0,
38 "nlmDisplayId": "string",
39 "nlmUsed": true,
40 "manager": 0,
41 "managerName": "string",
42 "imageId": 0,
43 "area": "string",
44 "modifiedAt": "2019-08-24T14:15:22Z"
45 },
46 "premiseFromNrm": true,
47 "premiseDisplayId": "string",
48 "nssProjectId": 0,
49 "nssTaskId": 0,
50 "nssTaskDisplayId": "string",
51 "orderDate": "2019-08-24",
52 "dueDate": "2019-08-24",
53 "startDate": "2019-08-24",
54 "endDate": "2019-08-24",
55 "startTime": {
56 "hour": 0,
57 "minute": 0,
58 "second": 0,
59 "nano": 0
60 },
61 "endTime": {
62 "hour": 0,
63 "minute": 0,
64 "second": 0,
65 "nano": 0
66 },
67 "modifiedAt": "2019-08-24T14:15:22Z",
68 "estimatedCost": "81.08",
69 "finalCost": "81.08",
70 "duration": 0,
71 "estimatedDayTime": 0,
72 "finalHourTime": "2.5",
73 "estimatedHourTime": "2.5",
74 "closeDate": "2019-08-24",
75 "inspection": "string",
76 "workOrderTypeId": 0,
77 "workOrderTypeName": "string",
78 "workOrderType": "string",
79 "workOrderPriorityId": 0,
80 "workOrderPriority": "string",
81 "workOrderPriorityType": "string",
82 "isTemplate": true,
83 "isWorkOrderTemplate": true,
84 "templateId": 0,
85 "isPartsInSufficient": true,
86 "partQuantityInfoList": [
87 {
88 "partId": 0,
89 "partDisplayId": "string",
90 "requestedQuantity": 0,
91 "availableQuantity": 0,
92 "usedQuantity": 0,
93 "sufficient": true,
94 "partial": true
95 }
96 ],
97 "parentWorkOrderId": 0,
98 "parentWorkOrderDisplayId": "string",
99 "parentWorkOrder": "string",
100 "mainAssetIds": [
101 0
102 ],
103 "mainAssetDto": {
104 "id": 0,
105 "createdBy": "string",
106 "createdAt": "2019-08-24T14:15:22Z",
107 "displayId": "string",
108 "name": "string",
109 "description": "string",
110 "qrCode": "string",
111 "barCode": "string",
112 "imageId": 0,
113 "model": "string",
114 "manufacturer": "string",
115 "serialNumber": "string",
116 "cost": "81.08",
117 "premiseId": 0,
118 "premiseDisplayId": "string",
119 "premiseDto": {
120 "id": 0,
121 "createdBy": "string",
122 "createdAt": "2019-08-24T14:15:22Z",
123 "displayId": "string",
124 "premiseName": "string",
125 "description": "string",
126 "address": "string",
127 "internalTeamNames": [
128 "string"
129 ],
130 "internalTeamIds": [
131 0
132 ],
133 "premiseAvailable": true,
134 "premiseFromNrm": true,
135 "nlmId": 0,
136 "nlmDisplayId": "string",
137 "nlmUsed": true,
138 "manager": 0,
139 "managerName": "string",
140 "imageId": 0,
141 "area": "string",
142 "modifiedAt": "2019-08-24T14:15:22Z"
143 },
144 "acquisitionDate": "2019-08-24",
145 "endOfLife": "2019-08-24",
146 "assetStatusId": 0,
147 "assetStatus": "string",
148 "assetStatusType": "string",
149 "parentAssetId": 0,
150 "parentAssetDisplayId": "string",
151 "parentAsset": "string",
152 "parentAssetDto": {},
153 "upcomingMaintenanceDate": "2019-08-24",
154 "assetCategoryIds": [
155 0
156 ],
157 "assetCategories": [
158 "string"
159 ],
160 "internalTeamIds": [
161 0
162 ],
163 "internalTeamDtos": [
164 {
165 "id": 0,
166 "createdBy": "string",
167 "createdAt": "2019-08-24T14:15:22Z",
168 "displayId": "string",
169 "name": "string",
170 "email": "string",
171 "phone": "string",
172 "manager": "string",
173 "requestCategoryName": [
174 "string"
175 ],
176 "requestCategoryId": [
177 0
178 ],
179 "requestCategoryDisplayId": [
180 "string"
181 ],
182 "description": "string",
183 "internalTeamUser": [
184 0
185 ],
186 "members": 0,
187 "mainAssets": [
188 0
189 ],
190 "premiseNames": [
191 "string"
192 ],
193 "internalTeamAvailable": true,
194 "premiseIds": [
195 0
196 ]
197 }
198 ],
199 "internalTeams": [
200 "string"
201 ],
202 "assignedUserIds": [
203 0
204 ],
205 "assignedUserDtos": [
206 {
207 "id": 0,
208 "createdBy": "string",
209 "createdAt": "2019-08-24T14:15:22Z",
210 "userName": "string",
211 "firstName": "string",
212 "lastName": "string",
213 "email": "string",
214 "roleIds": [
215 {
216 "id": 0,
217 "createdBy": "string",
218 "createdAt": "2019-08-24T14:15:22Z",
219 "modifiedBy": "string",
220 "modifiedAt": "2019-08-24T14:15:22Z",
221 "roleName": "string",
222 "entity": "string",
223 "new": true
224 }
225 ],
226 "internalTeamNames": [
227 "string"
228 ],
229 "internalTeamIds": [
230 0
231 ],
232 "internalTeamDisplayIds": [
233 "string"
234 ],
235 "premiseIds": [
236 0
237 ],
238 "premiseNames": [
239 "string"
240 ],
241 "userAvailable": true,
242 "temporaryWorkload": 0,
243 "preferredCultureCode": "string"
244 }
245 ],
246 "assignedUsers": [
247 "string"
248 ],
249 "assetPriority": "string",
250 "assetPriorityId": 0,
251 "assetPriorityDisplayId": "string",
252 "assetPriorityType": "string",
253 "assetAvailable": true,
254 "exactPlacement": "string",
255 "fosId": 0,
256 "downtimeStatus": "string",
257 "premiseFromNrm": true,
258 "modifiedAt": "2019-08-24T14:15:22Z"
259 },
260 "mainAssetDisplayId": "string",
261 "workOrderStatusId": 0,
262 "workOrderStatus": "string",
263 "workOrderStatusType": "string",
264 "requestIds": [
265 0
266 ],
267 "internalTeamIds": [
268 0
269 ],
270 "internalTeamDtos": [
271 {
272 "id": 0,
273 "createdBy": "string",
274 "createdAt": "2019-08-24T14:15:22Z",
275 "displayId": "string",
276 "name": "string",
277 "email": "string",
278 "phone": "string",
279 "manager": "string",
280 "requestCategoryName": [
281 "string"
282 ],
283 "requestCategoryId": [
284 0
285 ],
286 "requestCategoryDisplayId": [
287 "string"
288 ],
289 "description": "string",
290 "internalTeamUser": [
291 0
292 ],
293 "members": 0,
294 "mainAssets": [
295 0
296 ],
297 "premiseNames": [
298 "string"
299 ],
300 "internalTeamAvailable": true,
301 "premiseIds": [
302 0
303 ]
304 }
305 ],
306 "internalTeams": [
307 "string"
308 ],
309 "vendorId": 0,
310 "vendorDto": {
311 "id": 0,
312 "createdBy": "string",
313 "createdAt": "2019-08-24T14:15:22Z",
314 "displayId": "string",
315 "name": "string",
316 "description": "string",
317 "address": "string",
318 "contractEndDate": "2019-08-24",
319 "services": "string",
320 "vendorType": "string",
321 "vendorStatusId": 0,
322 "vendorStatus": "string",
323 "vendorStatusType": "string",
324 "businessTypeId": 0,
325 "businessType": "string",
326 "vendorRateId": 0,
327 "vendorRate": "string",
328 "vendorContactIds": [
329 0
330 ],
331 "premiseIds": [
332 0
333 ],
334 "firstPremiseDisplayId": "string",
335 "ownerUserName": "string",
336 "ownerDto": {
337 "id": 0,
338 "createdBy": "string",
339 "createdAt": "2019-08-24T14:15:22Z",
340 "userName": "string",
341 "firstName": "string",
342 "lastName": "string",
343 "email": "string",
344 "roleIds": [
345 {
346 "id": 0,
347 "createdBy": "string",
348 "createdAt": "2019-08-24T14:15:22Z",
349 "modifiedBy": "string",
350 "modifiedAt": "2019-08-24T14:15:22Z",
351 "roleName": "string",
352 "entity": "string",
353 "new": true
354 }
355 ],
356 "internalTeamNames": [
357 "string"
358 ],
359 "internalTeamIds": [
360 0
361 ],
362 "internalTeamDisplayIds": [
363 "string"
364 ],
365 "premiseIds": [
366 0
367 ],
368 "premiseNames": [
369 "string"
370 ],
371 "userAvailable": true,
372 "temporaryWorkload": 0,
373 "preferredCultureCode": "string"
374 },
375 "vendorAvailable": true,
376 "vendorRating": 0.1,
377 "premiseDisplayIds": [
378 "string"
379 ]
380 },
381 "vendorName": "string",
382 "workOrderTemplateSettings": {
383 "id": 0,
384 "createdBy": "string",
385 "createdAt": "2019-08-24T14:15:22Z",
386 "workOrderId": 0,
387 "startDate": "2019-08-24",
388 "dueDuration": 0,
389 "dueMonths": 0,
390 "endDate": "2019-08-24",
391 "recurringWOPriorityId": 0,
392 "recurringWOPriority": "string",
393 "recurringWOPriorityType": "string",
394 "isTemplate": true,
395 "isRemoveByDate": true,
396 "triggerByWorkOrderStatusId": 0,
397 "triggerByWorkOrderStatus": "string",
398 "triggerByWorkOrderStatusType": "string",
399 "removeByWorkOrderStatusId": 0,
400 "removeByWorkOrderStatus": "string",
401 "removeByWorkOrderStatusType": "string"
402 },
403 "assignedUserIds": [
404 0
405 ],
406 "assignedUserDtos": [
407 {
408 "id": 0,
409 "createdBy": "string",
410 "createdAt": "2019-08-24T14:15:22Z",
411 "userName": "string",
412 "firstName": "string",
413 "lastName": "string",
414 "email": "string",
415 "roleIds": [
416 {
417 "id": 0,
418 "createdBy": "string",
419 "createdAt": "2019-08-24T14:15:22Z",
420 "modifiedBy": "string",
421 "modifiedAt": "2019-08-24T14:15:22Z",
422 "roleName": "string",
423 "entity": "string",
424 "new": true
425 }
426 ],
427 "internalTeamNames": [
428 "string"
429 ],
430 "internalTeamIds": [
431 0
432 ],
433 "internalTeamDisplayIds": [
434 "string"
435 ],
436 "premiseIds": [
437 0
438 ],
439 "premiseNames": [
440 "string"
441 ],
442 "userAvailable": true,
443 "temporaryWorkload": 0,
444 "preferredCultureCode": "string"
445 }
446 ],
447 "assignedUsers": [
448 "string"
449 ],
450 "variableQuantity": 0,
451 "workOrderAvailable": true,
452 "exactPlacement": "string",
453 "primaryWorkOrderId": 0,
454 "primaryWorkOrderDto": {},
455 "primaryWorkOrderDisplayId": "string",
456 "isPrimary": true,
457 "invoiceIds": [
458 0
459 ],
460 "createdByTrigger": true,
461 "internalCosts": "81.08",
462 "invoiceTotal": "81.08",
463 "partsTotal": "81.08",
464 "inspectionItemId": 0,
465 "partIdToAttach": 0
466 },
467 "workOrderDisplayId": "string",
468 "reporterDto": {
469 "id": 0,
470 "createdBy": "string",
471 "createdAt": "2019-08-24T14:15:22Z",
472 "userName": "string",
473 "firstName": "string",
474 "lastName": "string",
475 "email": "string",
476 "roleIds": [
477 {
478 "id": 0,
479 "createdBy": "string",
480 "createdAt": "2019-08-24T14:15:22Z",
481 "modifiedBy": "string",
482 "modifiedAt": "2019-08-24T14:15:22Z",
483 "roleName": "string",
484 "entity": "string",
485 "new": true
486 }
487 ],
488 "internalTeamNames": [
489 "string"
490 ],
491 "internalTeamIds": [
492 0
493 ],
494 "internalTeamDisplayIds": [
495 "string"
496 ],
497 "premiseIds": [
498 0
499 ],
500 "premiseNames": [
501 "string"
502 ],
503 "userAvailable": true,
504 "temporaryWorkload": 0,
505 "preferredCultureCode": "string"
506 },
507 "username": "string",
508 "injuredPersonName": "string",
509 "exactLocation": "string",
510 "injuredPersonRole": "string",
511 "incidentTime": {
512 "hour": 0,
513 "minute": 0,
514 "second": 0,
515 "nano": 0
516 },
517 "injuryTypeAndBodyPartAffected": "string",
518 "severity": "string",
519 "premiseId": 0,
520 "premisesDisplayId": "string",
521 "premisesDto": {
522 "id": 0,
523 "createdBy": "string",
524 "createdAt": "2019-08-24T14:15:22Z",
525 "displayId": "string",
526 "premiseName": "string",
527 "description": "string",
528 "address": "string",
529 "internalTeamNames": [
530 "string"
531 ],
532 "internalTeamIds": [
533 0
534 ],
535 "premiseAvailable": true,
536 "premiseFromNrm": true,
537 "nlmId": 0,
538 "nlmDisplayId": "string",
539 "nlmUsed": true,
540 "manager": 0,
541 "managerName": "string",
542 "imageId": 0,
543 "area": "string",
544 "modifiedAt": "2019-08-24T14:15:22Z"
545 },
546 "workerIncidentAvailable": true,
547 "modifiedAt": "2019-08-24T14:15:22Z",
548 "statusId": 0
549 }
550]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an incident involving a worker, encapsulating relevant details such as incident type, date, and associated metadata for effective incident management and reporting.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» title |
string |
false |
none |
Title of the resource |
» description |
string |
false |
none |
Description of the resource |
» reportDate |
string(date) |
false |
none |
Date of the report |
» statusName |
string |
false |
none |
Name of the status |
» workOrder |
false |
none |
Data transfer object representing a work order, encapsulating essential details such as task specifications, assigned resources, and status updates to facilitate efficient project management and operational workflow. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» name |
string |
false |
none |
Name of the resource |
»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»» description |
string |
false |
none |
Description of the resource |
»» vendorRating |
integer(int32) |
false |
none |
Represents the numerical rating assigned to a vendor, reflecting their performance and reliability in fulfilling work orders. |
»» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
»» premiseDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» premiseName |
string |
false |
none |
Name of the premise |
»»» description |
string |
false |
none |
Description of the resource |
»»» address |
string |
true |
none |
Represents the physical location associated with the premise, essential for logistics and service delivery. |
»»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation within the organization. |
»»» internalTeamIds |
[integer] |
false |
none |
List of unique identifiers representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation. |
»»» premiseAvailable |
boolean |
false |
none |
Indicates whether the premise is available for use within the specified context. |
»»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the premise is sourced from the National Resource Management (NRM) framework, facilitating compliance and reporting within environmental management processes. |
»»» nlmId |
integer(int64) |
false |
none |
Unique identifier for the nlm |
»»» nlmDisplayId |
string |
false |
none |
Unique identifier for the nlm display |
»»» nlmUsed |
boolean |
false |
none |
Indicates whether the National Labor Market (NLM) resources have been utilized in the premise evaluation process. |
»»» manager |
integer(int64) |
false |
none |
Unique identifier for the manager associated with the premise, facilitating effective organizational hierarchy and resource management. |
»»» managerName |
string |
false |
none |
Name of the manager |
»»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»»» area |
string |
false |
none |
Represents the geographic area associated with the premise, providing essential context for location-based services and analysis. |
»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the work order is derived from the National Resource Management system. |
»» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
»» nssProjectId |
integer(int64) |
false |
none |
Unique identifier for the nss project |
»» nssTaskId |
integer(int64) |
false |
none |
Unique identifier for the nss task |
»» nssTaskDisplayId |
string |
false |
none |
Unique identifier for the nss task display |
»» orderDate |
string(date) |
false |
none |
Date of the order |
»» dueDate |
string(date) |
false |
none |
Due date of the resource |
»» startDate |
string(date) |
false |
none |
Start date of the resource |
»» endDate |
string(date) |
false |
none |
End date of the resource |
»» startTime |
false |
none |
Data transfer object representing the local time settings relevant to business operations, ensuring accurate scheduling and time management across various regions. |
|
»»» hour |
integer(int32) |
false |
none |
Represents the hour component of a time value, facilitating precise scheduling and time management within the application. |
»»» minute |
integer(int32) |
false |
none |
Represents the minute component of a local time value, facilitating precise time tracking and scheduling within the application. |
»»» second |
integer(int32) |
false |
none |
Represents the seconds component of a local time value, facilitating precise time tracking and scheduling within the application. |
»»» nano |
integer(int32) |
false |
none |
Represents the nanosecond component of a local time value, facilitating precise time tracking and scheduling within the application. |
»» endTime |
false |
none |
Data transfer object representing the local time settings relevant to business operations, ensuring accurate scheduling and time management across various regions. |
|
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»» estimatedCost |
string |
false |
none |
Estimated cost associated with the work order, providing a financial projection for budgeting and resource allocation. |
»» finalCost |
string |
false |
none |
The finalCost field represents the total cost associated with the completion of a work order, providing essential financial insights for project budgeting and resource allocation. |
»» duration |
integer(int32) |
false |
none |
Represents the total time, in minutes, allocated for the completion of the work order. |
»» estimatedDayTime |
integer(int32) |
false |
none |
Time of the estimated day |
»» finalHourTime |
string |
false |
none |
Time of the final hour |
»» estimatedHourTime |
string |
false |
none |
Time of the estimated hour |
»» closeDate |
string(date) |
false |
none |
Date of the close |
»» inspection |
string |
false |
none |
Describes the specific inspection details associated with the work order, ensuring clarity in task requirements and compliance standards. |
»» workOrderTypeId |
integer(int64) |
false |
none |
Unique identifier for the work order type |
»» workOrderTypeName |
string |
false |
none |
Name of the work order type |
»» workOrderType |
string |
false |
none |
Type of the work order |
»» workOrderPriorityId |
integer(int64) |
false |
none |
Unique identifier for the work order priority |
»» workOrderPriority |
string |
false |
none |
Priority of the work order |
»» workOrderPriorityType |
string |
false |
none |
Type of the work order priority |
»» isTemplate |
boolean |
false |
none |
Whether the resource is template |
»» isWorkOrderTemplate |
boolean |
false |
none |
Whether the resource is work order template |
»» templateId |
integer(int64) |
false |
none |
Unique identifier for the template |
»» isPartsInSufficient |
boolean |
false |
none |
Whether the resource is parts in sufficient |
»» partQuantityInfoList |
false |
none |
List of quantities for each part associated with the work order, providing essential details for inventory management and resource allocation. |
|
»»» partId |
integer(int64) |
false |
none |
Unique identifier for the part |
»»» partDisplayId |
string |
false |
none |
Unique identifier for the part display |
»»» requestedQuantity |
integer(int64) |
false |
none |
Quantity of requested quantity |
»»» availableQuantity |
integer(int64) |
false |
none |
Quantity of available quantity |
»»» usedQuantity |
integer(int64) |
false |
none |
Quantity of used quantity |
»»» sufficient |
boolean |
false |
none |
Indicates whether the quantity of parts available meets the required threshold for operational needs. |
»»» partial |
boolean |
false |
none |
Indicates whether the quantity of parts is partially fulfilled, providing insight into inventory status and order fulfillment. |
»» parentWorkOrderId |
integer(int64) |
false |
none |
Unique identifier for the parent work order |
»» parentWorkOrderDisplayId |
string |
false |
none |
Unique identifier for the parent work order display |
»» parentWorkOrder |
string |
false |
none |
Identifier for the parent work order, establishing a hierarchical relationship within the work order management system. |
»» mainAssetIds |
[integer] |
false |
none |
Array of unique identifiers for the primary assets associated with the work order, facilitating effective asset management and tracking. |
»» mainAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» name |
string |
false |
none |
Name of the resource |
»»» description |
string |
false |
none |
Description of the resource |
»»» qrCode |
string |
false |
none |
Code for the qr |
»»» barCode |
string |
false |
none |
Code for the bar |
»»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»»» model |
string |
false |
none |
Specifies the model associated with the main asset, providing essential context for asset classification and management. |
»»» manufacturer |
string |
false |
none |
Name of the manufacturer associated with the asset, providing essential information for inventory management and supplier relations. |
»»» serialNumber |
string |
false |
none |
Unique identifier for the asset, used to track and manage inventory within the system. |
»»» cost |
string |
false |
none |
Represents the total cost associated with the main asset, providing essential financial information for budgeting and resource allocation. |
»»» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
»»» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
»»» premiseDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
»»» acquisitionDate |
string(date) |
false |
none |
Date of the acquisition |
»»» endOfLife |
string(date) |
false |
none |
Indicates the end-of-life date for the asset, providing critical information for lifecycle management and planning. |
»»» assetStatusId |
integer(int64) |
false |
none |
Unique identifier for the asset status |
»»» assetStatus |
string |
false |
none |
Status of the asset |
»»» assetStatusType |
string |
false |
none |
Type of the asset status |
»»» parentAssetId |
integer(int64) |
false |
none |
Unique identifier for the parent asset |
»»» parentAssetDisplayId |
string |
false |
none |
Unique identifier for the parent asset display |
»»» parentAsset |
string |
false |
none |
Identifier for the parent asset associated with the main asset, facilitating hierarchical relationships within asset management. |
»»» parentAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»»» upcomingMaintenanceDate |
string(date) |
false |
none |
Date of the upcoming maintenance |
»»» assetCategoryIds |
[integer] |
false |
none |
Array of unique identifiers representing the categories to which the asset belongs, facilitating effective asset classification and management. |
»»» assetCategories |
[string] |
false |
none |
Array of asset categories that classify the main assets within the system, facilitating better organization and management of asset data. |
»»» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the main asset, facilitating streamlined collaboration and resource allocation. |
»»» internalTeamDtos |
false |
none |
An array of MainAssetDTO objects representing the internal teams associated with the asset, facilitating effective resource management and collaboration within the organization. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»»» name |
string |
false |
none |
Name of the resource |
string |
false |
none |
Email address of the internal team member, used for communication and notifications within the organization. |
|
»»»» phone |
string |
false |
none |
Contact number for the internal team, facilitating communication and collaboration within the organization. |
»»»» manager |
string |
false |
none |
Represents the name or identifier of the team manager responsible for overseeing the internal team. |
»»»» requestCategoryName |
[string] |
false |
none |
Name of the request category |
»»»» requestCategoryId |
[integer] |
false |
none |
Unique identifier for the request category |
»»»» requestCategoryDisplayId |
[string] |
false |
none |
Unique identifier for the request category display |
»»»» description |
string |
false |
none |
Description of the resource |
»»»» internalTeamUser |
[integer] |
false |
none |
An array of InternalTeamDTO objects representing the users within the internal team, facilitating collaboration and resource management. |
»»»» members |
integer(int32) |
false |
none |
Represents the total number of members within the internal team, providing insight into team size for resource allocation and management. |
»»»» mainAssets |
[integer] |
false |
none |
An array of internal team assets that represent the key resources and capabilities utilized within the organization. |
»»»» premiseNames |
[string] |
false |
none |
List of names associated with the premises relevant to the internal team, facilitating efficient identification and management of locations within the organization. |
»»»» internalTeamAvailable |
boolean |
false |
none |
Indicates the availability of the internal team for project allocation and resource planning. |
»»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the internal team. |
»»» internalTeams |
[string] |
false |
none |
An array of internal teams associated with the main asset, facilitating collaboration and resource allocation within the organization. |
»»» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers representing users assigned to the main asset, facilitating effective resource management and accountability. |
»»» assignedUserDtos |
false |
none |
Array of user assignments associated with the main asset, providing insights into resource allocation and accountability. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»»» userName |
string |
false |
none |
Name of the user |
»»»» firstName |
string |
false |
none |
Name of the first |
»»»» lastName |
string |
false |
none |
Name of the last |
string |
false |
none |
Email address of the user, used for communication and account verification purposes within the system. |
|
»»»» roleIds |
false |
none |
Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system. |
|
»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»»»» modifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»»»»» roleName |
string |
false |
none |
Name of the role |
»»»»» entity |
string |
false |
none |
Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management. |
»»»»» new |
boolean |
false |
none |
Indicates whether the role is newly created within the system, facilitating effective management of organizational changes. |
»»»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization. |
»»»» internalTeamIds |
[integer] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization. |
»»»» internalTeamDisplayIds |
[string] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration. |
»»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations. |
»»»» premiseNames |
[string] |
false |
none |
List of names associated with the user’s premises, providing essential context for location-based services and operations. |
»»»» userAvailable |
boolean |
false |
none |
Indicates whether the user is available for assignment or engagement within the system. |
»»»» temporaryWorkload |
integer(int32) |
false |
none |
Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning. |
»»»» preferredCultureCode |
string |
false |
none |
Code for the preferred culture |
»»» assignedUsers |
[string] |
false |
none |
List of users assigned to the main asset, facilitating effective resource management and collaboration within the organization. |
»»» assetPriority |
string |
false |
none |
Priority of the asset |
»»» assetPriorityId |
integer(int64) |
false |
none |
Unique identifier for the asset priority |
»»» assetPriorityDisplayId |
string |
false |
none |
Unique identifier for the asset priority display |
»»» assetPriorityType |
string |
false |
none |
Type of the asset priority |
»»» assetAvailable |
boolean |
false |
none |
Indicates whether the asset is currently available for allocation or use within the system. |
»»» exactPlacement |
string |
false |
none |
Specifies the precise location or context in which the main asset is intended to be utilized within the business framework. |
»»» fosId |
integer(int64) |
false |
none |
Unique identifier for the fos |
»»» downtimeStatus |
string |
false |
none |
Status of the downtime |
»»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the asset is sourced from the National Resource Management (NRM) framework, facilitating compliance and resource tracking. |
»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»» mainAssetDisplayId |
string |
false |
none |
Unique identifier for the main asset display |
»» workOrderStatusId |
integer(int64) |
false |
none |
Unique identifier for the work order status |
»» workOrderStatus |
string |
false |
none |
Status of the work order |
»» workOrderStatusType |
string |
false |
none |
Type of the work order status |
»» requestIds |
[integer] |
false |
none |
An array of unique identifiers for the associated work orders, facilitating tracking and management within the system. |
»» internalTeamIds |
[integer] |
false |
none |
List of unique identifiers representing the internal teams associated with the work order, facilitating effective resource allocation and collaboration. |
»» internalTeamDtos |
false |
none |
An array of WorkOrderDTO objects representing the internal teams associated with the work order, facilitating efficient resource allocation and management. |
|
»» internalTeams |
[string] |
false |
none |
List of internal teams associated with the work order, facilitating collaboration and resource allocation within the organization. |
»» vendorId |
integer(int64) |
false |
none |
Unique identifier for the vendor |
»» vendorDto |
false |
none |
Data transfer object representing a vendor, encapsulating essential details such as vendor identification, contact information, and service offerings to facilitate effective supplier management and collaboration. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» name |
string |
false |
none |
Name of the resource |
»»» description |
string |
false |
none |
Description of the resource |
»»» address |
string |
false |
none |
Represents the physical location of the vendor, essential for logistical coordination and service delivery. |
»»» contractEndDate |
string(date) |
false |
none |
Date of the contract end |
»»» services |
string |
false |
none |
Represents the list of services offered by the vendor, essential for evaluating vendor capabilities and aligning them with business needs. |
»»» vendorType |
string |
false |
none |
Type of the vendor |
»»» vendorStatusId |
integer(int64) |
false |
none |
Unique identifier for the vendor status |
»»» vendorStatus |
string |
false |
none |
Status of the vendor |
»»» vendorStatusType |
string |
false |
none |
Type of the vendor status |
»»» businessTypeId |
integer(int64) |
false |
none |
Unique identifier for the business type |
»»» businessType |
string |
false |
none |
Type of the business |
»»» vendorRateId |
integer(int64) |
false |
none |
Unique identifier for the vendor rate |
»»» vendorRate |
string |
false |
none |
Rate of vendor |
»»» vendorContactIds |
[integer] |
false |
none |
Array of unique identifiers for vendor contacts associated with the vendor, facilitating streamlined communication and management of vendor relationships. |
»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the vendor, facilitating streamlined management and tracking of vendor relationships. |
»»» firstPremiseDisplayId |
string |
false |
none |
Unique identifier for the first premise display |
»»» ownerUserName |
string |
false |
none |
Name of the owner user |
»»» ownerDto |
false |
none |
Data transfer object representing a user profile within the system, encapsulating essential user information and attributes for effective management and interaction across business applications. |
|
»»» vendorAvailable |
boolean |
false |
none |
Indicates whether the vendor is currently available for new engagements. |
»»» vendorRating |
number(double) |
false |
none |
Numeric representation of the vendor’s performance rating, used to assess and compare vendor quality within the procurement process. |
»»» premiseDisplayIds |
[string] |
false |
none |
Array of unique identifiers for the premises associated with the vendor, facilitating streamlined management and reference within the system. |
»» vendorName |
string |
false |
none |
Name of the vendor |
»» workOrderTemplateSettings |
false |
none |
Data transfer object representing the settings and configurations for work order templates, facilitating streamlined management and customization of work orders within the enterprise workflow. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» workOrderId |
integer(int64) |
false |
none |
Unique identifier for the work order |
»»» startDate |
string(date) |
false |
none |
Start date of the resource |
»»» dueDuration |
integer(int32) |
false |
none |
Specifies the duration, in minutes, for which a work order is due, facilitating effective scheduling and resource allocation. |
»»» dueMonths |
integer(int32) |
false |
none |
Specifies the number of months until the work order is due, facilitating effective scheduling and resource allocation. |
»»» endDate |
string(date) |
false |
none |
End date of the resource |
»»» recurringWOPriorityId |
integer(int64) |
false |
none |
Unique identifier for the recurring w o priority |
»»» recurringWOPriority |
string |
false |
none |
Priority of the recurring w o |
»»» recurringWOPriorityType |
string |
false |
none |
Type of the recurring w o priority |
»»» isTemplate |
boolean |
false |
none |
Whether the resource is template |
»»» isRemoveByDate |
boolean |
false |
none |
Whether the resource is remove by |
»»» triggerByWorkOrderStatusId |
integer(int64) |
false |
none |
Unique identifier for the trigger by work order status |
»»» triggerByWorkOrderStatus |
string |
false |
none |
Status of the trigger by work order |
»»» triggerByWorkOrderStatusType |
string |
false |
none |
Type of the trigger by work order status |
»»» removeByWorkOrderStatusId |
integer(int64) |
false |
none |
Unique identifier for the remove by work order status |
»»» removeByWorkOrderStatus |
string |
false |
none |
Status of the remove by work order |
»»» removeByWorkOrderStatusType |
string |
false |
none |
Type of the remove by work order status |
»» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers for users assigned to the work order, facilitating effective resource allocation and management. |
»» assignedUserDtos |
false |
none |
Array of user assignments associated with the work order, providing visibility into the personnel responsible for its execution. |
|
»» assignedUsers |
[string] |
false |
none |
List of users assigned to the work order, facilitating effective task management and resource allocation. |
»» variableQuantity |
integer(int64) |
false |
none |
Quantity of variable quantity |
»» workOrderAvailable |
boolean |
false |
none |
Indicates whether a work order is currently available for processing within the system. |
»» exactPlacement |
string |
false |
none |
Specifies the precise location or arrangement for the execution of the work order, ensuring clarity in task assignment and resource allocation. |
»» primaryWorkOrderId |
integer(int64) |
false |
none |
Unique identifier for the primary work order |
»» primaryWorkOrderDto |
false |
none |
Data transfer object representing a work order, encapsulating essential details such as task specifications, assigned resources, and status updates to facilitate efficient project management and operational workflow. |
|
»» primaryWorkOrderDisplayId |
string |
false |
none |
Unique identifier for the primary work order display |
»» isPrimary |
boolean |
false |
none |
Whether the resource is primary |
»» invoiceIds |
[integer] |
false |
none |
Array of unique identifiers for invoices associated with the work order, facilitating efficient tracking and management of financial transactions. |
»» createdByTrigger |
boolean |
false |
none |
Indicates whether the work order was created automatically by a trigger event within the system. |
»» internalCosts |
string |
false |
none |
Represents the internal costs associated with the work order, providing essential financial insights for effective budget management. |
»» invoiceTotal |
string |
false |
none |
Total invoice |
»» partsTotal |
string |
false |
none |
Total parts |
»» inspectionItemId |
integer(int64) |
false |
none |
Unique identifier for the inspection item |
»» partIdToAttach |
integer(int64) |
false |
none |
Unique identifier for the part to be attached to the work order, facilitating efficient tracking and management of resources. |
»» recurringWOIsTemplate |
boolean |
false |
write-only |
Indicates whether the work order is based on a recurring template, facilitating streamlined management of repeat tasks. |
»» recurringWOStartDate |
string(date) |
false |
write-only |
Date of the recurring w o start |
»» recurringWOEndDate |
string(date) |
false |
write-only |
Date of the recurring w o end |
»» recurringWODueDuration |
integer(int32) |
false |
write-only |
Specifies the duration, in days, for which a work order is set to recur, facilitating effective scheduling and resource allocation. |
»» recurringWODueMonths |
integer(int32) |
false |
write-only |
Specifies the number of months for which the work order is set to recur, facilitating effective scheduling and resource allocation. |
»» recurringWOPriority |
string |
false |
write-only |
Priority of the recurring w o |
»» recurringWOIsRemoveByDate |
boolean |
false |
write-only |
Date of the recurring w o is remove by |
»» triggerByWorkOrderStatus |
string |
false |
write-only |
Status of the trigger by work order |
»» removeByWorkOrderStatus |
string |
false |
write-only |
Status of the remove by work order |
»» recurringWOPriorityType |
string |
false |
write-only |
Type of the recurring w o priority |
»» triggerByWorkOrderStatusType |
string |
false |
write-only |
Type of the trigger by work order status |
»» removeByWorkOrderStatusType |
string |
false |
write-only |
Type of the remove by work order status |
»» recurringWOPriorityId |
integer(int64) |
false |
write-only |
Unique identifier for the recurring w o priority |
»» triggerByWorkOrderStatusId |
integer(int64) |
false |
write-only |
Unique identifier for the trigger by work order status |
»» removeByWorkOrderStatusId |
integer(int64) |
false |
write-only |
Unique identifier for the remove by work order status |
» workOrderDisplayId |
string |
false |
none |
Unique identifier for the work order display |
» reporterDto |
false |
none |
Data transfer object representing a user profile within the system, encapsulating essential user information and attributes for effective management and interaction across business applications. |
|
» username |
string |
false |
none |
Represents the unique identifier for the user within the system, facilitating user-specific incident tracking and management. |
» injuredPersonName |
string |
false |
none |
Name of the injured person |
» exactLocation |
string |
false |
none |
Represents the precise geographical location associated with a worker incident, facilitating accurate reporting and analysis. |
» injuredPersonRole |
string |
false |
none |
Indicates the role of the individual involved in the incident, providing essential context for incident reporting and analysis. |
» incidentTime |
false |
none |
Data transfer object representing the local time settings relevant to business operations, ensuring accurate scheduling and time management across various regions. |
|
» injuryTypeAndBodyPartAffected |
string |
false |
none |
Describes the specific type of injury and the body part affected, facilitating accurate reporting and analysis of worker incidents. |
» severity |
string |
false |
none |
Indicates the level of seriousness associated with a worker incident, facilitating prioritization and response in incident management. |
» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
» premisesDisplayId |
string |
false |
none |
Unique identifier for the premises display |
» premisesDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
» workerIncidentAvailable |
boolean |
false |
none |
Indicates whether there are any available incidents reported for the worker, facilitating effective incident management and response. |
» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
Get Severity List¶
HTTP Request
GET /api/workerIncidents/severities
📋 Description: Retrieves a list of incident severity levels associated with worker incidents, providing essential data for risk assessment and management within the organization.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "property1": "string",
4 "property2": "string"
5 }
6]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» additionalProperties |
string |
false |
none |
none |
Get All Worker Incidents By Premises ID¶
HTTP Request
GET /api/workerIncidents/premises/{id}
📋 Description: Fetches detailed information about worker incidents associated with a specific premises identified by the provided ID, enabling effective incident management and reporting.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "title": "string",
8 "description": "string",
9 "reportDate": "2019-08-24",
10 "statusName": "string",
11 "workOrder": {
12 "id": 0,
13 "createdBy": "string",
14 "createdAt": "2019-08-24T14:15:22Z",
15 "displayId": "string",
16 "name": "string",
17 "imageId": 0,
18 "description": "string",
19 "vendorRating": 0,
20 "premiseId": 0,
21 "premiseDto": {
22 "id": 0,
23 "createdBy": "string",
24 "createdAt": "2019-08-24T14:15:22Z",
25 "displayId": "string",
26 "premiseName": "string",
27 "description": "string",
28 "address": "string",
29 "internalTeamNames": [
30 "string"
31 ],
32 "internalTeamIds": [
33 0
34 ],
35 "premiseAvailable": true,
36 "premiseFromNrm": true,
37 "nlmId": 0,
38 "nlmDisplayId": "string",
39 "nlmUsed": true,
40 "manager": 0,
41 "managerName": "string",
42 "imageId": 0,
43 "area": "string",
44 "modifiedAt": "2019-08-24T14:15:22Z"
45 },
46 "premiseFromNrm": true,
47 "premiseDisplayId": "string",
48 "nssProjectId": 0,
49 "nssTaskId": 0,
50 "nssTaskDisplayId": "string",
51 "orderDate": "2019-08-24",
52 "dueDate": "2019-08-24",
53 "startDate": "2019-08-24",
54 "endDate": "2019-08-24",
55 "startTime": {
56 "hour": 0,
57 "minute": 0,
58 "second": 0,
59 "nano": 0
60 },
61 "endTime": {
62 "hour": 0,
63 "minute": 0,
64 "second": 0,
65 "nano": 0
66 },
67 "modifiedAt": "2019-08-24T14:15:22Z",
68 "estimatedCost": "81.08",
69 "finalCost": "81.08",
70 "duration": 0,
71 "estimatedDayTime": 0,
72 "finalHourTime": "2.5",
73 "estimatedHourTime": "2.5",
74 "closeDate": "2019-08-24",
75 "inspection": "string",
76 "workOrderTypeId": 0,
77 "workOrderTypeName": "string",
78 "workOrderType": "string",
79 "workOrderPriorityId": 0,
80 "workOrderPriority": "string",
81 "workOrderPriorityType": "string",
82 "isTemplate": true,
83 "isWorkOrderTemplate": true,
84 "templateId": 0,
85 "isPartsInSufficient": true,
86 "partQuantityInfoList": [
87 {
88 "partId": 0,
89 "partDisplayId": "string",
90 "requestedQuantity": 0,
91 "availableQuantity": 0,
92 "usedQuantity": 0,
93 "sufficient": true,
94 "partial": true
95 }
96 ],
97 "parentWorkOrderId": 0,
98 "parentWorkOrderDisplayId": "string",
99 "parentWorkOrder": "string",
100 "mainAssetIds": [
101 0
102 ],
103 "mainAssetDto": {
104 "id": 0,
105 "createdBy": "string",
106 "createdAt": "2019-08-24T14:15:22Z",
107 "displayId": "string",
108 "name": "string",
109 "description": "string",
110 "qrCode": "string",
111 "barCode": "string",
112 "imageId": 0,
113 "model": "string",
114 "manufacturer": "string",
115 "serialNumber": "string",
116 "cost": "81.08",
117 "premiseId": 0,
118 "premiseDisplayId": "string",
119 "premiseDto": {
120 "id": 0,
121 "createdBy": "string",
122 "createdAt": "2019-08-24T14:15:22Z",
123 "displayId": "string",
124 "premiseName": "string",
125 "description": "string",
126 "address": "string",
127 "internalTeamNames": [
128 "string"
129 ],
130 "internalTeamIds": [
131 0
132 ],
133 "premiseAvailable": true,
134 "premiseFromNrm": true,
135 "nlmId": 0,
136 "nlmDisplayId": "string",
137 "nlmUsed": true,
138 "manager": 0,
139 "managerName": "string",
140 "imageId": 0,
141 "area": "string",
142 "modifiedAt": "2019-08-24T14:15:22Z"
143 },
144 "acquisitionDate": "2019-08-24",
145 "endOfLife": "2019-08-24",
146 "assetStatusId": 0,
147 "assetStatus": "string",
148 "assetStatusType": "string",
149 "parentAssetId": 0,
150 "parentAssetDisplayId": "string",
151 "parentAsset": "string",
152 "parentAssetDto": {},
153 "upcomingMaintenanceDate": "2019-08-24",
154 "assetCategoryIds": [
155 0
156 ],
157 "assetCategories": [
158 "string"
159 ],
160 "internalTeamIds": [
161 0
162 ],
163 "internalTeamDtos": [
164 {
165 "id": 0,
166 "createdBy": "string",
167 "createdAt": "2019-08-24T14:15:22Z",
168 "displayId": "string",
169 "name": "string",
170 "email": "string",
171 "phone": "string",
172 "manager": "string",
173 "requestCategoryName": [
174 "string"
175 ],
176 "requestCategoryId": [
177 0
178 ],
179 "requestCategoryDisplayId": [
180 "string"
181 ],
182 "description": "string",
183 "internalTeamUser": [
184 0
185 ],
186 "members": 0,
187 "mainAssets": [
188 0
189 ],
190 "premiseNames": [
191 "string"
192 ],
193 "internalTeamAvailable": true,
194 "premiseIds": [
195 0
196 ]
197 }
198 ],
199 "internalTeams": [
200 "string"
201 ],
202 "assignedUserIds": [
203 0
204 ],
205 "assignedUserDtos": [
206 {
207 "id": 0,
208 "createdBy": "string",
209 "createdAt": "2019-08-24T14:15:22Z",
210 "userName": "string",
211 "firstName": "string",
212 "lastName": "string",
213 "email": "string",
214 "roleIds": [
215 {
216 "id": 0,
217 "createdBy": "string",
218 "createdAt": "2019-08-24T14:15:22Z",
219 "modifiedBy": "string",
220 "modifiedAt": "2019-08-24T14:15:22Z",
221 "roleName": "string",
222 "entity": "string",
223 "new": true
224 }
225 ],
226 "internalTeamNames": [
227 "string"
228 ],
229 "internalTeamIds": [
230 0
231 ],
232 "internalTeamDisplayIds": [
233 "string"
234 ],
235 "premiseIds": [
236 0
237 ],
238 "premiseNames": [
239 "string"
240 ],
241 "userAvailable": true,
242 "temporaryWorkload": 0,
243 "preferredCultureCode": "string"
244 }
245 ],
246 "assignedUsers": [
247 "string"
248 ],
249 "assetPriority": "string",
250 "assetPriorityId": 0,
251 "assetPriorityDisplayId": "string",
252 "assetPriorityType": "string",
253 "assetAvailable": true,
254 "exactPlacement": "string",
255 "fosId": 0,
256 "downtimeStatus": "string",
257 "premiseFromNrm": true,
258 "modifiedAt": "2019-08-24T14:15:22Z"
259 },
260 "mainAssetDisplayId": "string",
261 "workOrderStatusId": 0,
262 "workOrderStatus": "string",
263 "workOrderStatusType": "string",
264 "requestIds": [
265 0
266 ],
267 "internalTeamIds": [
268 0
269 ],
270 "internalTeamDtos": [
271 {
272 "id": 0,
273 "createdBy": "string",
274 "createdAt": "2019-08-24T14:15:22Z",
275 "displayId": "string",
276 "name": "string",
277 "email": "string",
278 "phone": "string",
279 "manager": "string",
280 "requestCategoryName": [
281 "string"
282 ],
283 "requestCategoryId": [
284 0
285 ],
286 "requestCategoryDisplayId": [
287 "string"
288 ],
289 "description": "string",
290 "internalTeamUser": [
291 0
292 ],
293 "members": 0,
294 "mainAssets": [
295 0
296 ],
297 "premiseNames": [
298 "string"
299 ],
300 "internalTeamAvailable": true,
301 "premiseIds": [
302 0
303 ]
304 }
305 ],
306 "internalTeams": [
307 "string"
308 ],
309 "vendorId": 0,
310 "vendorDto": {
311 "id": 0,
312 "createdBy": "string",
313 "createdAt": "2019-08-24T14:15:22Z",
314 "displayId": "string",
315 "name": "string",
316 "description": "string",
317 "address": "string",
318 "contractEndDate": "2019-08-24",
319 "services": "string",
320 "vendorType": "string",
321 "vendorStatusId": 0,
322 "vendorStatus": "string",
323 "vendorStatusType": "string",
324 "businessTypeId": 0,
325 "businessType": "string",
326 "vendorRateId": 0,
327 "vendorRate": "string",
328 "vendorContactIds": [
329 0
330 ],
331 "premiseIds": [
332 0
333 ],
334 "firstPremiseDisplayId": "string",
335 "ownerUserName": "string",
336 "ownerDto": {
337 "id": 0,
338 "createdBy": "string",
339 "createdAt": "2019-08-24T14:15:22Z",
340 "userName": "string",
341 "firstName": "string",
342 "lastName": "string",
343 "email": "string",
344 "roleIds": [
345 {
346 "id": 0,
347 "createdBy": "string",
348 "createdAt": "2019-08-24T14:15:22Z",
349 "modifiedBy": "string",
350 "modifiedAt": "2019-08-24T14:15:22Z",
351 "roleName": "string",
352 "entity": "string",
353 "new": true
354 }
355 ],
356 "internalTeamNames": [
357 "string"
358 ],
359 "internalTeamIds": [
360 0
361 ],
362 "internalTeamDisplayIds": [
363 "string"
364 ],
365 "premiseIds": [
366 0
367 ],
368 "premiseNames": [
369 "string"
370 ],
371 "userAvailable": true,
372 "temporaryWorkload": 0,
373 "preferredCultureCode": "string"
374 },
375 "vendorAvailable": true,
376 "vendorRating": 0.1,
377 "premiseDisplayIds": [
378 "string"
379 ]
380 },
381 "vendorName": "string",
382 "workOrderTemplateSettings": {
383 "id": 0,
384 "createdBy": "string",
385 "createdAt": "2019-08-24T14:15:22Z",
386 "workOrderId": 0,
387 "startDate": "2019-08-24",
388 "dueDuration": 0,
389 "dueMonths": 0,
390 "endDate": "2019-08-24",
391 "recurringWOPriorityId": 0,
392 "recurringWOPriority": "string",
393 "recurringWOPriorityType": "string",
394 "isTemplate": true,
395 "isRemoveByDate": true,
396 "triggerByWorkOrderStatusId": 0,
397 "triggerByWorkOrderStatus": "string",
398 "triggerByWorkOrderStatusType": "string",
399 "removeByWorkOrderStatusId": 0,
400 "removeByWorkOrderStatus": "string",
401 "removeByWorkOrderStatusType": "string"
402 },
403 "assignedUserIds": [
404 0
405 ],
406 "assignedUserDtos": [
407 {
408 "id": 0,
409 "createdBy": "string",
410 "createdAt": "2019-08-24T14:15:22Z",
411 "userName": "string",
412 "firstName": "string",
413 "lastName": "string",
414 "email": "string",
415 "roleIds": [
416 {
417 "id": 0,
418 "createdBy": "string",
419 "createdAt": "2019-08-24T14:15:22Z",
420 "modifiedBy": "string",
421 "modifiedAt": "2019-08-24T14:15:22Z",
422 "roleName": "string",
423 "entity": "string",
424 "new": true
425 }
426 ],
427 "internalTeamNames": [
428 "string"
429 ],
430 "internalTeamIds": [
431 0
432 ],
433 "internalTeamDisplayIds": [
434 "string"
435 ],
436 "premiseIds": [
437 0
438 ],
439 "premiseNames": [
440 "string"
441 ],
442 "userAvailable": true,
443 "temporaryWorkload": 0,
444 "preferredCultureCode": "string"
445 }
446 ],
447 "assignedUsers": [
448 "string"
449 ],
450 "variableQuantity": 0,
451 "workOrderAvailable": true,
452 "exactPlacement": "string",
453 "primaryWorkOrderId": 0,
454 "primaryWorkOrderDto": {},
455 "primaryWorkOrderDisplayId": "string",
456 "isPrimary": true,
457 "invoiceIds": [
458 0
459 ],
460 "createdByTrigger": true,
461 "internalCosts": "81.08",
462 "invoiceTotal": "81.08",
463 "partsTotal": "81.08",
464 "inspectionItemId": 0,
465 "partIdToAttach": 0
466 },
467 "workOrderDisplayId": "string",
468 "reporterDto": {
469 "id": 0,
470 "createdBy": "string",
471 "createdAt": "2019-08-24T14:15:22Z",
472 "userName": "string",
473 "firstName": "string",
474 "lastName": "string",
475 "email": "string",
476 "roleIds": [
477 {
478 "id": 0,
479 "createdBy": "string",
480 "createdAt": "2019-08-24T14:15:22Z",
481 "modifiedBy": "string",
482 "modifiedAt": "2019-08-24T14:15:22Z",
483 "roleName": "string",
484 "entity": "string",
485 "new": true
486 }
487 ],
488 "internalTeamNames": [
489 "string"
490 ],
491 "internalTeamIds": [
492 0
493 ],
494 "internalTeamDisplayIds": [
495 "string"
496 ],
497 "premiseIds": [
498 0
499 ],
500 "premiseNames": [
501 "string"
502 ],
503 "userAvailable": true,
504 "temporaryWorkload": 0,
505 "preferredCultureCode": "string"
506 },
507 "username": "string",
508 "injuredPersonName": "string",
509 "exactLocation": "string",
510 "injuredPersonRole": "string",
511 "incidentTime": {
512 "hour": 0,
513 "minute": 0,
514 "second": 0,
515 "nano": 0
516 },
517 "injuryTypeAndBodyPartAffected": "string",
518 "severity": "string",
519 "premiseId": 0,
520 "premisesDisplayId": "string",
521 "premisesDto": {
522 "id": 0,
523 "createdBy": "string",
524 "createdAt": "2019-08-24T14:15:22Z",
525 "displayId": "string",
526 "premiseName": "string",
527 "description": "string",
528 "address": "string",
529 "internalTeamNames": [
530 "string"
531 ],
532 "internalTeamIds": [
533 0
534 ],
535 "premiseAvailable": true,
536 "premiseFromNrm": true,
537 "nlmId": 0,
538 "nlmDisplayId": "string",
539 "nlmUsed": true,
540 "manager": 0,
541 "managerName": "string",
542 "imageId": 0,
543 "area": "string",
544 "modifiedAt": "2019-08-24T14:15:22Z"
545 },
546 "workerIncidentAvailable": true,
547 "modifiedAt": "2019-08-24T14:15:22Z",
548 "statusId": 0
549 }
550]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an incident involving a worker, encapsulating relevant details such as incident type, date, and associated metadata for effective incident management and reporting.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» title |
string |
false |
none |
Title of the resource |
» description |
string |
false |
none |
Description of the resource |
» reportDate |
string(date) |
false |
none |
Date of the report |
» statusName |
string |
false |
none |
Name of the status |
» workOrder |
false |
none |
Data transfer object representing a work order, encapsulating essential details such as task specifications, assigned resources, and status updates to facilitate efficient project management and operational workflow. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» name |
string |
false |
none |
Name of the resource |
»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»» description |
string |
false |
none |
Description of the resource |
»» vendorRating |
integer(int32) |
false |
none |
Represents the numerical rating assigned to a vendor, reflecting their performance and reliability in fulfilling work orders. |
»» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
»» premiseDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» premiseName |
string |
false |
none |
Name of the premise |
»»» description |
string |
false |
none |
Description of the resource |
»»» address |
string |
true |
none |
Represents the physical location associated with the premise, essential for logistics and service delivery. |
»»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation within the organization. |
»»» internalTeamIds |
[integer] |
false |
none |
List of unique identifiers representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation. |
»»» premiseAvailable |
boolean |
false |
none |
Indicates whether the premise is available for use within the specified context. |
»»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the premise is sourced from the National Resource Management (NRM) framework, facilitating compliance and reporting within environmental management processes. |
»»» nlmId |
integer(int64) |
false |
none |
Unique identifier for the nlm |
»»» nlmDisplayId |
string |
false |
none |
Unique identifier for the nlm display |
»»» nlmUsed |
boolean |
false |
none |
Indicates whether the National Labor Market (NLM) resources have been utilized in the premise evaluation process. |
»»» manager |
integer(int64) |
false |
none |
Unique identifier for the manager associated with the premise, facilitating effective organizational hierarchy and resource management. |
»»» managerName |
string |
false |
none |
Name of the manager |
»»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»»» area |
string |
false |
none |
Represents the geographic area associated with the premise, providing essential context for location-based services and analysis. |
»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the work order is derived from the National Resource Management system. |
»» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
»» nssProjectId |
integer(int64) |
false |
none |
Unique identifier for the nss project |
»» nssTaskId |
integer(int64) |
false |
none |
Unique identifier for the nss task |
»» nssTaskDisplayId |
string |
false |
none |
Unique identifier for the nss task display |
»» orderDate |
string(date) |
false |
none |
Date of the order |
»» dueDate |
string(date) |
false |
none |
Due date of the resource |
»» startDate |
string(date) |
false |
none |
Start date of the resource |
»» endDate |
string(date) |
false |
none |
End date of the resource |
»» startTime |
false |
none |
Data transfer object representing the local time settings relevant to business operations, ensuring accurate scheduling and time management across various regions. |
|
»»» hour |
integer(int32) |
false |
none |
Represents the hour component of a time value, facilitating precise scheduling and time management within the application. |
»»» minute |
integer(int32) |
false |
none |
Represents the minute component of a local time value, facilitating precise time tracking and scheduling within the application. |
»»» second |
integer(int32) |
false |
none |
Represents the seconds component of a local time value, facilitating precise time tracking and scheduling within the application. |
»»» nano |
integer(int32) |
false |
none |
Represents the nanosecond component of a local time value, facilitating precise time tracking and scheduling within the application. |
»» endTime |
false |
none |
Data transfer object representing the local time settings relevant to business operations, ensuring accurate scheduling and time management across various regions. |
|
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»» estimatedCost |
string |
false |
none |
Estimated cost associated with the work order, providing a financial projection for budgeting and resource allocation. |
»» finalCost |
string |
false |
none |
The finalCost field represents the total cost associated with the completion of a work order, providing essential financial insights for project budgeting and resource allocation. |
»» duration |
integer(int32) |
false |
none |
Represents the total time, in minutes, allocated for the completion of the work order. |
»» estimatedDayTime |
integer(int32) |
false |
none |
Time of the estimated day |
»» finalHourTime |
string |
false |
none |
Time of the final hour |
»» estimatedHourTime |
string |
false |
none |
Time of the estimated hour |
»» closeDate |
string(date) |
false |
none |
Date of the close |
»» inspection |
string |
false |
none |
Describes the specific inspection details associated with the work order, ensuring clarity in task requirements and compliance standards. |
»» workOrderTypeId |
integer(int64) |
false |
none |
Unique identifier for the work order type |
»» workOrderTypeName |
string |
false |
none |
Name of the work order type |
»» workOrderType |
string |
false |
none |
Type of the work order |
»» workOrderPriorityId |
integer(int64) |
false |
none |
Unique identifier for the work order priority |
»» workOrderPriority |
string |
false |
none |
Priority of the work order |
»» workOrderPriorityType |
string |
false |
none |
Type of the work order priority |
»» isTemplate |
boolean |
false |
none |
Whether the resource is template |
»» isWorkOrderTemplate |
boolean |
false |
none |
Whether the resource is work order template |
»» templateId |
integer(int64) |
false |
none |
Unique identifier for the template |
»» isPartsInSufficient |
boolean |
false |
none |
Whether the resource is parts in sufficient |
»» partQuantityInfoList |
false |
none |
List of quantities for each part associated with the work order, providing essential details for inventory management and resource allocation. |
|
»»» partId |
integer(int64) |
false |
none |
Unique identifier for the part |
»»» partDisplayId |
string |
false |
none |
Unique identifier for the part display |
»»» requestedQuantity |
integer(int64) |
false |
none |
Quantity of requested quantity |
»»» availableQuantity |
integer(int64) |
false |
none |
Quantity of available quantity |
»»» usedQuantity |
integer(int64) |
false |
none |
Quantity of used quantity |
»»» sufficient |
boolean |
false |
none |
Indicates whether the quantity of parts available meets the required threshold for operational needs. |
»»» partial |
boolean |
false |
none |
Indicates whether the quantity of parts is partially fulfilled, providing insight into inventory status and order fulfillment. |
»» parentWorkOrderId |
integer(int64) |
false |
none |
Unique identifier for the parent work order |
»» parentWorkOrderDisplayId |
string |
false |
none |
Unique identifier for the parent work order display |
»» parentWorkOrder |
string |
false |
none |
Identifier for the parent work order, establishing a hierarchical relationship within the work order management system. |
»» mainAssetIds |
[integer] |
false |
none |
Array of unique identifiers for the primary assets associated with the work order, facilitating effective asset management and tracking. |
»» mainAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» name |
string |
false |
none |
Name of the resource |
»»» description |
string |
false |
none |
Description of the resource |
»»» qrCode |
string |
false |
none |
Code for the qr |
»»» barCode |
string |
false |
none |
Code for the bar |
»»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»»» model |
string |
false |
none |
Specifies the model associated with the main asset, providing essential context for asset classification and management. |
»»» manufacturer |
string |
false |
none |
Name of the manufacturer associated with the asset, providing essential information for inventory management and supplier relations. |
»»» serialNumber |
string |
false |
none |
Unique identifier for the asset, used to track and manage inventory within the system. |
»»» cost |
string |
false |
none |
Represents the total cost associated with the main asset, providing essential financial information for budgeting and resource allocation. |
»»» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
»»» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
»»» premiseDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
»»» acquisitionDate |
string(date) |
false |
none |
Date of the acquisition |
»»» endOfLife |
string(date) |
false |
none |
Indicates the end-of-life date for the asset, providing critical information for lifecycle management and planning. |
»»» assetStatusId |
integer(int64) |
false |
none |
Unique identifier for the asset status |
»»» assetStatus |
string |
false |
none |
Status of the asset |
»»» assetStatusType |
string |
false |
none |
Type of the asset status |
»»» parentAssetId |
integer(int64) |
false |
none |
Unique identifier for the parent asset |
»»» parentAssetDisplayId |
string |
false |
none |
Unique identifier for the parent asset display |
»»» parentAsset |
string |
false |
none |
Identifier for the parent asset associated with the main asset, facilitating hierarchical relationships within asset management. |
»»» parentAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»»» upcomingMaintenanceDate |
string(date) |
false |
none |
Date of the upcoming maintenance |
»»» assetCategoryIds |
[integer] |
false |
none |
Array of unique identifiers representing the categories to which the asset belongs, facilitating effective asset classification and management. |
»»» assetCategories |
[string] |
false |
none |
Array of asset categories that classify the main assets within the system, facilitating better organization and management of asset data. |
»»» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the main asset, facilitating streamlined collaboration and resource allocation. |
»»» internalTeamDtos |
false |
none |
An array of MainAssetDTO objects representing the internal teams associated with the asset, facilitating effective resource management and collaboration within the organization. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»»» name |
string |
false |
none |
Name of the resource |
string |
false |
none |
Email address of the internal team member, used for communication and notifications within the organization. |
|
»»»» phone |
string |
false |
none |
Contact number for the internal team, facilitating communication and collaboration within the organization. |
»»»» manager |
string |
false |
none |
Represents the name or identifier of the team manager responsible for overseeing the internal team. |
»»»» requestCategoryName |
[string] |
false |
none |
Name of the request category |
»»»» requestCategoryId |
[integer] |
false |
none |
Unique identifier for the request category |
»»»» requestCategoryDisplayId |
[string] |
false |
none |
Unique identifier for the request category display |
»»»» description |
string |
false |
none |
Description of the resource |
»»»» internalTeamUser |
[integer] |
false |
none |
An array of InternalTeamDTO objects representing the users within the internal team, facilitating collaboration and resource management. |
»»»» members |
integer(int32) |
false |
none |
Represents the total number of members within the internal team, providing insight into team size for resource allocation and management. |
»»»» mainAssets |
[integer] |
false |
none |
An array of internal team assets that represent the key resources and capabilities utilized within the organization. |
»»»» premiseNames |
[string] |
false |
none |
List of names associated with the premises relevant to the internal team, facilitating efficient identification and management of locations within the organization. |
»»»» internalTeamAvailable |
boolean |
false |
none |
Indicates the availability of the internal team for project allocation and resource planning. |
»»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the internal team. |
»»» internalTeams |
[string] |
false |
none |
An array of internal teams associated with the main asset, facilitating collaboration and resource allocation within the organization. |
»»» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers representing users assigned to the main asset, facilitating effective resource management and accountability. |
»»» assignedUserDtos |
false |
none |
Array of user assignments associated with the main asset, providing insights into resource allocation and accountability. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»»» userName |
string |
false |
none |
Name of the user |
»»»» firstName |
string |
false |
none |
Name of the first |
»»»» lastName |
string |
false |
none |
Name of the last |
string |
false |
none |
Email address of the user, used for communication and account verification purposes within the system. |
|
»»»» roleIds |
false |
none |
Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system. |
|
»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»»»» modifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»»»»» roleName |
string |
false |
none |
Name of the role |
»»»»» entity |
string |
false |
none |
Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management. |
»»»»» new |
boolean |
false |
none |
Indicates whether the role is newly created within the system, facilitating effective management of organizational changes. |
»»»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization. |
»»»» internalTeamIds |
[integer] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization. |
»»»» internalTeamDisplayIds |
[string] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration. |
»»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations. |
»»»» premiseNames |
[string] |
false |
none |
List of names associated with the user’s premises, providing essential context for location-based services and operations. |
»»»» userAvailable |
boolean |
false |
none |
Indicates whether the user is available for assignment or engagement within the system. |
»»»» temporaryWorkload |
integer(int32) |
false |
none |
Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning. |
»»»» preferredCultureCode |
string |
false |
none |
Code for the preferred culture |
»»» assignedUsers |
[string] |
false |
none |
List of users assigned to the main asset, facilitating effective resource management and collaboration within the organization. |
»»» assetPriority |
string |
false |
none |
Priority of the asset |
»»» assetPriorityId |
integer(int64) |
false |
none |
Unique identifier for the asset priority |
»»» assetPriorityDisplayId |
string |
false |
none |
Unique identifier for the asset priority display |
»»» assetPriorityType |
string |
false |
none |
Type of the asset priority |
»»» assetAvailable |
boolean |
false |
none |
Indicates whether the asset is currently available for allocation or use within the system. |
»»» exactPlacement |
string |
false |
none |
Specifies the precise location or context in which the main asset is intended to be utilized within the business framework. |
»»» fosId |
integer(int64) |
false |
none |
Unique identifier for the fos |
»»» downtimeStatus |
string |
false |
none |
Status of the downtime |
»»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the asset is sourced from the National Resource Management (NRM) framework, facilitating compliance and resource tracking. |
»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»» mainAssetDisplayId |
string |
false |
none |
Unique identifier for the main asset display |
»» workOrderStatusId |
integer(int64) |
false |
none |
Unique identifier for the work order status |
»» workOrderStatus |
string |
false |
none |
Status of the work order |
»» workOrderStatusType |
string |
false |
none |
Type of the work order status |
»» requestIds |
[integer] |
false |
none |
An array of unique identifiers for the associated work orders, facilitating tracking and management within the system. |
»» internalTeamIds |
[integer] |
false |
none |
List of unique identifiers representing the internal teams associated with the work order, facilitating effective resource allocation and collaboration. |
»» internalTeamDtos |
false |
none |
An array of WorkOrderDTO objects representing the internal teams associated with the work order, facilitating efficient resource allocation and management. |
|
»» internalTeams |
[string] |
false |
none |
List of internal teams associated with the work order, facilitating collaboration and resource allocation within the organization. |
»» vendorId |
integer(int64) |
false |
none |
Unique identifier for the vendor |
»» vendorDto |
false |
none |
Data transfer object representing a vendor, encapsulating essential details such as vendor identification, contact information, and service offerings to facilitate effective supplier management and collaboration. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» name |
string |
false |
none |
Name of the resource |
»»» description |
string |
false |
none |
Description of the resource |
»»» address |
string |
false |
none |
Represents the physical location of the vendor, essential for logistical coordination and service delivery. |
»»» contractEndDate |
string(date) |
false |
none |
Date of the contract end |
»»» services |
string |
false |
none |
Represents the list of services offered by the vendor, essential for evaluating vendor capabilities and aligning them with business needs. |
»»» vendorType |
string |
false |
none |
Type of the vendor |
»»» vendorStatusId |
integer(int64) |
false |
none |
Unique identifier for the vendor status |
»»» vendorStatus |
string |
false |
none |
Status of the vendor |
»»» vendorStatusType |
string |
false |
none |
Type of the vendor status |
»»» businessTypeId |
integer(int64) |
false |
none |
Unique identifier for the business type |
»»» businessType |
string |
false |
none |
Type of the business |
»»» vendorRateId |
integer(int64) |
false |
none |
Unique identifier for the vendor rate |
»»» vendorRate |
string |
false |
none |
Rate of vendor |
»»» vendorContactIds |
[integer] |
false |
none |
Array of unique identifiers for vendor contacts associated with the vendor, facilitating streamlined communication and management of vendor relationships. |
»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the vendor, facilitating streamlined management and tracking of vendor relationships. |
»»» firstPremiseDisplayId |
string |
false |
none |
Unique identifier for the first premise display |
»»» ownerUserName |
string |
false |
none |
Name of the owner user |
»»» ownerDto |
false |
none |
Data transfer object representing a user profile within the system, encapsulating essential user information and attributes for effective management and interaction across business applications. |
|
»»» vendorAvailable |
boolean |
false |
none |
Indicates whether the vendor is currently available for new engagements. |
»»» vendorRating |
number(double) |
false |
none |
Numeric representation of the vendor’s performance rating, used to assess and compare vendor quality within the procurement process. |
»»» premiseDisplayIds |
[string] |
false |
none |
Array of unique identifiers for the premises associated with the vendor, facilitating streamlined management and reference within the system. |
»» vendorName |
string |
false |
none |
Name of the vendor |
»» workOrderTemplateSettings |
false |
none |
Data transfer object representing the settings and configurations for work order templates, facilitating streamlined management and customization of work orders within the enterprise workflow. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» workOrderId |
integer(int64) |
false |
none |
Unique identifier for the work order |
»»» startDate |
string(date) |
false |
none |
Start date of the resource |
»»» dueDuration |
integer(int32) |
false |
none |
Specifies the duration, in minutes, for which a work order is due, facilitating effective scheduling and resource allocation. |
»»» dueMonths |
integer(int32) |
false |
none |
Specifies the number of months until the work order is due, facilitating effective scheduling and resource allocation. |
»»» endDate |
string(date) |
false |
none |
End date of the resource |
»»» recurringWOPriorityId |
integer(int64) |
false |
none |
Unique identifier for the recurring w o priority |
»»» recurringWOPriority |
string |
false |
none |
Priority of the recurring w o |
»»» recurringWOPriorityType |
string |
false |
none |
Type of the recurring w o priority |
»»» isTemplate |
boolean |
false |
none |
Whether the resource is template |
»»» isRemoveByDate |
boolean |
false |
none |
Whether the resource is remove by |
»»» triggerByWorkOrderStatusId |
integer(int64) |
false |
none |
Unique identifier for the trigger by work order status |
»»» triggerByWorkOrderStatus |
string |
false |
none |
Status of the trigger by work order |
»»» triggerByWorkOrderStatusType |
string |
false |
none |
Type of the trigger by work order status |
»»» removeByWorkOrderStatusId |
integer(int64) |
false |
none |
Unique identifier for the remove by work order status |
»»» removeByWorkOrderStatus |
string |
false |
none |
Status of the remove by work order |
»»» removeByWorkOrderStatusType |
string |
false |
none |
Type of the remove by work order status |
»» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers for users assigned to the work order, facilitating effective resource allocation and management. |
»» assignedUserDtos |
false |
none |
Array of user assignments associated with the work order, providing visibility into the personnel responsible for its execution. |
|
»» assignedUsers |
[string] |
false |
none |
List of users assigned to the work order, facilitating effective task management and resource allocation. |
»» variableQuantity |
integer(int64) |
false |
none |
Quantity of variable quantity |
»» workOrderAvailable |
boolean |
false |
none |
Indicates whether a work order is currently available for processing within the system. |
»» exactPlacement |
string |
false |
none |
Specifies the precise location or arrangement for the execution of the work order, ensuring clarity in task assignment and resource allocation. |
»» primaryWorkOrderId |
integer(int64) |
false |
none |
Unique identifier for the primary work order |
»» primaryWorkOrderDto |
false |
none |
Data transfer object representing a work order, encapsulating essential details such as task specifications, assigned resources, and status updates to facilitate efficient project management and operational workflow. |
|
»» primaryWorkOrderDisplayId |
string |
false |
none |
Unique identifier for the primary work order display |
»» isPrimary |
boolean |
false |
none |
Whether the resource is primary |
»» invoiceIds |
[integer] |
false |
none |
Array of unique identifiers for invoices associated with the work order, facilitating efficient tracking and management of financial transactions. |
»» createdByTrigger |
boolean |
false |
none |
Indicates whether the work order was created automatically by a trigger event within the system. |
»» internalCosts |
string |
false |
none |
Represents the internal costs associated with the work order, providing essential financial insights for effective budget management. |
»» invoiceTotal |
string |
false |
none |
Total invoice |
»» partsTotal |
string |
false |
none |
Total parts |
»» inspectionItemId |
integer(int64) |
false |
none |
Unique identifier for the inspection item |
»» partIdToAttach |
integer(int64) |
false |
none |
Unique identifier for the part to be attached to the work order, facilitating efficient tracking and management of resources. |
»» recurringWOIsTemplate |
boolean |
false |
write-only |
Indicates whether the work order is based on a recurring template, facilitating streamlined management of repeat tasks. |
»» recurringWOStartDate |
string(date) |
false |
write-only |
Date of the recurring w o start |
»» recurringWOEndDate |
string(date) |
false |
write-only |
Date of the recurring w o end |
»» recurringWODueDuration |
integer(int32) |
false |
write-only |
Specifies the duration, in days, for which a work order is set to recur, facilitating effective scheduling and resource allocation. |
»» recurringWODueMonths |
integer(int32) |
false |
write-only |
Specifies the number of months for which the work order is set to recur, facilitating effective scheduling and resource allocation. |
»» recurringWOPriority |
string |
false |
write-only |
Priority of the recurring w o |
»» recurringWOIsRemoveByDate |
boolean |
false |
write-only |
Date of the recurring w o is remove by |
»» triggerByWorkOrderStatus |
string |
false |
write-only |
Status of the trigger by work order |
»» removeByWorkOrderStatus |
string |
false |
write-only |
Status of the remove by work order |
»» recurringWOPriorityType |
string |
false |
write-only |
Type of the recurring w o priority |
»» triggerByWorkOrderStatusType |
string |
false |
write-only |
Type of the trigger by work order status |
»» removeByWorkOrderStatusType |
string |
false |
write-only |
Type of the remove by work order status |
»» recurringWOPriorityId |
integer(int64) |
false |
write-only |
Unique identifier for the recurring w o priority |
»» triggerByWorkOrderStatusId |
integer(int64) |
false |
write-only |
Unique identifier for the trigger by work order status |
»» removeByWorkOrderStatusId |
integer(int64) |
false |
write-only |
Unique identifier for the remove by work order status |
» workOrderDisplayId |
string |
false |
none |
Unique identifier for the work order display |
» reporterDto |
false |
none |
Data transfer object representing a user profile within the system, encapsulating essential user information and attributes for effective management and interaction across business applications. |
|
» username |
string |
false |
none |
Represents the unique identifier for the user within the system, facilitating user-specific incident tracking and management. |
» injuredPersonName |
string |
false |
none |
Name of the injured person |
» exactLocation |
string |
false |
none |
Represents the precise geographical location associated with a worker incident, facilitating accurate reporting and analysis. |
» injuredPersonRole |
string |
false |
none |
Indicates the role of the individual involved in the incident, providing essential context for incident reporting and analysis. |
» incidentTime |
false |
none |
Data transfer object representing the local time settings relevant to business operations, ensuring accurate scheduling and time management across various regions. |
|
» injuryTypeAndBodyPartAffected |
string |
false |
none |
Describes the specific type of injury and the body part affected, facilitating accurate reporting and analysis of worker incidents. |
» severity |
string |
false |
none |
Indicates the level of seriousness associated with a worker incident, facilitating prioritization and response in incident management. |
» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
» premisesDisplayId |
string |
false |
none |
Unique identifier for the premises display |
» premisesDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
» workerIncidentAvailable |
boolean |
false |
none |
Indicates whether there are any available incidents reported for the worker, facilitating effective incident management and response. |
» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
Get All Active Worker Incident Status Type IDs¶
HTTP Request
GET /api/workerIncidents/allActiveWorkerIncidentStatusTypes
📋 Description: Retrieves a comprehensive list of all active worker incident status types, enabling organizations to effectively monitor and manage ongoing incidents within their workforce.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]