Class ODataError

constructor

• new ODataError(options: ODataErrorOptions): ODataError

  Creates a new ODataError instance.

  Parameters

  • options: ODataErrorOptions

    OData error construction options including HTTP status code, request URL, and entity set context for the failing operation.

  Returns ODataError

  Example

  import { ODataError } from '#core/errors/odata-error.js';
  
  const error = new ODataError({
    message: 'OData request failed with status 403',
    attempted: 'Fetch purchase orders from PurchaseOrder entity set',
    statusCode: 403,
    requestUrl: '/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/PurchaseOrder',
    entitySet: 'PurchaseOrder',
  });
  Copy

ReadonlyentitySet

ReadonlyrequestUrl

ReadonlystatusCode

toAIContext

• toAIContext(): AIErrorContext & {
      entitySet: string
      | undefined;
      requestUrl: string | undefined;
      statusCode: number | undefined;
  }

  Returns AI-agent-friendly context with OData-specific diagnostic fields.

  Returns AIErrorContext & {
      entitySet: string | undefined;
      requestUrl: string | undefined;
      statusCode: number | undefined;
  }

  Base AI context extended with HTTP status, request URL, and entity set details.

  Example

  const ctx = error.toAIContext();
  // LLM can use ctx.statusCode to determine if the error is auth-related (401/403)
  // and ctx.entitySet to suggest the correct OData service path
  Copy

toJSON

• toJSON(): SerializedPramanError & {
      entitySet: string
      | undefined;
      requestUrl: string | undefined;
      statusCode: number | undefined;
  }

  Serializes this error to a JSON-safe object with OData-specific fields.

  Returns SerializedPramanError & {
      entitySet: string | undefined;
      requestUrl: string | undefined;
      statusCode: number | undefined;
  }

  Base serialization extended with statusCode, requestUrl, and entitySet.

  Example

  const json = error.toJSON();
  console.log(json.statusCode); // 403
  console.log(json.entitySet);  // 'PurchaseOrder'
  console.log(json.requestUrl); // '/sap/opu/odata/sap/.../PurchaseOrder'
  Copy