• Discover fields and objects available to query through introspection.
• Query the exact data you need from a component.
• Manage multiple possible queries from a single API, as opposed to multiple endpoints for a REST request.
• Integrate with third-party systems by making the schema public.
• Generate the GraphQL query from your component and handle the response.

• GraphQL knowledge to create a schema.
• JavaScript knowledge to define the API behavior.
• General knowledge of web component concepts.
• A custom Workspace component to consume record data.
• Understanding of the ServiceNow data model that you want to expose in the schema.
• GlideRecord knowledge to map fields to record data in your resolver scripts.

GraphQL Schema Definition Language (SDL)

Define the structure and data type of fields available in a GraphQL query. You can define the SDL using the Schema script field in the GraphQL Scripted Schemas [sys_graphql_schema] table. The SDL only supports Query and Mutation operations.

Resolvers

Define the data returned by each field. You can define the resolvers for each field in the GraphQL Scripted Resolvers related list on the GraphQL Scripted Schemas form.

Typeresolvers

Resolve interfaces and unions into concrete GraphQL types. For example, you might define a union between an incident type and a problem type. Use the typeresolver script to define when to return which. You can define the typeresolvers in the GraphQL Scripted Typeresolvers related list on the GraphQL Scripted Schemas form.

Resolver mappings

Map resolvers to fields in the schema. You can define resolver mappings in the GraphQL Scripted Resolver Mappings related list on the GraphQL Scripted Schemas form.

• Subscription operations
• Custom scalar types

Application namespace

The namespace for the custom application. To learn more about application namespaces, see Application scope.

Schema namespace

The namespace for the schema to ensure that all queries are unique. You can have multiple schema namespaces in a single application.

• Application namespace: x_graph_scope
• Schema namespace: planet

query {
  x_graph_scope {
    planet {
      findAll {
        name
        mass
        distance
      }
    }
  }
}

@source schema directive

Maps a GraphQL field to the value of a property of the parent object. If the field has a separate resolver script, the system uses the record that it resolves to instead of the parent object.

Use the @source directive in your schema script.

@defer query directive

Defer processing of a GraphQL fragment until later in the query. Use this query directive to delay returning data for slow-responding fields within a fragment. Stream the field results of the deferred fragment as a multi-part response.

Note:

To use the @defer directive, your GraphQL client must accept multipart/mixed HTTP headers. For example, set the HTTP headers to Accept: multipart/mixed; boundary="-".

Use the @defer directive to improve user time to interaction. Avoid applying this query directive indiscriminately as it can also cause performance degradations. Conduct performance testing to determine which fields can be deferred for better performance.

Resolver functions

These functions are available on the global env object.

• getArguments(): Returns the arguments of the previous field.
• getSource(): Returns the parent object.

Use in your resolver script.

Typeresolver functions

These functions are available on the global env object.

• getArguments(): Returns the arguments of the previous field.
• getObject(): Returns the parent object.
• getTypeName(): Returns the name of the interface or union type.

Use in your typeresolver script.