Inspection Resource¶
Get Inspection¶
HTTP Request
GET /api/inspections/{id}
📋 Description: Retrieves detailed information about a specific inspection identified by the provided ID, enabling users to access critical inspection data for review and analysis.
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 "dueDate": "2019-08-24",
9 "closeDate": "2019-08-24",
10 "createdDate": "2019-08-24",
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "startTime": {
14 "hour": 0,
15 "minute": 0,
16 "second": 0,
17 "nano": 0
18 },
19 "endTime": {
20 "hour": 0,
21 "minute": 0,
22 "second": 0,
23 "nano": 0
24 },
25 "isCreatedBy": "string",
26 "isTemplate": true,
27 "inspectionAvailable": true,
28 "inspectionType": "string",
29 "templateId": 0,
30 "premiseId": 0,
31 "premiseDto": {
32 "id": 0,
33 "createdBy": "string",
34 "createdAt": "2019-08-24T14:15:22Z",
35 "displayId": "string",
36 "premiseName": "string",
37 "description": "string",
38 "address": "string",
39 "internalTeamNames": [
40 "string"
41 ],
42 "internalTeamIds": [
43 0
44 ],
45 "premiseAvailable": true,
46 "premiseFromNrm": true,
47 "nlmId": 0,
48 "nlmDisplayId": "string",
49 "nlmUsed": true,
50 "manager": 0,
51 "managerName": "string",
52 "imageId": 0,
53 "area": "string",
54 "modifiedAt": "2019-08-24T14:15:22Z"
55 },
56 "premiseFromNrm": true,
57 "premiseDisplayId": "string",
58 "mainAssetIds": [
59 0
60 ],
61 "mainAssetId": 0,
62 "mainAssetDto": {
63 "id": 0,
64 "createdBy": "string",
65 "createdAt": "2019-08-24T14:15:22Z",
66 "displayId": "string",
67 "name": "string",
68 "description": "string",
69 "qrCode": "string",
70 "barCode": "string",
71 "imageId": 0,
72 "model": "string",
73 "manufacturer": "string",
74 "serialNumber": "string",
75 "cost": "81.08",
76 "premiseId": 0,
77 "premiseDisplayId": "string",
78 "premiseDto": {
79 "id": 0,
80 "createdBy": "string",
81 "createdAt": "2019-08-24T14:15:22Z",
82 "displayId": "string",
83 "premiseName": "string",
84 "description": "string",
85 "address": "string",
86 "internalTeamNames": [
87 "string"
88 ],
89 "internalTeamIds": [
90 0
91 ],
92 "premiseAvailable": true,
93 "premiseFromNrm": true,
94 "nlmId": 0,
95 "nlmDisplayId": "string",
96 "nlmUsed": true,
97 "manager": 0,
98 "managerName": "string",
99 "imageId": 0,
100 "area": "string",
101 "modifiedAt": "2019-08-24T14:15:22Z"
102 },
103 "acquisitionDate": "2019-08-24",
104 "endOfLife": "2019-08-24",
105 "assetStatusId": 0,
106 "assetStatus": "string",
107 "assetStatusType": "string",
108 "parentAssetId": 0,
109 "parentAssetDisplayId": "string",
110 "parentAsset": "string",
111 "parentAssetDto": {},
112 "upcomingMaintenanceDate": "2019-08-24",
113 "assetCategoryIds": [
114 0
115 ],
116 "assetCategories": [
117 "string"
118 ],
119 "internalTeamIds": [
120 0
121 ],
122 "internalTeamDtos": [
123 {
124 "id": 0,
125 "createdBy": "string",
126 "createdAt": "2019-08-24T14:15:22Z",
127 "displayId": "string",
128 "name": "string",
129 "email": "string",
130 "phone": "string",
131 "manager": "string",
132 "requestCategoryName": [
133 "string"
134 ],
135 "requestCategoryId": [
136 0
137 ],
138 "requestCategoryDisplayId": [
139 "string"
140 ],
141 "description": "string",
142 "internalTeamUser": [
143 0
144 ],
145 "members": 0,
146 "mainAssets": [
147 0
148 ],
149 "premiseNames": [
150 "string"
151 ],
152 "internalTeamAvailable": true,
153 "premiseIds": [
154 0
155 ]
156 }
157 ],
158 "internalTeams": [
159 "string"
160 ],
161 "assignedUserIds": [
162 0
163 ],
164 "assignedUserDtos": [
165 {
166 "id": 0,
167 "createdBy": "string",
168 "createdAt": "2019-08-24T14:15:22Z",
169 "userName": "string",
170 "firstName": "string",
171 "lastName": "string",
172 "email": "string",
173 "roleIds": [
174 {
175 "id": 0,
176 "createdBy": "string",
177 "createdAt": "2019-08-24T14:15:22Z",
178 "modifiedBy": "string",
179 "modifiedAt": "2019-08-24T14:15:22Z",
180 "roleName": "string",
181 "entity": "string",
182 "new": true
183 }
184 ],
185 "internalTeamNames": [
186 "string"
187 ],
188 "internalTeamIds": [
189 0
190 ],
191 "internalTeamDisplayIds": [
192 "string"
193 ],
194 "premiseIds": [
195 0
196 ],
197 "premiseNames": [
198 "string"
199 ],
200 "userAvailable": true,
201 "temporaryWorkload": 0,
202 "preferredCultureCode": "string"
203 }
204 ],
205 "assignedUsers": [
206 "string"
207 ],
208 "assetPriority": "string",
209 "assetPriorityId": 0,
210 "assetPriorityDisplayId": "string",
211 "assetPriorityType": "string",
212 "assetAvailable": true,
213 "exactPlacement": "string",
214 "fosId": 0,
215 "downtimeStatus": "string",
216 "premiseFromNrm": true,
217 "modifiedAt": "2019-08-24T14:15:22Z"
218 },
219 "mainAssetDisplayId": "string",
220 "inspectionCategoryIds": [
221 0
222 ],
223 "inspectionCategories": [
224 "string"
225 ],
226 "inspectionCategoryId": 0,
227 "inspectionCategory": "string",
228 "inspectionConditionId": 0,
229 "inspectionCondition": "string",
230 "inspectionConditionType": "string",
231 "inspectionStatusId": 0,
232 "inspectionStatus": "string",
233 "inspectionStatusType": "string",
234 "inspectionItemIds": [
235 0
236 ],
237 "internalTeamIds": [
238 0
239 ],
240 "internalTeamDtos": [
241 {
242 "id": 0,
243 "createdBy": "string",
244 "createdAt": "2019-08-24T14:15:22Z",
245 "displayId": "string",
246 "name": "string",
247 "email": "string",
248 "phone": "string",
249 "manager": "string",
250 "requestCategoryName": [
251 "string"
252 ],
253 "requestCategoryId": [
254 0
255 ],
256 "requestCategoryDisplayId": [
257 "string"
258 ],
259 "description": "string",
260 "internalTeamUser": [
261 0
262 ],
263 "members": 0,
264 "mainAssets": [
265 0
266 ],
267 "premiseNames": [
268 "string"
269 ],
270 "internalTeamAvailable": true,
271 "premiseIds": [
272 0
273 ]
274 }
275 ],
276 "internalTeams": [
277 "string"
278 ],
279 "assignedUserIds": [
280 0
281 ],
282 "assignedUserDtos": [
283 {
284 "id": 0,
285 "createdBy": "string",
286 "createdAt": "2019-08-24T14:15:22Z",
287 "userName": "string",
288 "firstName": "string",
289 "lastName": "string",
290 "email": "string",
291 "roleIds": [
292 {
293 "id": 0,
294 "createdBy": "string",
295 "createdAt": "2019-08-24T14:15:22Z",
296 "modifiedBy": "string",
297 "modifiedAt": "2019-08-24T14:15:22Z",
298 "roleName": "string",
299 "entity": "string",
300 "new": true
301 }
302 ],
303 "internalTeamNames": [
304 "string"
305 ],
306 "internalTeamIds": [
307 0
308 ],
309 "internalTeamDisplayIds": [
310 "string"
311 ],
312 "premiseIds": [
313 0
314 ],
315 "premiseNames": [
316 "string"
317 ],
318 "userAvailable": true,
319 "temporaryWorkload": 0,
320 "preferredCultureCode": "string"
321 }
322 ],
323 "assignedUsers": [
324 "string"
325 ],
326 "activity": "string",
327 "createdByTrigger": true,
328 "modifiedAt": "2019-08-24T14:15:22Z"
329}
Update Inspection¶
HTTP Request
PUT /api/inspections/{id}
📋 Description: Updates the details of a specific inspection identified by its unique ID, allowing for modifications to inspection data to ensure accuracy and compliance with business standards.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated inspection details, including status, findings, and relevant metadata for the specified inspection 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 "dueDate": "2019-08-24",
9 "closeDate": "2019-08-24",
10 "createdDate": "2019-08-24",
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "startTime": {
14 "hour": 0,
15 "minute": 0,
16 "second": 0,
17 "nano": 0
18 },
19 "endTime": {
20 "hour": 0,
21 "minute": 0,
22 "second": 0,
23 "nano": 0
24 },
25 "isCreatedBy": "string",
26 "isTemplate": true,
27 "inspectionAvailable": true,
28 "inspectionType": "string",
29 "templateId": 0,
30 "premiseId": 0,
31 "premiseDto": {
32 "id": 0,
33 "createdBy": "string",
34 "createdAt": "2019-08-24T14:15:22Z",
35 "displayId": "string",
36 "premiseName": "string",
37 "description": "string",
38 "address": "string",
39 "internalTeamNames": [
40 "string"
41 ],
42 "internalTeamIds": [
43 0
44 ],
45 "premiseAvailable": true,
46 "premiseFromNrm": true,
47 "nlmId": 0,
48 "nlmDisplayId": "string",
49 "nlmUsed": true,
50 "manager": 0,
51 "managerName": "string",
52 "imageId": 0,
53 "area": "string",
54 "modifiedAt": "2019-08-24T14:15:22Z"
55 },
56 "premiseFromNrm": true,
57 "premiseDisplayId": "string",
58 "mainAssetIds": [
59 0
60 ],
61 "mainAssetId": 0,
62 "mainAssetDto": {
63 "id": 0,
64 "createdBy": "string",
65 "createdAt": "2019-08-24T14:15:22Z",
66 "displayId": "string",
67 "name": "string",
68 "description": "string",
69 "qrCode": "string",
70 "barCode": "string",
71 "imageId": 0,
72 "model": "string",
73 "manufacturer": "string",
74 "serialNumber": "string",
75 "cost": "81.08",
76 "premiseId": 0,
77 "premiseDisplayId": "string",
78 "premiseDto": {
79 "id": 0,
80 "createdBy": "string",
81 "createdAt": "2019-08-24T14:15:22Z",
82 "displayId": "string",
83 "premiseName": "string",
84 "description": "string",
85 "address": "string",
86 "internalTeamNames": [
87 "string"
88 ],
89 "internalTeamIds": [
90 0
91 ],
92 "premiseAvailable": true,
93 "premiseFromNrm": true,
94 "nlmId": 0,
95 "nlmDisplayId": "string",
96 "nlmUsed": true,
97 "manager": 0,
98 "managerName": "string",
99 "imageId": 0,
100 "area": "string",
101 "modifiedAt": "2019-08-24T14:15:22Z"
102 },
103 "acquisitionDate": "2019-08-24",
104 "endOfLife": "2019-08-24",
105 "assetStatusId": 0,
106 "assetStatus": "string",
107 "assetStatusType": "string",
108 "parentAssetId": 0,
109 "parentAssetDisplayId": "string",
110 "parentAsset": "string",
111 "parentAssetDto": {},
112 "upcomingMaintenanceDate": "2019-08-24",
113 "assetCategoryIds": [
114 0
115 ],
116 "assetCategories": [
117 "string"
118 ],
119 "internalTeamIds": [
120 0
121 ],
122 "internalTeamDtos": [
123 {
124 "id": 0,
125 "createdBy": "string",
126 "createdAt": "2019-08-24T14:15:22Z",
127 "displayId": "string",
128 "name": "string",
129 "email": "string",
130 "phone": "string",
131 "manager": "string",
132 "requestCategoryName": [
133 "string"
134 ],
135 "requestCategoryId": [
136 0
137 ],
138 "requestCategoryDisplayId": [
139 "string"
140 ],
141 "description": "string",
142 "internalTeamUser": [
143 0
144 ],
145 "members": 0,
146 "mainAssets": [
147 0
148 ],
149 "premiseNames": [
150 "string"
151 ],
152 "internalTeamAvailable": true,
153 "premiseIds": [
154 0
155 ]
156 }
157 ],
158 "internalTeams": [
159 "string"
160 ],
161 "assignedUserIds": [
162 0
163 ],
164 "assignedUserDtos": [
165 {
166 "id": 0,
167 "createdBy": "string",
168 "createdAt": "2019-08-24T14:15:22Z",
169 "userName": "string",
170 "firstName": "string",
171 "lastName": "string",
172 "email": "string",
173 "roleIds": [
174 {
175 "id": 0,
176 "createdBy": "string",
177 "createdAt": "2019-08-24T14:15:22Z",
178 "modifiedBy": "string",
179 "modifiedAt": "2019-08-24T14:15:22Z",
180 "roleName": "string",
181 "entity": "string",
182 "new": true
183 }
184 ],
185 "internalTeamNames": [
186 "string"
187 ],
188 "internalTeamIds": [
189 0
190 ],
191 "internalTeamDisplayIds": [
192 "string"
193 ],
194 "premiseIds": [
195 0
196 ],
197 "premiseNames": [
198 "string"
199 ],
200 "userAvailable": true,
201 "temporaryWorkload": 0,
202 "preferredCultureCode": "string"
203 }
204 ],
205 "assignedUsers": [
206 "string"
207 ],
208 "assetPriority": "string",
209 "assetPriorityId": 0,
210 "assetPriorityDisplayId": "string",
211 "assetPriorityType": "string",
212 "assetAvailable": true,
213 "exactPlacement": "string",
214 "fosId": 0,
215 "downtimeStatus": "string",
216 "premiseFromNrm": true,
217 "modifiedAt": "2019-08-24T14:15:22Z"
218 },
219 "mainAssetDisplayId": "string",
220 "inspectionCategoryIds": [
221 0
222 ],
223 "inspectionCategories": [
224 "string"
225 ],
226 "inspectionCategoryId": 0,
227 "inspectionCategory": "string",
228 "inspectionConditionId": 0,
229 "inspectionCondition": "string",
230 "inspectionConditionType": "string",
231 "inspectionStatusId": 0,
232 "inspectionStatus": "string",
233 "inspectionStatusType": "string",
234 "inspectionItemIds": [
235 0
236 ],
237 "internalTeamIds": [
238 0
239 ],
240 "internalTeamDtos": [
241 {
242 "id": 0,
243 "createdBy": "string",
244 "createdAt": "2019-08-24T14:15:22Z",
245 "displayId": "string",
246 "name": "string",
247 "email": "string",
248 "phone": "string",
249 "manager": "string",
250 "requestCategoryName": [
251 "string"
252 ],
253 "requestCategoryId": [
254 0
255 ],
256 "requestCategoryDisplayId": [
257 "string"
258 ],
259 "description": "string",
260 "internalTeamUser": [
261 0
262 ],
263 "members": 0,
264 "mainAssets": [
265 0
266 ],
267 "premiseNames": [
268 "string"
269 ],
270 "internalTeamAvailable": true,
271 "premiseIds": [
272 0
273 ]
274 }
275 ],
276 "internalTeams": [
277 "string"
278 ],
279 "assignedUserIds": [
280 0
281 ],
282 "assignedUserDtos": [
283 {
284 "id": 0,
285 "createdBy": "string",
286 "createdAt": "2019-08-24T14:15:22Z",
287 "userName": "string",
288 "firstName": "string",
289 "lastName": "string",
290 "email": "string",
291 "roleIds": [
292 {
293 "id": 0,
294 "createdBy": "string",
295 "createdAt": "2019-08-24T14:15:22Z",
296 "modifiedBy": "string",
297 "modifiedAt": "2019-08-24T14:15:22Z",
298 "roleName": "string",
299 "entity": "string",
300 "new": true
301 }
302 ],
303 "internalTeamNames": [
304 "string"
305 ],
306 "internalTeamIds": [
307 0
308 ],
309 "internalTeamDisplayIds": [
310 "string"
311 ],
312 "premiseIds": [
313 0
314 ],
315 "premiseNames": [
316 "string"
317 ],
318 "userAvailable": true,
319 "temporaryWorkload": 0,
320 "preferredCultureCode": "string"
321 }
322 ],
323 "assignedUsers": [
324 "string"
325 ],
326 "activity": "string",
327 "createdByTrigger": true,
328 "modifiedAt": "2019-08-24T14:15:22Z"
329}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Inspection¶
HTTP Request
DELETE /api/inspections/{id}
📋 Description: Deletes a specific inspection record identified by its unique ID, ensuring the removal of outdated or irrelevant data from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Update Asset Inspection¶
HTTP Request
PUT /api/inspections/updateAsset/{id}
📋 Description: Updates the asset details for a specified inspection, allowing users to modify relevant information to ensure accurate and up-to-date records. This operation is essential for maintaining the integrity of asset management within the inspection process.
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, condition, and location, to facilitate accurate inspection 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 "dueDate": "2019-08-24",
9 "closeDate": "2019-08-24",
10 "createdDate": "2019-08-24",
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "startTime": {
14 "hour": 0,
15 "minute": 0,
16 "second": 0,
17 "nano": 0
18 },
19 "endTime": {
20 "hour": 0,
21 "minute": 0,
22 "second": 0,
23 "nano": 0
24 },
25 "isCreatedBy": "string",
26 "isTemplate": true,
27 "inspectionAvailable": true,
28 "inspectionType": "string",
29 "templateId": 0,
30 "premiseId": 0,
31 "premiseDto": {
32 "id": 0,
33 "createdBy": "string",
34 "createdAt": "2019-08-24T14:15:22Z",
35 "displayId": "string",
36 "premiseName": "string",
37 "description": "string",
38 "address": "string",
39 "internalTeamNames": [
40 "string"
41 ],
42 "internalTeamIds": [
43 0
44 ],
45 "premiseAvailable": true,
46 "premiseFromNrm": true,
47 "nlmId": 0,
48 "nlmDisplayId": "string",
49 "nlmUsed": true,
50 "manager": 0,
51 "managerName": "string",
52 "imageId": 0,
53 "area": "string",
54 "modifiedAt": "2019-08-24T14:15:22Z"
55 },
56 "premiseFromNrm": true,
57 "premiseDisplayId": "string",
58 "mainAssetIds": [
59 0
60 ],
61 "mainAssetId": 0,
62 "mainAssetDto": {
63 "id": 0,
64 "createdBy": "string",
65 "createdAt": "2019-08-24T14:15:22Z",
66 "displayId": "string",
67 "name": "string",
68 "description": "string",
69 "qrCode": "string",
70 "barCode": "string",
71 "imageId": 0,
72 "model": "string",
73 "manufacturer": "string",
74 "serialNumber": "string",
75 "cost": "81.08",
76 "premiseId": 0,
77 "premiseDisplayId": "string",
78 "premiseDto": {
79 "id": 0,
80 "createdBy": "string",
81 "createdAt": "2019-08-24T14:15:22Z",
82 "displayId": "string",
83 "premiseName": "string",
84 "description": "string",
85 "address": "string",
86 "internalTeamNames": [
87 "string"
88 ],
89 "internalTeamIds": [
90 0
91 ],
92 "premiseAvailable": true,
93 "premiseFromNrm": true,
94 "nlmId": 0,
95 "nlmDisplayId": "string",
96 "nlmUsed": true,
97 "manager": 0,
98 "managerName": "string",
99 "imageId": 0,
100 "area": "string",
101 "modifiedAt": "2019-08-24T14:15:22Z"
102 },
103 "acquisitionDate": "2019-08-24",
104 "endOfLife": "2019-08-24",
105 "assetStatusId": 0,
106 "assetStatus": "string",
107 "assetStatusType": "string",
108 "parentAssetId": 0,
109 "parentAssetDisplayId": "string",
110 "parentAsset": "string",
111 "parentAssetDto": {},
112 "upcomingMaintenanceDate": "2019-08-24",
113 "assetCategoryIds": [
114 0
115 ],
116 "assetCategories": [
117 "string"
118 ],
119 "internalTeamIds": [
120 0
121 ],
122 "internalTeamDtos": [
123 {
124 "id": 0,
125 "createdBy": "string",
126 "createdAt": "2019-08-24T14:15:22Z",
127 "displayId": "string",
128 "name": "string",
129 "email": "string",
130 "phone": "string",
131 "manager": "string",
132 "requestCategoryName": [
133 "string"
134 ],
135 "requestCategoryId": [
136 0
137 ],
138 "requestCategoryDisplayId": [
139 "string"
140 ],
141 "description": "string",
142 "internalTeamUser": [
143 0
144 ],
145 "members": 0,
146 "mainAssets": [
147 0
148 ],
149 "premiseNames": [
150 "string"
151 ],
152 "internalTeamAvailable": true,
153 "premiseIds": [
154 0
155 ]
156 }
157 ],
158 "internalTeams": [
159 "string"
160 ],
161 "assignedUserIds": [
162 0
163 ],
164 "assignedUserDtos": [
165 {
166 "id": 0,
167 "createdBy": "string",
168 "createdAt": "2019-08-24T14:15:22Z",
169 "userName": "string",
170 "firstName": "string",
171 "lastName": "string",
172 "email": "string",
173 "roleIds": [
174 {
175 "id": 0,
176 "createdBy": "string",
177 "createdAt": "2019-08-24T14:15:22Z",
178 "modifiedBy": "string",
179 "modifiedAt": "2019-08-24T14:15:22Z",
180 "roleName": "string",
181 "entity": "string",
182 "new": true
183 }
184 ],
185 "internalTeamNames": [
186 "string"
187 ],
188 "internalTeamIds": [
189 0
190 ],
191 "internalTeamDisplayIds": [
192 "string"
193 ],
194 "premiseIds": [
195 0
196 ],
197 "premiseNames": [
198 "string"
199 ],
200 "userAvailable": true,
201 "temporaryWorkload": 0,
202 "preferredCultureCode": "string"
203 }
204 ],
205 "assignedUsers": [
206 "string"
207 ],
208 "assetPriority": "string",
209 "assetPriorityId": 0,
210 "assetPriorityDisplayId": "string",
211 "assetPriorityType": "string",
212 "assetAvailable": true,
213 "exactPlacement": "string",
214 "fosId": 0,
215 "downtimeStatus": "string",
216 "premiseFromNrm": true,
217 "modifiedAt": "2019-08-24T14:15:22Z"
218 },
219 "mainAssetDisplayId": "string",
220 "inspectionCategoryIds": [
221 0
222 ],
223 "inspectionCategories": [
224 "string"
225 ],
226 "inspectionCategoryId": 0,
227 "inspectionCategory": "string",
228 "inspectionConditionId": 0,
229 "inspectionCondition": "string",
230 "inspectionConditionType": "string",
231 "inspectionStatusId": 0,
232 "inspectionStatus": "string",
233 "inspectionStatusType": "string",
234 "inspectionItemIds": [
235 0
236 ],
237 "internalTeamIds": [
238 0
239 ],
240 "internalTeamDtos": [
241 {
242 "id": 0,
243 "createdBy": "string",
244 "createdAt": "2019-08-24T14:15:22Z",
245 "displayId": "string",
246 "name": "string",
247 "email": "string",
248 "phone": "string",
249 "manager": "string",
250 "requestCategoryName": [
251 "string"
252 ],
253 "requestCategoryId": [
254 0
255 ],
256 "requestCategoryDisplayId": [
257 "string"
258 ],
259 "description": "string",
260 "internalTeamUser": [
261 0
262 ],
263 "members": 0,
264 "mainAssets": [
265 0
266 ],
267 "premiseNames": [
268 "string"
269 ],
270 "internalTeamAvailable": true,
271 "premiseIds": [
272 0
273 ]
274 }
275 ],
276 "internalTeams": [
277 "string"
278 ],
279 "assignedUserIds": [
280 0
281 ],
282 "assignedUserDtos": [
283 {
284 "id": 0,
285 "createdBy": "string",
286 "createdAt": "2019-08-24T14:15:22Z",
287 "userName": "string",
288 "firstName": "string",
289 "lastName": "string",
290 "email": "string",
291 "roleIds": [
292 {
293 "id": 0,
294 "createdBy": "string",
295 "createdAt": "2019-08-24T14:15:22Z",
296 "modifiedBy": "string",
297 "modifiedAt": "2019-08-24T14:15:22Z",
298 "roleName": "string",
299 "entity": "string",
300 "new": true
301 }
302 ],
303 "internalTeamNames": [
304 "string"
305 ],
306 "internalTeamIds": [
307 0
308 ],
309 "internalTeamDisplayIds": [
310 "string"
311 ],
312 "premiseIds": [
313 0
314 ],
315 "premiseNames": [
316 "string"
317 ],
318 "userAvailable": true,
319 "temporaryWorkload": 0,
320 "preferredCultureCode": "string"
321 }
322 ],
323 "assignedUsers": [
324 "string"
325 ],
326 "activity": "string",
327 "createdByTrigger": true,
328 "modifiedAt": "2019-08-24T14:15:22Z"
329}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get All Inspections¶
HTTP Request
GET /api/inspections
📋 Description: Retrieves a list of inspections, allowing users to access detailed information on completed and scheduled inspections for effective compliance and quality 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 "dueDate": "2019-08-24",
10 "closeDate": "2019-08-24",
11 "createdDate": "2019-08-24",
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "startTime": {
15 "hour": 0,
16 "minute": 0,
17 "second": 0,
18 "nano": 0
19 },
20 "endTime": {
21 "hour": 0,
22 "minute": 0,
23 "second": 0,
24 "nano": 0
25 },
26 "isCreatedBy": "string",
27 "isTemplate": true,
28 "inspectionAvailable": true,
29 "inspectionType": "string",
30 "templateId": 0,
31 "premiseId": 0,
32 "premiseDto": {
33 "id": 0,
34 "createdBy": "string",
35 "createdAt": "2019-08-24T14:15:22Z",
36 "displayId": "string",
37 "premiseName": "string",
38 "description": "string",
39 "address": "string",
40 "internalTeamNames": [
41 "string"
42 ],
43 "internalTeamIds": [
44 0
45 ],
46 "premiseAvailable": true,
47 "premiseFromNrm": true,
48 "nlmId": 0,
49 "nlmDisplayId": "string",
50 "nlmUsed": true,
51 "manager": 0,
52 "managerName": "string",
53 "imageId": 0,
54 "area": "string",
55 "modifiedAt": "2019-08-24T14:15:22Z"
56 },
57 "premiseFromNrm": true,
58 "premiseDisplayId": "string",
59 "mainAssetIds": [
60 0
61 ],
62 "mainAssetId": 0,
63 "mainAssetDto": {
64 "id": 0,
65 "createdBy": "string",
66 "createdAt": "2019-08-24T14:15:22Z",
67 "displayId": "string",
68 "name": "string",
69 "description": "string",
70 "qrCode": "string",
71 "barCode": "string",
72 "imageId": 0,
73 "model": "string",
74 "manufacturer": "string",
75 "serialNumber": "string",
76 "cost": "81.08",
77 "premiseId": 0,
78 "premiseDisplayId": "string",
79 "premiseDto": {
80 "id": 0,
81 "createdBy": "string",
82 "createdAt": "2019-08-24T14:15:22Z",
83 "displayId": "string",
84 "premiseName": "string",
85 "description": "string",
86 "address": "string",
87 "internalTeamNames": [
88 "string"
89 ],
90 "internalTeamIds": [
91 0
92 ],
93 "premiseAvailable": true,
94 "premiseFromNrm": true,
95 "nlmId": 0,
96 "nlmDisplayId": "string",
97 "nlmUsed": true,
98 "manager": 0,
99 "managerName": "string",
100 "imageId": 0,
101 "area": "string",
102 "modifiedAt": "2019-08-24T14:15:22Z"
103 },
104 "acquisitionDate": "2019-08-24",
105 "endOfLife": "2019-08-24",
106 "assetStatusId": 0,
107 "assetStatus": "string",
108 "assetStatusType": "string",
109 "parentAssetId": 0,
110 "parentAssetDisplayId": "string",
111 "parentAsset": "string",
112 "parentAssetDto": {},
113 "upcomingMaintenanceDate": "2019-08-24",
114 "assetCategoryIds": [
115 0
116 ],
117 "assetCategories": [
118 "string"
119 ],
120 "internalTeamIds": [
121 0
122 ],
123 "internalTeamDtos": [
124 {
125 "id": 0,
126 "createdBy": "string",
127 "createdAt": "2019-08-24T14:15:22Z",
128 "displayId": "string",
129 "name": "string",
130 "email": "string",
131 "phone": "string",
132 "manager": "string",
133 "requestCategoryName": [
134 "string"
135 ],
136 "requestCategoryId": [
137 0
138 ],
139 "requestCategoryDisplayId": [
140 "string"
141 ],
142 "description": "string",
143 "internalTeamUser": [
144 0
145 ],
146 "members": 0,
147 "mainAssets": [
148 0
149 ],
150 "premiseNames": [
151 "string"
152 ],
153 "internalTeamAvailable": true,
154 "premiseIds": [
155 0
156 ]
157 }
158 ],
159 "internalTeams": [
160 "string"
161 ],
162 "assignedUserIds": [
163 0
164 ],
165 "assignedUserDtos": [
166 {
167 "id": 0,
168 "createdBy": "string",
169 "createdAt": "2019-08-24T14:15:22Z",
170 "userName": "string",
171 "firstName": "string",
172 "lastName": "string",
173 "email": "string",
174 "roleIds": [
175 {
176 "id": 0,
177 "createdBy": "string",
178 "createdAt": "2019-08-24T14:15:22Z",
179 "modifiedBy": "string",
180 "modifiedAt": "2019-08-24T14:15:22Z",
181 "roleName": "string",
182 "entity": "string",
183 "new": true
184 }
185 ],
186 "internalTeamNames": [
187 "string"
188 ],
189 "internalTeamIds": [
190 0
191 ],
192 "internalTeamDisplayIds": [
193 "string"
194 ],
195 "premiseIds": [
196 0
197 ],
198 "premiseNames": [
199 "string"
200 ],
201 "userAvailable": true,
202 "temporaryWorkload": 0,
203 "preferredCultureCode": "string"
204 }
205 ],
206 "assignedUsers": [
207 "string"
208 ],
209 "assetPriority": "string",
210 "assetPriorityId": 0,
211 "assetPriorityDisplayId": "string",
212 "assetPriorityType": "string",
213 "assetAvailable": true,
214 "exactPlacement": "string",
215 "fosId": 0,
216 "downtimeStatus": "string",
217 "premiseFromNrm": true,
218 "modifiedAt": "2019-08-24T14:15:22Z"
219 },
220 "mainAssetDisplayId": "string",
221 "inspectionCategoryIds": [
222 0
223 ],
224 "inspectionCategories": [
225 "string"
226 ],
227 "inspectionCategoryId": 0,
228 "inspectionCategory": "string",
229 "inspectionConditionId": 0,
230 "inspectionCondition": "string",
231 "inspectionConditionType": "string",
232 "inspectionStatusId": 0,
233 "inspectionStatus": "string",
234 "inspectionStatusType": "string",
235 "inspectionItemIds": [
236 0
237 ],
238 "internalTeamIds": [
239 0
240 ],
241 "internalTeamDtos": [
242 {
243 "id": 0,
244 "createdBy": "string",
245 "createdAt": "2019-08-24T14:15:22Z",
246 "displayId": "string",
247 "name": "string",
248 "email": "string",
249 "phone": "string",
250 "manager": "string",
251 "requestCategoryName": [
252 "string"
253 ],
254 "requestCategoryId": [
255 0
256 ],
257 "requestCategoryDisplayId": [
258 "string"
259 ],
260 "description": "string",
261 "internalTeamUser": [
262 0
263 ],
264 "members": 0,
265 "mainAssets": [
266 0
267 ],
268 "premiseNames": [
269 "string"
270 ],
271 "internalTeamAvailable": true,
272 "premiseIds": [
273 0
274 ]
275 }
276 ],
277 "internalTeams": [
278 "string"
279 ],
280 "assignedUserIds": [
281 0
282 ],
283 "assignedUserDtos": [
284 {
285 "id": 0,
286 "createdBy": "string",
287 "createdAt": "2019-08-24T14:15:22Z",
288 "userName": "string",
289 "firstName": "string",
290 "lastName": "string",
291 "email": "string",
292 "roleIds": [
293 {
294 "id": 0,
295 "createdBy": "string",
296 "createdAt": "2019-08-24T14:15:22Z",
297 "modifiedBy": "string",
298 "modifiedAt": "2019-08-24T14:15:22Z",
299 "roleName": "string",
300 "entity": "string",
301 "new": true
302 }
303 ],
304 "internalTeamNames": [
305 "string"
306 ],
307 "internalTeamIds": [
308 0
309 ],
310 "internalTeamDisplayIds": [
311 "string"
312 ],
313 "premiseIds": [
314 0
315 ],
316 "premiseNames": [
317 "string"
318 ],
319 "userAvailable": true,
320 "temporaryWorkload": 0,
321 "preferredCultureCode": "string"
322 }
323 ],
324 "assignedUsers": [
325 "string"
326 ],
327 "activity": "string",
328 "createdByTrigger": true,
329 "modifiedAt": "2019-08-24T14:15:22Z"
330 }
331]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the details of an inspection, including its findings, status, and associated metadata, to facilitate effective tracking and management of compliance and quality assurance processes.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
false |
none |
Name of the resource |
» description |
string |
false |
none |
Description of the resource |
» dueDate |
string(date) |
false |
none |
Due date of the resource |
» closeDate |
string(date) |
false |
none |
Date of the close |
» createdDate |
string(date) |
false |
none |
Date of the created |
» 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. |
|
» isCreatedBy |
string |
false |
none |
Whether the resource is created by |
» isTemplate |
boolean |
false |
none |
Whether the resource is template |
» inspectionAvailable |
boolean |
false |
none |
Indicates whether an inspection is available for the associated item, facilitating proactive management and compliance verification. |
» inspectionType |
string |
false |
none |
Type of the inspection |
» templateId |
integer(int64) |
false |
none |
Unique identifier for the template |
» 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 inspection is sourced from the National Risk Model, facilitating informed decision-making in risk assessment processes. |
» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
» mainAssetIds |
[integer] |
false |
none |
List of unique identifiers for the primary assets associated with the inspection, facilitating effective tracking and management. |
» mainAssetId |
integer(int64) |
false |
none |
Unique identifier for the main asset |
» mainAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» name |
string |
false |
none |
Name of the resource |
»» description |
string |
false |
none |
Description of the resource |
»» qrCode |
string |
false |
none |
Code for the qr |
»» barCode |
string |
false |
none |
Code for the bar |
»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»» model |
string |
false |
none |
Specifies the model associated with the main asset, providing essential context for asset classification and management. |
»» manufacturer |
string |
false |
none |
Name of the manufacturer associated with the asset, providing essential information for inventory management and supplier relations. |
»» serialNumber |
string |
false |
none |
Unique identifier for the asset, used to track and manage inventory within the system. |
»» cost |
string |
false |
none |
Represents the total cost associated with the main asset, providing essential financial information for budgeting and resource allocation. |
»» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
»» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
»» premiseDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
»» acquisitionDate |
string(date) |
false |
none |
Date of the acquisition |
»» endOfLife |
string(date) |
false |
none |
Indicates the end-of-life date for the asset, providing critical information for lifecycle management and planning. |
»» assetStatusId |
integer(int64) |
false |
none |
Unique identifier for the asset status |
»» assetStatus |
string |
false |
none |
Status of the asset |
»» assetStatusType |
string |
false |
none |
Type of the asset status |
»» parentAssetId |
integer(int64) |
false |
none |
Unique identifier for the parent asset |
»» parentAssetDisplayId |
string |
false |
none |
Unique identifier for the parent asset display |
»» parentAsset |
string |
false |
none |
Identifier for the parent asset associated with the main asset, facilitating hierarchical relationships within asset management. |
»» parentAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»» upcomingMaintenanceDate |
string(date) |
false |
none |
Date of the upcoming maintenance |
»» assetCategoryIds |
[integer] |
false |
none |
Array of unique identifiers representing the categories to which the asset belongs, facilitating effective asset classification and management. |
»» assetCategories |
[string] |
false |
none |
Array of asset categories that classify the main assets within the system, facilitating better organization and management of asset data. |
»» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the main asset, facilitating streamlined collaboration and resource allocation. |
»» internalTeamDtos |
false |
none |
An array of MainAssetDTO objects representing the internal teams associated with the asset, facilitating effective resource management and collaboration within the organization. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» name |
string |
false |
none |
Name of the resource |
string |
false |
none |
Email address of the internal team member, used for communication and notifications within the organization. |
|
»»» phone |
string |
false |
none |
Contact number for the internal team, facilitating communication and collaboration within the organization. |
»»» manager |
string |
false |
none |
Represents the name or identifier of the team manager responsible for overseeing the internal team. |
»»» requestCategoryName |
[string] |
false |
none |
Name of the request category |
»»» requestCategoryId |
[integer] |
false |
none |
Unique identifier for the request category |
»»» requestCategoryDisplayId |
[string] |
false |
none |
Unique identifier for the request category display |
»»» description |
string |
false |
none |
Description of the resource |
»»» internalTeamUser |
[integer] |
false |
none |
An array of InternalTeamDTO objects representing the users within the internal team, facilitating collaboration and resource management. |
»»» members |
integer(int32) |
false |
none |
Represents the total number of members within the internal team, providing insight into team size for resource allocation and management. |
»»» mainAssets |
[integer] |
false |
none |
An array of internal team assets that represent the key resources and capabilities utilized within the organization. |
»»» premiseNames |
[string] |
false |
none |
List of names associated with the premises relevant to the internal team, facilitating efficient identification and management of locations within the organization. |
»»» internalTeamAvailable |
boolean |
false |
none |
Indicates the availability of the internal team for project allocation and resource planning. |
»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the internal team. |
»» internalTeams |
[string] |
false |
none |
An array of internal teams associated with the main asset, facilitating collaboration and resource allocation within the organization. |
»» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers representing users assigned to the main asset, facilitating effective resource management and accountability. |
»» assignedUserDtos |
false |
none |
Array of user assignments associated with the main asset, providing insights into resource allocation and accountability. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» userName |
string |
false |
none |
Name of the user |
»»» firstName |
string |
false |
none |
Name of the first |
»»» lastName |
string |
false |
none |
Name of the last |
string |
false |
none |
Email address of the user, used for communication and account verification purposes within the system. |
|
»»» roleIds |
false |
none |
Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»»» modifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»»»» roleName |
string |
false |
none |
Name of the role |
»»»» entity |
string |
false |
none |
Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management. |
»»»» new |
boolean |
false |
none |
Indicates whether the role is newly created within the system, facilitating effective management of organizational changes. |
»»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization. |
»»» internalTeamIds |
[integer] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization. |
»»» internalTeamDisplayIds |
[string] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration. |
»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations. |
»»» premiseNames |
[string] |
false |
none |
List of names associated with the user’s premises, providing essential context for location-based services and operations. |
»»» userAvailable |
boolean |
false |
none |
Indicates whether the user is available for assignment or engagement within the system. |
»»» temporaryWorkload |
integer(int32) |
false |
none |
Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning. |
»»» preferredCultureCode |
string |
false |
none |
Code for the preferred culture |
»» assignedUsers |
[string] |
false |
none |
List of users assigned to the main asset, facilitating effective resource management and collaboration within the organization. |
»» assetPriority |
string |
false |
none |
Priority of the asset |
»» assetPriorityId |
integer(int64) |
false |
none |
Unique identifier for the asset priority |
»» assetPriorityDisplayId |
string |
false |
none |
Unique identifier for the asset priority display |
»» assetPriorityType |
string |
false |
none |
Type of the asset priority |
»» assetAvailable |
boolean |
false |
none |
Indicates whether the asset is currently available for allocation or use within the system. |
»» exactPlacement |
string |
false |
none |
Specifies the precise location or context in which the main asset is intended to be utilized within the business framework. |
»» fosId |
integer(int64) |
false |
none |
Unique identifier for the fos |
»» downtimeStatus |
string |
false |
none |
Status of the downtime |
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the asset is sourced from the National Resource Management (NRM) framework, facilitating compliance and resource tracking. |
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» mainAssetDisplayId |
string |
false |
none |
Unique identifier for the main asset display |
» inspectionCategoryIds |
[integer] |
false |
none |
Array of unique identifiers representing the categories of inspections associated with the inspection record. |
» inspectionCategories |
[string] |
false |
none |
An array of inspection categories that classify the types of inspections conducted, facilitating organized tracking and reporting. |
» inspectionCategoryId |
integer(int64) |
false |
none |
Unique identifier for the inspection category |
» inspectionCategory |
string |
false |
none |
Category of the inspection |
» inspectionConditionId |
integer(int64) |
false |
none |
Unique identifier for the inspection condition |
» inspectionCondition |
string |
false |
none |
Describes the current condition of the inspection, providing essential context for assessment and decision-making. |
» inspectionConditionType |
string |
false |
none |
Type of the inspection condition |
» inspectionStatusId |
integer(int64) |
false |
none |
Unique identifier for the inspection status |
» inspectionStatus |
string |
false |
none |
Status of the inspection |
» inspectionStatusType |
string |
false |
none |
Type of the inspection status |
» inspectionItemIds |
[integer] |
false |
none |
Array of unique identifiers for inspection items associated with the inspection process, facilitating efficient tracking and management. |
» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the inspection, facilitating streamlined collaboration and accountability within the organization. |
» internalTeamDtos |
false |
none |
An array of InspectionDTO objects representing the internal teams involved in the inspection process, facilitating effective collaboration and resource allocation. |
|
» internalTeams |
[string] |
false |
none |
Array of internal teams associated with the inspection, facilitating collaboration and accountability within the inspection process. |
» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers for users assigned to the inspection, facilitating effective tracking and management of responsibilities. |
» assignedUserDtos |
false |
none |
Array of InspectionDTO objects representing the users assigned to conduct inspections, facilitating effective resource allocation and management. |
|
» assignedUsers |
[string] |
false |
none |
List of users assigned to the inspection, facilitating effective task management and accountability within the inspection process. |
» activity |
string |
false |
none |
Describes the specific activity associated with the inspection, providing essential context for tracking and reporting purposes. |
» createdByTrigger |
boolean |
false |
none |
Indicates whether the inspection was initiated by an automated trigger within the system. |
» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
Create Inspection¶
HTTP Request
POST /api/inspections
📋 Description: Creates a new inspection record within the system, enabling organizations to efficiently manage and track inspection activities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the inspection details, including parameters such as inspection type, date, location, and any relevant notes for effective tracking and 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 "dueDate": "2019-08-24",
9 "closeDate": "2019-08-24",
10 "createdDate": "2019-08-24",
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "startTime": {
14 "hour": 0,
15 "minute": 0,
16 "second": 0,
17 "nano": 0
18 },
19 "endTime": {
20 "hour": 0,
21 "minute": 0,
22 "second": 0,
23 "nano": 0
24 },
25 "isCreatedBy": "string",
26 "isTemplate": true,
27 "inspectionAvailable": true,
28 "inspectionType": "string",
29 "templateId": 0,
30 "premiseId": 0,
31 "premiseDto": {
32 "id": 0,
33 "createdBy": "string",
34 "createdAt": "2019-08-24T14:15:22Z",
35 "displayId": "string",
36 "premiseName": "string",
37 "description": "string",
38 "address": "string",
39 "internalTeamNames": [
40 "string"
41 ],
42 "internalTeamIds": [
43 0
44 ],
45 "premiseAvailable": true,
46 "premiseFromNrm": true,
47 "nlmId": 0,
48 "nlmDisplayId": "string",
49 "nlmUsed": true,
50 "manager": 0,
51 "managerName": "string",
52 "imageId": 0,
53 "area": "string",
54 "modifiedAt": "2019-08-24T14:15:22Z"
55 },
56 "premiseFromNrm": true,
57 "premiseDisplayId": "string",
58 "mainAssetIds": [
59 0
60 ],
61 "mainAssetId": 0,
62 "mainAssetDto": {
63 "id": 0,
64 "createdBy": "string",
65 "createdAt": "2019-08-24T14:15:22Z",
66 "displayId": "string",
67 "name": "string",
68 "description": "string",
69 "qrCode": "string",
70 "barCode": "string",
71 "imageId": 0,
72 "model": "string",
73 "manufacturer": "string",
74 "serialNumber": "string",
75 "cost": "81.08",
76 "premiseId": 0,
77 "premiseDisplayId": "string",
78 "premiseDto": {
79 "id": 0,
80 "createdBy": "string",
81 "createdAt": "2019-08-24T14:15:22Z",
82 "displayId": "string",
83 "premiseName": "string",
84 "description": "string",
85 "address": "string",
86 "internalTeamNames": [
87 "string"
88 ],
89 "internalTeamIds": [
90 0
91 ],
92 "premiseAvailable": true,
93 "premiseFromNrm": true,
94 "nlmId": 0,
95 "nlmDisplayId": "string",
96 "nlmUsed": true,
97 "manager": 0,
98 "managerName": "string",
99 "imageId": 0,
100 "area": "string",
101 "modifiedAt": "2019-08-24T14:15:22Z"
102 },
103 "acquisitionDate": "2019-08-24",
104 "endOfLife": "2019-08-24",
105 "assetStatusId": 0,
106 "assetStatus": "string",
107 "assetStatusType": "string",
108 "parentAssetId": 0,
109 "parentAssetDisplayId": "string",
110 "parentAsset": "string",
111 "parentAssetDto": {},
112 "upcomingMaintenanceDate": "2019-08-24",
113 "assetCategoryIds": [
114 0
115 ],
116 "assetCategories": [
117 "string"
118 ],
119 "internalTeamIds": [
120 0
121 ],
122 "internalTeamDtos": [
123 {
124 "id": 0,
125 "createdBy": "string",
126 "createdAt": "2019-08-24T14:15:22Z",
127 "displayId": "string",
128 "name": "string",
129 "email": "string",
130 "phone": "string",
131 "manager": "string",
132 "requestCategoryName": [
133 "string"
134 ],
135 "requestCategoryId": [
136 0
137 ],
138 "requestCategoryDisplayId": [
139 "string"
140 ],
141 "description": "string",
142 "internalTeamUser": [
143 0
144 ],
145 "members": 0,
146 "mainAssets": [
147 0
148 ],
149 "premiseNames": [
150 "string"
151 ],
152 "internalTeamAvailable": true,
153 "premiseIds": [
154 0
155 ]
156 }
157 ],
158 "internalTeams": [
159 "string"
160 ],
161 "assignedUserIds": [
162 0
163 ],
164 "assignedUserDtos": [
165 {
166 "id": 0,
167 "createdBy": "string",
168 "createdAt": "2019-08-24T14:15:22Z",
169 "userName": "string",
170 "firstName": "string",
171 "lastName": "string",
172 "email": "string",
173 "roleIds": [
174 {
175 "id": 0,
176 "createdBy": "string",
177 "createdAt": "2019-08-24T14:15:22Z",
178 "modifiedBy": "string",
179 "modifiedAt": "2019-08-24T14:15:22Z",
180 "roleName": "string",
181 "entity": "string",
182 "new": true
183 }
184 ],
185 "internalTeamNames": [
186 "string"
187 ],
188 "internalTeamIds": [
189 0
190 ],
191 "internalTeamDisplayIds": [
192 "string"
193 ],
194 "premiseIds": [
195 0
196 ],
197 "premiseNames": [
198 "string"
199 ],
200 "userAvailable": true,
201 "temporaryWorkload": 0,
202 "preferredCultureCode": "string"
203 }
204 ],
205 "assignedUsers": [
206 "string"
207 ],
208 "assetPriority": "string",
209 "assetPriorityId": 0,
210 "assetPriorityDisplayId": "string",
211 "assetPriorityType": "string",
212 "assetAvailable": true,
213 "exactPlacement": "string",
214 "fosId": 0,
215 "downtimeStatus": "string",
216 "premiseFromNrm": true,
217 "modifiedAt": "2019-08-24T14:15:22Z"
218 },
219 "mainAssetDisplayId": "string",
220 "inspectionCategoryIds": [
221 0
222 ],
223 "inspectionCategories": [
224 "string"
225 ],
226 "inspectionCategoryId": 0,
227 "inspectionCategory": "string",
228 "inspectionConditionId": 0,
229 "inspectionCondition": "string",
230 "inspectionConditionType": "string",
231 "inspectionStatusId": 0,
232 "inspectionStatus": "string",
233 "inspectionStatusType": "string",
234 "inspectionItemIds": [
235 0
236 ],
237 "internalTeamIds": [
238 0
239 ],
240 "internalTeamDtos": [
241 {
242 "id": 0,
243 "createdBy": "string",
244 "createdAt": "2019-08-24T14:15:22Z",
245 "displayId": "string",
246 "name": "string",
247 "email": "string",
248 "phone": "string",
249 "manager": "string",
250 "requestCategoryName": [
251 "string"
252 ],
253 "requestCategoryId": [
254 0
255 ],
256 "requestCategoryDisplayId": [
257 "string"
258 ],
259 "description": "string",
260 "internalTeamUser": [
261 0
262 ],
263 "members": 0,
264 "mainAssets": [
265 0
266 ],
267 "premiseNames": [
268 "string"
269 ],
270 "internalTeamAvailable": true,
271 "premiseIds": [
272 0
273 ]
274 }
275 ],
276 "internalTeams": [
277 "string"
278 ],
279 "assignedUserIds": [
280 0
281 ],
282 "assignedUserDtos": [
283 {
284 "id": 0,
285 "createdBy": "string",
286 "createdAt": "2019-08-24T14:15:22Z",
287 "userName": "string",
288 "firstName": "string",
289 "lastName": "string",
290 "email": "string",
291 "roleIds": [
292 {
293 "id": 0,
294 "createdBy": "string",
295 "createdAt": "2019-08-24T14:15:22Z",
296 "modifiedBy": "string",
297 "modifiedAt": "2019-08-24T14:15:22Z",
298 "roleName": "string",
299 "entity": "string",
300 "new": true
301 }
302 ],
303 "internalTeamNames": [
304 "string"
305 ],
306 "internalTeamIds": [
307 0
308 ],
309 "internalTeamDisplayIds": [
310 "string"
311 ],
312 "premiseIds": [
313 0
314 ],
315 "premiseNames": [
316 "string"
317 ],
318 "userAvailable": true,
319 "temporaryWorkload": 0,
320 "preferredCultureCode": "string"
321 }
322 ],
323 "assignedUsers": [
324 "string"
325 ],
326 "activity": "string",
327 "createdByTrigger": true,
328 "modifiedAt": "2019-08-24T14:15:22Z"
329}
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 "dueDate": "2019-08-24",
9 "closeDate": "2019-08-24",
10 "createdDate": "2019-08-24",
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "startTime": {
14 "hour": 0,
15 "minute": 0,
16 "second": 0,
17 "nano": 0
18 },
19 "endTime": {
20 "hour": 0,
21 "minute": 0,
22 "second": 0,
23 "nano": 0
24 },
25 "isCreatedBy": "string",
26 "isTemplate": true,
27 "inspectionAvailable": true,
28 "inspectionType": "string",
29 "templateId": 0,
30 "premiseId": 0,
31 "premiseDto": {
32 "id": 0,
33 "createdBy": "string",
34 "createdAt": "2019-08-24T14:15:22Z",
35 "displayId": "string",
36 "premiseName": "string",
37 "description": "string",
38 "address": "string",
39 "internalTeamNames": [
40 "string"
41 ],
42 "internalTeamIds": [
43 0
44 ],
45 "premiseAvailable": true,
46 "premiseFromNrm": true,
47 "nlmId": 0,
48 "nlmDisplayId": "string",
49 "nlmUsed": true,
50 "manager": 0,
51 "managerName": "string",
52 "imageId": 0,
53 "area": "string",
54 "modifiedAt": "2019-08-24T14:15:22Z"
55 },
56 "premiseFromNrm": true,
57 "premiseDisplayId": "string",
58 "mainAssetIds": [
59 0
60 ],
61 "mainAssetId": 0,
62 "mainAssetDto": {
63 "id": 0,
64 "createdBy": "string",
65 "createdAt": "2019-08-24T14:15:22Z",
66 "displayId": "string",
67 "name": "string",
68 "description": "string",
69 "qrCode": "string",
70 "barCode": "string",
71 "imageId": 0,
72 "model": "string",
73 "manufacturer": "string",
74 "serialNumber": "string",
75 "cost": "81.08",
76 "premiseId": 0,
77 "premiseDisplayId": "string",
78 "premiseDto": {
79 "id": 0,
80 "createdBy": "string",
81 "createdAt": "2019-08-24T14:15:22Z",
82 "displayId": "string",
83 "premiseName": "string",
84 "description": "string",
85 "address": "string",
86 "internalTeamNames": [
87 "string"
88 ],
89 "internalTeamIds": [
90 0
91 ],
92 "premiseAvailable": true,
93 "premiseFromNrm": true,
94 "nlmId": 0,
95 "nlmDisplayId": "string",
96 "nlmUsed": true,
97 "manager": 0,
98 "managerName": "string",
99 "imageId": 0,
100 "area": "string",
101 "modifiedAt": "2019-08-24T14:15:22Z"
102 },
103 "acquisitionDate": "2019-08-24",
104 "endOfLife": "2019-08-24",
105 "assetStatusId": 0,
106 "assetStatus": "string",
107 "assetStatusType": "string",
108 "parentAssetId": 0,
109 "parentAssetDisplayId": "string",
110 "parentAsset": "string",
111 "parentAssetDto": {},
112 "upcomingMaintenanceDate": "2019-08-24",
113 "assetCategoryIds": [
114 0
115 ],
116 "assetCategories": [
117 "string"
118 ],
119 "internalTeamIds": [
120 0
121 ],
122 "internalTeamDtos": [
123 {
124 "id": 0,
125 "createdBy": "string",
126 "createdAt": "2019-08-24T14:15:22Z",
127 "displayId": "string",
128 "name": "string",
129 "email": "string",
130 "phone": "string",
131 "manager": "string",
132 "requestCategoryName": [
133 "string"
134 ],
135 "requestCategoryId": [
136 0
137 ],
138 "requestCategoryDisplayId": [
139 "string"
140 ],
141 "description": "string",
142 "internalTeamUser": [
143 0
144 ],
145 "members": 0,
146 "mainAssets": [
147 0
148 ],
149 "premiseNames": [
150 "string"
151 ],
152 "internalTeamAvailable": true,
153 "premiseIds": [
154 0
155 ]
156 }
157 ],
158 "internalTeams": [
159 "string"
160 ],
161 "assignedUserIds": [
162 0
163 ],
164 "assignedUserDtos": [
165 {
166 "id": 0,
167 "createdBy": "string",
168 "createdAt": "2019-08-24T14:15:22Z",
169 "userName": "string",
170 "firstName": "string",
171 "lastName": "string",
172 "email": "string",
173 "roleIds": [
174 {
175 "id": 0,
176 "createdBy": "string",
177 "createdAt": "2019-08-24T14:15:22Z",
178 "modifiedBy": "string",
179 "modifiedAt": "2019-08-24T14:15:22Z",
180 "roleName": "string",
181 "entity": "string",
182 "new": true
183 }
184 ],
185 "internalTeamNames": [
186 "string"
187 ],
188 "internalTeamIds": [
189 0
190 ],
191 "internalTeamDisplayIds": [
192 "string"
193 ],
194 "premiseIds": [
195 0
196 ],
197 "premiseNames": [
198 "string"
199 ],
200 "userAvailable": true,
201 "temporaryWorkload": 0,
202 "preferredCultureCode": "string"
203 }
204 ],
205 "assignedUsers": [
206 "string"
207 ],
208 "assetPriority": "string",
209 "assetPriorityId": 0,
210 "assetPriorityDisplayId": "string",
211 "assetPriorityType": "string",
212 "assetAvailable": true,
213 "exactPlacement": "string",
214 "fosId": 0,
215 "downtimeStatus": "string",
216 "premiseFromNrm": true,
217 "modifiedAt": "2019-08-24T14:15:22Z"
218 },
219 "mainAssetDisplayId": "string",
220 "inspectionCategoryIds": [
221 0
222 ],
223 "inspectionCategories": [
224 "string"
225 ],
226 "inspectionCategoryId": 0,
227 "inspectionCategory": "string",
228 "inspectionConditionId": 0,
229 "inspectionCondition": "string",
230 "inspectionConditionType": "string",
231 "inspectionStatusId": 0,
232 "inspectionStatus": "string",
233 "inspectionStatusType": "string",
234 "inspectionItemIds": [
235 0
236 ],
237 "internalTeamIds": [
238 0
239 ],
240 "internalTeamDtos": [
241 {
242 "id": 0,
243 "createdBy": "string",
244 "createdAt": "2019-08-24T14:15:22Z",
245 "displayId": "string",
246 "name": "string",
247 "email": "string",
248 "phone": "string",
249 "manager": "string",
250 "requestCategoryName": [
251 "string"
252 ],
253 "requestCategoryId": [
254 0
255 ],
256 "requestCategoryDisplayId": [
257 "string"
258 ],
259 "description": "string",
260 "internalTeamUser": [
261 0
262 ],
263 "members": 0,
264 "mainAssets": [
265 0
266 ],
267 "premiseNames": [
268 "string"
269 ],
270 "internalTeamAvailable": true,
271 "premiseIds": [
272 0
273 ]
274 }
275 ],
276 "internalTeams": [
277 "string"
278 ],
279 "assignedUserIds": [
280 0
281 ],
282 "assignedUserDtos": [
283 {
284 "id": 0,
285 "createdBy": "string",
286 "createdAt": "2019-08-24T14:15:22Z",
287 "userName": "string",
288 "firstName": "string",
289 "lastName": "string",
290 "email": "string",
291 "roleIds": [
292 {
293 "id": 0,
294 "createdBy": "string",
295 "createdAt": "2019-08-24T14:15:22Z",
296 "modifiedBy": "string",
297 "modifiedAt": "2019-08-24T14:15:22Z",
298 "roleName": "string",
299 "entity": "string",
300 "new": true
301 }
302 ],
303 "internalTeamNames": [
304 "string"
305 ],
306 "internalTeamIds": [
307 0
308 ],
309 "internalTeamDisplayIds": [
310 "string"
311 ],
312 "premiseIds": [
313 0
314 ],
315 "premiseNames": [
316 "string"
317 ],
318 "userAvailable": true,
319 "temporaryWorkload": 0,
320 "preferredCultureCode": "string"
321 }
322 ],
323 "assignedUsers": [
324 "string"
325 ],
326 "activity": "string",
327 "createdByTrigger": true,
328 "modifiedAt": "2019-08-24T14:15:22Z"
329}
Get Inspections¶
HTTP Request
POST /api/inspections/search
📋 Description: Submits a search request for inspections, allowing users to filter results based on specified criteria to enhance operational efficiency and decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the search results for inspections should be returned in a paginated format, enhancing the efficiency of data retrieval for large datasets. |
|
body |
body |
true |
Request body containing the search criteria and filters for retrieving inspection records, including parameters such as date range, status, and location. |
Body Parameters
1{
2 "displayIdLike": "string",
3 "nameLike": "string",
4 "isTemplate": true,
5 "inspectionAvailable": true,
6 "inspectionTypeIdIn": [
7 0
8 ],
9 "inspectionsStatusIdIn": [
10 0
11 ],
12 "attachToAssetIdIn": [
13 0
14 ],
15 "attachToAssetIdNotIn": [
16 0
17 ],
18 "attachToWorkOrderIdIn": [
19 0
20 ],
21 "attachToWorkOrderIdNotIn": [
22 0
23 ],
24 "premisesId": "string",
25 "premiseIdEqual": 0,
26 "startDateGreaterThanOrEqual": "2019-08-24",
27 "startDateLessThanOrEqual": "2019-08-24",
28 "endDateLessThanOrEqual": "2019-08-24",
29 "endDateGreaterThanOrEqual": "2019-08-24",
30 "endDateGreaterThanOrEqualOrNull": "2019-08-24",
31 "assigneeEqual": "string",
32 "isActive": true,
33 "relatedUser": "string"
34}
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 "dueDate": "2019-08-24",
29 "closeDate": "2019-08-24",
30 "createdDate": "2019-08-24",
31 "startDate": "2019-08-24",
32 "endDate": "2019-08-24",
33 "startTime": {
34 "hour": 0,
35 "minute": 0,
36 "second": 0,
37 "nano": 0
38 },
39 "endTime": {
40 "hour": 0,
41 "minute": 0,
42 "second": 0,
43 "nano": 0
44 },
45 "isCreatedBy": "string",
46 "isTemplate": true,
47 "inspectionAvailable": true,
48 "inspectionType": "string",
49 "templateId": 0,
50 "premiseId": 0,
51 "premiseDto": {
52 "id": 0,
53 "createdBy": "string",
54 "createdAt": "2019-08-24T14:15:22Z",
55 "displayId": "string",
56 "premiseName": "string",
57 "description": "string",
58 "address": "string",
59 "internalTeamNames": [
60 "string"
61 ],
62 "internalTeamIds": [
63 0
64 ],
65 "premiseAvailable": true,
66 "premiseFromNrm": true,
67 "nlmId": 0,
68 "nlmDisplayId": "string",
69 "nlmUsed": true,
70 "manager": 0,
71 "managerName": "string",
72 "imageId": 0,
73 "area": "string",
74 "modifiedAt": "2019-08-24T14:15:22Z"
75 },
76 "premiseFromNrm": true,
77 "premiseDisplayId": "string",
78 "mainAssetIds": [
79 0
80 ],
81 "mainAssetId": 0,
82 "mainAssetDto": {
83 "id": 0,
84 "createdBy": "string",
85 "createdAt": "2019-08-24T14:15:22Z",
86 "displayId": "string",
87 "name": "string",
88 "description": "string",
89 "qrCode": "string",
90 "barCode": "string",
91 "imageId": 0,
92 "model": "string",
93 "manufacturer": "string",
94 "serialNumber": "string",
95 "cost": "81.08",
96 "premiseId": 0,
97 "premiseDisplayId": "string",
98 "premiseDto": {
99 "id": 0,
100 "createdBy": "string",
101 "createdAt": "2019-08-24T14:15:22Z",
102 "displayId": "string",
103 "premiseName": "string",
104 "description": "string",
105 "address": "string",
106 "internalTeamNames": [
107 "string"
108 ],
109 "internalTeamIds": [
110 0
111 ],
112 "premiseAvailable": true,
113 "premiseFromNrm": true,
114 "nlmId": 0,
115 "nlmDisplayId": "string",
116 "nlmUsed": true,
117 "manager": 0,
118 "managerName": "string",
119 "imageId": 0,
120 "area": "string",
121 "modifiedAt": "2019-08-24T14:15:22Z"
122 },
123 "acquisitionDate": "2019-08-24",
124 "endOfLife": "2019-08-24",
125 "assetStatusId": 0,
126 "assetStatus": "string",
127 "assetStatusType": "string",
128 "parentAssetId": 0,
129 "parentAssetDisplayId": "string",
130 "parentAsset": "string",
131 "parentAssetDto": {},
132 "upcomingMaintenanceDate": "2019-08-24",
133 "assetCategoryIds": [
134 0
135 ],
136 "assetCategories": [
137 "string"
138 ],
139 "internalTeamIds": [
140 0
141 ],
142 "internalTeamDtos": [
143 {
144 "id": 0,
145 "createdBy": "string",
146 "createdAt": "2019-08-24T14:15:22Z",
147 "displayId": "string",
148 "name": "string",
149 "email": "string",
150 "phone": "string",
151 "manager": "string",
152 "requestCategoryName": [
153 "string"
154 ],
155 "requestCategoryId": [
156 0
157 ],
158 "requestCategoryDisplayId": [
159 "string"
160 ],
161 "description": "string",
162 "internalTeamUser": [
163 0
164 ],
165 "members": 0,
166 "mainAssets": [
167 0
168 ],
169 "premiseNames": [
170 "string"
171 ],
172 "internalTeamAvailable": true,
173 "premiseIds": [
174 0
175 ]
176 }
177 ],
178 "internalTeams": [
179 "string"
180 ],
181 "assignedUserIds": [
182 0
183 ],
184 "assignedUserDtos": [
185 {
186 "id": 0,
187 "createdBy": "string",
188 "createdAt": "2019-08-24T14:15:22Z",
189 "userName": "string",
190 "firstName": "string",
191 "lastName": "string",
192 "email": "string",
193 "roleIds": [
194 {
195 "id": 0,
196 "createdBy": "string",
197 "createdAt": "2019-08-24T14:15:22Z",
198 "modifiedBy": "string",
199 "modifiedAt": "2019-08-24T14:15:22Z",
200 "roleName": "string",
201 "entity": "string",
202 "new": true
203 }
204 ],
205 "internalTeamNames": [
206 "string"
207 ],
208 "internalTeamIds": [
209 0
210 ],
211 "internalTeamDisplayIds": [
212 "string"
213 ],
214 "premiseIds": [
215 0
216 ],
217 "premiseNames": [
218 "string"
219 ],
220 "userAvailable": true,
221 "temporaryWorkload": 0,
222 "preferredCultureCode": "string"
223 }
224 ],
225 "assignedUsers": [
226 "string"
227 ],
228 "assetPriority": "string",
229 "assetPriorityId": 0,
230 "assetPriorityDisplayId": "string",
231 "assetPriorityType": "string",
232 "assetAvailable": true,
233 "exactPlacement": "string",
234 "fosId": 0,
235 "downtimeStatus": "string",
236 "premiseFromNrm": true,
237 "modifiedAt": "2019-08-24T14:15:22Z"
238 },
239 "mainAssetDisplayId": "string",
240 "inspectionCategoryIds": [
241 0
242 ],
243 "inspectionCategories": [
244 "string"
245 ],
246 "inspectionCategoryId": 0,
247 "inspectionCategory": "string",
248 "inspectionConditionId": 0,
249 "inspectionCondition": "string",
250 "inspectionConditionType": "string",
251 "inspectionStatusId": 0,
252 "inspectionStatus": "string",
253 "inspectionStatusType": "string",
254 "inspectionItemIds": [
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 "assignedUserIds": [
300 0
301 ],
302 "assignedUserDtos": [
303 {
304 "id": 0,
305 "createdBy": "string",
306 "createdAt": "2019-08-24T14:15:22Z",
307 "userName": "string",
308 "firstName": "string",
309 "lastName": "string",
310 "email": "string",
311 "roleIds": [
312 {
313 "id": 0,
314 "createdBy": "string",
315 "createdAt": "2019-08-24T14:15:22Z",
316 "modifiedBy": "string",
317 "modifiedAt": "2019-08-24T14:15:22Z",
318 "roleName": "string",
319 "entity": "string",
320 "new": true
321 }
322 ],
323 "internalTeamNames": [
324 "string"
325 ],
326 "internalTeamIds": [
327 0
328 ],
329 "internalTeamDisplayIds": [
330 "string"
331 ],
332 "premiseIds": [
333 0
334 ],
335 "premiseNames": [
336 "string"
337 ],
338 "userAvailable": true,
339 "temporaryWorkload": 0,
340 "preferredCultureCode": "string"
341 }
342 ],
343 "assignedUsers": [
344 "string"
345 ],
346 "activity": "string",
347 "createdByTrigger": true,
348 "modifiedAt": "2019-08-24T14:15:22Z"
349 }
350 ],
351 "number": 0,
352 "sort": {
353 "unsorted": true,
354 "sorted": true,
355 "empty": true
356 },
357 "empty": true
358}
Get Inspections (With Search All)¶
HTTP Request
POST /api/inspections/search-all
📋 Description: Submits a request to search for all inspections, allowing users to efficiently access comprehensive inspection data for analysis and reporting.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the search criteria and filters for retrieving all inspection records, including parameters such as date range, status, and location. |
Body Parameters
1{
2 "displayIdLike": "string",
3 "nameLike": "string",
4 "isTemplate": true,
5 "inspectionAvailable": true,
6 "inspectionTypeIdIn": [
7 0
8 ],
9 "inspectionsStatusIdIn": [
10 0
11 ],
12 "attachToAssetIdIn": [
13 0
14 ],
15 "attachToAssetIdNotIn": [
16 0
17 ],
18 "attachToWorkOrderIdIn": [
19 0
20 ],
21 "attachToWorkOrderIdNotIn": [
22 0
23 ],
24 "premisesId": "string",
25 "premiseIdEqual": 0,
26 "startDateGreaterThanOrEqual": "2019-08-24",
27 "startDateLessThanOrEqual": "2019-08-24",
28 "endDateLessThanOrEqual": "2019-08-24",
29 "endDateGreaterThanOrEqual": "2019-08-24",
30 "endDateGreaterThanOrEqualOrNull": "2019-08-24",
31 "assigneeEqual": "string",
32 "isActive": true,
33 "relatedUser": "string"
34}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "type": "string",
4 "id": 0,
5 "displayId": "string",
6 "title": "string",
7 "details": "string",
8 "start": "2019-08-24",
9 "end": "2019-08-24",
10 "startTime": {
11 "hour": 0,
12 "minute": 0,
13 "second": 0,
14 "nano": 0
15 },
16 "endTime": {
17 "hour": 0,
18 "minute": 0,
19 "second": 0,
20 "nano": 0
21 },
22 "time": "string",
23 "duration": 0,
24 "bgcolor": "string",
25 "workOrder": {
26 "id": 0,
27 "createdBy": "string",
28 "createdAt": "2019-08-24T14:15:22Z",
29 "displayId": "string",
30 "name": "string",
31 "imageId": 0,
32 "description": "string",
33 "vendorRating": 0,
34 "premiseId": 0,
35 "premiseDto": {
36 "id": 0,
37 "createdBy": "string",
38 "createdAt": "2019-08-24T14:15:22Z",
39 "displayId": "string",
40 "premiseName": "string",
41 "description": "string",
42 "address": "string",
43 "internalTeamNames": [
44 "string"
45 ],
46 "internalTeamIds": [
47 0
48 ],
49 "premiseAvailable": true,
50 "premiseFromNrm": true,
51 "nlmId": 0,
52 "nlmDisplayId": "string",
53 "nlmUsed": true,
54 "manager": 0,
55 "managerName": "string",
56 "imageId": 0,
57 "area": "string",
58 "modifiedAt": "2019-08-24T14:15:22Z"
59 },
60 "premiseFromNrm": true,
61 "premiseDisplayId": "string",
62 "nssProjectId": 0,
63 "nssTaskId": 0,
64 "nssTaskDisplayId": "string",
65 "orderDate": "2019-08-24",
66 "dueDate": "2019-08-24",
67 "startDate": "2019-08-24",
68 "endDate": "2019-08-24",
69 "startTime": {
70 "hour": 0,
71 "minute": 0,
72 "second": 0,
73 "nano": 0
74 },
75 "endTime": {
76 "hour": 0,
77 "minute": 0,
78 "second": 0,
79 "nano": 0
80 },
81 "modifiedAt": "2019-08-24T14:15:22Z",
82 "estimatedCost": "81.08",
83 "finalCost": "81.08",
84 "duration": 0,
85 "estimatedDayTime": 0,
86 "finalHourTime": "2.5",
87 "estimatedHourTime": "2.5",
88 "closeDate": "2019-08-24",
89 "inspection": "string",
90 "workOrderTypeId": 0,
91 "workOrderTypeName": "string",
92 "workOrderType": "string",
93 "workOrderPriorityId": 0,
94 "workOrderPriority": "string",
95 "workOrderPriorityType": "string",
96 "isTemplate": true,
97 "isWorkOrderTemplate": true,
98 "templateId": 0,
99 "isPartsInSufficient": true,
100 "partQuantityInfoList": [
101 {
102 "partId": 0,
103 "partDisplayId": "string",
104 "requestedQuantity": 0,
105 "availableQuantity": 0,
106 "usedQuantity": 0,
107 "sufficient": true,
108 "partial": true
109 }
110 ],
111 "parentWorkOrderId": 0,
112 "parentWorkOrderDisplayId": "string",
113 "parentWorkOrder": "string",
114 "mainAssetIds": [
115 0
116 ],
117 "mainAssetDto": {
118 "id": 0,
119 "createdBy": "string",
120 "createdAt": "2019-08-24T14:15:22Z",
121 "displayId": "string",
122 "name": "string",
123 "description": "string",
124 "qrCode": "string",
125 "barCode": "string",
126 "imageId": 0,
127 "model": "string",
128 "manufacturer": "string",
129 "serialNumber": "string",
130 "cost": "81.08",
131 "premiseId": 0,
132 "premiseDisplayId": "string",
133 "premiseDto": {
134 "id": 0,
135 "createdBy": "string",
136 "createdAt": "2019-08-24T14:15:22Z",
137 "displayId": "string",
138 "premiseName": "string",
139 "description": "string",
140 "address": "string",
141 "internalTeamNames": [
142 "string"
143 ],
144 "internalTeamIds": [
145 0
146 ],
147 "premiseAvailable": true,
148 "premiseFromNrm": true,
149 "nlmId": 0,
150 "nlmDisplayId": "string",
151 "nlmUsed": true,
152 "manager": 0,
153 "managerName": "string",
154 "imageId": 0,
155 "area": "string",
156 "modifiedAt": "2019-08-24T14:15:22Z"
157 },
158 "acquisitionDate": "2019-08-24",
159 "endOfLife": "2019-08-24",
160 "assetStatusId": 0,
161 "assetStatus": "string",
162 "assetStatusType": "string",
163 "parentAssetId": 0,
164 "parentAssetDisplayId": "string",
165 "parentAsset": "string",
166 "parentAssetDto": {},
167 "upcomingMaintenanceDate": "2019-08-24",
168 "assetCategoryIds": [
169 0
170 ],
171 "assetCategories": [
172 "string"
173 ],
174 "internalTeamIds": [
175 0
176 ],
177 "internalTeamDtos": [
178 {
179 "id": 0,
180 "createdBy": "string",
181 "createdAt": "2019-08-24T14:15:22Z",
182 "displayId": "string",
183 "name": "string",
184 "email": "string",
185 "phone": "string",
186 "manager": "string",
187 "requestCategoryName": [
188 "string"
189 ],
190 "requestCategoryId": [
191 0
192 ],
193 "requestCategoryDisplayId": [
194 "string"
195 ],
196 "description": "string",
197 "internalTeamUser": [
198 0
199 ],
200 "members": 0,
201 "mainAssets": [
202 0
203 ],
204 "premiseNames": [
205 "string"
206 ],
207 "internalTeamAvailable": true,
208 "premiseIds": [
209 0
210 ]
211 }
212 ],
213 "internalTeams": [
214 "string"
215 ],
216 "assignedUserIds": [
217 0
218 ],
219 "assignedUserDtos": [
220 {
221 "id": 0,
222 "createdBy": "string",
223 "createdAt": "2019-08-24T14:15:22Z",
224 "userName": "string",
225 "firstName": "string",
226 "lastName": "string",
227 "email": "string",
228 "roleIds": [
229 {
230 "id": 0,
231 "createdBy": "string",
232 "createdAt": "2019-08-24T14:15:22Z",
233 "modifiedBy": "string",
234 "modifiedAt": "2019-08-24T14:15:22Z",
235 "roleName": "string",
236 "entity": "string",
237 "new": true
238 }
239 ],
240 "internalTeamNames": [
241 "string"
242 ],
243 "internalTeamIds": [
244 0
245 ],
246 "internalTeamDisplayIds": [
247 "string"
248 ],
249 "premiseIds": [
250 0
251 ],
252 "premiseNames": [
253 "string"
254 ],
255 "userAvailable": true,
256 "temporaryWorkload": 0,
257 "preferredCultureCode": "string"
258 }
259 ],
260 "assignedUsers": [
261 "string"
262 ],
263 "assetPriority": "string",
264 "assetPriorityId": 0,
265 "assetPriorityDisplayId": "string",
266 "assetPriorityType": "string",
267 "assetAvailable": true,
268 "exactPlacement": "string",
269 "fosId": 0,
270 "downtimeStatus": "string",
271 "premiseFromNrm": true,
272 "modifiedAt": "2019-08-24T14:15:22Z"
273 },
274 "mainAssetDisplayId": "string",
275 "workOrderStatusId": 0,
276 "workOrderStatus": "string",
277 "workOrderStatusType": "string",
278 "requestIds": [
279 0
280 ],
281 "internalTeamIds": [
282 0
283 ],
284 "internalTeamDtos": [
285 {
286 "id": 0,
287 "createdBy": "string",
288 "createdAt": "2019-08-24T14:15:22Z",
289 "displayId": "string",
290 "name": "string",
291 "email": "string",
292 "phone": "string",
293 "manager": "string",
294 "requestCategoryName": [
295 "string"
296 ],
297 "requestCategoryId": [
298 0
299 ],
300 "requestCategoryDisplayId": [
301 "string"
302 ],
303 "description": "string",
304 "internalTeamUser": [
305 0
306 ],
307 "members": 0,
308 "mainAssets": [
309 0
310 ],
311 "premiseNames": [
312 "string"
313 ],
314 "internalTeamAvailable": true,
315 "premiseIds": [
316 0
317 ]
318 }
319 ],
320 "internalTeams": [
321 "string"
322 ],
323 "vendorId": 0,
324 "vendorDto": {
325 "id": 0,
326 "createdBy": "string",
327 "createdAt": "2019-08-24T14:15:22Z",
328 "displayId": "string",
329 "name": "string",
330 "description": "string",
331 "address": "string",
332 "contractEndDate": "2019-08-24",
333 "services": "string",
334 "vendorType": "string",
335 "vendorStatusId": 0,
336 "vendorStatus": "string",
337 "vendorStatusType": "string",
338 "businessTypeId": 0,
339 "businessType": "string",
340 "vendorRateId": 0,
341 "vendorRate": "string",
342 "vendorContactIds": [
343 0
344 ],
345 "premiseIds": [
346 0
347 ],
348 "firstPremiseDisplayId": "string",
349 "ownerUserName": "string",
350 "ownerDto": {
351 "id": 0,
352 "createdBy": "string",
353 "createdAt": "2019-08-24T14:15:22Z",
354 "userName": "string",
355 "firstName": "string",
356 "lastName": "string",
357 "email": "string",
358 "roleIds": [
359 {
360 "id": 0,
361 "createdBy": "string",
362 "createdAt": "2019-08-24T14:15:22Z",
363 "modifiedBy": "string",
364 "modifiedAt": "2019-08-24T14:15:22Z",
365 "roleName": "string",
366 "entity": "string",
367 "new": true
368 }
369 ],
370 "internalTeamNames": [
371 "string"
372 ],
373 "internalTeamIds": [
374 0
375 ],
376 "internalTeamDisplayIds": [
377 "string"
378 ],
379 "premiseIds": [
380 0
381 ],
382 "premiseNames": [
383 "string"
384 ],
385 "userAvailable": true,
386 "temporaryWorkload": 0,
387 "preferredCultureCode": "string"
388 },
389 "vendorAvailable": true,
390 "vendorRating": 0.1,
391 "premiseDisplayIds": [
392 "string"
393 ]
394 },
395 "vendorName": "string",
396 "workOrderTemplateSettings": {
397 "id": 0,
398 "createdBy": "string",
399 "createdAt": "2019-08-24T14:15:22Z",
400 "workOrderId": 0,
401 "startDate": "2019-08-24",
402 "dueDuration": 0,
403 "dueMonths": 0,
404 "endDate": "2019-08-24",
405 "recurringWOPriorityId": 0,
406 "recurringWOPriority": "string",
407 "recurringWOPriorityType": "string",
408 "isTemplate": true,
409 "isRemoveByDate": true,
410 "triggerByWorkOrderStatusId": 0,
411 "triggerByWorkOrderStatus": "string",
412 "triggerByWorkOrderStatusType": "string",
413 "removeByWorkOrderStatusId": 0,
414 "removeByWorkOrderStatus": "string",
415 "removeByWorkOrderStatusType": "string"
416 },
417 "assignedUserIds": [
418 0
419 ],
420 "assignedUserDtos": [
421 {
422 "id": 0,
423 "createdBy": "string",
424 "createdAt": "2019-08-24T14:15:22Z",
425 "userName": "string",
426 "firstName": "string",
427 "lastName": "string",
428 "email": "string",
429 "roleIds": [
430 {
431 "id": 0,
432 "createdBy": "string",
433 "createdAt": "2019-08-24T14:15:22Z",
434 "modifiedBy": "string",
435 "modifiedAt": "2019-08-24T14:15:22Z",
436 "roleName": "string",
437 "entity": "string",
438 "new": true
439 }
440 ],
441 "internalTeamNames": [
442 "string"
443 ],
444 "internalTeamIds": [
445 0
446 ],
447 "internalTeamDisplayIds": [
448 "string"
449 ],
450 "premiseIds": [
451 0
452 ],
453 "premiseNames": [
454 "string"
455 ],
456 "userAvailable": true,
457 "temporaryWorkload": 0,
458 "preferredCultureCode": "string"
459 }
460 ],
461 "assignedUsers": [
462 "string"
463 ],
464 "variableQuantity": 0,
465 "workOrderAvailable": true,
466 "exactPlacement": "string",
467 "primaryWorkOrderId": 0,
468 "primaryWorkOrderDto": {},
469 "primaryWorkOrderDisplayId": "string",
470 "isPrimary": true,
471 "invoiceIds": [
472 0
473 ],
474 "createdByTrigger": true,
475 "internalCosts": "81.08",
476 "invoiceTotal": "81.08",
477 "partsTotal": "81.08",
478 "inspectionItemId": 0,
479 "partIdToAttach": 0
480 },
481 "inspection": {
482 "id": 0,
483 "createdBy": "string",
484 "createdAt": "2019-08-24T14:15:22Z",
485 "displayId": "string",
486 "name": "string",
487 "description": "string",
488 "dueDate": "2019-08-24",
489 "closeDate": "2019-08-24",
490 "createdDate": "2019-08-24",
491 "startDate": "2019-08-24",
492 "endDate": "2019-08-24",
493 "startTime": {
494 "hour": 0,
495 "minute": 0,
496 "second": 0,
497 "nano": 0
498 },
499 "endTime": {
500 "hour": 0,
501 "minute": 0,
502 "second": 0,
503 "nano": 0
504 },
505 "isCreatedBy": "string",
506 "isTemplate": true,
507 "inspectionAvailable": true,
508 "inspectionType": "string",
509 "templateId": 0,
510 "premiseId": 0,
511 "premiseDto": {
512 "id": 0,
513 "createdBy": "string",
514 "createdAt": "2019-08-24T14:15:22Z",
515 "displayId": "string",
516 "premiseName": "string",
517 "description": "string",
518 "address": "string",
519 "internalTeamNames": [
520 "string"
521 ],
522 "internalTeamIds": [
523 0
524 ],
525 "premiseAvailable": true,
526 "premiseFromNrm": true,
527 "nlmId": 0,
528 "nlmDisplayId": "string",
529 "nlmUsed": true,
530 "manager": 0,
531 "managerName": "string",
532 "imageId": 0,
533 "area": "string",
534 "modifiedAt": "2019-08-24T14:15:22Z"
535 },
536 "premiseFromNrm": true,
537 "premiseDisplayId": "string",
538 "mainAssetIds": [
539 0
540 ],
541 "mainAssetId": 0,
542 "mainAssetDto": {
543 "id": 0,
544 "createdBy": "string",
545 "createdAt": "2019-08-24T14:15:22Z",
546 "displayId": "string",
547 "name": "string",
548 "description": "string",
549 "qrCode": "string",
550 "barCode": "string",
551 "imageId": 0,
552 "model": "string",
553 "manufacturer": "string",
554 "serialNumber": "string",
555 "cost": "81.08",
556 "premiseId": 0,
557 "premiseDisplayId": "string",
558 "premiseDto": {
559 "id": 0,
560 "createdBy": "string",
561 "createdAt": "2019-08-24T14:15:22Z",
562 "displayId": "string",
563 "premiseName": "string",
564 "description": "string",
565 "address": "string",
566 "internalTeamNames": [
567 "string"
568 ],
569 "internalTeamIds": [
570 0
571 ],
572 "premiseAvailable": true,
573 "premiseFromNrm": true,
574 "nlmId": 0,
575 "nlmDisplayId": "string",
576 "nlmUsed": true,
577 "manager": 0,
578 "managerName": "string",
579 "imageId": 0,
580 "area": "string",
581 "modifiedAt": "2019-08-24T14:15:22Z"
582 },
583 "acquisitionDate": "2019-08-24",
584 "endOfLife": "2019-08-24",
585 "assetStatusId": 0,
586 "assetStatus": "string",
587 "assetStatusType": "string",
588 "parentAssetId": 0,
589 "parentAssetDisplayId": "string",
590 "parentAsset": "string",
591 "parentAssetDto": {},
592 "upcomingMaintenanceDate": "2019-08-24",
593 "assetCategoryIds": [
594 0
595 ],
596 "assetCategories": [
597 "string"
598 ],
599 "internalTeamIds": [
600 0
601 ],
602 "internalTeamDtos": [
603 {
604 "id": 0,
605 "createdBy": "string",
606 "createdAt": "2019-08-24T14:15:22Z",
607 "displayId": "string",
608 "name": "string",
609 "email": "string",
610 "phone": "string",
611 "manager": "string",
612 "requestCategoryName": [
613 "string"
614 ],
615 "requestCategoryId": [
616 0
617 ],
618 "requestCategoryDisplayId": [
619 "string"
620 ],
621 "description": "string",
622 "internalTeamUser": [
623 0
624 ],
625 "members": 0,
626 "mainAssets": [
627 0
628 ],
629 "premiseNames": [
630 "string"
631 ],
632 "internalTeamAvailable": true,
633 "premiseIds": [
634 0
635 ]
636 }
637 ],
638 "internalTeams": [
639 "string"
640 ],
641 "assignedUserIds": [
642 0
643 ],
644 "assignedUserDtos": [
645 {
646 "id": 0,
647 "createdBy": "string",
648 "createdAt": "2019-08-24T14:15:22Z",
649 "userName": "string",
650 "firstName": "string",
651 "lastName": "string",
652 "email": "string",
653 "roleIds": [
654 {
655 "id": 0,
656 "createdBy": "string",
657 "createdAt": "2019-08-24T14:15:22Z",
658 "modifiedBy": "string",
659 "modifiedAt": "2019-08-24T14:15:22Z",
660 "roleName": "string",
661 "entity": "string",
662 "new": true
663 }
664 ],
665 "internalTeamNames": [
666 "string"
667 ],
668 "internalTeamIds": [
669 0
670 ],
671 "internalTeamDisplayIds": [
672 "string"
673 ],
674 "premiseIds": [
675 0
676 ],
677 "premiseNames": [
678 "string"
679 ],
680 "userAvailable": true,
681 "temporaryWorkload": 0,
682 "preferredCultureCode": "string"
683 }
684 ],
685 "assignedUsers": [
686 "string"
687 ],
688 "assetPriority": "string",
689 "assetPriorityId": 0,
690 "assetPriorityDisplayId": "string",
691 "assetPriorityType": "string",
692 "assetAvailable": true,
693 "exactPlacement": "string",
694 "fosId": 0,
695 "downtimeStatus": "string",
696 "premiseFromNrm": true,
697 "modifiedAt": "2019-08-24T14:15:22Z"
698 },
699 "mainAssetDisplayId": "string",
700 "inspectionCategoryIds": [
701 0
702 ],
703 "inspectionCategories": [
704 "string"
705 ],
706 "inspectionCategoryId": 0,
707 "inspectionCategory": "string",
708 "inspectionConditionId": 0,
709 "inspectionCondition": "string",
710 "inspectionConditionType": "string",
711 "inspectionStatusId": 0,
712 "inspectionStatus": "string",
713 "inspectionStatusType": "string",
714 "inspectionItemIds": [
715 0
716 ],
717 "internalTeamIds": [
718 0
719 ],
720 "internalTeamDtos": [
721 {
722 "id": 0,
723 "createdBy": "string",
724 "createdAt": "2019-08-24T14:15:22Z",
725 "displayId": "string",
726 "name": "string",
727 "email": "string",
728 "phone": "string",
729 "manager": "string",
730 "requestCategoryName": [
731 "string"
732 ],
733 "requestCategoryId": [
734 0
735 ],
736 "requestCategoryDisplayId": [
737 "string"
738 ],
739 "description": "string",
740 "internalTeamUser": [
741 0
742 ],
743 "members": 0,
744 "mainAssets": [
745 0
746 ],
747 "premiseNames": [
748 "string"
749 ],
750 "internalTeamAvailable": true,
751 "premiseIds": [
752 0
753 ]
754 }
755 ],
756 "internalTeams": [
757 "string"
758 ],
759 "assignedUserIds": [
760 0
761 ],
762 "assignedUserDtos": [
763 {
764 "id": 0,
765 "createdBy": "string",
766 "createdAt": "2019-08-24T14:15:22Z",
767 "userName": "string",
768 "firstName": "string",
769 "lastName": "string",
770 "email": "string",
771 "roleIds": [
772 {
773 "id": 0,
774 "createdBy": "string",
775 "createdAt": "2019-08-24T14:15:22Z",
776 "modifiedBy": "string",
777 "modifiedAt": "2019-08-24T14:15:22Z",
778 "roleName": "string",
779 "entity": "string",
780 "new": true
781 }
782 ],
783 "internalTeamNames": [
784 "string"
785 ],
786 "internalTeamIds": [
787 0
788 ],
789 "internalTeamDisplayIds": [
790 "string"
791 ],
792 "premiseIds": [
793 0
794 ],
795 "premiseNames": [
796 "string"
797 ],
798 "userAvailable": true,
799 "temporaryWorkload": 0,
800 "preferredCultureCode": "string"
801 }
802 ],
803 "assignedUsers": [
804 "string"
805 ],
806 "activity": "string",
807 "createdByTrigger": true,
808 "modifiedAt": "2019-08-24T14:15:22Z"
809 }
810 }
811]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a scheduled event, encapsulating details such as event timing, participants, and relevant metadata to facilitate effective resource allocation and planning within the organization.] |
|
» type |
string |
false |
none |
Type of the resource |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» displayId |
string |
false |
none |
Unique identifier for the display |
» title |
string |
false |
none |
Title of the resource |
» details |
string |
false |
none |
Detailed description of the scheduled event, providing essential context and information for effective event management. |
» start |
string(date) |
false |
none |
Indicates the start date and time of the scheduled event, essential for effective resource allocation and planning. |
» end |
string(date) |
false |
none |
Indicates the end time of the scheduled event, providing clarity on the duration and timing for effective resource management. |
» 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. |
|
» time |
string |
false |
none |
Time of the resource |
» duration |
integer(int64) |
false |
none |
Represents the total duration of the scheduled event in minutes, facilitating effective time management and resource allocation. |
» bgcolor |
string |
false |
none |
Specifies the background color for the schedule event, enhancing visual organization and clarity in event representation. |
» workOrder |
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. |
|
»» 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 |
» inspection |
false |
none |
Data transfer object representing the details of an inspection, including its findings, status, and associated metadata, to facilitate effective tracking and management of compliance and quality assurance processes. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» name |
string |
false |
none |
Name of the resource |
»» description |
string |
false |
none |
Description of the resource |
»» dueDate |
string(date) |
false |
none |
Due date of the resource |
»» closeDate |
string(date) |
false |
none |
Date of the close |
»» createdDate |
string(date) |
false |
none |
Date of the created |
»» 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. |
|
»» endTime |
false |
none |
Data transfer object representing the local time settings relevant to business operations, ensuring accurate scheduling and time management across various regions. |
|
»» isCreatedBy |
string |
false |
none |
Whether the resource is created by |
»» isTemplate |
boolean |
false |
none |
Whether the resource is template |
»» inspectionAvailable |
boolean |
false |
none |
Indicates whether an inspection is available for the associated item, facilitating proactive management and compliance verification. |
»» inspectionType |
string |
false |
none |
Type of the inspection |
»» templateId |
integer(int64) |
false |
none |
Unique identifier for the template |
»» 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. |
|
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the inspection is sourced from the National Risk Model, facilitating informed decision-making in risk assessment processes. |
»» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
»» mainAssetIds |
[integer] |
false |
none |
List of unique identifiers for the primary assets associated with the inspection, facilitating effective tracking and management. |
»» mainAssetId |
integer(int64) |
false |
none |
Unique identifier for the main asset |
»» mainAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»» mainAssetDisplayId |
string |
false |
none |
Unique identifier for the main asset display |
»» inspectionCategoryIds |
[integer] |
false |
none |
Array of unique identifiers representing the categories of inspections associated with the inspection record. |
»» inspectionCategories |
[string] |
false |
none |
An array of inspection categories that classify the types of inspections conducted, facilitating organized tracking and reporting. |
»» inspectionCategoryId |
integer(int64) |
false |
none |
Unique identifier for the inspection category |
»» inspectionCategory |
string |
false |
none |
Category of the inspection |
»» inspectionConditionId |
integer(int64) |
false |
none |
Unique identifier for the inspection condition |
»» inspectionCondition |
string |
false |
none |
Describes the current condition of the inspection, providing essential context for assessment and decision-making. |
»» inspectionConditionType |
string |
false |
none |
Type of the inspection condition |
»» inspectionStatusId |
integer(int64) |
false |
none |
Unique identifier for the inspection status |
»» inspectionStatus |
string |
false |
none |
Status of the inspection |
»» inspectionStatusType |
string |
false |
none |
Type of the inspection status |
»» inspectionItemIds |
[integer] |
false |
none |
Array of unique identifiers for inspection items associated with the inspection process, facilitating efficient tracking and management. |
»» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the inspection, facilitating streamlined collaboration and accountability within the organization. |
»» internalTeamDtos |
false |
none |
An array of InspectionDTO objects representing the internal teams involved in the inspection process, facilitating effective collaboration and resource allocation. |
|
»» internalTeams |
[string] |
false |
none |
Array of internal teams associated with the inspection, facilitating collaboration and accountability within the inspection process. |
»» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers for users assigned to the inspection, facilitating effective tracking and management of responsibilities. |
»» assignedUserDtos |
false |
none |
Array of InspectionDTO objects representing the users assigned to conduct inspections, facilitating effective resource allocation and management. |
|
»» assignedUsers |
[string] |
false |
none |
List of users assigned to the inspection, facilitating effective task management and accountability within the inspection process. |
»» activity |
string |
false |
none |
Describes the specific activity associated with the inspection, providing essential context for tracking and reporting purposes. |
»» createdByTrigger |
boolean |
false |
none |
Indicates whether the inspection was initiated by an automated trigger within the system. |
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
Copy Inspection¶
HTTP Request
POST /api/inspections/copyInspection/{id}
📋 Description: Copies an existing inspection identified by the specified ID, allowing users to quickly replicate inspection details for efficiency in managing inspection workflows.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
name |
query |
string |
true |
Name of the resource |
saveAsTemplate |
query |
boolean |
true |
Indicates whether the copied inspection should be saved as a template for future use. |
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 "dueDate": "2019-08-24",
9 "closeDate": "2019-08-24",
10 "createdDate": "2019-08-24",
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "startTime": {
14 "hour": 0,
15 "minute": 0,
16 "second": 0,
17 "nano": 0
18 },
19 "endTime": {
20 "hour": 0,
21 "minute": 0,
22 "second": 0,
23 "nano": 0
24 },
25 "isCreatedBy": "string",
26 "isTemplate": true,
27 "inspectionAvailable": true,
28 "inspectionType": "string",
29 "templateId": 0,
30 "premiseId": 0,
31 "premiseDto": {
32 "id": 0,
33 "createdBy": "string",
34 "createdAt": "2019-08-24T14:15:22Z",
35 "displayId": "string",
36 "premiseName": "string",
37 "description": "string",
38 "address": "string",
39 "internalTeamNames": [
40 "string"
41 ],
42 "internalTeamIds": [
43 0
44 ],
45 "premiseAvailable": true,
46 "premiseFromNrm": true,
47 "nlmId": 0,
48 "nlmDisplayId": "string",
49 "nlmUsed": true,
50 "manager": 0,
51 "managerName": "string",
52 "imageId": 0,
53 "area": "string",
54 "modifiedAt": "2019-08-24T14:15:22Z"
55 },
56 "premiseFromNrm": true,
57 "premiseDisplayId": "string",
58 "mainAssetIds": [
59 0
60 ],
61 "mainAssetId": 0,
62 "mainAssetDto": {
63 "id": 0,
64 "createdBy": "string",
65 "createdAt": "2019-08-24T14:15:22Z",
66 "displayId": "string",
67 "name": "string",
68 "description": "string",
69 "qrCode": "string",
70 "barCode": "string",
71 "imageId": 0,
72 "model": "string",
73 "manufacturer": "string",
74 "serialNumber": "string",
75 "cost": "81.08",
76 "premiseId": 0,
77 "premiseDisplayId": "string",
78 "premiseDto": {
79 "id": 0,
80 "createdBy": "string",
81 "createdAt": "2019-08-24T14:15:22Z",
82 "displayId": "string",
83 "premiseName": "string",
84 "description": "string",
85 "address": "string",
86 "internalTeamNames": [
87 "string"
88 ],
89 "internalTeamIds": [
90 0
91 ],
92 "premiseAvailable": true,
93 "premiseFromNrm": true,
94 "nlmId": 0,
95 "nlmDisplayId": "string",
96 "nlmUsed": true,
97 "manager": 0,
98 "managerName": "string",
99 "imageId": 0,
100 "area": "string",
101 "modifiedAt": "2019-08-24T14:15:22Z"
102 },
103 "acquisitionDate": "2019-08-24",
104 "endOfLife": "2019-08-24",
105 "assetStatusId": 0,
106 "assetStatus": "string",
107 "assetStatusType": "string",
108 "parentAssetId": 0,
109 "parentAssetDisplayId": "string",
110 "parentAsset": "string",
111 "parentAssetDto": {},
112 "upcomingMaintenanceDate": "2019-08-24",
113 "assetCategoryIds": [
114 0
115 ],
116 "assetCategories": [
117 "string"
118 ],
119 "internalTeamIds": [
120 0
121 ],
122 "internalTeamDtos": [
123 {
124 "id": 0,
125 "createdBy": "string",
126 "createdAt": "2019-08-24T14:15:22Z",
127 "displayId": "string",
128 "name": "string",
129 "email": "string",
130 "phone": "string",
131 "manager": "string",
132 "requestCategoryName": [
133 "string"
134 ],
135 "requestCategoryId": [
136 0
137 ],
138 "requestCategoryDisplayId": [
139 "string"
140 ],
141 "description": "string",
142 "internalTeamUser": [
143 0
144 ],
145 "members": 0,
146 "mainAssets": [
147 0
148 ],
149 "premiseNames": [
150 "string"
151 ],
152 "internalTeamAvailable": true,
153 "premiseIds": [
154 0
155 ]
156 }
157 ],
158 "internalTeams": [
159 "string"
160 ],
161 "assignedUserIds": [
162 0
163 ],
164 "assignedUserDtos": [
165 {
166 "id": 0,
167 "createdBy": "string",
168 "createdAt": "2019-08-24T14:15:22Z",
169 "userName": "string",
170 "firstName": "string",
171 "lastName": "string",
172 "email": "string",
173 "roleIds": [
174 {
175 "id": 0,
176 "createdBy": "string",
177 "createdAt": "2019-08-24T14:15:22Z",
178 "modifiedBy": "string",
179 "modifiedAt": "2019-08-24T14:15:22Z",
180 "roleName": "string",
181 "entity": "string",
182 "new": true
183 }
184 ],
185 "internalTeamNames": [
186 "string"
187 ],
188 "internalTeamIds": [
189 0
190 ],
191 "internalTeamDisplayIds": [
192 "string"
193 ],
194 "premiseIds": [
195 0
196 ],
197 "premiseNames": [
198 "string"
199 ],
200 "userAvailable": true,
201 "temporaryWorkload": 0,
202 "preferredCultureCode": "string"
203 }
204 ],
205 "assignedUsers": [
206 "string"
207 ],
208 "assetPriority": "string",
209 "assetPriorityId": 0,
210 "assetPriorityDisplayId": "string",
211 "assetPriorityType": "string",
212 "assetAvailable": true,
213 "exactPlacement": "string",
214 "fosId": 0,
215 "downtimeStatus": "string",
216 "premiseFromNrm": true,
217 "modifiedAt": "2019-08-24T14:15:22Z"
218 },
219 "mainAssetDisplayId": "string",
220 "inspectionCategoryIds": [
221 0
222 ],
223 "inspectionCategories": [
224 "string"
225 ],
226 "inspectionCategoryId": 0,
227 "inspectionCategory": "string",
228 "inspectionConditionId": 0,
229 "inspectionCondition": "string",
230 "inspectionConditionType": "string",
231 "inspectionStatusId": 0,
232 "inspectionStatus": "string",
233 "inspectionStatusType": "string",
234 "inspectionItemIds": [
235 0
236 ],
237 "internalTeamIds": [
238 0
239 ],
240 "internalTeamDtos": [
241 {
242 "id": 0,
243 "createdBy": "string",
244 "createdAt": "2019-08-24T14:15:22Z",
245 "displayId": "string",
246 "name": "string",
247 "email": "string",
248 "phone": "string",
249 "manager": "string",
250 "requestCategoryName": [
251 "string"
252 ],
253 "requestCategoryId": [
254 0
255 ],
256 "requestCategoryDisplayId": [
257 "string"
258 ],
259 "description": "string",
260 "internalTeamUser": [
261 0
262 ],
263 "members": 0,
264 "mainAssets": [
265 0
266 ],
267 "premiseNames": [
268 "string"
269 ],
270 "internalTeamAvailable": true,
271 "premiseIds": [
272 0
273 ]
274 }
275 ],
276 "internalTeams": [
277 "string"
278 ],
279 "assignedUserIds": [
280 0
281 ],
282 "assignedUserDtos": [
283 {
284 "id": 0,
285 "createdBy": "string",
286 "createdAt": "2019-08-24T14:15:22Z",
287 "userName": "string",
288 "firstName": "string",
289 "lastName": "string",
290 "email": "string",
291 "roleIds": [
292 {
293 "id": 0,
294 "createdBy": "string",
295 "createdAt": "2019-08-24T14:15:22Z",
296 "modifiedBy": "string",
297 "modifiedAt": "2019-08-24T14:15:22Z",
298 "roleName": "string",
299 "entity": "string",
300 "new": true
301 }
302 ],
303 "internalTeamNames": [
304 "string"
305 ],
306 "internalTeamIds": [
307 0
308 ],
309 "internalTeamDisplayIds": [
310 "string"
311 ],
312 "premiseIds": [
313 0
314 ],
315 "premiseNames": [
316 "string"
317 ],
318 "userAvailable": true,
319 "temporaryWorkload": 0,
320 "preferredCultureCode": "string"
321 }
322 ],
323 "assignedUsers": [
324 "string"
325 ],
326 "activity": "string",
327 "createdByTrigger": true,
328 "modifiedAt": "2019-08-24T14:15:22Z"
329}
Get Internal Teams By ID¶
HTTP Request
GET /api/inspections/{id}/internalTeams/{internalTeamId}
📋 Description: Fetches details of a specific internal team associated with a given inspection, facilitating effective collaboration and resource allocation within the inspection process.
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 Inspections By Main Asset ID¶
HTTP Request
GET /api/inspections/{id}/historyOfInspections
📋 Description: Fetches the historical inspection records associated with a specific inspection ID, providing insights into past evaluations and compliance status.
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 Inspection¶
HTTP Request
GET /api/inspections/{id}/documents
📋 Description: Retrieves documents associated with a specific inspection identified by the provided ID, enabling users to access relevant documentation for review and compliance purposes.
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 Inspection ID¶
HTTP Request
GET /api/inspections/{id}/documents/{documentId}
📋 Description: Fetches the specified document associated with a particular inspection, enabling users to access critical documentation for review and compliance purposes.
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 Inspection Types¶
HTTP Request
GET /api/inspections/types
📋 Description: Retrieves a list of available inspection types, providing essential information for users to select appropriate categories for their inspection processes.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]
Response Schema
Get All Inspection Templates¶
HTTP Request
GET /api/inspections/templates
📋 Description: Fetches a list of available inspection templates, enabling users to streamline the inspection process and ensure compliance with industry standards.
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 "dueDate": "2019-08-24",
10 "closeDate": "2019-08-24",
11 "createdDate": "2019-08-24",
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "startTime": {
15 "hour": 0,
16 "minute": 0,
17 "second": 0,
18 "nano": 0
19 },
20 "endTime": {
21 "hour": 0,
22 "minute": 0,
23 "second": 0,
24 "nano": 0
25 },
26 "isCreatedBy": "string",
27 "isTemplate": true,
28 "inspectionAvailable": true,
29 "inspectionType": "string",
30 "templateId": 0,
31 "premiseId": 0,
32 "premiseDto": {
33 "id": 0,
34 "createdBy": "string",
35 "createdAt": "2019-08-24T14:15:22Z",
36 "displayId": "string",
37 "premiseName": "string",
38 "description": "string",
39 "address": "string",
40 "internalTeamNames": [
41 "string"
42 ],
43 "internalTeamIds": [
44 0
45 ],
46 "premiseAvailable": true,
47 "premiseFromNrm": true,
48 "nlmId": 0,
49 "nlmDisplayId": "string",
50 "nlmUsed": true,
51 "manager": 0,
52 "managerName": "string",
53 "imageId": 0,
54 "area": "string",
55 "modifiedAt": "2019-08-24T14:15:22Z"
56 },
57 "premiseFromNrm": true,
58 "premiseDisplayId": "string",
59 "mainAssetIds": [
60 0
61 ],
62 "mainAssetId": 0,
63 "mainAssetDto": {
64 "id": 0,
65 "createdBy": "string",
66 "createdAt": "2019-08-24T14:15:22Z",
67 "displayId": "string",
68 "name": "string",
69 "description": "string",
70 "qrCode": "string",
71 "barCode": "string",
72 "imageId": 0,
73 "model": "string",
74 "manufacturer": "string",
75 "serialNumber": "string",
76 "cost": "81.08",
77 "premiseId": 0,
78 "premiseDisplayId": "string",
79 "premiseDto": {
80 "id": 0,
81 "createdBy": "string",
82 "createdAt": "2019-08-24T14:15:22Z",
83 "displayId": "string",
84 "premiseName": "string",
85 "description": "string",
86 "address": "string",
87 "internalTeamNames": [
88 "string"
89 ],
90 "internalTeamIds": [
91 0
92 ],
93 "premiseAvailable": true,
94 "premiseFromNrm": true,
95 "nlmId": 0,
96 "nlmDisplayId": "string",
97 "nlmUsed": true,
98 "manager": 0,
99 "managerName": "string",
100 "imageId": 0,
101 "area": "string",
102 "modifiedAt": "2019-08-24T14:15:22Z"
103 },
104 "acquisitionDate": "2019-08-24",
105 "endOfLife": "2019-08-24",
106 "assetStatusId": 0,
107 "assetStatus": "string",
108 "assetStatusType": "string",
109 "parentAssetId": 0,
110 "parentAssetDisplayId": "string",
111 "parentAsset": "string",
112 "parentAssetDto": {},
113 "upcomingMaintenanceDate": "2019-08-24",
114 "assetCategoryIds": [
115 0
116 ],
117 "assetCategories": [
118 "string"
119 ],
120 "internalTeamIds": [
121 0
122 ],
123 "internalTeamDtos": [
124 {
125 "id": 0,
126 "createdBy": "string",
127 "createdAt": "2019-08-24T14:15:22Z",
128 "displayId": "string",
129 "name": "string",
130 "email": "string",
131 "phone": "string",
132 "manager": "string",
133 "requestCategoryName": [
134 "string"
135 ],
136 "requestCategoryId": [
137 0
138 ],
139 "requestCategoryDisplayId": [
140 "string"
141 ],
142 "description": "string",
143 "internalTeamUser": [
144 0
145 ],
146 "members": 0,
147 "mainAssets": [
148 0
149 ],
150 "premiseNames": [
151 "string"
152 ],
153 "internalTeamAvailable": true,
154 "premiseIds": [
155 0
156 ]
157 }
158 ],
159 "internalTeams": [
160 "string"
161 ],
162 "assignedUserIds": [
163 0
164 ],
165 "assignedUserDtos": [
166 {
167 "id": 0,
168 "createdBy": "string",
169 "createdAt": "2019-08-24T14:15:22Z",
170 "userName": "string",
171 "firstName": "string",
172 "lastName": "string",
173 "email": "string",
174 "roleIds": [
175 {
176 "id": 0,
177 "createdBy": "string",
178 "createdAt": "2019-08-24T14:15:22Z",
179 "modifiedBy": "string",
180 "modifiedAt": "2019-08-24T14:15:22Z",
181 "roleName": "string",
182 "entity": "string",
183 "new": true
184 }
185 ],
186 "internalTeamNames": [
187 "string"
188 ],
189 "internalTeamIds": [
190 0
191 ],
192 "internalTeamDisplayIds": [
193 "string"
194 ],
195 "premiseIds": [
196 0
197 ],
198 "premiseNames": [
199 "string"
200 ],
201 "userAvailable": true,
202 "temporaryWorkload": 0,
203 "preferredCultureCode": "string"
204 }
205 ],
206 "assignedUsers": [
207 "string"
208 ],
209 "assetPriority": "string",
210 "assetPriorityId": 0,
211 "assetPriorityDisplayId": "string",
212 "assetPriorityType": "string",
213 "assetAvailable": true,
214 "exactPlacement": "string",
215 "fosId": 0,
216 "downtimeStatus": "string",
217 "premiseFromNrm": true,
218 "modifiedAt": "2019-08-24T14:15:22Z"
219 },
220 "mainAssetDisplayId": "string",
221 "inspectionCategoryIds": [
222 0
223 ],
224 "inspectionCategories": [
225 "string"
226 ],
227 "inspectionCategoryId": 0,
228 "inspectionCategory": "string",
229 "inspectionConditionId": 0,
230 "inspectionCondition": "string",
231 "inspectionConditionType": "string",
232 "inspectionStatusId": 0,
233 "inspectionStatus": "string",
234 "inspectionStatusType": "string",
235 "inspectionItemIds": [
236 0
237 ],
238 "internalTeamIds": [
239 0
240 ],
241 "internalTeamDtos": [
242 {
243 "id": 0,
244 "createdBy": "string",
245 "createdAt": "2019-08-24T14:15:22Z",
246 "displayId": "string",
247 "name": "string",
248 "email": "string",
249 "phone": "string",
250 "manager": "string",
251 "requestCategoryName": [
252 "string"
253 ],
254 "requestCategoryId": [
255 0
256 ],
257 "requestCategoryDisplayId": [
258 "string"
259 ],
260 "description": "string",
261 "internalTeamUser": [
262 0
263 ],
264 "members": 0,
265 "mainAssets": [
266 0
267 ],
268 "premiseNames": [
269 "string"
270 ],
271 "internalTeamAvailable": true,
272 "premiseIds": [
273 0
274 ]
275 }
276 ],
277 "internalTeams": [
278 "string"
279 ],
280 "assignedUserIds": [
281 0
282 ],
283 "assignedUserDtos": [
284 {
285 "id": 0,
286 "createdBy": "string",
287 "createdAt": "2019-08-24T14:15:22Z",
288 "userName": "string",
289 "firstName": "string",
290 "lastName": "string",
291 "email": "string",
292 "roleIds": [
293 {
294 "id": 0,
295 "createdBy": "string",
296 "createdAt": "2019-08-24T14:15:22Z",
297 "modifiedBy": "string",
298 "modifiedAt": "2019-08-24T14:15:22Z",
299 "roleName": "string",
300 "entity": "string",
301 "new": true
302 }
303 ],
304 "internalTeamNames": [
305 "string"
306 ],
307 "internalTeamIds": [
308 0
309 ],
310 "internalTeamDisplayIds": [
311 "string"
312 ],
313 "premiseIds": [
314 0
315 ],
316 "premiseNames": [
317 "string"
318 ],
319 "userAvailable": true,
320 "temporaryWorkload": 0,
321 "preferredCultureCode": "string"
322 }
323 ],
324 "assignedUsers": [
325 "string"
326 ],
327 "activity": "string",
328 "createdByTrigger": true,
329 "modifiedAt": "2019-08-24T14:15:22Z"
330 }
331]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the details of an inspection, including its findings, status, and associated metadata, to facilitate effective tracking and management of compliance and quality assurance processes.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
false |
none |
Name of the resource |
» description |
string |
false |
none |
Description of the resource |
» dueDate |
string(date) |
false |
none |
Due date of the resource |
» closeDate |
string(date) |
false |
none |
Date of the close |
» createdDate |
string(date) |
false |
none |
Date of the created |
» 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. |
|
» isCreatedBy |
string |
false |
none |
Whether the resource is created by |
» isTemplate |
boolean |
false |
none |
Whether the resource is template |
» inspectionAvailable |
boolean |
false |
none |
Indicates whether an inspection is available for the associated item, facilitating proactive management and compliance verification. |
» inspectionType |
string |
false |
none |
Type of the inspection |
» templateId |
integer(int64) |
false |
none |
Unique identifier for the template |
» 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 inspection is sourced from the National Risk Model, facilitating informed decision-making in risk assessment processes. |
» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
» mainAssetIds |
[integer] |
false |
none |
List of unique identifiers for the primary assets associated with the inspection, facilitating effective tracking and management. |
» mainAssetId |
integer(int64) |
false |
none |
Unique identifier for the main asset |
» mainAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» name |
string |
false |
none |
Name of the resource |
»» description |
string |
false |
none |
Description of the resource |
»» qrCode |
string |
false |
none |
Code for the qr |
»» barCode |
string |
false |
none |
Code for the bar |
»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»» model |
string |
false |
none |
Specifies the model associated with the main asset, providing essential context for asset classification and management. |
»» manufacturer |
string |
false |
none |
Name of the manufacturer associated with the asset, providing essential information for inventory management and supplier relations. |
»» serialNumber |
string |
false |
none |
Unique identifier for the asset, used to track and manage inventory within the system. |
»» cost |
string |
false |
none |
Represents the total cost associated with the main asset, providing essential financial information for budgeting and resource allocation. |
»» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
»» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
»» premiseDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
»» acquisitionDate |
string(date) |
false |
none |
Date of the acquisition |
»» endOfLife |
string(date) |
false |
none |
Indicates the end-of-life date for the asset, providing critical information for lifecycle management and planning. |
»» assetStatusId |
integer(int64) |
false |
none |
Unique identifier for the asset status |
»» assetStatus |
string |
false |
none |
Status of the asset |
»» assetStatusType |
string |
false |
none |
Type of the asset status |
»» parentAssetId |
integer(int64) |
false |
none |
Unique identifier for the parent asset |
»» parentAssetDisplayId |
string |
false |
none |
Unique identifier for the parent asset display |
»» parentAsset |
string |
false |
none |
Identifier for the parent asset associated with the main asset, facilitating hierarchical relationships within asset management. |
»» parentAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»» upcomingMaintenanceDate |
string(date) |
false |
none |
Date of the upcoming maintenance |
»» assetCategoryIds |
[integer] |
false |
none |
Array of unique identifiers representing the categories to which the asset belongs, facilitating effective asset classification and management. |
»» assetCategories |
[string] |
false |
none |
Array of asset categories that classify the main assets within the system, facilitating better organization and management of asset data. |
»» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the main asset, facilitating streamlined collaboration and resource allocation. |
»» internalTeamDtos |
false |
none |
An array of MainAssetDTO objects representing the internal teams associated with the asset, facilitating effective resource management and collaboration within the organization. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» name |
string |
false |
none |
Name of the resource |
string |
false |
none |
Email address of the internal team member, used for communication and notifications within the organization. |
|
»»» phone |
string |
false |
none |
Contact number for the internal team, facilitating communication and collaboration within the organization. |
»»» manager |
string |
false |
none |
Represents the name or identifier of the team manager responsible for overseeing the internal team. |
»»» requestCategoryName |
[string] |
false |
none |
Name of the request category |
»»» requestCategoryId |
[integer] |
false |
none |
Unique identifier for the request category |
»»» requestCategoryDisplayId |
[string] |
false |
none |
Unique identifier for the request category display |
»»» description |
string |
false |
none |
Description of the resource |
»»» internalTeamUser |
[integer] |
false |
none |
An array of InternalTeamDTO objects representing the users within the internal team, facilitating collaboration and resource management. |
»»» members |
integer(int32) |
false |
none |
Represents the total number of members within the internal team, providing insight into team size for resource allocation and management. |
»»» mainAssets |
[integer] |
false |
none |
An array of internal team assets that represent the key resources and capabilities utilized within the organization. |
»»» premiseNames |
[string] |
false |
none |
List of names associated with the premises relevant to the internal team, facilitating efficient identification and management of locations within the organization. |
»»» internalTeamAvailable |
boolean |
false |
none |
Indicates the availability of the internal team for project allocation and resource planning. |
»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the internal team. |
»» internalTeams |
[string] |
false |
none |
An array of internal teams associated with the main asset, facilitating collaboration and resource allocation within the organization. |
»» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers representing users assigned to the main asset, facilitating effective resource management and accountability. |
»» assignedUserDtos |
false |
none |
Array of user assignments associated with the main asset, providing insights into resource allocation and accountability. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» userName |
string |
false |
none |
Name of the user |
»»» firstName |
string |
false |
none |
Name of the first |
»»» lastName |
string |
false |
none |
Name of the last |
string |
false |
none |
Email address of the user, used for communication and account verification purposes within the system. |
|
»»» roleIds |
false |
none |
Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»»» modifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»»»» roleName |
string |
false |
none |
Name of the role |
»»»» entity |
string |
false |
none |
Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management. |
»»»» new |
boolean |
false |
none |
Indicates whether the role is newly created within the system, facilitating effective management of organizational changes. |
»»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization. |
»»» internalTeamIds |
[integer] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization. |
»»» internalTeamDisplayIds |
[string] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration. |
»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations. |
»»» premiseNames |
[string] |
false |
none |
List of names associated with the user’s premises, providing essential context for location-based services and operations. |
»»» userAvailable |
boolean |
false |
none |
Indicates whether the user is available for assignment or engagement within the system. |
»»» temporaryWorkload |
integer(int32) |
false |
none |
Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning. |
»»» preferredCultureCode |
string |
false |
none |
Code for the preferred culture |
»» assignedUsers |
[string] |
false |
none |
List of users assigned to the main asset, facilitating effective resource management and collaboration within the organization. |
»» assetPriority |
string |
false |
none |
Priority of the asset |
»» assetPriorityId |
integer(int64) |
false |
none |
Unique identifier for the asset priority |
»» assetPriorityDisplayId |
string |
false |
none |
Unique identifier for the asset priority display |
»» assetPriorityType |
string |
false |
none |
Type of the asset priority |
»» assetAvailable |
boolean |
false |
none |
Indicates whether the asset is currently available for allocation or use within the system. |
»» exactPlacement |
string |
false |
none |
Specifies the precise location or context in which the main asset is intended to be utilized within the business framework. |
»» fosId |
integer(int64) |
false |
none |
Unique identifier for the fos |
»» downtimeStatus |
string |
false |
none |
Status of the downtime |
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the asset is sourced from the National Resource Management (NRM) framework, facilitating compliance and resource tracking. |
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» mainAssetDisplayId |
string |
false |
none |
Unique identifier for the main asset display |
» inspectionCategoryIds |
[integer] |
false |
none |
Array of unique identifiers representing the categories of inspections associated with the inspection record. |
» inspectionCategories |
[string] |
false |
none |
An array of inspection categories that classify the types of inspections conducted, facilitating organized tracking and reporting. |
» inspectionCategoryId |
integer(int64) |
false |
none |
Unique identifier for the inspection category |
» inspectionCategory |
string |
false |
none |
Category of the inspection |
» inspectionConditionId |
integer(int64) |
false |
none |
Unique identifier for the inspection condition |
» inspectionCondition |
string |
false |
none |
Describes the current condition of the inspection, providing essential context for assessment and decision-making. |
» inspectionConditionType |
string |
false |
none |
Type of the inspection condition |
» inspectionStatusId |
integer(int64) |
false |
none |
Unique identifier for the inspection status |
» inspectionStatus |
string |
false |
none |
Status of the inspection |
» inspectionStatusType |
string |
false |
none |
Type of the inspection status |
» inspectionItemIds |
[integer] |
false |
none |
Array of unique identifiers for inspection items associated with the inspection process, facilitating efficient tracking and management. |
» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the inspection, facilitating streamlined collaboration and accountability within the organization. |
» internalTeamDtos |
false |
none |
An array of InspectionDTO objects representing the internal teams involved in the inspection process, facilitating effective collaboration and resource allocation. |
|
» internalTeams |
[string] |
false |
none |
Array of internal teams associated with the inspection, facilitating collaboration and accountability within the inspection process. |
» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers for users assigned to the inspection, facilitating effective tracking and management of responsibilities. |
» assignedUserDtos |
false |
none |
Array of InspectionDTO objects representing the users assigned to conduct inspections, facilitating effective resource allocation and management. |
|
» assignedUsers |
[string] |
false |
none |
List of users assigned to the inspection, facilitating effective task management and accountability within the inspection process. |
» activity |
string |
false |
none |
Describes the specific activity associated with the inspection, providing essential context for tracking and reporting purposes. |
» createdByTrigger |
boolean |
false |
none |
Indicates whether the inspection was initiated by an automated trigger within the system. |
» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
Get All My Inspections¶
HTTP Request
GET /api/inspections/myInspections
📋 Description: Fetches a list of inspections associated with the authenticated user, providing insights into their inspection history and status.
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 "dueDate": "2019-08-24",
10 "closeDate": "2019-08-24",
11 "createdDate": "2019-08-24",
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "startTime": {
15 "hour": 0,
16 "minute": 0,
17 "second": 0,
18 "nano": 0
19 },
20 "endTime": {
21 "hour": 0,
22 "minute": 0,
23 "second": 0,
24 "nano": 0
25 },
26 "isCreatedBy": "string",
27 "isTemplate": true,
28 "inspectionAvailable": true,
29 "inspectionType": "string",
30 "templateId": 0,
31 "premiseId": 0,
32 "premiseDto": {
33 "id": 0,
34 "createdBy": "string",
35 "createdAt": "2019-08-24T14:15:22Z",
36 "displayId": "string",
37 "premiseName": "string",
38 "description": "string",
39 "address": "string",
40 "internalTeamNames": [
41 "string"
42 ],
43 "internalTeamIds": [
44 0
45 ],
46 "premiseAvailable": true,
47 "premiseFromNrm": true,
48 "nlmId": 0,
49 "nlmDisplayId": "string",
50 "nlmUsed": true,
51 "manager": 0,
52 "managerName": "string",
53 "imageId": 0,
54 "area": "string",
55 "modifiedAt": "2019-08-24T14:15:22Z"
56 },
57 "premiseFromNrm": true,
58 "premiseDisplayId": "string",
59 "mainAssetIds": [
60 0
61 ],
62 "mainAssetId": 0,
63 "mainAssetDto": {
64 "id": 0,
65 "createdBy": "string",
66 "createdAt": "2019-08-24T14:15:22Z",
67 "displayId": "string",
68 "name": "string",
69 "description": "string",
70 "qrCode": "string",
71 "barCode": "string",
72 "imageId": 0,
73 "model": "string",
74 "manufacturer": "string",
75 "serialNumber": "string",
76 "cost": "81.08",
77 "premiseId": 0,
78 "premiseDisplayId": "string",
79 "premiseDto": {
80 "id": 0,
81 "createdBy": "string",
82 "createdAt": "2019-08-24T14:15:22Z",
83 "displayId": "string",
84 "premiseName": "string",
85 "description": "string",
86 "address": "string",
87 "internalTeamNames": [
88 "string"
89 ],
90 "internalTeamIds": [
91 0
92 ],
93 "premiseAvailable": true,
94 "premiseFromNrm": true,
95 "nlmId": 0,
96 "nlmDisplayId": "string",
97 "nlmUsed": true,
98 "manager": 0,
99 "managerName": "string",
100 "imageId": 0,
101 "area": "string",
102 "modifiedAt": "2019-08-24T14:15:22Z"
103 },
104 "acquisitionDate": "2019-08-24",
105 "endOfLife": "2019-08-24",
106 "assetStatusId": 0,
107 "assetStatus": "string",
108 "assetStatusType": "string",
109 "parentAssetId": 0,
110 "parentAssetDisplayId": "string",
111 "parentAsset": "string",
112 "parentAssetDto": {},
113 "upcomingMaintenanceDate": "2019-08-24",
114 "assetCategoryIds": [
115 0
116 ],
117 "assetCategories": [
118 "string"
119 ],
120 "internalTeamIds": [
121 0
122 ],
123 "internalTeamDtos": [
124 {
125 "id": 0,
126 "createdBy": "string",
127 "createdAt": "2019-08-24T14:15:22Z",
128 "displayId": "string",
129 "name": "string",
130 "email": "string",
131 "phone": "string",
132 "manager": "string",
133 "requestCategoryName": [
134 "string"
135 ],
136 "requestCategoryId": [
137 0
138 ],
139 "requestCategoryDisplayId": [
140 "string"
141 ],
142 "description": "string",
143 "internalTeamUser": [
144 0
145 ],
146 "members": 0,
147 "mainAssets": [
148 0
149 ],
150 "premiseNames": [
151 "string"
152 ],
153 "internalTeamAvailable": true,
154 "premiseIds": [
155 0
156 ]
157 }
158 ],
159 "internalTeams": [
160 "string"
161 ],
162 "assignedUserIds": [
163 0
164 ],
165 "assignedUserDtos": [
166 {
167 "id": 0,
168 "createdBy": "string",
169 "createdAt": "2019-08-24T14:15:22Z",
170 "userName": "string",
171 "firstName": "string",
172 "lastName": "string",
173 "email": "string",
174 "roleIds": [
175 {
176 "id": 0,
177 "createdBy": "string",
178 "createdAt": "2019-08-24T14:15:22Z",
179 "modifiedBy": "string",
180 "modifiedAt": "2019-08-24T14:15:22Z",
181 "roleName": "string",
182 "entity": "string",
183 "new": true
184 }
185 ],
186 "internalTeamNames": [
187 "string"
188 ],
189 "internalTeamIds": [
190 0
191 ],
192 "internalTeamDisplayIds": [
193 "string"
194 ],
195 "premiseIds": [
196 0
197 ],
198 "premiseNames": [
199 "string"
200 ],
201 "userAvailable": true,
202 "temporaryWorkload": 0,
203 "preferredCultureCode": "string"
204 }
205 ],
206 "assignedUsers": [
207 "string"
208 ],
209 "assetPriority": "string",
210 "assetPriorityId": 0,
211 "assetPriorityDisplayId": "string",
212 "assetPriorityType": "string",
213 "assetAvailable": true,
214 "exactPlacement": "string",
215 "fosId": 0,
216 "downtimeStatus": "string",
217 "premiseFromNrm": true,
218 "modifiedAt": "2019-08-24T14:15:22Z"
219 },
220 "mainAssetDisplayId": "string",
221 "inspectionCategoryIds": [
222 0
223 ],
224 "inspectionCategories": [
225 "string"
226 ],
227 "inspectionCategoryId": 0,
228 "inspectionCategory": "string",
229 "inspectionConditionId": 0,
230 "inspectionCondition": "string",
231 "inspectionConditionType": "string",
232 "inspectionStatusId": 0,
233 "inspectionStatus": "string",
234 "inspectionStatusType": "string",
235 "inspectionItemIds": [
236 0
237 ],
238 "internalTeamIds": [
239 0
240 ],
241 "internalTeamDtos": [
242 {
243 "id": 0,
244 "createdBy": "string",
245 "createdAt": "2019-08-24T14:15:22Z",
246 "displayId": "string",
247 "name": "string",
248 "email": "string",
249 "phone": "string",
250 "manager": "string",
251 "requestCategoryName": [
252 "string"
253 ],
254 "requestCategoryId": [
255 0
256 ],
257 "requestCategoryDisplayId": [
258 "string"
259 ],
260 "description": "string",
261 "internalTeamUser": [
262 0
263 ],
264 "members": 0,
265 "mainAssets": [
266 0
267 ],
268 "premiseNames": [
269 "string"
270 ],
271 "internalTeamAvailable": true,
272 "premiseIds": [
273 0
274 ]
275 }
276 ],
277 "internalTeams": [
278 "string"
279 ],
280 "assignedUserIds": [
281 0
282 ],
283 "assignedUserDtos": [
284 {
285 "id": 0,
286 "createdBy": "string",
287 "createdAt": "2019-08-24T14:15:22Z",
288 "userName": "string",
289 "firstName": "string",
290 "lastName": "string",
291 "email": "string",
292 "roleIds": [
293 {
294 "id": 0,
295 "createdBy": "string",
296 "createdAt": "2019-08-24T14:15:22Z",
297 "modifiedBy": "string",
298 "modifiedAt": "2019-08-24T14:15:22Z",
299 "roleName": "string",
300 "entity": "string",
301 "new": true
302 }
303 ],
304 "internalTeamNames": [
305 "string"
306 ],
307 "internalTeamIds": [
308 0
309 ],
310 "internalTeamDisplayIds": [
311 "string"
312 ],
313 "premiseIds": [
314 0
315 ],
316 "premiseNames": [
317 "string"
318 ],
319 "userAvailable": true,
320 "temporaryWorkload": 0,
321 "preferredCultureCode": "string"
322 }
323 ],
324 "assignedUsers": [
325 "string"
326 ],
327 "activity": "string",
328 "createdByTrigger": true,
329 "modifiedAt": "2019-08-24T14:15:22Z"
330 }
331]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the details of an inspection, including its findings, status, and associated metadata, to facilitate effective tracking and management of compliance and quality assurance processes.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
false |
none |
Name of the resource |
» description |
string |
false |
none |
Description of the resource |
» dueDate |
string(date) |
false |
none |
Due date of the resource |
» closeDate |
string(date) |
false |
none |
Date of the close |
» createdDate |
string(date) |
false |
none |
Date of the created |
» 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. |
|
» isCreatedBy |
string |
false |
none |
Whether the resource is created by |
» isTemplate |
boolean |
false |
none |
Whether the resource is template |
» inspectionAvailable |
boolean |
false |
none |
Indicates whether an inspection is available for the associated item, facilitating proactive management and compliance verification. |
» inspectionType |
string |
false |
none |
Type of the inspection |
» templateId |
integer(int64) |
false |
none |
Unique identifier for the template |
» 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 inspection is sourced from the National Risk Model, facilitating informed decision-making in risk assessment processes. |
» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
» mainAssetIds |
[integer] |
false |
none |
List of unique identifiers for the primary assets associated with the inspection, facilitating effective tracking and management. |
» mainAssetId |
integer(int64) |
false |
none |
Unique identifier for the main asset |
» mainAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» name |
string |
false |
none |
Name of the resource |
»» description |
string |
false |
none |
Description of the resource |
»» qrCode |
string |
false |
none |
Code for the qr |
»» barCode |
string |
false |
none |
Code for the bar |
»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»» model |
string |
false |
none |
Specifies the model associated with the main asset, providing essential context for asset classification and management. |
»» manufacturer |
string |
false |
none |
Name of the manufacturer associated with the asset, providing essential information for inventory management and supplier relations. |
»» serialNumber |
string |
false |
none |
Unique identifier for the asset, used to track and manage inventory within the system. |
»» cost |
string |
false |
none |
Represents the total cost associated with the main asset, providing essential financial information for budgeting and resource allocation. |
»» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
»» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
»» premiseDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
»» acquisitionDate |
string(date) |
false |
none |
Date of the acquisition |
»» endOfLife |
string(date) |
false |
none |
Indicates the end-of-life date for the asset, providing critical information for lifecycle management and planning. |
»» assetStatusId |
integer(int64) |
false |
none |
Unique identifier for the asset status |
»» assetStatus |
string |
false |
none |
Status of the asset |
»» assetStatusType |
string |
false |
none |
Type of the asset status |
»» parentAssetId |
integer(int64) |
false |
none |
Unique identifier for the parent asset |
»» parentAssetDisplayId |
string |
false |
none |
Unique identifier for the parent asset display |
»» parentAsset |
string |
false |
none |
Identifier for the parent asset associated with the main asset, facilitating hierarchical relationships within asset management. |
»» parentAssetDto |
false |
none |
MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making. |
|
»» upcomingMaintenanceDate |
string(date) |
false |
none |
Date of the upcoming maintenance |
»» assetCategoryIds |
[integer] |
false |
none |
Array of unique identifiers representing the categories to which the asset belongs, facilitating effective asset classification and management. |
»» assetCategories |
[string] |
false |
none |
Array of asset categories that classify the main assets within the system, facilitating better organization and management of asset data. |
»» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the main asset, facilitating streamlined collaboration and resource allocation. |
»» internalTeamDtos |
false |
none |
An array of MainAssetDTO objects representing the internal teams associated with the asset, facilitating effective resource management and collaboration within the organization. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» displayId |
string |
false |
none |
Unique identifier for the display |
»»» name |
string |
false |
none |
Name of the resource |
string |
false |
none |
Email address of the internal team member, used for communication and notifications within the organization. |
|
»»» phone |
string |
false |
none |
Contact number for the internal team, facilitating communication and collaboration within the organization. |
»»» manager |
string |
false |
none |
Represents the name or identifier of the team manager responsible for overseeing the internal team. |
»»» requestCategoryName |
[string] |
false |
none |
Name of the request category |
»»» requestCategoryId |
[integer] |
false |
none |
Unique identifier for the request category |
»»» requestCategoryDisplayId |
[string] |
false |
none |
Unique identifier for the request category display |
»»» description |
string |
false |
none |
Description of the resource |
»»» internalTeamUser |
[integer] |
false |
none |
An array of InternalTeamDTO objects representing the users within the internal team, facilitating collaboration and resource management. |
»»» members |
integer(int32) |
false |
none |
Represents the total number of members within the internal team, providing insight into team size for resource allocation and management. |
»»» mainAssets |
[integer] |
false |
none |
An array of internal team assets that represent the key resources and capabilities utilized within the organization. |
»»» premiseNames |
[string] |
false |
none |
List of names associated with the premises relevant to the internal team, facilitating efficient identification and management of locations within the organization. |
»»» internalTeamAvailable |
boolean |
false |
none |
Indicates the availability of the internal team for project allocation and resource planning. |
»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the internal team. |
»» internalTeams |
[string] |
false |
none |
An array of internal teams associated with the main asset, facilitating collaboration and resource allocation within the organization. |
»» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers representing users assigned to the main asset, facilitating effective resource management and accountability. |
»» assignedUserDtos |
false |
none |
Array of user assignments associated with the main asset, providing insights into resource allocation and accountability. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» userName |
string |
false |
none |
Name of the user |
»»» firstName |
string |
false |
none |
Name of the first |
»»» lastName |
string |
false |
none |
Name of the last |
string |
false |
none |
Email address of the user, used for communication and account verification purposes within the system. |
|
»»» roleIds |
false |
none |
Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system. |
|
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»»» modifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»»»» roleName |
string |
false |
none |
Name of the role |
»»»» entity |
string |
false |
none |
Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management. |
»»»» new |
boolean |
false |
none |
Indicates whether the role is newly created within the system, facilitating effective management of organizational changes. |
»»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization. |
»»» internalTeamIds |
[integer] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization. |
»»» internalTeamDisplayIds |
[string] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration. |
»»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations. |
»»» premiseNames |
[string] |
false |
none |
List of names associated with the user’s premises, providing essential context for location-based services and operations. |
»»» userAvailable |
boolean |
false |
none |
Indicates whether the user is available for assignment or engagement within the system. |
»»» temporaryWorkload |
integer(int32) |
false |
none |
Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning. |
»»» preferredCultureCode |
string |
false |
none |
Code for the preferred culture |
»» assignedUsers |
[string] |
false |
none |
List of users assigned to the main asset, facilitating effective resource management and collaboration within the organization. |
»» assetPriority |
string |
false |
none |
Priority of the asset |
»» assetPriorityId |
integer(int64) |
false |
none |
Unique identifier for the asset priority |
»» assetPriorityDisplayId |
string |
false |
none |
Unique identifier for the asset priority display |
»» assetPriorityType |
string |
false |
none |
Type of the asset priority |
»» assetAvailable |
boolean |
false |
none |
Indicates whether the asset is currently available for allocation or use within the system. |
»» exactPlacement |
string |
false |
none |
Specifies the precise location or context in which the main asset is intended to be utilized within the business framework. |
»» fosId |
integer(int64) |
false |
none |
Unique identifier for the fos |
»» downtimeStatus |
string |
false |
none |
Status of the downtime |
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the asset is sourced from the National Resource Management (NRM) framework, facilitating compliance and resource tracking. |
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» mainAssetDisplayId |
string |
false |
none |
Unique identifier for the main asset display |
» inspectionCategoryIds |
[integer] |
false |
none |
Array of unique identifiers representing the categories of inspections associated with the inspection record. |
» inspectionCategories |
[string] |
false |
none |
An array of inspection categories that classify the types of inspections conducted, facilitating organized tracking and reporting. |
» inspectionCategoryId |
integer(int64) |
false |
none |
Unique identifier for the inspection category |
» inspectionCategory |
string |
false |
none |
Category of the inspection |
» inspectionConditionId |
integer(int64) |
false |
none |
Unique identifier for the inspection condition |
» inspectionCondition |
string |
false |
none |
Describes the current condition of the inspection, providing essential context for assessment and decision-making. |
» inspectionConditionType |
string |
false |
none |
Type of the inspection condition |
» inspectionStatusId |
integer(int64) |
false |
none |
Unique identifier for the inspection status |
» inspectionStatus |
string |
false |
none |
Status of the inspection |
» inspectionStatusType |
string |
false |
none |
Type of the inspection status |
» inspectionItemIds |
[integer] |
false |
none |
Array of unique identifiers for inspection items associated with the inspection process, facilitating efficient tracking and management. |
» internalTeamIds |
[integer] |
false |
none |
Array of unique identifiers representing the internal teams associated with the inspection, facilitating streamlined collaboration and accountability within the organization. |
» internalTeamDtos |
false |
none |
An array of InspectionDTO objects representing the internal teams involved in the inspection process, facilitating effective collaboration and resource allocation. |
|
» internalTeams |
[string] |
false |
none |
Array of internal teams associated with the inspection, facilitating collaboration and accountability within the inspection process. |
» assignedUserIds |
[integer] |
false |
none |
Array of unique identifiers for users assigned to the inspection, facilitating effective tracking and management of responsibilities. |
» assignedUserDtos |
false |
none |
Array of InspectionDTO objects representing the users assigned to conduct inspections, facilitating effective resource allocation and management. |
|
» assignedUsers |
[string] |
false |
none |
List of users assigned to the inspection, facilitating effective task management and accountability within the inspection process. |
» activity |
string |
false |
none |
Describes the specific activity associated with the inspection, providing essential context for tracking and reporting purposes. |
» createdByTrigger |
boolean |
false |
none |
Indicates whether the inspection was initiated by an automated trigger within the system. |
» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
Get All Active Status Type IDs¶
HTTP Request
GET /api/inspections/allActiveStatusTypes
📋 Description: Retrieves a comprehensive list of all active status types for inspections, enabling users to effectively manage and track inspection processes.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]
Response Schema
Get All Active Condition Type IDs¶
HTTP Request
GET /api/inspections/allActiveConditionTypes
📋 Description: Retrieves a comprehensive list of all active condition types for inspections, enabling users to access current criteria for evaluation and compliance purposes.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]