Request Resource¶
Get Request¶
HTTP Request
GET /api/requests/{id}
📋 Description: Fetches the details of a specific request identified by its unique ID, enabling users to review and manage request information efficiently.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "description": "string",
7 "imageId": 0,
8 "premiseId": 0,
9 "premiseDto": {
10 "id": 0,
11 "createdBy": "string",
12 "createdAt": "2019-08-24T14:15:22Z",
13 "displayId": "string",
14 "premiseName": "string",
15 "description": "string",
16 "address": "string",
17 "internalTeamNames": [
18 "string"
19 ],
20 "internalTeamIds": [
21 0
22 ],
23 "premiseAvailable": true,
24 "premiseFromNrm": true,
25 "nlmId": 0,
26 "nlmDisplayId": "string",
27 "nlmUsed": true,
28 "manager": 0,
29 "managerName": "string",
30 "imageId": 0,
31 "area": "string",
32 "modifiedAt": "2019-08-24T14:15:22Z"
33 },
34 "premiseFromNrm": true,
35 "premiseDisplayId": "string",
36 "name": "string",
37 "requestPriority": "string",
38 "requestPriorityType": "string",
39 "requestPriorityId": 0,
40 "requestPriorityDisplayId": "string",
41 "requestDate": "2019-08-24",
42 "modifiedAt": "2019-08-24T14:15:22Z",
43 "requestCategory": "string",
44 "requestCategoryId": 0,
45 "requestCategoryDisplayId": "string",
46 "requestStatus": "string",
47 "requestStatusType": "string",
48 "requestStatusId": 0,
49 "requestStatusDisplayId": "string",
50 "mainAssetIds": [
51 0
52 ],
53 "mainAssetId": 0,
54 "mainAssetDto": {
55 "id": 0,
56 "createdBy": "string",
57 "createdAt": "2019-08-24T14:15:22Z",
58 "displayId": "string",
59 "name": "string",
60 "description": "string",
61 "qrCode": "string",
62 "barCode": "string",
63 "imageId": 0,
64 "model": "string",
65 "manufacturer": "string",
66 "serialNumber": "string",
67 "cost": "81.08",
68 "premiseId": 0,
69 "premiseDisplayId": "string",
70 "premiseDto": {
71 "id": 0,
72 "createdBy": "string",
73 "createdAt": "2019-08-24T14:15:22Z",
74 "displayId": "string",
75 "premiseName": "string",
76 "description": "string",
77 "address": "string",
78 "internalTeamNames": [
79 "string"
80 ],
81 "internalTeamIds": [
82 0
83 ],
84 "premiseAvailable": true,
85 "premiseFromNrm": true,
86 "nlmId": 0,
87 "nlmDisplayId": "string",
88 "nlmUsed": true,
89 "manager": 0,
90 "managerName": "string",
91 "imageId": 0,
92 "area": "string",
93 "modifiedAt": "2019-08-24T14:15:22Z"
94 },
95 "acquisitionDate": "2019-08-24",
96 "endOfLife": "2019-08-24",
97 "assetStatusId": 0,
98 "assetStatus": "string",
99 "assetStatusType": "string",
100 "parentAssetId": 0,
101 "parentAssetDisplayId": "string",
102 "parentAsset": "string",
103 "parentAssetDto": {},
104 "upcomingMaintenanceDate": "2019-08-24",
105 "assetCategoryIds": [
106 0
107 ],
108 "assetCategories": [
109 "string"
110 ],
111 "internalTeamIds": [
112 0
113 ],
114 "internalTeamDtos": [
115 {
116 "id": 0,
117 "createdBy": "string",
118 "createdAt": "2019-08-24T14:15:22Z",
119 "displayId": "string",
120 "name": "string",
121 "email": "string",
122 "phone": "string",
123 "manager": "string",
124 "requestCategoryName": [
125 "string"
126 ],
127 "requestCategoryId": [
128 0
129 ],
130 "requestCategoryDisplayId": [
131 "string"
132 ],
133 "description": "string",
134 "internalTeamUser": [
135 0
136 ],
137 "members": 0,
138 "mainAssets": [
139 0
140 ],
141 "premiseNames": [
142 "string"
143 ],
144 "internalTeamAvailable": true,
145 "premiseIds": [
146 0
147 ]
148 }
149 ],
150 "internalTeams": [
151 "string"
152 ],
153 "assignedUserIds": [
154 0
155 ],
156 "assignedUserDtos": [
157 {
158 "id": 0,
159 "createdBy": "string",
160 "createdAt": "2019-08-24T14:15:22Z",
161 "userName": "string",
162 "firstName": "string",
163 "lastName": "string",
164 "email": "string",
165 "roleIds": [
166 {
167 "id": 0,
168 "createdBy": "string",
169 "createdAt": "2019-08-24T14:15:22Z",
170 "modifiedBy": "string",
171 "modifiedAt": "2019-08-24T14:15:22Z",
172 "roleName": "string",
173 "entity": "string",
174 "new": true
175 }
176 ],
177 "internalTeamNames": [
178 "string"
179 ],
180 "internalTeamIds": [
181 0
182 ],
183 "internalTeamDisplayIds": [
184 "string"
185 ],
186 "premiseIds": [
187 0
188 ],
189 "premiseNames": [
190 "string"
191 ],
192 "userAvailable": true,
193 "temporaryWorkload": 0,
194 "preferredCultureCode": "string"
195 }
196 ],
197 "assignedUsers": [
198 "string"
199 ],
200 "assetPriority": "string",
201 "assetPriorityId": 0,
202 "assetPriorityDisplayId": "string",
203 "assetPriorityType": "string",
204 "assetAvailable": true,
205 "exactPlacement": "string",
206 "fosId": 0,
207 "downtimeStatus": "string",
208 "premiseFromNrm": true,
209 "modifiedAt": "2019-08-24T14:15:22Z"
210 },
211 "mainAssetDisplayId": "string",
212 "assignedUserIds": [
213 0
214 ],
215 "assignedUserDtos": [
216 {
217 "id": 0,
218 "createdBy": "string",
219 "createdAt": "2019-08-24T14:15:22Z",
220 "userName": "string",
221 "firstName": "string",
222 "lastName": "string",
223 "email": "string",
224 "roleIds": [
225 {
226 "id": 0,
227 "createdBy": "string",
228 "createdAt": "2019-08-24T14:15:22Z",
229 "modifiedBy": "string",
230 "modifiedAt": "2019-08-24T14:15:22Z",
231 "roleName": "string",
232 "entity": "string",
233 "new": true
234 }
235 ],
236 "internalTeamNames": [
237 "string"
238 ],
239 "internalTeamIds": [
240 0
241 ],
242 "internalTeamDisplayIds": [
243 "string"
244 ],
245 "premiseIds": [
246 0
247 ],
248 "premiseNames": [
249 "string"
250 ],
251 "userAvailable": true,
252 "temporaryWorkload": 0,
253 "preferredCultureCode": "string"
254 }
255 ],
256 "assignedUsers": [
257 "string"
258 ],
259 "internalTeamIds": [
260 0
261 ],
262 "internalTeamDtos": [
263 {
264 "id": 0,
265 "createdBy": "string",
266 "createdAt": "2019-08-24T14:15:22Z",
267 "displayId": "string",
268 "name": "string",
269 "email": "string",
270 "phone": "string",
271 "manager": "string",
272 "requestCategoryName": [
273 "string"
274 ],
275 "requestCategoryId": [
276 0
277 ],
278 "requestCategoryDisplayId": [
279 "string"
280 ],
281 "description": "string",
282 "internalTeamUser": [
283 0
284 ],
285 "members": 0,
286 "mainAssets": [
287 0
288 ],
289 "premiseNames": [
290 "string"
291 ],
292 "internalTeamAvailable": true,
293 "premiseIds": [
294 0
295 ]
296 }
297 ],
298 "internalTeams": [
299 "string"
300 ],
301 "requestAvailable": true,
302 "exactPlacement": "string",
303 "requestType": "string",
304 "closeDate": "2019-08-24",
305 "requestFrom": "NFM"
306}
Update Request¶
HTTP Request
PUT /api/requests/{id}
📋 Description: Updates the details of a specific request identified by its unique ID, allowing for modifications to be made in response to changing business needs or user inputs.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated details of the specified request, including relevant attributes and status information. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "description": "string",
7 "imageId": 0,
8 "premiseId": 0,
9 "premiseDto": {
10 "id": 0,
11 "createdBy": "string",
12 "createdAt": "2019-08-24T14:15:22Z",
13 "displayId": "string",
14 "premiseName": "string",
15 "description": "string",
16 "address": "string",
17 "internalTeamNames": [
18 "string"
19 ],
20 "internalTeamIds": [
21 0
22 ],
23 "premiseAvailable": true,
24 "premiseFromNrm": true,
25 "nlmId": 0,
26 "nlmDisplayId": "string",
27 "nlmUsed": true,
28 "manager": 0,
29 "managerName": "string",
30 "imageId": 0,
31 "area": "string",
32 "modifiedAt": "2019-08-24T14:15:22Z"
33 },
34 "premiseFromNrm": true,
35 "premiseDisplayId": "string",
36 "name": "string",
37 "requestPriority": "string",
38 "requestPriorityType": "string",
39 "requestPriorityId": 0,
40 "requestPriorityDisplayId": "string",
41 "requestDate": "2019-08-24",
42 "modifiedAt": "2019-08-24T14:15:22Z",
43 "requestCategory": "string",
44 "requestCategoryId": 0,
45 "requestCategoryDisplayId": "string",
46 "requestStatus": "string",
47 "requestStatusType": "string",
48 "requestStatusId": 0,
49 "requestStatusDisplayId": "string",
50 "mainAssetIds": [
51 0
52 ],
53 "mainAssetId": 0,
54 "mainAssetDto": {
55 "id": 0,
56 "createdBy": "string",
57 "createdAt": "2019-08-24T14:15:22Z",
58 "displayId": "string",
59 "name": "string",
60 "description": "string",
61 "qrCode": "string",
62 "barCode": "string",
63 "imageId": 0,
64 "model": "string",
65 "manufacturer": "string",
66 "serialNumber": "string",
67 "cost": "81.08",
68 "premiseId": 0,
69 "premiseDisplayId": "string",
70 "premiseDto": {
71 "id": 0,
72 "createdBy": "string",
73 "createdAt": "2019-08-24T14:15:22Z",
74 "displayId": "string",
75 "premiseName": "string",
76 "description": "string",
77 "address": "string",
78 "internalTeamNames": [
79 "string"
80 ],
81 "internalTeamIds": [
82 0
83 ],
84 "premiseAvailable": true,
85 "premiseFromNrm": true,
86 "nlmId": 0,
87 "nlmDisplayId": "string",
88 "nlmUsed": true,
89 "manager": 0,
90 "managerName": "string",
91 "imageId": 0,
92 "area": "string",
93 "modifiedAt": "2019-08-24T14:15:22Z"
94 },
95 "acquisitionDate": "2019-08-24",
96 "endOfLife": "2019-08-24",
97 "assetStatusId": 0,
98 "assetStatus": "string",
99 "assetStatusType": "string",
100 "parentAssetId": 0,
101 "parentAssetDisplayId": "string",
102 "parentAsset": "string",
103 "parentAssetDto": {},
104 "upcomingMaintenanceDate": "2019-08-24",
105 "assetCategoryIds": [
106 0
107 ],
108 "assetCategories": [
109 "string"
110 ],
111 "internalTeamIds": [
112 0
113 ],
114 "internalTeamDtos": [
115 {
116 "id": 0,
117 "createdBy": "string",
118 "createdAt": "2019-08-24T14:15:22Z",
119 "displayId": "string",
120 "name": "string",
121 "email": "string",
122 "phone": "string",
123 "manager": "string",
124 "requestCategoryName": [
125 "string"
126 ],
127 "requestCategoryId": [
128 0
129 ],
130 "requestCategoryDisplayId": [
131 "string"
132 ],
133 "description": "string",
134 "internalTeamUser": [
135 0
136 ],
137 "members": 0,
138 "mainAssets": [
139 0
140 ],
141 "premiseNames": [
142 "string"
143 ],
144 "internalTeamAvailable": true,
145 "premiseIds": [
146 0
147 ]
148 }
149 ],
150 "internalTeams": [
151 "string"
152 ],
153 "assignedUserIds": [
154 0
155 ],
156 "assignedUserDtos": [
157 {
158 "id": 0,
159 "createdBy": "string",
160 "createdAt": "2019-08-24T14:15:22Z",
161 "userName": "string",
162 "firstName": "string",
163 "lastName": "string",
164 "email": "string",
165 "roleIds": [
166 {
167 "id": 0,
168 "createdBy": "string",
169 "createdAt": "2019-08-24T14:15:22Z",
170 "modifiedBy": "string",
171 "modifiedAt": "2019-08-24T14:15:22Z",
172 "roleName": "string",
173 "entity": "string",
174 "new": true
175 }
176 ],
177 "internalTeamNames": [
178 "string"
179 ],
180 "internalTeamIds": [
181 0
182 ],
183 "internalTeamDisplayIds": [
184 "string"
185 ],
186 "premiseIds": [
187 0
188 ],
189 "premiseNames": [
190 "string"
191 ],
192 "userAvailable": true,
193 "temporaryWorkload": 0,
194 "preferredCultureCode": "string"
195 }
196 ],
197 "assignedUsers": [
198 "string"
199 ],
200 "assetPriority": "string",
201 "assetPriorityId": 0,
202 "assetPriorityDisplayId": "string",
203 "assetPriorityType": "string",
204 "assetAvailable": true,
205 "exactPlacement": "string",
206 "fosId": 0,
207 "downtimeStatus": "string",
208 "premiseFromNrm": true,
209 "modifiedAt": "2019-08-24T14:15:22Z"
210 },
211 "mainAssetDisplayId": "string",
212 "assignedUserIds": [
213 0
214 ],
215 "assignedUserDtos": [
216 {
217 "id": 0,
218 "createdBy": "string",
219 "createdAt": "2019-08-24T14:15:22Z",
220 "userName": "string",
221 "firstName": "string",
222 "lastName": "string",
223 "email": "string",
224 "roleIds": [
225 {
226 "id": 0,
227 "createdBy": "string",
228 "createdAt": "2019-08-24T14:15:22Z",
229 "modifiedBy": "string",
230 "modifiedAt": "2019-08-24T14:15:22Z",
231 "roleName": "string",
232 "entity": "string",
233 "new": true
234 }
235 ],
236 "internalTeamNames": [
237 "string"
238 ],
239 "internalTeamIds": [
240 0
241 ],
242 "internalTeamDisplayIds": [
243 "string"
244 ],
245 "premiseIds": [
246 0
247 ],
248 "premiseNames": [
249 "string"
250 ],
251 "userAvailable": true,
252 "temporaryWorkload": 0,
253 "preferredCultureCode": "string"
254 }
255 ],
256 "assignedUsers": [
257 "string"
258 ],
259 "internalTeamIds": [
260 0
261 ],
262 "internalTeamDtos": [
263 {
264 "id": 0,
265 "createdBy": "string",
266 "createdAt": "2019-08-24T14:15:22Z",
267 "displayId": "string",
268 "name": "string",
269 "email": "string",
270 "phone": "string",
271 "manager": "string",
272 "requestCategoryName": [
273 "string"
274 ],
275 "requestCategoryId": [
276 0
277 ],
278 "requestCategoryDisplayId": [
279 "string"
280 ],
281 "description": "string",
282 "internalTeamUser": [
283 0
284 ],
285 "members": 0,
286 "mainAssets": [
287 0
288 ],
289 "premiseNames": [
290 "string"
291 ],
292 "internalTeamAvailable": true,
293 "premiseIds": [
294 0
295 ]
296 }
297 ],
298 "internalTeams": [
299 "string"
300 ],
301 "requestAvailable": true,
302 "exactPlacement": "string",
303 "requestType": "string",
304 "closeDate": "2019-08-24",
305 "requestFrom": "NFM"
306}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Request¶
HTTP Request
DELETE /api/requests/{id}
📋 Description: Deletes a specific request identified by its unique ID, ensuring the removal of outdated or unnecessary data from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get All Requests¶
HTTP Request
GET /api/requests
📋 Description: Fetches a list of requests submitted within the system, enabling users to review and manage ongoing operations efficiently.
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 "description": "string",
8 "imageId": 0,
9 "premiseId": 0,
10 "premiseDto": {
11 "id": 0,
12 "createdBy": "string",
13 "createdAt": "2019-08-24T14:15:22Z",
14 "displayId": "string",
15 "premiseName": "string",
16 "description": "string",
17 "address": "string",
18 "internalTeamNames": [
19 "string"
20 ],
21 "internalTeamIds": [
22 0
23 ],
24 "premiseAvailable": true,
25 "premiseFromNrm": true,
26 "nlmId": 0,
27 "nlmDisplayId": "string",
28 "nlmUsed": true,
29 "manager": 0,
30 "managerName": "string",
31 "imageId": 0,
32 "area": "string",
33 "modifiedAt": "2019-08-24T14:15:22Z"
34 },
35 "premiseFromNrm": true,
36 "premiseDisplayId": "string",
37 "name": "string",
38 "requestPriority": "string",
39 "requestPriorityType": "string",
40 "requestPriorityId": 0,
41 "requestPriorityDisplayId": "string",
42 "requestDate": "2019-08-24",
43 "modifiedAt": "2019-08-24T14:15:22Z",
44 "requestCategory": "string",
45 "requestCategoryId": 0,
46 "requestCategoryDisplayId": "string",
47 "requestStatus": "string",
48 "requestStatusType": "string",
49 "requestStatusId": 0,
50 "requestStatusDisplayId": "string",
51 "mainAssetIds": [
52 0
53 ],
54 "mainAssetId": 0,
55 "mainAssetDto": {
56 "id": 0,
57 "createdBy": "string",
58 "createdAt": "2019-08-24T14:15:22Z",
59 "displayId": "string",
60 "name": "string",
61 "description": "string",
62 "qrCode": "string",
63 "barCode": "string",
64 "imageId": 0,
65 "model": "string",
66 "manufacturer": "string",
67 "serialNumber": "string",
68 "cost": "81.08",
69 "premiseId": 0,
70 "premiseDisplayId": "string",
71 "premiseDto": {
72 "id": 0,
73 "createdBy": "string",
74 "createdAt": "2019-08-24T14:15:22Z",
75 "displayId": "string",
76 "premiseName": "string",
77 "description": "string",
78 "address": "string",
79 "internalTeamNames": [
80 "string"
81 ],
82 "internalTeamIds": [
83 0
84 ],
85 "premiseAvailable": true,
86 "premiseFromNrm": true,
87 "nlmId": 0,
88 "nlmDisplayId": "string",
89 "nlmUsed": true,
90 "manager": 0,
91 "managerName": "string",
92 "imageId": 0,
93 "area": "string",
94 "modifiedAt": "2019-08-24T14:15:22Z"
95 },
96 "acquisitionDate": "2019-08-24",
97 "endOfLife": "2019-08-24",
98 "assetStatusId": 0,
99 "assetStatus": "string",
100 "assetStatusType": "string",
101 "parentAssetId": 0,
102 "parentAssetDisplayId": "string",
103 "parentAsset": "string",
104 "parentAssetDto": {},
105 "upcomingMaintenanceDate": "2019-08-24",
106 "assetCategoryIds": [
107 0
108 ],
109 "assetCategories": [
110 "string"
111 ],
112 "internalTeamIds": [
113 0
114 ],
115 "internalTeamDtos": [
116 {
117 "id": 0,
118 "createdBy": "string",
119 "createdAt": "2019-08-24T14:15:22Z",
120 "displayId": "string",
121 "name": "string",
122 "email": "string",
123 "phone": "string",
124 "manager": "string",
125 "requestCategoryName": [
126 "string"
127 ],
128 "requestCategoryId": [
129 0
130 ],
131 "requestCategoryDisplayId": [
132 "string"
133 ],
134 "description": "string",
135 "internalTeamUser": [
136 0
137 ],
138 "members": 0,
139 "mainAssets": [
140 0
141 ],
142 "premiseNames": [
143 "string"
144 ],
145 "internalTeamAvailable": true,
146 "premiseIds": [
147 0
148 ]
149 }
150 ],
151 "internalTeams": [
152 "string"
153 ],
154 "assignedUserIds": [
155 0
156 ],
157 "assignedUserDtos": [
158 {
159 "id": 0,
160 "createdBy": "string",
161 "createdAt": "2019-08-24T14:15:22Z",
162 "userName": "string",
163 "firstName": "string",
164 "lastName": "string",
165 "email": "string",
166 "roleIds": [
167 {
168 "id": 0,
169 "createdBy": "string",
170 "createdAt": "2019-08-24T14:15:22Z",
171 "modifiedBy": "string",
172 "modifiedAt": "2019-08-24T14:15:22Z",
173 "roleName": "string",
174 "entity": "string",
175 "new": true
176 }
177 ],
178 "internalTeamNames": [
179 "string"
180 ],
181 "internalTeamIds": [
182 0
183 ],
184 "internalTeamDisplayIds": [
185 "string"
186 ],
187 "premiseIds": [
188 0
189 ],
190 "premiseNames": [
191 "string"
192 ],
193 "userAvailable": true,
194 "temporaryWorkload": 0,
195 "preferredCultureCode": "string"
196 }
197 ],
198 "assignedUsers": [
199 "string"
200 ],
201 "assetPriority": "string",
202 "assetPriorityId": 0,
203 "assetPriorityDisplayId": "string",
204 "assetPriorityType": "string",
205 "assetAvailable": true,
206 "exactPlacement": "string",
207 "fosId": 0,
208 "downtimeStatus": "string",
209 "premiseFromNrm": true,
210 "modifiedAt": "2019-08-24T14:15:22Z"
211 },
212 "mainAssetDisplayId": "string",
213 "assignedUserIds": [
214 0
215 ],
216 "assignedUserDtos": [
217 {
218 "id": 0,
219 "createdBy": "string",
220 "createdAt": "2019-08-24T14:15:22Z",
221 "userName": "string",
222 "firstName": "string",
223 "lastName": "string",
224 "email": "string",
225 "roleIds": [
226 {
227 "id": 0,
228 "createdBy": "string",
229 "createdAt": "2019-08-24T14:15:22Z",
230 "modifiedBy": "string",
231 "modifiedAt": "2019-08-24T14:15:22Z",
232 "roleName": "string",
233 "entity": "string",
234 "new": true
235 }
236 ],
237 "internalTeamNames": [
238 "string"
239 ],
240 "internalTeamIds": [
241 0
242 ],
243 "internalTeamDisplayIds": [
244 "string"
245 ],
246 "premiseIds": [
247 0
248 ],
249 "premiseNames": [
250 "string"
251 ],
252 "userAvailable": true,
253 "temporaryWorkload": 0,
254 "preferredCultureCode": "string"
255 }
256 ],
257 "assignedUsers": [
258 "string"
259 ],
260 "internalTeamIds": [
261 0
262 ],
263 "internalTeamDtos": [
264 {
265 "id": 0,
266 "createdBy": "string",
267 "createdAt": "2019-08-24T14:15:22Z",
268 "displayId": "string",
269 "name": "string",
270 "email": "string",
271 "phone": "string",
272 "manager": "string",
273 "requestCategoryName": [
274 "string"
275 ],
276 "requestCategoryId": [
277 0
278 ],
279 "requestCategoryDisplayId": [
280 "string"
281 ],
282 "description": "string",
283 "internalTeamUser": [
284 0
285 ],
286 "members": 0,
287 "mainAssets": [
288 0
289 ],
290 "premiseNames": [
291 "string"
292 ],
293 "internalTeamAvailable": true,
294 "premiseIds": [
295 0
296 ]
297 }
298 ],
299 "internalTeams": [
300 "string"
301 ],
302 "requestAvailable": true,
303 "exactPlacement": "string",
304 "requestType": "string",
305 "closeDate": "2019-08-24",
306 "requestFrom": "NFM"
307 }
308]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a client request, encapsulating essential details such as request type, priority, and associated metadata to facilitate efficient processing and tracking within the business workflow.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» description |
string |
false |
none |
Description of the resource |
» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
» premiseDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» premiseName |
string |
false |
none |
Name of the premise |
»» description |
string |
false |
none |
Description of the resource |
»» address |
string |
true |
none |
Represents the physical location associated with the premise, essential for logistics and service delivery. |
»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation within the organization. |
»» internalTeamIds |
[integer] |
false |
none |
List of unique identifiers representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation. |
»» premiseAvailable |
boolean |
false |
none |
Indicates whether the premise is available for use within the specified context. |
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the premise is sourced from the National Resource Management (NRM) framework, facilitating compliance and reporting within environmental management processes. |
»» nlmId |
integer(int64) |
false |
none |
Unique identifier for the nlm |
»» nlmDisplayId |
string |
false |
none |
Unique identifier for the nlm display |
»» nlmUsed |
boolean |
false |
none |
Indicates whether the National Labor Market (NLM) resources have been utilized in the premise evaluation process. |
»» manager |
integer(int64) |
false |
none |
Unique identifier for the manager associated with the premise, facilitating effective organizational hierarchy and resource management. |
»» managerName |
string |
false |
none |
Name of the manager |
»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»» area |
string |
false |
none |
Represents the geographic area associated with the premise, providing essential context for location-based services and analysis. |
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» premiseFromNrm |
boolean |
false |
none |
Indicates whether the premise is sourced from the National Resource Management (NRM) system, facilitating accurate data integration and reporting. |
» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
» name |
string |
false |
none |
Name of the resource |
» requestPriority |
string |
false |
none |
Priority of the request |
» requestPriorityType |
string |
false |
none |
Type of the request priority |
» requestPriorityId |
integer(int64) |
false |
none |
Unique identifier for the request priority |
» requestPriorityDisplayId |
string |
false |
none |
Unique identifier for the request priority display |
» requestDate |
string(date) |
false |
none |
Date of the request |
» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» requestCategory |
string |
false |
none |
Category of the request |
» requestCategoryId |
integer(int64) |
false |
none |
Unique identifier for the request category |
» requestCategoryDisplayId |
string |
false |
none |
Unique identifier for the request category display |
» requestStatus |
string |
false |
none |
Status of the request |
» requestStatusType |
string |
false |
none |
Type of the request status |
» requestStatusId |
integer(int64) |
false |
none |
Unique identifier for the request status |
» requestStatusDisplayId |
string |
false |
none |
Unique identifier for the request status display |
» mainAssetIds |
[integer] |
false |
none |
List of unique identifiers for the primary assets associated with the request, facilitating efficient tracking and management within the system. |
» mainAssetId |
integer(int64) |
false |
none |
Unique identifier for the main asset |
» mainAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» name |
string |
false |
none |
Name of the resource |
»» description |
string |
false |
none |
Description of the resource |
»» qrCode |
string |
false |
none |
Code for the qr |
»» barCode |
string |
false |
none |
Code for the bar |
»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»» model |
string |
false |
none |
Specifies the model associated with the main asset, providing essential context for asset classification and management. |
»» manufacturer |
string |
false |
none |
Name of the manufacturer associated with the asset, providing essential information for inventory management and supplier relations. |
»» serialNumber |
string |
false |
none |
Unique identifier for the asset, used to track and manage inventory within the system. |
»» cost |
string |
false |
none |
Represents the total cost associated with the main asset, providing essential financial information for budgeting and resource allocation. |
»» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
»» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
»» premiseDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
»» acquisitionDate |
string(date) |
false |
none |
Date of the acquisition |
»» endOfLife |
string(date) |
false |
none |
Indicates the end-of-life date for the asset, providing critical information for lifecycle management and planning. |
»» assetStatusId |
integer(int64) |
false |
none |
Unique identifier for the asset status |
»» assetStatus |
string |
false |
none |
Status of the asset |
»» assetStatusType |
string |
false |
none |
Type of the asset status |
»» parentAssetId |
integer(int64) |
false |
none |
Unique identifier for the parent asset |
»» parentAssetDisplayId |
string |
false |
none |
Unique identifier for the parent asset display |
»» parentAsset |
string |
false |
none |
Identifier for the parent asset associated with the main asset, facilitating hierarchical relationships within asset management. |
»» parentAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»» upcomingMaintenanceDate |
string(date) |
false |
none |
Date of the upcoming maintenance |
»» assetCategoryIds |
[integer] |
false |
none |
Array of unique identifiers representing the categories to which the asset belongs, facilitating effective asset classification and management. |
»» assetCategories |
[string] |
false |
none |
Array of asset categories that classify the main assets within the system, facilitating better organization and management of asset data. |
»» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the main asset, facilitating streamlined collaboration and resource allocation. |
»» internalTeamDtos |
false |
none |
An array of MainAssetDTO objects representing the internal teams associated with the asset, facilitating effective resource management and collaboration within the organization. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» name |
string |
false |
none |
Name of the resource |
string |
false |
none |
Email address of the internal team member, used for communication and notifications within the organization. |
|
»»» phone |
string |
false |
none |
Contact number for the internal team, facilitating communication and collaboration within the organization. |
»»» manager |
string |
false |
none |
Represents the name or identifier of the team manager responsible for overseeing the internal team. |
»»» requestCategoryName |
[string] |
false |
none |
Name of the request category |
»»» requestCategoryId |
[integer] |
false |
none |
Unique identifier for the request category |
»»» requestCategoryDisplayId |
[string] |
false |
none |
Unique identifier for the request category display |
»»» description |
string |
false |
none |
Description of the resource |
»»» internalTeamUser |
[integer] |
false |
none |
An array of InternalTeamDTO objects representing the users within the internal team, facilitating collaboration and resource management. |
»»» members |
integer(int32) |
false |
none |
Represents the total number of members within the internal team, providing insight into team size for resource allocation and management. |
»»» mainAssets |
[integer] |
false |
none |
An array of internal team assets that represent the key resources and capabilities utilized within the organization. |
»»» premiseNames |
[string] |
false |
none |
List of names associated with the premises relevant to the internal team, facilitating efficient identification and management of locations within the organization. |
»»» internalTeamAvailable |
boolean |
false |
none |
Indicates the availability of the internal team for project allocation and resource planning. |
»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the internal team. |
»» internalTeams |
[string] |
false |
none |
An array of internal teams associated with the main asset, facilitating collaboration and resource allocation within the organization. |
»» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers representing users assigned to the main asset, facilitating effective resource management and accountability. |
»» assignedUserDtos |
false |
none |
Array of user assignments associated with the main asset, providing insights into resource allocation and accountability. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» userName |
string |
false |
none |
Name of the user |
»»» firstName |
string |
false |
none |
Name of the first |
»»» lastName |
string |
false |
none |
Name of the last |
string |
false |
none |
Email address of the user, used for communication and account verification purposes within the system. |
|
»»» roleIds |
false |
none |
Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»»» modifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»»»» roleName |
string |
false |
none |
Name of the role |
»»»» entity |
string |
false |
none |
Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management. |
»»»» new |
boolean |
false |
none |
Indicates whether the role is newly created within the system, facilitating effective management of organizational changes. |
»»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization. |
»»» internalTeamIds |
[integer] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization. |
»»» internalTeamDisplayIds |
[string] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration. |
»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations. |
»»» premiseNames |
[string] |
false |
none |
List of names associated with the user’s premises, providing essential context for location-based services and operations. |
»»» userAvailable |
boolean |
false |
none |
Indicates whether the user is available for assignment or engagement within the system. |
»»» temporaryWorkload |
integer(int32) |
false |
none |
Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning. |
»»» preferredCultureCode |
string |
false |
none |
Code for the preferred culture |
»» assignedUsers |
[string] |
false |
none |
List of users assigned to the main asset, facilitating effective resource management and collaboration within the organization. |
»» assetPriority |
string |
false |
none |
Priority of the asset |
»» assetPriorityId |
integer(int64) |
false |
none |
Unique identifier for the asset priority |
»» assetPriorityDisplayId |
string |
false |
none |
Unique identifier for the asset priority display |
»» assetPriorityType |
string |
false |
none |
Type of the asset priority |
»» assetAvailable |
boolean |
false |
none |
Indicates whether the asset is currently available for allocation or use within the system. |
»» exactPlacement |
string |
false |
none |
Specifies the precise location or context in which the main asset is intended to be utilized within the business framework. |
»» fosId |
integer(int64) |
false |
none |
Unique identifier for the fos |
»» downtimeStatus |
string |
false |
none |
Status of the downtime |
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the asset is sourced from the National Resource Management (NRM) framework, facilitating compliance and resource tracking. |
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» mainAssetDisplayId |
string |
false |
none |
Unique identifier for the main asset display |
» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers representing the users assigned to the specific task or project within the system. |
» assignedUserDtos |
false |
none |
Array of user assignments that delineates the individuals responsible for managing the associated tasks within the request. |
|
» assignedUsers |
[string] |
false |
none |
List of users assigned to the request, facilitating effective task management and collaboration within the organization. |
» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the request, facilitating effective team management and collaboration. |
» internalTeamDtos |
false |
none |
An array of RequestDTO objects representing the internal teams involved in the project, facilitating collaboration and resource allocation. |
|
» internalTeams |
[string] |
false |
none |
List of internal teams involved in the project, facilitating collaboration and resource allocation. |
» requestAvailable |
boolean |
false |
none |
Indicates whether the requested resource is available for allocation within the system. |
» exactPlacement |
string |
false |
none |
Specifies the precise location or context for the placement of resources within the operational framework. |
» requestType |
string |
false |
none |
Type of the request |
» closeDate |
string(date) |
false |
none |
Date of the close |
» requestFrom |
string |
false |
none |
Identifies the origin of the request, providing context for processing and tracking within the system. |
Enumerated Values
Attribute |
Value |
|---|---|
requestFrom |
NFM, PORTAL |
Create Request¶
HTTP Request
POST /api/requests
📋 Description: Submits a new request to the system, enabling users to initiate workflows and track progress within the business context.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the details of the new request, including relevant parameters and associated metadata for processing. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "description": "string",
7 "imageId": 0,
8 "premiseId": 0,
9 "premiseDto": {
10 "id": 0,
11 "createdBy": "string",
12 "createdAt": "2019-08-24T14:15:22Z",
13 "displayId": "string",
14 "premiseName": "string",
15 "description": "string",
16 "address": "string",
17 "internalTeamNames": [
18 "string"
19 ],
20 "internalTeamIds": [
21 0
22 ],
23 "premiseAvailable": true,
24 "premiseFromNrm": true,
25 "nlmId": 0,
26 "nlmDisplayId": "string",
27 "nlmUsed": true,
28 "manager": 0,
29 "managerName": "string",
30 "imageId": 0,
31 "area": "string",
32 "modifiedAt": "2019-08-24T14:15:22Z"
33 },
34 "premiseFromNrm": true,
35 "premiseDisplayId": "string",
36 "name": "string",
37 "requestPriority": "string",
38 "requestPriorityType": "string",
39 "requestPriorityId": 0,
40 "requestPriorityDisplayId": "string",
41 "requestDate": "2019-08-24",
42 "modifiedAt": "2019-08-24T14:15:22Z",
43 "requestCategory": "string",
44 "requestCategoryId": 0,
45 "requestCategoryDisplayId": "string",
46 "requestStatus": "string",
47 "requestStatusType": "string",
48 "requestStatusId": 0,
49 "requestStatusDisplayId": "string",
50 "mainAssetIds": [
51 0
52 ],
53 "mainAssetId": 0,
54 "mainAssetDto": {
55 "id": 0,
56 "createdBy": "string",
57 "createdAt": "2019-08-24T14:15:22Z",
58 "displayId": "string",
59 "name": "string",
60 "description": "string",
61 "qrCode": "string",
62 "barCode": "string",
63 "imageId": 0,
64 "model": "string",
65 "manufacturer": "string",
66 "serialNumber": "string",
67 "cost": "81.08",
68 "premiseId": 0,
69 "premiseDisplayId": "string",
70 "premiseDto": {
71 "id": 0,
72 "createdBy": "string",
73 "createdAt": "2019-08-24T14:15:22Z",
74 "displayId": "string",
75 "premiseName": "string",
76 "description": "string",
77 "address": "string",
78 "internalTeamNames": [
79 "string"
80 ],
81 "internalTeamIds": [
82 0
83 ],
84 "premiseAvailable": true,
85 "premiseFromNrm": true,
86 "nlmId": 0,
87 "nlmDisplayId": "string",
88 "nlmUsed": true,
89 "manager": 0,
90 "managerName": "string",
91 "imageId": 0,
92 "area": "string",
93 "modifiedAt": "2019-08-24T14:15:22Z"
94 },
95 "acquisitionDate": "2019-08-24",
96 "endOfLife": "2019-08-24",
97 "assetStatusId": 0,
98 "assetStatus": "string",
99 "assetStatusType": "string",
100 "parentAssetId": 0,
101 "parentAssetDisplayId": "string",
102 "parentAsset": "string",
103 "parentAssetDto": {},
104 "upcomingMaintenanceDate": "2019-08-24",
105 "assetCategoryIds": [
106 0
107 ],
108 "assetCategories": [
109 "string"
110 ],
111 "internalTeamIds": [
112 0
113 ],
114 "internalTeamDtos": [
115 {
116 "id": 0,
117 "createdBy": "string",
118 "createdAt": "2019-08-24T14:15:22Z",
119 "displayId": "string",
120 "name": "string",
121 "email": "string",
122 "phone": "string",
123 "manager": "string",
124 "requestCategoryName": [
125 "string"
126 ],
127 "requestCategoryId": [
128 0
129 ],
130 "requestCategoryDisplayId": [
131 "string"
132 ],
133 "description": "string",
134 "internalTeamUser": [
135 0
136 ],
137 "members": 0,
138 "mainAssets": [
139 0
140 ],
141 "premiseNames": [
142 "string"
143 ],
144 "internalTeamAvailable": true,
145 "premiseIds": [
146 0
147 ]
148 }
149 ],
150 "internalTeams": [
151 "string"
152 ],
153 "assignedUserIds": [
154 0
155 ],
156 "assignedUserDtos": [
157 {
158 "id": 0,
159 "createdBy": "string",
160 "createdAt": "2019-08-24T14:15:22Z",
161 "userName": "string",
162 "firstName": "string",
163 "lastName": "string",
164 "email": "string",
165 "roleIds": [
166 {
167 "id": 0,
168 "createdBy": "string",
169 "createdAt": "2019-08-24T14:15:22Z",
170 "modifiedBy": "string",
171 "modifiedAt": "2019-08-24T14:15:22Z",
172 "roleName": "string",
173 "entity": "string",
174 "new": true
175 }
176 ],
177 "internalTeamNames": [
178 "string"
179 ],
180 "internalTeamIds": [
181 0
182 ],
183 "internalTeamDisplayIds": [
184 "string"
185 ],
186 "premiseIds": [
187 0
188 ],
189 "premiseNames": [
190 "string"
191 ],
192 "userAvailable": true,
193 "temporaryWorkload": 0,
194 "preferredCultureCode": "string"
195 }
196 ],
197 "assignedUsers": [
198 "string"
199 ],
200 "assetPriority": "string",
201 "assetPriorityId": 0,
202 "assetPriorityDisplayId": "string",
203 "assetPriorityType": "string",
204 "assetAvailable": true,
205 "exactPlacement": "string",
206 "fosId": 0,
207 "downtimeStatus": "string",
208 "premiseFromNrm": true,
209 "modifiedAt": "2019-08-24T14:15:22Z"
210 },
211 "mainAssetDisplayId": "string",
212 "assignedUserIds": [
213 0
214 ],
215 "assignedUserDtos": [
216 {
217 "id": 0,
218 "createdBy": "string",
219 "createdAt": "2019-08-24T14:15:22Z",
220 "userName": "string",
221 "firstName": "string",
222 "lastName": "string",
223 "email": "string",
224 "roleIds": [
225 {
226 "id": 0,
227 "createdBy": "string",
228 "createdAt": "2019-08-24T14:15:22Z",
229 "modifiedBy": "string",
230 "modifiedAt": "2019-08-24T14:15:22Z",
231 "roleName": "string",
232 "entity": "string",
233 "new": true
234 }
235 ],
236 "internalTeamNames": [
237 "string"
238 ],
239 "internalTeamIds": [
240 0
241 ],
242 "internalTeamDisplayIds": [
243 "string"
244 ],
245 "premiseIds": [
246 0
247 ],
248 "premiseNames": [
249 "string"
250 ],
251 "userAvailable": true,
252 "temporaryWorkload": 0,
253 "preferredCultureCode": "string"
254 }
255 ],
256 "assignedUsers": [
257 "string"
258 ],
259 "internalTeamIds": [
260 0
261 ],
262 "internalTeamDtos": [
263 {
264 "id": 0,
265 "createdBy": "string",
266 "createdAt": "2019-08-24T14:15:22Z",
267 "displayId": "string",
268 "name": "string",
269 "email": "string",
270 "phone": "string",
271 "manager": "string",
272 "requestCategoryName": [
273 "string"
274 ],
275 "requestCategoryId": [
276 0
277 ],
278 "requestCategoryDisplayId": [
279 "string"
280 ],
281 "description": "string",
282 "internalTeamUser": [
283 0
284 ],
285 "members": 0,
286 "mainAssets": [
287 0
288 ],
289 "premiseNames": [
290 "string"
291 ],
292 "internalTeamAvailable": true,
293 "premiseIds": [
294 0
295 ]
296 }
297 ],
298 "internalTeams": [
299 "string"
300 ],
301 "requestAvailable": true,
302 "exactPlacement": "string",
303 "requestType": "string",
304 "closeDate": "2019-08-24",
305 "requestFrom": "NFM"
306}
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 "description": "string",
7 "imageId": 0,
8 "premiseId": 0,
9 "premiseDto": {
10 "id": 0,
11 "createdBy": "string",
12 "createdAt": "2019-08-24T14:15:22Z",
13 "displayId": "string",
14 "premiseName": "string",
15 "description": "string",
16 "address": "string",
17 "internalTeamNames": [
18 "string"
19 ],
20 "internalTeamIds": [
21 0
22 ],
23 "premiseAvailable": true,
24 "premiseFromNrm": true,
25 "nlmId": 0,
26 "nlmDisplayId": "string",
27 "nlmUsed": true,
28 "manager": 0,
29 "managerName": "string",
30 "imageId": 0,
31 "area": "string",
32 "modifiedAt": "2019-08-24T14:15:22Z"
33 },
34 "premiseFromNrm": true,
35 "premiseDisplayId": "string",
36 "name": "string",
37 "requestPriority": "string",
38 "requestPriorityType": "string",
39 "requestPriorityId": 0,
40 "requestPriorityDisplayId": "string",
41 "requestDate": "2019-08-24",
42 "modifiedAt": "2019-08-24T14:15:22Z",
43 "requestCategory": "string",
44 "requestCategoryId": 0,
45 "requestCategoryDisplayId": "string",
46 "requestStatus": "string",
47 "requestStatusType": "string",
48 "requestStatusId": 0,
49 "requestStatusDisplayId": "string",
50 "mainAssetIds": [
51 0
52 ],
53 "mainAssetId": 0,
54 "mainAssetDto": {
55 "id": 0,
56 "createdBy": "string",
57 "createdAt": "2019-08-24T14:15:22Z",
58 "displayId": "string",
59 "name": "string",
60 "description": "string",
61 "qrCode": "string",
62 "barCode": "string",
63 "imageId": 0,
64 "model": "string",
65 "manufacturer": "string",
66 "serialNumber": "string",
67 "cost": "81.08",
68 "premiseId": 0,
69 "premiseDisplayId": "string",
70 "premiseDto": {
71 "id": 0,
72 "createdBy": "string",
73 "createdAt": "2019-08-24T14:15:22Z",
74 "displayId": "string",
75 "premiseName": "string",
76 "description": "string",
77 "address": "string",
78 "internalTeamNames": [
79 "string"
80 ],
81 "internalTeamIds": [
82 0
83 ],
84 "premiseAvailable": true,
85 "premiseFromNrm": true,
86 "nlmId": 0,
87 "nlmDisplayId": "string",
88 "nlmUsed": true,
89 "manager": 0,
90 "managerName": "string",
91 "imageId": 0,
92 "area": "string",
93 "modifiedAt": "2019-08-24T14:15:22Z"
94 },
95 "acquisitionDate": "2019-08-24",
96 "endOfLife": "2019-08-24",
97 "assetStatusId": 0,
98 "assetStatus": "string",
99 "assetStatusType": "string",
100 "parentAssetId": 0,
101 "parentAssetDisplayId": "string",
102 "parentAsset": "string",
103 "parentAssetDto": {},
104 "upcomingMaintenanceDate": "2019-08-24",
105 "assetCategoryIds": [
106 0
107 ],
108 "assetCategories": [
109 "string"
110 ],
111 "internalTeamIds": [
112 0
113 ],
114 "internalTeamDtos": [
115 {
116 "id": 0,
117 "createdBy": "string",
118 "createdAt": "2019-08-24T14:15:22Z",
119 "displayId": "string",
120 "name": "string",
121 "email": "string",
122 "phone": "string",
123 "manager": "string",
124 "requestCategoryName": [
125 "string"
126 ],
127 "requestCategoryId": [
128 0
129 ],
130 "requestCategoryDisplayId": [
131 "string"
132 ],
133 "description": "string",
134 "internalTeamUser": [
135 0
136 ],
137 "members": 0,
138 "mainAssets": [
139 0
140 ],
141 "premiseNames": [
142 "string"
143 ],
144 "internalTeamAvailable": true,
145 "premiseIds": [
146 0
147 ]
148 }
149 ],
150 "internalTeams": [
151 "string"
152 ],
153 "assignedUserIds": [
154 0
155 ],
156 "assignedUserDtos": [
157 {
158 "id": 0,
159 "createdBy": "string",
160 "createdAt": "2019-08-24T14:15:22Z",
161 "userName": "string",
162 "firstName": "string",
163 "lastName": "string",
164 "email": "string",
165 "roleIds": [
166 {
167 "id": 0,
168 "createdBy": "string",
169 "createdAt": "2019-08-24T14:15:22Z",
170 "modifiedBy": "string",
171 "modifiedAt": "2019-08-24T14:15:22Z",
172 "roleName": "string",
173 "entity": "string",
174 "new": true
175 }
176 ],
177 "internalTeamNames": [
178 "string"
179 ],
180 "internalTeamIds": [
181 0
182 ],
183 "internalTeamDisplayIds": [
184 "string"
185 ],
186 "premiseIds": [
187 0
188 ],
189 "premiseNames": [
190 "string"
191 ],
192 "userAvailable": true,
193 "temporaryWorkload": 0,
194 "preferredCultureCode": "string"
195 }
196 ],
197 "assignedUsers": [
198 "string"
199 ],
200 "assetPriority": "string",
201 "assetPriorityId": 0,
202 "assetPriorityDisplayId": "string",
203 "assetPriorityType": "string",
204 "assetAvailable": true,
205 "exactPlacement": "string",
206 "fosId": 0,
207 "downtimeStatus": "string",
208 "premiseFromNrm": true,
209 "modifiedAt": "2019-08-24T14:15:22Z"
210 },
211 "mainAssetDisplayId": "string",
212 "assignedUserIds": [
213 0
214 ],
215 "assignedUserDtos": [
216 {
217 "id": 0,
218 "createdBy": "string",
219 "createdAt": "2019-08-24T14:15:22Z",
220 "userName": "string",
221 "firstName": "string",
222 "lastName": "string",
223 "email": "string",
224 "roleIds": [
225 {
226 "id": 0,
227 "createdBy": "string",
228 "createdAt": "2019-08-24T14:15:22Z",
229 "modifiedBy": "string",
230 "modifiedAt": "2019-08-24T14:15:22Z",
231 "roleName": "string",
232 "entity": "string",
233 "new": true
234 }
235 ],
236 "internalTeamNames": [
237 "string"
238 ],
239 "internalTeamIds": [
240 0
241 ],
242 "internalTeamDisplayIds": [
243 "string"
244 ],
245 "premiseIds": [
246 0
247 ],
248 "premiseNames": [
249 "string"
250 ],
251 "userAvailable": true,
252 "temporaryWorkload": 0,
253 "preferredCultureCode": "string"
254 }
255 ],
256 "assignedUsers": [
257 "string"
258 ],
259 "internalTeamIds": [
260 0
261 ],
262 "internalTeamDtos": [
263 {
264 "id": 0,
265 "createdBy": "string",
266 "createdAt": "2019-08-24T14:15:22Z",
267 "displayId": "string",
268 "name": "string",
269 "email": "string",
270 "phone": "string",
271 "manager": "string",
272 "requestCategoryName": [
273 "string"
274 ],
275 "requestCategoryId": [
276 0
277 ],
278 "requestCategoryDisplayId": [
279 "string"
280 ],
281 "description": "string",
282 "internalTeamUser": [
283 0
284 ],
285 "members": 0,
286 "mainAssets": [
287 0
288 ],
289 "premiseNames": [
290 "string"
291 ],
292 "internalTeamAvailable": true,
293 "premiseIds": [
294 0
295 ]
296 }
297 ],
298 "internalTeams": [
299 "string"
300 ],
301 "requestAvailable": true,
302 "exactPlacement": "string",
303 "requestType": "string",
304 "closeDate": "2019-08-24",
305 "requestFrom": "NFM"
306}
Get Work Orders By ID¶
HTTP Request
GET /api/requests/{id}/workOrders/{workOrderId}
📋 Description: Fetches detailed information about a specific work order associated with a given request, enabling users to review and manage work order details efficiently.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
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 {
206 "id": 0,
207 "createdBy": "string",
208 "createdAt": "2019-08-24T14:15:22Z",
209 "modifiedBy": "string",
210 "modifiedAt": "2019-08-24T14:15:22Z",
211 "roleName": "string",
212 "entity": "string",
213 "new": true
214 }
215 ],
216 "internalTeamNames": [
217 "string"
218 ],
219 "internalTeamIds": [
220 0
221 ],
222 "internalTeamDisplayIds": [
223 "string"
224 ],
225 "premiseIds": [
226 0
227 ],
228 "premiseNames": [
229 "string"
230 ],
231 "userAvailable": true,
232 "temporaryWorkload": 0,
233 "preferredCultureCode": "string"
234 }
235 ],
236 "assignedUsers": [
237 "string"
238 ],
239 "assetPriority": "string",
240 "assetPriorityId": 0,
241 "assetPriorityDisplayId": "string",
242 "assetPriorityType": "string",
243 "assetAvailable": true,
244 "exactPlacement": "string",
245 "fosId": 0,
246 "downtimeStatus": "string",
247 "premiseFromNrm": true,
248 "modifiedAt": "2019-08-24T14:15:22Z"
249 },
250 "mainAssetDisplayId": "string",
251 "workOrderStatusId": 0,
252 "workOrderStatus": "string",
253 "workOrderStatusType": "string",
254 "requestIds": [
255 0
256 ],
257 "internalTeamIds": [
258 0
259 ],
260 "internalTeamDtos": [
261 {
262 "id": 0,
263 "createdBy": "string",
264 "createdAt": "2019-08-24T14:15:22Z",
265 "displayId": "string",
266 "name": "string",
267 "email": "string",
268 "phone": "string",
269 "manager": "string",
270 "requestCategoryName": [
271 "string"
272 ],
273 "requestCategoryId": [
274 0
275 ],
276 "requestCategoryDisplayId": [
277 "string"
278 ],
279 "description": "string",
280 "internalTeamUser": [
281 0
282 ],
283 "members": 0,
284 "mainAssets": [
285 0
286 ],
287 "premiseNames": [
288 "string"
289 ],
290 "internalTeamAvailable": true,
291 "premiseIds": [
292 0
293 ]
294 }
295 ],
296 "internalTeams": [
297 "string"
298 ],
299 "vendorId": 0,
300 "vendorDto": {
301 "id": 0,
302 "createdBy": "string",
303 "createdAt": "2019-08-24T14:15:22Z",
304 "displayId": "string",
305 "name": "string",
306 "description": "string",
307 "address": "string",
308 "contractEndDate": "2019-08-24",
309 "services": "string",
310 "vendorType": "string",
311 "vendorStatusId": 0,
312 "vendorStatus": "string",
313 "vendorStatusType": "string",
314 "businessTypeId": 0,
315 "businessType": "string",
316 "vendorRateId": 0,
317 "vendorRate": "string",
318 "vendorContactIds": [
319 0
320 ],
321 "premiseIds": [
322 0
323 ],
324 "firstPremiseDisplayId": "string",
325 "ownerUserName": "string",
326 "ownerDto": {
327 "id": 0,
328 "createdBy": "string",
329 "createdAt": "2019-08-24T14:15:22Z",
330 "userName": "string",
331 "firstName": "string",
332 "lastName": "string",
333 "email": "string",
334 "roleIds": [
335 {
336 "id": 0,
337 "createdBy": "string",
338 "createdAt": "2019-08-24T14:15:22Z",
339 "modifiedBy": "string",
340 "modifiedAt": "2019-08-24T14:15:22Z",
341 "roleName": "string",
342 "entity": "string",
343 "new": true
344 }
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 {
407 "id": 0,
408 "createdBy": "string",
409 "createdAt": "2019-08-24T14:15:22Z",
410 "modifiedBy": "string",
411 "modifiedAt": "2019-08-24T14:15:22Z",
412 "roleName": "string",
413 "entity": "string",
414 "new": true
415 }
416 ],
417 "internalTeamNames": [
418 "string"
419 ],
420 "internalTeamIds": [
421 0
422 ],
423 "internalTeamDisplayIds": [
424 "string"
425 ],
426 "premiseIds": [
427 0
428 ],
429 "premiseNames": [
430 "string"
431 ],
432 "userAvailable": true,
433 "temporaryWorkload": 0,
434 "preferredCultureCode": "string"
435 }
436 ],
437 "assignedUsers": [
438 "string"
439 ],
440 "variableQuantity": 0,
441 "workOrderAvailable": true,
442 "exactPlacement": "string",
443 "primaryWorkOrderId": 0,
444 "primaryWorkOrderDto": {
445 "id": 0,
446 "createdBy": "string",
447 "createdAt": "2019-08-24T14:15:22Z",
448 "displayId": "string",
449 "name": "string",
450 "imageId": 0,
451 "description": "string",
452 "vendorRating": 0,
453 "premiseId": 0,
454 "premiseDto": {
455 "id": 0,
456 "createdBy": "string",
457 "createdAt": "2019-08-24T14:15:22Z",
458 "displayId": "string",
459 "premiseName": "string",
460 "description": "string",
461 "address": "string",
462 "internalTeamNames": [
463 "string"
464 ],
465 "internalTeamIds": [
466 0
467 ],
468 "premiseAvailable": true,
469 "premiseFromNrm": true,
470 "nlmId": 0,
471 "nlmDisplayId": "string",
472 "nlmUsed": true,
473 "manager": 0,
474 "managerName": "string",
475 "imageId": 0,
476 "area": "string",
477 "modifiedAt": "2019-08-24T14:15:22Z"
478 },
479 "premiseFromNrm": true,
480 "premiseDisplayId": "string",
481 "nssProjectId": 0,
482 "nssTaskId": 0,
483 "nssTaskDisplayId": "string",
484 "orderDate": "2019-08-24",
485 "dueDate": "2019-08-24",
486 "startDate": "2019-08-24",
487 "endDate": "2019-08-24",
488 "startTime": {
489 "hour": 0,
490 "minute": 0,
491 "second": 0,
492 "nano": 0
493 },
494 "endTime": {
495 "hour": 0,
496 "minute": 0,
497 "second": 0,
498 "nano": 0
499 },
500 "modifiedAt": "2019-08-24T14:15:22Z",
501 "estimatedCost": "81.08",
502 "finalCost": "81.08",
503 "duration": 0,
504 "estimatedDayTime": 0,
505 "finalHourTime": "2.5",
506 "estimatedHourTime": "2.5",
507 "closeDate": "2019-08-24",
508 "inspection": "string",
509 "workOrderTypeId": 0,
510 "workOrderTypeName": "string",
511 "workOrderType": "string",
512 "workOrderPriorityId": 0,
513 "workOrderPriority": "string",
514 "workOrderPriorityType": "string",
515 "isTemplate": true,
516 "isWorkOrderTemplate": true,
517 "templateId": 0,
518 "isPartsInSufficient": true,
519 "partQuantityInfoList": [
520 {
521 "partId": 0,
522 "partDisplayId": "string",
523 "requestedQuantity": 0,
524 "availableQuantity": 0,
525 "usedQuantity": 0,
526 "sufficient": true,
527 "partial": true
528 }
529 ],
530 "parentWorkOrderId": 0,
531 "parentWorkOrderDisplayId": "string",
532 "parentWorkOrder": "string",
533 "mainAssetIds": [
534 0
535 ],
536 "mainAssetDto": {
537 "id": 0,
538 "createdBy": "string",
539 "createdAt": "2019-08-24T14:15:22Z",
540 "displayId": "string",
541 "name": "string",
542 "description": "string",
543 "qrCode": "string",
544 "barCode": "string",
545 "imageId": 0,
546 "model": "string",
547 "manufacturer": "string",
548 "serialNumber": "string",
549 "cost": "81.08",
550 "premiseId": 0,
551 "premiseDisplayId": "string",
552 "premiseDto": {
553 "id": 0,
554 "createdBy": "string",
555 "createdAt": "2019-08-24T14:15:22Z",
556 "displayId": "string",
557 "premiseName": "string",
558 "description": "string",
559 "address": "string",
560 "internalTeamNames": [
561 "string"
562 ],
563 "internalTeamIds": [
564 0
565 ],
566 "premiseAvailable": true,
567 "premiseFromNrm": true,
568 "nlmId": 0,
569 "nlmDisplayId": "string",
570 "nlmUsed": true,
571 "manager": 0,
572 "managerName": "string",
573 "imageId": 0,
574 "area": "string",
575 "modifiedAt": "2019-08-24T14:15:22Z"
576 },
577 "acquisitionDate": "2019-08-24",
578 "endOfLife": "2019-08-24",
579 "assetStatusId": 0,
580 "assetStatus": "string",
581 "assetStatusType": "string",
582 "parentAssetId": 0,
583 "parentAssetDisplayId": "string",
584 "parentAsset": "string",
585 "parentAssetDto": {},
586 "upcomingMaintenanceDate": "2019-08-24",
587 "assetCategoryIds": [
588 0
589 ],
590 "assetCategories": [
591 "string"
592 ],
593 "internalTeamIds": [
594 0
595 ],
596 "internalTeamDtos": [
597 {
598 "id": 0,
599 "createdBy": "string",
600 "createdAt": "2019-08-24T14:15:22Z",
601 "displayId": "string",
602 "name": "string",
603 "email": "string",
604 "phone": "string",
605 "manager": "string",
606 "requestCategoryName": [
607 "string"
608 ],
609 "requestCategoryId": [
610 0
611 ],
612 "requestCategoryDisplayId": [
613 "string"
614 ],
615 "description": "string",
616 "internalTeamUser": [
617 0
618 ],
619 "members": 0,
620 "mainAssets": [
621 0
622 ],
623 "premiseNames": [
624 "string"
625 ],
626 "internalTeamAvailable": true,
627 "premiseIds": [
628 0
629 ]
630 }
631 ],
632 "internalTeams": [
633 "string"
634 ],
635 "assignedUserIds": [
636 0
637 ],
638 "assignedUserDtos": [
639 {
640 "id": 0,
641 "createdBy": "string",
642 "createdAt": "2019-08-24T14:15:22Z",
643 "userName": "string",
644 "firstName": "string",
645 "lastName": "string",
646 "email": "string",
647 "roleIds": [
648 {
649 "id": 0,
650 "createdBy": "string",
651 "createdAt": "2019-08-24T14:15:22Z",
652 "modifiedBy": "string",
653 "modifiedAt": "2019-08-24T14:15:22Z",
654 "roleName": "string",
655 "entity": "string",
656 "new": true
657 }
658 ],
659 "internalTeamNames": [
660 "string"
661 ],
662 "internalTeamIds": [
663 0
664 ],
665 "internalTeamDisplayIds": [
666 "string"
667 ],
668 "premiseIds": [
669 0
670 ],
671 "premiseNames": [
672 "string"
673 ],
674 "userAvailable": true,
675 "temporaryWorkload": 0,
676 "preferredCultureCode": "string"
677 }
678 ],
679 "assignedUsers": [
680 "string"
681 ],
682 "assetPriority": "string",
683 "assetPriorityId": 0,
684 "assetPriorityDisplayId": "string",
685 "assetPriorityType": "string",
686 "assetAvailable": true,
687 "exactPlacement": "string",
688 "fosId": 0,
689 "downtimeStatus": "string",
690 "premiseFromNrm": true,
691 "modifiedAt": "2019-08-24T14:15:22Z"
692 },
693 "mainAssetDisplayId": "string",
694 "workOrderStatusId": 0,
695 "workOrderStatus": "string",
696 "workOrderStatusType": "string",
697 "requestIds": [
698 0
699 ],
700 "internalTeamIds": [
701 0
702 ],
703 "internalTeamDtos": [
704 {
705 "id": 0,
706 "createdBy": "string",
707 "createdAt": "2019-08-24T14:15:22Z",
708 "displayId": "string",
709 "name": "string",
710 "email": "string",
711 "phone": "string",
712 "manager": "string",
713 "requestCategoryName": [
714 "string"
715 ],
716 "requestCategoryId": [
717 0
718 ],
719 "requestCategoryDisplayId": [
720 "string"
721 ],
722 "description": "string",
723 "internalTeamUser": [
724 0
725 ],
726 "members": 0,
727 "mainAssets": [
728 0
729 ],
730 "premiseNames": [
731 "string"
732 ],
733 "internalTeamAvailable": true,
734 "premiseIds": [
735 0
736 ]
737 }
738 ],
739 "internalTeams": [
740 "string"
741 ],
742 "vendorId": 0,
743 "vendorDto": {
744 "id": 0,
745 "createdBy": "string",
746 "createdAt": "2019-08-24T14:15:22Z",
747 "displayId": "string",
748 "name": "string",
749 "description": "string",
750 "address": "string",
751 "contractEndDate": "2019-08-24",
752 "services": "string",
753 "vendorType": "string",
754 "vendorStatusId": 0,
755 "vendorStatus": "string",
756 "vendorStatusType": "string",
757 "businessTypeId": 0,
758 "businessType": "string",
759 "vendorRateId": 0,
760 "vendorRate": "string",
761 "vendorContactIds": [
762 0
763 ],
764 "premiseIds": [
765 0
766 ],
767 "firstPremiseDisplayId": "string",
768 "ownerUserName": "string",
769 "ownerDto": {
770 "id": 0,
771 "createdBy": "string",
772 "createdAt": "2019-08-24T14:15:22Z",
773 "userName": "string",
774 "firstName": "string",
775 "lastName": "string",
776 "email": "string",
777 "roleIds": [
778 {
779 "id": 0,
780 "createdBy": "string",
781 "createdAt": "2019-08-24T14:15:22Z",
782 "modifiedBy": "string",
783 "modifiedAt": "2019-08-24T14:15:22Z",
784 "roleName": "string",
785 "entity": "string",
786 "new": true
787 }
788 ],
789 "internalTeamNames": [
790 "string"
791 ],
792 "internalTeamIds": [
793 0
794 ],
795 "internalTeamDisplayIds": [
796 "string"
797 ],
798 "premiseIds": [
799 0
800 ],
801 "premiseNames": [
802 "string"
803 ],
804 "userAvailable": true,
805 "temporaryWorkload": 0,
806 "preferredCultureCode": "string"
807 },
808 "vendorAvailable": true,
809 "vendorRating": 0.1,
810 "premiseDisplayIds": [
811 "string"
812 ]
813 },
814 "vendorName": "string",
815 "workOrderTemplateSettings": {
816 "id": 0,
817 "createdBy": "string",
818 "createdAt": "2019-08-24T14:15:22Z",
819 "workOrderId": 0,
820 "startDate": "2019-08-24",
821 "dueDuration": 0,
822 "dueMonths": 0,
823 "endDate": "2019-08-24",
824 "recurringWOPriorityId": 0,
825 "recurringWOPriority": "string",
826 "recurringWOPriorityType": "string",
827 "isTemplate": true,
828 "isRemoveByDate": true,
829 "triggerByWorkOrderStatusId": 0,
830 "triggerByWorkOrderStatus": "string",
831 "triggerByWorkOrderStatusType": "string",
832 "removeByWorkOrderStatusId": 0,
833 "removeByWorkOrderStatus": "string",
834 "removeByWorkOrderStatusType": "string"
835 },
836 "assignedUserIds": [
837 0
838 ],
839 "assignedUserDtos": [
840 {
841 "id": 0,
842 "createdBy": "string",
843 "createdAt": "2019-08-24T14:15:22Z",
844 "userName": "string",
845 "firstName": "string",
846 "lastName": "string",
847 "email": "string",
848 "roleIds": [
849 {
850 "id": 0,
851 "createdBy": "string",
852 "createdAt": "2019-08-24T14:15:22Z",
853 "modifiedBy": "string",
854 "modifiedAt": "2019-08-24T14:15:22Z",
855 "roleName": "string",
856 "entity": "string",
857 "new": true
858 }
859 ],
860 "internalTeamNames": [
861 "string"
862 ],
863 "internalTeamIds": [
864 0
865 ],
866 "internalTeamDisplayIds": [
867 "string"
868 ],
869 "premiseIds": [
870 0
871 ],
872 "premiseNames": [
873 "string"
874 ],
875 "userAvailable": true,
876 "temporaryWorkload": 0,
877 "preferredCultureCode": "string"
878 }
879 ],
880 "assignedUsers": [
881 "string"
882 ],
883 "variableQuantity": 0,
884 "workOrderAvailable": true,
885 "exactPlacement": "string",
886 "primaryWorkOrderId": 0,
887 "primaryWorkOrderDto": {},
888 "primaryWorkOrderDisplayId": "string",
889 "isPrimary": true,
890 "invoiceIds": [
891 0
892 ],
893 "createdByTrigger": true,
894 "internalCosts": "81.08",
895 "invoiceTotal": "81.08",
896 "partsTotal": "81.08",
897 "inspectionItemId": 0,
898 "partIdToAttach": 0
899 },
900 "primaryWorkOrderDisplayId": "string",
901 "isPrimary": true,
902 "invoiceIds": [
903 0
904 ],
905 "createdByTrigger": true,
906 "internalCosts": "81.08",
907 "invoiceTotal": "81.08",
908 "partsTotal": "81.08",
909 "inspectionItemId": 0,
910 "partIdToAttach": 0
911}
Assign Work Orders To Request¶
HTTP Request
POST /api/requests/{id}/workOrders/{workOrderId}
📋 Description: Creates a new work order associated with a specific request, enabling efficient management and tracking of tasks within the workflow.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
workOrderId |
path |
integer(int64) |
true |
Unique identifier for the work order |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Detach Work Order From Request¶
HTTP Request
DELETE /api/requests/{id}/workOrders/{workOrderId}
📋 Description: Deletes a specific work order associated with a request, streamlining request management and ensuring accurate tracking of work order statuses.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
workOrderId |
path |
integer(int64) |
true |
Unique identifier for the work order |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Attach Request To Premises¶
HTTP Request
POST /api/requests/{id}/requests/{requestId}
📋 Description: Creates a new request associated with a specified request ID, enabling efficient management and tracking of business operations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
requestId |
path |
integer(int64) |
true |
Unique identifier for the request |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get Main Assets By ID¶
HTTP Request
GET /api/requests/{id}/mainAssets/{mainAssetId}
📋 Description: Retrieves detailed information about a specific main asset associated with a request, identified by its unique ID, to facilitate effective asset management and decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
mainAssetId |
path |
integer(int64) |
true |
Unique identifier for the main asset |
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 "description": "string",
8 "qrCode": "string",
9 "barCode": "string",
10 "imageId": 0,
11 "model": "string",
12 "manufacturer": "string",
13 "serialNumber": "string",
14 "cost": "81.08",
15 "premiseId": 0,
16 "premiseDisplayId": "string",
17 "premiseDto": {
18 "id": 0,
19 "createdBy": "string",
20 "createdAt": "2019-08-24T14:15:22Z",
21 "displayId": "string",
22 "premiseName": "string",
23 "description": "string",
24 "address": "string",
25 "internalTeamNames": [
26 "string"
27 ],
28 "internalTeamIds": [
29 0
30 ],
31 "premiseAvailable": true,
32 "premiseFromNrm": true,
33 "nlmId": 0,
34 "nlmDisplayId": "string",
35 "nlmUsed": true,
36 "manager": 0,
37 "managerName": "string",
38 "imageId": 0,
39 "area": "string",
40 "modifiedAt": "2019-08-24T14:15:22Z"
41 },
42 "acquisitionDate": "2019-08-24",
43 "endOfLife": "2019-08-24",
44 "assetStatusId": 0,
45 "assetStatus": "string",
46 "assetStatusType": "string",
47 "parentAssetId": 0,
48 "parentAssetDisplayId": "string",
49 "parentAsset": "string",
50 "parentAssetDto": {
51 "id": 0,
52 "createdBy": "string",
53 "createdAt": "2019-08-24T14:15:22Z",
54 "displayId": "string",
55 "name": "string",
56 "description": "string",
57 "qrCode": "string",
58 "barCode": "string",
59 "imageId": 0,
60 "model": "string",
61 "manufacturer": "string",
62 "serialNumber": "string",
63 "cost": "81.08",
64 "premiseId": 0,
65 "premiseDisplayId": "string",
66 "premiseDto": {
67 "id": 0,
68 "createdBy": "string",
69 "createdAt": "2019-08-24T14:15:22Z",
70 "displayId": "string",
71 "premiseName": "string",
72 "description": "string",
73 "address": "string",
74 "internalTeamNames": [
75 "string"
76 ],
77 "internalTeamIds": [
78 0
79 ],
80 "premiseAvailable": true,
81 "premiseFromNrm": true,
82 "nlmId": 0,
83 "nlmDisplayId": "string",
84 "nlmUsed": true,
85 "manager": 0,
86 "managerName": "string",
87 "imageId": 0,
88 "area": "string",
89 "modifiedAt": "2019-08-24T14:15:22Z"
90 },
91 "acquisitionDate": "2019-08-24",
92 "endOfLife": "2019-08-24",
93 "assetStatusId": 0,
94 "assetStatus": "string",
95 "assetStatusType": "string",
96 "parentAssetId": 0,
97 "parentAssetDisplayId": "string",
98 "parentAsset": "string",
99 "parentAssetDto": {},
100 "upcomingMaintenanceDate": "2019-08-24",
101 "assetCategoryIds": [
102 0
103 ],
104 "assetCategories": [
105 "string"
106 ],
107 "internalTeamIds": [
108 0
109 ],
110 "internalTeamDtos": [
111 {
112 "id": 0,
113 "createdBy": "string",
114 "createdAt": "2019-08-24T14:15:22Z",
115 "displayId": "string",
116 "name": "string",
117 "email": "string",
118 "phone": "string",
119 "manager": "string",
120 "requestCategoryName": [
121 "string"
122 ],
123 "requestCategoryId": [
124 0
125 ],
126 "requestCategoryDisplayId": [
127 "string"
128 ],
129 "description": "string",
130 "internalTeamUser": [
131 0
132 ],
133 "members": 0,
134 "mainAssets": [
135 0
136 ],
137 "premiseNames": [
138 "string"
139 ],
140 "internalTeamAvailable": true,
141 "premiseIds": [
142 0
143 ]
144 }
145 ],
146 "internalTeams": [
147 "string"
148 ],
149 "assignedUserIds": [
150 0
151 ],
152 "assignedUserDtos": [
153 {
154 "id": 0,
155 "createdBy": "string",
156 "createdAt": "2019-08-24T14:15:22Z",
157 "userName": "string",
158 "firstName": "string",
159 "lastName": "string",
160 "email": "string",
161 "roleIds": [
162 {
163 "id": 0,
164 "createdBy": "string",
165 "createdAt": "2019-08-24T14:15:22Z",
166 "modifiedBy": "string",
167 "modifiedAt": "2019-08-24T14:15:22Z",
168 "roleName": "string",
169 "entity": "string",
170 "new": true
171 }
172 ],
173 "internalTeamNames": [
174 "string"
175 ],
176 "internalTeamIds": [
177 0
178 ],
179 "internalTeamDisplayIds": [
180 "string"
181 ],
182 "premiseIds": [
183 0
184 ],
185 "premiseNames": [
186 "string"
187 ],
188 "userAvailable": true,
189 "temporaryWorkload": 0,
190 "preferredCultureCode": "string"
191 }
192 ],
193 "assignedUsers": [
194 "string"
195 ],
196 "assetPriority": "string",
197 "assetPriorityId": 0,
198 "assetPriorityDisplayId": "string",
199 "assetPriorityType": "string",
200 "assetAvailable": true,
201 "exactPlacement": "string",
202 "fosId": 0,
203 "downtimeStatus": "string",
204 "premiseFromNrm": true,
205 "modifiedAt": "2019-08-24T14:15:22Z"
206 },
207 "upcomingMaintenanceDate": "2019-08-24",
208 "assetCategoryIds": [
209 0
210 ],
211 "assetCategories": [
212 "string"
213 ],
214 "internalTeamIds": [
215 0
216 ],
217 "internalTeamDtos": [
218 {
219 "id": 0,
220 "createdBy": "string",
221 "createdAt": "2019-08-24T14:15:22Z",
222 "displayId": "string",
223 "name": "string",
224 "email": "string",
225 "phone": "string",
226 "manager": "string",
227 "requestCategoryName": [
228 "string"
229 ],
230 "requestCategoryId": [
231 0
232 ],
233 "requestCategoryDisplayId": [
234 "string"
235 ],
236 "description": "string",
237 "internalTeamUser": [
238 0
239 ],
240 "members": 0,
241 "mainAssets": [
242 0
243 ],
244 "premiseNames": [
245 "string"
246 ],
247 "internalTeamAvailable": true,
248 "premiseIds": [
249 0
250 ]
251 }
252 ],
253 "internalTeams": [
254 "string"
255 ],
256 "assignedUserIds": [
257 0
258 ],
259 "assignedUserDtos": [
260 {
261 "id": 0,
262 "createdBy": "string",
263 "createdAt": "2019-08-24T14:15:22Z",
264 "userName": "string",
265 "firstName": "string",
266 "lastName": "string",
267 "email": "string",
268 "roleIds": [
269 {
270 "id": 0,
271 "createdBy": "string",
272 "createdAt": "2019-08-24T14:15:22Z",
273 "modifiedBy": "string",
274 "modifiedAt": "2019-08-24T14:15:22Z",
275 "roleName": "string",
276 "entity": "string",
277 "new": true
278 }
279 ],
280 "internalTeamNames": [
281 "string"
282 ],
283 "internalTeamIds": [
284 0
285 ],
286 "internalTeamDisplayIds": [
287 "string"
288 ],
289 "premiseIds": [
290 0
291 ],
292 "premiseNames": [
293 "string"
294 ],
295 "userAvailable": true,
296 "temporaryWorkload": 0,
297 "preferredCultureCode": "string"
298 }
299 ],
300 "assignedUsers": [
301 "string"
302 ],
303 "assetPriority": "string",
304 "assetPriorityId": 0,
305 "assetPriorityDisplayId": "string",
306 "assetPriorityType": "string",
307 "assetAvailable": true,
308 "exactPlacement": "string",
309 "fosId": 0,
310 "downtimeStatus": "string",
311 "premiseFromNrm": true,
312 "modifiedAt": "2019-08-24T14:15:22Z"
313}
Assign Main Asset To Request¶
HTTP Request
POST /api/requests/{id}/mainAssets/{mainAssetId}
📋 Description: Creates a new main asset associated with a specific request, enabling effective management and tracking of key resources within the project.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
mainAssetId |
path |
integer(int64) |
true |
Unique identifier for the main asset |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Detach Main Asset From Request¶
HTTP Request
DELETE /api/requests/{id}/mainAssets/{mainAssetId}
📋 Description: Deletes a specified main asset associated with a particular request, ensuring the request’s asset list remains accurate and up-to-date.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
mainAssetId |
path |
integer(int64) |
true |
Unique identifier for the main asset |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get Requests¶
HTTP Request
POST /api/requests/search
📋 Description: Submits a search request to retrieve relevant data based on specified criteria, enabling users to efficiently locate and access necessary information within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the search results should be returned in a paginated format, enhancing the efficiency of data retrieval for large datasets. |
|
usePagination |
query |
boolean |
false |
Indicates whether the search results should be returned in a paginated format, allowing for more manageable data retrieval and improved performance. |
body |
body |
true |
Request body containing search criteria and filters to retrieve relevant request data based on specified parameters. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
usePagination |
|
query |
Body Parameters
1{
2 "displayIdLike": "string",
3 "nameLike": "string",
4 "requestAvailable": true,
5 "requestStatusIn": [
6 0
7 ],
8 "requestPriorityIn": [
9 0
10 ],
11 "requestCategoryIn": [
12 0
13 ],
14 "attachToAssetIdIn": [
15 0
16 ],
17 "attachToAssetIdNotIn": [
18 0
19 ],
20 "attachToWorkOrderIdIn": [
21 0
22 ],
23 "attachToWorkOrderIdNotIn": [
24 0
25 ],
26 "premisesIdIn": [
27 0
28 ],
29 "premisesIdNotIn": [
30 0
31 ],
32 "relatedUser": "string"
33}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "paged": true,
6 "unpaged": true,
7 "pageNumber": 0,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "first": true,
18 "last": true,
19 "size": 0,
20 "content": [
21 {
22 "id": 0,
23 "createdBy": "string",
24 "createdAt": "2019-08-24T14:15:22Z",
25 "displayId": "string",
26 "description": "string",
27 "imageId": 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 "name": "string",
57 "requestPriority": "string",
58 "requestPriorityType": "string",
59 "requestPriorityId": 0,
60 "requestPriorityDisplayId": "string",
61 "requestDate": "2019-08-24",
62 "modifiedAt": "2019-08-24T14:15:22Z",
63 "requestCategory": "string",
64 "requestCategoryId": 0,
65 "requestCategoryDisplayId": "string",
66 "requestStatus": "string",
67 "requestStatusType": "string",
68 "requestStatusId": 0,
69 "requestStatusDisplayId": "string",
70 "mainAssetIds": [
71 0
72 ],
73 "mainAssetId": 0,
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 "area": "string",
113 "modifiedAt": "2019-08-24T14:15:22Z"
114 },
115 "acquisitionDate": "2019-08-24",
116 "endOfLife": "2019-08-24",
117 "assetStatusId": 0,
118 "assetStatus": "string",
119 "assetStatusType": "string",
120 "parentAssetId": 0,
121 "parentAssetDisplayId": "string",
122 "parentAsset": "string",
123 "parentAssetDto": {},
124 "upcomingMaintenanceDate": "2019-08-24",
125 "assetCategoryIds": [
126 0
127 ],
128 "assetCategories": [
129 "string"
130 ],
131 "internalTeamIds": [
132 0
133 ],
134 "internalTeamDtos": [
135 {
136 "id": 0,
137 "createdBy": "string",
138 "createdAt": "2019-08-24T14:15:22Z",
139 "displayId": "string",
140 "name": "string",
141 "email": "string",
142 "phone": "string",
143 "manager": "string",
144 "requestCategoryName": [
145 "string"
146 ],
147 "requestCategoryId": [
148 0
149 ],
150 "requestCategoryDisplayId": [
151 "string"
152 ],
153 "description": "string",
154 "internalTeamUser": [
155 0
156 ],
157 "members": 0,
158 "mainAssets": [
159 0
160 ],
161 "premiseNames": [
162 "string"
163 ],
164 "internalTeamAvailable": true,
165 "premiseIds": [
166 0
167 ]
168 }
169 ],
170 "internalTeams": [
171 "string"
172 ],
173 "assignedUserIds": [
174 0
175 ],
176 "assignedUserDtos": [
177 {
178 "id": 0,
179 "createdBy": "string",
180 "createdAt": "2019-08-24T14:15:22Z",
181 "userName": "string",
182 "firstName": "string",
183 "lastName": "string",
184 "email": "string",
185 "roleIds": [
186 {
187 "id": 0,
188 "createdBy": "string",
189 "createdAt": "2019-08-24T14:15:22Z",
190 "modifiedBy": "string",
191 "modifiedAt": "2019-08-24T14:15:22Z",
192 "roleName": "string",
193 "entity": "string",
194 "new": true
195 }
196 ],
197 "internalTeamNames": [
198 "string"
199 ],
200 "internalTeamIds": [
201 0
202 ],
203 "internalTeamDisplayIds": [
204 "string"
205 ],
206 "premiseIds": [
207 0
208 ],
209 "premiseNames": [
210 "string"
211 ],
212 "userAvailable": true,
213 "temporaryWorkload": 0,
214 "preferredCultureCode": "string"
215 }
216 ],
217 "assignedUsers": [
218 "string"
219 ],
220 "assetPriority": "string",
221 "assetPriorityId": 0,
222 "assetPriorityDisplayId": "string",
223 "assetPriorityType": "string",
224 "assetAvailable": true,
225 "exactPlacement": "string",
226 "fosId": 0,
227 "downtimeStatus": "string",
228 "premiseFromNrm": true,
229 "modifiedAt": "2019-08-24T14:15:22Z"
230 },
231 "mainAssetDisplayId": "string",
232 "assignedUserIds": [
233 0
234 ],
235 "assignedUserDtos": [
236 {
237 "id": 0,
238 "createdBy": "string",
239 "createdAt": "2019-08-24T14:15:22Z",
240 "userName": "string",
241 "firstName": "string",
242 "lastName": "string",
243 "email": "string",
244 "roleIds": [
245 {
246 "id": 0,
247 "createdBy": "string",
248 "createdAt": "2019-08-24T14:15:22Z",
249 "modifiedBy": "string",
250 "modifiedAt": "2019-08-24T14:15:22Z",
251 "roleName": "string",
252 "entity": "string",
253 "new": true
254 }
255 ],
256 "internalTeamNames": [
257 "string"
258 ],
259 "internalTeamIds": [
260 0
261 ],
262 "internalTeamDisplayIds": [
263 "string"
264 ],
265 "premiseIds": [
266 0
267 ],
268 "premiseNames": [
269 "string"
270 ],
271 "userAvailable": true,
272 "temporaryWorkload": 0,
273 "preferredCultureCode": "string"
274 }
275 ],
276 "assignedUsers": [
277 "string"
278 ],
279 "internalTeamIds": [
280 0
281 ],
282 "internalTeamDtos": [
283 {
284 "id": 0,
285 "createdBy": "string",
286 "createdAt": "2019-08-24T14:15:22Z",
287 "displayId": "string",
288 "name": "string",
289 "email": "string",
290 "phone": "string",
291 "manager": "string",
292 "requestCategoryName": [
293 "string"
294 ],
295 "requestCategoryId": [
296 0
297 ],
298 "requestCategoryDisplayId": [
299 "string"
300 ],
301 "description": "string",
302 "internalTeamUser": [
303 0
304 ],
305 "members": 0,
306 "mainAssets": [
307 0
308 ],
309 "premiseNames": [
310 "string"
311 ],
312 "internalTeamAvailable": true,
313 "premiseIds": [
314 0
315 ]
316 }
317 ],
318 "internalTeams": [
319 "string"
320 ],
321 "requestAvailable": true,
322 "exactPlacement": "string",
323 "requestType": "string",
324 "closeDate": "2019-08-24",
325 "requestFrom": "NFM"
326 }
327 ],
328 "number": 0,
329 "sort": {
330 "unsorted": true,
331 "sorted": true,
332 "empty": true
333 },
334 "empty": true
335}
Create Request From Portal¶
HTTP Request
POST /api/requests/createRequestFromPortal
📋 Description: Creates a new request from the portal, enabling users to initiate service or support inquiries directly through the application interface.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the details necessary to create a new request from the portal, including relevant user information, request specifications, and any associated metadata. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "description": "string",
7 "imageId": 0,
8 "premiseId": 0,
9 "premiseDto": {
10 "id": 0,
11 "createdBy": "string",
12 "createdAt": "2019-08-24T14:15:22Z",
13 "displayId": "string",
14 "premiseName": "string",
15 "description": "string",
16 "address": "string",
17 "internalTeamNames": [
18 "string"
19 ],
20 "internalTeamIds": [
21 0
22 ],
23 "premiseAvailable": true,
24 "premiseFromNrm": true,
25 "nlmId": 0,
26 "nlmDisplayId": "string",
27 "nlmUsed": true,
28 "manager": 0,
29 "managerName": "string",
30 "imageId": 0,
31 "area": "string",
32 "modifiedAt": "2019-08-24T14:15:22Z"
33 },
34 "premiseFromNrm": true,
35 "premiseDisplayId": "string",
36 "name": "string",
37 "requestPriority": "string",
38 "requestPriorityType": "string",
39 "requestPriorityId": 0,
40 "requestPriorityDisplayId": "string",
41 "requestDate": "2019-08-24",
42 "modifiedAt": "2019-08-24T14:15:22Z",
43 "requestCategory": "string",
44 "requestCategoryId": 0,
45 "requestCategoryDisplayId": "string",
46 "requestStatus": "string",
47 "requestStatusType": "string",
48 "requestStatusId": 0,
49 "requestStatusDisplayId": "string",
50 "mainAssetIds": [
51 0
52 ],
53 "mainAssetId": 0,
54 "mainAssetDto": {
55 "id": 0,
56 "createdBy": "string",
57 "createdAt": "2019-08-24T14:15:22Z",
58 "displayId": "string",
59 "name": "string",
60 "description": "string",
61 "qrCode": "string",
62 "barCode": "string",
63 "imageId": 0,
64 "model": "string",
65 "manufacturer": "string",
66 "serialNumber": "string",
67 "cost": "81.08",
68 "premiseId": 0,
69 "premiseDisplayId": "string",
70 "premiseDto": {
71 "id": 0,
72 "createdBy": "string",
73 "createdAt": "2019-08-24T14:15:22Z",
74 "displayId": "string",
75 "premiseName": "string",
76 "description": "string",
77 "address": "string",
78 "internalTeamNames": [
79 "string"
80 ],
81 "internalTeamIds": [
82 0
83 ],
84 "premiseAvailable": true,
85 "premiseFromNrm": true,
86 "nlmId": 0,
87 "nlmDisplayId": "string",
88 "nlmUsed": true,
89 "manager": 0,
90 "managerName": "string",
91 "imageId": 0,
92 "area": "string",
93 "modifiedAt": "2019-08-24T14:15:22Z"
94 },
95 "acquisitionDate": "2019-08-24",
96 "endOfLife": "2019-08-24",
97 "assetStatusId": 0,
98 "assetStatus": "string",
99 "assetStatusType": "string",
100 "parentAssetId": 0,
101 "parentAssetDisplayId": "string",
102 "parentAsset": "string",
103 "parentAssetDto": {},
104 "upcomingMaintenanceDate": "2019-08-24",
105 "assetCategoryIds": [
106 0
107 ],
108 "assetCategories": [
109 "string"
110 ],
111 "internalTeamIds": [
112 0
113 ],
114 "internalTeamDtos": [
115 {
116 "id": 0,
117 "createdBy": "string",
118 "createdAt": "2019-08-24T14:15:22Z",
119 "displayId": "string",
120 "name": "string",
121 "email": "string",
122 "phone": "string",
123 "manager": "string",
124 "requestCategoryName": [
125 "string"
126 ],
127 "requestCategoryId": [
128 0
129 ],
130 "requestCategoryDisplayId": [
131 "string"
132 ],
133 "description": "string",
134 "internalTeamUser": [
135 0
136 ],
137 "members": 0,
138 "mainAssets": [
139 0
140 ],
141 "premiseNames": [
142 "string"
143 ],
144 "internalTeamAvailable": true,
145 "premiseIds": [
146 0
147 ]
148 }
149 ],
150 "internalTeams": [
151 "string"
152 ],
153 "assignedUserIds": [
154 0
155 ],
156 "assignedUserDtos": [
157 {
158 "id": 0,
159 "createdBy": "string",
160 "createdAt": "2019-08-24T14:15:22Z",
161 "userName": "string",
162 "firstName": "string",
163 "lastName": "string",
164 "email": "string",
165 "roleIds": [
166 {
167 "id": 0,
168 "createdBy": "string",
169 "createdAt": "2019-08-24T14:15:22Z",
170 "modifiedBy": "string",
171 "modifiedAt": "2019-08-24T14:15:22Z",
172 "roleName": "string",
173 "entity": "string",
174 "new": true
175 }
176 ],
177 "internalTeamNames": [
178 "string"
179 ],
180 "internalTeamIds": [
181 0
182 ],
183 "internalTeamDisplayIds": [
184 "string"
185 ],
186 "premiseIds": [
187 0
188 ],
189 "premiseNames": [
190 "string"
191 ],
192 "userAvailable": true,
193 "temporaryWorkload": 0,
194 "preferredCultureCode": "string"
195 }
196 ],
197 "assignedUsers": [
198 "string"
199 ],
200 "assetPriority": "string",
201 "assetPriorityId": 0,
202 "assetPriorityDisplayId": "string",
203 "assetPriorityType": "string",
204 "assetAvailable": true,
205 "exactPlacement": "string",
206 "fosId": 0,
207 "downtimeStatus": "string",
208 "premiseFromNrm": true,
209 "modifiedAt": "2019-08-24T14:15:22Z"
210 },
211 "mainAssetDisplayId": "string",
212 "assignedUserIds": [
213 0
214 ],
215 "assignedUserDtos": [
216 {
217 "id": 0,
218 "createdBy": "string",
219 "createdAt": "2019-08-24T14:15:22Z",
220 "userName": "string",
221 "firstName": "string",
222 "lastName": "string",
223 "email": "string",
224 "roleIds": [
225 {
226 "id": 0,
227 "createdBy": "string",
228 "createdAt": "2019-08-24T14:15:22Z",
229 "modifiedBy": "string",
230 "modifiedAt": "2019-08-24T14:15:22Z",
231 "roleName": "string",
232 "entity": "string",
233 "new": true
234 }
235 ],
236 "internalTeamNames": [
237 "string"
238 ],
239 "internalTeamIds": [
240 0
241 ],
242 "internalTeamDisplayIds": [
243 "string"
244 ],
245 "premiseIds": [
246 0
247 ],
248 "premiseNames": [
249 "string"
250 ],
251 "userAvailable": true,
252 "temporaryWorkload": 0,
253 "preferredCultureCode": "string"
254 }
255 ],
256 "assignedUsers": [
257 "string"
258 ],
259 "internalTeamIds": [
260 0
261 ],
262 "internalTeamDtos": [
263 {
264 "id": 0,
265 "createdBy": "string",
266 "createdAt": "2019-08-24T14:15:22Z",
267 "displayId": "string",
268 "name": "string",
269 "email": "string",
270 "phone": "string",
271 "manager": "string",
272 "requestCategoryName": [
273 "string"
274 ],
275 "requestCategoryId": [
276 0
277 ],
278 "requestCategoryDisplayId": [
279 "string"
280 ],
281 "description": "string",
282 "internalTeamUser": [
283 0
284 ],
285 "members": 0,
286 "mainAssets": [
287 0
288 ],
289 "premiseNames": [
290 "string"
291 ],
292 "internalTeamAvailable": true,
293 "premiseIds": [
294 0
295 ]
296 }
297 ],
298 "internalTeams": [
299 "string"
300 ],
301 "requestAvailable": true,
302 "exactPlacement": "string",
303 "requestType": "string",
304 "closeDate": "2019-08-24",
305 "requestFrom": "NFM"
306}
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 "description": "string",
7 "imageId": 0,
8 "premiseId": 0,
9 "premiseDto": {
10 "id": 0,
11 "createdBy": "string",
12 "createdAt": "2019-08-24T14:15:22Z",
13 "displayId": "string",
14 "premiseName": "string",
15 "description": "string",
16 "address": "string",
17 "internalTeamNames": [
18 "string"
19 ],
20 "internalTeamIds": [
21 0
22 ],
23 "premiseAvailable": true,
24 "premiseFromNrm": true,
25 "nlmId": 0,
26 "nlmDisplayId": "string",
27 "nlmUsed": true,
28 "manager": 0,
29 "managerName": "string",
30 "imageId": 0,
31 "area": "string",
32 "modifiedAt": "2019-08-24T14:15:22Z"
33 },
34 "premiseFromNrm": true,
35 "premiseDisplayId": "string",
36 "name": "string",
37 "requestPriority": "string",
38 "requestPriorityType": "string",
39 "requestPriorityId": 0,
40 "requestPriorityDisplayId": "string",
41 "requestDate": "2019-08-24",
42 "modifiedAt": "2019-08-24T14:15:22Z",
43 "requestCategory": "string",
44 "requestCategoryId": 0,
45 "requestCategoryDisplayId": "string",
46 "requestStatus": "string",
47 "requestStatusType": "string",
48 "requestStatusId": 0,
49 "requestStatusDisplayId": "string",
50 "mainAssetIds": [
51 0
52 ],
53 "mainAssetId": 0,
54 "mainAssetDto": {
55 "id": 0,
56 "createdBy": "string",
57 "createdAt": "2019-08-24T14:15:22Z",
58 "displayId": "string",
59 "name": "string",
60 "description": "string",
61 "qrCode": "string",
62 "barCode": "string",
63 "imageId": 0,
64 "model": "string",
65 "manufacturer": "string",
66 "serialNumber": "string",
67 "cost": "81.08",
68 "premiseId": 0,
69 "premiseDisplayId": "string",
70 "premiseDto": {
71 "id": 0,
72 "createdBy": "string",
73 "createdAt": "2019-08-24T14:15:22Z",
74 "displayId": "string",
75 "premiseName": "string",
76 "description": "string",
77 "address": "string",
78 "internalTeamNames": [
79 "string"
80 ],
81 "internalTeamIds": [
82 0
83 ],
84 "premiseAvailable": true,
85 "premiseFromNrm": true,
86 "nlmId": 0,
87 "nlmDisplayId": "string",
88 "nlmUsed": true,
89 "manager": 0,
90 "managerName": "string",
91 "imageId": 0,
92 "area": "string",
93 "modifiedAt": "2019-08-24T14:15:22Z"
94 },
95 "acquisitionDate": "2019-08-24",
96 "endOfLife": "2019-08-24",
97 "assetStatusId": 0,
98 "assetStatus": "string",
99 "assetStatusType": "string",
100 "parentAssetId": 0,
101 "parentAssetDisplayId": "string",
102 "parentAsset": "string",
103 "parentAssetDto": {},
104 "upcomingMaintenanceDate": "2019-08-24",
105 "assetCategoryIds": [
106 0
107 ],
108 "assetCategories": [
109 "string"
110 ],
111 "internalTeamIds": [
112 0
113 ],
114 "internalTeamDtos": [
115 {
116 "id": 0,
117 "createdBy": "string",
118 "createdAt": "2019-08-24T14:15:22Z",
119 "displayId": "string",
120 "name": "string",
121 "email": "string",
122 "phone": "string",
123 "manager": "string",
124 "requestCategoryName": [
125 "string"
126 ],
127 "requestCategoryId": [
128 0
129 ],
130 "requestCategoryDisplayId": [
131 "string"
132 ],
133 "description": "string",
134 "internalTeamUser": [
135 0
136 ],
137 "members": 0,
138 "mainAssets": [
139 0
140 ],
141 "premiseNames": [
142 "string"
143 ],
144 "internalTeamAvailable": true,
145 "premiseIds": [
146 0
147 ]
148 }
149 ],
150 "internalTeams": [
151 "string"
152 ],
153 "assignedUserIds": [
154 0
155 ],
156 "assignedUserDtos": [
157 {
158 "id": 0,
159 "createdBy": "string",
160 "createdAt": "2019-08-24T14:15:22Z",
161 "userName": "string",
162 "firstName": "string",
163 "lastName": "string",
164 "email": "string",
165 "roleIds": [
166 {
167 "id": 0,
168 "createdBy": "string",
169 "createdAt": "2019-08-24T14:15:22Z",
170 "modifiedBy": "string",
171 "modifiedAt": "2019-08-24T14:15:22Z",
172 "roleName": "string",
173 "entity": "string",
174 "new": true
175 }
176 ],
177 "internalTeamNames": [
178 "string"
179 ],
180 "internalTeamIds": [
181 0
182 ],
183 "internalTeamDisplayIds": [
184 "string"
185 ],
186 "premiseIds": [
187 0
188 ],
189 "premiseNames": [
190 "string"
191 ],
192 "userAvailable": true,
193 "temporaryWorkload": 0,
194 "preferredCultureCode": "string"
195 }
196 ],
197 "assignedUsers": [
198 "string"
199 ],
200 "assetPriority": "string",
201 "assetPriorityId": 0,
202 "assetPriorityDisplayId": "string",
203 "assetPriorityType": "string",
204 "assetAvailable": true,
205 "exactPlacement": "string",
206 "fosId": 0,
207 "downtimeStatus": "string",
208 "premiseFromNrm": true,
209 "modifiedAt": "2019-08-24T14:15:22Z"
210 },
211 "mainAssetDisplayId": "string",
212 "assignedUserIds": [
213 0
214 ],
215 "assignedUserDtos": [
216 {
217 "id": 0,
218 "createdBy": "string",
219 "createdAt": "2019-08-24T14:15:22Z",
220 "userName": "string",
221 "firstName": "string",
222 "lastName": "string",
223 "email": "string",
224 "roleIds": [
225 {
226 "id": 0,
227 "createdBy": "string",
228 "createdAt": "2019-08-24T14:15:22Z",
229 "modifiedBy": "string",
230 "modifiedAt": "2019-08-24T14:15:22Z",
231 "roleName": "string",
232 "entity": "string",
233 "new": true
234 }
235 ],
236 "internalTeamNames": [
237 "string"
238 ],
239 "internalTeamIds": [
240 0
241 ],
242 "internalTeamDisplayIds": [
243 "string"
244 ],
245 "premiseIds": [
246 0
247 ],
248 "premiseNames": [
249 "string"
250 ],
251 "userAvailable": true,
252 "temporaryWorkload": 0,
253 "preferredCultureCode": "string"
254 }
255 ],
256 "assignedUsers": [
257 "string"
258 ],
259 "internalTeamIds": [
260 0
261 ],
262 "internalTeamDtos": [
263 {
264 "id": 0,
265 "createdBy": "string",
266 "createdAt": "2019-08-24T14:15:22Z",
267 "displayId": "string",
268 "name": "string",
269 "email": "string",
270 "phone": "string",
271 "manager": "string",
272 "requestCategoryName": [
273 "string"
274 ],
275 "requestCategoryId": [
276 0
277 ],
278 "requestCategoryDisplayId": [
279 "string"
280 ],
281 "description": "string",
282 "internalTeamUser": [
283 0
284 ],
285 "members": 0,
286 "mainAssets": [
287 0
288 ],
289 "premiseNames": [
290 "string"
291 ],
292 "internalTeamAvailable": true,
293 "premiseIds": [
294 0
295 ]
296 }
297 ],
298 "internalTeams": [
299 "string"
300 ],
301 "requestAvailable": true,
302 "exactPlacement": "string",
303 "requestType": "string",
304 "closeDate": "2019-08-24",
305 "requestFrom": "NFM"
306}
Copy Request¶
HTTP Request
POST /api/requests/copyRequest/{id}
📋 Description: Creates a duplicate of an existing request identified by the specified ID, facilitating efficient request management and streamlining workflow processes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
name |
query |
string |
true |
Name of the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "description": "string",
7 "imageId": 0,
8 "premiseId": 0,
9 "premiseDto": {
10 "id": 0,
11 "createdBy": "string",
12 "createdAt": "2019-08-24T14:15:22Z",
13 "displayId": "string",
14 "premiseName": "string",
15 "description": "string",
16 "address": "string",
17 "internalTeamNames": [
18 "string"
19 ],
20 "internalTeamIds": [
21 0
22 ],
23 "premiseAvailable": true,
24 "premiseFromNrm": true,
25 "nlmId": 0,
26 "nlmDisplayId": "string",
27 "nlmUsed": true,
28 "manager": 0,
29 "managerName": "string",
30 "imageId": 0,
31 "area": "string",
32 "modifiedAt": "2019-08-24T14:15:22Z"
33 },
34 "premiseFromNrm": true,
35 "premiseDisplayId": "string",
36 "name": "string",
37 "requestPriority": "string",
38 "requestPriorityType": "string",
39 "requestPriorityId": 0,
40 "requestPriorityDisplayId": "string",
41 "requestDate": "2019-08-24",
42 "modifiedAt": "2019-08-24T14:15:22Z",
43 "requestCategory": "string",
44 "requestCategoryId": 0,
45 "requestCategoryDisplayId": "string",
46 "requestStatus": "string",
47 "requestStatusType": "string",
48 "requestStatusId": 0,
49 "requestStatusDisplayId": "string",
50 "mainAssetIds": [
51 0
52 ],
53 "mainAssetId": 0,
54 "mainAssetDto": {
55 "id": 0,
56 "createdBy": "string",
57 "createdAt": "2019-08-24T14:15:22Z",
58 "displayId": "string",
59 "name": "string",
60 "description": "string",
61 "qrCode": "string",
62 "barCode": "string",
63 "imageId": 0,
64 "model": "string",
65 "manufacturer": "string",
66 "serialNumber": "string",
67 "cost": "81.08",
68 "premiseId": 0,
69 "premiseDisplayId": "string",
70 "premiseDto": {
71 "id": 0,
72 "createdBy": "string",
73 "createdAt": "2019-08-24T14:15:22Z",
74 "displayId": "string",
75 "premiseName": "string",
76 "description": "string",
77 "address": "string",
78 "internalTeamNames": [
79 "string"
80 ],
81 "internalTeamIds": [
82 0
83 ],
84 "premiseAvailable": true,
85 "premiseFromNrm": true,
86 "nlmId": 0,
87 "nlmDisplayId": "string",
88 "nlmUsed": true,
89 "manager": 0,
90 "managerName": "string",
91 "imageId": 0,
92 "area": "string",
93 "modifiedAt": "2019-08-24T14:15:22Z"
94 },
95 "acquisitionDate": "2019-08-24",
96 "endOfLife": "2019-08-24",
97 "assetStatusId": 0,
98 "assetStatus": "string",
99 "assetStatusType": "string",
100 "parentAssetId": 0,
101 "parentAssetDisplayId": "string",
102 "parentAsset": "string",
103 "parentAssetDto": {},
104 "upcomingMaintenanceDate": "2019-08-24",
105 "assetCategoryIds": [
106 0
107 ],
108 "assetCategories": [
109 "string"
110 ],
111 "internalTeamIds": [
112 0
113 ],
114 "internalTeamDtos": [
115 {
116 "id": 0,
117 "createdBy": "string",
118 "createdAt": "2019-08-24T14:15:22Z",
119 "displayId": "string",
120 "name": "string",
121 "email": "string",
122 "phone": "string",
123 "manager": "string",
124 "requestCategoryName": [
125 "string"
126 ],
127 "requestCategoryId": [
128 0
129 ],
130 "requestCategoryDisplayId": [
131 "string"
132 ],
133 "description": "string",
134 "internalTeamUser": [
135 0
136 ],
137 "members": 0,
138 "mainAssets": [
139 0
140 ],
141 "premiseNames": [
142 "string"
143 ],
144 "internalTeamAvailable": true,
145 "premiseIds": [
146 0
147 ]
148 }
149 ],
150 "internalTeams": [
151 "string"
152 ],
153 "assignedUserIds": [
154 0
155 ],
156 "assignedUserDtos": [
157 {
158 "id": 0,
159 "createdBy": "string",
160 "createdAt": "2019-08-24T14:15:22Z",
161 "userName": "string",
162 "firstName": "string",
163 "lastName": "string",
164 "email": "string",
165 "roleIds": [
166 {
167 "id": 0,
168 "createdBy": "string",
169 "createdAt": "2019-08-24T14:15:22Z",
170 "modifiedBy": "string",
171 "modifiedAt": "2019-08-24T14:15:22Z",
172 "roleName": "string",
173 "entity": "string",
174 "new": true
175 }
176 ],
177 "internalTeamNames": [
178 "string"
179 ],
180 "internalTeamIds": [
181 0
182 ],
183 "internalTeamDisplayIds": [
184 "string"
185 ],
186 "premiseIds": [
187 0
188 ],
189 "premiseNames": [
190 "string"
191 ],
192 "userAvailable": true,
193 "temporaryWorkload": 0,
194 "preferredCultureCode": "string"
195 }
196 ],
197 "assignedUsers": [
198 "string"
199 ],
200 "assetPriority": "string",
201 "assetPriorityId": 0,
202 "assetPriorityDisplayId": "string",
203 "assetPriorityType": "string",
204 "assetAvailable": true,
205 "exactPlacement": "string",
206 "fosId": 0,
207 "downtimeStatus": "string",
208 "premiseFromNrm": true,
209 "modifiedAt": "2019-08-24T14:15:22Z"
210 },
211 "mainAssetDisplayId": "string",
212 "assignedUserIds": [
213 0
214 ],
215 "assignedUserDtos": [
216 {
217 "id": 0,
218 "createdBy": "string",
219 "createdAt": "2019-08-24T14:15:22Z",
220 "userName": "string",
221 "firstName": "string",
222 "lastName": "string",
223 "email": "string",
224 "roleIds": [
225 {
226 "id": 0,
227 "createdBy": "string",
228 "createdAt": "2019-08-24T14:15:22Z",
229 "modifiedBy": "string",
230 "modifiedAt": "2019-08-24T14:15:22Z",
231 "roleName": "string",
232 "entity": "string",
233 "new": true
234 }
235 ],
236 "internalTeamNames": [
237 "string"
238 ],
239 "internalTeamIds": [
240 0
241 ],
242 "internalTeamDisplayIds": [
243 "string"
244 ],
245 "premiseIds": [
246 0
247 ],
248 "premiseNames": [
249 "string"
250 ],
251 "userAvailable": true,
252 "temporaryWorkload": 0,
253 "preferredCultureCode": "string"
254 }
255 ],
256 "assignedUsers": [
257 "string"
258 ],
259 "internalTeamIds": [
260 0
261 ],
262 "internalTeamDtos": [
263 {
264 "id": 0,
265 "createdBy": "string",
266 "createdAt": "2019-08-24T14:15:22Z",
267 "displayId": "string",
268 "name": "string",
269 "email": "string",
270 "phone": "string",
271 "manager": "string",
272 "requestCategoryName": [
273 "string"
274 ],
275 "requestCategoryId": [
276 0
277 ],
278 "requestCategoryDisplayId": [
279 "string"
280 ],
281 "description": "string",
282 "internalTeamUser": [
283 0
284 ],
285 "members": 0,
286 "mainAssets": [
287 0
288 ],
289 "premiseNames": [
290 "string"
291 ],
292 "internalTeamAvailable": true,
293 "premiseIds": [
294 0
295 ]
296 }
297 ],
298 "internalTeams": [
299 "string"
300 ],
301 "requestAvailable": true,
302 "exactPlacement": "string",
303 "requestType": "string",
304 "closeDate": "2019-08-24",
305 "requestFrom": "NFM"
306}
Get All Work Orders By Request ID¶
HTTP Request
GET /api/requests/{id}/workOrders
📋 Description: Retrieves the work orders associated with a specific request, enabling users to access detailed task information linked to their operational needs.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "name": "string",
8 "imageId": 0,
9 "description": "string",
10 "vendorRating": 0,
11 "premiseId": 0,
12 "premiseDto": {
13 "id": 0,
14 "createdBy": "string",
15 "createdAt": "2019-08-24T14:15:22Z",
16 "displayId": "string",
17 "premiseName": "string",
18 "description": "string",
19 "address": "string",
20 "internalTeamNames": [
21 "string"
22 ],
23 "internalTeamIds": [
24 0
25 ],
26 "premiseAvailable": true,
27 "premiseFromNrm": true,
28 "nlmId": 0,
29 "nlmDisplayId": "string",
30 "nlmUsed": true,
31 "manager": 0,
32 "managerName": "string",
33 "imageId": 0,
34 "area": "string",
35 "modifiedAt": "2019-08-24T14:15:22Z"
36 },
37 "premiseFromNrm": true,
38 "premiseDisplayId": "string",
39 "nssProjectId": 0,
40 "nssTaskId": 0,
41 "nssTaskDisplayId": "string",
42 "orderDate": "2019-08-24",
43 "dueDate": "2019-08-24",
44 "startDate": "2019-08-24",
45 "endDate": "2019-08-24",
46 "startTime": {
47 "hour": 0,
48 "minute": 0,
49 "second": 0,
50 "nano": 0
51 },
52 "endTime": {
53 "hour": 0,
54 "minute": 0,
55 "second": 0,
56 "nano": 0
57 },
58 "modifiedAt": "2019-08-24T14:15:22Z",
59 "estimatedCost": "81.08",
60 "finalCost": "81.08",
61 "duration": 0,
62 "estimatedDayTime": 0,
63 "finalHourTime": "2.5",
64 "estimatedHourTime": "2.5",
65 "closeDate": "2019-08-24",
66 "inspection": "string",
67 "workOrderTypeId": 0,
68 "workOrderTypeName": "string",
69 "workOrderType": "string",
70 "workOrderPriorityId": 0,
71 "workOrderPriority": "string",
72 "workOrderPriorityType": "string",
73 "isTemplate": true,
74 "isWorkOrderTemplate": true,
75 "templateId": 0,
76 "isPartsInSufficient": true,
77 "partQuantityInfoList": [
78 {
79 "partId": 0,
80 "partDisplayId": "string",
81 "requestedQuantity": 0,
82 "availableQuantity": 0,
83 "usedQuantity": 0,
84 "sufficient": true,
85 "partial": true
86 }
87 ],
88 "parentWorkOrderId": 0,
89 "parentWorkOrderDisplayId": "string",
90 "parentWorkOrder": "string",
91 "mainAssetIds": [
92 0
93 ],
94 "mainAssetDto": {
95 "id": 0,
96 "createdBy": "string",
97 "createdAt": "2019-08-24T14:15:22Z",
98 "displayId": "string",
99 "name": "string",
100 "description": "string",
101 "qrCode": "string",
102 "barCode": "string",
103 "imageId": 0,
104 "model": "string",
105 "manufacturer": "string",
106 "serialNumber": "string",
107 "cost": "81.08",
108 "premiseId": 0,
109 "premiseDisplayId": "string",
110 "premiseDto": {
111 "id": 0,
112 "createdBy": "string",
113 "createdAt": "2019-08-24T14:15:22Z",
114 "displayId": "string",
115 "premiseName": "string",
116 "description": "string",
117 "address": "string",
118 "internalTeamNames": [
119 "string"
120 ],
121 "internalTeamIds": [
122 0
123 ],
124 "premiseAvailable": true,
125 "premiseFromNrm": true,
126 "nlmId": 0,
127 "nlmDisplayId": "string",
128 "nlmUsed": true,
129 "manager": 0,
130 "managerName": "string",
131 "imageId": 0,
132 "area": "string",
133 "modifiedAt": "2019-08-24T14:15:22Z"
134 },
135 "acquisitionDate": "2019-08-24",
136 "endOfLife": "2019-08-24",
137 "assetStatusId": 0,
138 "assetStatus": "string",
139 "assetStatusType": "string",
140 "parentAssetId": 0,
141 "parentAssetDisplayId": "string",
142 "parentAsset": "string",
143 "parentAssetDto": {},
144 "upcomingMaintenanceDate": "2019-08-24",
145 "assetCategoryIds": [
146 0
147 ],
148 "assetCategories": [
149 "string"
150 ],
151 "internalTeamIds": [
152 0
153 ],
154 "internalTeamDtos": [
155 {
156 "id": 0,
157 "createdBy": "string",
158 "createdAt": "2019-08-24T14:15:22Z",
159 "displayId": "string",
160 "name": "string",
161 "email": "string",
162 "phone": "string",
163 "manager": "string",
164 "requestCategoryName": [
165 "string"
166 ],
167 "requestCategoryId": [
168 0
169 ],
170 "requestCategoryDisplayId": [
171 "string"
172 ],
173 "description": "string",
174 "internalTeamUser": [
175 0
176 ],
177 "members": 0,
178 "mainAssets": [
179 0
180 ],
181 "premiseNames": [
182 "string"
183 ],
184 "internalTeamAvailable": true,
185 "premiseIds": [
186 0
187 ]
188 }
189 ],
190 "internalTeams": [
191 "string"
192 ],
193 "assignedUserIds": [
194 0
195 ],
196 "assignedUserDtos": [
197 {
198 "id": 0,
199 "createdBy": "string",
200 "createdAt": "2019-08-24T14:15:22Z",
201 "userName": "string",
202 "firstName": "string",
203 "lastName": "string",
204 "email": "string",
205 "roleIds": [
206 {
207 "id": 0,
208 "createdBy": "string",
209 "createdAt": "2019-08-24T14:15:22Z",
210 "modifiedBy": "string",
211 "modifiedAt": "2019-08-24T14:15:22Z",
212 "roleName": "string",
213 "entity": "string",
214 "new": true
215 }
216 ],
217 "internalTeamNames": [
218 "string"
219 ],
220 "internalTeamIds": [
221 0
222 ],
223 "internalTeamDisplayIds": [
224 "string"
225 ],
226 "premiseIds": [
227 0
228 ],
229 "premiseNames": [
230 "string"
231 ],
232 "userAvailable": true,
233 "temporaryWorkload": 0,
234 "preferredCultureCode": "string"
235 }
236 ],
237 "assignedUsers": [
238 "string"
239 ],
240 "assetPriority": "string",
241 "assetPriorityId": 0,
242 "assetPriorityDisplayId": "string",
243 "assetPriorityType": "string",
244 "assetAvailable": true,
245 "exactPlacement": "string",
246 "fosId": 0,
247 "downtimeStatus": "string",
248 "premiseFromNrm": true,
249 "modifiedAt": "2019-08-24T14:15:22Z"
250 },
251 "mainAssetDisplayId": "string",
252 "workOrderStatusId": 0,
253 "workOrderStatus": "string",
254 "workOrderStatusType": "string",
255 "requestIds": [
256 0
257 ],
258 "internalTeamIds": [
259 0
260 ],
261 "internalTeamDtos": [
262 {
263 "id": 0,
264 "createdBy": "string",
265 "createdAt": "2019-08-24T14:15:22Z",
266 "displayId": "string",
267 "name": "string",
268 "email": "string",
269 "phone": "string",
270 "manager": "string",
271 "requestCategoryName": [
272 "string"
273 ],
274 "requestCategoryId": [
275 0
276 ],
277 "requestCategoryDisplayId": [
278 "string"
279 ],
280 "description": "string",
281 "internalTeamUser": [
282 0
283 ],
284 "members": 0,
285 "mainAssets": [
286 0
287 ],
288 "premiseNames": [
289 "string"
290 ],
291 "internalTeamAvailable": true,
292 "premiseIds": [
293 0
294 ]
295 }
296 ],
297 "internalTeams": [
298 "string"
299 ],
300 "vendorId": 0,
301 "vendorDto": {
302 "id": 0,
303 "createdBy": "string",
304 "createdAt": "2019-08-24T14:15:22Z",
305 "displayId": "string",
306 "name": "string",
307 "description": "string",
308 "address": "string",
309 "contractEndDate": "2019-08-24",
310 "services": "string",
311 "vendorType": "string",
312 "vendorStatusId": 0,
313 "vendorStatus": "string",
314 "vendorStatusType": "string",
315 "businessTypeId": 0,
316 "businessType": "string",
317 "vendorRateId": 0,
318 "vendorRate": "string",
319 "vendorContactIds": [
320 0
321 ],
322 "premiseIds": [
323 0
324 ],
325 "firstPremiseDisplayId": "string",
326 "ownerUserName": "string",
327 "ownerDto": {
328 "id": 0,
329 "createdBy": "string",
330 "createdAt": "2019-08-24T14:15:22Z",
331 "userName": "string",
332 "firstName": "string",
333 "lastName": "string",
334 "email": "string",
335 "roleIds": [
336 {
337 "id": 0,
338 "createdBy": "string",
339 "createdAt": "2019-08-24T14:15:22Z",
340 "modifiedBy": "string",
341 "modifiedAt": "2019-08-24T14:15:22Z",
342 "roleName": "string",
343 "entity": "string",
344 "new": true
345 }
346 ],
347 "internalTeamNames": [
348 "string"
349 ],
350 "internalTeamIds": [
351 0
352 ],
353 "internalTeamDisplayIds": [
354 "string"
355 ],
356 "premiseIds": [
357 0
358 ],
359 "premiseNames": [
360 "string"
361 ],
362 "userAvailable": true,
363 "temporaryWorkload": 0,
364 "preferredCultureCode": "string"
365 },
366 "vendorAvailable": true,
367 "vendorRating": 0.1,
368 "premiseDisplayIds": [
369 "string"
370 ]
371 },
372 "vendorName": "string",
373 "workOrderTemplateSettings": {
374 "id": 0,
375 "createdBy": "string",
376 "createdAt": "2019-08-24T14:15:22Z",
377 "workOrderId": 0,
378 "startDate": "2019-08-24",
379 "dueDuration": 0,
380 "dueMonths": 0,
381 "endDate": "2019-08-24",
382 "recurringWOPriorityId": 0,
383 "recurringWOPriority": "string",
384 "recurringWOPriorityType": "string",
385 "isTemplate": true,
386 "isRemoveByDate": true,
387 "triggerByWorkOrderStatusId": 0,
388 "triggerByWorkOrderStatus": "string",
389 "triggerByWorkOrderStatusType": "string",
390 "removeByWorkOrderStatusId": 0,
391 "removeByWorkOrderStatus": "string",
392 "removeByWorkOrderStatusType": "string"
393 },
394 "assignedUserIds": [
395 0
396 ],
397 "assignedUserDtos": [
398 {
399 "id": 0,
400 "createdBy": "string",
401 "createdAt": "2019-08-24T14:15:22Z",
402 "userName": "string",
403 "firstName": "string",
404 "lastName": "string",
405 "email": "string",
406 "roleIds": [
407 {
408 "id": 0,
409 "createdBy": "string",
410 "createdAt": "2019-08-24T14:15:22Z",
411 "modifiedBy": "string",
412 "modifiedAt": "2019-08-24T14:15:22Z",
413 "roleName": "string",
414 "entity": "string",
415 "new": true
416 }
417 ],
418 "internalTeamNames": [
419 "string"
420 ],
421 "internalTeamIds": [
422 0
423 ],
424 "internalTeamDisplayIds": [
425 "string"
426 ],
427 "premiseIds": [
428 0
429 ],
430 "premiseNames": [
431 "string"
432 ],
433 "userAvailable": true,
434 "temporaryWorkload": 0,
435 "preferredCultureCode": "string"
436 }
437 ],
438 "assignedUsers": [
439 "string"
440 ],
441 "variableQuantity": 0,
442 "workOrderAvailable": true,
443 "exactPlacement": "string",
444 "primaryWorkOrderId": 0,
445 "primaryWorkOrderDto": {},
446 "primaryWorkOrderDisplayId": "string",
447 "isPrimary": true,
448 "invoiceIds": [
449 0
450 ],
451 "createdByTrigger": true,
452 "internalCosts": "81.08",
453 "invoiceTotal": "81.08",
454 "partsTotal": "81.08",
455 "inspectionItemId": 0,
456 "partIdToAttach": 0
457 }
458]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a work order, encapsulating essential details such as task specifications, assigned resources, and status updates to facilitate efficient project management and operational workflow.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
false |
none |
Name of the resource |
» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
» description |
string |
false |
none |
Description of the resource |
» vendorRating |
integer(int32) |
false |
none |
Represents the numerical rating assigned to a vendor, reflecting their performance and reliability in fulfilling work orders. |
» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
» premiseDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» premiseName |
string |
false |
none |
Name of the premise |
»» description |
string |
false |
none |
Description of the resource |
»» address |
string |
true |
none |
Represents the physical location associated with the premise, essential for logistics and service delivery. |
»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation within the organization. |
»» internalTeamIds |
[integer] |
false |
none |
List of unique identifiers representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation. |
»» premiseAvailable |
boolean |
false |
none |
Indicates whether the premise is available for use within the specified context. |
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the premise is sourced from the National Resource Management (NRM) framework, facilitating compliance and reporting within environmental management processes. |
»» nlmId |
integer(int64) |
false |
none |
Unique identifier for the nlm |
»» nlmDisplayId |
string |
false |
none |
Unique identifier for the nlm display |
»» nlmUsed |
boolean |
false |
none |
Indicates whether the National Labor Market (NLM) resources have been utilized in the premise evaluation process. |
»» manager |
integer(int64) |
false |
none |
Unique identifier for the manager associated with the premise, facilitating effective organizational hierarchy and resource management. |
»» managerName |
string |
false |
none |
Name of the manager |
»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»» area |
string |
false |
none |
Represents the geographic area associated with the premise, providing essential context for location-based services and analysis. |
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» premiseFromNrm |
boolean |
false |
none |
Indicates whether the work order is derived from the National Resource Management system. |
» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
» nssProjectId |
integer(int64) |
false |
none |
Unique identifier for the nss project |
» nssTaskId |
integer(int64) |
false |
none |
Unique identifier for the nss task |
» nssTaskDisplayId |
string |
false |
none |
Unique identifier for the nss task display |
» orderDate |
string(date) |
false |
none |
Date of the order |
» dueDate |
string(date) |
false |
none |
Due date of the resource |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» endDate |
string(date) |
false |
none |
End date of the resource |
» startTime |
false |
none |
Data transfer object representing the local time settings relevant to business operations, ensuring accurate scheduling and time management across various regions. |
|
»» hour |
integer(int32) |
false |
none |
Represents the hour component of a time value, facilitating precise scheduling and time management within the application. |
»» minute |
integer(int32) |
false |
none |
Represents the minute component of a local time value, facilitating precise time tracking and scheduling within the application. |
»» second |
integer(int32) |
false |
none |
Represents the seconds component of a local time value, facilitating precise time tracking and scheduling within the application. |
»» nano |
integer(int32) |
false |
none |
Represents the nanosecond component of a local time value, facilitating precise time tracking and scheduling within the application. |
» endTime |
false |
none |
Data transfer object representing the local time settings relevant to business operations, ensuring accurate scheduling and time management across various regions. |
|
» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» estimatedCost |
string |
false |
none |
Estimated cost associated with the work order, providing a financial projection for budgeting and resource allocation. |
» finalCost |
string |
false |
none |
The finalCost field represents the total cost associated with the completion of a work order, providing essential financial insights for project budgeting and resource allocation. |
» duration |
integer(int32) |
false |
none |
Represents the total time, in minutes, allocated for the completion of the work order. |
» estimatedDayTime |
integer(int32) |
false |
none |
Time of the estimated day |
» finalHourTime |
string |
false |
none |
Time of the final hour |
» estimatedHourTime |
string |
false |
none |
Time of the estimated hour |
» closeDate |
string(date) |
false |
none |
Date of the close |
» inspection |
string |
false |
none |
Describes the specific inspection details associated with the work order, ensuring clarity in task requirements and compliance standards. |
» workOrderTypeId |
integer(int64) |
false |
none |
Unique identifier for the work order type |
» workOrderTypeName |
string |
false |
none |
Name of the work order type |
» workOrderType |
string |
false |
none |
Type of the work order |
» workOrderPriorityId |
integer(int64) |
false |
none |
Unique identifier for the work order priority |
» workOrderPriority |
string |
false |
none |
Priority of the work order |
» workOrderPriorityType |
string |
false |
none |
Type of the work order priority |
» isTemplate |
boolean |
false |
none |
Whether the resource is template |
» isWorkOrderTemplate |
boolean |
false |
none |
Whether the resource is work order template |
» templateId |
integer(int64) |
false |
none |
Unique identifier for the template |
» isPartsInSufficient |
boolean |
false |
none |
Whether the resource is parts in sufficient |
» partQuantityInfoList |
false |
none |
List of quantities for each part associated with the work order, providing essential details for inventory management and resource allocation. |
|
»» partId |
integer(int64) |
false |
none |
Unique identifier for the part |
»» partDisplayId |
string |
false |
none |
Unique identifier for the part display |
»» requestedQuantity |
integer(int64) |
false |
none |
Quantity of requested quantity |
»» availableQuantity |
integer(int64) |
false |
none |
Quantity of available quantity |
»» usedQuantity |
integer(int64) |
false |
none |
Quantity of used quantity |
»» sufficient |
boolean |
false |
none |
Indicates whether the quantity of parts available meets the required threshold for operational needs. |
»» partial |
boolean |
false |
none |
Indicates whether the quantity of parts is partially fulfilled, providing insight into inventory status and order fulfillment. |
» parentWorkOrderId |
integer(int64) |
false |
none |
Unique identifier for the parent work order |
» parentWorkOrderDisplayId |
string |
false |
none |
Unique identifier for the parent work order display |
» parentWorkOrder |
string |
false |
none |
Identifier for the parent work order, establishing a hierarchical relationship within the work order management system. |
» mainAssetIds |
[integer] |
false |
none |
Array of unique identifiers for the primary assets associated with the work order, facilitating effective asset management and tracking. |
» mainAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» name |
string |
false |
none |
Name of the resource |
»» description |
string |
false |
none |
Description of the resource |
»» qrCode |
string |
false |
none |
Code for the qr |
»» barCode |
string |
false |
none |
Code for the bar |
»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»» model |
string |
false |
none |
Specifies the model associated with the main asset, providing essential context for asset classification and management. |
»» manufacturer |
string |
false |
none |
Name of the manufacturer associated with the asset, providing essential information for inventory management and supplier relations. |
»» serialNumber |
string |
false |
none |
Unique identifier for the asset, used to track and manage inventory within the system. |
»» cost |
string |
false |
none |
Represents the total cost associated with the main asset, providing essential financial information for budgeting and resource allocation. |
»» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
»» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
»» premiseDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
»» acquisitionDate |
string(date) |
false |
none |
Date of the acquisition |
»» endOfLife |
string(date) |
false |
none |
Indicates the end-of-life date for the asset, providing critical information for lifecycle management and planning. |
»» assetStatusId |
integer(int64) |
false |
none |
Unique identifier for the asset status |
»» assetStatus |
string |
false |
none |
Status of the asset |
»» assetStatusType |
string |
false |
none |
Type of the asset status |
»» parentAssetId |
integer(int64) |
false |
none |
Unique identifier for the parent asset |
»» parentAssetDisplayId |
string |
false |
none |
Unique identifier for the parent asset display |
»» parentAsset |
string |
false |
none |
Identifier for the parent asset associated with the main asset, facilitating hierarchical relationships within asset management. |
»» parentAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»» upcomingMaintenanceDate |
string(date) |
false |
none |
Date of the upcoming maintenance |
»» assetCategoryIds |
[integer] |
false |
none |
Array of unique identifiers representing the categories to which the asset belongs, facilitating effective asset classification and management. |
»» assetCategories |
[string] |
false |
none |
Array of asset categories that classify the main assets within the system, facilitating better organization and management of asset data. |
»» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the main asset, facilitating streamlined collaboration and resource allocation. |
»» internalTeamDtos |
false |
none |
An array of MainAssetDTO objects representing the internal teams associated with the asset, facilitating effective resource management and collaboration within the organization. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» name |
string |
false |
none |
Name of the resource |
string |
false |
none |
Email address of the internal team member, used for communication and notifications within the organization. |
|
»»» phone |
string |
false |
none |
Contact number for the internal team, facilitating communication and collaboration within the organization. |
»»» manager |
string |
false |
none |
Represents the name or identifier of the team manager responsible for overseeing the internal team. |
»»» requestCategoryName |
[string] |
false |
none |
Name of the request category |
»»» requestCategoryId |
[integer] |
false |
none |
Unique identifier for the request category |
»»» requestCategoryDisplayId |
[string] |
false |
none |
Unique identifier for the request category display |
»»» description |
string |
false |
none |
Description of the resource |
»»» internalTeamUser |
[integer] |
false |
none |
An array of InternalTeamDTO objects representing the users within the internal team, facilitating collaboration and resource management. |
»»» members |
integer(int32) |
false |
none |
Represents the total number of members within the internal team, providing insight into team size for resource allocation and management. |
»»» mainAssets |
[integer] |
false |
none |
An array of internal team assets that represent the key resources and capabilities utilized within the organization. |
»»» premiseNames |
[string] |
false |
none |
List of names associated with the premises relevant to the internal team, facilitating efficient identification and management of locations within the organization. |
»»» internalTeamAvailable |
boolean |
false |
none |
Indicates the availability of the internal team for project allocation and resource planning. |
»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the internal team. |
»» internalTeams |
[string] |
false |
none |
An array of internal teams associated with the main asset, facilitating collaboration and resource allocation within the organization. |
»» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers representing users assigned to the main asset, facilitating effective resource management and accountability. |
»» assignedUserDtos |
false |
none |
Array of user assignments associated with the main asset, providing insights into resource allocation and accountability. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» userName |
string |
false |
none |
Name of the user |
»»» firstName |
string |
false |
none |
Name of the first |
»»» lastName |
string |
false |
none |
Name of the last |
string |
false |
none |
Email address of the user, used for communication and account verification purposes within the system. |
|
»»» roleIds |
false |
none |
Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»»» modifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»»»» roleName |
string |
false |
none |
Name of the role |
»»»» entity |
string |
false |
none |
Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management. |
»»»» new |
boolean |
false |
none |
Indicates whether the role is newly created within the system, facilitating effective management of organizational changes. |
»»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization. |
»»» internalTeamIds |
[integer] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization. |
»»» internalTeamDisplayIds |
[string] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration. |
»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations. |
»»» premiseNames |
[string] |
false |
none |
List of names associated with the user’s premises, providing essential context for location-based services and operations. |
»»» userAvailable |
boolean |
false |
none |
Indicates whether the user is available for assignment or engagement within the system. |
»»» temporaryWorkload |
integer(int32) |
false |
none |
Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning. |
»»» preferredCultureCode |
string |
false |
none |
Code for the preferred culture |
»» assignedUsers |
[string] |
false |
none |
List of users assigned to the main asset, facilitating effective resource management and collaboration within the organization. |
»» assetPriority |
string |
false |
none |
Priority of the asset |
»» assetPriorityId |
integer(int64) |
false |
none |
Unique identifier for the asset priority |
»» assetPriorityDisplayId |
string |
false |
none |
Unique identifier for the asset priority display |
»» assetPriorityType |
string |
false |
none |
Type of the asset priority |
»» assetAvailable |
boolean |
false |
none |
Indicates whether the asset is currently available for allocation or use within the system. |
»» exactPlacement |
string |
false |
none |
Specifies the precise location or context in which the main asset is intended to be utilized within the business framework. |
»» fosId |
integer(int64) |
false |
none |
Unique identifier for the fos |
»» downtimeStatus |
string |
false |
none |
Status of the downtime |
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the asset is sourced from the National Resource Management (NRM) framework, facilitating compliance and resource tracking. |
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» mainAssetDisplayId |
string |
false |
none |
Unique identifier for the main asset display |
» workOrderStatusId |
integer(int64) |
false |
none |
Unique identifier for the work order status |
» workOrderStatus |
string |
false |
none |
Status of the work order |
» workOrderStatusType |
string |
false |
none |
Type of the work order status |
» requestIds |
[integer] |
false |
none |
An array of unique identifiers for the associated work orders, facilitating tracking and management within the system. |
» internalTeamIds |
[integer] |
false |
none |
List of unique identifiers representing the internal teams associated with the work order, facilitating effective resource allocation and collaboration. |
» internalTeamDtos |
false |
none |
An array of WorkOrderDTO objects representing the internal teams associated with the work order, facilitating efficient resource allocation and management. |
|
» internalTeams |
[string] |
false |
none |
List of internal teams associated with the work order, facilitating collaboration and resource allocation within the organization. |
» vendorId |
integer(int64) |
false |
none |
Unique identifier for the vendor |
» vendorDto |
false |
none |
Data transfer object representing a vendor, encapsulating essential details such as vendor identification, contact information, and service offerings to facilitate effective supplier management and collaboration. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» name |
string |
false |
none |
Name of the resource |
»» description |
string |
false |
none |
Description of the resource |
»» address |
string |
false |
none |
Represents the physical location of the vendor, essential for logistical coordination and service delivery. |
»» contractEndDate |
string(date) |
false |
none |
Date of the contract end |
»» services |
string |
false |
none |
Represents the list of services offered by the vendor, essential for evaluating vendor capabilities and aligning them with business needs. |
»» vendorType |
string |
false |
none |
Type of the vendor |
»» vendorStatusId |
integer(int64) |
false |
none |
Unique identifier for the vendor status |
»» vendorStatus |
string |
false |
none |
Status of the vendor |
»» vendorStatusType |
string |
false |
none |
Type of the vendor status |
»» businessTypeId |
integer(int64) |
false |
none |
Unique identifier for the business type |
»» businessType |
string |
false |
none |
Type of the business |
»» vendorRateId |
integer(int64) |
false |
none |
Unique identifier for the vendor rate |
»» vendorRate |
string |
false |
none |
Rate of vendor |
»» vendorContactIds |
[integer] |
false |
none |
Array of unique identifiers for vendor contacts associated with the vendor, facilitating streamlined communication and management of vendor relationships. |
»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the vendor, facilitating streamlined management and tracking of vendor relationships. |
»» firstPremiseDisplayId |
string |
false |
none |
Unique identifier for the first premise display |
»» ownerUserName |
string |
false |
none |
Name of the owner user |
»» ownerDto |
false |
none |
Data transfer object representing a user profile within the system, encapsulating essential user information and attributes for effective management and interaction across business applications. |
|
»» vendorAvailable |
boolean |
false |
none |
Indicates whether the vendor is currently available for new engagements. |
»» vendorRating |
number(double) |
false |
none |
Numeric representation of the vendor’s performance rating, used to assess and compare vendor quality within the procurement process. |
»» premiseDisplayIds |
[string] |
false |
none |
Array of unique identifiers for the premises associated with the vendor, facilitating streamlined management and reference within the system. |
» vendorName |
string |
false |
none |
Name of the vendor |
» workOrderTemplateSettings |
false |
none |
Data transfer object representing the settings and configurations for work order templates, facilitating streamlined management and customization of work orders within the enterprise workflow. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» workOrderId |
integer(int64) |
false |
none |
Unique identifier for the work order |
»» startDate |
string(date) |
false |
none |
Start date of the resource |
»» dueDuration |
integer(int32) |
false |
none |
Specifies the duration, in minutes, for which a work order is due, facilitating effective scheduling and resource allocation. |
»» dueMonths |
integer(int32) |
false |
none |
Specifies the number of months until the work order is due, facilitating effective scheduling and resource allocation. |
»» endDate |
string(date) |
false |
none |
End date of the resource |
»» recurringWOPriorityId |
integer(int64) |
false |
none |
Unique identifier for the recurring w o priority |
»» recurringWOPriority |
string |
false |
none |
Priority of the recurring w o |
»» recurringWOPriorityType |
string |
false |
none |
Type of the recurring w o priority |
»» isTemplate |
boolean |
false |
none |
Whether the resource is template |
»» isRemoveByDate |
boolean |
false |
none |
Whether the resource is remove by |
»» triggerByWorkOrderStatusId |
integer(int64) |
false |
none |
Unique identifier for the trigger by work order status |
»» triggerByWorkOrderStatus |
string |
false |
none |
Status of the trigger by work order |
»» triggerByWorkOrderStatusType |
string |
false |
none |
Type of the trigger by work order status |
»» removeByWorkOrderStatusId |
integer(int64) |
false |
none |
Unique identifier for the remove by work order status |
»» removeByWorkOrderStatus |
string |
false |
none |
Status of the remove by work order |
»» removeByWorkOrderStatusType |
string |
false |
none |
Type of the remove by work order status |
» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers for users assigned to the work order, facilitating effective resource allocation and management. |
» assignedUserDtos |
false |
none |
Array of user assignments associated with the work order, providing visibility into the personnel responsible for its execution. |
|
» assignedUsers |
[string] |
false |
none |
List of users assigned to the work order, facilitating effective task management and resource allocation. |
» variableQuantity |
integer(int64) |
false |
none |
Quantity of variable quantity |
» workOrderAvailable |
boolean |
false |
none |
Indicates whether a work order is currently available for processing within the system. |
» exactPlacement |
string |
false |
none |
Specifies the precise location or arrangement for the execution of the work order, ensuring clarity in task assignment and resource allocation. |
» primaryWorkOrderId |
integer(int64) |
false |
none |
Unique identifier for the primary work order |
» primaryWorkOrderDto |
false |
none |
Data transfer object representing a work order, encapsulating essential details such as task specifications, assigned resources, and status updates to facilitate efficient project management and operational workflow. |
|
» primaryWorkOrderDisplayId |
string |
false |
none |
Unique identifier for the primary work order display |
» isPrimary |
boolean |
false |
none |
Whether the resource is primary |
» invoiceIds |
[integer] |
false |
none |
Array of unique identifiers for invoices associated with the work order, facilitating efficient tracking and management of financial transactions. |
» createdByTrigger |
boolean |
false |
none |
Indicates whether the work order was created automatically by a trigger event within the system. |
» internalCosts |
string |
false |
none |
Represents the internal costs associated with the work order, providing essential financial insights for effective budget management. |
» invoiceTotal |
string |
false |
none |
Total invoice |
» partsTotal |
string |
false |
none |
Total parts |
» inspectionItemId |
integer(int64) |
false |
none |
Unique identifier for the inspection item |
» partIdToAttach |
integer(int64) |
false |
none |
Unique identifier for the part to be attached to the work order, facilitating efficient tracking and management of resources. |
» recurringWOIsTemplate |
boolean |
false |
write-only |
Indicates whether the work order is based on a recurring template, facilitating streamlined management of repeat tasks. |
» recurringWOStartDate |
string(date) |
false |
write-only |
Date of the recurring w o start |
» recurringWOEndDate |
string(date) |
false |
write-only |
Date of the recurring w o end |
» recurringWODueDuration |
integer(int32) |
false |
write-only |
Specifies the duration, in days, for which a work order is set to recur, facilitating effective scheduling and resource allocation. |
» recurringWODueMonths |
integer(int32) |
false |
write-only |
Specifies the number of months for which the work order is set to recur, facilitating effective scheduling and resource allocation. |
» recurringWOPriority |
string |
false |
write-only |
Priority of the recurring w o |
» recurringWOIsRemoveByDate |
boolean |
false |
write-only |
Date of the recurring w o is remove by |
» triggerByWorkOrderStatus |
string |
false |
write-only |
Status of the trigger by work order |
» removeByWorkOrderStatus |
string |
false |
write-only |
Status of the remove by work order |
» recurringWOPriorityType |
string |
false |
write-only |
Type of the recurring w o priority |
» triggerByWorkOrderStatusType |
string |
false |
write-only |
Type of the trigger by work order status |
» removeByWorkOrderStatusType |
string |
false |
write-only |
Type of the remove by work order status |
» recurringWOPriorityId |
integer(int64) |
false |
write-only |
Unique identifier for the recurring w o priority |
» triggerByWorkOrderStatusId |
integer(int64) |
false |
write-only |
Unique identifier for the trigger by work order status |
» removeByWorkOrderStatusId |
integer(int64) |
false |
write-only |
Unique identifier for the remove by work order status |
Get All Main Assets By Request¶
HTTP Request
GET /api/requests/{id}/mainAssets
📋 Description: Retrieves the main assets associated with a specific request identified by the provided ID, enabling users to access critical resource information for effective decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "name": "string",
8 "description": "string",
9 "qrCode": "string",
10 "barCode": "string",
11 "imageId": 0,
12 "model": "string",
13 "manufacturer": "string",
14 "serialNumber": "string",
15 "cost": "81.08",
16 "premiseId": 0,
17 "premiseDisplayId": "string",
18 "premiseDto": {
19 "id": 0,
20 "createdBy": "string",
21 "createdAt": "2019-08-24T14:15:22Z",
22 "displayId": "string",
23 "premiseName": "string",
24 "description": "string",
25 "address": "string",
26 "internalTeamNames": [
27 "string"
28 ],
29 "internalTeamIds": [
30 0
31 ],
32 "premiseAvailable": true,
33 "premiseFromNrm": true,
34 "nlmId": 0,
35 "nlmDisplayId": "string",
36 "nlmUsed": true,
37 "manager": 0,
38 "managerName": "string",
39 "imageId": 0,
40 "area": "string",
41 "modifiedAt": "2019-08-24T14:15:22Z"
42 },
43 "acquisitionDate": "2019-08-24",
44 "endOfLife": "2019-08-24",
45 "assetStatusId": 0,
46 "assetStatus": "string",
47 "assetStatusType": "string",
48 "parentAssetId": 0,
49 "parentAssetDisplayId": "string",
50 "parentAsset": "string",
51 "parentAssetDto": {},
52 "upcomingMaintenanceDate": "2019-08-24",
53 "assetCategoryIds": [
54 0
55 ],
56 "assetCategories": [
57 "string"
58 ],
59 "internalTeamIds": [
60 0
61 ],
62 "internalTeamDtos": [
63 {
64 "id": 0,
65 "createdBy": "string",
66 "createdAt": "2019-08-24T14:15:22Z",
67 "displayId": "string",
68 "name": "string",
69 "email": "string",
70 "phone": "string",
71 "manager": "string",
72 "requestCategoryName": [
73 "string"
74 ],
75 "requestCategoryId": [
76 0
77 ],
78 "requestCategoryDisplayId": [
79 "string"
80 ],
81 "description": "string",
82 "internalTeamUser": [
83 0
84 ],
85 "members": 0,
86 "mainAssets": [
87 0
88 ],
89 "premiseNames": [
90 "string"
91 ],
92 "internalTeamAvailable": true,
93 "premiseIds": [
94 0
95 ]
96 }
97 ],
98 "internalTeams": [
99 "string"
100 ],
101 "assignedUserIds": [
102 0
103 ],
104 "assignedUserDtos": [
105 {
106 "id": 0,
107 "createdBy": "string",
108 "createdAt": "2019-08-24T14:15:22Z",
109 "userName": "string",
110 "firstName": "string",
111 "lastName": "string",
112 "email": "string",
113 "roleIds": [
114 {
115 "id": 0,
116 "createdBy": "string",
117 "createdAt": "2019-08-24T14:15:22Z",
118 "modifiedBy": "string",
119 "modifiedAt": "2019-08-24T14:15:22Z",
120 "roleName": "string",
121 "entity": "string",
122 "new": true
123 }
124 ],
125 "internalTeamNames": [
126 "string"
127 ],
128 "internalTeamIds": [
129 0
130 ],
131 "internalTeamDisplayIds": [
132 "string"
133 ],
134 "premiseIds": [
135 0
136 ],
137 "premiseNames": [
138 "string"
139 ],
140 "userAvailable": true,
141 "temporaryWorkload": 0,
142 "preferredCultureCode": "string"
143 }
144 ],
145 "assignedUsers": [
146 "string"
147 ],
148 "assetPriority": "string",
149 "assetPriorityId": 0,
150 "assetPriorityDisplayId": "string",
151 "assetPriorityType": "string",
152 "assetAvailable": true,
153 "exactPlacement": "string",
154 "fosId": 0,
155 "downtimeStatus": "string",
156 "premiseFromNrm": true,
157 "modifiedAt": "2019-08-24T14:15:22Z"
158 }
159]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
false |
none |
Name of the resource |
» description |
string |
false |
none |
Description of the resource |
» qrCode |
string |
false |
none |
Code for the qr |
» barCode |
string |
false |
none |
Code for the bar |
» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
» model |
string |
false |
none |
Specifies the model associated with the main asset, providing essential context for asset classification and management. |
» manufacturer |
string |
false |
none |
Name of the manufacturer associated with the asset, providing essential information for inventory management and supplier relations. |
» serialNumber |
string |
false |
none |
Unique identifier for the asset, used to track and manage inventory within the system. |
» cost |
string |
false |
none |
Represents the total cost associated with the main asset, providing essential financial information for budgeting and resource allocation. |
» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
» premiseDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» premiseName |
string |
false |
none |
Name of the premise |
»» description |
string |
false |
none |
Description of the resource |
»» address |
string |
true |
none |
Represents the physical location associated with the premise, essential for logistics and service delivery. |
»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation within the organization. |
»» internalTeamIds |
[integer] |
false |
none |
List of unique identifiers representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation. |
»» premiseAvailable |
boolean |
false |
none |
Indicates whether the premise is available for use within the specified context. |
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the premise is sourced from the National Resource Management (NRM) framework, facilitating compliance and reporting within environmental management processes. |
»» nlmId |
integer(int64) |
false |
none |
Unique identifier for the nlm |
»» nlmDisplayId |
string |
false |
none |
Unique identifier for the nlm display |
»» nlmUsed |
boolean |
false |
none |
Indicates whether the National Labor Market (NLM) resources have been utilized in the premise evaluation process. |
»» manager |
integer(int64) |
false |
none |
Unique identifier for the manager associated with the premise, facilitating effective organizational hierarchy and resource management. |
»» managerName |
string |
false |
none |
Name of the manager |
»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»» area |
string |
false |
none |
Represents the geographic area associated with the premise, providing essential context for location-based services and analysis. |
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» acquisitionDate |
string(date) |
false |
none |
Date of the acquisition |
» endOfLife |
string(date) |
false |
none |
Indicates the end-of-life date for the asset, providing critical information for lifecycle management and planning. |
» assetStatusId |
integer(int64) |
false |
none |
Unique identifier for the asset status |
» assetStatus |
string |
false |
none |
Status of the asset |
» assetStatusType |
string |
false |
none |
Type of the asset status |
» parentAssetId |
integer(int64) |
false |
none |
Unique identifier for the parent asset |
» parentAssetDisplayId |
string |
false |
none |
Unique identifier for the parent asset display |
» parentAsset |
string |
false |
none |
Identifier for the parent asset associated with the main asset, facilitating hierarchical relationships within asset management. |
» parentAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
» upcomingMaintenanceDate |
string(date) |
false |
none |
Date of the upcoming maintenance |
» assetCategoryIds |
[integer] |
false |
none |
Array of unique identifiers representing the categories to which the asset belongs, facilitating effective asset classification and management. |
» assetCategories |
[string] |
false |
none |
Array of asset categories that classify the main assets within the system, facilitating better organization and management of asset data. |
» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the main asset, facilitating streamlined collaboration and resource allocation. |
» internalTeamDtos |
false |
none |
An array of MainAssetDTO objects representing the internal teams associated with the asset, facilitating effective resource management and collaboration within the organization. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» name |
string |
false |
none |
Name of the resource |
string |
false |
none |
Email address of the internal team member, used for communication and notifications within the organization. |
|
»» phone |
string |
false |
none |
Contact number for the internal team, facilitating communication and collaboration within the organization. |
»» manager |
string |
false |
none |
Represents the name or identifier of the team manager responsible for overseeing the internal team. |
»» requestCategoryName |
[string] |
false |
none |
Name of the request category |
»» requestCategoryId |
[integer] |
false |
none |
Unique identifier for the request category |
»» requestCategoryDisplayId |
[string] |
false |
none |
Unique identifier for the request category display |
»» description |
string |
false |
none |
Description of the resource |
»» internalTeamUser |
[integer] |
false |
none |
An array of InternalTeamDTO objects representing the users within the internal team, facilitating collaboration and resource management. |
»» members |
integer(int32) |
false |
none |
Represents the total number of members within the internal team, providing insight into team size for resource allocation and management. |
»» mainAssets |
[integer] |
false |
none |
An array of internal team assets that represent the key resources and capabilities utilized within the organization. |
»» premiseNames |
[string] |
false |
none |
List of names associated with the premises relevant to the internal team, facilitating efficient identification and management of locations within the organization. |
»» internalTeamAvailable |
boolean |
false |
none |
Indicates the availability of the internal team for project allocation and resource planning. |
»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the internal team. |
» internalTeams |
[string] |
false |
none |
An array of internal teams associated with the main asset, facilitating collaboration and resource allocation within the organization. |
» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers representing users assigned to the main asset, facilitating effective resource management and accountability. |
» assignedUserDtos |
false |
none |
Array of user assignments associated with the main asset, providing insights into resource allocation and accountability. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» userName |
string |
false |
none |
Name of the user |
»» firstName |
string |
false |
none |
Name of the first |
»» lastName |
string |
false |
none |
Name of the last |
string |
false |
none |
Email address of the user, used for communication and account verification purposes within the system. |
|
»» roleIds |
false |
none |
Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» modifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»»» roleName |
string |
false |
none |
Name of the role |
»»» entity |
string |
false |
none |
Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management. |
»»» new |
boolean |
false |
none |
Indicates whether the role is newly created within the system, facilitating effective management of organizational changes. |
»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization. |
»» internalTeamIds |
[integer] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization. |
»» internalTeamDisplayIds |
[string] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration. |
»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations. |
»» premiseNames |
[string] |
false |
none |
List of names associated with the user’s premises, providing essential context for location-based services and operations. |
»» userAvailable |
boolean |
false |
none |
Indicates whether the user is available for assignment or engagement within the system. |
»» temporaryWorkload |
integer(int32) |
false |
none |
Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning. |
»» preferredCultureCode |
string |
false |
none |
Code for the preferred culture |
» assignedUsers |
[string] |
false |
none |
List of users assigned to the main asset, facilitating effective resource management and collaboration within the organization. |
» assetPriority |
string |
false |
none |
Priority of the asset |
» assetPriorityId |
integer(int64) |
false |
none |
Unique identifier for the asset priority |
» assetPriorityDisplayId |
string |
false |
none |
Unique identifier for the asset priority display |
» assetPriorityType |
string |
false |
none |
Type of the asset priority |
» assetAvailable |
boolean |
false |
none |
Indicates whether the asset is currently available for allocation or use within the system. |
» exactPlacement |
string |
false |
none |
Specifies the precise location or context in which the main asset is intended to be utilized within the business framework. |
» fosId |
integer(int64) |
false |
none |
Unique identifier for the fos |
» downtimeStatus |
string |
false |
none |
Status of the downtime |
» premiseFromNrm |
boolean |
false |
none |
Indicates whether the asset is sourced from the National Resource Management (NRM) framework, facilitating compliance and resource tracking. |
» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
Get All Documents By Request¶
HTTP Request
GET /api/requests/{id}/documents
📋 Description: Retrieves documents associated with a specific request identified by the provided ID, enabling users to access relevant documentation for review and decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "name": "string",
7 "contentType": "string",
8 "documentTypeName": "string",
9 "documentTypeId": 0,
10 "description": "string",
11 "data": "string",
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "documentStatusId": 0,
15 "documentStatus": "string",
16 "documentStatusType": "string",
17 "parentEntityId": 0,
18 "link": "string",
19 "parentEntityName": "string"
20 }
21]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a document within the enterprise system, encapsulating essential attributes such as title, content, and metadata for effective document management and retrieval.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» name |
string |
false |
none |
Name of the resource |
» contentType |
string |
false |
none |
Type of the content |
» documentTypeName |
string |
false |
none |
Name of the document type |
» documentTypeId |
integer(int64) |
false |
none |
Unique identifier for the document type |
» description |
string |
false |
none |
Description of the resource |
» data |
string(byte) |
false |
none |
Contains the primary content of the document, providing essential information relevant to the associated business process. |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» endDate |
string(date) |
false |
none |
End date of the resource |
» documentStatusId |
integer(int64) |
false |
none |
Unique identifier for the document status |
» documentStatus |
string |
false |
none |
Status of the document |
» documentStatusType |
string |
false |
none |
Type of the document status |
» parentEntityId |
integer(int64) |
true |
none |
Unique identifier for the parent entity |
» link |
string |
false |
none |
URL reference to the associated document, facilitating easy access and retrieval within the system. |
» parentEntityName |
string |
true |
none |
Name of the parent entity |
Get All My Work Orders¶
HTTP Request
GET /api/requests/myRequests
📋 Description: Retrieves a list of requests submitted by the authenticated user, providing visibility into their current status and details for effective request 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 "description": "string",
8 "imageId": 0,
9 "premiseId": 0,
10 "premiseDto": {
11 "id": 0,
12 "createdBy": "string",
13 "createdAt": "2019-08-24T14:15:22Z",
14 "displayId": "string",
15 "premiseName": "string",
16 "description": "string",
17 "address": "string",
18 "internalTeamNames": [
19 "string"
20 ],
21 "internalTeamIds": [
22 0
23 ],
24 "premiseAvailable": true,
25 "premiseFromNrm": true,
26 "nlmId": 0,
27 "nlmDisplayId": "string",
28 "nlmUsed": true,
29 "manager": 0,
30 "managerName": "string",
31 "imageId": 0,
32 "area": "string",
33 "modifiedAt": "2019-08-24T14:15:22Z"
34 },
35 "premiseFromNrm": true,
36 "premiseDisplayId": "string",
37 "name": "string",
38 "requestPriority": "string",
39 "requestPriorityType": "string",
40 "requestPriorityId": 0,
41 "requestPriorityDisplayId": "string",
42 "requestDate": "2019-08-24",
43 "modifiedAt": "2019-08-24T14:15:22Z",
44 "requestCategory": "string",
45 "requestCategoryId": 0,
46 "requestCategoryDisplayId": "string",
47 "requestStatus": "string",
48 "requestStatusType": "string",
49 "requestStatusId": 0,
50 "requestStatusDisplayId": "string",
51 "mainAssetIds": [
52 0
53 ],
54 "mainAssetId": 0,
55 "mainAssetDto": {
56 "id": 0,
57 "createdBy": "string",
58 "createdAt": "2019-08-24T14:15:22Z",
59 "displayId": "string",
60 "name": "string",
61 "description": "string",
62 "qrCode": "string",
63 "barCode": "string",
64 "imageId": 0,
65 "model": "string",
66 "manufacturer": "string",
67 "serialNumber": "string",
68 "cost": "81.08",
69 "premiseId": 0,
70 "premiseDisplayId": "string",
71 "premiseDto": {
72 "id": 0,
73 "createdBy": "string",
74 "createdAt": "2019-08-24T14:15:22Z",
75 "displayId": "string",
76 "premiseName": "string",
77 "description": "string",
78 "address": "string",
79 "internalTeamNames": [
80 "string"
81 ],
82 "internalTeamIds": [
83 0
84 ],
85 "premiseAvailable": true,
86 "premiseFromNrm": true,
87 "nlmId": 0,
88 "nlmDisplayId": "string",
89 "nlmUsed": true,
90 "manager": 0,
91 "managerName": "string",
92 "imageId": 0,
93 "area": "string",
94 "modifiedAt": "2019-08-24T14:15:22Z"
95 },
96 "acquisitionDate": "2019-08-24",
97 "endOfLife": "2019-08-24",
98 "assetStatusId": 0,
99 "assetStatus": "string",
100 "assetStatusType": "string",
101 "parentAssetId": 0,
102 "parentAssetDisplayId": "string",
103 "parentAsset": "string",
104 "parentAssetDto": {},
105 "upcomingMaintenanceDate": "2019-08-24",
106 "assetCategoryIds": [
107 0
108 ],
109 "assetCategories": [
110 "string"
111 ],
112 "internalTeamIds": [
113 0
114 ],
115 "internalTeamDtos": [
116 {
117 "id": 0,
118 "createdBy": "string",
119 "createdAt": "2019-08-24T14:15:22Z",
120 "displayId": "string",
121 "name": "string",
122 "email": "string",
123 "phone": "string",
124 "manager": "string",
125 "requestCategoryName": [
126 "string"
127 ],
128 "requestCategoryId": [
129 0
130 ],
131 "requestCategoryDisplayId": [
132 "string"
133 ],
134 "description": "string",
135 "internalTeamUser": [
136 0
137 ],
138 "members": 0,
139 "mainAssets": [
140 0
141 ],
142 "premiseNames": [
143 "string"
144 ],
145 "internalTeamAvailable": true,
146 "premiseIds": [
147 0
148 ]
149 }
150 ],
151 "internalTeams": [
152 "string"
153 ],
154 "assignedUserIds": [
155 0
156 ],
157 "assignedUserDtos": [
158 {
159 "id": 0,
160 "createdBy": "string",
161 "createdAt": "2019-08-24T14:15:22Z",
162 "userName": "string",
163 "firstName": "string",
164 "lastName": "string",
165 "email": "string",
166 "roleIds": [
167 {
168 "id": 0,
169 "createdBy": "string",
170 "createdAt": "2019-08-24T14:15:22Z",
171 "modifiedBy": "string",
172 "modifiedAt": "2019-08-24T14:15:22Z",
173 "roleName": "string",
174 "entity": "string",
175 "new": true
176 }
177 ],
178 "internalTeamNames": [
179 "string"
180 ],
181 "internalTeamIds": [
182 0
183 ],
184 "internalTeamDisplayIds": [
185 "string"
186 ],
187 "premiseIds": [
188 0
189 ],
190 "premiseNames": [
191 "string"
192 ],
193 "userAvailable": true,
194 "temporaryWorkload": 0,
195 "preferredCultureCode": "string"
196 }
197 ],
198 "assignedUsers": [
199 "string"
200 ],
201 "assetPriority": "string",
202 "assetPriorityId": 0,
203 "assetPriorityDisplayId": "string",
204 "assetPriorityType": "string",
205 "assetAvailable": true,
206 "exactPlacement": "string",
207 "fosId": 0,
208 "downtimeStatus": "string",
209 "premiseFromNrm": true,
210 "modifiedAt": "2019-08-24T14:15:22Z"
211 },
212 "mainAssetDisplayId": "string",
213 "assignedUserIds": [
214 0
215 ],
216 "assignedUserDtos": [
217 {
218 "id": 0,
219 "createdBy": "string",
220 "createdAt": "2019-08-24T14:15:22Z",
221 "userName": "string",
222 "firstName": "string",
223 "lastName": "string",
224 "email": "string",
225 "roleIds": [
226 {
227 "id": 0,
228 "createdBy": "string",
229 "createdAt": "2019-08-24T14:15:22Z",
230 "modifiedBy": "string",
231 "modifiedAt": "2019-08-24T14:15:22Z",
232 "roleName": "string",
233 "entity": "string",
234 "new": true
235 }
236 ],
237 "internalTeamNames": [
238 "string"
239 ],
240 "internalTeamIds": [
241 0
242 ],
243 "internalTeamDisplayIds": [
244 "string"
245 ],
246 "premiseIds": [
247 0
248 ],
249 "premiseNames": [
250 "string"
251 ],
252 "userAvailable": true,
253 "temporaryWorkload": 0,
254 "preferredCultureCode": "string"
255 }
256 ],
257 "assignedUsers": [
258 "string"
259 ],
260 "internalTeamIds": [
261 0
262 ],
263 "internalTeamDtos": [
264 {
265 "id": 0,
266 "createdBy": "string",
267 "createdAt": "2019-08-24T14:15:22Z",
268 "displayId": "string",
269 "name": "string",
270 "email": "string",
271 "phone": "string",
272 "manager": "string",
273 "requestCategoryName": [
274 "string"
275 ],
276 "requestCategoryId": [
277 0
278 ],
279 "requestCategoryDisplayId": [
280 "string"
281 ],
282 "description": "string",
283 "internalTeamUser": [
284 0
285 ],
286 "members": 0,
287 "mainAssets": [
288 0
289 ],
290 "premiseNames": [
291 "string"
292 ],
293 "internalTeamAvailable": true,
294 "premiseIds": [
295 0
296 ]
297 }
298 ],
299 "internalTeams": [
300 "string"
301 ],
302 "requestAvailable": true,
303 "exactPlacement": "string",
304 "requestType": "string",
305 "closeDate": "2019-08-24",
306 "requestFrom": "NFM"
307 }
308]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a client request, encapsulating essential details such as request type, priority, and associated metadata to facilitate efficient processing and tracking within the business workflow.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» description |
string |
false |
none |
Description of the resource |
» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
» premiseDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» premiseName |
string |
false |
none |
Name of the premise |
»» description |
string |
false |
none |
Description of the resource |
»» address |
string |
true |
none |
Represents the physical location associated with the premise, essential for logistics and service delivery. |
»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation within the organization. |
»» internalTeamIds |
[integer] |
false |
none |
List of unique identifiers representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation. |
»» premiseAvailable |
boolean |
false |
none |
Indicates whether the premise is available for use within the specified context. |
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the premise is sourced from the National Resource Management (NRM) framework, facilitating compliance and reporting within environmental management processes. |
»» nlmId |
integer(int64) |
false |
none |
Unique identifier for the nlm |
»» nlmDisplayId |
string |
false |
none |
Unique identifier for the nlm display |
»» nlmUsed |
boolean |
false |
none |
Indicates whether the National Labor Market (NLM) resources have been utilized in the premise evaluation process. |
»» manager |
integer(int64) |
false |
none |
Unique identifier for the manager associated with the premise, facilitating effective organizational hierarchy and resource management. |
»» managerName |
string |
false |
none |
Name of the manager |
»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»» area |
string |
false |
none |
Represents the geographic area associated with the premise, providing essential context for location-based services and analysis. |
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» premiseFromNrm |
boolean |
false |
none |
Indicates whether the premise is sourced from the National Resource Management (NRM) system, facilitating accurate data integration and reporting. |
» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
» name |
string |
false |
none |
Name of the resource |
» requestPriority |
string |
false |
none |
Priority of the request |
» requestPriorityType |
string |
false |
none |
Type of the request priority |
» requestPriorityId |
integer(int64) |
false |
none |
Unique identifier for the request priority |
» requestPriorityDisplayId |
string |
false |
none |
Unique identifier for the request priority display |
» requestDate |
string(date) |
false |
none |
Date of the request |
» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» requestCategory |
string |
false |
none |
Category of the request |
» requestCategoryId |
integer(int64) |
false |
none |
Unique identifier for the request category |
» requestCategoryDisplayId |
string |
false |
none |
Unique identifier for the request category display |
» requestStatus |
string |
false |
none |
Status of the request |
» requestStatusType |
string |
false |
none |
Type of the request status |
» requestStatusId |
integer(int64) |
false |
none |
Unique identifier for the request status |
» requestStatusDisplayId |
string |
false |
none |
Unique identifier for the request status display |
» mainAssetIds |
[integer] |
false |
none |
List of unique identifiers for the primary assets associated with the request, facilitating efficient tracking and management within the system. |
» mainAssetId |
integer(int64) |
false |
none |
Unique identifier for the main asset |
» mainAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» name |
string |
false |
none |
Name of the resource |
»» description |
string |
false |
none |
Description of the resource |
»» qrCode |
string |
false |
none |
Code for the qr |
»» barCode |
string |
false |
none |
Code for the bar |
»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»» model |
string |
false |
none |
Specifies the model associated with the main asset, providing essential context for asset classification and management. |
»» manufacturer |
string |
false |
none |
Name of the manufacturer associated with the asset, providing essential information for inventory management and supplier relations. |
»» serialNumber |
string |
false |
none |
Unique identifier for the asset, used to track and manage inventory within the system. |
»» cost |
string |
false |
none |
Represents the total cost associated with the main asset, providing essential financial information for budgeting and resource allocation. |
»» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
»» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
»» premiseDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
»» acquisitionDate |
string(date) |
false |
none |
Date of the acquisition |
»» endOfLife |
string(date) |
false |
none |
Indicates the end-of-life date for the asset, providing critical information for lifecycle management and planning. |
»» assetStatusId |
integer(int64) |
false |
none |
Unique identifier for the asset status |
»» assetStatus |
string |
false |
none |
Status of the asset |
»» assetStatusType |
string |
false |
none |
Type of the asset status |
»» parentAssetId |
integer(int64) |
false |
none |
Unique identifier for the parent asset |
»» parentAssetDisplayId |
string |
false |
none |
Unique identifier for the parent asset display |
»» parentAsset |
string |
false |
none |
Identifier for the parent asset associated with the main asset, facilitating hierarchical relationships within asset management. |
»» parentAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»» upcomingMaintenanceDate |
string(date) |
false |
none |
Date of the upcoming maintenance |
»» assetCategoryIds |
[integer] |
false |
none |
Array of unique identifiers representing the categories to which the asset belongs, facilitating effective asset classification and management. |
»» assetCategories |
[string] |
false |
none |
Array of asset categories that classify the main assets within the system, facilitating better organization and management of asset data. |
»» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the main asset, facilitating streamlined collaboration and resource allocation. |
»» internalTeamDtos |
false |
none |
An array of MainAssetDTO objects representing the internal teams associated with the asset, facilitating effective resource management and collaboration within the organization. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» name |
string |
false |
none |
Name of the resource |
string |
false |
none |
Email address of the internal team member, used for communication and notifications within the organization. |
|
»»» phone |
string |
false |
none |
Contact number for the internal team, facilitating communication and collaboration within the organization. |
»»» manager |
string |
false |
none |
Represents the name or identifier of the team manager responsible for overseeing the internal team. |
»»» requestCategoryName |
[string] |
false |
none |
Name of the request category |
»»» requestCategoryId |
[integer] |
false |
none |
Unique identifier for the request category |
»»» requestCategoryDisplayId |
[string] |
false |
none |
Unique identifier for the request category display |
»»» description |
string |
false |
none |
Description of the resource |
»»» internalTeamUser |
[integer] |
false |
none |
An array of InternalTeamDTO objects representing the users within the internal team, facilitating collaboration and resource management. |
»»» members |
integer(int32) |
false |
none |
Represents the total number of members within the internal team, providing insight into team size for resource allocation and management. |
»»» mainAssets |
[integer] |
false |
none |
An array of internal team assets that represent the key resources and capabilities utilized within the organization. |
»»» premiseNames |
[string] |
false |
none |
List of names associated with the premises relevant to the internal team, facilitating efficient identification and management of locations within the organization. |
»»» internalTeamAvailable |
boolean |
false |
none |
Indicates the availability of the internal team for project allocation and resource planning. |
»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the internal team. |
»» internalTeams |
[string] |
false |
none |
An array of internal teams associated with the main asset, facilitating collaboration and resource allocation within the organization. |
»» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers representing users assigned to the main asset, facilitating effective resource management and accountability. |
»» assignedUserDtos |
false |
none |
Array of user assignments associated with the main asset, providing insights into resource allocation and accountability. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» userName |
string |
false |
none |
Name of the user |
»»» firstName |
string |
false |
none |
Name of the first |
»»» lastName |
string |
false |
none |
Name of the last |
string |
false |
none |
Email address of the user, used for communication and account verification purposes within the system. |
|
»»» roleIds |
false |
none |
Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»»» modifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»»»» roleName |
string |
false |
none |
Name of the role |
»»»» entity |
string |
false |
none |
Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management. |
»»»» new |
boolean |
false |
none |
Indicates whether the role is newly created within the system, facilitating effective management of organizational changes. |
»»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization. |
»»» internalTeamIds |
[integer] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization. |
»»» internalTeamDisplayIds |
[string] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration. |
»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations. |
»»» premiseNames |
[string] |
false |
none |
List of names associated with the user’s premises, providing essential context for location-based services and operations. |
»»» userAvailable |
boolean |
false |
none |
Indicates whether the user is available for assignment or engagement within the system. |
»»» temporaryWorkload |
integer(int32) |
false |
none |
Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning. |
»»» preferredCultureCode |
string |
false |
none |
Code for the preferred culture |
»» assignedUsers |
[string] |
false |
none |
List of users assigned to the main asset, facilitating effective resource management and collaboration within the organization. |
»» assetPriority |
string |
false |
none |
Priority of the asset |
»» assetPriorityId |
integer(int64) |
false |
none |
Unique identifier for the asset priority |
»» assetPriorityDisplayId |
string |
false |
none |
Unique identifier for the asset priority display |
»» assetPriorityType |
string |
false |
none |
Type of the asset priority |
»» assetAvailable |
boolean |
false |
none |
Indicates whether the asset is currently available for allocation or use within the system. |
»» exactPlacement |
string |
false |
none |
Specifies the precise location or context in which the main asset is intended to be utilized within the business framework. |
»» fosId |
integer(int64) |
false |
none |
Unique identifier for the fos |
»» downtimeStatus |
string |
false |
none |
Status of the downtime |
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the asset is sourced from the National Resource Management (NRM) framework, facilitating compliance and resource tracking. |
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» mainAssetDisplayId |
string |
false |
none |
Unique identifier for the main asset display |
» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers representing the users assigned to the specific task or project within the system. |
» assignedUserDtos |
false |
none |
Array of user assignments that delineates the individuals responsible for managing the associated tasks within the request. |
|
» assignedUsers |
[string] |
false |
none |
List of users assigned to the request, facilitating effective task management and collaboration within the organization. |
» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the request, facilitating effective team management and collaboration. |
» internalTeamDtos |
false |
none |
An array of RequestDTO objects representing the internal teams involved in the project, facilitating collaboration and resource allocation. |
|
» internalTeams |
[string] |
false |
none |
List of internal teams involved in the project, facilitating collaboration and resource allocation. |
» requestAvailable |
boolean |
false |
none |
Indicates whether the requested resource is available for allocation within the system. |
» exactPlacement |
string |
false |
none |
Specifies the precise location or context for the placement of resources within the operational framework. |
» requestType |
string |
false |
none |
Type of the request |
» closeDate |
string(date) |
false |
none |
Date of the close |
» requestFrom |
string |
false |
none |
Identifies the origin of the request, providing context for processing and tracking within the system. |
Enumerated Values
Attribute |
Value |
|---|---|
requestFrom |
NFM, PORTAL |
Get All Active Request Status Type IDs¶
HTTP Request
GET /api/requests/allActiveRequestStatusTypes
📋 Description: Retrieves all active request status types, providing essential information for tracking and managing ongoing requests within the system.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]
Response Schema
Get All Active Request Priority Type IDs¶
HTTP Request
GET /api/requests/allActiveRequestPriorityTypes
📋 Description: Retrieves a list of all active request priority types, enabling users to assess and manage request prioritization effectively within the system.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]
Response Schema
Get All Active Request Category Type IDs¶
HTTP Request
GET /api/requests/allActiveRequestCategoryTypes
📋 Description: Retrieves a comprehensive list of all active request category types, enabling users to efficiently manage and categorize ongoing requests within the system.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]