With GraphQL endpoints, Datahub allows integrating Pimcore to other systems and services via GraphQL and test them with the integrated GraphiQL explorer tool right away.
Configuration takes place in the endpoint configuration and offers following possibilities:
Depending on the configuration, the endpoint provides several queries to fetch data from Pimcore. As Datahub always creates a proper graphQL schema, also have a look at the generated schema to get details for the possible queries of a certain endpoint.
On the following pages certain generic aspects are explained, and a couple of samples are listed:
- For details on Document queries see Document Query Documentation.
- For details on Asset queries see Asset Query Documentation.
- For details on DataObjects queries see DataObject Query Documentation.
- For details on how to add custom queries see Add Custom Queries Documentation.
Depending on the configuration, the endpoint provides several mutations to update data in Pimcore. As Datahub always creates a proper graphQL schema, also have a look at the generated schema to get details for the possible mutations of a certain endpoint.
See following pages for a general overview of possible mutations:
- For details on Document mutations see Document Mutation Documentation
- For details on Asset mutations see Asset Mutation Documentation
- For details on DataObject mutations see DataObject Mutation Documentation
- For details on how to add custom mutations see Add Custom Mutations Documentation.
GraphiQL explorer can be opened for an endpoint in an iframe within Pimcore or as an additional browser tab.
It is possible to customize default behavior of graphQL endpoint with event listeners. For details see Events Documentation.