Error object representation

The error object representation and fields are described below.

error was introduced in API version V1

error has not been marked for deprecation

Description

General API error object representation

Fields

NameTypeDescriptionConstraints
httpCodeHTTP code. See https://www.rfc-editor.org/rfc/rfc9110.html#name-status-codesHTTP code for this error
apiCodeAPI specific error code. See reference documentationAPI Error specific code. See reference docs for values / meanings

Allowed values:

  • INVALID_REPRESENTATION
  • REPRESENTATION_MISSING_REQUIRED_FIELD
  • READ_SUCCESS
  • UPDATE_SUCCESS
  • DELETE_SUCCESS
  • NOT_FOUND
  • CREATE_SUCCESS
  • BAD_REQUEST

detailString literalDetail message for specific issue used in combination with API error