GraphQLError

A GraphQL error

CMSCommunitiesCRMCustomer PortalDigital ExperienceExperience CloudPartner Portal

Properties

Name Type Description
message string Human-readable error message
locations array Locations in the query where the error occurred
path array Path to the field that caused the error
extensions object Additional error details
View JSON Schema on GitHub

JSON Schema

salesforce-experience-cloud-graphqlerror-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GraphQLError",
  "title": "GraphQLError",
  "type": "object",
  "description": "A GraphQL error",
  "properties": {
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "locations": {
      "type": "array",
      "description": "Locations in the query where the error occurred",
      "items": {
        "type": "object",
        "properties": {
          "line": {
            "type": "integer"
          },
          "column": {
            "type": "integer"
          }
        }
      }
    },
    "path": {
      "type": "array",
      "description": "Path to the field that caused the error",
      "items": {
        "type": "string"
      }
    },
    "extensions": {
      "type": "object",
      "description": "Additional error details",
      "properties": {
        "errorCode": {
          "type": "string"
        },
        "classification": {
          "type": "string"
        }
      },
      "additionalProperties": true
    }
  }
}