Dynatrace · Schema

ErrorEnvelope

Error response envelope returned when a request fails.

AI OperationsAnalyticsAPMApplication Performance MonitoringApplication SecurityAutomationCloud MonitoringDigital Experience ManagementIntelligenceObservability

Properties

Name Type Description
error object Details of an API error.
View JSON Schema on GitHub

JSON Schema

dynatrace-log-monitoring-v2-error-envelope-schema.json Raw ↑
{
  "type": "object",
  "description": "Error response envelope returned when a request fails.",
  "properties": {
    "error": {
      "type": "object",
      "description": "Details of an API error.",
      "properties": {
        "code": {
          "type": "integer",
          "description": "The HTTP status code of the error.",
          "example": 500
        },
        "message": {
          "type": "string",
          "description": "A human-readable description of the error.",
          "example": "Example description."
        },
        "constraintViolations": {
          "type": "array",
          "description": "A list of constraint violations for validation errors (HTTP 400).",
          "example": [
            {
              "path": "example-value",
              "message": "Example description.",
              "parameterLocation": "example-value",
              "location": "example-value"
            }
          ],
          "items": {
            "type": "object",
            "description": "Details of a single constraint violation in a request.",
            "properties": {
              "path": {
                "type": "string",
                "description": "The JSON path to the field that caused the violation.",
                "example": "example-value"
              },
              "message": {
                "type": "string",
                "description": "A description of the constraint violation.",
                "example": "Example description."
              },
              "parameterLocation": {
                "type": "string",
                "description": "The location of the violating parameter (QUERY, PATH, BODY).",
                "example": "example-value"
              },
              "location": {
                "type": "string",
                "description": "The location detail for the violation.",
                "example": "example-value"
              }
            }
          }
        }
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ErrorEnvelope"
}