Main Asset Resource¶
Get Main Asset¶
HTTP Request
GET /api/mainAssets/{id}
📋 Description: Retrieves detailed information about a specific main asset identified by the provided ID, enabling users to access essential asset data for informed 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 |
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}
Update Main Asset¶
HTTP Request
PUT /api/mainAssets/{id}
📋 Description: Updates the details of a specified main asset, allowing for modifications to its attributes to reflect current business needs and operational changes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated asset information, including attributes such as name, description, and status, necessary for maintaining accurate asset records. |
Body Parameters
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}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Main Asset¶
HTTP Request
DELETE /api/mainAssets/{id}
📋 Description: Deletes a specified main asset from the system, ensuring that all associated data is removed and maintaining data integrity within the asset management framework.
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 |
Update Barcode Value¶
HTTP Request
PUT /api/mainAssets/updateBarcode/{id}
📋 Description: Updates the barcode information for a specified main asset, identified by its unique ID, ensuring accurate inventory management and tracking within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated barcode information and associated metadata for the main asset identified by the specified ID. |
Body Parameters
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}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Online Main Asset¶
HTTP Request
PUT /api/mainAssets/online/{id}
📋 Description: Updates the status of a specified main asset to online, allowing businesses to manage asset availability effectively. This operation ensures that assets are accurately reflected in the system for operational efficiency.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
object |
false |
Request body containing the updated asset information, including attributes such as status, description, and allocation details, necessary for managing online asset records. |
» mainAsset |
body |
true |
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 |
body |
integer(int64) |
false |
Unique identifier for the resource |
»» createdBy |
body |
string |
false |
Username of who created this resource |
»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»» displayId |
body |
string |
false |
Unique identifier for the display |
»» name |
body |
string |
false |
Name of the resource |
»» description |
body |
string |
false |
Description of the resource |
»» qrCode |
body |
string |
false |
Code for the qr |
»» barCode |
body |
string |
false |
Code for the bar |
»» imageId |
body |
integer(int64) |
false |
Unique identifier for the image |
»» model |
body |
string |
false |
Specifies the model associated with the main asset, providing essential context for asset classification and management. |
»» manufacturer |
body |
string |
false |
Name of the manufacturer associated with the asset, providing essential information for inventory management and supplier relations. |
»» serialNumber |
body |
string |
false |
Unique identifier for the asset, used to track and manage inventory within the system. |
»» cost |
body |
string |
false |
Represents the total cost associated with the main asset, providing essential financial information for budgeting and resource allocation. |
»» premiseId |
body |
integer(int64) |
false |
Unique identifier for the premise |
»» premiseDisplayId |
body |
string |
false |
Unique identifier for the premise display |
»» premiseDto |
body |
false |
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 |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»» premiseName |
body |
string |
false |
Name of the premise |
»»» description |
body |
string |
false |
Description of the resource |
»»» address |
body |
string |
true |
Represents the physical location associated with the premise, essential for logistics and service delivery. |
»»» internalTeamNames |
body |
[string] |
false |
List of names representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation within the organization. |
»»» internalTeamIds |
body |
[integer] |
false |
List of unique identifiers representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation. |
»»» premiseAvailable |
body |
boolean |
false |
Indicates whether the premise is available for use within the specified context. |
»»» premiseFromNrm |
body |
boolean |
false |
Indicates whether the premise is sourced from the National Resource Management (NRM) framework, facilitating compliance and reporting within environmental management processes. |
»»» nlmId |
body |
integer(int64) |
false |
Unique identifier for the nlm |
»»» nlmDisplayId |
body |
string |
false |
Unique identifier for the nlm display |
»»» nlmUsed |
body |
boolean |
false |
Indicates whether the National Labor Market (NLM) resources have been utilized in the premise evaluation process. |
»»» manager |
body |
integer(int64) |
false |
Unique identifier for the manager associated with the premise, facilitating effective organizational hierarchy and resource management. |
»»» managerName |
body |
string |
false |
Name of the manager |
»»» imageId |
body |
integer(int64) |
false |
Unique identifier for the image |
»»» area |
body |
string |
false |
Represents the geographic area associated with the premise, providing essential context for location-based services and analysis. |
»»» modifiedAt |
body |
string(date-time) |
false |
Timestamp when this resource was last modified |
»» acquisitionDate |
body |
string(date) |
false |
Date of the acquisition |
»» endOfLife |
body |
string(date) |
false |
Indicates the end-of-life date for the asset, providing critical information for lifecycle management and planning. |
»» assetStatusId |
body |
integer(int64) |
false |
Unique identifier for the asset status |
»» assetStatus |
body |
string |
false |
Status of the asset |
»» assetStatusType |
body |
string |
false |
Type of the asset status |
»» parentAssetId |
body |
integer(int64) |
false |
Unique identifier for the parent asset |
»» parentAssetDisplayId |
body |
string |
false |
Unique identifier for the parent asset display |
»» parentAsset |
body |
string |
false |
Identifier for the parent asset associated with the main asset, facilitating hierarchical relationships within asset management. |
»» parentAssetDto |
body |
false |
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 |
body |
string(date) |
false |
Date of the upcoming maintenance |
»» assetCategoryIds |
body |
[integer] |
false |
Array of unique identifiers representing the categories to which the asset belongs, facilitating effective asset classification and management. |
»» assetCategories |
body |
[string] |
false |
Array of asset categories that classify the main assets within the system, facilitating better organization and management of asset data. |
»» internalTeamIds |
body |
[integer] |
false |
Array of unique identifiers representing the internal teams associated with the main asset, facilitating streamlined collaboration and resource allocation. |
»» internalTeamDtos |
body |
false |
An array of MainAssetDTO objects representing the internal teams associated with the asset, facilitating effective resource management and collaboration within the organization. |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»» name |
body |
string |
false |
Name of the resource |
body |
string |
false |
Email address of the internal team member, used for communication and notifications within the organization. |
|
»»» phone |
body |
string |
false |
Contact number for the internal team, facilitating communication and collaboration within the organization. |
»»» manager |
body |
string |
false |
Represents the name or identifier of the team manager responsible for overseeing the internal team. |
»»» requestCategoryName |
body |
[string] |
false |
Name of the request category |
»»» requestCategoryId |
body |
[integer] |
false |
Unique identifier for the request category |
»»» requestCategoryDisplayId |
body |
[string] |
false |
Unique identifier for the request category display |
»»» description |
body |
string |
false |
Description of the resource |
»»» internalTeamUser |
body |
[integer] |
false |
An array of InternalTeamDTO objects representing the users within the internal team, facilitating collaboration and resource management. |
»»» members |
body |
integer(int32) |
false |
Represents the total number of members within the internal team, providing insight into team size for resource allocation and management. |
»»» mainAssets |
body |
[integer] |
false |
An array of internal team assets that represent the key resources and capabilities utilized within the organization. |
»»» premiseNames |
body |
[string] |
false |
List of names associated with the premises relevant to the internal team, facilitating efficient identification and management of locations within the organization. |
»»» internalTeamAvailable |
body |
boolean |
false |
Indicates the availability of the internal team for project allocation and resource planning. |
»»» premiseIds |
body |
[integer] |
false |
Array of unique identifiers representing the premises associated with the internal team. |
»» internalTeams |
body |
[string] |
false |
An array of internal teams associated with the main asset, facilitating collaboration and resource allocation within the organization. |
»» assignedUserIds |
body |
[integer] |
false |
Array of unique identifiers representing users assigned to the main asset, facilitating effective resource management and accountability. |
»» assignedUserDtos |
body |
false |
Array of user assignments associated with the main asset, providing insights into resource allocation and accountability. |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»»» userName |
body |
string |
false |
Name of the user |
»»» firstName |
body |
string |
false |
Name of the first |
»»» lastName |
body |
string |
false |
Name of the last |
body |
string |
false |
Email address of the user, used for communication and account verification purposes within the system. |
|
»»» roleIds |
body |
false |
Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system. |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»»»» modifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»»» modifiedAt |
body |
string(date-time) |
false |
Timestamp when this resource was last modified |
»»»» roleName |
body |
string |
false |
Name of the role |
»»»» entity |
body |
string |
false |
Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management. |
»»»» new |
body |
boolean |
false |
Indicates whether the role is newly created within the system, facilitating effective management of organizational changes. |
»»» internalTeamNames |
body |
[string] |
false |
List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization. |
»»» internalTeamIds |
body |
[integer] |
false |
An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization. |
»»» internalTeamDisplayIds |
body |
[string] |
false |
An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration. |
»»» premiseIds |
body |
[integer] |
false |
Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations. |
»»» premiseNames |
body |
[string] |
false |
List of names associated with the user’s premises, providing essential context for location-based services and operations. |
»»» userAvailable |
body |
boolean |
false |
Indicates whether the user is available for assignment or engagement within the system. |
»»» temporaryWorkload |
body |
integer(int32) |
false |
Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning. |
»»» preferredCultureCode |
body |
string |
false |
Code for the preferred culture |
»» assignedUsers |
body |
[string] |
false |
List of users assigned to the main asset, facilitating effective resource management and collaboration within the organization. |
»» assetPriority |
body |
string |
false |
Priority of the asset |
»» assetPriorityId |
body |
integer(int64) |
false |
Unique identifier for the asset priority |
»» assetPriorityDisplayId |
body |
string |
false |
Unique identifier for the asset priority display |
»» assetPriorityType |
body |
string |
false |
Type of the asset priority |
»» assetAvailable |
body |
boolean |
false |
Indicates whether the asset is currently available for allocation or use within the system. |
»» exactPlacement |
body |
string |
false |
Specifies the precise location or context in which the main asset is intended to be utilized within the business framework. |
»» fosId |
body |
integer(int64) |
false |
Unique identifier for the fos |
»» downtimeStatus |
body |
string |
false |
Status of the downtime |
»» premiseFromNrm |
body |
boolean |
false |
Indicates whether the asset is sourced from the National Resource Management (NRM) framework, facilitating compliance and resource tracking. |
»» modifiedAt |
body |
string(date-time) |
false |
Timestamp when this resource was last modified |
» selectedWorkOrder |
body |
false |
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 |
body |
integer(int64) |
false |
Unique identifier for the resource |
»» createdBy |
body |
string |
false |
Username of who created this resource |
»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»» displayId |
body |
string |
false |
Unique identifier for the display |
»» name |
body |
string |
false |
Name of the resource |
»» imageId |
body |
integer(int64) |
false |
Unique identifier for the image |
»» description |
body |
string |
false |
Description of the resource |
»» vendorRating |
body |
integer(int32) |
false |
Represents the numerical rating assigned to a vendor, reflecting their performance and reliability in fulfilling work orders. |
»» premiseId |
body |
integer(int64) |
false |
Unique identifier for the premise |
»» premiseDto |
body |
false |
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. |
|
»» premiseFromNrm |
body |
boolean |
false |
Indicates whether the work order is derived from the National Resource Management system. |
»» premiseDisplayId |
body |
string |
false |
Unique identifier for the premise display |
»» nssProjectId |
body |
integer(int64) |
false |
Unique identifier for the nss project |
»» nssTaskId |
body |
integer(int64) |
false |
Unique identifier for the nss task |
»» nssTaskDisplayId |
body |
string |
false |
Unique identifier for the nss task display |
»» orderDate |
body |
string(date) |
false |
Date of the order |
»» dueDate |
body |
string(date) |
false |
Due date of the resource |
»» startDate |
body |
string(date) |
false |
Start date of the resource |
»» endDate |
body |
string(date) |
false |
End date of the resource |
»» startTime |
body |
false |
Data transfer object representing the local time settings relevant to business operations, ensuring accurate scheduling and time management across various regions. |
|
»»» hour |
body |
integer(int32) |
false |
Represents the hour component of a time value, facilitating precise scheduling and time management within the application. |
»»» minute |
body |
integer(int32) |
false |
Represents the minute component of a local time value, facilitating precise time tracking and scheduling within the application. |
»»» second |
body |
integer(int32) |
false |
Represents the seconds component of a local time value, facilitating precise time tracking and scheduling within the application. |
»»» nano |
body |
integer(int32) |
false |
Represents the nanosecond component of a local time value, facilitating precise time tracking and scheduling within the application. |
»» endTime |
body |
false |
Data transfer object representing the local time settings relevant to business operations, ensuring accurate scheduling and time management across various regions. |
|
»» modifiedAt |
body |
string(date-time) |
false |
Timestamp when this resource was last modified |
»» estimatedCost |
body |
string |
false |
Estimated cost associated with the work order, providing a financial projection for budgeting and resource allocation. |
»» finalCost |
body |
string |
false |
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 |
body |
integer(int32) |
false |
Represents the total time, in minutes, allocated for the completion of the work order. |
»» estimatedDayTime |
body |
integer(int32) |
false |
Time of the estimated day |
»» finalHourTime |
body |
string |
false |
Time of the final hour |
»» estimatedHourTime |
body |
string |
false |
Time of the estimated hour |
»» closeDate |
body |
string(date) |
false |
Date of the close |
»» inspection |
body |
string |
false |
Describes the specific inspection details associated with the work order, ensuring clarity in task requirements and compliance standards. |
»» workOrderTypeId |
body |
integer(int64) |
false |
Unique identifier for the work order type |
»» workOrderTypeName |
body |
string |
false |
Name of the work order type |
»» workOrderType |
body |
string |
false |
Type of the work order |
»» workOrderPriorityId |
body |
integer(int64) |
false |
Unique identifier for the work order priority |
»» workOrderPriority |
body |
string |
false |
Priority of the work order |
»» workOrderPriorityType |
body |
string |
false |
Type of the work order priority |
»» isTemplate |
body |
boolean |
false |
Whether the resource is template |
»» isWorkOrderTemplate |
body |
boolean |
false |
Whether the resource is work order template |
»» templateId |
body |
integer(int64) |
false |
Unique identifier for the template |
»» isPartsInSufficient |
body |
boolean |
false |
Whether the resource is parts in sufficient |
»» partQuantityInfoList |
body |
false |
List of quantities for each part associated with the work order, providing essential details for inventory management and resource allocation. |
|
»»» partId |
body |
integer(int64) |
false |
Unique identifier for the part |
»»» partDisplayId |
body |
string |
false |
Unique identifier for the part display |
»»» requestedQuantity |
body |
integer(int64) |
false |
Quantity of requested quantity |
»»» availableQuantity |
body |
integer(int64) |
false |
Quantity of available quantity |
»»» usedQuantity |
body |
integer(int64) |
false |
Quantity of used quantity |
»»» sufficient |
body |
boolean |
false |
Indicates whether the quantity of parts available meets the required threshold for operational needs. |
»»» partial |
body |
boolean |
false |
Indicates whether the quantity of parts is partially fulfilled, providing insight into inventory status and order fulfillment. |
»» parentWorkOrderId |
body |
integer(int64) |
false |
Unique identifier for the parent work order |
»» parentWorkOrderDisplayId |
body |
string |
false |
Unique identifier for the parent work order display |
»» parentWorkOrder |
body |
string |
false |
Identifier for the parent work order, establishing a hierarchical relationship within the work order management system. |
»» mainAssetIds |
body |
[integer] |
false |
Array of unique identifiers for the primary assets associated with the work order, facilitating effective asset management and tracking. |
»» mainAssetDto |
body |
false |
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. |
|
»» mainAssetDisplayId |
body |
string |
false |
Unique identifier for the main asset display |
»» workOrderStatusId |
body |
integer(int64) |
false |
Unique identifier for the work order status |
»» workOrderStatus |
body |
string |
false |
Status of the work order |
»» workOrderStatusType |
body |
string |
false |
Type of the work order status |
»» requestIds |
body |
[integer] |
false |
An array of unique identifiers for the associated work orders, facilitating tracking and management within the system. |
»» internalTeamIds |
body |
[integer] |
false |
List of unique identifiers representing the internal teams associated with the work order, facilitating effective resource allocation and collaboration. |
»» internalTeamDtos |
body |
false |
An array of WorkOrderDTO objects representing the internal teams associated with the work order, facilitating efficient resource allocation and management. |
|
»» internalTeams |
body |
[string] |
false |
List of internal teams associated with the work order, facilitating collaboration and resource allocation within the organization. |
»» vendorId |
body |
integer(int64) |
false |
Unique identifier for the vendor |
»» vendorDto |
body |
false |
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 |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»» name |
body |
string |
false |
Name of the resource |
»»» description |
body |
string |
false |
Description of the resource |
»»» address |
body |
string |
false |
Represents the physical location of the vendor, essential for logistical coordination and service delivery. |
»»» contractEndDate |
body |
string(date) |
false |
Date of the contract end |
»»» services |
body |
string |
false |
Represents the list of services offered by the vendor, essential for evaluating vendor capabilities and aligning them with business needs. |
»»» vendorType |
body |
string |
false |
Type of the vendor |
»»» vendorStatusId |
body |
integer(int64) |
false |
Unique identifier for the vendor status |
»»» vendorStatus |
body |
string |
false |
Status of the vendor |
»»» vendorStatusType |
body |
string |
false |
Type of the vendor status |
»»» businessTypeId |
body |
integer(int64) |
false |
Unique identifier for the business type |
»»» businessType |
body |
string |
false |
Type of the business |
»»» vendorRateId |
body |
integer(int64) |
false |
Unique identifier for the vendor rate |
»»» vendorRate |
body |
string |
false |
Rate of vendor |
»»» vendorContactIds |
body |
[integer] |
false |
Array of unique identifiers for vendor contacts associated with the vendor, facilitating streamlined communication and management of vendor relationships. |
»»» premiseIds |
body |
[integer] |
false |
Array of unique identifiers representing the premises associated with the vendor, facilitating streamlined management and tracking of vendor relationships. |
»»» firstPremiseDisplayId |
body |
string |
false |
Unique identifier for the first premise display |
»»» ownerUserName |
body |
string |
false |
Name of the owner user |
»»» ownerDto |
body |
false |
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 |
body |
boolean |
false |
Indicates whether the vendor is currently available for new engagements. |
»»» vendorRating |
body |
number(double) |
false |
Numeric representation of the vendor’s performance rating, used to assess and compare vendor quality within the procurement process. |
»»» premiseDisplayIds |
body |
[string] |
false |
Array of unique identifiers for the premises associated with the vendor, facilitating streamlined management and reference within the system. |
»» vendorName |
body |
string |
false |
Name of the vendor |
»» workOrderTemplateSettings |
body |
false |
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 |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»»» workOrderId |
body |
integer(int64) |
false |
Unique identifier for the work order |
»»» startDate |
body |
string(date) |
false |
Start date of the resource |
»»» dueDuration |
body |
integer(int32) |
false |
Specifies the duration, in minutes, for which a work order is due, facilitating effective scheduling and resource allocation. |
»»» dueMonths |
body |
integer(int32) |
false |
Specifies the number of months until the work order is due, facilitating effective scheduling and resource allocation. |
»»» endDate |
body |
string(date) |
false |
End date of the resource |
»»» recurringWOPriorityId |
body |
integer(int64) |
false |
Unique identifier for the recurring w o priority |
»»» recurringWOPriority |
body |
string |
false |
Priority of the recurring w o |
»»» recurringWOPriorityType |
body |
string |
false |
Type of the recurring w o priority |
»»» isTemplate |
body |
boolean |
false |
Whether the resource is template |
»»» isRemoveByDate |
body |
boolean |
false |
Whether the resource is remove by |
»»» triggerByWorkOrderStatusId |
body |
integer(int64) |
false |
Unique identifier for the trigger by work order status |
»»» triggerByWorkOrderStatus |
body |
string |
false |
Status of the trigger by work order |
»»» triggerByWorkOrderStatusType |
body |
string |
false |
Type of the trigger by work order status |
»»» removeByWorkOrderStatusId |
body |
integer(int64) |
false |
Unique identifier for the remove by work order status |
»»» removeByWorkOrderStatus |
body |
string |
false |
Status of the remove by work order |
»»» removeByWorkOrderStatusType |
body |
string |
false |
Type of the remove by work order status |
»» assignedUserIds |
body |
[integer] |
false |
Array of unique identifiers for users assigned to the work order, facilitating effective resource allocation and management. |
»» assignedUserDtos |
body |
false |
Array of user assignments associated with the work order, providing visibility into the personnel responsible for its execution. |
|
»» assignedUsers |
body |
[string] |
false |
List of users assigned to the work order, facilitating effective task management and resource allocation. |
»» variableQuantity |
body |
integer(int64) |
false |
Quantity of variable quantity |
»» workOrderAvailable |
body |
boolean |
false |
Indicates whether a work order is currently available for processing within the system. |
»» exactPlacement |
body |
string |
false |
Specifies the precise location or arrangement for the execution of the work order, ensuring clarity in task assignment and resource allocation. |
»» primaryWorkOrderId |
body |
integer(int64) |
false |
Unique identifier for the primary work order |
»» primaryWorkOrderDto |
body |
false |
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 |
body |
string |
false |
Unique identifier for the primary work order display |
»» isPrimary |
body |
boolean |
false |
Whether the resource is primary |
»» invoiceIds |
body |
[integer] |
false |
Array of unique identifiers for invoices associated with the work order, facilitating efficient tracking and management of financial transactions. |
»» createdByTrigger |
body |
boolean |
false |
Indicates whether the work order was created automatically by a trigger event within the system. |
»» internalCosts |
body |
string |
false |
Represents the internal costs associated with the work order, providing essential financial insights for effective budget management. |
»» invoiceTotal |
body |
string |
false |
Total invoice |
»» partsTotal |
body |
string |
false |
Total parts |
»» inspectionItemId |
body |
integer(int64) |
false |
Unique identifier for the inspection item |
»» partIdToAttach |
body |
integer(int64) |
false |
Unique identifier for the part to be attached to the work order, facilitating efficient tracking and management of resources. |
»» recurringWOIsTemplate |
body |
boolean |
false |
Indicates whether the work order is based on a recurring template, facilitating streamlined management of repeat tasks. |
»» recurringWOStartDate |
body |
string(date) |
false |
Date of the recurring w o start |
»» recurringWOEndDate |
body |
string(date) |
false |
Date of the recurring w o end |
»» recurringWODueDuration |
body |
integer(int32) |
false |
Specifies the duration, in days, for which a work order is set to recur, facilitating effective scheduling and resource allocation. |
»» recurringWODueMonths |
body |
integer(int32) |
false |
Specifies the number of months for which the work order is set to recur, facilitating effective scheduling and resource allocation. |
»» recurringWOPriority |
body |
string |
false |
Priority of the recurring w o |
»» recurringWOIsRemoveByDate |
body |
boolean |
false |
Date of the recurring w o is remove by |
»» triggerByWorkOrderStatus |
body |
string |
false |
Status of the trigger by work order |
»» removeByWorkOrderStatus |
body |
string |
false |
Status of the remove by work order |
»» recurringWOPriorityType |
body |
string |
false |
Type of the recurring w o priority |
»» triggerByWorkOrderStatusType |
body |
string |
false |
Type of the trigger by work order status |
»» removeByWorkOrderStatusType |
body |
string |
false |
Type of the remove by work order status |
»» recurringWOPriorityId |
body |
integer(int64) |
false |
Unique identifier for the recurring w o priority |
»» triggerByWorkOrderStatusId |
body |
integer(int64) |
false |
Unique identifier for the trigger by work order status |
»» removeByWorkOrderStatusId |
body |
integer(int64) |
false |
Unique identifier for the remove by work order status |
» description |
body |
string |
false |
none |
» date |
body |
string |
true |
none |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
»» cost |
|
body |
»» estimatedCost |
|
body |
»» finalCost |
|
body |
»» finalHourTime |
|
body |
»» estimatedHourTime |
|
body |
»» internalCosts |
|
body |
»» invoiceTotal |
|
body |
»» partsTotal |
|
body |
Body Parameters
1{
2 "mainAsset": {
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 "selectedWorkOrder": {
160 "id": 0,
161 "createdBy": "string",
162 "createdAt": "2019-08-24T14:15:22Z",
163 "displayId": "string",
164 "name": "string",
165 "imageId": 0,
166 "description": "string",
167 "vendorRating": 0,
168 "premiseId": 0,
169 "premiseDto": {
170 "id": 0,
171 "createdBy": "string",
172 "createdAt": "2019-08-24T14:15:22Z",
173 "displayId": "string",
174 "premiseName": "string",
175 "description": "string",
176 "address": "string",
177 "internalTeamNames": [
178 "string"
179 ],
180 "internalTeamIds": [
181 0
182 ],
183 "premiseAvailable": true,
184 "premiseFromNrm": true,
185 "nlmId": 0,
186 "nlmDisplayId": "string",
187 "nlmUsed": true,
188 "manager": 0,
189 "managerName": "string",
190 "imageId": 0,
191 "area": "string",
192 "modifiedAt": "2019-08-24T14:15:22Z"
193 },
194 "premiseFromNrm": true,
195 "premiseDisplayId": "string",
196 "nssProjectId": 0,
197 "nssTaskId": 0,
198 "nssTaskDisplayId": "string",
199 "orderDate": "2019-08-24",
200 "dueDate": "2019-08-24",
201 "startDate": "2019-08-24",
202 "endDate": "2019-08-24",
203 "startTime": {
204 "hour": 0,
205 "minute": 0,
206 "second": 0,
207 "nano": 0
208 },
209 "endTime": {
210 "hour": 0,
211 "minute": 0,
212 "second": 0,
213 "nano": 0
214 },
215 "modifiedAt": "2019-08-24T14:15:22Z",
216 "estimatedCost": "81.08",
217 "finalCost": "81.08",
218 "duration": 0,
219 "estimatedDayTime": 0,
220 "finalHourTime": "2.5",
221 "estimatedHourTime": "2.5",
222 "closeDate": "2019-08-24",
223 "inspection": "string",
224 "workOrderTypeId": 0,
225 "workOrderTypeName": "string",
226 "workOrderType": "string",
227 "workOrderPriorityId": 0,
228 "workOrderPriority": "string",
229 "workOrderPriorityType": "string",
230 "isTemplate": true,
231 "isWorkOrderTemplate": true,
232 "templateId": 0,
233 "isPartsInSufficient": true,
234 "partQuantityInfoList": [
235 {
236 "partId": 0,
237 "partDisplayId": "string",
238 "requestedQuantity": 0,
239 "availableQuantity": 0,
240 "usedQuantity": 0,
241 "sufficient": true,
242 "partial": true
243 }
244 ],
245 "parentWorkOrderId": 0,
246 "parentWorkOrderDisplayId": "string",
247 "parentWorkOrder": "string",
248 "mainAssetIds": [
249 0
250 ],
251 "mainAssetDto": {
252 "id": 0,
253 "createdBy": "string",
254 "createdAt": "2019-08-24T14:15:22Z",
255 "displayId": "string",
256 "name": "string",
257 "description": "string",
258 "qrCode": "string",
259 "barCode": "string",
260 "imageId": 0,
261 "model": "string",
262 "manufacturer": "string",
263 "serialNumber": "string",
264 "cost": "81.08",
265 "premiseId": 0,
266 "premiseDisplayId": "string",
267 "premiseDto": {
268 "id": 0,
269 "createdBy": "string",
270 "createdAt": "2019-08-24T14:15:22Z",
271 "displayId": "string",
272 "premiseName": "string",
273 "description": "string",
274 "address": "string",
275 "internalTeamNames": [
276 "string"
277 ],
278 "internalTeamIds": [
279 0
280 ],
281 "premiseAvailable": true,
282 "premiseFromNrm": true,
283 "nlmId": 0,
284 "nlmDisplayId": "string",
285 "nlmUsed": true,
286 "manager": 0,
287 "managerName": "string",
288 "imageId": 0,
289 "area": "string",
290 "modifiedAt": "2019-08-24T14:15:22Z"
291 },
292 "acquisitionDate": "2019-08-24",
293 "endOfLife": "2019-08-24",
294 "assetStatusId": 0,
295 "assetStatus": "string",
296 "assetStatusType": "string",
297 "parentAssetId": 0,
298 "parentAssetDisplayId": "string",
299 "parentAsset": "string",
300 "parentAssetDto": {},
301 "upcomingMaintenanceDate": "2019-08-24",
302 "assetCategoryIds": [
303 0
304 ],
305 "assetCategories": [
306 "string"
307 ],
308 "internalTeamIds": [
309 0
310 ],
311 "internalTeamDtos": [
312 {
313 "id": 0,
314 "createdBy": "string",
315 "createdAt": "2019-08-24T14:15:22Z",
316 "displayId": "string",
317 "name": "string",
318 "email": "string",
319 "phone": "string",
320 "manager": "string",
321 "requestCategoryName": [
322 "string"
323 ],
324 "requestCategoryId": [
325 0
326 ],
327 "requestCategoryDisplayId": [
328 "string"
329 ],
330 "description": "string",
331 "internalTeamUser": [
332 0
333 ],
334 "members": 0,
335 "mainAssets": [
336 0
337 ],
338 "premiseNames": [
339 "string"
340 ],
341 "internalTeamAvailable": true,
342 "premiseIds": [
343 0
344 ]
345 }
346 ],
347 "internalTeams": [
348 "string"
349 ],
350 "assignedUserIds": [
351 0
352 ],
353 "assignedUserDtos": [
354 {
355 "id": 0,
356 "createdBy": "string",
357 "createdAt": "2019-08-24T14:15:22Z",
358 "userName": "string",
359 "firstName": "string",
360 "lastName": "string",
361 "email": "string",
362 "roleIds": [
363 {
364 "id": 0,
365 "createdBy": "string",
366 "createdAt": "2019-08-24T14:15:22Z",
367 "modifiedBy": "string",
368 "modifiedAt": "2019-08-24T14:15:22Z",
369 "roleName": "string",
370 "entity": "string",
371 "new": true
372 }
373 ],
374 "internalTeamNames": [
375 "string"
376 ],
377 "internalTeamIds": [
378 0
379 ],
380 "internalTeamDisplayIds": [
381 "string"
382 ],
383 "premiseIds": [
384 0
385 ],
386 "premiseNames": [
387 "string"
388 ],
389 "userAvailable": true,
390 "temporaryWorkload": 0,
391 "preferredCultureCode": "string"
392 }
393 ],
394 "assignedUsers": [
395 "string"
396 ],
397 "assetPriority": "string",
398 "assetPriorityId": 0,
399 "assetPriorityDisplayId": "string",
400 "assetPriorityType": "string",
401 "assetAvailable": true,
402 "exactPlacement": "string",
403 "fosId": 0,
404 "downtimeStatus": "string",
405 "premiseFromNrm": true,
406 "modifiedAt": "2019-08-24T14:15:22Z"
407 },
408 "mainAssetDisplayId": "string",
409 "workOrderStatusId": 0,
410 "workOrderStatus": "string",
411 "workOrderStatusType": "string",
412 "requestIds": [
413 0
414 ],
415 "internalTeamIds": [
416 0
417 ],
418 "internalTeamDtos": [
419 {
420 "id": 0,
421 "createdBy": "string",
422 "createdAt": "2019-08-24T14:15:22Z",
423 "displayId": "string",
424 "name": "string",
425 "email": "string",
426 "phone": "string",
427 "manager": "string",
428 "requestCategoryName": [
429 "string"
430 ],
431 "requestCategoryId": [
432 0
433 ],
434 "requestCategoryDisplayId": [
435 "string"
436 ],
437 "description": "string",
438 "internalTeamUser": [
439 0
440 ],
441 "members": 0,
442 "mainAssets": [
443 0
444 ],
445 "premiseNames": [
446 "string"
447 ],
448 "internalTeamAvailable": true,
449 "premiseIds": [
450 0
451 ]
452 }
453 ],
454 "internalTeams": [
455 "string"
456 ],
457 "vendorId": 0,
458 "vendorDto": {
459 "id": 0,
460 "createdBy": "string",
461 "createdAt": "2019-08-24T14:15:22Z",
462 "displayId": "string",
463 "name": "string",
464 "description": "string",
465 "address": "string",
466 "contractEndDate": "2019-08-24",
467 "services": "string",
468 "vendorType": "string",
469 "vendorStatusId": 0,
470 "vendorStatus": "string",
471 "vendorStatusType": "string",
472 "businessTypeId": 0,
473 "businessType": "string",
474 "vendorRateId": 0,
475 "vendorRate": "string",
476 "vendorContactIds": [
477 0
478 ],
479 "premiseIds": [
480 0
481 ],
482 "firstPremiseDisplayId": "string",
483 "ownerUserName": "string",
484 "ownerDto": {
485 "id": 0,
486 "createdBy": "string",
487 "createdAt": "2019-08-24T14:15:22Z",
488 "userName": "string",
489 "firstName": "string",
490 "lastName": "string",
491 "email": "string",
492 "roleIds": [
493 {
494 "id": 0,
495 "createdBy": "string",
496 "createdAt": "2019-08-24T14:15:22Z",
497 "modifiedBy": "string",
498 "modifiedAt": "2019-08-24T14:15:22Z",
499 "roleName": "string",
500 "entity": "string",
501 "new": true
502 }
503 ],
504 "internalTeamNames": [
505 "string"
506 ],
507 "internalTeamIds": [
508 0
509 ],
510 "internalTeamDisplayIds": [
511 "string"
512 ],
513 "premiseIds": [
514 0
515 ],
516 "premiseNames": [
517 "string"
518 ],
519 "userAvailable": true,
520 "temporaryWorkload": 0,
521 "preferredCultureCode": "string"
522 },
523 "vendorAvailable": true,
524 "vendorRating": 0.1,
525 "premiseDisplayIds": [
526 "string"
527 ]
528 },
529 "vendorName": "string",
530 "workOrderTemplateSettings": {
531 "id": 0,
532 "createdBy": "string",
533 "createdAt": "2019-08-24T14:15:22Z",
534 "workOrderId": 0,
535 "startDate": "2019-08-24",
536 "dueDuration": 0,
537 "dueMonths": 0,
538 "endDate": "2019-08-24",
539 "recurringWOPriorityId": 0,
540 "recurringWOPriority": "string",
541 "recurringWOPriorityType": "string",
542 "isTemplate": true,
543 "isRemoveByDate": true,
544 "triggerByWorkOrderStatusId": 0,
545 "triggerByWorkOrderStatus": "string",
546 "triggerByWorkOrderStatusType": "string",
547 "removeByWorkOrderStatusId": 0,
548 "removeByWorkOrderStatus": "string",
549 "removeByWorkOrderStatusType": "string"
550 },
551 "assignedUserIds": [
552 0
553 ],
554 "assignedUserDtos": [
555 {
556 "id": 0,
557 "createdBy": "string",
558 "createdAt": "2019-08-24T14:15:22Z",
559 "userName": "string",
560 "firstName": "string",
561 "lastName": "string",
562 "email": "string",
563 "roleIds": [
564 {
565 "id": 0,
566 "createdBy": "string",
567 "createdAt": "2019-08-24T14:15:22Z",
568 "modifiedBy": "string",
569 "modifiedAt": "2019-08-24T14:15:22Z",
570 "roleName": "string",
571 "entity": "string",
572 "new": true
573 }
574 ],
575 "internalTeamNames": [
576 "string"
577 ],
578 "internalTeamIds": [
579 0
580 ],
581 "internalTeamDisplayIds": [
582 "string"
583 ],
584 "premiseIds": [
585 0
586 ],
587 "premiseNames": [
588 "string"
589 ],
590 "userAvailable": true,
591 "temporaryWorkload": 0,
592 "preferredCultureCode": "string"
593 }
594 ],
595 "assignedUsers": [
596 "string"
597 ],
598 "variableQuantity": 0,
599 "workOrderAvailable": true,
600 "exactPlacement": "string",
601 "primaryWorkOrderId": 0,
602 "primaryWorkOrderDto": {},
603 "primaryWorkOrderDisplayId": "string",
604 "isPrimary": true,
605 "invoiceIds": [
606 0
607 ],
608 "createdByTrigger": true,
609 "internalCosts": "81.08",
610 "invoiceTotal": "81.08",
611 "partsTotal": "81.08",
612 "inspectionItemId": 0,
613 "partIdToAttach": 0,
614 "recurringWOIsTemplate": true,
615 "recurringWOStartDate": "2019-08-24",
616 "recurringWOEndDate": "2019-08-24",
617 "recurringWODueDuration": 0,
618 "recurringWODueMonths": 0,
619 "recurringWOPriority": "string",
620 "recurringWOIsRemoveByDate": true,
621 "triggerByWorkOrderStatus": "string",
622 "removeByWorkOrderStatus": "string",
623 "recurringWOPriorityType": "string",
624 "triggerByWorkOrderStatusType": "string",
625 "removeByWorkOrderStatusType": "string",
626 "recurringWOPriorityId": 0,
627 "triggerByWorkOrderStatusId": 0,
628 "removeByWorkOrderStatusId": 0
629 },
630 "description": "string",
631 "date": "string"
632}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Offline Main Asset¶
HTTP Request
PUT /api/mainAssets/offline/{id}
📋 Description: Updates the status of a specified main asset to offline, allowing for better asset management and tracking within the system. This operation ensures that the asset is marked appropriately for reporting and operational purposes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
object |
false |
Request body containing the updated details of the main asset, including its status and relevant metadata, to facilitate effective asset management. |
» mainAsset |
body |
true |
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 |
body |
integer(int64) |
false |
Unique identifier for the resource |
»» createdBy |
body |
string |
false |
Username of who created this resource |
»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»» displayId |
body |
string |
false |
Unique identifier for the display |
»» name |
body |
string |
false |
Name of the resource |
»» description |
body |
string |
false |
Description of the resource |
»» qrCode |
body |
string |
false |
Code for the qr |
»» barCode |
body |
string |
false |
Code for the bar |
»» imageId |
body |
integer(int64) |
false |
Unique identifier for the image |
»» model |
body |
string |
false |
Specifies the model associated with the main asset, providing essential context for asset classification and management. |
»» manufacturer |
body |
string |
false |
Name of the manufacturer associated with the asset, providing essential information for inventory management and supplier relations. |
»» serialNumber |
body |
string |
false |
Unique identifier for the asset, used to track and manage inventory within the system. |
»» cost |
body |
string |
false |
Represents the total cost associated with the main asset, providing essential financial information for budgeting and resource allocation. |
»» premiseId |
body |
integer(int64) |
false |
Unique identifier for the premise |
»» premiseDisplayId |
body |
string |
false |
Unique identifier for the premise display |
»» premiseDto |
body |
false |
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 |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»» premiseName |
body |
string |
false |
Name of the premise |
»»» description |
body |
string |
false |
Description of the resource |
»»» address |
body |
string |
true |
Represents the physical location associated with the premise, essential for logistics and service delivery. |
»»» internalTeamNames |
body |
[string] |
false |
List of names representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation within the organization. |
»»» internalTeamIds |
body |
[integer] |
false |
List of unique identifiers representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation. |
»»» premiseAvailable |
body |
boolean |
false |
Indicates whether the premise is available for use within the specified context. |
»»» premiseFromNrm |
body |
boolean |
false |
Indicates whether the premise is sourced from the National Resource Management (NRM) framework, facilitating compliance and reporting within environmental management processes. |
»»» nlmId |
body |
integer(int64) |
false |
Unique identifier for the nlm |
»»» nlmDisplayId |
body |
string |
false |
Unique identifier for the nlm display |
»»» nlmUsed |
body |
boolean |
false |
Indicates whether the National Labor Market (NLM) resources have been utilized in the premise evaluation process. |
»»» manager |
body |
integer(int64) |
false |
Unique identifier for the manager associated with the premise, facilitating effective organizational hierarchy and resource management. |
»»» managerName |
body |
string |
false |
Name of the manager |
»»» imageId |
body |
integer(int64) |
false |
Unique identifier for the image |
»»» area |
body |
string |
false |
Represents the geographic area associated with the premise, providing essential context for location-based services and analysis. |
»»» modifiedAt |
body |
string(date-time) |
false |
Timestamp when this resource was last modified |
»» acquisitionDate |
body |
string(date) |
false |
Date of the acquisition |
»» endOfLife |
body |
string(date) |
false |
Indicates the end-of-life date for the asset, providing critical information for lifecycle management and planning. |
»» assetStatusId |
body |
integer(int64) |
false |
Unique identifier for the asset status |
»» assetStatus |
body |
string |
false |
Status of the asset |
»» assetStatusType |
body |
string |
false |
Type of the asset status |
»» parentAssetId |
body |
integer(int64) |
false |
Unique identifier for the parent asset |
»» parentAssetDisplayId |
body |
string |
false |
Unique identifier for the parent asset display |
»» parentAsset |
body |
string |
false |
Identifier for the parent asset associated with the main asset, facilitating hierarchical relationships within asset management. |
»» parentAssetDto |
body |
false |
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 |
body |
string(date) |
false |
Date of the upcoming maintenance |
»» assetCategoryIds |
body |
[integer] |
false |
Array of unique identifiers representing the categories to which the asset belongs, facilitating effective asset classification and management. |
»» assetCategories |
body |
[string] |
false |
Array of asset categories that classify the main assets within the system, facilitating better organization and management of asset data. |
»» internalTeamIds |
body |
[integer] |
false |
Array of unique identifiers representing the internal teams associated with the main asset, facilitating streamlined collaboration and resource allocation. |
»» internalTeamDtos |
body |
false |
An array of MainAssetDTO objects representing the internal teams associated with the asset, facilitating effective resource management and collaboration within the organization. |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»»» displayId |
body |
string |
false |
Unique identifier for the display |
»»» name |
body |
string |
false |
Name of the resource |
body |
string |
false |
Email address of the internal team member, used for communication and notifications within the organization. |
|
»»» phone |
body |
string |
false |
Contact number for the internal team, facilitating communication and collaboration within the organization. |
»»» manager |
body |
string |
false |
Represents the name or identifier of the team manager responsible for overseeing the internal team. |
»»» requestCategoryName |
body |
[string] |
false |
Name of the request category |
»»» requestCategoryId |
body |
[integer] |
false |
Unique identifier for the request category |
»»» requestCategoryDisplayId |
body |
[string] |
false |
Unique identifier for the request category display |
»»» description |
body |
string |
false |
Description of the resource |
»»» internalTeamUser |
body |
[integer] |
false |
An array of InternalTeamDTO objects representing the users within the internal team, facilitating collaboration and resource management. |
»»» members |
body |
integer(int32) |
false |
Represents the total number of members within the internal team, providing insight into team size for resource allocation and management. |
»»» mainAssets |
body |
[integer] |
false |
An array of internal team assets that represent the key resources and capabilities utilized within the organization. |
»»» premiseNames |
body |
[string] |
false |
List of names associated with the premises relevant to the internal team, facilitating efficient identification and management of locations within the organization. |
»»» internalTeamAvailable |
body |
boolean |
false |
Indicates the availability of the internal team for project allocation and resource planning. |
»»» premiseIds |
body |
[integer] |
false |
Array of unique identifiers representing the premises associated with the internal team. |
»» internalTeams |
body |
[string] |
false |
An array of internal teams associated with the main asset, facilitating collaboration and resource allocation within the organization. |
»» assignedUserIds |
body |
[integer] |
false |
Array of unique identifiers representing users assigned to the main asset, facilitating effective resource management and accountability. |
»» assignedUserDtos |
body |
false |
Array of user assignments associated with the main asset, providing insights into resource allocation and accountability. |
|
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»»» userName |
body |
string |
false |
Name of the user |
»»» firstName |
body |
string |
false |
Name of the first |
»»» lastName |
body |
string |
false |
Name of the last |
body |
string |
false |
Email address of the user, used for communication and account verification purposes within the system. |
|
»»» roleIds |
body |
false |
Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system. |
|
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»»» createdAt |
body |
string(date-time) |
false |
Timestamp when this resource was created |
»»»» modifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»»» modifiedAt |
body |
string(date-time) |
false |
Timestamp when this resource was last modified |
»»»» roleName |
body |
string |
false |
Name of the role |
»»»» entity |
body |
string |
false |
Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management. |
»»»» new |
body |
boolean |
false |
Indicates whether the role is newly created within the system, facilitating effective management of organizational changes. |
»»» internalTeamNames |
body |
[string] |
false |
List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization. |
»»» internalTeamIds |
body |
[integer] |
false |
An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization. |
»»» internalTeamDisplayIds |
body |
[string] |
false |
An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration. |
»»» premiseIds |
body |
[integer] |
false |
Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations. |
»»» premiseNames |
body |
[string] |
false |
List of names associated with the user’s premises, providing essential context for location-based services and operations. |
»»» userAvailable |
body |
boolean |
false |
Indicates whether the user is available for assignment or engagement within the system. |
»»» temporaryWorkload |
body |
integer(int32) |
false |
Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning. |
»»» preferredCultureCode |
body |
string |
false |
Code for the preferred culture |
»» assignedUsers |
body |
[string] |
false |
List of users assigned to the main asset, facilitating effective resource management and collaboration within the organization. |
»» assetPriority |
body |
string |
false |
Priority of the asset |
»» assetPriorityId |
body |
integer(int64) |
false |
Unique identifier for the asset priority |
»» assetPriorityDisplayId |
body |
string |
false |
Unique identifier for the asset priority display |
»» assetPriorityType |
body |
string |
false |
Type of the asset priority |
»» assetAvailable |
body |
boolean |
false |
Indicates whether the asset is currently available for allocation or use within the system. |
»» exactPlacement |
body |
string |
false |
Specifies the precise location or context in which the main asset is intended to be utilized within the business framework. |
»» fosId |
body |
integer(int64) |
false |
Unique identifier for the fos |
»» downtimeStatus |
body |
string |
false |
Status of the downtime |
»» premiseFromNrm |
body |
boolean |
false |
Indicates whether the asset is sourced from the National Resource Management (NRM) framework, facilitating compliance and resource tracking. |
»» modifiedAt |
body |
string(date-time) |
false |
Timestamp when this resource was last modified |
» reason |
body |
string |
true |
none |
» description |
body |
string |
false |
none |
» date |
body |
string |
true |
none |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
»» cost |
|
body |
Body Parameters
1{
2 "mainAsset": {
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 "reason": "string",
160 "description": "string",
161 "date": "string"
162}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get All Main Assets¶
HTTP Request
GET /api/mainAssets
📋 Description: Fetches a list of main assets within the system, providing users with essential information for asset management and decision-making.
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 |
Create Main Asset¶
HTTP Request
POST /api/mainAssets
📋 Description: Creates a new main asset entry in the system, enabling efficient management and tracking of key business resources.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the main asset details, including identification, specifications, and associated metadata for effective asset management. |
Body Parameters
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}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "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}
Get Work Orders By ID¶
HTTP Request
GET /api/mainAssets/{id}/workOrders/{workOrderId}
📋 Description: Fetches detailed information about a specific work order associated with a main asset, 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}
Attach Work Order To Main Asset¶
HTTP Request
POST /api/mainAssets/{id}/workOrders/{workOrderId}
📋 Description: Creates a new work order associated with the specified main asset, enabling efficient management and tracking of maintenance and operational tasks.
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 Main Asset¶
HTTP Request
DELETE /api/mainAssets/{id}/workOrders/{workOrderId}
📋 Description: Deletes a specific work order associated with a main asset, ensuring the removal of outdated or unnecessary tasks from asset management records.
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 Vendor To Main Asset¶
HTTP Request
POST /api/mainAssets/{id}/vendors/{vendorId}
📋 Description: Associates a specified vendor with a main asset, enabling streamlined management of vendor-related activities and resources for enhanced operational efficiency.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
vendorId |
path |
integer(int64) |
true |
Unique identifier for the vendor |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Detach Vendor From Main Asset¶
HTTP Request
DELETE /api/mainAssets/{id}/vendors/{vendorId}
📋 Description: Deletes the specified vendor associated with a main asset, ensuring that vendor relationships are accurately maintained within the asset management framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
vendorId |
path |
integer(int64) |
true |
Unique identifier for the vendor |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Handle File Upload¶
HTTP Request
POST /api/mainAssets/{id}/upload
📋 Description: Uploads a new asset file associated with the specified main asset ID, facilitating the management and enhancement of asset-related documentation.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
object |
false |
Request body containing the asset upload data, including file content and associated metadata for processing the specified asset. |
» file |
body |
string(binary) |
true |
none |
Body Parameters
1{
2 "file": "string"
3}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
string |
Example Responses
1"string"
Assign Asset Part To Main Asset¶
HTTP Request
POST /api/mainAssets/{id}/assetParts/{assetPartId}
📋 Description: Creates a new asset part associated with the specified main asset, enabling effective management and organization of asset components within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
assetPartId |
path |
integer(int64) |
true |
Unique identifier for the asset part |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Detach Asset Parts By Main Asset¶
HTTP Request
DELETE /api/mainAssets/{id}/assetParts/{assetPartId}
📋 Description: Deletes a specific asset part associated with the main asset identified by the provided ID, ensuring the integrity and accuracy of asset management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
assetPartId |
path |
integer(int64) |
true |
Unique identifier for the asset part |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get Main Assets¶
HTTP Request
POST /api/mainAssets/search
📋 Description: Submits a search request for main assets, allowing users to filter results based on specified criteria to enhance asset management and decision-making processes.
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 asset inventories. |
|
body |
body |
true |
Request body containing search criteria and filters for main asset retrieval, enabling targeted asset management and analysis. |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idNotIn": [
6 0
7 ],
8 "displayIdLike": "string",
9 "nameLike": "string",
10 "modelLike": "string",
11 "assetAvailable": true,
12 "premiseIdIn": [
13 0
14 ],
15 "premiseIdNotIn": [
16 0
17 ],
18 "assetStatusIn": [
19 0
20 ],
21 "assetPriorityIn": [
22 0
23 ],
24 "attachToAssetCategoryIdIn": [
25 0
26 ],
27 "attachToAssetCategoryIdNotIn": [
28 0
29 ],
30 "attachToAssetPartIdIn": [
31 0
32 ],
33 "attachToAssetPartIdNotIn": [
34 0
35 ],
36 "attachToWorkOrderIdIn": [
37 0
38 ],
39 "attachToWorkOrderIdNotIn": [
40 0
41 ],
42 "assetPremisesId": "string",
43 "relatedUser": "string"
44}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "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 "name": "string",
27 "description": "string",
28 "qrCode": "string",
29 "barCode": "string",
30 "imageId": 0,
31 "model": "string",
32 "manufacturer": "string",
33 "serialNumber": "string",
34 "cost": "81.08",
35 "premiseId": 0,
36 "premiseDisplayId": "string",
37 "premiseDto": {
38 "id": 0,
39 "createdBy": "string",
40 "createdAt": "2019-08-24T14:15:22Z",
41 "displayId": "string",
42 "premiseName": "string",
43 "description": "string",
44 "address": "string",
45 "internalTeamNames": [
46 "string"
47 ],
48 "internalTeamIds": [
49 0
50 ],
51 "premiseAvailable": true,
52 "premiseFromNrm": true,
53 "nlmId": 0,
54 "nlmDisplayId": "string",
55 "nlmUsed": true,
56 "manager": 0,
57 "managerName": "string",
58 "imageId": 0,
59 "area": "string",
60 "modifiedAt": "2019-08-24T14:15:22Z"
61 },
62 "acquisitionDate": "2019-08-24",
63 "endOfLife": "2019-08-24",
64 "assetStatusId": 0,
65 "assetStatus": "string",
66 "assetStatusType": "string",
67 "parentAssetId": 0,
68 "parentAssetDisplayId": "string",
69 "parentAsset": "string",
70 "parentAssetDto": {},
71 "upcomingMaintenanceDate": "2019-08-24",
72 "assetCategoryIds": [
73 0
74 ],
75 "assetCategories": [
76 "string"
77 ],
78 "internalTeamIds": [
79 0
80 ],
81 "internalTeamDtos": [
82 {
83 "id": 0,
84 "createdBy": "string",
85 "createdAt": "2019-08-24T14:15:22Z",
86 "displayId": "string",
87 "name": "string",
88 "email": "string",
89 "phone": "string",
90 "manager": "string",
91 "requestCategoryName": [
92 "string"
93 ],
94 "requestCategoryId": [
95 0
96 ],
97 "requestCategoryDisplayId": [
98 "string"
99 ],
100 "description": "string",
101 "internalTeamUser": [
102 0
103 ],
104 "members": 0,
105 "mainAssets": [
106 0
107 ],
108 "premiseNames": [
109 "string"
110 ],
111 "internalTeamAvailable": true,
112 "premiseIds": [
113 0
114 ]
115 }
116 ],
117 "internalTeams": [
118 "string"
119 ],
120 "assignedUserIds": [
121 0
122 ],
123 "assignedUserDtos": [
124 {
125 "id": 0,
126 "createdBy": "string",
127 "createdAt": "2019-08-24T14:15:22Z",
128 "userName": "string",
129 "firstName": "string",
130 "lastName": "string",
131 "email": "string",
132 "roleIds": [
133 {
134 "id": 0,
135 "createdBy": "string",
136 "createdAt": "2019-08-24T14:15:22Z",
137 "modifiedBy": "string",
138 "modifiedAt": "2019-08-24T14:15:22Z",
139 "roleName": "string",
140 "entity": "string",
141 "new": true
142 }
143 ],
144 "internalTeamNames": [
145 "string"
146 ],
147 "internalTeamIds": [
148 0
149 ],
150 "internalTeamDisplayIds": [
151 "string"
152 ],
153 "premiseIds": [
154 0
155 ],
156 "premiseNames": [
157 "string"
158 ],
159 "userAvailable": true,
160 "temporaryWorkload": 0,
161 "preferredCultureCode": "string"
162 }
163 ],
164 "assignedUsers": [
165 "string"
166 ],
167 "assetPriority": "string",
168 "assetPriorityId": 0,
169 "assetPriorityDisplayId": "string",
170 "assetPriorityType": "string",
171 "assetAvailable": true,
172 "exactPlacement": "string",
173 "fosId": 0,
174 "downtimeStatus": "string",
175 "premiseFromNrm": true,
176 "modifiedAt": "2019-08-24T14:15:22Z"
177 }
178 ],
179 "number": 0,
180 "sort": {
181 "unsorted": true,
182 "sorted": true,
183 "empty": true
184 },
185 "empty": true
186}
Get Assets From FOS¶
HTTP Request
POST /api/mainAssets/search/fos
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Submits a search request for main assets using specified criteria, enabling users to efficiently locate and manage asset information within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing search criteria and filters for main asset identification and retrieval. |
Body Parameters
1{}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "name": "string",
6 "quantity": 0
7 }
8]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an asset within the organization, encapsulating essential attributes and metadata necessary for effective asset management and tracking.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
false |
none |
Name of the resource |
» quantity |
integer(int64) |
false |
none |
Quantity value |
Copy Main Asset¶
HTTP Request
POST /api/mainAssets/copyAsset/{id}
📋 Description: Copies an existing asset identified by the specified ID, allowing for efficient duplication of asset configurations and attributes within the system.
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 "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}
Get All Work Orders By Main Asset¶
HTTP Request
GET /api/mainAssets/{id}/workOrders
📋 Description: Retrieves work orders associated with a specific main asset, enabling users to manage and track maintenance and operational tasks effectively.
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 |
Find All Work Order Schedules By Main Asset¶
HTTP Request
GET /api/mainAssets/{id}/workOrderSchedules
📋 Description: Fetches the work order schedules associated with a specific main asset, enabling users to efficiently manage and track maintenance and operational activities.
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 Internal Teams By Main Asset¶
HTTP Request
GET /api/mainAssets/{id}/internalTeams
📋 Description: Retrieves the internal teams associated with a specific main asset, providing insights into resource allocation and collaboration opportunities.
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 "email": "string",
9 "phone": "string",
10 "manager": "string",
11 "requestCategoryName": [
12 "string"
13 ],
14 "requestCategoryId": [
15 0
16 ],
17 "requestCategoryDisplayId": [
18 "string"
19 ],
20 "description": "string",
21 "internalTeamUser": [
22 0
23 ],
24 "members": 0,
25 "mainAssets": [
26 0
27 ],
28 "premiseNames": [
29 "string"
30 ],
31 "internalTeamAvailable": true,
32 "premiseIds": [
33 0
34 ]
35 }
36]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an internal team within the organization, encapsulating essential details such as team members, roles, and operational objectives to facilitate effective collaboration and resource allocation.] |
|
» 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. |
Get Internal Teams By ID¶
HTTP Request
GET /api/mainAssets/{id}/internalTeams/{internalTeamId}
📋 Description: Fetches detailed information about a specific internal team associated with a main asset, enabling users to access relevant team data for enhanced collaboration and management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
internalTeamId |
path |
integer(int64) |
true |
Unique identifier for the internal team |
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 "email": "string",
8 "phone": "string",
9 "manager": "string",
10 "requestCategoryName": [
11 "string"
12 ],
13 "requestCategoryId": [
14 0
15 ],
16 "requestCategoryDisplayId": [
17 "string"
18 ],
19 "description": "string",
20 "internalTeamUser": [
21 0
22 ],
23 "members": 0,
24 "mainAssets": [
25 0
26 ],
27 "premiseNames": [
28 "string"
29 ],
30 "internalTeamAvailable": true,
31 "premiseIds": [
32 0
33 ]
34}
Get All History Of Asset Parts By Main Asset ID¶
HTTP Request
GET /api/mainAssets/{id}/historyOfAssetParts
📋 Description: Retrieves the historical records of asset parts associated with a specified main asset, providing insights into past modifications and configurations for effective asset management.
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 "entityName": "string",
7 "entityId": 0,
8 "linkedEntityName": "string",
9 "linkedEntityId": 0,
10 "changeType": "string",
11 "fieldName": "string",
12 "oldValue": "string",
13 "newValue": "string",
14 "linkedEntityDisplayId": "string",
15 "linkedEntityDisplayName": "string"
16 }
17]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the historical changes made to an entity, capturing essential details such as timestamps and user actions for audit and compliance purposes.] |
|
» 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 |
» entityName |
string |
true |
none |
Name of the entity |
» entityId |
integer(int64) |
true |
none |
Unique identifier for the entity |
» linkedEntityName |
string |
true |
none |
Name of the linked entity |
» linkedEntityId |
integer(int64) |
true |
none |
Unique identifier for the linked entity |
» changeType |
string |
true |
none |
Type of the change |
» fieldName |
string |
true |
none |
Name of the field |
» oldValue |
string |
false |
none |
Represents the previous value of the entity before the change was made, providing a historical reference for auditing and analysis purposes. |
» newValue |
string |
false |
none |
Represents the updated value associated with a specific change in the entity’s history, providing insight into modifications made for effective tracking and auditing. |
» linkedEntityDisplayId |
string |
false |
none |
Unique identifier for the linked entity display |
» linkedEntityDisplayName |
string |
false |
none |
Name of the linked entity display |
Get All Documents By Main Asset¶
HTTP Request
GET /api/mainAssets/{id}/documents
📋 Description: Retrieves all documents associated with the specified main asset, enabling users to access relevant documentation for effective asset management.
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 Documents By ID¶
HTTP Request
GET /api/mainAssets/{id}/documents/{documentId}
📋 Description: Retrieves the specified document associated with a main asset, providing access to essential documentation for effective asset management and decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "contentType": "string",
7 "documentTypeName": "string",
8 "documentTypeId": 0,
9 "description": "string",
10 "data": "string",
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "documentStatusId": 0,
14 "documentStatus": "string",
15 "documentStatusType": "string",
16 "parentEntityId": 0,
17 "link": "string",
18 "parentEntityName": "string"
19}
Get All Asset Upcoming Maintenances By Main Asset ID¶
HTTP Request
GET /api/mainAssets/{id}/assetUpcomingMaintenances
📋 Description: Fetches upcoming maintenance schedules for a specified main asset, enabling proactive management and planning of maintenance activities.
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 "upcomingMaintenanceDate": "2019-08-24",
7 "mainAsset": {
8 "id": 0,
9 "createdBy": "string",
10 "createdAt": "2019-08-24T14:15:22Z",
11 "displayId": "string",
12 "name": "string",
13 "description": "string",
14 "qrCode": "string",
15 "barCode": "string",
16 "imageId": 0,
17 "model": "string",
18 "manufacturer": "string",
19 "serialNumber": "string",
20 "cost": "81.08",
21 "premiseId": 0,
22 "premiseDisplayId": "string",
23 "premiseDto": {
24 "id": 0,
25 "createdBy": "string",
26 "createdAt": "2019-08-24T14:15:22Z",
27 "displayId": "string",
28 "premiseName": "string",
29 "description": "string",
30 "address": "string",
31 "internalTeamNames": [
32 "string"
33 ],
34 "internalTeamIds": [
35 0
36 ],
37 "premiseAvailable": true,
38 "premiseFromNrm": true,
39 "nlmId": 0,
40 "nlmDisplayId": "string",
41 "nlmUsed": true,
42 "manager": 0,
43 "managerName": "string",
44 "imageId": 0,
45 "area": "string",
46 "modifiedAt": "2019-08-24T14:15:22Z"
47 },
48 "acquisitionDate": "2019-08-24",
49 "endOfLife": "2019-08-24",
50 "assetStatusId": 0,
51 "assetStatus": "string",
52 "assetStatusType": "string",
53 "parentAssetId": 0,
54 "parentAssetDisplayId": "string",
55 "parentAsset": "string",
56 "parentAssetDto": {},
57 "upcomingMaintenanceDate": "2019-08-24",
58 "assetCategoryIds": [
59 0
60 ],
61 "assetCategories": [
62 "string"
63 ],
64 "internalTeamIds": [
65 0
66 ],
67 "internalTeamDtos": [
68 {
69 "id": 0,
70 "createdBy": "string",
71 "createdAt": "2019-08-24T14:15:22Z",
72 "displayId": "string",
73 "name": "string",
74 "email": "string",
75 "phone": "string",
76 "manager": "string",
77 "requestCategoryName": [
78 "string"
79 ],
80 "requestCategoryId": [
81 0
82 ],
83 "requestCategoryDisplayId": [
84 "string"
85 ],
86 "description": "string",
87 "internalTeamUser": [
88 0
89 ],
90 "members": 0,
91 "mainAssets": [
92 0
93 ],
94 "premiseNames": [
95 "string"
96 ],
97 "internalTeamAvailable": true,
98 "premiseIds": [
99 0
100 ]
101 }
102 ],
103 "internalTeams": [
104 "string"
105 ],
106 "assignedUserIds": [
107 0
108 ],
109 "assignedUserDtos": [
110 {
111 "id": 0,
112 "createdBy": "string",
113 "createdAt": "2019-08-24T14:15:22Z",
114 "userName": "string",
115 "firstName": "string",
116 "lastName": "string",
117 "email": "string",
118 "roleIds": [
119 {
120 "id": 0,
121 "createdBy": "string",
122 "createdAt": "2019-08-24T14:15:22Z",
123 "modifiedBy": "string",
124 "modifiedAt": "2019-08-24T14:15:22Z",
125 "roleName": "string",
126 "entity": "string",
127 "new": true
128 }
129 ],
130 "internalTeamNames": [
131 "string"
132 ],
133 "internalTeamIds": [
134 0
135 ],
136 "internalTeamDisplayIds": [
137 "string"
138 ],
139 "premiseIds": [
140 0
141 ],
142 "premiseNames": [
143 "string"
144 ],
145 "userAvailable": true,
146 "temporaryWorkload": 0,
147 "preferredCultureCode": "string"
148 }
149 ],
150 "assignedUsers": [
151 "string"
152 ],
153 "assetPriority": "string",
154 "assetPriorityId": 0,
155 "assetPriorityDisplayId": "string",
156 "assetPriorityType": "string",
157 "assetAvailable": true,
158 "exactPlacement": "string",
159 "fosId": 0,
160 "downtimeStatus": "string",
161 "premiseFromNrm": true,
162 "modifiedAt": "2019-08-24T14:15:22Z"
163 }
164 }
165]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the upcoming maintenance schedule for assets, including relevant details such as maintenance dates and associated asset identifiers, to facilitate proactive asset management and operational efficiency.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» upcomingMaintenanceDate |
string(date) |
false |
none |
Date of the upcoming maintenance |
» mainAsset |
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 Asset Parts By Main Asset¶
HTTP Request
GET /api/mainAssets/{id}/assetParts
📋 Description: Retrieves the asset parts associated with a specific main asset, identified by its unique ID, to facilitate detailed asset management and inventory tracking.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "name": "string",
8 "description": "string",
9 "imageId": 0,
10 "premiseId": 0,
11 "premiseDisplayId": "string",
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 "model": "string",
39 "unitCost": "67.08",
40 "serialNumber": "string",
41 "qrCode": "string",
42 "quantityOnHand": 0,
43 "reOrderPoint": 0,
44 "size": "string",
45 "color": "string",
46 "weight": "24.08",
47 "length": "11.5",
48 "width": "16.9",
49 "height": "12.3",
50 "materialType": "string",
51 "assetPartType": "string",
52 "assetPartTypeId": 0,
53 "assetPartManufacturer": {
54 "id": 0,
55 "createdBy": "string",
56 "createdAt": "2019-08-24T14:15:22Z",
57 "name": "string",
58 "assetParts": [
59 {}
60 ]
61 },
62 "variableQuantity": 0,
63 "assetPartAvailable": true,
64 "owner": 0,
65 "ownerDto": {
66 "id": 0,
67 "createdBy": "string",
68 "createdAt": "2019-08-24T14:15:22Z",
69 "userName": "string",
70 "firstName": "string",
71 "lastName": "string",
72 "email": "string",
73 "roleIds": [
74 {
75 "id": 0,
76 "createdBy": "string",
77 "createdAt": "2019-08-24T14:15:22Z",
78 "modifiedBy": "string",
79 "modifiedAt": "2019-08-24T14:15:22Z",
80 "roleName": "string",
81 "entity": "string",
82 "new": true
83 }
84 ],
85 "internalTeamNames": [
86 "string"
87 ],
88 "internalTeamIds": [
89 0
90 ],
91 "internalTeamDisplayIds": [
92 "string"
93 ],
94 "premiseIds": [
95 0
96 ],
97 "premiseNames": [
98 "string"
99 ],
100 "userAvailable": true,
101 "temporaryWorkload": 0,
102 "preferredCultureCode": "string"
103 },
104 "ownerUserName": "string",
105 "modifiedAt": "2019-08-24T14:15:22Z",
106 "isPartsSufficient": true
107 }
108]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a component of an asset, detailing its specifications and associated metadata for effective asset management and tracking within the enterprise.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
true |
none |
Name of the resource |
» 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 |
» 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 |
» premiseFromNrm |
boolean |
false |
none |
Indicates whether the asset part originates from the National Resource Management (NRM) framework, facilitating compliance and reporting requirements. |
» model |
string |
false |
none |
Represents the specific model associated with the asset part, facilitating accurate identification and management within the system. |
» unitCost |
string |
false |
none |
Represents the cost per unit of the asset part, essential for accurate budgeting and financial analysis within asset management. |
» serialNumber |
string |
false |
none |
Unique identifier for the asset part, facilitating efficient tracking and management within the asset management system. |
» qrCode |
string |
false |
none |
Code for the qr |
» quantityOnHand |
integer(int64) |
false |
none |
Represents the current inventory level of the asset part, indicating the quantity available for use or sale. |
» reOrderPoint |
integer(int64) |
false |
none |
Reorder point indicates the inventory level at which new stock should be ordered to prevent stockouts and ensure continuous availability of asset parts. |
» size |
string |
false |
none |
Number of items per page |
» color |
string |
false |
none |
Represents the color attribute associated with the asset part, providing essential visual differentiation for inventory management and asset tracking. |
» weight |
string |
false |
none |
Represents the weight of the asset part, providing essential information for inventory management and logistics optimization. |
» length |
string |
false |
none |
Specifies the length of the asset part, providing essential information for inventory management and resource allocation. |
» width |
string |
false |
none |
Specifies the width dimension of the asset part, facilitating accurate representation and management of asset specifications. |
» height |
string |
false |
none |
Specifies the height of the asset part, providing essential dimensional information for inventory and asset management. |
» materialType |
string |
false |
none |
Type of the material |
» assetPartType |
string |
false |
none |
Type of the asset part |
» assetPartTypeId |
integer(int64) |
false |
none |
Unique identifier for the asset part type |
» assetPartManufacturer |
false |
none |
Data transfer object representing the manufacturer details of an asset part, including essential identification and classification information to facilitate inventory management and procurement processes. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» name |
string |
false |
none |
Name of the resource |
»» assetParts |
false |
none |
An array of asset parts, represented by AssetPartManufacturerDTO, that details the components associated with each asset for effective inventory and resource management. |
|
» variableQuantity |
integer(int64) |
false |
none |
Quantity of variable quantity |
» assetPartAvailable |
boolean |
false |
none |
Indicates whether the specific asset part is currently available for allocation or use within the system. |
» owner |
integer(int64) |
false |
none |
Unique identifier for the owner of the asset part, facilitating asset management and accountability within the system. |
» 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. |
|
»» 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 |
» ownerUserName |
string |
false |
none |
Name of the owner user |
» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» isPartsSufficient |
boolean |
false |
none |
Whether the resource is parts sufficient |
Get All Asset Categories By Main Asset ID¶
HTTP Request
GET /api/mainAssets/{id}/assetCategories
📋 Description: Fetches the asset categories associated with a specific main asset identified by the provided ID, enabling users to gain insights into the categorization of their assets.
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 "objectAvailable": true
9 }
10]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a classification of assets within the organization, facilitating effective asset management and reporting by categorizing assets based on their characteristics and usage.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
true |
none |
Name of the resource |
» objectAvailable |
boolean |
false |
none |
Indicates whether the asset category is currently available for allocation within the system. |
Get Asset Category By ID¶
HTTP Request
GET /api/mainAssets/{id}/assetCategories/{assetCategoryId}
📋 Description: Fetches the details of a specific asset category associated with a main asset, providing essential information for effective asset management and categorization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
assetCategoryId |
path |
integer(int64) |
true |
Unique identifier for the asset category |
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 "objectAvailable": true
8}
Search Main Asset By Barcode Value¶
HTTP Request
GET /api/mainAssets/searchBarcodeValue/{barcodeValue}
📋 Description: Retrieves detailed information about main assets based on the provided barcode value, enabling efficient asset management and tracking.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
barcodeValue |
path |
string |
true |
Represents the unique barcode value used to search for specific main asset records within the system. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
boolean |
Example Responses
1true
Get All My Offline Assets¶
HTTP Request
GET /api/mainAssets/myOfflineAssets
📋 Description: Retrieves a list of offline assets associated with the authenticated user, providing visibility into available resources that are not currently connected to the network.
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 My Assets¶
HTTP Request
GET /api/mainAssets/myAssets
📋 Description: Retrieves a list of main assets associated with the authenticated user, providing insights into asset ownership and management.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "name": "string",
8 "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 Linked FOS Assets¶
HTTP Request
GET /api/mainAssets/linked-fos-assets
📋 Description: Retrieves a list of linked financial operating system (FOS) assets associated with the main assets, providing insights into asset relationships for enhanced financial analysis and decision-making.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]
Response Schema
Get All Assets By Premise ID¶
HTTP Request
GET /api/mainAssets/assetsByPremise/{premiseid}
📋 Description: Retrieves a list of main assets associated with a specified premise, enabling users to access relevant asset information for effective management and decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
premiseid |
path |
string |
true |
Unique identifier for the premise, used to retrieve associated asset information from the system. |
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 Active Asset Status Type IDs¶
HTTP Request
GET /api/mainAssets/allActiveAssetStatusTypes
📋 Description: Retrieves a list of all active asset status types, providing essential information for asset management and operational oversight.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]
Response Schema
Get All Active Asset Priority Type IDs¶
HTTP Request
GET /api/mainAssets/allActiveAssetPriorityTypes
📋 Description: Retrieves a list of all active asset priority types, enabling users to effectively manage and prioritize asset allocation within their operations.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]
Response Schema
Get All Active Asset Category Type IDs¶
HTTP Request
GET /api/mainAssets/allActiveAssetCategoryTypes
📋 Description: Retrieves a list of all active asset category types, providing essential data for effective asset management and categorization within the enterprise.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]