Nrm Client¶
Create Nrm Work Order¶
HTTP Request
POST /api/nrm/work-orders
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
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 "workType": "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 },
35 "premiseFromNrm": true,
36 "premiseDisplayId": "string",
37 "nssProjectId": 0,
38 "nssTaskId": 0,
39 "nssTaskDisplayId": "string",
40 "orderDate": "2019-08-24",
41 "dueDate": "2019-08-24",
42 "startDate": "2019-08-24",
43 "endDate": "2019-08-24",
44 "startTime": {
45 "hour": 0,
46 "minute": 0,
47 "second": 0,
48 "nano": 0
49 },
50 "endTime": {
51 "hour": 0,
52 "minute": 0,
53 "second": 0,
54 "nano": 0
55 },
56 "estimatedCost": "81.08",
57 "finalCost": "81.08",
58 "duration": 0,
59 "estimatedDayTime": 0,
60 "finalHourTime": "2.5",
61 "estimatedHourTime": "2.5",
62 "closeDate": "2019-08-24",
63 "inspection": "string",
64 "workOrderPriorityId": 0,
65 "workOrderPriority": "string",
66 "workOrderPriorityType": "string",
67 "isTemplate": true,
68 "parentWorkOrderId": 0,
69 "parentWorkOrderDisplayId": "string",
70 "parentWorkOrder": "string",
71 "mainAssetIds": [
72 0
73 ],
74 "mainAssetDto": {
75 "id": 0,
76 "createdBy": "string",
77 "createdAt": "2019-08-24T14:15:22Z",
78 "displayId": "string",
79 "name": "string",
80 "description": "string",
81 "qrCode": "string",
82 "barCode": "string",
83 "imageId": 0,
84 "model": "string",
85 "manufacturer": "string",
86 "serialNumber": "string",
87 "cost": "81.08",
88 "premiseId": 0,
89 "premiseDisplayId": "string",
90 "premiseDto": {
91 "id": 0,
92 "createdBy": "string",
93 "createdAt": "2019-08-24T14:15:22Z",
94 "displayId": "string",
95 "premiseName": "string",
96 "description": "string",
97 "address": "string",
98 "internalTeamNames": [
99 "string"
100 ],
101 "internalTeamIds": [
102 0
103 ],
104 "premiseAvailable": true,
105 "premiseFromNrm": true,
106 "nlmId": 0,
107 "nlmDisplayId": "string",
108 "nlmUsed": true,
109 "manager": 0,
110 "managerName": "string",
111 "imageId": 0
112 },
113 "acquisitionDate": "2019-08-24",
114 "endOfLife": "2019-08-24",
115 "assetStatusId": 0,
116 "assetStatus": "string",
117 "assetStatusType": "string",
118 "parentAssetId": 0,
119 "parentAssetDisplayId": "string",
120 "parentAsset": "string",
121 "parentAssetDto": {},
122 "upcomingMaintenanceDate": "2019-08-24",
123 "assetCategoryIds": [
124 0
125 ],
126 "assetCategories": [
127 "string"
128 ],
129 "internalTeamIds": [
130 0
131 ],
132 "internalTeamDtos": [
133 {
134 "id": 0,
135 "createdBy": "string",
136 "createdAt": "2019-08-24T14:15:22Z",
137 "displayId": "string",
138 "name": "string",
139 "email": "string",
140 "phone": "string",
141 "manager": "string",
142 "requestCategoryName": [
143 "string"
144 ],
145 "requestCategoryId": [
146 0
147 ],
148 "requestCategoryDisplayId": [
149 "string"
150 ],
151 "description": "string",
152 "internalTeamUser": [
153 0
154 ],
155 "members": 0,
156 "mainAssets": [
157 0
158 ],
159 "premiseNames": [
160 "string"
161 ],
162 "internalTeamAvailable": true,
163 "premiseIds": [
164 0
165 ]
166 }
167 ],
168 "internalTeams": [
169 "string"
170 ],
171 "assignedUserIds": [
172 0
173 ],
174 "assignedUserDtos": [
175 {
176 "id": 0,
177 "createdBy": "string",
178 "createdAt": "2019-08-24T14:15:22Z",
179 "userName": "string",
180 "firstName": "string",
181 "lastName": "string",
182 "email": "string",
183 "roleIds": [
184 0
185 ],
186 "internalTeamNames": [
187 "string"
188 ],
189 "internalTeamIds": [
190 0
191 ],
192 "internalTeamDisplayIds": [
193 "string"
194 ],
195 "premiseIds": [
196 0
197 ],
198 "premiseNames": [
199 "string"
200 ],
201 "userAvailable": true,
202 "temporaryWorkload": 0,
203 "preferredCultureCode": "string"
204 }
205 ],
206 "assignedUsers": [
207 "string"
208 ],
209 "assetPriority": "string",
210 "assetPriorityId": 0,
211 "assetPriorityDisplayId": "string",
212 "assetPriorityType": "string",
213 "assetAvailable": true,
214 "exactPlacement": "string",
215 "supplierIds": [
216 0
217 ],
218 "documentIds": [
219 0
220 ],
221 "workOrderIds": [
222 0
223 ],
224 "assetPartIds": [
225 0
226 ],
227 "fosId": 0,
228 "downtimeStatus": "string",
229 "premiseFromNrm": true
230 },
231 "mainAssetDisplayId": "string",
232 "workOrderStatusId": 0,
233 "workOrderStatus": "string",
234 "workOrderStatusType": "string",
235 "requestIds": [
236 0
237 ],
238 "internalTeamIds": [
239 0
240 ],
241 "internalTeamDtos": [
242 {
243 "id": 0,
244 "createdBy": "string",
245 "createdAt": "2019-08-24T14:15:22Z",
246 "displayId": "string",
247 "name": "string",
248 "email": "string",
249 "phone": "string",
250 "manager": "string",
251 "requestCategoryName": [
252 "string"
253 ],
254 "requestCategoryId": [
255 0
256 ],
257 "requestCategoryDisplayId": [
258 "string"
259 ],
260 "description": "string",
261 "internalTeamUser": [
262 0
263 ],
264 "members": 0,
265 "mainAssets": [
266 0
267 ],
268 "premiseNames": [
269 "string"
270 ],
271 "internalTeamAvailable": true,
272 "premiseIds": [
273 0
274 ]
275 }
276 ],
277 "internalTeams": [
278 "string"
279 ],
280 "vendorId": 0,
281 "vendorDto": {
282 "id": 0,
283 "createdBy": "string",
284 "createdAt": "2019-08-24T14:15:22Z",
285 "displayId": "string",
286 "name": "string",
287 "description": "string",
288 "address": "string",
289 "contractEndDate": "2019-08-24",
290 "services": "string",
291 "vendorType": "string",
292 "vendorStatusId": 0,
293 "vendorStatus": "string",
294 "vendorStatusType": "string",
295 "businessTypeId": 0,
296 "businessType": "string",
297 "vendorRateId": 0,
298 "vendorRate": "string",
299 "vendorContactIds": [
300 0
301 ],
302 "documentIds": [
303 0
304 ],
305 "assetPartIds": [
306 0
307 ],
308 "mainAssetIds": [
309 0
310 ],
311 "premiseIds": [
312 0
313 ],
314 "ownerDto": {
315 "id": 0,
316 "createdBy": "string",
317 "createdAt": "2019-08-24T14:15:22Z",
318 "userName": "string",
319 "firstName": "string",
320 "lastName": "string",
321 "email": "string",
322 "roleIds": [
323 0
324 ],
325 "internalTeamNames": [
326 "string"
327 ],
328 "internalTeamIds": [
329 0
330 ],
331 "internalTeamDisplayIds": [
332 "string"
333 ],
334 "premiseIds": [
335 0
336 ],
337 "premiseNames": [
338 "string"
339 ],
340 "userAvailable": true,
341 "temporaryWorkload": 0,
342 "preferredCultureCode": "string"
343 },
344 "vendorAvailable": true,
345 "vendorRating": 0.1
346 },
347 "vendorName": "string",
348 "requestCategoryId": 0,
349 "requestCategory": "string",
350 "workOrderTemplateSettings": {
351 "id": 0,
352 "createdBy": "string",
353 "createdAt": "2019-08-24T14:15:22Z",
354 "workOrderId": 0,
355 "startDate": "2019-08-24",
356 "dueDuration": 0,
357 "dueMonths": 0,
358 "endDate": "2019-08-24",
359 "recurringWOPriorityId": 0,
360 "recurringWOPriority": "string",
361 "recurringWOPriorityType": "string",
362 "isTemplate": true,
363 "isRemoveByDate": true,
364 "triggerByWorkOrderStatusId": 0,
365 "triggerByWorkOrderStatus": "string",
366 "triggerByWorkOrderStatusType": "string",
367 "removeByWorkOrderStatusId": 0,
368 "removeByWorkOrderStatus": "string",
369 "removeByWorkOrderStatusType": "string"
370 },
371 "assignedUserIds": [
372 0
373 ],
374 "assignedUserDtos": [
375 {
376 "id": 0,
377 "createdBy": "string",
378 "createdAt": "2019-08-24T14:15:22Z",
379 "userName": "string",
380 "firstName": "string",
381 "lastName": "string",
382 "email": "string",
383 "roleIds": [
384 0
385 ],
386 "internalTeamNames": [
387 "string"
388 ],
389 "internalTeamIds": [
390 0
391 ],
392 "internalTeamDisplayIds": [
393 "string"
394 ],
395 "premiseIds": [
396 0
397 ],
398 "premiseNames": [
399 "string"
400 ],
401 "userAvailable": true,
402 "temporaryWorkload": 0,
403 "preferredCultureCode": "string"
404 }
405 ],
406 "assignedUsers": [
407 "string"
408 ],
409 "variableQuantity": 0,
410 "workOrderAvailable": true,
411 "exactPlacement": "string",
412 "primaryWorkOrderId": 0,
413 "primaryWorkOrderDto": {
414 "id": 0,
415 "createdBy": "string",
416 "createdAt": "2019-08-24T14:15:22Z",
417 "displayId": "string",
418 "name": "string",
419 "imageId": 0,
420 "description": "string",
421 "workType": "string",
422 "vendorRating": 0,
423 "premiseId": 0,
424 "premiseDto": {
425 "id": 0,
426 "createdBy": "string",
427 "createdAt": "2019-08-24T14:15:22Z",
428 "displayId": "string",
429 "premiseName": "string",
430 "description": "string",
431 "address": "string",
432 "internalTeamNames": [
433 "string"
434 ],
435 "internalTeamIds": [
436 0
437 ],
438 "premiseAvailable": true,
439 "premiseFromNrm": true,
440 "nlmId": 0,
441 "nlmDisplayId": "string",
442 "nlmUsed": true,
443 "manager": 0,
444 "managerName": "string",
445 "imageId": 0
446 },
447 "premiseFromNrm": true,
448 "premiseDisplayId": "string",
449 "nssProjectId": 0,
450 "nssTaskId": 0,
451 "nssTaskDisplayId": "string",
452 "orderDate": "2019-08-24",
453 "dueDate": "2019-08-24",
454 "startDate": "2019-08-24",
455 "endDate": "2019-08-24",
456 "startTime": {
457 "hour": 0,
458 "minute": 0,
459 "second": 0,
460 "nano": 0
461 },
462 "endTime": {
463 "hour": 0,
464 "minute": 0,
465 "second": 0,
466 "nano": 0
467 },
468 "estimatedCost": "81.08",
469 "finalCost": "81.08",
470 "duration": 0,
471 "estimatedDayTime": 0,
472 "finalHourTime": "2.5",
473 "estimatedHourTime": "2.5",
474 "closeDate": "2019-08-24",
475 "inspection": "string",
476 "workOrderPriorityId": 0,
477 "workOrderPriority": "string",
478 "workOrderPriorityType": "string",
479 "isTemplate": true,
480 "parentWorkOrderId": 0,
481 "parentWorkOrderDisplayId": "string",
482 "parentWorkOrder": "string",
483 "mainAssetIds": [
484 0
485 ],
486 "mainAssetDto": {
487 "id": 0,
488 "createdBy": "string",
489 "createdAt": "2019-08-24T14:15:22Z",
490 "displayId": "string",
491 "name": "string",
492 "description": "string",
493 "qrCode": "string",
494 "barCode": "string",
495 "imageId": 0,
496 "model": "string",
497 "manufacturer": "string",
498 "serialNumber": "string",
499 "cost": "81.08",
500 "premiseId": 0,
501 "premiseDisplayId": "string",
502 "premiseDto": {
503 "id": 0,
504 "createdBy": "string",
505 "createdAt": "2019-08-24T14:15:22Z",
506 "displayId": "string",
507 "premiseName": "string",
508 "description": "string",
509 "address": "string",
510 "internalTeamNames": [
511 "string"
512 ],
513 "internalTeamIds": [
514 0
515 ],
516 "premiseAvailable": true,
517 "premiseFromNrm": true,
518 "nlmId": 0,
519 "nlmDisplayId": "string",
520 "nlmUsed": true,
521 "manager": 0,
522 "managerName": "string",
523 "imageId": 0
524 },
525 "acquisitionDate": "2019-08-24",
526 "endOfLife": "2019-08-24",
527 "assetStatusId": 0,
528 "assetStatus": "string",
529 "assetStatusType": "string",
530 "parentAssetId": 0,
531 "parentAssetDisplayId": "string",
532 "parentAsset": "string",
533 "parentAssetDto": {},
534 "upcomingMaintenanceDate": "2019-08-24",
535 "assetCategoryIds": [
536 0
537 ],
538 "assetCategories": [
539 "string"
540 ],
541 "internalTeamIds": [
542 0
543 ],
544 "internalTeamDtos": [
545 {
546 "id": 0,
547 "createdBy": "string",
548 "createdAt": "2019-08-24T14:15:22Z",
549 "displayId": "string",
550 "name": "string",
551 "email": "string",
552 "phone": "string",
553 "manager": "string",
554 "requestCategoryName": [
555 "string"
556 ],
557 "requestCategoryId": [
558 0
559 ],
560 "requestCategoryDisplayId": [
561 "string"
562 ],
563 "description": "string",
564 "internalTeamUser": [
565 0
566 ],
567 "members": 0,
568 "mainAssets": [
569 0
570 ],
571 "premiseNames": [
572 "string"
573 ],
574 "internalTeamAvailable": true,
575 "premiseIds": [
576 0
577 ]
578 }
579 ],
580 "internalTeams": [
581 "string"
582 ],
583 "assignedUserIds": [
584 0
585 ],
586 "assignedUserDtos": [
587 {
588 "id": 0,
589 "createdBy": "string",
590 "createdAt": "2019-08-24T14:15:22Z",
591 "userName": "string",
592 "firstName": "string",
593 "lastName": "string",
594 "email": "string",
595 "roleIds": [
596 0
597 ],
598 "internalTeamNames": [
599 "string"
600 ],
601 "internalTeamIds": [
602 0
603 ],
604 "internalTeamDisplayIds": [
605 "string"
606 ],
607 "premiseIds": [
608 0
609 ],
610 "premiseNames": [
611 "string"
612 ],
613 "userAvailable": true,
614 "temporaryWorkload": 0,
615 "preferredCultureCode": "string"
616 }
617 ],
618 "assignedUsers": [
619 "string"
620 ],
621 "assetPriority": "string",
622 "assetPriorityId": 0,
623 "assetPriorityDisplayId": "string",
624 "assetPriorityType": "string",
625 "assetAvailable": true,
626 "exactPlacement": "string",
627 "supplierIds": [
628 0
629 ],
630 "documentIds": [
631 0
632 ],
633 "workOrderIds": [
634 0
635 ],
636 "assetPartIds": [
637 0
638 ],
639 "fosId": 0,
640 "downtimeStatus": "string",
641 "premiseFromNrm": true
642 },
643 "mainAssetDisplayId": "string",
644 "workOrderStatusId": 0,
645 "workOrderStatus": "string",
646 "workOrderStatusType": "string",
647 "requestIds": [
648 0
649 ],
650 "internalTeamIds": [
651 0
652 ],
653 "internalTeamDtos": [
654 {
655 "id": 0,
656 "createdBy": "string",
657 "createdAt": "2019-08-24T14:15:22Z",
658 "displayId": "string",
659 "name": "string",
660 "email": "string",
661 "phone": "string",
662 "manager": "string",
663 "requestCategoryName": [
664 "string"
665 ],
666 "requestCategoryId": [
667 0
668 ],
669 "requestCategoryDisplayId": [
670 "string"
671 ],
672 "description": "string",
673 "internalTeamUser": [
674 0
675 ],
676 "members": 0,
677 "mainAssets": [
678 0
679 ],
680 "premiseNames": [
681 "string"
682 ],
683 "internalTeamAvailable": true,
684 "premiseIds": [
685 0
686 ]
687 }
688 ],
689 "internalTeams": [
690 "string"
691 ],
692 "vendorId": 0,
693 "vendorDto": {
694 "id": 0,
695 "createdBy": "string",
696 "createdAt": "2019-08-24T14:15:22Z",
697 "displayId": "string",
698 "name": "string",
699 "description": "string",
700 "address": "string",
701 "contractEndDate": "2019-08-24",
702 "services": "string",
703 "vendorType": "string",
704 "vendorStatusId": 0,
705 "vendorStatus": "string",
706 "vendorStatusType": "string",
707 "businessTypeId": 0,
708 "businessType": "string",
709 "vendorRateId": 0,
710 "vendorRate": "string",
711 "vendorContactIds": [
712 0
713 ],
714 "documentIds": [
715 0
716 ],
717 "assetPartIds": [
718 0
719 ],
720 "mainAssetIds": [
721 0
722 ],
723 "premiseIds": [
724 0
725 ],
726 "ownerDto": {
727 "id": 0,
728 "createdBy": "string",
729 "createdAt": "2019-08-24T14:15:22Z",
730 "userName": "string",
731 "firstName": "string",
732 "lastName": "string",
733 "email": "string",
734 "roleIds": [
735 0
736 ],
737 "internalTeamNames": [
738 "string"
739 ],
740 "internalTeamIds": [
741 0
742 ],
743 "internalTeamDisplayIds": [
744 "string"
745 ],
746 "premiseIds": [
747 0
748 ],
749 "premiseNames": [
750 "string"
751 ],
752 "userAvailable": true,
753 "temporaryWorkload": 0,
754 "preferredCultureCode": "string"
755 },
756 "vendorAvailable": true,
757 "vendorRating": 0.1
758 },
759 "vendorName": "string",
760 "requestCategoryId": 0,
761 "requestCategory": "string",
762 "workOrderTemplateSettings": {
763 "id": 0,
764 "createdBy": "string",
765 "createdAt": "2019-08-24T14:15:22Z",
766 "workOrderId": 0,
767 "startDate": "2019-08-24",
768 "dueDuration": 0,
769 "dueMonths": 0,
770 "endDate": "2019-08-24",
771 "recurringWOPriorityId": 0,
772 "recurringWOPriority": "string",
773 "recurringWOPriorityType": "string",
774 "isTemplate": true,
775 "isRemoveByDate": true,
776 "triggerByWorkOrderStatusId": 0,
777 "triggerByWorkOrderStatus": "string",
778 "triggerByWorkOrderStatusType": "string",
779 "removeByWorkOrderStatusId": 0,
780 "removeByWorkOrderStatus": "string",
781 "removeByWorkOrderStatusType": "string"
782 },
783 "assignedUserIds": [
784 0
785 ],
786 "assignedUserDtos": [
787 {
788 "id": 0,
789 "createdBy": "string",
790 "createdAt": "2019-08-24T14:15:22Z",
791 "userName": "string",
792 "firstName": "string",
793 "lastName": "string",
794 "email": "string",
795 "roleIds": [
796 0
797 ],
798 "internalTeamNames": [
799 "string"
800 ],
801 "internalTeamIds": [
802 0
803 ],
804 "internalTeamDisplayIds": [
805 "string"
806 ],
807 "premiseIds": [
808 0
809 ],
810 "premiseNames": [
811 "string"
812 ],
813 "userAvailable": true,
814 "temporaryWorkload": 0,
815 "preferredCultureCode": "string"
816 }
817 ],
818 "assignedUsers": [
819 "string"
820 ],
821 "variableQuantity": 0,
822 "workOrderAvailable": true,
823 "exactPlacement": "string",
824 "primaryWorkOrderId": 0,
825 "primaryWorkOrderDto": {},
826 "primaryWorkOrderDisplayId": "string",
827 "isPrimary": true,
828 "documentIds": [
829 0
830 ],
831 "assetPartIds": [
832 0
833 ],
834 "invoiceIds": [
835 0
836 ],
837 "internalCosts": "81.08",
838 "invoiceTotal": "81.08",
839 "inspectionItemId": 0
840 },
841 "primaryWorkOrderDisplayId": "string",
842 "isPrimary": true,
843 "documentIds": [
844 0
845 ],
846 "assetPartIds": [
847 0
848 ],
849 "invoiceIds": [
850 0
851 ],
852 "internalCosts": "81.08",
853 "invoiceTotal": "81.08",
854 "inspectionItemId": 0
855}
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 "name": "string",
7 "imageId": 0,
8 "description": "string",
9 "workType": "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 },
35 "premiseFromNrm": true,
36 "premiseDisplayId": "string",
37 "nssProjectId": 0,
38 "nssTaskId": 0,
39 "nssTaskDisplayId": "string",
40 "orderDate": "2019-08-24",
41 "dueDate": "2019-08-24",
42 "startDate": "2019-08-24",
43 "endDate": "2019-08-24",
44 "startTime": {
45 "hour": 0,
46 "minute": 0,
47 "second": 0,
48 "nano": 0
49 },
50 "endTime": {
51 "hour": 0,
52 "minute": 0,
53 "second": 0,
54 "nano": 0
55 },
56 "estimatedCost": "81.08",
57 "finalCost": "81.08",
58 "duration": 0,
59 "estimatedDayTime": 0,
60 "finalHourTime": "2.5",
61 "estimatedHourTime": "2.5",
62 "closeDate": "2019-08-24",
63 "inspection": "string",
64 "workOrderPriorityId": 0,
65 "workOrderPriority": "string",
66 "workOrderPriorityType": "string",
67 "isTemplate": true,
68 "parentWorkOrderId": 0,
69 "parentWorkOrderDisplayId": "string",
70 "parentWorkOrder": "string",
71 "mainAssetIds": [
72 0
73 ],
74 "mainAssetDto": {
75 "id": 0,
76 "createdBy": "string",
77 "createdAt": "2019-08-24T14:15:22Z",
78 "displayId": "string",
79 "name": "string",
80 "description": "string",
81 "qrCode": "string",
82 "barCode": "string",
83 "imageId": 0,
84 "model": "string",
85 "manufacturer": "string",
86 "serialNumber": "string",
87 "cost": "81.08",
88 "premiseId": 0,
89 "premiseDisplayId": "string",
90 "premiseDto": {
91 "id": 0,
92 "createdBy": "string",
93 "createdAt": "2019-08-24T14:15:22Z",
94 "displayId": "string",
95 "premiseName": "string",
96 "description": "string",
97 "address": "string",
98 "internalTeamNames": [
99 "string"
100 ],
101 "internalTeamIds": [
102 0
103 ],
104 "premiseAvailable": true,
105 "premiseFromNrm": true,
106 "nlmId": 0,
107 "nlmDisplayId": "string",
108 "nlmUsed": true,
109 "manager": 0,
110 "managerName": "string",
111 "imageId": 0
112 },
113 "acquisitionDate": "2019-08-24",
114 "endOfLife": "2019-08-24",
115 "assetStatusId": 0,
116 "assetStatus": "string",
117 "assetStatusType": "string",
118 "parentAssetId": 0,
119 "parentAssetDisplayId": "string",
120 "parentAsset": "string",
121 "parentAssetDto": {},
122 "upcomingMaintenanceDate": "2019-08-24",
123 "assetCategoryIds": [
124 0
125 ],
126 "assetCategories": [
127 "string"
128 ],
129 "internalTeamIds": [
130 0
131 ],
132 "internalTeamDtos": [
133 {
134 "id": 0,
135 "createdBy": "string",
136 "createdAt": "2019-08-24T14:15:22Z",
137 "displayId": "string",
138 "name": "string",
139 "email": "string",
140 "phone": "string",
141 "manager": "string",
142 "requestCategoryName": [
143 "string"
144 ],
145 "requestCategoryId": [
146 0
147 ],
148 "requestCategoryDisplayId": [
149 "string"
150 ],
151 "description": "string",
152 "internalTeamUser": [
153 0
154 ],
155 "members": 0,
156 "mainAssets": [
157 0
158 ],
159 "premiseNames": [
160 "string"
161 ],
162 "internalTeamAvailable": true,
163 "premiseIds": [
164 0
165 ]
166 }
167 ],
168 "internalTeams": [
169 "string"
170 ],
171 "assignedUserIds": [
172 0
173 ],
174 "assignedUserDtos": [
175 {
176 "id": 0,
177 "createdBy": "string",
178 "createdAt": "2019-08-24T14:15:22Z",
179 "userName": "string",
180 "firstName": "string",
181 "lastName": "string",
182 "email": "string",
183 "roleIds": [
184 0
185 ],
186 "internalTeamNames": [
187 "string"
188 ],
189 "internalTeamIds": [
190 0
191 ],
192 "internalTeamDisplayIds": [
193 "string"
194 ],
195 "premiseIds": [
196 0
197 ],
198 "premiseNames": [
199 "string"
200 ],
201 "userAvailable": true,
202 "temporaryWorkload": 0,
203 "preferredCultureCode": "string"
204 }
205 ],
206 "assignedUsers": [
207 "string"
208 ],
209 "assetPriority": "string",
210 "assetPriorityId": 0,
211 "assetPriorityDisplayId": "string",
212 "assetPriorityType": "string",
213 "assetAvailable": true,
214 "exactPlacement": "string",
215 "supplierIds": [
216 0
217 ],
218 "documentIds": [
219 0
220 ],
221 "workOrderIds": [
222 0
223 ],
224 "assetPartIds": [
225 0
226 ],
227 "fosId": 0,
228 "downtimeStatus": "string",
229 "premiseFromNrm": true
230 },
231 "mainAssetDisplayId": "string",
232 "workOrderStatusId": 0,
233 "workOrderStatus": "string",
234 "workOrderStatusType": "string",
235 "requestIds": [
236 0
237 ],
238 "internalTeamIds": [
239 0
240 ],
241 "internalTeamDtos": [
242 {
243 "id": 0,
244 "createdBy": "string",
245 "createdAt": "2019-08-24T14:15:22Z",
246 "displayId": "string",
247 "name": "string",
248 "email": "string",
249 "phone": "string",
250 "manager": "string",
251 "requestCategoryName": [
252 "string"
253 ],
254 "requestCategoryId": [
255 0
256 ],
257 "requestCategoryDisplayId": [
258 "string"
259 ],
260 "description": "string",
261 "internalTeamUser": [
262 0
263 ],
264 "members": 0,
265 "mainAssets": [
266 0
267 ],
268 "premiseNames": [
269 "string"
270 ],
271 "internalTeamAvailable": true,
272 "premiseIds": [
273 0
274 ]
275 }
276 ],
277 "internalTeams": [
278 "string"
279 ],
280 "vendorId": 0,
281 "vendorDto": {
282 "id": 0,
283 "createdBy": "string",
284 "createdAt": "2019-08-24T14:15:22Z",
285 "displayId": "string",
286 "name": "string",
287 "description": "string",
288 "address": "string",
289 "contractEndDate": "2019-08-24",
290 "services": "string",
291 "vendorType": "string",
292 "vendorStatusId": 0,
293 "vendorStatus": "string",
294 "vendorStatusType": "string",
295 "businessTypeId": 0,
296 "businessType": "string",
297 "vendorRateId": 0,
298 "vendorRate": "string",
299 "vendorContactIds": [
300 0
301 ],
302 "documentIds": [
303 0
304 ],
305 "assetPartIds": [
306 0
307 ],
308 "mainAssetIds": [
309 0
310 ],
311 "premiseIds": [
312 0
313 ],
314 "ownerDto": {
315 "id": 0,
316 "createdBy": "string",
317 "createdAt": "2019-08-24T14:15:22Z",
318 "userName": "string",
319 "firstName": "string",
320 "lastName": "string",
321 "email": "string",
322 "roleIds": [
323 0
324 ],
325 "internalTeamNames": [
326 "string"
327 ],
328 "internalTeamIds": [
329 0
330 ],
331 "internalTeamDisplayIds": [
332 "string"
333 ],
334 "premiseIds": [
335 0
336 ],
337 "premiseNames": [
338 "string"
339 ],
340 "userAvailable": true,
341 "temporaryWorkload": 0,
342 "preferredCultureCode": "string"
343 },
344 "vendorAvailable": true,
345 "vendorRating": 0.1
346 },
347 "vendorName": "string",
348 "requestCategoryId": 0,
349 "requestCategory": "string",
350 "workOrderTemplateSettings": {
351 "id": 0,
352 "createdBy": "string",
353 "createdAt": "2019-08-24T14:15:22Z",
354 "workOrderId": 0,
355 "startDate": "2019-08-24",
356 "dueDuration": 0,
357 "dueMonths": 0,
358 "endDate": "2019-08-24",
359 "recurringWOPriorityId": 0,
360 "recurringWOPriority": "string",
361 "recurringWOPriorityType": "string",
362 "isTemplate": true,
363 "isRemoveByDate": true,
364 "triggerByWorkOrderStatusId": 0,
365 "triggerByWorkOrderStatus": "string",
366 "triggerByWorkOrderStatusType": "string",
367 "removeByWorkOrderStatusId": 0,
368 "removeByWorkOrderStatus": "string",
369 "removeByWorkOrderStatusType": "string"
370 },
371 "assignedUserIds": [
372 0
373 ],
374 "assignedUserDtos": [
375 {
376 "id": 0,
377 "createdBy": "string",
378 "createdAt": "2019-08-24T14:15:22Z",
379 "userName": "string",
380 "firstName": "string",
381 "lastName": "string",
382 "email": "string",
383 "roleIds": [
384 0
385 ],
386 "internalTeamNames": [
387 "string"
388 ],
389 "internalTeamIds": [
390 0
391 ],
392 "internalTeamDisplayIds": [
393 "string"
394 ],
395 "premiseIds": [
396 0
397 ],
398 "premiseNames": [
399 "string"
400 ],
401 "userAvailable": true,
402 "temporaryWorkload": 0,
403 "preferredCultureCode": "string"
404 }
405 ],
406 "assignedUsers": [
407 "string"
408 ],
409 "variableQuantity": 0,
410 "workOrderAvailable": true,
411 "exactPlacement": "string",
412 "primaryWorkOrderId": 0,
413 "primaryWorkOrderDto": {
414 "id": 0,
415 "createdBy": "string",
416 "createdAt": "2019-08-24T14:15:22Z",
417 "displayId": "string",
418 "name": "string",
419 "imageId": 0,
420 "description": "string",
421 "workType": "string",
422 "vendorRating": 0,
423 "premiseId": 0,
424 "premiseDto": {
425 "id": 0,
426 "createdBy": "string",
427 "createdAt": "2019-08-24T14:15:22Z",
428 "displayId": "string",
429 "premiseName": "string",
430 "description": "string",
431 "address": "string",
432 "internalTeamNames": [
433 "string"
434 ],
435 "internalTeamIds": [
436 0
437 ],
438 "premiseAvailable": true,
439 "premiseFromNrm": true,
440 "nlmId": 0,
441 "nlmDisplayId": "string",
442 "nlmUsed": true,
443 "manager": 0,
444 "managerName": "string",
445 "imageId": 0
446 },
447 "premiseFromNrm": true,
448 "premiseDisplayId": "string",
449 "nssProjectId": 0,
450 "nssTaskId": 0,
451 "nssTaskDisplayId": "string",
452 "orderDate": "2019-08-24",
453 "dueDate": "2019-08-24",
454 "startDate": "2019-08-24",
455 "endDate": "2019-08-24",
456 "startTime": {
457 "hour": 0,
458 "minute": 0,
459 "second": 0,
460 "nano": 0
461 },
462 "endTime": {
463 "hour": 0,
464 "minute": 0,
465 "second": 0,
466 "nano": 0
467 },
468 "estimatedCost": "81.08",
469 "finalCost": "81.08",
470 "duration": 0,
471 "estimatedDayTime": 0,
472 "finalHourTime": "2.5",
473 "estimatedHourTime": "2.5",
474 "closeDate": "2019-08-24",
475 "inspection": "string",
476 "workOrderPriorityId": 0,
477 "workOrderPriority": "string",
478 "workOrderPriorityType": "string",
479 "isTemplate": true,
480 "parentWorkOrderId": 0,
481 "parentWorkOrderDisplayId": "string",
482 "parentWorkOrder": "string",
483 "mainAssetIds": [
484 0
485 ],
486 "mainAssetDto": {
487 "id": 0,
488 "createdBy": "string",
489 "createdAt": "2019-08-24T14:15:22Z",
490 "displayId": "string",
491 "name": "string",
492 "description": "string",
493 "qrCode": "string",
494 "barCode": "string",
495 "imageId": 0,
496 "model": "string",
497 "manufacturer": "string",
498 "serialNumber": "string",
499 "cost": "81.08",
500 "premiseId": 0,
501 "premiseDisplayId": "string",
502 "premiseDto": {
503 "id": 0,
504 "createdBy": "string",
505 "createdAt": "2019-08-24T14:15:22Z",
506 "displayId": "string",
507 "premiseName": "string",
508 "description": "string",
509 "address": "string",
510 "internalTeamNames": [
511 "string"
512 ],
513 "internalTeamIds": [
514 0
515 ],
516 "premiseAvailable": true,
517 "premiseFromNrm": true,
518 "nlmId": 0,
519 "nlmDisplayId": "string",
520 "nlmUsed": true,
521 "manager": 0,
522 "managerName": "string",
523 "imageId": 0
524 },
525 "acquisitionDate": "2019-08-24",
526 "endOfLife": "2019-08-24",
527 "assetStatusId": 0,
528 "assetStatus": "string",
529 "assetStatusType": "string",
530 "parentAssetId": 0,
531 "parentAssetDisplayId": "string",
532 "parentAsset": "string",
533 "parentAssetDto": {},
534 "upcomingMaintenanceDate": "2019-08-24",
535 "assetCategoryIds": [
536 0
537 ],
538 "assetCategories": [
539 "string"
540 ],
541 "internalTeamIds": [
542 0
543 ],
544 "internalTeamDtos": [
545 {
546 "id": 0,
547 "createdBy": "string",
548 "createdAt": "2019-08-24T14:15:22Z",
549 "displayId": "string",
550 "name": "string",
551 "email": "string",
552 "phone": "string",
553 "manager": "string",
554 "requestCategoryName": [
555 "string"
556 ],
557 "requestCategoryId": [
558 0
559 ],
560 "requestCategoryDisplayId": [
561 "string"
562 ],
563 "description": "string",
564 "internalTeamUser": [
565 0
566 ],
567 "members": 0,
568 "mainAssets": [
569 0
570 ],
571 "premiseNames": [
572 "string"
573 ],
574 "internalTeamAvailable": true,
575 "premiseIds": [
576 0
577 ]
578 }
579 ],
580 "internalTeams": [
581 "string"
582 ],
583 "assignedUserIds": [
584 0
585 ],
586 "assignedUserDtos": [
587 {
588 "id": 0,
589 "createdBy": "string",
590 "createdAt": "2019-08-24T14:15:22Z",
591 "userName": "string",
592 "firstName": "string",
593 "lastName": "string",
594 "email": "string",
595 "roleIds": [
596 0
597 ],
598 "internalTeamNames": [
599 "string"
600 ],
601 "internalTeamIds": [
602 0
603 ],
604 "internalTeamDisplayIds": [
605 "string"
606 ],
607 "premiseIds": [
608 0
609 ],
610 "premiseNames": [
611 "string"
612 ],
613 "userAvailable": true,
614 "temporaryWorkload": 0,
615 "preferredCultureCode": "string"
616 }
617 ],
618 "assignedUsers": [
619 "string"
620 ],
621 "assetPriority": "string",
622 "assetPriorityId": 0,
623 "assetPriorityDisplayId": "string",
624 "assetPriorityType": "string",
625 "assetAvailable": true,
626 "exactPlacement": "string",
627 "supplierIds": [
628 0
629 ],
630 "documentIds": [
631 0
632 ],
633 "workOrderIds": [
634 0
635 ],
636 "assetPartIds": [
637 0
638 ],
639 "fosId": 0,
640 "downtimeStatus": "string",
641 "premiseFromNrm": true
642 },
643 "mainAssetDisplayId": "string",
644 "workOrderStatusId": 0,
645 "workOrderStatus": "string",
646 "workOrderStatusType": "string",
647 "requestIds": [
648 0
649 ],
650 "internalTeamIds": [
651 0
652 ],
653 "internalTeamDtos": [
654 {
655 "id": 0,
656 "createdBy": "string",
657 "createdAt": "2019-08-24T14:15:22Z",
658 "displayId": "string",
659 "name": "string",
660 "email": "string",
661 "phone": "string",
662 "manager": "string",
663 "requestCategoryName": [
664 "string"
665 ],
666 "requestCategoryId": [
667 0
668 ],
669 "requestCategoryDisplayId": [
670 "string"
671 ],
672 "description": "string",
673 "internalTeamUser": [
674 0
675 ],
676 "members": 0,
677 "mainAssets": [
678 0
679 ],
680 "premiseNames": [
681 "string"
682 ],
683 "internalTeamAvailable": true,
684 "premiseIds": [
685 0
686 ]
687 }
688 ],
689 "internalTeams": [
690 "string"
691 ],
692 "vendorId": 0,
693 "vendorDto": {
694 "id": 0,
695 "createdBy": "string",
696 "createdAt": "2019-08-24T14:15:22Z",
697 "displayId": "string",
698 "name": "string",
699 "description": "string",
700 "address": "string",
701 "contractEndDate": "2019-08-24",
702 "services": "string",
703 "vendorType": "string",
704 "vendorStatusId": 0,
705 "vendorStatus": "string",
706 "vendorStatusType": "string",
707 "businessTypeId": 0,
708 "businessType": "string",
709 "vendorRateId": 0,
710 "vendorRate": "string",
711 "vendorContactIds": [
712 0
713 ],
714 "documentIds": [
715 0
716 ],
717 "assetPartIds": [
718 0
719 ],
720 "mainAssetIds": [
721 0
722 ],
723 "premiseIds": [
724 0
725 ],
726 "ownerDto": {
727 "id": 0,
728 "createdBy": "string",
729 "createdAt": "2019-08-24T14:15:22Z",
730 "userName": "string",
731 "firstName": "string",
732 "lastName": "string",
733 "email": "string",
734 "roleIds": [
735 0
736 ],
737 "internalTeamNames": [
738 "string"
739 ],
740 "internalTeamIds": [
741 0
742 ],
743 "internalTeamDisplayIds": [
744 "string"
745 ],
746 "premiseIds": [
747 0
748 ],
749 "premiseNames": [
750 "string"
751 ],
752 "userAvailable": true,
753 "temporaryWorkload": 0,
754 "preferredCultureCode": "string"
755 },
756 "vendorAvailable": true,
757 "vendorRating": 0.1
758 },
759 "vendorName": "string",
760 "requestCategoryId": 0,
761 "requestCategory": "string",
762 "workOrderTemplateSettings": {
763 "id": 0,
764 "createdBy": "string",
765 "createdAt": "2019-08-24T14:15:22Z",
766 "workOrderId": 0,
767 "startDate": "2019-08-24",
768 "dueDuration": 0,
769 "dueMonths": 0,
770 "endDate": "2019-08-24",
771 "recurringWOPriorityId": 0,
772 "recurringWOPriority": "string",
773 "recurringWOPriorityType": "string",
774 "isTemplate": true,
775 "isRemoveByDate": true,
776 "triggerByWorkOrderStatusId": 0,
777 "triggerByWorkOrderStatus": "string",
778 "triggerByWorkOrderStatusType": "string",
779 "removeByWorkOrderStatusId": 0,
780 "removeByWorkOrderStatus": "string",
781 "removeByWorkOrderStatusType": "string"
782 },
783 "assignedUserIds": [
784 0
785 ],
786 "assignedUserDtos": [
787 {
788 "id": 0,
789 "createdBy": "string",
790 "createdAt": "2019-08-24T14:15:22Z",
791 "userName": "string",
792 "firstName": "string",
793 "lastName": "string",
794 "email": "string",
795 "roleIds": [
796 0
797 ],
798 "internalTeamNames": [
799 "string"
800 ],
801 "internalTeamIds": [
802 0
803 ],
804 "internalTeamDisplayIds": [
805 "string"
806 ],
807 "premiseIds": [
808 0
809 ],
810 "premiseNames": [
811 "string"
812 ],
813 "userAvailable": true,
814 "temporaryWorkload": 0,
815 "preferredCultureCode": "string"
816 }
817 ],
818 "assignedUsers": [
819 "string"
820 ],
821 "variableQuantity": 0,
822 "workOrderAvailable": true,
823 "exactPlacement": "string",
824 "primaryWorkOrderId": 0,
825 "primaryWorkOrderDto": {},
826 "primaryWorkOrderDisplayId": "string",
827 "isPrimary": true,
828 "documentIds": [
829 0
830 ],
831 "assetPartIds": [
832 0
833 ],
834 "invoiceIds": [
835 0
836 ],
837 "internalCosts": "81.08",
838 "invoiceTotal": "81.08",
839 "inspectionItemId": 0
840 },
841 "primaryWorkOrderDisplayId": "string",
842 "isPrimary": true,
843 "documentIds": [
844 0
845 ],
846 "assetPartIds": [
847 0
848 ],
849 "invoiceIds": [
850 0
851 ],
852 "internalCosts": "81.08",
853 "invoiceTotal": "81.08",
854 "inspectionItemId": 0
855}
Search Nrm Work Orders¶
HTTP Request
POST /api/nrm/work-orders/search
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idNotIn": [
6 0
7 ],
8 "displayIdLike": "string",
9 "nameLike": "string",
10 "isTemplate": true,
11 "isPrimaryWorkOrderIdNull": true,
12 "isParentWorkOrderIdNull": true,
13 "workOrderAvailable": true,
14 "relatedUser": "string",
15 "candidatePrimaryWorkOrderForId": 0,
16 "workOrderStatusIn": [
17 0
18 ],
19 "workOrderPriorityIn": [
20 0
21 ],
22 "attachToAssetIdIn": [
23 0
24 ],
25 "attachToAssetIdNotIn": [
26 0
27 ],
28 "attachToAssetPartIdIn": [
29 0
30 ],
31 "attachToAssetPartIdNotIn": [
32 0
33 ],
34 "attachToRequestIdIn": [
35 0
36 ],
37 "attachToRequestIdNotIn": [
38 0
39 ],
40 "primaryWorkOrderIdIn": [
41 0
42 ],
43 "primaryWorkOrderIdNotIn": [
44 0
45 ],
46 "parentWorkOrderIdIn": [
47 0
48 ],
49 "parentWorkOrderIdNotIn": [
50 0
51 ],
52 "attachToInspectionIdIn": [
53 0
54 ],
55 "attachToInspectionIdNotIn": [
56 0
57 ],
58 "attachToInspectionItemIdIn": [
59 0
60 ],
61 "attachToInspectionItemIdNotIn": [
62 0
63 ],
64 "premiseIdEqual": 0,
65 "premisesIdIn": [
66 0
67 ],
68 "premisesIdNotIn": [
69 0
70 ],
71 "attachToVendorIdIn": [
72 0
73 ],
74 "startDateGreaterThanOrEqual": "2019-08-24",
75 "startDateLessThanOrEqual": "2019-08-24",
76 "endDateLessThanOrEqual": "2019-08-24",
77 "endDateGreaterThanOrEqual": "2019-08-24",
78 "endDateGreaterThanOrEqualOrNull": "2019-08-24",
79 "assigneeEqual": "string",
80 "isActive": true
81}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "numberOfElements": 0,
5 "pageable": {
6 "unpaged": true,
7 "paged": true,
8 "pageNumber": 0,
9 "pageSize": 0,
10 "offset": 0,
11 "sort": {
12 "unsorted": true,
13 "sorted": true,
14 "empty": true
15 }
16 },
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "createdBy": "string",
22 "createdAt": "2019-08-24T14:15:22Z",
23 "displayId": "string",
24 "name": "string",
25 "imageId": 0,
26 "description": "string",
27 "workType": "string",
28 "vendorRating": 0,
29 "premiseId": 0,
30 "premiseDto": {
31 "id": 0,
32 "createdBy": "string",
33 "createdAt": "2019-08-24T14:15:22Z",
34 "displayId": "string",
35 "premiseName": "string",
36 "description": "string",
37 "address": "string",
38 "internalTeamNames": [
39 "string"
40 ],
41 "internalTeamIds": [
42 0
43 ],
44 "premiseAvailable": true,
45 "premiseFromNrm": true,
46 "nlmId": 0,
47 "nlmDisplayId": "string",
48 "nlmUsed": true,
49 "manager": 0,
50 "managerName": "string",
51 "imageId": 0
52 },
53 "premiseFromNrm": true,
54 "premiseDisplayId": "string",
55 "nssProjectId": 0,
56 "nssTaskId": 0,
57 "nssTaskDisplayId": "string",
58 "orderDate": "2019-08-24",
59 "dueDate": "2019-08-24",
60 "startDate": "2019-08-24",
61 "endDate": "2019-08-24",
62 "startTime": {
63 "hour": 0,
64 "minute": 0,
65 "second": 0,
66 "nano": 0
67 },
68 "endTime": {
69 "hour": 0,
70 "minute": 0,
71 "second": 0,
72 "nano": 0
73 },
74 "estimatedCost": "81.08",
75 "finalCost": "81.08",
76 "duration": 0,
77 "estimatedDayTime": 0,
78 "finalHourTime": "2.5",
79 "estimatedHourTime": "2.5",
80 "closeDate": "2019-08-24",
81 "inspection": "string",
82 "workOrderPriorityId": 0,
83 "workOrderPriority": "string",
84 "workOrderPriorityType": "string",
85 "isTemplate": true,
86 "parentWorkOrderId": 0,
87 "parentWorkOrderDisplayId": "string",
88 "parentWorkOrder": "string",
89 "mainAssetIds": [
90 0
91 ],
92 "mainAssetDto": {
93 "id": 0,
94 "createdBy": "string",
95 "createdAt": "2019-08-24T14:15:22Z",
96 "displayId": "string",
97 "name": "string",
98 "description": "string",
99 "qrCode": "string",
100 "barCode": "string",
101 "imageId": 0,
102 "model": "string",
103 "manufacturer": "string",
104 "serialNumber": "string",
105 "cost": "81.08",
106 "premiseId": 0,
107 "premiseDisplayId": "string",
108 "premiseDto": {
109 "id": 0,
110 "createdBy": "string",
111 "createdAt": "2019-08-24T14:15:22Z",
112 "displayId": "string",
113 "premiseName": "string",
114 "description": "string",
115 "address": "string",
116 "internalTeamNames": [
117 "string"
118 ],
119 "internalTeamIds": [
120 0
121 ],
122 "premiseAvailable": true,
123 "premiseFromNrm": true,
124 "nlmId": 0,
125 "nlmDisplayId": "string",
126 "nlmUsed": true,
127 "manager": 0,
128 "managerName": "string",
129 "imageId": 0
130 },
131 "acquisitionDate": "2019-08-24",
132 "endOfLife": "2019-08-24",
133 "assetStatusId": 0,
134 "assetStatus": "string",
135 "assetStatusType": "string",
136 "parentAssetId": 0,
137 "parentAssetDisplayId": "string",
138 "parentAsset": "string",
139 "parentAssetDto": {},
140 "upcomingMaintenanceDate": "2019-08-24",
141 "assetCategoryIds": [
142 0
143 ],
144 "assetCategories": [
145 "string"
146 ],
147 "internalTeamIds": [
148 0
149 ],
150 "internalTeamDtos": [
151 {
152 "id": 0,
153 "createdBy": "string",
154 "createdAt": "2019-08-24T14:15:22Z",
155 "displayId": "string",
156 "name": "string",
157 "email": "string",
158 "phone": "string",
159 "manager": "string",
160 "requestCategoryName": [
161 "string"
162 ],
163 "requestCategoryId": [
164 0
165 ],
166 "requestCategoryDisplayId": [
167 "string"
168 ],
169 "description": "string",
170 "internalTeamUser": [
171 0
172 ],
173 "members": 0,
174 "mainAssets": [
175 0
176 ],
177 "premiseNames": [
178 "string"
179 ],
180 "internalTeamAvailable": true,
181 "premiseIds": [
182 0
183 ]
184 }
185 ],
186 "internalTeams": [
187 "string"
188 ],
189 "assignedUserIds": [
190 0
191 ],
192 "assignedUserDtos": [
193 {
194 "id": 0,
195 "createdBy": "string",
196 "createdAt": "2019-08-24T14:15:22Z",
197 "userName": "string",
198 "firstName": "string",
199 "lastName": "string",
200 "email": "string",
201 "roleIds": [
202 0
203 ],
204 "internalTeamNames": [
205 "string"
206 ],
207 "internalTeamIds": [
208 0
209 ],
210 "internalTeamDisplayIds": [
211 "string"
212 ],
213 "premiseIds": [
214 0
215 ],
216 "premiseNames": [
217 "string"
218 ],
219 "userAvailable": true,
220 "temporaryWorkload": 0,
221 "preferredCultureCode": "string"
222 }
223 ],
224 "assignedUsers": [
225 "string"
226 ],
227 "assetPriority": "string",
228 "assetPriorityId": 0,
229 "assetPriorityDisplayId": "string",
230 "assetPriorityType": "string",
231 "assetAvailable": true,
232 "exactPlacement": "string",
233 "supplierIds": [
234 0
235 ],
236 "documentIds": [
237 0
238 ],
239 "workOrderIds": [
240 0
241 ],
242 "assetPartIds": [
243 0
244 ],
245 "fosId": 0,
246 "downtimeStatus": "string",
247 "premiseFromNrm": true
248 },
249 "mainAssetDisplayId": "string",
250 "workOrderStatusId": 0,
251 "workOrderStatus": "string",
252 "workOrderStatusType": "string",
253 "requestIds": [
254 0
255 ],
256 "internalTeamIds": [
257 0
258 ],
259 "internalTeamDtos": [
260 {
261 "id": 0,
262 "createdBy": "string",
263 "createdAt": "2019-08-24T14:15:22Z",
264 "displayId": "string",
265 "name": "string",
266 "email": "string",
267 "phone": "string",
268 "manager": "string",
269 "requestCategoryName": [
270 "string"
271 ],
272 "requestCategoryId": [
273 0
274 ],
275 "requestCategoryDisplayId": [
276 "string"
277 ],
278 "description": "string",
279 "internalTeamUser": [
280 0
281 ],
282 "members": 0,
283 "mainAssets": [
284 0
285 ],
286 "premiseNames": [
287 "string"
288 ],
289 "internalTeamAvailable": true,
290 "premiseIds": [
291 0
292 ]
293 }
294 ],
295 "internalTeams": [
296 "string"
297 ],
298 "vendorId": 0,
299 "vendorDto": {
300 "id": 0,
301 "createdBy": "string",
302 "createdAt": "2019-08-24T14:15:22Z",
303 "displayId": "string",
304 "name": "string",
305 "description": "string",
306 "address": "string",
307 "contractEndDate": "2019-08-24",
308 "services": "string",
309 "vendorType": "string",
310 "vendorStatusId": 0,
311 "vendorStatus": "string",
312 "vendorStatusType": "string",
313 "businessTypeId": 0,
314 "businessType": "string",
315 "vendorRateId": 0,
316 "vendorRate": "string",
317 "vendorContactIds": [
318 0
319 ],
320 "documentIds": [
321 0
322 ],
323 "assetPartIds": [
324 0
325 ],
326 "mainAssetIds": [
327 0
328 ],
329 "premiseIds": [
330 0
331 ],
332 "ownerDto": {
333 "id": 0,
334 "createdBy": "string",
335 "createdAt": "2019-08-24T14:15:22Z",
336 "userName": "string",
337 "firstName": "string",
338 "lastName": "string",
339 "email": "string",
340 "roleIds": [
341 0
342 ],
343 "internalTeamNames": [
344 "string"
345 ],
346 "internalTeamIds": [
347 0
348 ],
349 "internalTeamDisplayIds": [
350 "string"
351 ],
352 "premiseIds": [
353 0
354 ],
355 "premiseNames": [
356 "string"
357 ],
358 "userAvailable": true,
359 "temporaryWorkload": 0,
360 "preferredCultureCode": "string"
361 },
362 "vendorAvailable": true,
363 "vendorRating": 0.1
364 },
365 "vendorName": "string",
366 "requestCategoryId": 0,
367 "requestCategory": "string",
368 "workOrderTemplateSettings": {
369 "id": 0,
370 "createdBy": "string",
371 "createdAt": "2019-08-24T14:15:22Z",
372 "workOrderId": 0,
373 "startDate": "2019-08-24",
374 "dueDuration": 0,
375 "dueMonths": 0,
376 "endDate": "2019-08-24",
377 "recurringWOPriorityId": 0,
378 "recurringWOPriority": "string",
379 "recurringWOPriorityType": "string",
380 "isTemplate": true,
381 "isRemoveByDate": true,
382 "triggerByWorkOrderStatusId": 0,
383 "triggerByWorkOrderStatus": "string",
384 "triggerByWorkOrderStatusType": "string",
385 "removeByWorkOrderStatusId": 0,
386 "removeByWorkOrderStatus": "string",
387 "removeByWorkOrderStatusType": "string"
388 },
389 "assignedUserIds": [
390 0
391 ],
392 "assignedUserDtos": [
393 {
394 "id": 0,
395 "createdBy": "string",
396 "createdAt": "2019-08-24T14:15:22Z",
397 "userName": "string",
398 "firstName": "string",
399 "lastName": "string",
400 "email": "string",
401 "roleIds": [
402 0
403 ],
404 "internalTeamNames": [
405 "string"
406 ],
407 "internalTeamIds": [
408 0
409 ],
410 "internalTeamDisplayIds": [
411 "string"
412 ],
413 "premiseIds": [
414 0
415 ],
416 "premiseNames": [
417 "string"
418 ],
419 "userAvailable": true,
420 "temporaryWorkload": 0,
421 "preferredCultureCode": "string"
422 }
423 ],
424 "assignedUsers": [
425 "string"
426 ],
427 "variableQuantity": 0,
428 "workOrderAvailable": true,
429 "exactPlacement": "string",
430 "primaryWorkOrderId": 0,
431 "primaryWorkOrderDto": {},
432 "primaryWorkOrderDisplayId": "string",
433 "isPrimary": true,
434 "documentIds": [
435 0
436 ],
437 "assetPartIds": [
438 0
439 ],
440 "invoiceIds": [
441 0
442 ],
443 "internalCosts": "81.08",
444 "invoiceTotal": "81.08",
445 "inspectionItemId": 0
446 }
447 ],
448 "number": 0,
449 "sort": {
450 "unsorted": true,
451 "sorted": true,
452 "empty": true
453 },
454 "first": true,
455 "last": true,
456 "empty": true
457}
Search Nrm Users¶
HTTP Request
POST /api/nrm/users/search
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idNotIn": [
6 0
7 ],
8 "userNameLike": "string",
9 "userAvailable": true,
10 "premiseIdEqualOrNull": 0
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "numberOfElements": 0,
5 "pageable": {
6 "unpaged": true,
7 "paged": true,
8 "pageNumber": 0,
9 "pageSize": 0,
10 "offset": 0,
11 "sort": {
12 "unsorted": true,
13 "sorted": true,
14 "empty": true
15 }
16 },
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "createdBy": "string",
22 "createdAt": "2019-08-24T14:15:22Z",
23 "userName": "string",
24 "firstName": "string",
25 "lastName": "string",
26 "email": "string",
27 "roleIds": [
28 0
29 ],
30 "internalTeamNames": [
31 "string"
32 ],
33 "internalTeamIds": [
34 0
35 ],
36 "internalTeamDisplayIds": [
37 "string"
38 ],
39 "premiseIds": [
40 0
41 ],
42 "premiseNames": [
43 "string"
44 ],
45 "userAvailable": true,
46 "temporaryWorkload": 0,
47 "preferredCultureCode": "string"
48 }
49 ],
50 "number": 0,
51 "sort": {
52 "unsorted": true,
53 "sorted": true,
54 "empty": true
55 },
56 "first": true,
57 "last": true,
58 "empty": true
59}
Search Nrm Premises¶
HTTP Request
POST /api/nrm/premises/searchFilter
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idNotIn": [
6 0
7 ],
8 "displayIdLike": "string",
9 "premiseAvailable": true,
10 "premiseNameLike": "string",
11 "premiseAddressLike": "string",
12 "premiseManagerLike": "string",
13 "attachToVendorIdIn": [
14 0
15 ],
16 "attachToVendorIdNotIn": [
17 0
18 ]
19}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "numberOfElements": 0,
5 "pageable": {
6 "unpaged": true,
7 "paged": true,
8 "pageNumber": 0,
9 "pageSize": 0,
10 "offset": 0,
11 "sort": {
12 "unsorted": true,
13 "sorted": true,
14 "empty": true
15 }
16 },
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "createdBy": "string",
22 "createdAt": "2019-08-24T14:15:22Z",
23 "displayId": "string",
24 "premiseName": "string",
25 "description": "string",
26 "address": "string",
27 "internalTeamNames": [
28 "string"
29 ],
30 "internalTeamIds": [
31 0
32 ],
33 "premiseAvailable": true,
34 "premiseFromNrm": true,
35 "nlmId": 0,
36 "nlmDisplayId": "string",
37 "nlmUsed": true,
38 "manager": 0,
39 "managerName": "string",
40 "imageId": 0
41 }
42 ],
43 "number": 0,
44 "sort": {
45 "unsorted": true,
46 "sorted": true,
47 "empty": true
48 },
49 "first": true,
50 "last": true,
51 "empty": true
52}
Search NRE Premises¶
HTTP Request
POST /api/nrm/premises/nre/search
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idNotIn": [
6 0
7 ],
8 "displayIdLike": "string",
9 "premiseAvailable": true,
10 "premiseNameLike": "string",
11 "premiseAddressLike": "string",
12 "premiseManagerLike": "string",
13 "attachToVendorIdIn": [
14 0
15 ],
16 "attachToVendorIdNotIn": [
17 0
18 ]
19}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "numberOfElements": 0,
5 "pageable": {
6 "unpaged": true,
7 "paged": true,
8 "pageNumber": 0,
9 "pageSize": 0,
10 "offset": 0,
11 "sort": {
12 "unsorted": true,
13 "sorted": true,
14 "empty": true
15 }
16 },
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "createdBy": "string",
22 "createdAt": "2019-08-24T14:15:22Z",
23 "displayId": "string",
24 "premiseName": "string",
25 "description": "string",
26 "address": "string",
27 "internalTeamNames": [
28 "string"
29 ],
30 "internalTeamIds": [
31 0
32 ],
33 "premiseAvailable": true,
34 "premiseFromNrm": true,
35 "nlmId": 0,
36 "nlmDisplayId": "string",
37 "nlmUsed": true,
38 "manager": 0,
39 "managerName": "string",
40 "imageId": 0
41 }
42 ],
43 "number": 0,
44 "sort": {
45 "unsorted": true,
46 "sorted": true,
47 "empty": true
48 },
49 "first": true,
50 "last": true,
51 "empty": true
52}
Search Nrm Main Assets¶
HTTP Request
POST /api/nrm/main-assets/search
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idNotIn": [
6 0
7 ],
8 "displayIdLike": "string",
9 "nameLike": "string",
10 "modelLike": "string",
11 "assetAvailable": true,
12 "premiseIdIn": [
13 0
14 ],
15 "premiseIdNotIn": [
16 0
17 ],
18 "assetStatusIn": [
19 0
20 ],
21 "assetPriorityIn": [
22 0
23 ],
24 "attachToAssetCategoryIdIn": [
25 0
26 ],
27 "attachToAssetCategoryIdNotIn": [
28 0
29 ],
30 "attachToAssetPartIdIn": [
31 0
32 ],
33 "attachToAssetPartIdNotIn": [
34 0
35 ],
36 "attachToWorkOrderIdIn": [
37 0
38 ],
39 "attachToWorkOrderIdNotIn": [
40 0
41 ],
42 "assetPremisesId": "string",
43 "relatedUser": "string"
44}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "numberOfElements": 0,
5 "pageable": {
6 "unpaged": true,
7 "paged": true,
8 "pageNumber": 0,
9 "pageSize": 0,
10 "offset": 0,
11 "sort": {
12 "unsorted": true,
13 "sorted": true,
14 "empty": true
15 }
16 },
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "createdBy": "string",
22 "createdAt": "2019-08-24T14:15:22Z",
23 "displayId": "string",
24 "name": "string",
25 "description": "string",
26 "qrCode": "string",
27 "barCode": "string",
28 "imageId": 0,
29 "model": "string",
30 "manufacturer": "string",
31 "serialNumber": "string",
32 "cost": "81.08",
33 "premiseId": 0,
34 "premiseDisplayId": "string",
35 "premiseDto": {
36 "id": 0,
37 "createdBy": "string",
38 "createdAt": "2019-08-24T14:15:22Z",
39 "displayId": "string",
40 "premiseName": "string",
41 "description": "string",
42 "address": "string",
43 "internalTeamNames": [
44 "string"
45 ],
46 "internalTeamIds": [
47 0
48 ],
49 "premiseAvailable": true,
50 "premiseFromNrm": true,
51 "nlmId": 0,
52 "nlmDisplayId": "string",
53 "nlmUsed": true,
54 "manager": 0,
55 "managerName": "string",
56 "imageId": 0
57 },
58 "acquisitionDate": "2019-08-24",
59 "endOfLife": "2019-08-24",
60 "assetStatusId": 0,
61 "assetStatus": "string",
62 "assetStatusType": "string",
63 "parentAssetId": 0,
64 "parentAssetDisplayId": "string",
65 "parentAsset": "string",
66 "parentAssetDto": {},
67 "upcomingMaintenanceDate": "2019-08-24",
68 "assetCategoryIds": [
69 0
70 ],
71 "assetCategories": [
72 "string"
73 ],
74 "internalTeamIds": [
75 0
76 ],
77 "internalTeamDtos": [
78 {
79 "id": 0,
80 "createdBy": "string",
81 "createdAt": "2019-08-24T14:15:22Z",
82 "displayId": "string",
83 "name": "string",
84 "email": "string",
85 "phone": "string",
86 "manager": "string",
87 "requestCategoryName": [
88 "string"
89 ],
90 "requestCategoryId": [
91 0
92 ],
93 "requestCategoryDisplayId": [
94 "string"
95 ],
96 "description": "string",
97 "internalTeamUser": [
98 0
99 ],
100 "members": 0,
101 "mainAssets": [
102 0
103 ],
104 "premiseNames": [
105 "string"
106 ],
107 "internalTeamAvailable": true,
108 "premiseIds": [
109 0
110 ]
111 }
112 ],
113 "internalTeams": [
114 "string"
115 ],
116 "assignedUserIds": [
117 0
118 ],
119 "assignedUserDtos": [
120 {
121 "id": 0,
122 "createdBy": "string",
123 "createdAt": "2019-08-24T14:15:22Z",
124 "userName": "string",
125 "firstName": "string",
126 "lastName": "string",
127 "email": "string",
128 "roleIds": [
129 0
130 ],
131 "internalTeamNames": [
132 "string"
133 ],
134 "internalTeamIds": [
135 0
136 ],
137 "internalTeamDisplayIds": [
138 "string"
139 ],
140 "premiseIds": [
141 0
142 ],
143 "premiseNames": [
144 "string"
145 ],
146 "userAvailable": true,
147 "temporaryWorkload": 0,
148 "preferredCultureCode": "string"
149 }
150 ],
151 "assignedUsers": [
152 "string"
153 ],
154 "assetPriority": "string",
155 "assetPriorityId": 0,
156 "assetPriorityDisplayId": "string",
157 "assetPriorityType": "string",
158 "assetAvailable": true,
159 "exactPlacement": "string",
160 "supplierIds": [
161 0
162 ],
163 "documentIds": [
164 0
165 ],
166 "workOrderIds": [
167 0
168 ],
169 "assetPartIds": [
170 0
171 ],
172 "fosId": 0,
173 "downtimeStatus": "string",
174 "premiseFromNrm": true
175 }
176 ],
177 "number": 0,
178 "sort": {
179 "unsorted": true,
180 "sorted": true,
181 "empty": true
182 },
183 "first": true,
184 "last": true,
185 "empty": true
186}
Get Nrm Work Order¶
HTTP Request
GET /api/nrm/work-orders/{workOrderId}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
workOrderId |
path |
integer(int64) |
true |
none |
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 "workType": "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 },
35 "premiseFromNrm": true,
36 "premiseDisplayId": "string",
37 "nssProjectId": 0,
38 "nssTaskId": 0,
39 "nssTaskDisplayId": "string",
40 "orderDate": "2019-08-24",
41 "dueDate": "2019-08-24",
42 "startDate": "2019-08-24",
43 "endDate": "2019-08-24",
44 "startTime": {
45 "hour": 0,
46 "minute": 0,
47 "second": 0,
48 "nano": 0
49 },
50 "endTime": {
51 "hour": 0,
52 "minute": 0,
53 "second": 0,
54 "nano": 0
55 },
56 "estimatedCost": "81.08",
57 "finalCost": "81.08",
58 "duration": 0,
59 "estimatedDayTime": 0,
60 "finalHourTime": "2.5",
61 "estimatedHourTime": "2.5",
62 "closeDate": "2019-08-24",
63 "inspection": "string",
64 "workOrderPriorityId": 0,
65 "workOrderPriority": "string",
66 "workOrderPriorityType": "string",
67 "isTemplate": true,
68 "parentWorkOrderId": 0,
69 "parentWorkOrderDisplayId": "string",
70 "parentWorkOrder": "string",
71 "mainAssetIds": [
72 0
73 ],
74 "mainAssetDto": {
75 "id": 0,
76 "createdBy": "string",
77 "createdAt": "2019-08-24T14:15:22Z",
78 "displayId": "string",
79 "name": "string",
80 "description": "string",
81 "qrCode": "string",
82 "barCode": "string",
83 "imageId": 0,
84 "model": "string",
85 "manufacturer": "string",
86 "serialNumber": "string",
87 "cost": "81.08",
88 "premiseId": 0,
89 "premiseDisplayId": "string",
90 "premiseDto": {
91 "id": 0,
92 "createdBy": "string",
93 "createdAt": "2019-08-24T14:15:22Z",
94 "displayId": "string",
95 "premiseName": "string",
96 "description": "string",
97 "address": "string",
98 "internalTeamNames": [
99 "string"
100 ],
101 "internalTeamIds": [
102 0
103 ],
104 "premiseAvailable": true,
105 "premiseFromNrm": true,
106 "nlmId": 0,
107 "nlmDisplayId": "string",
108 "nlmUsed": true,
109 "manager": 0,
110 "managerName": "string",
111 "imageId": 0
112 },
113 "acquisitionDate": "2019-08-24",
114 "endOfLife": "2019-08-24",
115 "assetStatusId": 0,
116 "assetStatus": "string",
117 "assetStatusType": "string",
118 "parentAssetId": 0,
119 "parentAssetDisplayId": "string",
120 "parentAsset": "string",
121 "parentAssetDto": {},
122 "upcomingMaintenanceDate": "2019-08-24",
123 "assetCategoryIds": [
124 0
125 ],
126 "assetCategories": [
127 "string"
128 ],
129 "internalTeamIds": [
130 0
131 ],
132 "internalTeamDtos": [
133 {
134 "id": 0,
135 "createdBy": "string",
136 "createdAt": "2019-08-24T14:15:22Z",
137 "displayId": "string",
138 "name": "string",
139 "email": "string",
140 "phone": "string",
141 "manager": "string",
142 "requestCategoryName": [
143 "string"
144 ],
145 "requestCategoryId": [
146 0
147 ],
148 "requestCategoryDisplayId": [
149 "string"
150 ],
151 "description": "string",
152 "internalTeamUser": [
153 0
154 ],
155 "members": 0,
156 "mainAssets": [
157 0
158 ],
159 "premiseNames": [
160 "string"
161 ],
162 "internalTeamAvailable": true,
163 "premiseIds": [
164 0
165 ]
166 }
167 ],
168 "internalTeams": [
169 "string"
170 ],
171 "assignedUserIds": [
172 0
173 ],
174 "assignedUserDtos": [
175 {
176 "id": 0,
177 "createdBy": "string",
178 "createdAt": "2019-08-24T14:15:22Z",
179 "userName": "string",
180 "firstName": "string",
181 "lastName": "string",
182 "email": "string",
183 "roleIds": [
184 0
185 ],
186 "internalTeamNames": [
187 "string"
188 ],
189 "internalTeamIds": [
190 0
191 ],
192 "internalTeamDisplayIds": [
193 "string"
194 ],
195 "premiseIds": [
196 0
197 ],
198 "premiseNames": [
199 "string"
200 ],
201 "userAvailable": true,
202 "temporaryWorkload": 0,
203 "preferredCultureCode": "string"
204 }
205 ],
206 "assignedUsers": [
207 "string"
208 ],
209 "assetPriority": "string",
210 "assetPriorityId": 0,
211 "assetPriorityDisplayId": "string",
212 "assetPriorityType": "string",
213 "assetAvailable": true,
214 "exactPlacement": "string",
215 "supplierIds": [
216 0
217 ],
218 "documentIds": [
219 0
220 ],
221 "workOrderIds": [
222 0
223 ],
224 "assetPartIds": [
225 0
226 ],
227 "fosId": 0,
228 "downtimeStatus": "string",
229 "premiseFromNrm": true
230 },
231 "mainAssetDisplayId": "string",
232 "workOrderStatusId": 0,
233 "workOrderStatus": "string",
234 "workOrderStatusType": "string",
235 "requestIds": [
236 0
237 ],
238 "internalTeamIds": [
239 0
240 ],
241 "internalTeamDtos": [
242 {
243 "id": 0,
244 "createdBy": "string",
245 "createdAt": "2019-08-24T14:15:22Z",
246 "displayId": "string",
247 "name": "string",
248 "email": "string",
249 "phone": "string",
250 "manager": "string",
251 "requestCategoryName": [
252 "string"
253 ],
254 "requestCategoryId": [
255 0
256 ],
257 "requestCategoryDisplayId": [
258 "string"
259 ],
260 "description": "string",
261 "internalTeamUser": [
262 0
263 ],
264 "members": 0,
265 "mainAssets": [
266 0
267 ],
268 "premiseNames": [
269 "string"
270 ],
271 "internalTeamAvailable": true,
272 "premiseIds": [
273 0
274 ]
275 }
276 ],
277 "internalTeams": [
278 "string"
279 ],
280 "vendorId": 0,
281 "vendorDto": {
282 "id": 0,
283 "createdBy": "string",
284 "createdAt": "2019-08-24T14:15:22Z",
285 "displayId": "string",
286 "name": "string",
287 "description": "string",
288 "address": "string",
289 "contractEndDate": "2019-08-24",
290 "services": "string",
291 "vendorType": "string",
292 "vendorStatusId": 0,
293 "vendorStatus": "string",
294 "vendorStatusType": "string",
295 "businessTypeId": 0,
296 "businessType": "string",
297 "vendorRateId": 0,
298 "vendorRate": "string",
299 "vendorContactIds": [
300 0
301 ],
302 "documentIds": [
303 0
304 ],
305 "assetPartIds": [
306 0
307 ],
308 "mainAssetIds": [
309 0
310 ],
311 "premiseIds": [
312 0
313 ],
314 "ownerDto": {
315 "id": 0,
316 "createdBy": "string",
317 "createdAt": "2019-08-24T14:15:22Z",
318 "userName": "string",
319 "firstName": "string",
320 "lastName": "string",
321 "email": "string",
322 "roleIds": [
323 0
324 ],
325 "internalTeamNames": [
326 "string"
327 ],
328 "internalTeamIds": [
329 0
330 ],
331 "internalTeamDisplayIds": [
332 "string"
333 ],
334 "premiseIds": [
335 0
336 ],
337 "premiseNames": [
338 "string"
339 ],
340 "userAvailable": true,
341 "temporaryWorkload": 0,
342 "preferredCultureCode": "string"
343 },
344 "vendorAvailable": true,
345 "vendorRating": 0.1
346 },
347 "vendorName": "string",
348 "requestCategoryId": 0,
349 "requestCategory": "string",
350 "workOrderTemplateSettings": {
351 "id": 0,
352 "createdBy": "string",
353 "createdAt": "2019-08-24T14:15:22Z",
354 "workOrderId": 0,
355 "startDate": "2019-08-24",
356 "dueDuration": 0,
357 "dueMonths": 0,
358 "endDate": "2019-08-24",
359 "recurringWOPriorityId": 0,
360 "recurringWOPriority": "string",
361 "recurringWOPriorityType": "string",
362 "isTemplate": true,
363 "isRemoveByDate": true,
364 "triggerByWorkOrderStatusId": 0,
365 "triggerByWorkOrderStatus": "string",
366 "triggerByWorkOrderStatusType": "string",
367 "removeByWorkOrderStatusId": 0,
368 "removeByWorkOrderStatus": "string",
369 "removeByWorkOrderStatusType": "string"
370 },
371 "assignedUserIds": [
372 0
373 ],
374 "assignedUserDtos": [
375 {
376 "id": 0,
377 "createdBy": "string",
378 "createdAt": "2019-08-24T14:15:22Z",
379 "userName": "string",
380 "firstName": "string",
381 "lastName": "string",
382 "email": "string",
383 "roleIds": [
384 0
385 ],
386 "internalTeamNames": [
387 "string"
388 ],
389 "internalTeamIds": [
390 0
391 ],
392 "internalTeamDisplayIds": [
393 "string"
394 ],
395 "premiseIds": [
396 0
397 ],
398 "premiseNames": [
399 "string"
400 ],
401 "userAvailable": true,
402 "temporaryWorkload": 0,
403 "preferredCultureCode": "string"
404 }
405 ],
406 "assignedUsers": [
407 "string"
408 ],
409 "variableQuantity": 0,
410 "workOrderAvailable": true,
411 "exactPlacement": "string",
412 "primaryWorkOrderId": 0,
413 "primaryWorkOrderDto": {
414 "id": 0,
415 "createdBy": "string",
416 "createdAt": "2019-08-24T14:15:22Z",
417 "displayId": "string",
418 "name": "string",
419 "imageId": 0,
420 "description": "string",
421 "workType": "string",
422 "vendorRating": 0,
423 "premiseId": 0,
424 "premiseDto": {
425 "id": 0,
426 "createdBy": "string",
427 "createdAt": "2019-08-24T14:15:22Z",
428 "displayId": "string",
429 "premiseName": "string",
430 "description": "string",
431 "address": "string",
432 "internalTeamNames": [
433 "string"
434 ],
435 "internalTeamIds": [
436 0
437 ],
438 "premiseAvailable": true,
439 "premiseFromNrm": true,
440 "nlmId": 0,
441 "nlmDisplayId": "string",
442 "nlmUsed": true,
443 "manager": 0,
444 "managerName": "string",
445 "imageId": 0
446 },
447 "premiseFromNrm": true,
448 "premiseDisplayId": "string",
449 "nssProjectId": 0,
450 "nssTaskId": 0,
451 "nssTaskDisplayId": "string",
452 "orderDate": "2019-08-24",
453 "dueDate": "2019-08-24",
454 "startDate": "2019-08-24",
455 "endDate": "2019-08-24",
456 "startTime": {
457 "hour": 0,
458 "minute": 0,
459 "second": 0,
460 "nano": 0
461 },
462 "endTime": {
463 "hour": 0,
464 "minute": 0,
465 "second": 0,
466 "nano": 0
467 },
468 "estimatedCost": "81.08",
469 "finalCost": "81.08",
470 "duration": 0,
471 "estimatedDayTime": 0,
472 "finalHourTime": "2.5",
473 "estimatedHourTime": "2.5",
474 "closeDate": "2019-08-24",
475 "inspection": "string",
476 "workOrderPriorityId": 0,
477 "workOrderPriority": "string",
478 "workOrderPriorityType": "string",
479 "isTemplate": true,
480 "parentWorkOrderId": 0,
481 "parentWorkOrderDisplayId": "string",
482 "parentWorkOrder": "string",
483 "mainAssetIds": [
484 0
485 ],
486 "mainAssetDto": {
487 "id": 0,
488 "createdBy": "string",
489 "createdAt": "2019-08-24T14:15:22Z",
490 "displayId": "string",
491 "name": "string",
492 "description": "string",
493 "qrCode": "string",
494 "barCode": "string",
495 "imageId": 0,
496 "model": "string",
497 "manufacturer": "string",
498 "serialNumber": "string",
499 "cost": "81.08",
500 "premiseId": 0,
501 "premiseDisplayId": "string",
502 "premiseDto": {
503 "id": 0,
504 "createdBy": "string",
505 "createdAt": "2019-08-24T14:15:22Z",
506 "displayId": "string",
507 "premiseName": "string",
508 "description": "string",
509 "address": "string",
510 "internalTeamNames": [
511 "string"
512 ],
513 "internalTeamIds": [
514 0
515 ],
516 "premiseAvailable": true,
517 "premiseFromNrm": true,
518 "nlmId": 0,
519 "nlmDisplayId": "string",
520 "nlmUsed": true,
521 "manager": 0,
522 "managerName": "string",
523 "imageId": 0
524 },
525 "acquisitionDate": "2019-08-24",
526 "endOfLife": "2019-08-24",
527 "assetStatusId": 0,
528 "assetStatus": "string",
529 "assetStatusType": "string",
530 "parentAssetId": 0,
531 "parentAssetDisplayId": "string",
532 "parentAsset": "string",
533 "parentAssetDto": {},
534 "upcomingMaintenanceDate": "2019-08-24",
535 "assetCategoryIds": [
536 0
537 ],
538 "assetCategories": [
539 "string"
540 ],
541 "internalTeamIds": [
542 0
543 ],
544 "internalTeamDtos": [
545 {
546 "id": 0,
547 "createdBy": "string",
548 "createdAt": "2019-08-24T14:15:22Z",
549 "displayId": "string",
550 "name": "string",
551 "email": "string",
552 "phone": "string",
553 "manager": "string",
554 "requestCategoryName": [
555 "string"
556 ],
557 "requestCategoryId": [
558 0
559 ],
560 "requestCategoryDisplayId": [
561 "string"
562 ],
563 "description": "string",
564 "internalTeamUser": [
565 0
566 ],
567 "members": 0,
568 "mainAssets": [
569 0
570 ],
571 "premiseNames": [
572 "string"
573 ],
574 "internalTeamAvailable": true,
575 "premiseIds": [
576 0
577 ]
578 }
579 ],
580 "internalTeams": [
581 "string"
582 ],
583 "assignedUserIds": [
584 0
585 ],
586 "assignedUserDtos": [
587 {
588 "id": 0,
589 "createdBy": "string",
590 "createdAt": "2019-08-24T14:15:22Z",
591 "userName": "string",
592 "firstName": "string",
593 "lastName": "string",
594 "email": "string",
595 "roleIds": [
596 0
597 ],
598 "internalTeamNames": [
599 "string"
600 ],
601 "internalTeamIds": [
602 0
603 ],
604 "internalTeamDisplayIds": [
605 "string"
606 ],
607 "premiseIds": [
608 0
609 ],
610 "premiseNames": [
611 "string"
612 ],
613 "userAvailable": true,
614 "temporaryWorkload": 0,
615 "preferredCultureCode": "string"
616 }
617 ],
618 "assignedUsers": [
619 "string"
620 ],
621 "assetPriority": "string",
622 "assetPriorityId": 0,
623 "assetPriorityDisplayId": "string",
624 "assetPriorityType": "string",
625 "assetAvailable": true,
626 "exactPlacement": "string",
627 "supplierIds": [
628 0
629 ],
630 "documentIds": [
631 0
632 ],
633 "workOrderIds": [
634 0
635 ],
636 "assetPartIds": [
637 0
638 ],
639 "fosId": 0,
640 "downtimeStatus": "string",
641 "premiseFromNrm": true
642 },
643 "mainAssetDisplayId": "string",
644 "workOrderStatusId": 0,
645 "workOrderStatus": "string",
646 "workOrderStatusType": "string",
647 "requestIds": [
648 0
649 ],
650 "internalTeamIds": [
651 0
652 ],
653 "internalTeamDtos": [
654 {
655 "id": 0,
656 "createdBy": "string",
657 "createdAt": "2019-08-24T14:15:22Z",
658 "displayId": "string",
659 "name": "string",
660 "email": "string",
661 "phone": "string",
662 "manager": "string",
663 "requestCategoryName": [
664 "string"
665 ],
666 "requestCategoryId": [
667 0
668 ],
669 "requestCategoryDisplayId": [
670 "string"
671 ],
672 "description": "string",
673 "internalTeamUser": [
674 0
675 ],
676 "members": 0,
677 "mainAssets": [
678 0
679 ],
680 "premiseNames": [
681 "string"
682 ],
683 "internalTeamAvailable": true,
684 "premiseIds": [
685 0
686 ]
687 }
688 ],
689 "internalTeams": [
690 "string"
691 ],
692 "vendorId": 0,
693 "vendorDto": {
694 "id": 0,
695 "createdBy": "string",
696 "createdAt": "2019-08-24T14:15:22Z",
697 "displayId": "string",
698 "name": "string",
699 "description": "string",
700 "address": "string",
701 "contractEndDate": "2019-08-24",
702 "services": "string",
703 "vendorType": "string",
704 "vendorStatusId": 0,
705 "vendorStatus": "string",
706 "vendorStatusType": "string",
707 "businessTypeId": 0,
708 "businessType": "string",
709 "vendorRateId": 0,
710 "vendorRate": "string",
711 "vendorContactIds": [
712 0
713 ],
714 "documentIds": [
715 0
716 ],
717 "assetPartIds": [
718 0
719 ],
720 "mainAssetIds": [
721 0
722 ],
723 "premiseIds": [
724 0
725 ],
726 "ownerDto": {
727 "id": 0,
728 "createdBy": "string",
729 "createdAt": "2019-08-24T14:15:22Z",
730 "userName": "string",
731 "firstName": "string",
732 "lastName": "string",
733 "email": "string",
734 "roleIds": [
735 0
736 ],
737 "internalTeamNames": [
738 "string"
739 ],
740 "internalTeamIds": [
741 0
742 ],
743 "internalTeamDisplayIds": [
744 "string"
745 ],
746 "premiseIds": [
747 0
748 ],
749 "premiseNames": [
750 "string"
751 ],
752 "userAvailable": true,
753 "temporaryWorkload": 0,
754 "preferredCultureCode": "string"
755 },
756 "vendorAvailable": true,
757 "vendorRating": 0.1
758 },
759 "vendorName": "string",
760 "requestCategoryId": 0,
761 "requestCategory": "string",
762 "workOrderTemplateSettings": {
763 "id": 0,
764 "createdBy": "string",
765 "createdAt": "2019-08-24T14:15:22Z",
766 "workOrderId": 0,
767 "startDate": "2019-08-24",
768 "dueDuration": 0,
769 "dueMonths": 0,
770 "endDate": "2019-08-24",
771 "recurringWOPriorityId": 0,
772 "recurringWOPriority": "string",
773 "recurringWOPriorityType": "string",
774 "isTemplate": true,
775 "isRemoveByDate": true,
776 "triggerByWorkOrderStatusId": 0,
777 "triggerByWorkOrderStatus": "string",
778 "triggerByWorkOrderStatusType": "string",
779 "removeByWorkOrderStatusId": 0,
780 "removeByWorkOrderStatus": "string",
781 "removeByWorkOrderStatusType": "string"
782 },
783 "assignedUserIds": [
784 0
785 ],
786 "assignedUserDtos": [
787 {
788 "id": 0,
789 "createdBy": "string",
790 "createdAt": "2019-08-24T14:15:22Z",
791 "userName": "string",
792 "firstName": "string",
793 "lastName": "string",
794 "email": "string",
795 "roleIds": [
796 0
797 ],
798 "internalTeamNames": [
799 "string"
800 ],
801 "internalTeamIds": [
802 0
803 ],
804 "internalTeamDisplayIds": [
805 "string"
806 ],
807 "premiseIds": [
808 0
809 ],
810 "premiseNames": [
811 "string"
812 ],
813 "userAvailable": true,
814 "temporaryWorkload": 0,
815 "preferredCultureCode": "string"
816 }
817 ],
818 "assignedUsers": [
819 "string"
820 ],
821 "variableQuantity": 0,
822 "workOrderAvailable": true,
823 "exactPlacement": "string",
824 "primaryWorkOrderId": 0,
825 "primaryWorkOrderDto": {},
826 "primaryWorkOrderDisplayId": "string",
827 "isPrimary": true,
828 "documentIds": [
829 0
830 ],
831 "assetPartIds": [
832 0
833 ],
834 "invoiceIds": [
835 0
836 ],
837 "internalCosts": "81.08",
838 "invoiceTotal": "81.08",
839 "inspectionItemId": 0
840 },
841 "primaryWorkOrderDisplayId": "string",
842 "isPrimary": true,
843 "documentIds": [
844 0
845 ],
846 "assetPartIds": [
847 0
848 ],
849 "invoiceIds": [
850 0
851 ],
852 "internalCosts": "81.08",
853 "invoiceTotal": "81.08",
854 "inspectionItemId": 0
855}
Get Nrm Work Order Statuses¶
HTTP Request
GET /api/nrm/work-orders/statuses
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 "isDefault": true,
9 "objectAvailable": true,
10 "workOrderStatusType": "string",
11 "isDefaultType": true
12 }
13]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
none |
|
» id |
integer(int64) |
false |
none |
none |
» createdBy |
string |
false |
none |
none |
» createdAt |
string(date-time) |
false |
none |
none |
» displayId |
string |
false |
none |
none |
» name |
string |
true |
none |
none |
» isDefault |
boolean |
false |
none |
none |
» objectAvailable |
boolean |
false |
none |
none |
» workOrderStatusType |
string |
false |
none |
none |
» isDefaultType |
boolean |
false |
none |
none |
Get Nrm Priorities¶
HTTP Request
GET /api/nrm/work-orders/priorities
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 "isDefault": true,
9 "leadTime": 0,
10 "objectAvailable": true,
11 "workOrderPriorityType": "string",
12 "isDefaultType": true
13 }
14]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
none |
|
» id |
integer(int64) |
false |
none |
none |
» createdBy |
string |
false |
none |
none |
» createdAt |
string(date-time) |
false |
none |
none |
» displayId |
string |
false |
none |
none |
» name |
string |
true |
none |
none |
» isDefault |
boolean |
false |
none |
none |
» leadTime |
integer(int32) |
false |
none |
none |
» objectAvailable |
boolean |
false |
none |
none |
» workOrderPriorityType |
string |
false |
none |
none |
» isDefaultType |
boolean |
false |
none |
none |
Get Nrm Users¶
HTTP Request
GET /api/nrm/users
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 "userName": "string",
7 "firstName": "string",
8 "lastName": "string",
9 "email": "string",
10 "roleIds": [
11 0
12 ],
13 "internalTeamNames": [
14 "string"
15 ],
16 "internalTeamIds": [
17 0
18 ],
19 "internalTeamDisplayIds": [
20 "string"
21 ],
22 "premiseIds": [
23 0
24 ],
25 "premiseNames": [
26 "string"
27 ],
28 "userAvailable": true,
29 "temporaryWorkload": 0,
30 "preferredCultureCode": "string"
31 }
32]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
none |
|
» id |
integer(int64) |
false |
none |
none |
» createdBy |
string |
false |
none |
none |
» createdAt |
string(date-time) |
false |
none |
none |
» userName |
string |
false |
none |
none |
» firstName |
string |
false |
none |
none |
» lastName |
string |
false |
none |
none |
string |
false |
none |
none |
|
» roleIds |
[integer] |
false |
none |
none |
» internalTeamNames |
[string] |
false |
none |
none |
» internalTeamIds |
[integer] |
false |
none |
none |
» internalTeamDisplayIds |
[string] |
false |
none |
none |
» premiseIds |
[integer] |
false |
none |
none |
» premiseNames |
[string] |
false |
none |
none |
» userAvailable |
boolean |
false |
none |
none |
» temporaryWorkload |
integer(int32) |
false |
none |
none |
» preferredCultureCode |
string |
false |
none |
none |