Graph QL

The GraphQL Asp.net Core controller.

Graph QL Get

Executes a GraphQL Query or Mutation based on the query arguments of a GET request.
It returns a GraphQLResponse in JSON format. The format of the response varies depending on the request.
For more details specific to GraphQL, see the GraphQL POST method (it is the recommended approach for working with GraphQL).

Request

GET /api/v1.0-preview/tenants/{tenantId}/namespaces/{namespaceId}/graphql
?graphql={graphql}&variables={variables}&operationName={operationName}&continuation={continuation}&metrics={metrics}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string graphql
The GraphQL query or mutation.

[optional] string variables
One or more named variables and their values that support the query. This is a serialized Dictionary<string, object?>. The object is the variable value and can be a scalar or any supported schema type or type collection (serialized JSON).

[optional] string operationName
The name of the operation.

[optional] string continuation
Additional data for querying the next page of data. Use this when the GraphQL response has a continuation token in its extension data.

[optional] boolean metrics
Enables collection of metrics. These are added to the GraphQL response in its extension data.

Response

Example response body

200 Response

{
  "data": {
    "events": {
      "upsertAlarm": [
        {
          "id": "alarm_0001"
        }
      ]
    }
  },
  "errors": [
    {
      "message": "Optimistic concurrency error",
      "path": [
        "Alarm[id: alarm_0002]"
      ],
      "extensions": {
        "code": "OPTIMISTIC_CONCURRENCY_ERROR"
      },
      "data": {
        "id": "alarm_0002"
      }
    }
  ]
}

Graph QL Post

Executes a GraphQL Query or Mutation based on the GraphQLRequest body content in a POST request.
The query or mutation will run against a loaded GraphQL schema that defines all the Types and APIs available for a namespace.
The request query property contains the GraphQL query or mutation.
The request variables property can be used to pass named values into a query or mutation. The value can be a scalar or any schema defined type or type collection (serialized JSON).
It returns a GraphQLResponse in JSON format. The format of the response varies depending on the request.

Request

POST /api/v1.0-preview/tenants/{tenantId}/namespaces/{namespaceId}/graphql
?continuation={continuation}&metrics={metrics}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

[optional] string continuation
Additional data for querying the next page of data. Use this when the GraphQL query response has a continuation token in its extension data.

[optional] boolean metrics
Enables collection of metrics. These are added to the GraphQL response in its extension data.

Request Body

A GraphQLRequest that represents a query or mutation.

{
  "query": "query ($varinput1: Int!) { referenceData { queryAlarmSeverityCat ( where: { severity: { gt: $varinput1 } } options: { sort: { severity: DESC }, count: 2 } ) { id color severity } } }",
  "variables": {
    "varinput1": 1
  }
}

Response

Example response body

200 Response

{
  "data": {
    "referenceData": {
      "queryAlarmSeverityCat": [
        {
          "id": "critical",
          "color": "red",
          "severity": 2
        },
        {
          "id": "notice",
          "color": "blue",
          "severity": 8
        }
      ]
    }
  },
  "errors": null,
  "extensions": {
    "continuation": "eyJJZCI6IjdhZGNkMzEwYzIxYjQ4MmM4MGRiZjQ4OTE3ZWZiM2FlIiwiVHlwZUlkIjoiQWxhcm1FdmVudFR5cGUifQ%3d%3d"
  }
}

Definitions

IGraphQLResponse

Properties

{
  "Data": null,
  "Errors": [
    {
      "Locations": [
        {
          "Column": 0,
          "Line": 0
        }
      ],
      "Message": "string",
      "Path": {
        "_items": [
          null
        ],
        "_size": 0,
        "Capacity": 0,
        "Count": 0,
        "Item": null
      },
      "Extensions": {}
    }
  ],
  "Extensions": {}
}

GraphQLError

Properties

{
  "Locations": [
    {
      "Column": 0,
      "Line": 0
    }
  ],
  "Message": "string",
  "Path": {
    "_items": [
      null
    ],
    "_size": 0,
    "Capacity": 0,
    "Count": 0,
    "Item": null
  },
  "Extensions": {}
}

GraphQLLocation

Properties

{
  "Column": 0,
  "Line": 0
}

ErrorPath

Properties

{
  "_items": [
    null
  ],
  "_size": 0,
  "Capacity": 0,
  "Count": 0,
  "Item": null
}

Map

{}

GraphQLRequest

Properties

{
  "OperationName": "string",
  "Query": "string",
  "Variables": {},
  "Extensions": {}
}

Inputs

{}