Skip to main content
All CollectionsCHR Enterprise API
Navigating the CHR Enterprise API schema (GraphQL Voyager)
Navigating the CHR Enterprise API schema (GraphQL Voyager)
Updated over 6 months ago

The CHR Entreprise API schema leverages GraphQL Voyager to allow you to explore the capabilities of the CHR Enterprise API. It defines the supported queries and mutations and shows how all elements in the schema relate to each other, using arrows to show the connections between types.

To view and navigate the schema, go to the CHR Entreprise API documentation.

📌 Note: The schema represents the current production version of the API and is therefore the most up-to-date documentation on what is available in the API.

GraphQL Voyager has three main components:

  • The Type List in the left panel to explore available queries and mutations, and their supported arguments.

  • The data graph in the centre. The graph responds to what is selected in the Type List and option panel.

  • The options panel at the bottom to set filters and switch between queries and mutations.

Queries

To review the list of available queries and their supported arguments:

  1. Ensure Query is selected in the options panel (selected by default).

  2. In the Type List, click Query root.
    The list of supported queries is displayed in the Type List, along with their description, arguments (in orange) and returned type (in blue).

  3. Click a query to expand it and see a description of the supported arguments.

  4. Click an argument (in dark red) or an input to view more details.

  5. Click the returned type (in blue) to view the type and its supported fields for the query.

    📌 Note: Required fields are indicated by an exclamation mark.

Mutations

To review the list of available mutations and their supported inputs:

  1. In the options panel at the bottom, click Query. A list of all the types in the schema is displayed.

  2. In the list of types, click Mutation.

  3. In the Type List, click Mutation root.
    The list of supported mutations is displayed in the Type List, along with their description, arguments (in orange) and returned type (in blue).

  4. Click a mutation to expand it and see a description of the supported arguments.

  5. Click an input to expand it and view more details. A list of the supported fields for that mutation appears.

  6. Click the returned type (in blue) to view the type and its supported fields for the mutation.

    📌 Note: Required fields are indicated by an exclamation mark.

Updated May 17, 2024

Did this answer your question?