ErrorResponse

Business ManagementDynamics NAVERPFinanceInventoryMicrosoftNavision

Properties

Name Type Description
code string A stable error code describing the type and nature of the error
message string A readable description of the error and cause
target string Information about what part of the request caused the error
extensionData object Additional key/value information about the error
clientError array Nested list of error objects with more details
View JSON Schema on GitHub

JSON Schema

navision-errorresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ErrorResponse",
  "title": "ErrorResponse",
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "A stable error code describing the type and nature of the error",
      "example": "example_value"
    },
    "message": {
      "type": "string",
      "description": "A readable description of the error and cause",
      "example": "example_value"
    },
    "target": {
      "type": "string",
      "description": "Information about what part of the request caused the error",
      "example": "example_value"
    },
    "extensionData": {
      "type": "object",
      "description": "Additional key/value information about the error",
      "additionalProperties": true,
      "example": "example_value"
    },
    "clientError": {
      "type": "array",
      "description": "Nested list of error objects with more details",
      "items": {
        "$ref": "#/components/schemas/ErrorResponse"
      },
      "example": []
    }
  }
}