RMsis provides GraphQL API's on all major entities and relationships. You can use these API's to develop integrations between RMsis and other applications. This guide will help you to understand how to access and utilise these API's.
This section covers primary information needed to access RMsis API's
JIRA API Authentication
RMsis API endpoint i.e. <JIRA_BASE_URL>/rest/service/latest/rmsis/graphql is part of RMsis plugin.
So, you will need to access JIRA authentication API to receive authentication token and subsequently you can access RMsis API endpoint.
GraphQL returns media type application/json as response. HTTP Code 200 or 400 is provided depending upon errors in response. Structure of this response is,
GraphQL Response JSON
//contains data response
//optional list of error while executing api
//if there is any error in response, http status code will be 404.
As per GraphQL standard, API's in RMsis are divided in two operation structures, query and mutation types.
API to retrieve any entity or relationships are part of query type. General structure for these API's are
API to create, update, or delete are part of mutation type. General structure for these API's are
More information about Structure of API's can be obtained from GraphQL Schema file.
Permissions granted to users are same as the ones configured for a specific user.
RMsis provides GraphiQL Playground (https://github.com/graphql/graphiql) build along side RMsis plugin for API documentation and testing API calls against your system. It can be accessed from your JIRA Menu Bar >> RMsis >> API Playground (<Jira_base_url>/secure/ApiPlayground.jspa). A view of the GraphiQL user interface is presented below:
Few samples based on RMsis GraphQL,
Here are links to some applications created using RMsis GraphQL,