API

We expose some parts of Approval Path functionality by API.

Authorization

You have to generate an API key in our app.

It is available in the Approval Path global view:

Click “Apps” on the top menu,
Click Approval Path,
Go to the API Keys tab,
Click “Create a new API Key”.

Setup your API key and copy or download it. The template has the following fields:

Key name - provide your name for the API key, up to 40 characters long.
Key value - non-modifiable field, shows the value of the key.
Reveal - reveals the key. This is NOT one time operation - you can reveal the key at any time.
Download - downloads the key to the selected location.
Get page approval status - determines whether list approval for page operation is allowed for the key.
List approval definitions - determines whether list approval definition operation is allowed for the key.
Create approval for page - determines whether create operation is allowed for the key.
Delete approval - determines whether delete operation is allowed for the key.
Allow change performer origin - presents a valuable customization capability for users, empowering them to personalize change performer. Once checked, users are granted the flexibility to adjust performer origin according to their chosen parameters.

Change Performer Origin select offers three distinct options:

User - to ensure smooth operations, it is essential to select a valid user as the new performer. This can be done by utilizing the option that allows the selection of a specific user.
Page creator - you to set user who created the page as the new change performer. In cases where the field does not have a valid user, you have the option to assign a default page creator to ensure continuity.
Page modifier - you can set user who last modified the page as the new change performer. In instances where the field lacks a valid user, you retain the option to select a default page modifier, ensuring a smooth transition in the performer's origin.
User from API call - API call body parameter allows for the passing of a user id. User ids can be limited to users from a designated group. In cases where the submitted user id is empty or does not contain a valid user, a default user can be selected. However, if the submitted user does not belong to the specified group, an error will be returned.

Not valid before - set the start date for key validity.
Not valid after - set the invalidation date for the key.
Allowed IPs - set IPs or IP range that can use the key.
Description - description of the key. Maximum 4000 characters.
Creation time - non-modifiable field, the time when the key was created.
Last modified - non-modifiable field, the time when the key was last modified.
Last usage - non-modifiable field, the time when the key was last used.
Usage Count - non-modifiable field, counter that shows how many times the key was used.

Using the Web API with API key

With key generated, you can now make a call to Web API. First of all, set Authorization and Content-Type headers in your REST client.

Authorization: Bearer mc96LyRi9nUQySSjKXEf8xfqUZzjS2CYhRK8bWSRRfQi
Content-Type: 'application/json'

Definition

ref-id- In the case of Approval Path for Jira, this is space id.

List of space definitions

GET /approval-definitions/{ref-id}

List of global definitions

GET /approval-definitions

{
  "result": [
    {
      "id": "45",
      "name": "with rejection steps",
      "description": "",
      "collectionId": null,
      "steps": [
        {
          "type": "USER",
          "parallelGroupNumber": 1,
          "userId": "557058:6e542a10-54a5-44e3-97b4-397df9caf04d",
          "action": "CONSENT",
          "displayName": "Kamil Zarychta",
          "lastUpdated": null,
          "issueWatchersNotification": "ENABLED"
        },
        {
          "type": "EMAIL",
          "parallelGroupNumber": 1,
          "email": "kamilzarychta@gmail.com",
          "action": "NOTIFICATION",
          "issueWatchersNotification": "ENABLED"
        },
        {
          "type": "HTTP",
          "parallelGroupNumber": 1,
          "name": "webhook",
          "httpMethod": "POST",
          "urlTemplate": "https://webhook.site/d42d1f3d-74a8-433e-b5a3-961d46505fe4?test=test",
          "headersTemplate": "Content-Type: application/json\nAccept: application/json",
          "bodyTemplate": "{\"pages\":[\"${ref.id}\"]}",
          "action": "NOTIFICATION",
          "issueWatchersNotification": "DISABLED"
        }
      ],
      "rejectionSteps": [
        {
          "type": "HTTP",
          "parallelGroupNumber": null,
          "name": "asd",
          "httpMethod": "POST",
          "urlTemplate": "https://2e98-91-220-222-198.ngrok-free.app/connect/jira/webhook-with-message",
          "headersTemplate": "",
          "bodyTemplate": "                ",
          "action": "NOTIFICATION",
          "issueWatchersNotification": "DISABLED"
        }
      ],
      "availableForJSMCustomers": false
    },
    {
      "id": "98",
      "name": "only confluence users",
      "description": "",
      "collectionId": null,
      "steps": [
        {
          "type": "GROUP",
          "parallelGroupNumber": null,
          "groupId": "06a60c65-1cb8-4ea8-997a-3dc3dafc6ceb",
          "action": "APPROVAL",
          "requiredVotes": 1,
          "requiredRejectVotes": 1,
          "displayName": "confluence-users",
          "approvalCreatorExcluded": true,
          "skipFromApprovalWhenEmpty": false,
          "issueWatchersNotification": "ENABLED"
        }
      ],
      "rejectionSteps": [],
      "availableForJSMCustomers": false
    }
  ],
  "totalCount": 2
}

Approval

ref-id- In the case of Approval Path for Confluence, this is page id.

List approvals

GET /approvals/{ref-id}

Return example:

{
  "result": [
    {
      "id": "38",
      "definitionId": "35",
      "name": "Approval Name",
      "summary": "Ticket Summary",
      "collectionId": "10002",
      "refId": "10004",
      "steps": [
        {
          "type": "USER",
          "status": "SUCCESS",
          "userId": "557058:aea7ac02-75c1-4f47-9beb-dd89777d4949",
          "displayName": "Krzysztof Bogdan",
          "action": "STARTED",
          "decision": "ACCEPTED",
          "decisionDate": "2021-09-30T13:51:01.676+00:00"
        }
      ],
      "status": "IN_PROGRESS"
    }
  ],
  "totalCount": 1
}

When Change Performer Origin 'USER' is selected for API key approval create and reset requests can be extended to include the userId field.

Create approval

POST /approvals/{ref-id}

Reset approval

Allows the user to reset ongoing or finalized approval path on an issue.

POST /approvals/{ref-id}/reset

Body parameters
createComment - Default false. If true, will generate a comment when the approval path is reset via API. The creator of the API will be specified as the agent.

This will reset the approval path - by default no comment will be generated.

This will reset the path and generate a comment.