Class WorkOrderService

Service for working with Maximo Work Orders Extends the base ResourceService with work order-specific operations

Hierarchy (View Summary)

ResourceService<WorkOrder>
- WorkOrderService

Index

Properties

`Protected`apiBase

apiBase: string

API base path (e.g., '/maximo/api')

`Protected`logger

logger: ILogger

`Protected`httpClient

httpClient: HttpClient

The HTTP client for making requests

`Protected`apiHome

apiHome: string

API home path (e.g., '/maximo/api/os')

`Optional`uniqueColumn

uniqueColumn?: string

Unique column name for the object (e.g., 'autoscriptid', 'workorderid')

`Optional`appName

appName?: string

Maximo App Name for generating Web URLs (e.g., 'autoscript', 'wotrack')

`Protected`objectStructure

objectStructure: string

The Maximo object structure name (e.g., 'mxapiasset')

Methods

setLogger

setLogger(logger: ILogger): this
Overrides the logger used by this service instance.
Parameters
- logger: ILogger
Returns this
Inherited from ResourceService.setLogger

getLogger

getLogger(): ILogger
Returns the current logger used by this service instance.

Returns ILogger
Inherited from ResourceService.getLogger

`Protected`formatProperties

formatProperties(properties?: string | string[]): string | undefined
Parameters
- Optionalproperties: string | string[]
Returns string | undefined
Inherited from ResourceService.formatProperties

`Protected`handleError

handleError(error: any): never
Error handler
Parameters
- error: any
  the error to process
Returns never
Inherited from ResourceService.handleError

getUniqueColumnName

getUniqueColumnName(): string | undefined
Gets the unique column name for this resource.

Returns string | undefined
Inherited from ResourceService.getUniqueColumnName

getUniqueColumnId

getUniqueColumnId(resource: WorkOrder): string | number | undefined
Gets the unique column ID value from a resource object.
Parameters
- resource: WorkOrder
  The resource object.
Returns string | number | undefined
Inherited from ResourceService.getUniqueColumnId

getWebUrl

getWebUrl(
    uniqueIdValue: string | number,
    appNameOverride?: string,
    changeTab?: string,
): string
Generates a Maximo UI URL for a record.
Parameters
- uniqueIdValue: string | number
  The specific internal ID of the record.
- OptionalappNameOverride: string
  Optional. Provide or override the Maximo App Name.
- OptionalchangeTab: string
  Optional. Tab id to switch to within the app, e.g. 'relationships'.
Returns string
Inherited from ResourceService.getWebUrl

executeResourceCreate

executeResourceCreate(
createBuilder: ResourceCreate<WorkOrder>,
): Promise<WorkOrder>
Internal
Executes a ResourceCreate request. This is called internally by ResourceCreate.execute().
Parameters
- createBuilder: ResourceCreate<WorkOrder>
  The ResourceCreate builder to execute
Returns Promise<WorkOrder>
A promise resolving to the created resource

Inherited from ResourceService.executeResourceCreate

executeResourceUpdate

executeResourceUpdate(
updateBuilder: ResourceUpdate<WorkOrder>,
): Promise<ResourceUpdateResponse<WorkOrder>>
Internal
Executes a ResourceUpdate request. This is called internally by ResourceUpdate.execute().
Parameters
- updateBuilder: ResourceUpdate<WorkOrder>
  The ResourceUpdate builder to execute
Returns Promise<ResourceUpdateResponse<WorkOrder>>
A promise resolving to a response object with success status

Inherited from ResourceService.executeResourceUpdate

executeResourceDelete

executeResourceDelete(deleteBuilder: ResourceDelete<WorkOrder>): Promise<void>
Internal
Executes a ResourceDelete request. This is called internally by ResourceDelete.execute().
Parameters
- deleteBuilder: ResourceDelete<WorkOrder>
  The ResourceDelete builder to execute
Returns Promise<void>
A promise that resolves when the resource is deleted

Inherited from ResourceService.executeResourceDelete

executeResourceFetch

executeResourceFetch(fetchBuilder: ResourceFetch<WorkOrder>): Promise<WorkOrder>
Internal
Executes a ResourceFetch request. This is called internally by ResourceFetch.execute().
Parameters
- fetchBuilder: ResourceFetch<WorkOrder>
  The ResourceFetch builder to execute
Returns Promise<WorkOrder>
A promise resolving to the resource

Inherited from ResourceService.executeResourceFetch

webMethod

webMethod(
    id: string,
    methodName: string,
    payload?: any,
    returnProperties?: string | string[],
): Promise<ResourceUpdateResponse<WorkOrder>>
Executes a WebMethod action on a specific resource
Parameters
- id: string
- methodName: string
- Optionalpayload: any
- OptionalreturnProperties: string | string[]
Returns Promise<ResourceUpdateResponse<WorkOrder>>
Inherited from ResourceService.webMethod

workflow

workflow(
    id: string,
    workflowName: string,
    payload?: any,
    returnProperties?: string | string[],
): Promise<ResourceUpdateResponse<WorkOrder>>
Executes a workflow action on a specific resource
Parameters
- id: string
- workflowName: string
- Optionalpayload: any
- OptionalreturnProperties: string | string[]
Returns Promise<ResourceUpdateResponse<WorkOrder>>
Inherited from ResourceService.workflow

createWorkOrder

createWorkOrder(
    description: string,
    siteId: string,
    workType?: string,
    priority?: number,
    properties?: string,
): Promise<WorkOrder>
Creates a new work order
Parameters
- description: string
  The work order description
- siteId: string
  The site ID
- OptionalworkType: string
  Optional work type
- Optionalpriority: number
  Optional priority
- Optionalproperties: string
  Optional properties to return in the response
Returns Promise<WorkOrder>
A promise resolving to the created work order

assignTo

assignTo(
    woId: string,
    personId: string,
    returnProperties?: string | string[],
): Promise<ResourceUpdateResponse<WorkOrder>>
Assigns a work order to a person
Parameters
- woId: string
  The work order ID
- personId: string
  The person ID
- OptionalreturnProperties: string | string[]
  Optional properties to return in the response
Returns Promise<ResourceUpdateResponse<WorkOrder>>
A promise resolving to the update response containing status and optional work order data

changeStatus

changeStatus(
    woId: string,
    status: string,
    memo?: string,
    returnProperties?: string | string[],
): Promise<ResourceUpdateResponse<WorkOrder>>
Changes the status of a work order
Parameters
- woId: string
  The work order ID
- status: string
  The new status
- Optionalmemo: string
  Optional memo for the status change
- OptionalreturnProperties: string | string[]
  Optional properties to return in the response
Returns Promise<ResourceUpdateResponse<WorkOrder>>
A promise resolving to the update response containing status and optional work order data

updateCosts

updateCosts(
    woId: string,
    estCost: number,
    actCost?: number,
    returnProperties?: string | string[],
): Promise<ResourceUpdateResponse<WorkOrder>>
Updates the estimated and actual costs for a work order
Parameters
- woId: string
  The work order ID
- estCost: number
  The estimated cost
- OptionalactCost: number
  The actual cost
- OptionalreturnProperties: string | string[]
  Optional properties to return in the response
Returns Promise<ResourceUpdateResponse<WorkOrder>>
A promise resolving to the update response containing status and optional work order data

updateHours

updateHours(
    woId: string,
    estHours: number,
    actHours?: number,
    returnProperties?: string | string[],
): Promise<ResourceUpdateResponse<WorkOrder>>
Updates the estimated and actual hours for a work order
Parameters
- woId: string
  The work order ID
- estHours: number
  The estimated hours
- OptionalactHours: number
  The actual hours
- OptionalreturnProperties: string | string[]
  Optional properties to return in the response
Returns Promise<ResourceUpdateResponse<WorkOrder>>
A promise resolving to the update response containing status and optional work order data

findByAsset

findByAsset(assetId: string): Promise<WorkOrder[]>
Finds work orders by asset
Parameters
- assetId: string
  The asset ID
Returns Promise<WorkOrder[]>
A promise resolving to an array of work orders

findByLocation

findByLocation(locationId: string): Promise<WorkOrder[]>
Finds work orders by location
Parameters
- locationId: string
  The location ID
Returns Promise<WorkOrder[]>
A promise resolving to an array of work orders

findByStatus

findByStatus(status: string): Promise<WorkOrder[]>
Finds work orders by status
Parameters
- status: string
  The status
Returns Promise<WorkOrder[]>
A promise resolving to an array of work orders

findByWorkType

findByWorkType(workType: string): Promise<WorkOrder[]>
Finds work orders by work type
Parameters
- workType: string
  The work type
Returns Promise<WorkOrder[]>
A promise resolving to an array of work orders

findByPriority

findByPriority(priority: number): Promise<WorkOrder[]>
Finds work orders by priority
Parameters
- priority: number
  The priority
Returns Promise<WorkOrder[]>
A promise resolving to an array of work orders

findByAssignee

findByAssignee(personId: string): Promise<WorkOrder[]>
Finds work orders assigned to a person
Parameters
- personId: string
  The person ID
Returns Promise<WorkOrder[]>
A promise resolving to an array of work orders

findByReportedBy

findByReportedBy(personId: string): Promise<WorkOrder[]>
Finds work orders reported by a person
Parameters
- personId: string
  The person ID
Returns Promise<WorkOrder[]>
A promise resolving to an array of work orders

addLaborPlan

addLaborPlan(
    woId: string,
    laborCode: string,
    hours: number,
    returnProperties?: string | string[],
): Promise<ResourceUpdateResponse<WorkOrder>>
Add labor planning to work order
Parameters
- woId: string
  The work order ID
- laborCode: string
  The labor code
- hours: number
  The planned hours
- OptionalreturnProperties: string | string[]
  Optional properties to return in the response
Returns Promise<ResourceUpdateResponse<WorkOrder>>
A promise resolving to the update response containing status and optional work order data

addMaterialPlan

addMaterialPlan(
    woId: string,
    itemNum: string,
    storeRoom: string,
    qty: number,
    returnProperties?: string | string[],
): Promise<ResourceUpdateResponse<WorkOrder>>
Add material planning to work order
Parameters
- woId: string
  The work order ID
- itemNum: string
  The item number
- storeRoom: string
  The storeroom
- qty: number
  The quantity
- OptionalreturnProperties: string | string[]
  Optional properties to return in the response
Returns Promise<ResourceUpdateResponse<WorkOrder>>
A promise resolving to the update response containing status and optional work order data

getWorkOrderFromUpdateResponse

getWorkOrderFromUpdateResponse(
    updateResponse: ResourceUpdateResponse<WorkOrder>,
    woId: string,
    properties?: string | string[],
): Promise<WorkOrder>
Helper method to get the work order data from an update response If the update didn't return data, this fetches the work order by ID
Parameters
- updateResponse: ResourceUpdateResponse<WorkOrder>
  The update response from a previous operation
- woId: string
  The work order ID
- Optionalproperties: string | string[]
  Optional properties to return if fetching is needed
Returns Promise<WorkOrder>
A promise resolving to the work order data

Common Resource Operations

actionOnEndpoint

actionOnEndpoint(
    endpoint: string,
    actionName: string,
    payload?: any,
    returnProperties?: string | string[],
): Promise<ResourceUpdateResponse<any>>
Executes an action on an arbitrary endpoint Useful for service endpoints that don't follow the standard resource/ID pattern Supports both GET and POST methods based on payload presence
Parameters
- endpoint: string
  The endpoint to call the action on (e.g., 'service/logging')
- actionName: string
  The name of the action to execute (e.g., 'wsmethod:streamLog')
- Optionalpayload: any
  Optional payload data for the action (if provided, uses POST, otherwise GET)
- OptionalreturnProperties: string | string[]
  Optional properties to return in the response
Returns Promise<ResourceUpdateResponse<any>>
A promise resolving to a response object containing success status and optional data

Inherited from ResourceService.actionOnEndpoint

updateBuilder

updateBuilder(): UpdateBuilder<WorkOrder>
Returns a fluent builder for update payloads

Returns UpdateBuilder<WorkOrder>
Inherited from ResourceService.updateBuilder

createBuilder

createBuilder(): UpdateBuilder<WorkOrder>
Returns a fluent builder for create payloads (alias for updateBuilder)

Returns UpdateBuilder<WorkOrder>
Inherited from ResourceService.createBuilder

`Protected`primaryKeys

primaryKeys: string[]

Primary key columns for this resource type

setApiHome

setApiHome(apiHome: string): void
Sets the API home path
Parameters
- apiHome: string
  The API home path to use
Returns void
Inherited from ResourceService.setApiHome

`Protected`getPrimaryColumns

getPrimaryColumns(): string[]
Gets the primary columns for this resource type Can be overridden by subclasses to specify their primary key columns

Returns string[]
Array of primary key column names

Inherited from ResourceService.getPrimaryColumns

`Protected`encodeResourceId

encodeResourceId(values: Record<string, string>): string
Encodes resource ID from primary key values Format: {col1}:{value1}|{col2}:{value2}
Parameters
- values: Record<string, string>
  Object containing primary key values
Returns string
Encoded resource ID string

Inherited from ResourceService.encodeResourceId

`Protected`decodeResourceId

decodeResourceId(resourceId: string): Record<string, string>
Decodes resource ID into primary key values
Parameters
- resourceId: string
  Encoded resource ID string
Returns Record<string, string>
Object with primary key values

Inherited from ResourceService.decodeResourceId

createResource

createResource(data: Partial<T>): ResourceCreate<WorkOrder>
Creates a fluent builder for creating a new resource. Provides fine-grained control over the POST request headers and parameters.
Parameters
- data: Partial<T>
  The data for the new resource
Returns ResourceCreate<WorkOrder>
A ResourceCreate builder instance
Example
```
const asset = await client.asset
  .createResource({ assetnum: 'A001', description: 'New Asset' })
  .returnProperties(['assetnum', 'status'])
  .suppressEvents()
  .execute();
```
Inherited from ResourceService.createResource

updateResource

updateResource(id: string, data: Partial<T>): ResourceUpdate<WorkOrder>
Creates a fluent builder for updating an existing resource. Provides fine-grained control over the PATCH request headers and parameters.
Parameters
- id: string
  The ID of the resource to update
- data: Partial<T>
  The data to update
Returns ResourceUpdate<WorkOrder>
A ResourceUpdate builder instance
Example
```
const result = await client.asset
  .updateById('12345', { description: 'Updated' })
  .useMergePatch()
  .suppressEvents()
  .execute();
```
Inherited from ResourceService.updateResource

createRecord

createRecord(
    data: Partial<T>,
    returnProperties?: string | string[],
    getCreatedResult?: boolean,
): Promise<WorkOrder>
Creates a new resource (Simple Version)
Parameters
- data: Partial<T>
  The data for the new resource
- OptionalreturnProperties: string | string[]
  Optional properties to return in the response (string or string array)
- OptionalgetCreatedResult: boolean
  If true, fetches and returns the created resource after creation (default: false)
Returns Promise<WorkOrder>
A promise resolving to the created resource

Inherited from ResourceService.createRecord

create

create(
    data: Partial<T>,
    params?: Record<string, string>,
    headers?: Record<string, string>,
): Promise<WorkOrder>
Creates a new resource
Parameters
- data: Partial<T>
  The data for the new resource
- Optionalparams: Record<string, string>
  Optional query parameters (e.g., { ignorecollectionref: '1' })
- Optionalheaders: Record<string, string>
  Optional HTTP headers (e.g., { properties: 'field1,field2', 'x-allow-events': '0' })
Returns Promise<WorkOrder>
A promise resolving to the created resource

Inherited from ResourceService.create

updateRecord

updateRecord(
    id: string,
    data: Partial<T>,
    returnProperties?: string | string[],
): Promise<ResourceUpdateResponse<WorkOrder>>
Updates an existing resource (simple version)
Parameters
- id: string
  The ID of the resource to update
- data: Partial<T>
  The data to update
- OptionalreturnProperties: string | string[]
  Optional properties to return in the response (string or string array)
Returns Promise<ResourceUpdateResponse<WorkOrder>>
A promise resolving to a response object containing success status and optional data

Inherited from ResourceService.updateRecord

update

update(
    id: string,
    data: Partial<T>,
    params?: Record<string, string>,
    headers?: Record<string, string>,
): Promise<ResourceUpdateResponse<WorkOrder>>
Updates an existing resource
Parameters
- id: string
  The ID of the resource to update
- data: Partial<T>
  The data to update
- Optionalparams: Record<string, string>
  Optional query parameters
- Optionalheaders: Record<string, string>
  Optional HTTP headers (e.g., { patchtype: 'MERGE', 'x-allow-events': '0' })
Returns Promise<ResourceUpdateResponse<WorkOrder>>
A promise resolving to a response object containing success status and optional data

Inherited from ResourceService.update

mergeRecord

mergeRecord(
    id: string,
    data: Partial<T>,
    returnProperties?: string | string[],
): Promise<ResourceUpdateResponse<WorkOrder>>
Merges changes into an existing resource (simple version)
Parameters
- id: string
  The ID of the resource to update
- data: Partial<T>
  The data to merge, including child objects
- OptionalreturnProperties: string | string[]
  Optional properties to return in the response (string or string array)
Returns Promise<ResourceUpdateResponse<WorkOrder>>
A promise resolving to a response object containing success status and optional data

Inherited from ResourceService.mergeRecord

merge

merge(
    id: string,
    data: Partial<T>,
    params?: Record<string, string>,
    headers?: Record<string, string>,
): Promise<ResourceUpdateResponse<WorkOrder>>
Merges changes into an existing resource (e.g., for updating child objects) Uses MERGE patch type to avoid deleting unspecified child objects
Parameters
- id: string
  The ID of the resource to update
- data: Partial<T>
  The data to merge, including child objects
- Optionalparams: Record<string, string>
  Optional query parameters
- Optionalheaders: Record<string, string>
  Optional HTTP headers
Returns Promise<ResourceUpdateResponse<WorkOrder>>
A promise resolving to a response object containing success status and optional data

Inherited from ResourceService.merge

sync

sync(
    data: Partial<T>,
    params?: Record<string, string>,
    headers?: Record<string, string>,
): Promise<ResourceUpdateResponse<WorkOrder>>
Synchronizes a resource: Creates it if it doesn't exist (based on primary keys), or updates it if it does. Uses the SYNC method override.
Parameters
- data: Partial<T>
  The data for the resource, including primary key fields.
- Optionalparams: Record<string, string>
  Optional query parameters
- Optionalheaders: Record<string, string>
  Optional HTTP headers (e.g., { patchtype: 'MERGE' })
Returns Promise<ResourceUpdateResponse<WorkOrder>>
A promise resolving to a response object containing success status and optional data.

Inherited from ResourceService.sync

delete

delete(
    idOrResource: string | Partial<WorkOrder> | undefined,
    params?: Record<string, string>,
    headers?: Record<string, string>,
): Promise<void>
Deletes a resource
Parameters
- idOrResource: string | Partial<WorkOrder> | undefined
  The ID of the resource to delete or the resource object itself
- Optionalparams: Record<string, string>
  Optional query parameters
- Optionalheaders: Record<string, string>
  Optional HTTP headers
Returns Promise<void>
A promise that resolves when the resource is deleted

Inherited from ResourceService.delete

deleteById

deleteById(id: string): ResourceDelete<WorkOrder>
Creates a fluent builder for deleting a single resource by ID. Provides fine-grained control over the DELETE request headers.
Parameters
- id: string
  The ID of the resource to delete
Returns ResourceDelete<WorkOrder>
A ResourceDelete builder instance
Example
```
await client.asset
  .deleteById('12345')
  .withTransactionId('unique-tx-id')
  .suppressEvents()
  .execute();
```
Inherited from ResourceService.deleteById

getById

getById(id: string, select?: string | string[]): Promise<WorkOrder>
Retrieves a resource by its ID
Parameters
- id: string
  The ID of the resource to retrieve
- Optionalselect: string | string[]
  Optional oslc.select to return in the response (string or string array)
Returns Promise<WorkOrder>
A promise resolving to the resource

Inherited from ResourceService.getById

fetchById

fetchById(id: string): ResourceFetch<WorkOrder>
Creates a fluent builder for fetching a single resource by ID. Provides fine-grained control over the GET request parameters.
Parameters
- id: string
  The ID of the resource to fetch
Returns ResourceFetch<WorkOrder>
A ResourceFetch builder instance
Example
```
const asset = await client.asset
  .fetch('12345')
  .properties(['assetnum', 'description', 'status'])
  .inlineDoc(true)
  .dropNulls(false)
  .execute();
```
Inherited from ResourceService.fetchById

query

query(): QueryBuilder<WorkOrder>
Creates a new query builder for this resource

Returns QueryBuilder<WorkOrder>
A QueryBuilder instance

Inherited from ResourceService.query

executeQuery

executeQuery(
queryBuilder: QueryBuilder<WorkOrder>,
): Promise<OslcPaginatedResult<WorkOrder>>
Executes a query built by QueryBuilder
Parameters
- queryBuilder: QueryBuilder<WorkOrder>
  The QueryBuilder instance to execute
Returns Promise<OslcPaginatedResult<WorkOrder>>
A promise resolving to a paginated result

Inherited from ResourceService.executeQuery

findAll

findAll(
    whereOrBuilder?: string | QueryBuilder<WorkOrder>,
    select?: SelectableField<WorkOrder> | SelectableField<WorkOrder>[],
    orderBy?: string | string[],
): Promise<WorkOrder[]>
Finds all resources matching the given condition
Parameters
- OptionalwhereOrBuilder: string | QueryBuilder<WorkOrder>
  Optional OSLC where condition or a QueryBuilder instance
- Optionalselect: SelectableField<WorkOrder> | SelectableField<WorkOrder>[]
  Optional fields to select (ignored if whereOrBuilder is a QueryBuilder)
- OptionalorderBy: string | string[]
  Optional fields to order by (ignored if whereOrBuilder is a QueryBuilder)
Returns Promise<WorkOrder[]>
A promise resolving to an array of resources

Inherited from ResourceService.findAll

findPaginated

findPaginated(
    whereOrBuilder?: string | QueryBuilder<WorkOrder>,
    pageNum?: number,
    pageSize?: number,
    select?: SelectableField<WorkOrder> | SelectableField<WorkOrder>[],
    orderBy?: string | string[],
): Promise<OslcPaginatedResult<WorkOrder>>
Finds resources with pagination
Parameters
- OptionalwhereOrBuilder: string | QueryBuilder<WorkOrder>
  Optional OSLC where condition or a QueryBuilder instance
- pageNum: number = 1
  Page number (1-based) (ignored if whereOrBuilder is a QueryBuilder)
- pageSize: number = 100
  Number of items per page (ignored if whereOrBuilder is a QueryBuilder)
- Optionalselect: SelectableField<WorkOrder> | SelectableField<WorkOrder>[]
  Optional fields to select (ignored if whereOrBuilder is a QueryBuilder)
- OptionalorderBy: string | string[]
  Optional fields to order by (ignored if whereOrBuilder is a QueryBuilder)
Returns Promise<OslcPaginatedResult<WorkOrder>>
A promise resolving to a paginated result

Inherited from ResourceService.findPaginated

count

count(whereOrBuilder?: string | QueryBuilder<WorkOrder>): Promise<number>
Counts resources matching the given condition
Parameters
- OptionalwhereOrBuilder: string | QueryBuilder<WorkOrder>
  Optional OSLC where condition or a QueryBuilder instance
Returns Promise<number>
A promise resolving to the count

Inherited from ResourceService.count

findById

findById(id: string, properties?: string | string[]): Promise<WorkOrder>
Finds a resource by its ID
Parameters
- id: string
  The ID of the resource
- Optionalproperties: string | string[]
  Optional properties to return (string or string array)
Returns Promise<WorkOrder>
A promise resolving to the resource

Inherited from ResourceService.findById

findBySavedQuery

findBySavedQuery(
    queryNameOrBuilder: string | QueryBuilder<WorkOrder>,
    select?: SelectableField<WorkOrder> | SelectableField<WorkOrder>[],
    orderBy?: string | string[],
): Promise<OslcPaginatedResult<WorkOrder>>
Finds resources using a saved query
Parameters
- queryNameOrBuilder: string | QueryBuilder<WorkOrder>
  The name of the saved query or a QueryBuilder with a saved query
- Optionalselect: SelectableField<WorkOrder> | SelectableField<WorkOrder>[]
  Optional fields to select (ignored if queryNameOrBuilder is a QueryBuilder)
- OptionalorderBy: string | string[]
  Optional fields to order by (ignored if queryNameOrBuilder is a QueryBuilder)
Returns Promise<OslcPaginatedResult<WorkOrder>>
A promise resolving to a paginated result

Inherited from ResourceService.findBySavedQuery

findDistinct

findDistinct(
fieldOrBuilder: string | QueryBuilder<WorkOrder>,
where?: string,
): Promise<any[]>
Finds distinct values for a field
Parameters
- fieldOrBuilder: string | QueryBuilder<WorkOrder>
  The field to get distinct values for or a QueryBuilder with distinct field
- Optionalwhere: string
  Optional OSLC where condition (ignored if fieldOrBuilder is a QueryBuilder)
Returns Promise<any[]>
A promise resolving to an array of distinct values

Inherited from ResourceService.findDistinct

bulkOperation

bulkOperation(): BulkOperationBuilder<WorkOrder>
Creates a new bulk operation builder for this resource

Returns BulkOperationBuilder<WorkOrder>
A BulkOperationBuilder instance

Inherited from ResourceService.bulkOperation

executeBulkOperation

executeBulkOperation(
    builder: BulkOperationBuilder<WorkOrder> | Partial<WorkOrder>[],
    actionName?: string,
    params?: Record<string, string>,
    headers?: Record<string, string>,
): Promise<BulkOperationResult<WorkOrder>>
Executes a bulk operation
Parameters
- builder: BulkOperationBuilder<WorkOrder> | Partial<WorkOrder>[]
  The BulkOperationBuilder instance to execute or an array of partial resource objects
- OptionalactionName: string
  Optional action name to execute (for object methods)
- Optionalparams: Record<string, string>
- Optionalheaders: Record<string, string>
Returns Promise<BulkOperationResult<WorkOrder>>
A promise resolving to the bulk operation result

Inherited from ResourceService.executeBulkOperation

getAllowedActions

getAllowedActions(id: string): Promise<WorkOrder>
Retrieves allowed actions for a specific resource
Parameters
- id: string
  The ID of the resource to get allowed actions for
Returns Promise<WorkOrder>
A promise resolving to the resource with allowed actions information

Inherited from ResourceService.getAllowedActions

action

action(
    id: string,
    actionName: string,
    payload?: any,
    returnProperties?: string | string[],
): Promise<ResourceUpdateResponse<WorkOrder>>
Executes an action on a specific resource Supports both GET and POST methods based on payload presence
Parameters
- id: string
  The ID of the resource to execute the action on
- actionName: string
  The name of the action to execute
- Optionalpayload: any
  Optional payload data for the action (if provided, uses POST, otherwise GET)
- OptionalreturnProperties: string | string[]
  Optional properties to return in the response
Returns Promise<ResourceUpdateResponse<WorkOrder>>
A promise resolving to a response object containing success status and optional data

Inherited from ResourceService.action

globalAction

globalAction(
    actionName: string,
    payload?: any,
    returnProperties?: string | string[],
): Promise<ResourceUpdateResponse<any>>
Executes a global action on the object structure (not tied to a specific resource)
Parameters
- actionName: string
  The name of the action to execute
- Optionalpayload: any
  Optional payload data for the action (if provided, uses POST, otherwise GET)
- OptionalreturnProperties: string | string[]
  Optional properties to return in the response
Returns Promise<ResourceUpdateResponse<any>>
A promise resolving to a response object containing success status and optional data

Inherited from ResourceService.globalAction

getObjectStructure

getObjectStructure(): string
Returns the object structure name for this service.

Returns string
Inherited from ResourceService.getObjectStructure

Constructors

constructor

new WorkOrderService(httpClient: HttpClient): WorkOrderService
Creates a new WorkOrderService
Parameters
- httpClient: HttpClient
  The HTTP client for making requests
Returns WorkOrderService
Overrides ResourceService.constructor

Report Operations

listReports

listReports(): Promise<ReportDescriptor[]>
Lists available BIRT reports for this object structure

Returns Promise<ReportDescriptor[]>
A promise resolving to an array of report descriptors

Inherited from ResourceService.listReports

generateReport

generateReport(
    reportName: string,
    format?: string,
    additionalParams?: Record<string, any>,
): Promise<any>
Generates a BIRT report
Parameters
- reportName: string
  The name of the report to generate (e.g., 'woprint.rptdesign')
- format: string = 'pdf'
  The output format (default: 'pdf'). Other options: 'xls', 'html', etc.
- OptionaladditionalParams: Record<string, any>
  Optional additional parameters (e.g., oslc.where, or report parameters)
Returns Promise<any>
A promise resolving to the report content as a buffer (or appropriate type based on environment)

Inherited from ResourceService.generateReport

Class WorkOrderService

Hierarchy (View Summary)

Index

Properties

Methods

Common Resource Operations

Constructors

Report Operations

Properties

ProtectedapiBase

Protectedlogger

ProtectedhttpClient

ProtectedapiHome

OptionaluniqueColumn

OptionalappName

ProtectedobjectStructure

Methods

setLogger

Parameters

Returns this

getLogger

Returns ILogger

ProtectedformatProperties

Parameters

Returns string | undefined

ProtectedhandleError

Parameters

Returns never

getUniqueColumnName

Returns string | undefined

getUniqueColumnId

Parameters

Returns string | number | undefined

getWebUrl

Parameters

Returns string

executeResourceCreate

Parameters

Returns Promise<WorkOrder>

executeResourceUpdate

Parameters

Returns Promise<ResourceUpdateResponse<WorkOrder>>

executeResourceDelete

Parameters

Returns Promise<void>

executeResourceFetch

Parameters

Returns Promise<WorkOrder>

webMethod

Parameters

Returns Promise<ResourceUpdateResponse<WorkOrder>>

workflow

Parameters

Returns Promise<ResourceUpdateResponse<WorkOrder>>

createWorkOrder

Parameters

Returns Promise<WorkOrder>

assignTo

Parameters

Returns Promise<ResourceUpdateResponse<WorkOrder>>

changeStatus

Parameters

Returns Promise<ResourceUpdateResponse<WorkOrder>>

updateCosts

Parameters

Returns Promise<ResourceUpdateResponse<WorkOrder>>

updateHours

Parameters

Returns Promise<ResourceUpdateResponse<WorkOrder>>

findByAsset

Parameters

Returns Promise<WorkOrder[]>

findByLocation

Parameters

Returns Promise<WorkOrder[]>

findByStatus

Parameters

Returns Promise<WorkOrder[]>

findByWorkType

Parameters

`Protected`apiBase

`Protected`logger

`Protected`httpClient

`Protected`apiHome

`Optional`uniqueColumn

`Optional`appName

`Protected`objectStructure

`Protected`formatProperties

`Protected`handleError

`Protected`primaryKeys

`Protected`getPrimaryColumns

`Protected`encodeResourceId

`Protected`decodeResourceId