Nrm Client¶
Nrm Client - Create Nrm Work Order¶
HTTP Request
POST /api/nrm/work-orders
📋 Description: Creates a new work order within the Nakisa Portfolio Management Suite, enabling users to efficiently manage and track tasks related to portfolio assets and real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the work order details, including asset identifiers, portfolio associations, and relevant analytics for real estate property 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 |
|---|---|---|---|
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 "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}
Nrm Client - Search Nrm Work Orders¶
HTTP Request
POST /api/nrm/work-orders/search
📋 Description: Submits a search request for work orders within the Nakisa Portfolio Management Suite, enabling users to efficiently locate and analyze portfolio-related asset activities in the context of real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing search criteria and filters for retrieving work order information related to portfolio management, asset tracking, and real estate analytics. |
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 "isNotAssignedToTask": true
82}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
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 "vendorRating": 0,
28 "premiseId": 0,
29 "premiseDto": {
30 "id": 0,
31 "createdBy": "string",
32 "createdAt": "2019-08-24T14:15:22Z",
33 "displayId": "string",
34 "premiseName": "string",
35 "description": "string",
36 "address": "string",
37 "internalTeamNames": [
38 "string"
39 ],
40 "internalTeamIds": [
41 0
42 ],
43 "premiseAvailable": true,
44 "premiseFromNrm": true,
45 "nlmId": 0,
46 "nlmDisplayId": "string",
47 "nlmUsed": true,
48 "manager": 0,
49 "managerName": "string",
50 "imageId": 0,
51 "area": "string",
52 "modifiedAt": "2019-08-24T14:15:22Z"
53 },
54 "premiseFromNrm": true,
55 "premiseDisplayId": "string",
56 "nssProjectId": 0,
57 "nssTaskId": 0,
58 "nssTaskDisplayId": "string",
59 "orderDate": "2019-08-24",
60 "dueDate": "2019-08-24",
61 "startDate": "2019-08-24",
62 "endDate": "2019-08-24",
63 "startTime": {
64 "hour": 0,
65 "minute": 0,
66 "second": 0,
67 "nano": 0
68 },
69 "endTime": {
70 "hour": 0,
71 "minute": 0,
72 "second": 0,
73 "nano": 0
74 },
75 "modifiedAt": "2019-08-24T14:15:22Z",
76 "estimatedCost": "81.08",
77 "finalCost": "81.08",
78 "duration": 0,
79 "estimatedDayTime": 0,
80 "finalHourTime": "2.5",
81 "estimatedHourTime": "2.5",
82 "closeDate": "2019-08-24",
83 "inspection": "string",
84 "workOrderTypeId": 0,
85 "workOrderTypeName": "string",
86 "workOrderType": "string",
87 "workOrderPriorityId": 0,
88 "workOrderPriority": "string",
89 "workOrderPriorityType": "string",
90 "isTemplate": true,
91 "isWorkOrderTemplate": true,
92 "templateId": 0,
93 "isPartsInSufficient": true,
94 "partQuantityInfoList": [
95 {
96 "partId": 0,
97 "partDisplayId": "string",
98 "requestedQuantity": 0,
99 "availableQuantity": 0,
100 "usedQuantity": 0,
101 "sufficient": true,
102 "partial": true
103 }
104 ],
105 "parentWorkOrderId": 0,
106 "parentWorkOrderDisplayId": "string",
107 "parentWorkOrder": "string",
108 "mainAssetIds": [
109 0
110 ],
111 "mainAssetDto": {
112 "id": 0,
113 "createdBy": "string",
114 "createdAt": "2019-08-24T14:15:22Z",
115 "displayId": "string",
116 "name": "string",
117 "description": "string",
118 "qrCode": "string",
119 "barCode": "string",
120 "imageId": 0,
121 "model": "string",
122 "manufacturer": "string",
123 "serialNumber": "string",
124 "cost": "81.08",
125 "premiseId": 0,
126 "premiseDisplayId": "string",
127 "premiseDto": {
128 "id": 0,
129 "createdBy": "string",
130 "createdAt": "2019-08-24T14:15:22Z",
131 "displayId": "string",
132 "premiseName": "string",
133 "description": "string",
134 "address": "string",
135 "internalTeamNames": [
136 "string"
137 ],
138 "internalTeamIds": [
139 0
140 ],
141 "premiseAvailable": true,
142 "premiseFromNrm": true,
143 "nlmId": 0,
144 "nlmDisplayId": "string",
145 "nlmUsed": true,
146 "manager": 0,
147 "managerName": "string",
148 "imageId": 0,
149 "area": "string",
150 "modifiedAt": "2019-08-24T14:15:22Z"
151 },
152 "acquisitionDate": "2019-08-24",
153 "endOfLife": "2019-08-24",
154 "assetStatusId": 0,
155 "assetStatus": "string",
156 "assetStatusType": "string",
157 "parentAssetId": 0,
158 "parentAssetDisplayId": "string",
159 "parentAsset": "string",
160 "parentAssetDto": {},
161 "upcomingMaintenanceDate": "2019-08-24",
162 "assetCategoryIds": [
163 0
164 ],
165 "assetCategories": [
166 "string"
167 ],
168 "internalTeamIds": [
169 0
170 ],
171 "internalTeamDtos": [
172 {
173 "id": 0,
174 "createdBy": "string",
175 "createdAt": "2019-08-24T14:15:22Z",
176 "displayId": "string",
177 "name": "string",
178 "email": "string",
179 "phone": "string",
180 "manager": "string",
181 "requestCategoryName": [
182 "string"
183 ],
184 "requestCategoryId": [
185 0
186 ],
187 "requestCategoryDisplayId": [
188 "string"
189 ],
190 "description": "string",
191 "internalTeamUser": [
192 0
193 ],
194 "members": 0,
195 "mainAssets": [
196 0
197 ],
198 "premiseNames": [
199 "string"
200 ],
201 "internalTeamAvailable": true,
202 "premiseIds": [
203 0
204 ]
205 }
206 ],
207 "internalTeams": [
208 "string"
209 ],
210 "assignedUserIds": [
211 0
212 ],
213 "assignedUserDtos": [
214 {
215 "id": 0,
216 "createdBy": "string",
217 "createdAt": "2019-08-24T14:15:22Z",
218 "userName": "string",
219 "firstName": "string",
220 "lastName": "string",
221 "email": "string",
222 "roleIds": [
223 0
224 ],
225 "internalTeamNames": [
226 "string"
227 ],
228 "internalTeamIds": [
229 0
230 ],
231 "internalTeamDisplayIds": [
232 "string"
233 ],
234 "premiseIds": [
235 0
236 ],
237 "premiseNames": [
238 "string"
239 ],
240 "userAvailable": true,
241 "temporaryWorkload": 0,
242 "preferredCultureCode": "string"
243 }
244 ],
245 "assignedUsers": [
246 "string"
247 ],
248 "assetPriority": "string",
249 "assetPriorityId": 0,
250 "assetPriorityDisplayId": "string",
251 "assetPriorityType": "string",
252 "assetAvailable": true,
253 "exactPlacement": "string",
254 "fosId": 0,
255 "downtimeStatus": "string",
256 "premiseFromNrm": true,
257 "modifiedAt": "2019-08-24T14:15:22Z"
258 },
259 "mainAssetDisplayId": "string",
260 "workOrderStatusId": 0,
261 "workOrderStatus": "string",
262 "workOrderStatusType": "string",
263 "requestIds": [
264 0
265 ],
266 "internalTeamIds": [
267 0
268 ],
269 "internalTeamDtos": [
270 {
271 "id": 0,
272 "createdBy": "string",
273 "createdAt": "2019-08-24T14:15:22Z",
274 "displayId": "string",
275 "name": "string",
276 "email": "string",
277 "phone": "string",
278 "manager": "string",
279 "requestCategoryName": [
280 "string"
281 ],
282 "requestCategoryId": [
283 0
284 ],
285 "requestCategoryDisplayId": [
286 "string"
287 ],
288 "description": "string",
289 "internalTeamUser": [
290 0
291 ],
292 "members": 0,
293 "mainAssets": [
294 0
295 ],
296 "premiseNames": [
297 "string"
298 ],
299 "internalTeamAvailable": true,
300 "premiseIds": [
301 0
302 ]
303 }
304 ],
305 "internalTeams": [
306 "string"
307 ],
308 "vendorId": 0,
309 "vendorDto": {
310 "id": 0,
311 "createdBy": "string",
312 "createdAt": "2019-08-24T14:15:22Z",
313 "displayId": "string",
314 "name": "string",
315 "description": "string",
316 "address": "string",
317 "contractEndDate": "2019-08-24",
318 "services": "string",
319 "vendorType": "string",
320 "vendorStatusId": 0,
321 "vendorStatus": "string",
322 "vendorStatusType": "string",
323 "businessTypeId": 0,
324 "businessType": "string",
325 "vendorRateId": 0,
326 "vendorRate": "string",
327 "vendorContactIds": [
328 0
329 ],
330 "premiseIds": [
331 0
332 ],
333 "firstPremiseDisplayId": "string",
334 "ownerUserName": "string",
335 "ownerDto": {
336 "id": 0,
337 "createdBy": "string",
338 "createdAt": "2019-08-24T14:15:22Z",
339 "userName": "string",
340 "firstName": "string",
341 "lastName": "string",
342 "email": "string",
343 "roleIds": [
344 0
345 ],
346 "internalTeamNames": [
347 "string"
348 ],
349 "internalTeamIds": [
350 0
351 ],
352 "internalTeamDisplayIds": [
353 "string"
354 ],
355 "premiseIds": [
356 0
357 ],
358 "premiseNames": [
359 "string"
360 ],
361 "userAvailable": true,
362 "temporaryWorkload": 0,
363 "preferredCultureCode": "string"
364 },
365 "vendorAvailable": true,
366 "vendorRating": 0.1,
367 "premiseDisplayIds": [
368 "string"
369 ]
370 },
371 "vendorName": "string",
372 "workOrderTemplateSettings": {
373 "id": 0,
374 "createdBy": "string",
375 "createdAt": "2019-08-24T14:15:22Z",
376 "workOrderId": 0,
377 "startDate": "2019-08-24",
378 "dueDuration": 0,
379 "dueMonths": 0,
380 "endDate": "2019-08-24",
381 "recurringWOPriorityId": 0,
382 "recurringWOPriority": "string",
383 "recurringWOPriorityType": "string",
384 "isTemplate": true,
385 "isRemoveByDate": true,
386 "triggerByWorkOrderStatusId": 0,
387 "triggerByWorkOrderStatus": "string",
388 "triggerByWorkOrderStatusType": "string",
389 "removeByWorkOrderStatusId": 0,
390 "removeByWorkOrderStatus": "string",
391 "removeByWorkOrderStatusType": "string"
392 },
393 "assignedUserIds": [
394 0
395 ],
396 "assignedUserDtos": [
397 {
398 "id": 0,
399 "createdBy": "string",
400 "createdAt": "2019-08-24T14:15:22Z",
401 "userName": "string",
402 "firstName": "string",
403 "lastName": "string",
404 "email": "string",
405 "roleIds": [
406 0
407 ],
408 "internalTeamNames": [
409 "string"
410 ],
411 "internalTeamIds": [
412 0
413 ],
414 "internalTeamDisplayIds": [
415 "string"
416 ],
417 "premiseIds": [
418 0
419 ],
420 "premiseNames": [
421 "string"
422 ],
423 "userAvailable": true,
424 "temporaryWorkload": 0,
425 "preferredCultureCode": "string"
426 }
427 ],
428 "assignedUsers": [
429 "string"
430 ],
431 "variableQuantity": 0,
432 "workOrderAvailable": true,
433 "exactPlacement": "string",
434 "primaryWorkOrderId": 0,
435 "primaryWorkOrderDto": {},
436 "primaryWorkOrderDisplayId": "string",
437 "isPrimary": true,
438 "invoiceIds": [
439 0
440 ],
441 "createdByTrigger": true,
442 "internalCosts": "81.08",
443 "invoiceTotal": "81.08",
444 "partsTotal": "81.08",
445 "inspectionItemId": 0,
446 "partIdToAttach": 0
447 }
448 ],
449 "number": 0,
450 "sort": {
451 "sorted": true,
452 "unsorted": true,
453 "empty": true
454 },
455 "first": true,
456 "last": true,
457 "empty": true
458}
Nrm Client - Search Nrm Users¶
HTTP Request
POST /api/nrm/users/search
📋 Description: Submits a search query to locate users within the Nakisa Portfolio Management Suite, enabling efficient access to user data relevant to portfolio, asset, analytics, and real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing user search criteria and filters relevant to portfolio, asset, and real estate property analytics. |
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 "pageable": {
5 "pageNumber": 0,
6 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
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 "sorted": true,
53 "unsorted": true,
54 "empty": true
55 },
56 "first": true,
57 "last": true,
58 "empty": true
59}
Nrm Client - Search Nrm Premises¶
HTTP Request
POST /api/nrm/premises/searchFilter
📋 Description: Submits a search filter request to identify premises within the Nakisa Portfolio Management Suite, enabling users to refine their portfolio, asset, and analytics insights related to real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing search filter criteria for premises, including parameters related to portfolio, asset, and real estate property analytics. |
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 "pageable": {
5 "pageNumber": 0,
6 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
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 "area": "string",
42 "modifiedAt": "2019-08-24T14:15:22Z"
43 }
44 ],
45 "number": 0,
46 "sort": {
47 "sorted": true,
48 "unsorted": true,
49 "empty": true
50 },
51 "first": true,
52 "last": true,
53 "empty": true
54}
Nrm Client - Search NRE Premises¶
HTTP Request
POST /api/nrm/premises/nre/search
📋 Description: Submits a search request for non-residential premises within the Nakisa Portfolio Management Suite, enabling users to efficiently locate and analyze real estate properties in relation to their portfolio and asset management needs.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing search criteria and filters for identifying real estate properties within the portfolio, enabling enhanced asset analytics. |
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 "pageable": {
5 "pageNumber": 0,
6 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
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 "area": "string",
42 "modifiedAt": "2019-08-24T14:15:22Z"
43 }
44 ],
45 "number": 0,
46 "sort": {
47 "sorted": true,
48 "unsorted": true,
49 "empty": true
50 },
51 "first": true,
52 "last": true,
53 "empty": true
54}
Nrm Client - Search Nrm Main Assets¶
HTTP Request
POST /api/nrm/main-assets/search
📋 Description: Submits a search request for main assets within the Nakisa Portfolio Management Suite, enabling users to efficiently analyze and retrieve relevant portfolio and real estate property data.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing search criteria and filters for analyzing main assets within the Nakisa Portfolio Management Suite, specifically tailored for portfolio, asset, and real estate property analytics. |
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 "pageable": {
5 "pageNumber": 0,
6 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
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 "area": "string",
58 "modifiedAt": "2019-08-24T14:15:22Z"
59 },
60 "acquisitionDate": "2019-08-24",
61 "endOfLife": "2019-08-24",
62 "assetStatusId": 0,
63 "assetStatus": "string",
64 "assetStatusType": "string",
65 "parentAssetId": 0,
66 "parentAssetDisplayId": "string",
67 "parentAsset": "string",
68 "parentAssetDto": {},
69 "upcomingMaintenanceDate": "2019-08-24",
70 "assetCategoryIds": [
71 0
72 ],
73 "assetCategories": [
74 "string"
75 ],
76 "internalTeamIds": [
77 0
78 ],
79 "internalTeamDtos": [
80 {
81 "id": 0,
82 "createdBy": "string",
83 "createdAt": "2019-08-24T14:15:22Z",
84 "displayId": "string",
85 "name": "string",
86 "email": "string",
87 "phone": "string",
88 "manager": "string",
89 "requestCategoryName": [
90 "string"
91 ],
92 "requestCategoryId": [
93 0
94 ],
95 "requestCategoryDisplayId": [
96 "string"
97 ],
98 "description": "string",
99 "internalTeamUser": [
100 0
101 ],
102 "members": 0,
103 "mainAssets": [
104 0
105 ],
106 "premiseNames": [
107 "string"
108 ],
109 "internalTeamAvailable": true,
110 "premiseIds": [
111 0
112 ]
113 }
114 ],
115 "internalTeams": [
116 "string"
117 ],
118 "assignedUserIds": [
119 0
120 ],
121 "assignedUserDtos": [
122 {
123 "id": 0,
124 "createdBy": "string",
125 "createdAt": "2019-08-24T14:15:22Z",
126 "userName": "string",
127 "firstName": "string",
128 "lastName": "string",
129 "email": "string",
130 "roleIds": [
131 0
132 ],
133 "internalTeamNames": [
134 "string"
135 ],
136 "internalTeamIds": [
137 0
138 ],
139 "internalTeamDisplayIds": [
140 "string"
141 ],
142 "premiseIds": [
143 0
144 ],
145 "premiseNames": [
146 "string"
147 ],
148 "userAvailable": true,
149 "temporaryWorkload": 0,
150 "preferredCultureCode": "string"
151 }
152 ],
153 "assignedUsers": [
154 "string"
155 ],
156 "assetPriority": "string",
157 "assetPriorityId": 0,
158 "assetPriorityDisplayId": "string",
159 "assetPriorityType": "string",
160 "assetAvailable": true,
161 "exactPlacement": "string",
162 "fosId": 0,
163 "downtimeStatus": "string",
164 "premiseFromNrm": true,
165 "modifiedAt": "2019-08-24T14:15:22Z"
166 }
167 ],
168 "number": 0,
169 "sort": {
170 "sorted": true,
171 "unsorted": true,
172 "empty": true
173 },
174 "first": true,
175 "last": true,
176 "empty": true
177}
Nrm Client - Get Nrm Work Order¶
HTTP Request
GET /api/nrm/work-orders/{workOrderId}
📋 Description: Retrieves detailed information about a specific work order identified by the workOrderId, enabling users to analyze and manage portfolio and asset-related activities within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
workOrderId |
path |
integer(int64) |
true |
Unique identifier for the work order |
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}
Nrm Client - Get Nrm Work Order Statuses¶
HTTP Request
GET /api/nrm/work-orders/statuses
📋 Description: Retrieves the current statuses of work orders within the Nakisa Portfolio Management Suite, providing insights essential for effective portfolio and asset management in real estate property analytics.
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 |
[Data transfer object representing the status of a work order within the Nakisa Portfolio Management Suite, facilitating effective tracking and management of portfolio assets and real estate properties.] |
|
» 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 |
true |
none |
Name of the resource |
» isDefault |
boolean |
false |
none |
Whether the resource is default |
» objectAvailable |
boolean |
false |
none |
Indicates whether the associated asset is available for allocation within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management. |
» workOrderStatusType |
string |
false |
none |
Type of the work order status |
» isDefaultType |
boolean |
false |
none |
Whether the resource is default |
Nrm Client - Get Nrm Priorities¶
HTTP Request
GET /api/nrm/work-orders/priorities
📋 Description: Retrieves a list of work order priorities within the Nakisa Portfolio Management Suite, enabling users to analyze and manage asset-related tasks effectively in the context of portfolio and real estate property management.
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 |
[Data transfer object representing the priority level of work orders within the Nakisa Portfolio Management Suite, facilitating effective asset management and analytics for real estate properties.] |
|
» 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 |
true |
none |
Name of the resource |
» isDefault |
boolean |
false |
none |
Whether the resource is default |
» leadTime |
integer(int32) |
false |
none |
Time of the lead |
» objectAvailable |
boolean |
false |
none |
Indicates whether the specified asset is available for allocation within the Nakisa Portfolio Management Suite, supporting effective portfolio and real estate property management. |
» workOrderPriorityType |
string |
false |
none |
Type of the work order priority |
» isDefaultType |
boolean |
false |
none |
Whether the resource is default |
Nrm Client - Get Nrm Users¶
HTTP Request
GET /api/nrm/users
📋 Description: Retrieves a list of users within the Nakisa Portfolio Management Suite, enabling effective management and analysis of portfolio and asset-related activities in the context of real estate properties.
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 |
[Data transfer object representing a user within the Nakisa Portfolio Management Suite, encapsulating essential information for managing portfolio, asset, and analytics interactions related to real estate properties.] |
|
» 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, utilized for communication and notifications within the Nakisa Portfolio Management Suite, particularly in relation to portfolio, asset, analytics, and real estate property management. |
|
» roleIds |
[integer] |
false |
none |
Array of unique identifiers representing the roles assigned to a user within the Nakisa Portfolio Management Suite, facilitating effective management of portfolios, assets, analytics, and real estate properties. |
» internalTeamNames |
[string] |
false |
none |
List of internal team names associated with the user, relevant for portfolio management, asset tracking, analytics, and real estate property operations. |
» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the user, facilitating collaboration across portfolio, asset, analytics, and real estate property management within the Nakisa Portfolio Management Suite. |
» internalTeamDisplayIds |
[string] |
false |
none |
Array of unique identifiers for internal team display purposes within the Nakisa Portfolio Management Suite, relevant to portfolio, asset, analytics, and real estate property management. |
» premiseIds |
[integer] |
false |
none |
Array of unique identifiers for premises associated with the user’s portfolio, enabling effective asset management and analytics within the Nakisa Portfolio Management Suite. |
» premiseNames |
[string] |
false |
none |
An array of names representing the premises associated with the user’s portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite. |
» userAvailable |
boolean |
false |
none |
Indicates whether the user is available for portfolio management tasks within the Nakisa Portfolio Management Suite. |
» temporaryWorkload |
integer(int32) |
false |
none |
Represents the temporary workload assigned to a user, facilitating effective resource allocation and analytics within the Nakisa Portfolio Management Suite for portfolio and asset management. |
» preferredCultureCode |
string |
false |
none |
Code for the preferred culture |