ODataV4Format Classe

  • Referência

Classe para descrever o formato de erro OData V4.

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

Exemplo de JSON:

error: { "code": "ValidationError", "message": "Um ou mais campos contêm valores incorretos: ", "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))."

  }

]

}

Herança
builtins.object
ODataV4Format

Construtor

ODataV4Format(json_object: Mapping[str, Any])

Parâmetros

json_object
dict
Obrigatório

Um dict do Python que representa um JSON ODataV4

Variáveis

~.code
str

Seu valor é um código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.

message
str

Representação legível e dependente de idioma do erro.

target
str

O destino do erro específico (por exemplo, o nome da propriedade em erro). Esse campo é opcional e pode ser Nenhum.

details
list[ODataV4Format]

Matriz de instâncias ODataV4Format que DEVEM conter pares nome/valor para código e mensagem e PODE conter um par nome/valor para o destino, conforme descrito acima.

innererror
dict

Um objeto. O conteúdo desse objeto é definido pelo serviço. Normalmente, esse objeto contém informações que ajudarão a depurar o serviço.

Métodos

message_details

Retornar uma cadeia de caracteres detalhada do erro.

message_details

Retornar uma cadeia de caracteres detalhada do erro.

message_details() -> str

Retornos

Uma cadeia de caracteres com os detalhes do erro.

Tipo de retorno

str

Atributos

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'