Class ResourceService<T>`Abstract`

Base service class for Maximo resources Provides CRUD operations and query capabilities for any Maximo resource

Type Parameters

T extends OslcResource
The resource type that extends OslcResource

Hierarchy (View Summary)

BaseMaximoService
- ResourceService

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 BaseMaximoService.setLogger

getLogger

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

Returns ILogger
Inherited from BaseMaximoService.getLogger

`Protected`formatProperties

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

`Protected`handleError

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

getUniqueColumnName

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

Returns string | undefined

getUniqueColumnId

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

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

executeResourceCreate

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

executeResourceUpdate

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

executeResourceDelete

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

executeResourceFetch

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

webMethod

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

workflow

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

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 BaseMaximoService.actionOnEndpoint

updateBuilder

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

Returns UpdateBuilder<T>

createBuilder

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

Returns UpdateBuilder<T>

`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

`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

`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

`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

createResource

createResource(data: Partial<T>): ResourceCreate<T>
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<T>
A ResourceCreate builder instance
Example
```
const asset = await client.asset
  .createResource({ assetnum: 'A001', description: 'New Asset' })
  .returnProperties(['assetnum', 'status'])
  .suppressEvents()
  .execute();
```

updateResource

updateResource(id: string, data: Partial<T>): ResourceUpdate<T>
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<T>
A ResourceUpdate builder instance
Example
```
const result = await client.asset
  .updateById('12345', { description: 'Updated' })
  .useMergePatch()
  .suppressEvents()
  .execute();
```

createRecord

createRecord(
    data: Partial<T>,
    returnProperties?: string | string[],
    getCreatedResult?: boolean,
): Promise<T>
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<T>
A promise resolving to the created resource

create

create(
    data: Partial<T>,
    params?: Record<string, string>,
    headers?: Record<string, string>,
): Promise<T>
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<T>
A promise resolving to the created resource

updateRecord

updateRecord(
    id: string,
    data: Partial<T>,
    returnProperties?: string | string[],
): Promise<ResourceUpdateResponse<T>>
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<T>>
A promise resolving to a response object containing success status and optional data

update

update(
    id: string,
    data: Partial<T>,
    params?: Record<string, string>,
    headers?: Record<string, string>,
): Promise<ResourceUpdateResponse<T>>
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<T>>
A promise resolving to a response object containing success status and optional data

mergeRecord

mergeRecord(
    id: string,
    data: Partial<T>,
    returnProperties?: string | string[],
): Promise<ResourceUpdateResponse<T>>
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<T>>
A promise resolving to a response object containing success status and optional data

merge

merge(
    id: string,
    data: Partial<T>,
    params?: Record<string, string>,
    headers?: Record<string, string>,
): Promise<ResourceUpdateResponse<T>>
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<T>>
A promise resolving to a response object containing success status and optional data

sync

sync(
    data: Partial<T>,
    params?: Record<string, string>,
    headers?: Record<string, string>,
): Promise<ResourceUpdateResponse<T>>
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<T>>
A promise resolving to a response object containing success status and optional data.

delete

delete(
    idOrResource: string | Partial<T> | undefined,
    params?: Record<string, string>,
    headers?: Record<string, string>,
): Promise<void>
Deletes a resource
Parameters
- idOrResource: string | Partial<T> | 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

deleteById

deleteById(id: string): ResourceDelete<T>
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<T>
A ResourceDelete builder instance
Example
```
await client.asset
  .deleteById('12345')
  .withTransactionId('unique-tx-id')
  .suppressEvents()
  .execute();
```

getById

getById(id: string, select?: string | string[]): Promise<T>
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<T>
A promise resolving to the resource

fetchById

fetchById(id: string): ResourceFetch<T>
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<T>
A ResourceFetch builder instance
Example
```
const asset = await client.asset
  .fetch('12345')
  .properties(['assetnum', 'description', 'status'])
  .inlineDoc(true)
  .dropNulls(false)
  .execute();
```

query

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

Returns QueryBuilder<T>
A QueryBuilder instance

executeQuery

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

findAll

findAll(
    whereOrBuilder?: string | QueryBuilder<T>,
    select?: SelectableField<T> | SelectableField<T>[],
    orderBy?: string | string[],
): Promise<T[]>
Finds all resources matching the given condition
Parameters
- OptionalwhereOrBuilder: string | QueryBuilder<T>
  Optional OSLC where condition or a QueryBuilder instance
- Optionalselect: SelectableField<T> | SelectableField<T>[]
  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<T[]>
A promise resolving to an array of resources

findPaginated

findPaginated(
    whereOrBuilder?: string | QueryBuilder<T>,
    pageNum?: number,
    pageSize?: number,
    select?: SelectableField<T> | SelectableField<T>[],
    orderBy?: string | string[],
): Promise<OslcPaginatedResult<T>>
Finds resources with pagination
Parameters
- OptionalwhereOrBuilder: string | QueryBuilder<T>
  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<T> | SelectableField<T>[]
  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<T>>
A promise resolving to a paginated result

count

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

findById

findById(id: string, properties?: string | string[]): Promise<T>
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<T>
A promise resolving to the resource

findBySavedQuery

findBySavedQuery(
    queryNameOrBuilder: string | QueryBuilder<T>,
    select?: SelectableField<T> | SelectableField<T>[],
    orderBy?: string | string[],
): Promise<OslcPaginatedResult<T>>
Finds resources using a saved query
Parameters
- queryNameOrBuilder: string | QueryBuilder<T>
  The name of the saved query or a QueryBuilder with a saved query
- Optionalselect: SelectableField<T> | SelectableField<T>[]
  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<T>>
A promise resolving to a paginated result

findDistinct

findDistinct(
fieldOrBuilder: string | QueryBuilder<T>,
where?: string,
): Promise<any[]>
Finds distinct values for a field
Parameters
- fieldOrBuilder: string | QueryBuilder<T>
  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

bulkOperation

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

Returns BulkOperationBuilder<T>
A BulkOperationBuilder instance

executeBulkOperation

executeBulkOperation(
    builder: BulkOperationBuilder<T> | Partial<T>[],
    actionName?: string,
    params?: Record<string, string>,
    headers?: Record<string, string>,
): Promise<BulkOperationResult<T>>
Executes a bulk operation
Parameters
- builder: BulkOperationBuilder<T> | Partial<T>[]
  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<T>>
A promise resolving to the bulk operation result

getAllowedActions

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

action

action(
    id: string,
    actionName: string,
    payload?: any,
    returnProperties?: string | string[],
): Promise<ResourceUpdateResponse<T>>
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<T>>
A promise resolving to a response object containing success status and optional data

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

getObjectStructure

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

Returns string

Constructors

constructor

new ResourceService<T extends OslcResource>(
    httpClient: HttpClient,
    objectStructure: string,
    primaryKeys?: string[],
    logger?: ILogger,
): ResourceService<T>
Creates a new ResourceService for a specific Maximo object structure
Type Parameters
- T extends OslcResource
  The resource type that extends OslcResource
Parameters
- httpClient: HttpClient
  The HTTP client for making requests
- objectStructure: string
  The Maximo object structure name (e.g., 'mxapiasset')
- OptionalprimaryKeys: string[]
- Optionallogger: ILogger
Returns ResourceService<T>
Overrides BaseMaximoService.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

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)

Class ResourceService<T>Abstract

Type Parameters

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

executeResourceUpdate

Parameters

Returns Promise<ResourceUpdateResponse<T>>

executeResourceDelete

Parameters

Returns Promise<void>

executeResourceFetch

Parameters

Returns Promise<T>

webMethod

Parameters

Returns Promise<ResourceUpdateResponse<T>>

workflow

Parameters

Returns Promise<ResourceUpdateResponse<T>>

Common Resource Operations

actionOnEndpoint

Parameters

Returns Promise<ResourceUpdateResponse<any>>

updateBuilder

Returns UpdateBuilder<T>

createBuilder

Returns UpdateBuilder<T>

ProtectedprimaryKeys

setApiHome

Parameters

Returns void

ProtectedgetPrimaryColumns

Returns string[]

ProtectedencodeResourceId

Parameters

Returns string

ProtecteddecodeResourceId

Parameters

Returns Record<string, string>

createResource

Parameters

Returns ResourceCreate<T>

Example

updateResource

Class ResourceService<T>`Abstract`

`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