Worker Incident

Get All Worker Incidents By Work Order ID

HTTP Request

GET /api/workerIncidents/workOrder/{id}

📋 Description: Retrieves detailed information about a specific worker incident associated with the provided work order ID, enabling effective incident management and resolution tracking.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

  1[
  2  {
  3    "id": 0,
  4    "createdBy": "string",
  5    "createdAt": "2019-08-24T14:15:22Z",
  6    "displayId": "string",
  7    "title": "string",
  8    "description": "string",
  9    "reportDate": "2019-08-24",
 10    "statusName": "string",
 11    "workOrder": {
 12      "id": 0,
 13      "createdBy": "string",
 14      "createdAt": "2019-08-24T14:15:22Z",
 15      "displayId": "string",
 16      "name": "string",
 17      "imageId": 0,
 18      "description": "string",
 19      "vendorRating": 0,
 20      "premiseId": 0,
 21      "premiseDto": {
 22        "id": 0,
 23        "createdBy": "string",
 24        "createdAt": "2019-08-24T14:15:22Z",
 25        "displayId": "string",
 26        "premiseName": "string",
 27        "description": "string",
 28        "address": "string",
 29        "internalTeamNames": [
 30          "string"
 31        ],
 32        "internalTeamIds": [
 33          0
 34        ],
 35        "premiseAvailable": true,
 36        "premiseFromNrm": true,
 37        "nlmId": 0,
 38        "nlmDisplayId": "string",
 39        "nlmUsed": true,
 40        "manager": 0,
 41        "managerName": "string",
 42        "imageId": 0,
 43        "area": "string",
 44        "modifiedAt": "2019-08-24T14:15:22Z"
 45      },
 46      "premiseFromNrm": true,
 47      "premiseDisplayId": "string",
 48      "nssProjectId": 0,
 49      "nssTaskId": 0,
 50      "nssTaskDisplayId": "string",
 51      "orderDate": "2019-08-24",
 52      "dueDate": "2019-08-24",
 53      "startDate": "2019-08-24",
 54      "endDate": "2019-08-24",
 55      "startTime": {
 56        "hour": 0,
 57        "minute": 0,
 58        "second": 0,
 59        "nano": 0
 60      },
 61      "endTime": {
 62        "hour": 0,
 63        "minute": 0,
 64        "second": 0,
 65        "nano": 0
 66      },
 67      "modifiedAt": "2019-08-24T14:15:22Z",
 68      "estimatedCost": "81.08",
 69      "finalCost": "81.08",
 70      "duration": 0,
 71      "estimatedDayTime": 0,
 72      "finalHourTime": "2.5",
 73      "estimatedHourTime": "2.5",
 74      "closeDate": "2019-08-24",
 75      "inspection": "string",
 76      "workOrderTypeId": 0,
 77      "workOrderTypeName": "string",
 78      "workOrderType": "string",
 79      "workOrderPriorityId": 0,
 80      "workOrderPriority": "string",
 81      "workOrderPriorityType": "string",
 82      "isTemplate": true,
 83      "isWorkOrderTemplate": true,
 84      "templateId": 0,
 85      "isPartsInSufficient": true,
 86      "partQuantityInfoList": [
 87        {
 88          "partId": 0,
 89          "partDisplayId": "string",
 90          "requestedQuantity": 0,
 91          "availableQuantity": 0,
 92          "usedQuantity": 0,
 93          "sufficient": true,
 94          "partial": true
 95        }
 96      ],
 97      "parentWorkOrderId": 0,
 98      "parentWorkOrderDisplayId": "string",
 99      "parentWorkOrder": "string",
100      "mainAssetIds": [
101        0
102      ],
103      "mainAssetDto": {
104        "id": 0,
105        "createdBy": "string",
106        "createdAt": "2019-08-24T14:15:22Z",
107        "displayId": "string",
108        "name": "string",
109        "description": "string",
110        "qrCode": "string",
111        "barCode": "string",
112        "imageId": 0,
113        "model": "string",
114        "manufacturer": "string",
115        "serialNumber": "string",
116        "cost": "81.08",
117        "premiseId": 0,
118        "premiseDisplayId": "string",
119        "premiseDto": {
120          "id": 0,
121          "createdBy": "string",
122          "createdAt": "2019-08-24T14:15:22Z",
123          "displayId": "string",
124          "premiseName": "string",
125          "description": "string",
126          "address": "string",
127          "internalTeamNames": [
128            "string"
129          ],
130          "internalTeamIds": [
131            0
132          ],
133          "premiseAvailable": true,
134          "premiseFromNrm": true,
135          "nlmId": 0,
136          "nlmDisplayId": "string",
137          "nlmUsed": true,
138          "manager": 0,
139          "managerName": "string",
140          "imageId": 0,
141          "area": "string",
142          "modifiedAt": "2019-08-24T14:15:22Z"
143        },
144        "acquisitionDate": "2019-08-24",
145        "endOfLife": "2019-08-24",
146        "assetStatusId": 0,
147        "assetStatus": "string",
148        "assetStatusType": "string",
149        "parentAssetId": 0,
150        "parentAssetDisplayId": "string",
151        "parentAsset": "string",
152        "parentAssetDto": {},
153        "upcomingMaintenanceDate": "2019-08-24",
154        "assetCategoryIds": [
155          0
156        ],
157        "assetCategories": [
158          "string"
159        ],
160        "internalTeamIds": [
161          0
162        ],
163        "internalTeamDtos": [
164          {
165            "id": 0,
166            "createdBy": "string",
167            "createdAt": "2019-08-24T14:15:22Z",
168            "displayId": "string",
169            "name": "string",
170            "email": "string",
171            "phone": "string",
172            "manager": "string",
173            "requestCategoryName": [
174              "string"
175            ],
176            "requestCategoryId": [
177              0
178            ],
179            "requestCategoryDisplayId": [
180              "string"
181            ],
182            "description": "string",
183            "internalTeamUser": [
184              0
185            ],
186            "members": 0,
187            "mainAssets": [
188              0
189            ],
190            "premiseNames": [
191              "string"
192            ],
193            "internalTeamAvailable": true,
194            "premiseIds": [
195              0
196            ]
197          }
198        ],
199        "internalTeams": [
200          "string"
201        ],
202        "assignedUserIds": [
203          0
204        ],
205        "assignedUserDtos": [
206          {
207            "id": 0,
208            "createdBy": "string",
209            "createdAt": "2019-08-24T14:15:22Z",
210            "userName": "string",
211            "firstName": "string",
212            "lastName": "string",
213            "email": "string",
214            "roleIds": [
215              0
216            ],
217            "internalTeamNames": [
218              "string"
219            ],
220            "internalTeamIds": [
221              0
222            ],
223            "internalTeamDisplayIds": [
224              "string"
225            ],
226            "premiseIds": [
227              0
228            ],
229            "premiseNames": [
230              "string"
231            ],
232            "userAvailable": true,
233            "temporaryWorkload": 0,
234            "preferredCultureCode": "string"
235          }
236        ],
237        "assignedUsers": [
238          "string"
239        ],
240        "assetPriority": "string",
241        "assetPriorityId": 0,
242        "assetPriorityDisplayId": "string",
243        "assetPriorityType": "string",
244        "assetAvailable": true,
245        "exactPlacement": "string",
246        "fosId": 0,
247        "downtimeStatus": "string",
248        "premiseFromNrm": true,
249        "modifiedAt": "2019-08-24T14:15:22Z"
250      },
251      "mainAssetDisplayId": "string",
252      "workOrderStatusId": 0,
253      "workOrderStatus": "string",
254      "workOrderStatusType": "string",
255      "requestIds": [
256        0
257      ],
258      "internalTeamIds": [
259        0
260      ],
261      "internalTeamDtos": [
262        {
263          "id": 0,
264          "createdBy": "string",
265          "createdAt": "2019-08-24T14:15:22Z",
266          "displayId": "string",
267          "name": "string",
268          "email": "string",
269          "phone": "string",
270          "manager": "string",
271          "requestCategoryName": [
272            "string"
273          ],
274          "requestCategoryId": [
275            0
276          ],
277          "requestCategoryDisplayId": [
278            "string"
279          ],
280          "description": "string",
281          "internalTeamUser": [
282            0
283          ],
284          "members": 0,
285          "mainAssets": [
286            0
287          ],
288          "premiseNames": [
289            "string"
290          ],
291          "internalTeamAvailable": true,
292          "premiseIds": [
293            0
294          ]
295        }
296      ],
297      "internalTeams": [
298        "string"
299      ],
300      "vendorId": 0,
301      "vendorDto": {
302        "id": 0,
303        "createdBy": "string",
304        "createdAt": "2019-08-24T14:15:22Z",
305        "displayId": "string",
306        "name": "string",
307        "description": "string",
308        "address": "string",
309        "contractEndDate": "2019-08-24",
310        "services": "string",
311        "vendorType": "string",
312        "vendorStatusId": 0,
313        "vendorStatus": "string",
314        "vendorStatusType": "string",
315        "businessTypeId": 0,
316        "businessType": "string",
317        "vendorRateId": 0,
318        "vendorRate": "string",
319        "vendorContactIds": [
320          0
321        ],
322        "premiseIds": [
323          0
324        ],
325        "firstPremiseDisplayId": "string",
326        "ownerUserName": "string",
327        "ownerDto": {
328          "id": 0,
329          "createdBy": "string",
330          "createdAt": "2019-08-24T14:15:22Z",
331          "userName": "string",
332          "firstName": "string",
333          "lastName": "string",
334          "email": "string",
335          "roleIds": [
336            0
337          ],
338          "internalTeamNames": [
339            "string"
340          ],
341          "internalTeamIds": [
342            0
343          ],
344          "internalTeamDisplayIds": [
345            "string"
346          ],
347          "premiseIds": [
348            0
349          ],
350          "premiseNames": [
351            "string"
352          ],
353          "userAvailable": true,
354          "temporaryWorkload": 0,
355          "preferredCultureCode": "string"
356        },
357        "vendorAvailable": true,
358        "vendorRating": 0.1,
359        "premiseDisplayIds": [
360          "string"
361        ]
362      },
363      "vendorName": "string",
364      "workOrderTemplateSettings": {
365        "id": 0,
366        "createdBy": "string",
367        "createdAt": "2019-08-24T14:15:22Z",
368        "workOrderId": 0,
369        "startDate": "2019-08-24",
370        "dueDuration": 0,
371        "dueMonths": 0,
372        "endDate": "2019-08-24",
373        "recurringWOPriorityId": 0,
374        "recurringWOPriority": "string",
375        "recurringWOPriorityType": "string",
376        "isTemplate": true,
377        "isRemoveByDate": true,
378        "triggerByWorkOrderStatusId": 0,
379        "triggerByWorkOrderStatus": "string",
380        "triggerByWorkOrderStatusType": "string",
381        "removeByWorkOrderStatusId": 0,
382        "removeByWorkOrderStatus": "string",
383        "removeByWorkOrderStatusType": "string"
384      },
385      "assignedUserIds": [
386        0
387      ],
388      "assignedUserDtos": [
389        {
390          "id": 0,
391          "createdBy": "string",
392          "createdAt": "2019-08-24T14:15:22Z",
393          "userName": "string",
394          "firstName": "string",
395          "lastName": "string",
396          "email": "string",
397          "roleIds": [
398            0
399          ],
400          "internalTeamNames": [
401            "string"
402          ],
403          "internalTeamIds": [
404            0
405          ],
406          "internalTeamDisplayIds": [
407            "string"
408          ],
409          "premiseIds": [
410            0
411          ],
412          "premiseNames": [
413            "string"
414          ],
415          "userAvailable": true,
416          "temporaryWorkload": 0,
417          "preferredCultureCode": "string"
418        }
419      ],
420      "assignedUsers": [
421        "string"
422      ],
423      "variableQuantity": 0,
424      "workOrderAvailable": true,
425      "exactPlacement": "string",
426      "primaryWorkOrderId": 0,
427      "primaryWorkOrderDto": {},
428      "primaryWorkOrderDisplayId": "string",
429      "isPrimary": true,
430      "invoiceIds": [
431        0
432      ],
433      "createdByTrigger": true,
434      "internalCosts": "81.08",
435      "invoiceTotal": "81.08",
436      "partsTotal": "81.08",
437      "inspectionItemId": 0,
438      "partIdToAttach": 0
439    },
440    "workOrderDisplayId": "string",
441    "reporterDto": {
442      "id": 0,
443      "createdBy": "string",
444      "createdAt": "2019-08-24T14:15:22Z",
445      "userName": "string",
446      "firstName": "string",
447      "lastName": "string",
448      "email": "string",
449      "roleIds": [
450        0
451      ],
452      "internalTeamNames": [
453        "string"
454      ],
455      "internalTeamIds": [
456        0
457      ],
458      "internalTeamDisplayIds": [
459        "string"
460      ],
461      "premiseIds": [
462        0
463      ],
464      "premiseNames": [
465        "string"
466      ],
467      "userAvailable": true,
468      "temporaryWorkload": 0,
469      "preferredCultureCode": "string"
470    },
471    "username": "string",
472    "injuredPersonName": "string",
473    "exactLocation": "string",
474    "injuredPersonRole": "string",
475    "incidentTime": {
476      "hour": 0,
477      "minute": 0,
478      "second": 0,
479      "nano": 0
480    },
481    "injuryTypeAndBodyPartAffected": "string",
482    "severity": "string",
483    "premiseId": 0,
484    "premisesDisplayId": "string",
485    "premisesDto": {
486      "id": 0,
487      "createdBy": "string",
488      "createdAt": "2019-08-24T14:15:22Z",
489      "displayId": "string",
490      "premiseName": "string",
491      "description": "string",
492      "address": "string",
493      "internalTeamNames": [
494        "string"
495      ],
496      "internalTeamIds": [
497        0
498      ],
499      "premiseAvailable": true,
500      "premiseFromNrm": true,
501      "nlmId": 0,
502      "nlmDisplayId": "string",
503      "nlmUsed": true,
504      "manager": 0,
505      "managerName": "string",
506      "imageId": 0,
507      "area": "string",
508      "modifiedAt": "2019-08-24T14:15:22Z"
509    },
510    "workerIncidentAvailable": true,
511    "modifiedAt": "2019-08-24T14:15:22Z",
512    "statusId": 0
513  }
514]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[WorkerIncidentDTO]

false

none

[Data transfer object representing an incident involving a worker, including relevant details such as incident type, date, and associated metadata, to facilitate effective incident management and reporting 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

» title

string

false

none

Title of the resource

» description

string

false

none

Description of the resource

» reportDate

string(date)

false

none

Date of the report

» statusName

string

false

none

Name of the status

» workOrder

WorkOrderDTO

false

none

Data transfer object representing a work order, encapsulating essential details such as task specifications, status, and associated resources to facilitate efficient project management and operational workflows.

»» 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

PremiseDTO

false

none

Data transfer object representing a premise, encapsulating essential details such as location, type, and operational status, to facilitate effective decision-making in property management and strategic 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 logistical and operational purposes.

»»» internalTeamNames

[string]

false

none

List of names representing the internal teams associated with the premise, facilitating effective collaboration and resource allocation.

»»» internalTeamIds

[integer]

false

none

List of unique identifiers for 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 business 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 initiatives.

»»» 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 Library of Medicine (NLM) resources have been utilized in the premise.

»»» 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 geographical 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 sourced from the National Resource Management system, facilitating integration with external resource planning tools.

»» 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

LocalTime

false

none

Data transfer object representing the local time settings relevant to business operations, ensuring accurate time management and scheduling across different time zones.

»»» 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 second 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, enabling precise time tracking for scheduling and reporting purposes.

»» endTime

LocalTime

false

none

Data transfer object representing the local time settings relevant to business operations, ensuring accurate time management and scheduling across different time zones.

»» modifiedAt

string(date-time)

false

none

Timestamp when this resource was last modified

»» estimatedCost

string

false

none

Estimated cost of the work order, providing a financial projection to assist in budget planning and resource allocation.

»» finalCost

string

false

none

The finalCost field represents the total cost associated with the completion of the work order, providing essential financial insight 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, facilitating effective resource planning and scheduling.

»» 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

Details the specific inspection requirements associated with the work order, ensuring compliance and quality standards are met.

»» 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

[PartQuantityInfoDTO]

false

none

List of quantities associated with each part required for the work order, facilitating accurate 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 items is a partial amount, providing essential information for inventory management and order fulfillment processes.

»» 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 associated with the current work order, facilitating hierarchical organization and tracking of related tasks.

»» mainAssetIds

[integer]

false

none

List of unique identifiers for the primary assets associated with the work order, facilitating effective asset management and tracking.

»» mainAssetDto

MainAssetDTO

false

none

Data transfer object representing a primary asset within the enterprise, encompassing essential attributes and metadata necessary for 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 management and decision-making.

»»» manufacturer

string

false

none

Name of the manufacturer responsible for producing the asset, essential for tracking and managing supplier relationships.

»»» serialNumber

string

false

none

Unique identifier for the asset, facilitating tracking and management within the inventory 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

PremiseDTO

false

none

Data transfer object representing a premise, encapsulating essential details such as location, type, and operational status, to facilitate effective decision-making in property management and strategic 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 asset management and organization.

»»» parentAssetDto

MainAssetDTO

false

none

Data transfer object representing a primary asset within the enterprise, encompassing essential attributes and metadata necessary for effective asset management and decision-making.

»»» upcomingMaintenanceDate

string(date)

false

none

Date of the upcoming maintenance

»»» assetCategoryIds

[integer]

false

none

List of unique identifiers representing the categories to which the asset belongs, facilitating effective asset management and reporting.

»»» assetCategories

[string]

false

none

Array of asset categories that categorizes the main assets for effective management and reporting.

»»» internalTeamIds

[integer]

false

none

List of unique identifiers for the internal teams associated with the main asset, facilitating streamlined collaboration and resource allocation.

»»» internalTeamDtos

[InternalTeamDTO]

false

none

An array of MainAssetDTO objects representing the internal teams associated with the asset, facilitating effective resource allocation and management.

»»»» 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

»»»» email

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 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

Array of internal team user details, represented by InternalTeamDTO, facilitating collaboration and resource management within the organization.

»»»» members

integer(int32)

false

none

Represents the total number of members within the internal team, facilitating effective resource allocation and team management.

»»»» mainAssets

[integer]

false

none

List of primary assets associated with the internal team, providing essential insights for resource allocation and project management.

»»»» premiseNames

[string]

false

none

List of names associated with the premises relevant to the internal team, facilitating effective identification and management of locations within the organization.

»»»» internalTeamAvailable

boolean

false

none

Indicates whether the internal team is available to support the request, facilitating efficient resource allocation and project management.

»»»» premiseIds

[integer]

false

none

Array of unique identifiers representing the premises associated with the internal team.

»»» internalTeams

[string]

false

none

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 for users assigned to the main asset, facilitating effective resource management and accountability.

»»» assignedUserDtos

[UserDTO]

false

none

Array of assigned user data transfer objects (DTOs) representing the users allocated to the main asset, facilitating effective resource management 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

»»»» email

string

false

none

Email address of the user, used for communication and account verification purposes within the system.

»»»» roleIds

[integer]

false

none

An array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system.

»»»» 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

Array of unique identifiers representing the internal teams associated with the user, facilitating streamlined collaboration and resource allocation within the organization.

»»»» internalTeamDisplayIds

[string]

false

none

Array of unique identifiers representing the display IDs of internal teams associated with the user.

»»»» premiseIds

[integer]

false

none

Array of unique identifiers representing the premises associated with the user, facilitating efficient management and retrieval of location-specific data.

»»»» premiseNames

[string]

false

none

List of names associated with the user’s premises, facilitating identification and management of multiple locations within the system.

»»»» 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 a 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 originates from the National Resource Management (NRM) framework, facilitating compliance and reporting within environmental management processes.

»»» 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, enabling efficient tracking and management of related requests within the system.

»» internalTeamIds

[integer]

false

none

List of unique identifiers for the internal teams associated with the work order, facilitating effective resource allocation and collaboration.

»» internalTeamDtos

[InternalTeamDTO]

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

Array 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

VendorDTO

false

none

Data transfer object representing a vendor, encapsulating essential information such as vendor identification, contact details, and service offerings to facilitate effective vendor management and procurement processes.

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» createdBy

string

false

none

Username of who created this resource

»»» createdAt

string(date-time)

false

none

Timestamp when this resource was created

»»» 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 logistics and communication purposes.

»»» contractEndDate

string(date)

false

none

Date of the contract end

»»» services

string

false

none

Represents the services offered by the vendor, providing essential information for evaluating vendor capabilities and aligning 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 effective management and tracking of vendor-related locations.

»»» firstPremiseDisplayId

string

false

none

Unique identifier for the first premise display

»»» ownerUserName

string

false

none

Name of the owner user

»»» ownerDto

UserDTO

false

none

Data transfer object representing a user profile, encapsulating essential information such as user identification, contact details, and role within the organization, facilitating seamless user management and interaction within the enterprise system.

»»» vendorAvailable

boolean

false

none

Indicates whether the vendor is currently available for new engagements within the system.

»»» vendorRating

number(double)

false

none

Represents the numerical rating assigned to a vendor, reflecting their performance and reliability in business engagements.

»»» premiseDisplayIds

[string]

false

none

Array of unique identifiers representing the display premises associated with the vendor, facilitating streamlined management and retrieval of vendor-related information.

»» vendorName

string

false

none

Name of the vendor

»» workOrderTemplateSettings

WorkOrderTemplateSettingsDTO

false

none

Data transfer object representing the configuration settings for work order templates, enabling businesses to standardize and streamline their work order processes for improved operational efficiency.

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» createdBy

string

false

none

Username of who created this resource

»»» createdAt

string(date-time)

false

none

Timestamp when this resource was created

»»» 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 hours, 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

An array of unique identifiers representing the users assigned to the work order, facilitating effective resource allocation and management.

»» assignedUserDtos

[UserDTO]

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 resource allocation and task management.

»» 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 of resources as defined in the work order, facilitating accurate execution and tracking of tasks.

»» primaryWorkOrderId

integer(int64)

false

none

Unique identifier for the primary work order

»» primaryWorkOrderDto

WorkOrderDTO

false

none

Data transfer object representing a work order, encapsulating essential details such as task specifications, status, and associated resources to facilitate efficient project management and operational workflows.

»» 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 streamlined tracking and management of billing processes.

»» createdByTrigger

boolean

false

none

Indicates whether the work order was created automatically by a system trigger.

»» internalCosts

string

false

none

Represents the internal costs associated with the work order, providing essential financial insights for project budgeting and resource allocation.

»» 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.

»» 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

»» recurringWOPriority

string

false

write-only

Priority of the recurring w o

»» recurringWOPriorityType

string

false

write-only

Type of the recurring w o priority

»» triggerByWorkOrderStatus

string

false

write-only

Status of the trigger by work order

»» triggerByWorkOrderStatusType

string

false

write-only

Type of the trigger by work order status

»» removeByWorkOrderStatus

string

false

write-only

Status of the remove by work order

»» removeByWorkOrderStatusType

string

false

write-only

Type of the remove by work order status

»» 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

Indicates the number of months for which the work order is set to recur, facilitating effective scheduling and resource allocation.

»» recurringWOIsTemplate

boolean

false

write-only

Indicates whether the work order is based on a recurring template, facilitating streamlined management of repeat tasks.

»» recurringWOIsRemoveByDate

boolean

false

write-only

Date of the recurring w o is remove by

» workOrderDisplayId

string

false

none

Unique identifier for the work order display

» reporterDto

UserDTO

false

none

Data transfer object representing a user profile, encapsulating essential information such as user identification, contact details, and role within the organization, facilitating seamless user management and interaction within the enterprise system.

» username

string

false

none

Represents the unique username associated with the worker, used for identification and authentication within the incident management system.

» injuredPersonName

string

false

none

Name of the injured person

» exactLocation

string

false

none

Specifies the precise geographic location associated with the worker incident, facilitating accurate reporting and analysis.

» injuredPersonRole

string

false

none

Indicates the role of the individual involved in the incident, providing essential context for incident management and reporting.

» incidentTime

LocalTime

false

none

Data transfer object representing the local time settings relevant to business operations, ensuring accurate time management and scheduling across different time zones.

» injuryTypeAndBodyPartAffected

string

false

none

Describes the specific type of injury and the body part affected, facilitating accurate incident reporting and analysis for workplace safety management.

» severity

string

false

none

Indicates the level of seriousness associated with a worker incident, facilitating prioritization and response actions within the incident management process.

» premiseId

integer(int64)

false

none

Unique identifier for the premise

» premisesDisplayId

string

false

none

Unique identifier for the premises display

» premisesDto

PremiseDTO

false

none

Data transfer object representing a premise, encapsulating essential details such as location, type, and operational status, to facilitate effective decision-making in property management and strategic planning.

» workerIncidentAvailable

boolean

false

none

Indicates whether there are any available incidents reported for the worker, facilitating effective incident management and response.

» modifiedAt

string(date-time)

false

none

Timestamp when this resource was last modified

» statusId

integer(int64)

false

none

Unique identifier for the status