API

GET /o/graphql/schema

Description

This endpoint allows the retrieval of the current GraphQL schema.

GET /o/graphql/api

Description

This endpoint will execute a GraphQL query specified in the parameters.

Parameters

Name	Mandatory	Description
query	true	Defines the GraphQL query to be executed
operationName	false	Defines which operation should be executed if the query contains multiple operations
variables	false	Defines the query variables as JSON encoded string

Example request

GET /o/graphql/api?query={me{name}}

Example response

{
  "data": { ... },
  "errors": [ ... ],
  "extensions": {
      "tracing": { ... }
  }
}

The data will contain the returned objects from the GraphQL query. The errors will contain an array of issues encountered during the processing of the query. Might not be sent. The extensions.tracing will contain tracing information of the query. Might not be sent.

POST /o/graphql/api with JSON content

Description

This endpoint will execute a GraphQL query specified in the body. The body contains a JSON object defining the GraphQL query, the operation to execution if multiple are available and the variables values if needed.

Parameters

None

Headers

• Content-Type: application/json

Body

Name	Mandatory	Description
query	true	Defines the GraphQL query to be executed
operationName	false	Defines which operation should be executed if the query contains multiple operations
variables	false	Defines the query variables as JSON encoded string

Example request

POST /o/graphql/api

{
  "query": "...",
  "operationName": "...",
  "variables": { "myVariable": "someValue", ... }
}

Example response

{
  "data": { ... },
  "errors": [ ... ],
  "extensions": {
      "tracing": { ... }
  }
}

The data will contain the returned objects from the GraphQL query. The errors will contain an array of issues encountered during the processing of the query. Might not be sent. The extensions.tracing will contain tracing information of the query. Might not be sent.

POST /o/graphql/api with GraphQL query

This endpoint will execute a GraphQL query specified in the body. The latter will contain only the GraphQL query that will be executed.

Parameters

None

Headers

• Content-Type: application/graphql

Body

The body will contain the GraphQL query directly. For example:

{
  me {
    name
  }
}

Example request

POST /o/graphql/api

{
  me {
    name
  }
}

Example response

{
  "data": { ... },
  "errors": [ ... ],
  "extensions": {
      "tracing": { ... }
  }
}

The data will contain the returned objects from the GraphQL query. The errors will contain an array of issues encountered during the processing of the query. Might not be sent. The extensions.tracing will contain tracing information of the query. Might not be sent.