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

    Class LoggingService

    Service for Maximo log management operations Implements endpoints from the Logging section of Maximo REST API

    Hierarchy

    • BaseMaximoService
      • LoggingService
    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 the list of available log appenders on the server Calls /service/logging?action=wsmethod:getAppenderList

      Returns Promise<any[]>

      Promise resolving to array of appender objects

    • Get the list of available loggers/categories on the server Calls /service/logging?action=wsmethod:getLoggerList

      Returns Promise<any[]>

      Promise resolving to array of logger objects

    • Get the root folder for logs from Maximo Calls /service/logging?action=wsmethod:getRootFolder

      Returns Promise<string>

      Promise resolving to the root folder string (e.g. "/opt/logs")

    • Upload logs from Maximo Manage UI, Cron, Maximo Enterprise Adapter, or Report pods to S3 Cloud Object Storage HTTP Method: POST Signature Option: GETLOG API Request Type: Asynchronous

      Returns Promise<any>

      Promise resolving to the upload result containing the LOGREQUESTNUM from LOGREQUEST table e.g. {"return":"1002-1767713985445"} 1002 is the LOGREQUESTNUM 1767713985445 is the REQUESTTS (The timestamp when the request was made in epoch time)

    • Stream logs from Maximo Manage pods. If the 'lines' parameter is provided, it retrieves the full log and then returns only the last N lines.

      Parameters

      • Optionallines: number

        Optional. The number of recent lines to retrieve from the log.

      Returns Promise<any>

      A promise that resolves with the log data.

    • Get current log level

      Parameters

      • logKey: string

        log key for getting specific log levels

      Returns Promise<any>

      Promise resolving to current log levels

    • Disable all logs in thread logging for the current user

      Returns Promise<any>

      Promise resolving to the action result

    • Disable all logs in thread logging for the current user

      Returns Promise<any>

      Promise resolving to the action result

    • Enable logs for the provided logKey array

      Parameters

      • logKeys: string[]

        Array of logKey strings (e.g. ["maximo.sql.crontaskmgr"])

      Returns Promise<boolean>

      Promise resolving to true if successful (HTTP 200)

    • Set a specific logger's level

      Parameters

      • loggerName: string

        Logger/category name

      • level: string

        Log level (DEBUG, ERROR, INFO, WARN, FATAL)

      Returns Promise<boolean>

      Promise resolving to the action result

    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