Comment on page
Error models
This article describes API error formats
A machine-readable format for specifying errors in HTTP API responses based on https://tools.ietf.org/html/rfc7807.
Name | Type | Description |
---|---|---|
type | string? | A URI reference [RFC3986] that identifies the problem type. |
title | string? | A short, human-readable summary of the problem type. |
status | int? | The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. |
detail | string? | A human-readable explanation specific to this occurrence of the problem. |
instance | string? | A request URI path. |
traceId | string? | Unique identifier to represent this request in trace logs. |
errorCode | int? | |
resource |
Name | Type | Description |
---|---|---|
errors | Collection of errors. Each element represents one broken validation rule. |
Name | Type | Description |
---|---|---|
memberName | string | Property name. |
message | string | Message that describes error. |
code | string? |
Name | Type | Description |
---|---|---|
name | string | |
id | string | Unique resource identifier |
version | int? | Resource version |
Last modified 1yr ago