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

    Class SchemaService

    Service for fetching JSON schema information from Maximo Allows retrieving object structure and MBO schemas

    Hierarchy

    • BaseMaximoService
      • SchemaService
    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

    • Fetches JSON schema for an object structure

      Parameters

      • objectStructure: string

        The object structure name (e.g., 'mxapiwodetail')

      • OptionalselectClause: string

        Optional OSLC select clause to filter schema properties

      Returns Promise<any>

      Promise resolving to the schema object

    • Fetches JSON schema for an MBO (Maximo Business Object)

      Parameters

      • mboName: string

        The MBO name (e.g., 'asset', 'workorder')

      • OptionalselectClause: string

        Optional OSLC select clause to filter schema properties

      Returns Promise<any>

      Promise resolving to the schema object

    • Generic method to fetch any schema type

      Parameters

      • schemaType: SchemaType

        Type of schema to fetch (jsonschemas or jsonmboschemas)

      • name: string

        Name of the object structure or MBO

      • OptionalselectClause: string

        Optional OSLC select clause to filter schema properties

      Returns Promise<any>

      Promise resolving to the schema object

    • Includes schema in a standard resource request This adds the addschema=1 parameter to any resource fetch

      Parameters

      • resourceUrl: string

        The resource URL to fetch with schema

      • params: Record<string, string> = {}

        Additional query parameters

      Returns Promise<any>

      Promise resolving to the resource with schema included

    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