REST API
Overview
Herzum Approval exposes its data via REST Application Programming Interfaces (API) which allows you to build your own integrations with the app.
API Capabilities at the moment include:
Search information about approval items filtering by user, status and approval name
Operate on the issue approvals (APPROVE, REJECT, ABSTAIN, RESET)
Authentication
The Approval API relies on the underlying JIRA Authentication mechanism and the following are supported
OAuth
Basic Auth
Cookie Based Authentication
For detailed information about the Authentication mechanisms please refer to Atlassian JIRA Security Documentation
In particular:
In this section
Related Documentation
Here you can find some links to our customer documentation illustrating the effect of these customizations:
Need support?
We would love to help.
Using Postman
Postman is a popular tool for working with APIs. We have published a collection for testing and documentation using Postman.
VIEW INTERACTIVE DOCUMENTATION
Download the latest version of Postman from https://www.getpostman.com/ and then click this button to import our collection:
You are also able to .
The collection is available from the sidebar under "Collections":
The Collection comes with various example requests, that have been set up with Collection specific variables
Get Issue Approvals
The following API is for retrieving information about items still hanging into the approval stage.
Act on Requested Approvals
The following API is for performing operations on the items still hanging into the approval stage.
Bulk operations for Approval mapping
The following API performs bulk operations such as delete, copy, move, and edit on the Approval mapping configuration.
The feature is available in Approval plugin version 6.9 and later.
This REST service allows you to perform the same bulk operations as the plugin's graphical interface:
For execution limitations, see
Bulk Operations - Herzum Approval Documentation - Herzum's Confluence