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

    Class OslcInfoService

    Service for interacting with Maximo OSLC/API Home and related information endpoints. These endpoints provide details about the Maximo runtime environment, installed products, API metadata, user information, etc.

    Corresponds to endpoints described in apihome.md:

    • /oslc or /api (root API home document)
    • /oslc/systeminfo or /api/systeminfo
    • /oslc/whoami or /api/whoami
    • /oslc/products or /api/products
    • /oslc/members or /api/members
    • /oslc/license or /api/license
    • /oslc/apimeta or /api/apimeta

    Hierarchy

    • BaseMaximoService
      • OslcInfoService
    Index

    Properties

    apiBase logger httpClient

    Methods

    setLogger getLogger formatProperties handleError fetchApiHomeDocument getSystemInfo getWhoAmI getInstalledProducts getServerMembers getLicenses getApiMetadataDocument

    Common Resource Operations

    actionOnEndpoint

    Constructors

    constructor

    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

    • Fetches the API home document from the root of the API (/oslc/ or /api/). This document contains links to various other API resources and details about the Maximo runtime environment.

      Returns Promise<any>

      A promise that resolves to the API home JSON object.

    • Fetches the system information JSON for the deployed Maximo instance. Corresponds to GET /oslc/systeminfo or GET /api/systeminfo.

      Returns Promise<any>

      A promise that resolves to the system information JSON.

    • Fetches the profile JSON for the user that is logged in. Corresponds to GET /oslc/whoami or GET /api/whoami.

      Returns Promise<any>

      A promise that resolves to the user's profile JSON.

    • Fetches the list of installed add-ons for Maximo Asset Management. Corresponds to GET /oslc/products or GET /api/products.

      Returns Promise<any>

      A promise that resolves to the list of installed products.

    • Fetches the list of live Maximo servers (MMI - Maximo Management Interface). Corresponds to GET /oslc/members or GET /api/members.

      Returns Promise<any>

      A promise that resolves to the list of server members.

    • Fetches the list of available license keys for Maximo components. Corresponds to GET /oslc/license or GET /api/license.

      Returns Promise<any>

      A promise that resolves to the list of licenses.

    • Fetches the metadata for all API-eligible object structures. Corresponds to GET /oslc/apimeta or GET /api/apimeta.

      Returns Promise<any>

      A promise that resolves to the API metadata JSON.

    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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    Common Resource Operations
    Constructors