Resource Fields
|
PII |
SI |
Field |
Description |
Format |
|---|---|---|---|---|
|
|
|
id (workOrderId) |
The "id" refers to the identifier of a specific entity within the context of the API. It is automatically generated, does not change, and can only be accessed in read mode. It serves as a search filter to locate data based on a list of values. This field is also named “workOrderId“ when used as path parameter. |
integer |
|
|
|
addressId |
It’s a unique identifier for an address. The |
integer |
|
|
|
typeId |
It’s a unique identifier for a specific work order type. It is used to distinguish between different types of work orders. |
integer |
|
|
|
statusId |
It refers to the status identifier of a specific entity within the context of the API provided. It is used to distinguish between different status of work orders. |
integer |
|
|
|
creationDate |
It refers to the date/time when a work order was created. |
|
|
|
|
code |
Alphanumeric code that uniquely identifies a singular Work Order. This is usually generated by the system and can be obtained by using the appropriate API. |
string |
|
|
|
startDate |
Indicates when the Work Order should begin. |
|
|
|
|
endDate |
Indicates when the Work Order is expected to be completed. It is greater than or equal to the startDate. |
|
|
|
|
operationCenterId |
It’s an identifier for a specific operation center within the context of the API provided. It is used to distinguish between different operation centers. |
integer |
|
|
|
description |
Natural language description of the Work Order. |
string |
|
|
|
releaseDate |
It refers to the date when a work order is released. It is a field used to indicate the specific date and time when a work order is made available for scheduling and execution. |
|
|
|
|
closingDate |
It refers to the date when a work order is closed. |
|
|
|
|
workCycleId |
WorkCycleId is a unique identifier for a specific work cycle. Work cycle refers to the sequential process of activities involved in managing field operations. |
integer |
|
|
|
externalCode |
It’s an alphanumeric code that identifies a singular work order in an external system. |
string |
|
|
|
originId |
It’s a unique identifier for the origin of a specific work order within the context of the API provided. It is used to distinguish between different origins of work orders (e.g, via API, event based, manually created, etc). |
integer |
|
|
|
externalSystemId |
It’s a unique identifier for a specific external system within the context of the API provided. It is used to distinguish between different external systems. |
integer |
|
|
|
operationsAssignment |
It’s a field that indicates whether work order operations can be scheduled separately. If it’s set to AGGREGATE means that work order operations cannot be scheduled separately. If it’s set to DISTINCT means that work order operations can be scheduled separately. |
enum: [AGGREGATED, DISTINCT] |
|
|
|
aggregatedDuration |
It’s a parameter used in the context of work orders. It refers to the duration of a work order when |
integer |
|
|
|
aggregatedCardinalityId |
It's a parameter that indicates the cardinality of work order operations when |
integer |
|
|
|
aggregatedResidualDuration |
It’s a parameter used in the context of work orders. It refers to the residual duration of a work order when |
integer |
|
|
|
notes |
It’s refers to additional information or comments related to the work order. |
string |
|
|
|
urgencyId |
It’s a unique identifier for a specific urgency type within the context of the API provided. It is used to distinguish between different urgency levels for work orders. |
integer |
|
|
|
workCenterId |
It’s a unique identifier that allows the system to distinguish between different work centers |
integer |
|
|
|
appointmentStartDate |
These dates are not related to the booking process but usually are related to the assets and are used to define the start of the maintenance period. |
|
|
|
|
appointmentEndDate |
These dates are not related to the booking process but usually are related to the assets and are used to define the end of the maintenance period. |
|
|
|
|
skipResourceOutcomeChecks |
If enabled, the application skips all checks on user accountings when a Work Order gets closed |
boolean |
|
|
|
lastOutcomeReasonId |
WO last outcome reason |
|
|
|
|
lastOutcomeUserId |
WO ID last outcome user |
|
|
|
|
lastOutcomeOriginId |
last WO outcome origin |
|
|
|
|
lastOutcomeDate |
WO last outcome date |
|
|
|
|
parentWorkOrderId |
WO Parent Work Order Id |
Integer |