Maximo API Client - v0.9.20
    Preparing search index...

    Class SystemService

    Hierarchy

    • BaseMaximoService
      • SystemService
    Index

    Properties

    apiBase: string

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

    logger: ILogger
    httpClient: HttpClient

    The HTTP client for making requests

    Methods

    • Overrides the logger used by this service instance.

      Parameters

      Returns this

    • Returns the current logger used by this service instance.

      Returns ILogger

    • Parameters

      • Optionalproperties: string | string[]

      Returns string | undefined

    • Error handler

      Parameters

      • error: any

        the error to process

      Returns never

    • Get all property names

      Returns Promise<any>

      Array of property names

    • Get the value of a specific property

      Parameters

      • propertyName: string

        Property name to get

      Returns Promise<any>

    • Bulk-fetch many system property values in a single HTTP call. Maximo's wsmethod:getProperties action takes an array of names and returns { propertyName: value, ... } — every name maps to its current value (or null when the property doesn't exist).

      Why this matters: the singular getPropertyValue makes one round-trip per property. On Maximo installs with thousands of system properties that's prohibitive. Use this method whenever you need more than a couple of values.

      Parameters

      • propertyNames: string[]

        Property names to fetch. An empty array short- circuits to {} without making a network call.

      Returns Promise<Record<string, string | null>>

      Map of name → string value (or null when Maximo has no value set for that name).

    • Live refresh the property

      Parameters

      • propertyName: string

        Property name to refresh

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

    • Checks if the instance is of Maximo Manage

      Returns Promise<any>

      True if the its Maximo manage, false otherwise.

    • Gets the current server date

      Returns Promise<any>

      Current server date

    • Helper function to check if os security is enabled using property mxe.int.enableosauth

      Returns Promise<boolean>

    Common Resource Operations

    • 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

    Constructors