Skip to main content
Version: 1.x

Class: ODataError

Error subclass for OData request failures.

Example​

const error = new ODataError({
  message: 'OData request failed',
  attempted: 'Fetch entity set',
  statusCode: 500,
});

Sap Module​

BC-SRV-OData

Failure Mode​

Request failed — OData HTTP request returned error status

Failure Mode​

Parse error — OData response body could not be parsed as JSON/XML

Failure Mode​

CSRF expired — x-csrf-token is stale and needs refresh

Extends​

Constructors​

Constructor​

new ODataError(options): 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',
});

Overrides​

PramanError.constructor

Properties​

attempted​

readonly attempted: string

Inherited from​

PramanError.attempted

cause?​

optional cause?: unknown

Inherited from​

PramanError.cause

code​

readonly code: ErrorCode

Inherited from​

PramanError.code

details​

readonly details: Readonly<Record<string, unknown>>

Inherited from​

PramanError.details

entitySet​

readonly entitySet: string | undefined

message​

message: string

Inherited from​

PramanError.message

name​

name: string

Inherited from​

PramanError.name

requestUrl​

readonly requestUrl: string | undefined

retryable​

readonly retryable: boolean

Inherited from​

PramanError.retryable

severity​

readonly severity: "error" | "info" | "warning"

Inherited from​

PramanError.severity

stack?​

optional stack?: string

Inherited from​

PramanError.stack

statusCode​

readonly statusCode: number | undefined

suggestions​

readonly suggestions: readonly string[]

Inherited from​

PramanError.suggestions

timestamp​

readonly timestamp: string

Inherited from​

PramanError.timestamp

stackTraceLimit​

static stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from​

PramanError.stackTraceLimit

Methods​

toAIContext()​

toAIContext(): AIErrorContext & object

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

Returns​

AIErrorContext & object

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

Overrides​

PramanError.toAIContext

toJSON()​

toJSON(): SerializedPramanError & object

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

Returns​

SerializedPramanError & object

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'

Overrides​

PramanError.toJSON

toUserMessage()​

toUserMessage(): string

Formats the error for human-readable console output.

Returns​

string

Multi-line formatted string with all diagnostic sections.

Example​

console.error(error.toUserMessage());

Inherited from​

PramanError.toUserMessage

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

PramanError.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from​

PramanError.prepareStackTrace