Looking for a REST API? The Ad Manager API (Beta) is now available.

abstract type ApiError (v202505)

Page Summary

ApiError is the base class for API errors in the DaiEncodingProfileService.
It provides details about errors that occur during service requests, including the OGNL field path to identify the problematic data element.
Subclasses of ApiError represent specific error types, such as AuthenticationError, CollectionSizeError, and various DaiEncodingProfile related errors.
Key fields within ApiError include fieldPath , fieldPathElements , trigger , and errorString , providing information about the error's location, cause, and description.

Service

Dependencies

ApiException

▼

ApiError

The API error base class that provides details about an error that occurred while processing a service request.

The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

Field
`fieldPath`	`xsd: string` The OGNL field path to identify cause of error.
`fieldPathElements`	`FieldPathElement []` A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
`trigger`	`xsd: string` The data that caused the error.
`errorString`	`xsd: string` A simple string representation of the error and reason.