Class SystemService

Hierarchy

BaseMaximoService
- SystemService

Index

Properties

apiBase logger httpClient

Methods

setLogger getLogger formatProperties handleError getAllPropertyNames getPropertyValue liveRefreshProperty setPropertyValue isManage getDate isOsSecurityOn

Common Resource Operations

actionOnEndpoint

Constructors

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

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

getAllPropertyNames

getAllPropertyNames(): Promise<any>
Get all property names

Returns Promise<any>
Array of property names

getPropertyValue

getPropertyValue(propertyName: string): Promise<any>
Get the value of a specific property
Parameters
- propertyName: string
  Property name to get
Returns Promise<any>

liveRefreshProperty

liveRefreshProperty(propertyName: string): Promise<any>
Live refresh the property
Parameters
- propertyName: string
  Property name to refresh
Returns Promise<any>

setPropertyValue

setPropertyValue(propertyName: string, propertyValue: any): Promise<any>
Sets the value of a specific property and liverefreshes it
Parameters
- propertyName: string
  Property name to set
- propertyValue: any
  Property value to set
Returns Promise<any>

isManage

isManage(): Promise<any>
Checks if the instance is of Maximo Manage

Returns Promise<any>
True if the its Maximo manage, false otherwise.

getDate

getDate(): Promise<any>
Gets the current server date

Returns Promise<any>
Current server date

isOsSecurityOn

isOsSecurityOn(): Promise<boolean>
Helper function to check if os security is enabled using property mxe.int.enableosauth

Returns Promise<boolean>

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

Constructors

constructor

new SystemService(httpClient: HttpClient): SystemService
Parameters
- httpClient: HttpClient
Returns SystemService
Overrides BaseMaximoService.constructor