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

    Class ResourceDelete<T>

    Fluent builder for deleting a single resource by ID. Provides a chainable API for configuring DELETE /os/{objectStructure}/{id} requests.

    await client.asset
      .deleteById('12345')
      .withTransactionId('unique-tx-id')
      .suppressEvents()
      .execute();

    Type Parameters

    • T extends OslcResource

      The resource type that extends OslcResource

    Index

    Methods

    withTransactionId suppressEvents allowEvents withPublicUri header getId buildHeaders execute

    Constructors

    constructor

    Methods

    • Sets the transaction ID for deduplication (transactionid header) If a matching transaction ID exists, the server returns a conflict error.

      Parameters

      • transactionId: string

        Unique transaction identifier

      Returns this

      This builder instance for chaining

    • Suppresses business object events (sets x-allow-events to 0) Prevents triggers, scripts, and notifications from firing.

      Returns this

      This builder instance for chaining

    • Explicitly allows business object events (sets x-allow-events to 1) This is the default behavior.

      Returns this

      This builder instance for chaining

    • Sets the public URI header (x-public-uri)

      Parameters

      • uri: string

        The public URI base for generated links

      Returns this

      This builder instance for chaining

    • Sets a custom header

      Parameters

      • name: string

        Header name

      • value: string

        Header value

      Returns this

      This builder instance for chaining

    • Gets the resource ID

      Returns string

    • Internal

      Builds the headers for the request

      Returns Record<string, string>

    • Executes the delete request

      Returns Promise<void>

      A promise that resolves when the resource is deleted

    Constructors

    Settings

    Member Visibility

    On This Page

    Methods
    Constructors