WorkOrderDTO

📄 Description: 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.

Properties

Name

Type

Required

Restrictions

Description

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 the details of the work order’s premise, facilitating effective management and tracking of associated tasks.

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

Time of the start

endTime

LocalTime

false

none

Time of the end

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.

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

Represents the primary asset associated with the work order, facilitating effective resource management and operational efficiency.

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 the vendor associated with the work order, facilitating streamlined management of vendor-related information.

vendorName

string

false

none

Name of the vendor

workOrderTemplateSettings

WorkOrderTemplateSettingsDTO

false

none

Configuration settings for the work order template, enabling customization and standardization of work orders to enhance operational efficiency.

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

Represents the primary work order associated with the current operation, facilitating efficient tracking and management of tasks within the 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 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