Work Order¶
Get Work Order¶
HTTP Request
GET /api/workOrders/{id}
📋 Description: Retrieves detailed information about a specific work order identified by its unique ID, enabling users to access essential data for effective project management and operational oversight.
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 "name": "string",
7 "imageId": 0,
8 "description": "string",
9 "vendorRating": 0,
10 "premiseId": 0,
11 "premiseDto": {
12 "id": 0,
13 "createdBy": "string",
14 "createdAt": "2019-08-24T14:15:22Z",
15 "displayId": "string",
16 "premiseName": "string",
17 "description": "string",
18 "address": "string",
19 "internalTeamNames": [
20 "string"
21 ],
22 "internalTeamIds": [
23 0
24 ],
25 "premiseAvailable": true,
26 "premiseFromNrm": true,
27 "nlmId": 0,
28 "nlmDisplayId": "string",
29 "nlmUsed": true,
30 "manager": 0,
31 "managerName": "string",
32 "imageId": 0,
33 "area": "string",
34 "modifiedAt": "2019-08-24T14:15:22Z"
35 },
36 "premiseFromNrm": true,
37 "premiseDisplayId": "string",
38 "nssProjectId": 0,
39 "nssTaskId": 0,
40 "nssTaskDisplayId": "string",
41 "orderDate": "2019-08-24",
42 "dueDate": "2019-08-24",
43 "startDate": "2019-08-24",
44 "endDate": "2019-08-24",
45 "startTime": {
46 "hour": 0,
47 "minute": 0,
48 "second": 0,
49 "nano": 0
50 },
51 "endTime": {
52 "hour": 0,
53 "minute": 0,
54 "second": 0,
55 "nano": 0
56 },
57 "modifiedAt": "2019-08-24T14:15:22Z",
58 "estimatedCost": "81.08",
59 "finalCost": "81.08",
60 "duration": 0,
61 "estimatedDayTime": 0,
62 "finalHourTime": "2.5",
63 "estimatedHourTime": "2.5",
64 "closeDate": "2019-08-24",
65 "inspection": "string",
66 "workOrderTypeId": 0,
67 "workOrderTypeName": "string",
68 "workOrderType": "string",
69 "workOrderPriorityId": 0,
70 "workOrderPriority": "string",
71 "workOrderPriorityType": "string",
72 "isTemplate": true,
73 "isWorkOrderTemplate": true,
74 "templateId": 0,
75 "isPartsInSufficient": true,
76 "partQuantityInfoList": [
77 {
78 "partId": 0,
79 "partDisplayId": "string",
80 "requestedQuantity": 0,
81 "availableQuantity": 0,
82 "usedQuantity": 0,
83 "sufficient": true,
84 "partial": true
85 }
86 ],
87 "parentWorkOrderId": 0,
88 "parentWorkOrderDisplayId": "string",
89 "parentWorkOrder": "string",
90 "mainAssetIds": [
91 0
92 ],
93 "mainAssetDto": {
94 "id": 0,
95 "createdBy": "string",
96 "createdAt": "2019-08-24T14:15:22Z",
97 "displayId": "string",
98 "name": "string",
99 "description": "string",
100 "qrCode": "string",
101 "barCode": "string",
102 "imageId": 0,
103 "model": "string",
104 "manufacturer": "string",
105 "serialNumber": "string",
106 "cost": "81.08",
107 "premiseId": 0,
108 "premiseDisplayId": "string",
109 "premiseDto": {
110 "id": 0,
111 "createdBy": "string",
112 "createdAt": "2019-08-24T14:15:22Z",
113 "displayId": "string",
114 "premiseName": "string",
115 "description": "string",
116 "address": "string",
117 "internalTeamNames": [
118 "string"
119 ],
120 "internalTeamIds": [
121 0
122 ],
123 "premiseAvailable": true,
124 "premiseFromNrm": true,
125 "nlmId": 0,
126 "nlmDisplayId": "string",
127 "nlmUsed": true,
128 "manager": 0,
129 "managerName": "string",
130 "imageId": 0,
131 "area": "string",
132 "modifiedAt": "2019-08-24T14:15:22Z"
133 },
134 "acquisitionDate": "2019-08-24",
135 "endOfLife": "2019-08-24",
136 "assetStatusId": 0,
137 "assetStatus": "string",
138 "assetStatusType": "string",
139 "parentAssetId": 0,
140 "parentAssetDisplayId": "string",
141 "parentAsset": "string",
142 "parentAssetDto": {},
143 "upcomingMaintenanceDate": "2019-08-24",
144 "assetCategoryIds": [
145 0
146 ],
147 "assetCategories": [
148 "string"
149 ],
150 "internalTeamIds": [
151 0
152 ],
153 "internalTeamDtos": [
154 {
155 "id": 0,
156 "createdBy": "string",
157 "createdAt": "2019-08-24T14:15:22Z",
158 "displayId": "string",
159 "name": "string",
160 "email": "string",
161 "phone": "string",
162 "manager": "string",
163 "requestCategoryName": [
164 "string"
165 ],
166 "requestCategoryId": [
167 0
168 ],
169 "requestCategoryDisplayId": [
170 "string"
171 ],
172 "description": "string",
173 "internalTeamUser": [
174 0
175 ],
176 "members": 0,
177 "mainAssets": [
178 0
179 ],
180 "premiseNames": [
181 "string"
182 ],
183 "internalTeamAvailable": true,
184 "premiseIds": [
185 0
186 ]
187 }
188 ],
189 "internalTeams": [
190 "string"
191 ],
192 "assignedUserIds": [
193 0
194 ],
195 "assignedUserDtos": [
196 {
197 "id": 0,
198 "createdBy": "string",
199 "createdAt": "2019-08-24T14:15:22Z",
200 "userName": "string",
201 "firstName": "string",
202 "lastName": "string",
203 "email": "string",
204 "roleIds": [
205 0
206 ],
207 "internalTeamNames": [
208 "string"
209 ],
210 "internalTeamIds": [
211 0
212 ],
213 "internalTeamDisplayIds": [
214 "string"
215 ],
216 "premiseIds": [
217 0
218 ],
219 "premiseNames": [
220 "string"
221 ],
222 "userAvailable": true,
223 "temporaryWorkload": 0,
224 "preferredCultureCode": "string"
225 }
226 ],
227 "assignedUsers": [
228 "string"
229 ],
230 "assetPriority": "string",
231 "assetPriorityId": 0,
232 "assetPriorityDisplayId": "string",
233 "assetPriorityType": "string",
234 "assetAvailable": true,
235 "exactPlacement": "string",
236 "fosId": 0,
237 "downtimeStatus": "string",
238 "premiseFromNrm": true,
239 "modifiedAt": "2019-08-24T14:15:22Z"
240 },
241 "mainAssetDisplayId": "string",
242 "workOrderStatusId": 0,
243 "workOrderStatus": "string",
244 "workOrderStatusType": "string",
245 "requestIds": [
246 0
247 ],
248 "internalTeamIds": [
249 0
250 ],
251 "internalTeamDtos": [
252 {
253 "id": 0,
254 "createdBy": "string",
255 "createdAt": "2019-08-24T14:15:22Z",
256 "displayId": "string",
257 "name": "string",
258 "email": "string",
259 "phone": "string",
260 "manager": "string",
261 "requestCategoryName": [
262 "string"
263 ],
264 "requestCategoryId": [
265 0
266 ],
267 "requestCategoryDisplayId": [
268 "string"
269 ],
270 "description": "string",
271 "internalTeamUser": [
272 0
273 ],
274 "members": 0,
275 "mainAssets": [
276 0
277 ],
278 "premiseNames": [
279 "string"
280 ],
281 "internalTeamAvailable": true,
282 "premiseIds": [
283 0
284 ]
285 }
286 ],
287 "internalTeams": [
288 "string"
289 ],
290 "vendorId": 0,
291 "vendorDto": {
292 "id": 0,
293 "createdBy": "string",
294 "createdAt": "2019-08-24T14:15:22Z",
295 "displayId": "string",
296 "name": "string",
297 "description": "string",
298 "address": "string",
299 "contractEndDate": "2019-08-24",
300 "services": "string",
301 "vendorType": "string",
302 "vendorStatusId": 0,
303 "vendorStatus": "string",
304 "vendorStatusType": "string",
305 "businessTypeId": 0,
306 "businessType": "string",
307 "vendorRateId": 0,
308 "vendorRate": "string",
309 "vendorContactIds": [
310 0
311 ],
312 "premiseIds": [
313 0
314 ],
315 "firstPremiseDisplayId": "string",
316 "ownerUserName": "string",
317 "ownerDto": {
318 "id": 0,
319 "createdBy": "string",
320 "createdAt": "2019-08-24T14:15:22Z",
321 "userName": "string",
322 "firstName": "string",
323 "lastName": "string",
324 "email": "string",
325 "roleIds": [
326 0
327 ],
328 "internalTeamNames": [
329 "string"
330 ],
331 "internalTeamIds": [
332 0
333 ],
334 "internalTeamDisplayIds": [
335 "string"
336 ],
337 "premiseIds": [
338 0
339 ],
340 "premiseNames": [
341 "string"
342 ],
343 "userAvailable": true,
344 "temporaryWorkload": 0,
345 "preferredCultureCode": "string"
346 },
347 "vendorAvailable": true,
348 "vendorRating": 0.1,
349 "premiseDisplayIds": [
350 "string"
351 ]
352 },
353 "vendorName": "string",
354 "workOrderTemplateSettings": {
355 "id": 0,
356 "createdBy": "string",
357 "createdAt": "2019-08-24T14:15:22Z",
358 "workOrderId": 0,
359 "startDate": "2019-08-24",
360 "dueDuration": 0,
361 "dueMonths": 0,
362 "endDate": "2019-08-24",
363 "recurringWOPriorityId": 0,
364 "recurringWOPriority": "string",
365 "recurringWOPriorityType": "string",
366 "isTemplate": true,
367 "isRemoveByDate": true,
368 "triggerByWorkOrderStatusId": 0,
369 "triggerByWorkOrderStatus": "string",
370 "triggerByWorkOrderStatusType": "string",
371 "removeByWorkOrderStatusId": 0,
372 "removeByWorkOrderStatus": "string",
373 "removeByWorkOrderStatusType": "string"
374 },
375 "assignedUserIds": [
376 0
377 ],
378 "assignedUserDtos": [
379 {
380 "id": 0,
381 "createdBy": "string",
382 "createdAt": "2019-08-24T14:15:22Z",
383 "userName": "string",
384 "firstName": "string",
385 "lastName": "string",
386 "email": "string",
387 "roleIds": [
388 0
389 ],
390 "internalTeamNames": [
391 "string"
392 ],
393 "internalTeamIds": [
394 0
395 ],
396 "internalTeamDisplayIds": [
397 "string"
398 ],
399 "premiseIds": [
400 0
401 ],
402 "premiseNames": [
403 "string"
404 ],
405 "userAvailable": true,
406 "temporaryWorkload": 0,
407 "preferredCultureCode": "string"
408 }
409 ],
410 "assignedUsers": [
411 "string"
412 ],
413 "variableQuantity": 0,
414 "workOrderAvailable": true,
415 "exactPlacement": "string",
416 "primaryWorkOrderId": 0,
417 "primaryWorkOrderDto": {
418 "id": 0,
419 "createdBy": "string",
420 "createdAt": "2019-08-24T14:15:22Z",
421 "displayId": "string",
422 "name": "string",
423 "imageId": 0,
424 "description": "string",
425 "vendorRating": 0,
426 "premiseId": 0,
427 "premiseDto": {
428 "id": 0,
429 "createdBy": "string",
430 "createdAt": "2019-08-24T14:15:22Z",
431 "displayId": "string",
432 "premiseName": "string",
433 "description": "string",
434 "address": "string",
435 "internalTeamNames": [
436 "string"
437 ],
438 "internalTeamIds": [
439 0
440 ],
441 "premiseAvailable": true,
442 "premiseFromNrm": true,
443 "nlmId": 0,
444 "nlmDisplayId": "string",
445 "nlmUsed": true,
446 "manager": 0,
447 "managerName": "string",
448 "imageId": 0,
449 "area": "string",
450 "modifiedAt": "2019-08-24T14:15:22Z"
451 },
452 "premiseFromNrm": true,
453 "premiseDisplayId": "string",
454 "nssProjectId": 0,
455 "nssTaskId": 0,
456 "nssTaskDisplayId": "string",
457 "orderDate": "2019-08-24",
458 "dueDate": "2019-08-24",
459 "startDate": "2019-08-24",
460 "endDate": "2019-08-24",
461 "startTime": {
462 "hour": 0,
463 "minute": 0,
464 "second": 0,
465 "nano": 0
466 },
467 "endTime": {
468 "hour": 0,
469 "minute": 0,
470 "second": 0,
471 "nano": 0
472 },
473 "modifiedAt": "2019-08-24T14:15:22Z",
474 "estimatedCost": "81.08",
475 "finalCost": "81.08",
476 "duration": 0,
477 "estimatedDayTime": 0,
478 "finalHourTime": "2.5",
479 "estimatedHourTime": "2.5",
480 "closeDate": "2019-08-24",
481 "inspection": "string",
482 "workOrderTypeId": 0,
483 "workOrderTypeName": "string",
484 "workOrderType": "string",
485 "workOrderPriorityId": 0,
486 "workOrderPriority": "string",
487 "workOrderPriorityType": "string",
488 "isTemplate": true,
489 "isWorkOrderTemplate": true,
490 "templateId": 0,
491 "isPartsInSufficient": true,
492 "partQuantityInfoList": [
493 {
494 "partId": 0,
495 "partDisplayId": "string",
496 "requestedQuantity": 0,
497 "availableQuantity": 0,
498 "usedQuantity": 0,
499 "sufficient": true,
500 "partial": true
501 }
502 ],
503 "parentWorkOrderId": 0,
504 "parentWorkOrderDisplayId": "string",
505 "parentWorkOrder": "string",
506 "mainAssetIds": [
507 0
508 ],
509 "mainAssetDto": {
510 "id": 0,
511 "createdBy": "string",
512 "createdAt": "2019-08-24T14:15:22Z",
513 "displayId": "string",
514 "name": "string",
515 "description": "string",
516 "qrCode": "string",
517 "barCode": "string",
518 "imageId": 0,
519 "model": "string",
520 "manufacturer": "string",
521 "serialNumber": "string",
522 "cost": "81.08",
523 "premiseId": 0,
524 "premiseDisplayId": "string",
525 "premiseDto": {
526 "id": 0,
527 "createdBy": "string",
528 "createdAt": "2019-08-24T14:15:22Z",
529 "displayId": "string",
530 "premiseName": "string",
531 "description": "string",
532 "address": "string",
533 "internalTeamNames": [
534 "string"
535 ],
536 "internalTeamIds": [
537 0
538 ],
539 "premiseAvailable": true,
540 "premiseFromNrm": true,
541 "nlmId": 0,
542 "nlmDisplayId": "string",
543 "nlmUsed": true,
544 "manager": 0,
545 "managerName": "string",
546 "imageId": 0,
547 "area": "string",
548 "modifiedAt": "2019-08-24T14:15:22Z"
549 },
550 "acquisitionDate": "2019-08-24",
551 "endOfLife": "2019-08-24",
552 "assetStatusId": 0,
553 "assetStatus": "string",
554 "assetStatusType": "string",
555 "parentAssetId": 0,
556 "parentAssetDisplayId": "string",
557 "parentAsset": "string",
558 "parentAssetDto": {},
559 "upcomingMaintenanceDate": "2019-08-24",
560 "assetCategoryIds": [
561 0
562 ],
563 "assetCategories": [
564 "string"
565 ],
566 "internalTeamIds": [
567 0
568 ],
569 "internalTeamDtos": [
570 {
571 "id": 0,
572 "createdBy": "string",
573 "createdAt": "2019-08-24T14:15:22Z",
574 "displayId": "string",
575 "name": "string",
576 "email": "string",
577 "phone": "string",
578 "manager": "string",
579 "requestCategoryName": [
580 "string"
581 ],
582 "requestCategoryId": [
583 0
584 ],
585 "requestCategoryDisplayId": [
586 "string"
587 ],
588 "description": "string",
589 "internalTeamUser": [
590 0
591 ],
592 "members": 0,
593 "mainAssets": [
594 0
595 ],
596 "premiseNames": [
597 "string"
598 ],
599 "internalTeamAvailable": true,
600 "premiseIds": [
601 0
602 ]
603 }
604 ],
605 "internalTeams": [
606 "string"
607 ],
608 "assignedUserIds": [
609 0
610 ],
611 "assignedUserDtos": [
612 {
613 "id": 0,
614 "createdBy": "string",
615 "createdAt": "2019-08-24T14:15:22Z",
616 "userName": "string",
617 "firstName": "string",
618 "lastName": "string",
619 "email": "string",
620 "roleIds": [
621 0
622 ],
623 "internalTeamNames": [
624 "string"
625 ],
626 "internalTeamIds": [
627 0
628 ],
629 "internalTeamDisplayIds": [
630 "string"
631 ],
632 "premiseIds": [
633 0
634 ],
635 "premiseNames": [
636 "string"
637 ],
638 "userAvailable": true,
639 "temporaryWorkload": 0,
640 "preferredCultureCode": "string"
641 }
642 ],
643 "assignedUsers": [
644 "string"
645 ],
646 "assetPriority": "string",
647 "assetPriorityId": 0,
648 "assetPriorityDisplayId": "string",
649 "assetPriorityType": "string",
650 "assetAvailable": true,
651 "exactPlacement": "string",
652 "fosId": 0,
653 "downtimeStatus": "string",
654 "premiseFromNrm": true,
655 "modifiedAt": "2019-08-24T14:15:22Z"
656 },
657 "mainAssetDisplayId": "string",
658 "workOrderStatusId": 0,
659 "workOrderStatus": "string",
660 "workOrderStatusType": "string",
661 "requestIds": [
662 0
663 ],
664 "internalTeamIds": [
665 0
666 ],
667 "internalTeamDtos": [
668 {
669 "id": 0,
670 "createdBy": "string",
671 "createdAt": "2019-08-24T14:15:22Z",
672 "displayId": "string",
673 "name": "string",
674 "email": "string",
675 "phone": "string",
676 "manager": "string",
677 "requestCategoryName": [
678 "string"
679 ],
680 "requestCategoryId": [
681 0
682 ],
683 "requestCategoryDisplayId": [
684 "string"
685 ],
686 "description": "string",
687 "internalTeamUser": [
688 0
689 ],
690 "members": 0,
691 "mainAssets": [
692 0
693 ],
694 "premiseNames": [
695 "string"
696 ],
697 "internalTeamAvailable": true,
698 "premiseIds": [
699 0
700 ]
701 }
702 ],
703 "internalTeams": [
704 "string"
705 ],
706 "vendorId": 0,
707 "vendorDto": {
708 "id": 0,
709 "createdBy": "string",
710 "createdAt": "2019-08-24T14:15:22Z",
711 "displayId": "string",
712 "name": "string",
713 "description": "string",
714 "address": "string",
715 "contractEndDate": "2019-08-24",
716 "services": "string",
717 "vendorType": "string",
718 "vendorStatusId": 0,
719 "vendorStatus": "string",
720 "vendorStatusType": "string",
721 "businessTypeId": 0,
722 "businessType": "string",
723 "vendorRateId": 0,
724 "vendorRate": "string",
725 "vendorContactIds": [
726 0
727 ],
728 "premiseIds": [
729 0
730 ],
731 "firstPremiseDisplayId": "string",
732 "ownerUserName": "string",
733 "ownerDto": {
734 "id": 0,
735 "createdBy": "string",
736 "createdAt": "2019-08-24T14:15:22Z",
737 "userName": "string",
738 "firstName": "string",
739 "lastName": "string",
740 "email": "string",
741 "roleIds": [
742 0
743 ],
744 "internalTeamNames": [
745 "string"
746 ],
747 "internalTeamIds": [
748 0
749 ],
750 "internalTeamDisplayIds": [
751 "string"
752 ],
753 "premiseIds": [
754 0
755 ],
756 "premiseNames": [
757 "string"
758 ],
759 "userAvailable": true,
760 "temporaryWorkload": 0,
761 "preferredCultureCode": "string"
762 },
763 "vendorAvailable": true,
764 "vendorRating": 0.1,
765 "premiseDisplayIds": [
766 "string"
767 ]
768 },
769 "vendorName": "string",
770 "workOrderTemplateSettings": {
771 "id": 0,
772 "createdBy": "string",
773 "createdAt": "2019-08-24T14:15:22Z",
774 "workOrderId": 0,
775 "startDate": "2019-08-24",
776 "dueDuration": 0,
777 "dueMonths": 0,
778 "endDate": "2019-08-24",
779 "recurringWOPriorityId": 0,
780 "recurringWOPriority": "string",
781 "recurringWOPriorityType": "string",
782 "isTemplate": true,
783 "isRemoveByDate": true,
784 "triggerByWorkOrderStatusId": 0,
785 "triggerByWorkOrderStatus": "string",
786 "triggerByWorkOrderStatusType": "string",
787 "removeByWorkOrderStatusId": 0,
788 "removeByWorkOrderStatus": "string",
789 "removeByWorkOrderStatusType": "string"
790 },
791 "assignedUserIds": [
792 0
793 ],
794 "assignedUserDtos": [
795 {
796 "id": 0,
797 "createdBy": "string",
798 "createdAt": "2019-08-24T14:15:22Z",
799 "userName": "string",
800 "firstName": "string",
801 "lastName": "string",
802 "email": "string",
803 "roleIds": [
804 0
805 ],
806 "internalTeamNames": [
807 "string"
808 ],
809 "internalTeamIds": [
810 0
811 ],
812 "internalTeamDisplayIds": [
813 "string"
814 ],
815 "premiseIds": [
816 0
817 ],
818 "premiseNames": [
819 "string"
820 ],
821 "userAvailable": true,
822 "temporaryWorkload": 0,
823 "preferredCultureCode": "string"
824 }
825 ],
826 "assignedUsers": [
827 "string"
828 ],
829 "variableQuantity": 0,
830 "workOrderAvailable": true,
831 "exactPlacement": "string",
832 "primaryWorkOrderId": 0,
833 "primaryWorkOrderDto": {},
834 "primaryWorkOrderDisplayId": "string",
835 "isPrimary": true,
836 "invoiceIds": [
837 0
838 ],
839 "createdByTrigger": true,
840 "internalCosts": "81.08",
841 "invoiceTotal": "81.08",
842 "partsTotal": "81.08",
843 "inspectionItemId": 0,
844 "partIdToAttach": 0
845 },
846 "primaryWorkOrderDisplayId": "string",
847 "isPrimary": true,
848 "invoiceIds": [
849 0
850 ],
851 "createdByTrigger": true,
852 "internalCosts": "81.08",
853 "invoiceTotal": "81.08",
854 "partsTotal": "81.08",
855 "inspectionItemId": 0,
856 "partIdToAttach": 0
857}
Update Work Order Status¶
HTTP Request
PUT /api/workOrders/{id}
📋 Description: Updates the details of a specific work order identified by its unique ID, allowing for modifications to be made in response to changing project requirements or operational needs.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated work order details, including status, priority, and assigned resources, to facilitate effective project management. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "imageId": 0,
8 "description": "string",
9 "vendorRating": 0,
10 "premiseId": 0,
11 "premiseDto": {
12 "id": 0,
13 "createdBy": "string",
14 "createdAt": "2019-08-24T14:15:22Z",
15 "displayId": "string",
16 "premiseName": "string",
17 "description": "string",
18 "address": "string",
19 "internalTeamNames": [
20 "string"
21 ],
22 "internalTeamIds": [
23 0
24 ],
25 "premiseAvailable": true,
26 "premiseFromNrm": true,
27 "nlmId": 0,
28 "nlmDisplayId": "string",
29 "nlmUsed": true,
30 "manager": 0,
31 "managerName": "string",
32 "imageId": 0,
33 "area": "string",
34 "modifiedAt": "2019-08-24T14:15:22Z"
35 },
36 "premiseFromNrm": true,
37 "premiseDisplayId": "string",
38 "nssProjectId": 0,
39 "nssTaskId": 0,
40 "nssTaskDisplayId": "string",
41 "orderDate": "2019-08-24",
42 "dueDate": "2019-08-24",
43 "startDate": "2019-08-24",
44 "endDate": "2019-08-24",
45 "startTime": {
46 "hour": 0,
47 "minute": 0,
48 "second": 0,
49 "nano": 0
50 },
51 "endTime": {
52 "hour": 0,
53 "minute": 0,
54 "second": 0,
55 "nano": 0
56 },
57 "modifiedAt": "2019-08-24T14:15:22Z",
58 "estimatedCost": "81.08",
59 "finalCost": "81.08",
60 "duration": 0,
61 "estimatedDayTime": 0,
62 "finalHourTime": "2.5",
63 "estimatedHourTime": "2.5",
64 "closeDate": "2019-08-24",
65 "inspection": "string",
66 "workOrderTypeId": 0,
67 "workOrderTypeName": "string",
68 "workOrderType": "string",
69 "workOrderPriorityId": 0,
70 "workOrderPriority": "string",
71 "workOrderPriorityType": "string",
72 "isTemplate": true,
73 "isWorkOrderTemplate": true,
74 "templateId": 0,
75 "isPartsInSufficient": true,
76 "partQuantityInfoList": [
77 {
78 "partId": 0,
79 "partDisplayId": "string",
80 "requestedQuantity": 0,
81 "availableQuantity": 0,
82 "usedQuantity": 0,
83 "sufficient": true,
84 "partial": true
85 }
86 ],
87 "parentWorkOrderId": 0,
88 "parentWorkOrderDisplayId": "string",
89 "parentWorkOrder": "string",
90 "mainAssetIds": [
91 0
92 ],
93 "mainAssetDto": {
94 "id": 0,
95 "createdBy": "string",
96 "createdAt": "2019-08-24T14:15:22Z",
97 "displayId": "string",
98 "name": "string",
99 "description": "string",
100 "qrCode": "string",
101 "barCode": "string",
102 "imageId": 0,
103 "model": "string",
104 "manufacturer": "string",
105 "serialNumber": "string",
106 "cost": "81.08",
107 "premiseId": 0,
108 "premiseDisplayId": "string",
109 "premiseDto": {
110 "id": 0,
111 "createdBy": "string",
112 "createdAt": "2019-08-24T14:15:22Z",
113 "displayId": "string",
114 "premiseName": "string",
115 "description": "string",
116 "address": "string",
117 "internalTeamNames": [
118 "string"
119 ],
120 "internalTeamIds": [
121 0
122 ],
123 "premiseAvailable": true,
124 "premiseFromNrm": true,
125 "nlmId": 0,
126 "nlmDisplayId": "string",
127 "nlmUsed": true,
128 "manager": 0,
129 "managerName": "string",
130 "imageId": 0,
131 "area": "string",
132 "modifiedAt": "2019-08-24T14:15:22Z"
133 },
134 "acquisitionDate": "2019-08-24",
135 "endOfLife": "2019-08-24",
136 "assetStatusId": 0,
137 "assetStatus": "string",
138 "assetStatusType": "string",
139 "parentAssetId": 0,
140 "parentAssetDisplayId": "string",
141 "parentAsset": "string",
142 "parentAssetDto": {},
143 "upcomingMaintenanceDate": "2019-08-24",
144 "assetCategoryIds": [
145 0
146 ],
147 "assetCategories": [
148 "string"
149 ],
150 "internalTeamIds": [
151 0
152 ],
153 "internalTeamDtos": [
154 {
155 "id": 0,
156 "createdBy": "string",
157 "createdAt": "2019-08-24T14:15:22Z",
158 "displayId": "string",
159 "name": "string",
160 "email": "string",
161 "phone": "string",
162 "manager": "string",
163 "requestCategoryName": [
164 "string"
165 ],
166 "requestCategoryId": [
167 0
168 ],
169 "requestCategoryDisplayId": [
170 "string"
171 ],
172 "description": "string",
173 "internalTeamUser": [
174 0
175 ],
176 "members": 0,
177 "mainAssets": [
178 0
179 ],
180 "premiseNames": [
181 "string"
182 ],
183 "internalTeamAvailable": true,
184 "premiseIds": [
185 0
186 ]
187 }
188 ],
189 "internalTeams": [
190 "string"
191 ],
192 "assignedUserIds": [
193 0
194 ],
195 "assignedUserDtos": [
196 {
197 "id": 0,
198 "createdBy": "string",
199 "createdAt": "2019-08-24T14:15:22Z",
200 "userName": "string",
201 "firstName": "string",
202 "lastName": "string",
203 "email": "string",
204 "roleIds": [
205 0
206 ],
207 "internalTeamNames": [
208 "string"
209 ],
210 "internalTeamIds": [
211 0
212 ],
213 "internalTeamDisplayIds": [
214 "string"
215 ],
216 "premiseIds": [
217 0
218 ],
219 "premiseNames": [
220 "string"
221 ],
222 "userAvailable": true,
223 "temporaryWorkload": 0,
224 "preferredCultureCode": "string"
225 }
226 ],
227 "assignedUsers": [
228 "string"
229 ],
230 "assetPriority": "string",
231 "assetPriorityId": 0,
232 "assetPriorityDisplayId": "string",
233 "assetPriorityType": "string",
234 "assetAvailable": true,
235 "exactPlacement": "string",
236 "fosId": 0,
237 "downtimeStatus": "string",
238 "premiseFromNrm": true,
239 "modifiedAt": "2019-08-24T14:15:22Z"
240 },
241 "mainAssetDisplayId": "string",
242 "workOrderStatusId": 0,
243 "workOrderStatus": "string",
244 "workOrderStatusType": "string",
245 "requestIds": [
246 0
247 ],
248 "internalTeamIds": [
249 0
250 ],
251 "internalTeamDtos": [
252 {
253 "id": 0,
254 "createdBy": "string",
255 "createdAt": "2019-08-24T14:15:22Z",
256 "displayId": "string",
257 "name": "string",
258 "email": "string",
259 "phone": "string",
260 "manager": "string",
261 "requestCategoryName": [
262 "string"
263 ],
264 "requestCategoryId": [
265 0
266 ],
267 "requestCategoryDisplayId": [
268 "string"
269 ],
270 "description": "string",
271 "internalTeamUser": [
272 0
273 ],
274 "members": 0,
275 "mainAssets": [
276 0
277 ],
278 "premiseNames": [
279 "string"
280 ],
281 "internalTeamAvailable": true,
282 "premiseIds": [
283 0
284 ]
285 }
286 ],
287 "internalTeams": [
288 "string"
289 ],
290 "vendorId": 0,
291 "vendorDto": {
292 "id": 0,
293 "createdBy": "string",
294 "createdAt": "2019-08-24T14:15:22Z",
295 "displayId": "string",
296 "name": "string",
297 "description": "string",
298 "address": "string",
299 "contractEndDate": "2019-08-24",
300 "services": "string",
301 "vendorType": "string",
302 "vendorStatusId": 0,
303 "vendorStatus": "string",
304 "vendorStatusType": "string",
305 "businessTypeId": 0,
306 "businessType": "string",
307 "vendorRateId": 0,
308 "vendorRate": "string",
309 "vendorContactIds": [
310 0
311 ],
312 "premiseIds": [
313 0
314 ],
315 "firstPremiseDisplayId": "string",
316 "ownerUserName": "string",
317 "ownerDto": {
318 "id": 0,
319 "createdBy": "string",
320 "createdAt": "2019-08-24T14:15:22Z",
321 "userName": "string",
322 "firstName": "string",
323 "lastName": "string",
324 "email": "string",
325 "roleIds": [
326 0
327 ],
328 "internalTeamNames": [
329 "string"
330 ],
331 "internalTeamIds": [
332 0
333 ],
334 "internalTeamDisplayIds": [
335 "string"
336 ],
337 "premiseIds": [
338 0
339 ],
340 "premiseNames": [
341 "string"
342 ],
343 "userAvailable": true,
344 "temporaryWorkload": 0,
345 "preferredCultureCode": "string"
346 },
347 "vendorAvailable": true,
348 "vendorRating": 0.1,
349 "premiseDisplayIds": [
350 "string"
351 ]
352 },
353 "vendorName": "string",
354 "workOrderTemplateSettings": {
355 "id": 0,
356 "createdBy": "string",
357 "createdAt": "2019-08-24T14:15:22Z",
358 "workOrderId": 0,
359 "startDate": "2019-08-24",
360 "dueDuration": 0,
361 "dueMonths": 0,
362 "endDate": "2019-08-24",
363 "recurringWOPriorityId": 0,
364 "recurringWOPriority": "string",
365 "recurringWOPriorityType": "string",
366 "isTemplate": true,
367 "isRemoveByDate": true,
368 "triggerByWorkOrderStatusId": 0,
369 "triggerByWorkOrderStatus": "string",
370 "triggerByWorkOrderStatusType": "string",
371 "removeByWorkOrderStatusId": 0,
372 "removeByWorkOrderStatus": "string",
373 "removeByWorkOrderStatusType": "string"
374 },
375 "assignedUserIds": [
376 0
377 ],
378 "assignedUserDtos": [
379 {
380 "id": 0,
381 "createdBy": "string",
382 "createdAt": "2019-08-24T14:15:22Z",
383 "userName": "string",
384 "firstName": "string",
385 "lastName": "string",
386 "email": "string",
387 "roleIds": [
388 0
389 ],
390 "internalTeamNames": [
391 "string"
392 ],
393 "internalTeamIds": [
394 0
395 ],
396 "internalTeamDisplayIds": [
397 "string"
398 ],
399 "premiseIds": [
400 0
401 ],
402 "premiseNames": [
403 "string"
404 ],
405 "userAvailable": true,
406 "temporaryWorkload": 0,
407 "preferredCultureCode": "string"
408 }
409 ],
410 "assignedUsers": [
411 "string"
412 ],
413 "variableQuantity": 0,
414 "workOrderAvailable": true,
415 "exactPlacement": "string",
416 "primaryWorkOrderId": 0,
417 "primaryWorkOrderDto": {
418 "id": 0,
419 "createdBy": "string",
420 "createdAt": "2019-08-24T14:15:22Z",
421 "displayId": "string",
422 "name": "string",
423 "imageId": 0,
424 "description": "string",
425 "vendorRating": 0,
426 "premiseId": 0,
427 "premiseDto": {
428 "id": 0,
429 "createdBy": "string",
430 "createdAt": "2019-08-24T14:15:22Z",
431 "displayId": "string",
432 "premiseName": "string",
433 "description": "string",
434 "address": "string",
435 "internalTeamNames": [
436 "string"
437 ],
438 "internalTeamIds": [
439 0
440 ],
441 "premiseAvailable": true,
442 "premiseFromNrm": true,
443 "nlmId": 0,
444 "nlmDisplayId": "string",
445 "nlmUsed": true,
446 "manager": 0,
447 "managerName": "string",
448 "imageId": 0,
449 "area": "string",
450 "modifiedAt": "2019-08-24T14:15:22Z"
451 },
452 "premiseFromNrm": true,
453 "premiseDisplayId": "string",
454 "nssProjectId": 0,
455 "nssTaskId": 0,
456 "nssTaskDisplayId": "string",
457 "orderDate": "2019-08-24",
458 "dueDate": "2019-08-24",
459 "startDate": "2019-08-24",
460 "endDate": "2019-08-24",
461 "startTime": {
462 "hour": 0,
463 "minute": 0,
464 "second": 0,
465 "nano": 0
466 },
467 "endTime": {
468 "hour": 0,
469 "minute": 0,
470 "second": 0,
471 "nano": 0
472 },
473 "modifiedAt": "2019-08-24T14:15:22Z",
474 "estimatedCost": "81.08",
475 "finalCost": "81.08",
476 "duration": 0,
477 "estimatedDayTime": 0,
478 "finalHourTime": "2.5",
479 "estimatedHourTime": "2.5",
480 "closeDate": "2019-08-24",
481 "inspection": "string",
482 "workOrderTypeId": 0,
483 "workOrderTypeName": "string",
484 "workOrderType": "string",
485 "workOrderPriorityId": 0,
486 "workOrderPriority": "string",
487 "workOrderPriorityType": "string",
488 "isTemplate": true,
489 "isWorkOrderTemplate": true,
490 "templateId": 0,
491 "isPartsInSufficient": true,
492 "partQuantityInfoList": [
493 {
494 "partId": 0,
495 "partDisplayId": "string",
496 "requestedQuantity": 0,
497 "availableQuantity": 0,
498 "usedQuantity": 0,
499 "sufficient": true,
500 "partial": true
501 }
502 ],
503 "parentWorkOrderId": 0,
504 "parentWorkOrderDisplayId": "string",
505 "parentWorkOrder": "string",
506 "mainAssetIds": [
507 0
508 ],
509 "mainAssetDto": {
510 "id": 0,
511 "createdBy": "string",
512 "createdAt": "2019-08-24T14:15:22Z",
513 "displayId": "string",
514 "name": "string",
515 "description": "string",
516 "qrCode": "string",
517 "barCode": "string",
518 "imageId": 0,
519 "model": "string",
520 "manufacturer": "string",
521 "serialNumber": "string",
522 "cost": "81.08",
523 "premiseId": 0,
524 "premiseDisplayId": "string",
525 "premiseDto": {
526 "id": 0,
527 "createdBy": "string",
528 "createdAt": "2019-08-24T14:15:22Z",
529 "displayId": "string",
530 "premiseName": "string",
531 "description": "string",
532 "address": "string",
533 "internalTeamNames": [
534 "string"
535 ],
536 "internalTeamIds": [
537 0
538 ],
539 "premiseAvailable": true,
540 "premiseFromNrm": true,
541 "nlmId": 0,
542 "nlmDisplayId": "string",
543 "nlmUsed": true,
544 "manager": 0,
545 "managerName": "string",
546 "imageId": 0,
547 "area": "string",
548 "modifiedAt": "2019-08-24T14:15:22Z"
549 },
550 "acquisitionDate": "2019-08-24",
551 "endOfLife": "2019-08-24",
552 "assetStatusId": 0,
553 "assetStatus": "string",
554 "assetStatusType": "string",
555 "parentAssetId": 0,
556 "parentAssetDisplayId": "string",
557 "parentAsset": "string",
558 "parentAssetDto": {},
559 "upcomingMaintenanceDate": "2019-08-24",
560 "assetCategoryIds": [
561 0
562 ],
563 "assetCategories": [
564 "string"
565 ],
566 "internalTeamIds": [
567 0
568 ],
569 "internalTeamDtos": [
570 {
571 "id": 0,
572 "createdBy": "string",
573 "createdAt": "2019-08-24T14:15:22Z",
574 "displayId": "string",
575 "name": "string",
576 "email": "string",
577 "phone": "string",
578 "manager": "string",
579 "requestCategoryName": [
580 "string"
581 ],
582 "requestCategoryId": [
583 0
584 ],
585 "requestCategoryDisplayId": [
586 "string"
587 ],
588 "description": "string",
589 "internalTeamUser": [
590 0
591 ],
592 "members": 0,
593 "mainAssets": [
594 0
595 ],
596 "premiseNames": [
597 "string"
598 ],
599 "internalTeamAvailable": true,
600 "premiseIds": [
601 0
602 ]
603 }
604 ],
605 "internalTeams": [
606 "string"
607 ],
608 "assignedUserIds": [
609 0
610 ],
611 "assignedUserDtos": [
612 {
613 "id": 0,
614 "createdBy": "string",
615 "createdAt": "2019-08-24T14:15:22Z",
616 "userName": "string",
617 "firstName": "string",
618 "lastName": "string",
619 "email": "string",
620 "roleIds": [
621 0
622 ],
623 "internalTeamNames": [
624 "string"
625 ],
626 "internalTeamIds": [
627 0
628 ],
629 "internalTeamDisplayIds": [
630 "string"
631 ],
632 "premiseIds": [
633 0
634 ],
635 "premiseNames": [
636 "string"
637 ],
638 "userAvailable": true,
639 "temporaryWorkload": 0,
640 "preferredCultureCode": "string"
641 }
642 ],
643 "assignedUsers": [
644 "string"
645 ],
646 "assetPriority": "string",
647 "assetPriorityId": 0,
648 "assetPriorityDisplayId": "string",
649 "assetPriorityType": "string",
650 "assetAvailable": true,
651 "exactPlacement": "string",
652 "fosId": 0,
653 "downtimeStatus": "string",
654 "premiseFromNrm": true,
655 "modifiedAt": "2019-08-24T14:15:22Z"
656 },
657 "mainAssetDisplayId": "string",
658 "workOrderStatusId": 0,
659 "workOrderStatus": "string",
660 "workOrderStatusType": "string",
661 "requestIds": [
662 0
663 ],
664 "internalTeamIds": [
665 0
666 ],
667 "internalTeamDtos": [
668 {
669 "id": 0,
670 "createdBy": "string",
671 "createdAt": "2019-08-24T14:15:22Z",
672 "displayId": "string",
673 "name": "string",
674 "email": "string",
675 "phone": "string",
676 "manager": "string",
677 "requestCategoryName": [
678 "string"
679 ],
680 "requestCategoryId": [
681 0
682 ],
683 "requestCategoryDisplayId": [
684 "string"
685 ],
686 "description": "string",
687 "internalTeamUser": [
688 0
689 ],
690 "members": 0,
691 "mainAssets": [
692 0
693 ],
694 "premiseNames": [
695 "string"
696 ],
697 "internalTeamAvailable": true,
698 "premiseIds": [
699 0
700 ]
701 }
702 ],
703 "internalTeams": [
704 "string"
705 ],
706 "vendorId": 0,
707 "vendorDto": {
708 "id": 0,
709 "createdBy": "string",
710 "createdAt": "2019-08-24T14:15:22Z",
711 "displayId": "string",
712 "name": "string",
713 "description": "string",
714 "address": "string",
715 "contractEndDate": "2019-08-24",
716 "services": "string",
717 "vendorType": "string",
718 "vendorStatusId": 0,
719 "vendorStatus": "string",
720 "vendorStatusType": "string",
721 "businessTypeId": 0,
722 "businessType": "string",
723 "vendorRateId": 0,
724 "vendorRate": "string",
725 "vendorContactIds": [
726 0
727 ],
728 "premiseIds": [
729 0
730 ],
731 "firstPremiseDisplayId": "string",
732 "ownerUserName": "string",
733 "ownerDto": {
734 "id": 0,
735 "createdBy": "string",
736 "createdAt": "2019-08-24T14:15:22Z",
737 "userName": "string",
738 "firstName": "string",
739 "lastName": "string",
740 "email": "string",
741 "roleIds": [
742 0
743 ],
744 "internalTeamNames": [
745 "string"
746 ],
747 "internalTeamIds": [
748 0
749 ],
750 "internalTeamDisplayIds": [
751 "string"
752 ],
753 "premiseIds": [
754 0
755 ],
756 "premiseNames": [
757 "string"
758 ],
759 "userAvailable": true,
760 "temporaryWorkload": 0,
761 "preferredCultureCode": "string"
762 },
763 "vendorAvailable": true,
764 "vendorRating": 0.1,
765 "premiseDisplayIds": [
766 "string"
767 ]
768 },
769 "vendorName": "string",
770 "workOrderTemplateSettings": {
771 "id": 0,
772 "createdBy": "string",
773 "createdAt": "2019-08-24T14:15:22Z",
774 "workOrderId": 0,
775 "startDate": "2019-08-24",
776 "dueDuration": 0,
777 "dueMonths": 0,
778 "endDate": "2019-08-24",
779 "recurringWOPriorityId": 0,
780 "recurringWOPriority": "string",
781 "recurringWOPriorityType": "string",
782 "isTemplate": true,
783 "isRemoveByDate": true,
784 "triggerByWorkOrderStatusId": 0,
785 "triggerByWorkOrderStatus": "string",
786 "triggerByWorkOrderStatusType": "string",
787 "removeByWorkOrderStatusId": 0,
788 "removeByWorkOrderStatus": "string",
789 "removeByWorkOrderStatusType": "string"
790 },
791 "assignedUserIds": [
792 0
793 ],
794 "assignedUserDtos": [
795 {
796 "id": 0,
797 "createdBy": "string",
798 "createdAt": "2019-08-24T14:15:22Z",
799 "userName": "string",
800 "firstName": "string",
801 "lastName": "string",
802 "email": "string",
803 "roleIds": [
804 0
805 ],
806 "internalTeamNames": [
807 "string"
808 ],
809 "internalTeamIds": [
810 0
811 ],
812 "internalTeamDisplayIds": [
813 "string"
814 ],
815 "premiseIds": [
816 0
817 ],
818 "premiseNames": [
819 "string"
820 ],
821 "userAvailable": true,
822 "temporaryWorkload": 0,
823 "preferredCultureCode": "string"
824 }
825 ],
826 "assignedUsers": [
827 "string"
828 ],
829 "variableQuantity": 0,
830 "workOrderAvailable": true,
831 "exactPlacement": "string",
832 "primaryWorkOrderId": 0,
833 "primaryWorkOrderDto": {},
834 "primaryWorkOrderDisplayId": "string",
835 "isPrimary": true,
836 "invoiceIds": [
837 0
838 ],
839 "createdByTrigger": true,
840 "internalCosts": "81.08",
841 "invoiceTotal": "81.08",
842 "partsTotal": "81.08",
843 "inspectionItemId": 0,
844 "partIdToAttach": 0,
845 "recurringWOPriorityId": 0,
846 "triggerByWorkOrderStatusId": 0,
847 "removeByWorkOrderStatusId": 0,
848 "recurringWOPriority": "string",
849 "recurringWOPriorityType": "string",
850 "triggerByWorkOrderStatus": "string",
851 "triggerByWorkOrderStatusType": "string",
852 "removeByWorkOrderStatus": "string",
853 "removeByWorkOrderStatusType": "string",
854 "recurringWOStartDate": "2019-08-24",
855 "recurringWOEndDate": "2019-08-24",
856 "recurringWODueDuration": 0,
857 "recurringWODueMonths": 0,
858 "recurringWOIsTemplate": true,
859 "recurringWOIsRemoveByDate": true
860 },
861 "primaryWorkOrderDisplayId": "string",
862 "isPrimary": true,
863 "invoiceIds": [
864 0
865 ],
866 "createdByTrigger": true,
867 "internalCosts": "81.08",
868 "invoiceTotal": "81.08",
869 "partsTotal": "81.08",
870 "inspectionItemId": 0,
871 "partIdToAttach": 0,
872 "recurringWOPriorityId": 0,
873 "triggerByWorkOrderStatusId": 0,
874 "removeByWorkOrderStatusId": 0,
875 "recurringWOPriority": "string",
876 "recurringWOPriorityType": "string",
877 "triggerByWorkOrderStatus": "string",
878 "triggerByWorkOrderStatusType": "string",
879 "removeByWorkOrderStatus": "string",
880 "removeByWorkOrderStatusType": "string",
881 "recurringWOStartDate": "2019-08-24",
882 "recurringWOEndDate": "2019-08-24",
883 "recurringWODueDuration": 0,
884 "recurringWODueMonths": 0,
885 "recurringWOIsTemplate": true,
886 "recurringWOIsRemoveByDate": true
887}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get All My Work Orders¶
HTTP Request
GET /api/workOrders/myWorkOrders
📋 Description: Retrieves a list of work orders assigned to the authenticated user, enabling efficient tracking and management of individual tasks within the organization.
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 "name": "string",
8 "imageId": 0,
9 "description": "string",
10 "vendorRating": 0,
11 "premiseId": 0,
12 "premiseDto": {
13 "id": 0,
14 "createdBy": "string",
15 "createdAt": "2019-08-24T14:15:22Z",
16 "displayId": "string",
17 "premiseName": "string",
18 "description": "string",
19 "address": "string",
20 "internalTeamNames": [
21 "string"
22 ],
23 "internalTeamIds": [
24 0
25 ],
26 "premiseAvailable": true,
27 "premiseFromNrm": true,
28 "nlmId": 0,
29 "nlmDisplayId": "string",
30 "nlmUsed": true,
31 "manager": 0,
32 "managerName": "string",
33 "imageId": 0,
34 "area": "string",
35 "modifiedAt": "2019-08-24T14:15:22Z"
36 },
37 "premiseFromNrm": true,
38 "premiseDisplayId": "string",
39 "nssProjectId": 0,
40 "nssTaskId": 0,
41 "nssTaskDisplayId": "string",
42 "orderDate": "2019-08-24",
43 "dueDate": "2019-08-24",
44 "startDate": "2019-08-24",
45 "endDate": "2019-08-24",
46 "startTime": {
47 "hour": 0,
48 "minute": 0,
49 "second": 0,
50 "nano": 0
51 },
52 "endTime": {
53 "hour": 0,
54 "minute": 0,
55 "second": 0,
56 "nano": 0
57 },
58 "modifiedAt": "2019-08-24T14:15:22Z",
59 "estimatedCost": "81.08",
60 "finalCost": "81.08",
61 "duration": 0,
62 "estimatedDayTime": 0,
63 "finalHourTime": "2.5",
64 "estimatedHourTime": "2.5",
65 "closeDate": "2019-08-24",
66 "inspection": "string",
67 "workOrderTypeId": 0,
68 "workOrderTypeName": "string",
69 "workOrderType": "string",
70 "workOrderPriorityId": 0,
71 "workOrderPriority": "string",
72 "workOrderPriorityType": "string",
73 "isTemplate": true,
74 "isWorkOrderTemplate": true,
75 "templateId": 0,
76 "isPartsInSufficient": true,
77 "partQuantityInfoList": [
78 {
79 "partId": 0,
80 "partDisplayId": "string",
81 "requestedQuantity": 0,
82 "availableQuantity": 0,
83 "usedQuantity": 0,
84 "sufficient": true,
85 "partial": true
86 }
87 ],
88 "parentWorkOrderId": 0,
89 "parentWorkOrderDisplayId": "string",
90 "parentWorkOrder": "string",
91 "mainAssetIds": [
92 0
93 ],
94 "mainAssetDto": {
95 "id": 0,
96 "createdBy": "string",
97 "createdAt": "2019-08-24T14:15:22Z",
98 "displayId": "string",
99 "name": "string",
100 "description": "string",
101 "qrCode": "string",
102 "barCode": "string",
103 "imageId": 0,
104 "model": "string",
105 "manufacturer": "string",
106 "serialNumber": "string",
107 "cost": "81.08",
108 "premiseId": 0,
109 "premiseDisplayId": "string",
110 "premiseDto": {
111 "id": 0,
112 "createdBy": "string",
113 "createdAt": "2019-08-24T14:15:22Z",
114 "displayId": "string",
115 "premiseName": "string",
116 "description": "string",
117 "address": "string",
118 "internalTeamNames": [
119 "string"
120 ],
121 "internalTeamIds": [
122 0
123 ],
124 "premiseAvailable": true,
125 "premiseFromNrm": true,
126 "nlmId": 0,
127 "nlmDisplayId": "string",
128 "nlmUsed": true,
129 "manager": 0,
130 "managerName": "string",
131 "imageId": 0,
132 "area": "string",
133 "modifiedAt": "2019-08-24T14:15:22Z"
134 },
135 "acquisitionDate": "2019-08-24",
136 "endOfLife": "2019-08-24",
137 "assetStatusId": 0,
138 "assetStatus": "string",
139 "assetStatusType": "string",
140 "parentAssetId": 0,
141 "parentAssetDisplayId": "string",
142 "parentAsset": "string",
143 "parentAssetDto": {},
144 "upcomingMaintenanceDate": "2019-08-24",
145 "assetCategoryIds": [
146 0
147 ],
148 "assetCategories": [
149 "string"
150 ],
151 "internalTeamIds": [
152 0
153 ],
154 "internalTeamDtos": [
155 {
156 "id": 0,
157 "createdBy": "string",
158 "createdAt": "2019-08-24T14:15:22Z",
159 "displayId": "string",
160 "name": "string",
161 "email": "string",
162 "phone": "string",
163 "manager": "string",
164 "requestCategoryName": [
165 "string"
166 ],
167 "requestCategoryId": [
168 0
169 ],
170 "requestCategoryDisplayId": [
171 "string"
172 ],
173 "description": "string",
174 "internalTeamUser": [
175 0
176 ],
177 "members": 0,
178 "mainAssets": [
179 0
180 ],
181 "premiseNames": [
182 "string"
183 ],
184 "internalTeamAvailable": true,
185 "premiseIds": [
186 0
187 ]
188 }
189 ],
190 "internalTeams": [
191 "string"
192 ],
193 "assignedUserIds": [
194 0
195 ],
196 "assignedUserDtos": [
197 {
198 "id": 0,
199 "createdBy": "string",
200 "createdAt": "2019-08-24T14:15:22Z",
201 "userName": "string",
202 "firstName": "string",
203 "lastName": "string",
204 "email": "string",
205 "roleIds": [
206 0
207 ],
208 "internalTeamNames": [
209 "string"
210 ],
211 "internalTeamIds": [
212 0
213 ],
214 "internalTeamDisplayIds": [
215 "string"
216 ],
217 "premiseIds": [
218 0
219 ],
220 "premiseNames": [
221 "string"
222 ],
223 "userAvailable": true,
224 "temporaryWorkload": 0,
225 "preferredCultureCode": "string"
226 }
227 ],
228 "assignedUsers": [
229 "string"
230 ],
231 "assetPriority": "string",
232 "assetPriorityId": 0,
233 "assetPriorityDisplayId": "string",
234 "assetPriorityType": "string",
235 "assetAvailable": true,
236 "exactPlacement": "string",
237 "fosId": 0,
238 "downtimeStatus": "string",
239 "premiseFromNrm": true,
240 "modifiedAt": "2019-08-24T14:15:22Z"
241 },
242 "mainAssetDisplayId": "string",
243 "workOrderStatusId": 0,
244 "workOrderStatus": "string",
245 "workOrderStatusType": "string",
246 "requestIds": [
247 0
248 ],
249 "internalTeamIds": [
250 0
251 ],
252 "internalTeamDtos": [
253 {
254 "id": 0,
255 "createdBy": "string",
256 "createdAt": "2019-08-24T14:15:22Z",
257 "displayId": "string",
258 "name": "string",
259 "email": "string",
260 "phone": "string",
261 "manager": "string",
262 "requestCategoryName": [
263 "string"
264 ],
265 "requestCategoryId": [
266 0
267 ],
268 "requestCategoryDisplayId": [
269 "string"
270 ],
271 "description": "string",
272 "internalTeamUser": [
273 0
274 ],
275 "members": 0,
276 "mainAssets": [
277 0
278 ],
279 "premiseNames": [
280 "string"
281 ],
282 "internalTeamAvailable": true,
283 "premiseIds": [
284 0
285 ]
286 }
287 ],
288 "internalTeams": [
289 "string"
290 ],
291 "vendorId": 0,
292 "vendorDto": {
293 "id": 0,
294 "createdBy": "string",
295 "createdAt": "2019-08-24T14:15:22Z",
296 "displayId": "string",
297 "name": "string",
298 "description": "string",
299 "address": "string",
300 "contractEndDate": "2019-08-24",
301 "services": "string",
302 "vendorType": "string",
303 "vendorStatusId": 0,
304 "vendorStatus": "string",
305 "vendorStatusType": "string",
306 "businessTypeId": 0,
307 "businessType": "string",
308 "vendorRateId": 0,
309 "vendorRate": "string",
310 "vendorContactIds": [
311 0
312 ],
313 "premiseIds": [
314 0
315 ],
316 "firstPremiseDisplayId": "string",
317 "ownerUserName": "string",
318 "ownerDto": {
319 "id": 0,
320 "createdBy": "string",
321 "createdAt": "2019-08-24T14:15:22Z",
322 "userName": "string",
323 "firstName": "string",
324 "lastName": "string",
325 "email": "string",
326 "roleIds": [
327 0
328 ],
329 "internalTeamNames": [
330 "string"
331 ],
332 "internalTeamIds": [
333 0
334 ],
335 "internalTeamDisplayIds": [
336 "string"
337 ],
338 "premiseIds": [
339 0
340 ],
341 "premiseNames": [
342 "string"
343 ],
344 "userAvailable": true,
345 "temporaryWorkload": 0,
346 "preferredCultureCode": "string"
347 },
348 "vendorAvailable": true,
349 "vendorRating": 0.1,
350 "premiseDisplayIds": [
351 "string"
352 ]
353 },
354 "vendorName": "string",
355 "workOrderTemplateSettings": {
356 "id": 0,
357 "createdBy": "string",
358 "createdAt": "2019-08-24T14:15:22Z",
359 "workOrderId": 0,
360 "startDate": "2019-08-24",
361 "dueDuration": 0,
362 "dueMonths": 0,
363 "endDate": "2019-08-24",
364 "recurringWOPriorityId": 0,
365 "recurringWOPriority": "string",
366 "recurringWOPriorityType": "string",
367 "isTemplate": true,
368 "isRemoveByDate": true,
369 "triggerByWorkOrderStatusId": 0,
370 "triggerByWorkOrderStatus": "string",
371 "triggerByWorkOrderStatusType": "string",
372 "removeByWorkOrderStatusId": 0,
373 "removeByWorkOrderStatus": "string",
374 "removeByWorkOrderStatusType": "string"
375 },
376 "assignedUserIds": [
377 0
378 ],
379 "assignedUserDtos": [
380 {
381 "id": 0,
382 "createdBy": "string",
383 "createdAt": "2019-08-24T14:15:22Z",
384 "userName": "string",
385 "firstName": "string",
386 "lastName": "string",
387 "email": "string",
388 "roleIds": [
389 0
390 ],
391 "internalTeamNames": [
392 "string"
393 ],
394 "internalTeamIds": [
395 0
396 ],
397 "internalTeamDisplayIds": [
398 "string"
399 ],
400 "premiseIds": [
401 0
402 ],
403 "premiseNames": [
404 "string"
405 ],
406 "userAvailable": true,
407 "temporaryWorkload": 0,
408 "preferredCultureCode": "string"
409 }
410 ],
411 "assignedUsers": [
412 "string"
413 ],
414 "variableQuantity": 0,
415 "workOrderAvailable": true,
416 "exactPlacement": "string",
417 "primaryWorkOrderId": 0,
418 "primaryWorkOrderDto": {},
419 "primaryWorkOrderDisplayId": "string",
420 "isPrimary": true,
421 "invoiceIds": [
422 0
423 ],
424 "createdByTrigger": true,
425 "internalCosts": "81.08",
426 "invoiceTotal": "81.08",
427 "partsTotal": "81.08",
428 "inspectionItemId": 0,
429 "partIdToAttach": 0
430 }
431]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a work order, encapsulating essential details such as task specifications, status, and associated resources to facilitate efficient project management and operational workflows.] |
|
» 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 operational status, to facilitate effective decision-making in property management and strategic 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 logistical and operational purposes. |
»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the premise, facilitating effective collaboration and resource allocation. |
»» internalTeamIds |
[integer] |
false |
none |
List of unique identifiers for 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 business 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 initiatives. |
»» 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 Library of Medicine (NLM) resources have been utilized in the premise. |
»» 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 geographical 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 sourced from the National Resource Management system, facilitating integration with external resource planning tools. |
» 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 time management and scheduling across different time zones. |
|
»» 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 second 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, enabling precise time tracking for scheduling and reporting purposes. |
» endTime |
false |
none |
Data transfer object representing the local time settings relevant to business operations, ensuring accurate time management and scheduling across different time zones. |
|
» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» estimatedCost |
string |
false |
none |
Estimated cost of the work order, providing a financial projection to assist in budget planning and resource allocation. |
» finalCost |
string |
false |
none |
The finalCost field represents the total cost associated with the completion of the work order, providing essential financial insight 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, facilitating effective resource planning and scheduling. |
» 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 |
Details the specific inspection requirements associated with the work order, ensuring compliance and quality standards are met. |
» 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 associated with each part required for the work order, facilitating accurate 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 items is a partial amount, providing essential information for inventory management and order fulfillment processes. |
» 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 associated with the current work order, facilitating hierarchical organization and tracking of related tasks. |
» mainAssetIds |
[integer] |
false |
none |
List of unique identifiers for the primary assets associated with the work order, facilitating effective asset management and tracking. |
» mainAssetDto |
false |
none |
Data transfer object representing a primary asset within the enterprise, encompassing essential attributes and metadata necessary for 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 management and decision-making. |
»» manufacturer |
string |
false |
none |
Name of the manufacturer responsible for producing the asset, essential for tracking and managing supplier relationships. |
»» serialNumber |
string |
false |
none |
Unique identifier for the asset, facilitating tracking and management within the inventory 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 operational status, to facilitate effective decision-making in property management and strategic 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 asset management and organization. |
»» parentAssetDto |
false |
none |
Data transfer object representing a primary asset within the enterprise, encompassing essential attributes and metadata necessary for effective asset management and decision-making. |
|
»» upcomingMaintenanceDate |
string(date) |
false |
none |
Date of the upcoming maintenance |
»» assetCategoryIds |
[integer] |
false |
none |
List of unique identifiers representing the categories to which the asset belongs, facilitating effective asset management and reporting. |
»» assetCategories |
[string] |
false |
none |
Array of asset categories that categorizes the main assets for effective management and reporting. |
»» internalTeamIds |
[integer] |
false |
none |
List of unique identifiers for 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 allocation and management. |
|
»»» 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 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 |
Array of internal team user details, represented by InternalTeamDTO, facilitating collaboration and resource management within the organization. |
»»» members |
integer(int32) |
false |
none |
Represents the total number of members within the internal team, facilitating effective resource allocation and team management. |
»»» mainAssets |
[integer] |
false |
none |
List of primary assets associated with the internal team, providing essential insights for resource allocation and project management. |
»»» premiseNames |
[string] |
false |
none |
List of names associated with the premises relevant to the internal team, facilitating effective identification and management of locations within the organization. |
»»» internalTeamAvailable |
boolean |
false |
none |
Indicates whether the internal team is available to support the request, facilitating efficient resource allocation and project management. |
»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the internal team. |
»» internalTeams |
[string] |
false |
none |
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 for users assigned to the main asset, facilitating effective resource management and accountability. |
»» assignedUserDtos |
false |
none |
Array of assigned user data transfer objects (DTOs) representing the users allocated to the main asset, facilitating effective resource management 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 |
[integer] |
false |
none |
An array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system. |
»»» 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 |
Array of unique identifiers representing the internal teams associated with the user, facilitating streamlined collaboration and resource allocation within the organization. |
»»» internalTeamDisplayIds |
[string] |
false |
none |
Array of unique identifiers representing the display IDs of internal teams associated with the user. |
»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the user, facilitating efficient management and retrieval of location-specific data. |
»»» premiseNames |
[string] |
false |
none |
List of names associated with the user’s premises, facilitating identification and management of multiple locations within the system. |
»»» 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 a 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 originates from the National Resource Management (NRM) framework, facilitating compliance and reporting within environmental management processes. |
»» 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, enabling efficient tracking and management of related requests within the system. |
» internalTeamIds |
[integer] |
false |
none |
List of unique identifiers for 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 |
Array 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 information such as vendor identification, contact details, and service offerings to facilitate effective vendor management and procurement processes. |
|
»» 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 logistics and communication purposes. |
»» contractEndDate |
string(date) |
false |
none |
Date of the contract end |
»» services |
string |
false |
none |
Represents the services offered by the vendor, providing essential information for evaluating vendor capabilities and aligning 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 effective management and tracking of vendor-related locations. |
»» 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, encapsulating essential information such as user identification, contact details, and role within the organization, facilitating seamless user management and interaction within the enterprise system. |
|
»» vendorAvailable |
boolean |
false |
none |
Indicates whether the vendor is currently available for new engagements within the system. |
»» vendorRating |
number(double) |
false |
none |
Represents the numerical rating assigned to a vendor, reflecting their performance and reliability in business engagements. |
»» premiseDisplayIds |
[string] |
false |
none |
Array of unique identifiers representing the display premises associated with the vendor, facilitating streamlined management and retrieval of vendor-related information. |
» vendorName |
string |
false |
none |
Name of the vendor |
» workOrderTemplateSettings |
false |
none |
Data transfer object representing the configuration settings for work order templates, enabling businesses to standardize and streamline their work order processes for improved operational efficiency. |
|
»» 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 hours, 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 |
An array of unique identifiers representing the 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 resource allocation and task management. |
» 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 of resources as defined in the work order, facilitating accurate execution and tracking of tasks. |
» 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, status, and associated resources to facilitate efficient project management and operational workflows. |
|
» 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 streamlined tracking and management of billing processes. |
» createdByTrigger |
boolean |
false |
none |
Indicates whether the work order was created automatically by a system trigger. |
» internalCosts |
string |
false |
none |
Represents the internal costs associated with the work order, providing essential financial insights for project budgeting and resource allocation. |
» 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. |
» 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 |
» recurringWOPriority |
string |
false |
write-only |
Priority of the recurring w o |
» recurringWOPriorityType |
string |
false |
write-only |
Type of the recurring w o priority |
» triggerByWorkOrderStatus |
string |
false |
write-only |
Status of the trigger by work order |
» triggerByWorkOrderStatusType |
string |
false |
write-only |
Type of the trigger by work order status |
» removeByWorkOrderStatus |
string |
false |
write-only |
Status of the remove by work order |
» removeByWorkOrderStatusType |
string |
false |
write-only |
Type of the remove by work order status |
» 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 |
Indicates the number of months for which the work order is set to recur, facilitating effective scheduling and resource allocation. |
» recurringWOIsTemplate |
boolean |
false |
write-only |
Indicates whether the work order is based on a recurring template, facilitating streamlined management of repeat tasks. |
» recurringWOIsRemoveByDate |
boolean |
false |
write-only |
Date of the recurring w o is remove by |