Dynatrace · JSON Structure

Dynatrace Entities V2 Error Envelope Structure

Error response envelope returned when a request fails.

Type: object Properties: 1
AI OperationsAnalyticsAPMApplication Performance MonitoringApplication SecurityAutomationCloud MonitoringDigital Experience ManagementIntelligenceObservability

ErrorEnvelope is a JSON Structure definition published by Dynatrace, describing 1 property. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

error

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑
{
  "type": "object",
  "description": "Error response envelope returned when a request fails.",
  "name": "ErrorEnvelope",
  "properties": {
    "error": {
      "type": "object",
      "description": "Details of an API error.",
      "properties": {
        "code": {
          "type": "integer",
          "description": "The HTTP status code of the error."
        },
        "message": {
          "type": "string",
          "description": "A human-readable description of the error."
        },
        "constraintViolations": {
          "type": "array",
          "description": "A list of constraint violations for validation errors (HTTP 400).",
          "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."
              },
              "message": {
                "type": "string",
                "description": "A description of the constraint violation."
              },
              "parameterLocation": {
                "type": "string",
                "description": "The location of the violating parameter (QUERY, PATH, BODY)."
              },
              "location": {
                "type": "string",
                "description": "The location detail for the violation."
              }
            }
          }
        }
      }
    }
  },
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}