Share via

ODataV4Format Class

  • Reference

Class to describe OData V4 error format.

http://docs.oasis-open.org/odata/odata-json-format/v4.0/os/odata-json-format-v4.0-os.html#_Toc372793091

Example of JSON:


   {
       "error": {
           "code": "ValidationError",
           "message": "One or more fields contain incorrect values: ",
           "details": [
               {
                   "code": "ValidationError",
                   "target": "representation",
                   "message": "Parsing error(s): String '' does not match regex pattern '^[^{}/ :]+(?: :\\d+)?$'.
                   Path 'host', line 1, position 297."
               },
               {
                   "code": "ValidationError",
                   "target": "representation",
                   "message": "Parsing error(s): The input OpenAPI file is not valid for the OpenAPI specificate
                   https: //github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
                   (schema https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v2.0/schema.json)."
               }
           ]
       }
   }
Inheritance
builtins.object
ODataV4Format

Constructor

ODataV4Format(json_object: Mapping[str, Any])

Parameters

Name Description
json_object
Required
dict

A Python dict representing a ODataV4 JSON

Variables

Name Description
~.code
str

Its value is a service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
message
str

Human-readable, language-dependent representation of the error.
target
str

The target of the particular error (for example, the name of the property in error). This field is optional and may be None.
details
list[ODataV4Format]

Array of ODataV4Format instances that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.
innererror
dict

An object. The contents of this object are service-defined. Usually this object contains information that will help debug the service.

Methods

message_details

Return a detailed string of the error.

message_details

Return a detailed string of the error.

message_details() -> str

Returns

Type Description
str

A string with the details of the error.

Attributes

error

CODE_LABEL 

CODE_LABEL = 'code'

DETAILS_LABEL 

DETAILS_LABEL = 'details'

INNERERROR_LABEL 

INNERERROR_LABEL = 'innererror'

MESSAGE_LABEL 

MESSAGE_LABEL = 'message'

TARGET_LABEL 

TARGET_LABEL = 'target'