ODataV4Format Klasse

  • Referenz

Klasse zum Beschreiben des OData V4-Fehlerformats.

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

Beispiel für JSON:

error: { "code": "ValidationError", "message": "Mindestens ein Feld enthält falsche Werte: ", "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](https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v2.0/schema.json))."

  }

]

}

Vererbung
builtins.object
ODataV4Format

Konstruktor

ODataV4Format(json_object: Mapping[str, Any])

Parameter

json_object
dict
Erforderlich

Ein Python-Diktat, das einen ODataV4-JSON-Code darstellt

Variablen

~.code
str

Sein Wert ist ein vom Dienst definierter Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.

message
str

Für Menschen lesbare, sprachabhängige Darstellung des Fehlers.

target
str

Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler). Dieses Feld ist optional und kann Keine sein.

details
list[ODataV4Format]

Array von ODataV4Format-Instanzen, die Name-Wert-Paare für Code und Nachricht enthalten müssen, und möglicherweise ein Name-Wert-Paar für das Ziel enthalten, wie oben beschrieben.

innererror
dict

Ein Objekt. Der Inhalt dieses Objekts ist dienstdefiniert. In der Regel enthält dieses Objekt Informationen, die beim Debuggen des Diensts helfen.

Methoden

message_details

Gibt eine detaillierte Zeichenfolge des Fehlers zurück.

message_details

Gibt eine detaillierte Zeichenfolge des Fehlers zurück.

message_details() -> str

Gibt zurück

Eine Zeichenfolge mit den Details des Fehlers.

Rückgabetyp

str

Attribute

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'