• Reference
  • Nodes
  • Resources
  • GraphQL

GraphQL Resource

The GraphQL Resource provides an easy way to connect to a GraphQL API of your choosing.

Properties

Environment Profiles

Propprofiles
Typearray
Default[ { 'baseURL': '', 'headers': [ { 'key': 'Content-Type', 'value': 'application/json' } ], 'method': 'POST', 'query': 'query { books { id, title } }', 'variables': '{}', 'healthcheckQuery': 'query { books { id, title } }', 'environment': '' } ]

The profiles configured for this resource in an environment

Environment Profile

Propprofiles[]
Typeobject

A profile of this resource for an environment

Base URL

Propprofiles[].baseURL
Typestring

The base URL for the GraphQL API request.

Headers

Propprofiles[].headers
Typearray

The header values to use for the GraphQL API request.

Header

Propprofiles[].headers[]
Typeobject

A key-value pair to attach to the headers of the request

Header key

Propprofiles[].headers[].key
Typestring

The key of the header

Header value

Propprofiles[].headers[].value
Typestring

The value of the specified header

Method

Propprofiles[].method
Typestring

The GraphQL request methods.

Query

Propprofiles[].query
Typestring

The content for the query.

Variables

Propprofiles[].variables
Typeunknown

Variable values for the query.

Health-check Query

Propprofiles[].healthcheckQuery
Typestring

Query for testing connection to server

Environment

Propprofiles[].environment
Typestring

The name of the environment with which this profile is associated

Actions

Perform GraphQL request

Makes a GraphQL request over HTTP(S) to the specified API endpoint.

ParameterTypeDefault
pathstringundefined
querystringquery { books { id, title } }
variablesunknown{'n':10}
headersarray[ { 'key': 'Content-Type', 'value': 'application/json' }]
methodHTTPMethodTypes ("GET" | "POST" | "PUT" | "DELETE" | "OPTIONS")POST
Last updated on November 1, 2022