Camunda GraphQL

Camunda GraphQL is a Community Extension for Camunda BPM that allows you to use GraphQL to query and mutate Process Engine data in a simple way.

Installation

1. Build and deploy the WAR file of this project to your Camunda BPM Server.
   Use Application Context /graphql.
   That's it. You added GraphQL to Camunda BPM at http://<server-name>:<PORT>/graphql

   If you use tomcat, you could deplay your war with Manager App to test the graphql, see: camunda-community-hub#10 (comment)

2. Optional: To play around with GraphQL we highly encourage you to install GraphiQL.
   

   You can google for GraphiQL or install GraphiQL from these places:
   

   • https://github.com/redound/graphql-ide
     (Windows, Mac OS X)

   • https://github.com/skevy/graphiql-app
     Mac User just type: brew cask install graphiql
     Windows/Linux User:

     • npm install -g electron
       
     • download graphiql-app zip/tar.gz from https://github.com/skevy/graphiql-app/releases
       
     • unzip
     • electron <app-folder> with app-folder = GraphiQL.app/Contents/Resources/app

   • https://github.com/graphql/graphiql

   Configure GraphiQL to point to the GraphQL endpoint as defined in step 1.
   
   Basic Authentication:
   You must add an Authorization-Header to your GraphQL-request!
   Example for user 'demo' and 'password 'demo' is:
   Key='Authorization'
   Value='Basic ZGVtbzpkZW1v'
   

   In GraphiQL (graphiql-app) there is a link 'Edit HTTP headers' where you can adjust your request headers.

   
   

Example Queries

###Fetch all Tasks:

(on the left side is the query we just typed in. After pressing the Play-Button on top the result appears on the right side. )

###Fetch Tasks with Filter:

(Queries are based on the Camunda Process Engine API)

Example Mutation

###Set the assignee of a specific Task:

(Here it's specified that the fields id, name and assignee should be returned after the mutation.)

Camunda GraphQL Types (automatically generated documentation)

###Fields of a Task (TaskEntity)

Camunda Forum Thread (initial)

https://forum.camunda.org/t/developing-the-camunda-graphql-extension