Versions Compared

Old Version 20

changes.mady.by.user Kamil Zarychta

Saved on

compared with

New Version Current

changes.mady.by.user Kamil Zarychta

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Base path: https://app.approval-path.com/webapi

...

Definition

ref-id- In the case of Approval Path for Jira, this is issue project id or issue project key.

List

...

of project definitions

GET /approvalsapproval-definitions/{ref-id}Return example:

List of global definitions

GET /approval-definitions

Expand
titleExample response data
Code Block
languagejson
{
  "result": [
    {
      "id": "3853",
      "definitionIdname": "35users with create condition",
      "namedescription": "Approval Name",
      "summarycollectionId": "Ticket Summary"null,
      "collectionIdsteps": "10002",[
       "refId": "10004", {
      "steps": [   "type": "USER",
    {           "typeparallelGroupNumber": "USER"null,
          "statususerId": "SUCCESS557058:6e542a10-54a5-44e3-97b4-397df9caf04d",
          "userIdaction": "557058:aea7ac02-75c1-4f47-9beb-dd89777d4949NOTIFICATION",
          "displayName": "KrzysztofKamil BogdanZarychta",
          "avatarUrlslastUpdated": {null,
            "48x48issueWatchersNotification": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/557058:aea7ac02-75c1-4f47-9beb-dd89777d4949/f795c3d7-bee3-4444-9d39-0b18b81cb20b/48","ENABLED",
          "condition": {
            "32x32id": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/557058:aea7ac02-75c1-4f47-9beb-dd89777d4949/f795c3d7-bee3-4444-9d39-0b18b81cb20b/32", 2
          }
       "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/557058:aea7ac02-75c1-4f47-9beb-dd89777d4949/f795c3d7-bee3-4444-9d39-0b18b81cb20b/24",
  },
        {
          "16x16type": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/557058:aea7ac02-75c1-4f47-9beb-dd89777d4949/f795c3d7-bee3-4444-9d39-0b18b81cb20b/16"USER",
              }"parallelGroupNumber": null,
          "actionuserId": "STARTED557058:6e542a10-54a5-44e3-97b4-397df9caf04d",
          "decisionaction": "ACCEPTEDAPPROVAL",
          "decisionDatedisplayName": "2021-09-30T13:51:01.676+00:00"Kamil Zarychta",
        }  "lastUpdated": null,
   ],       "statusissueWatchersNotification": "ENABLED",
      "IN_PROGRESS"
    "condition": {
   }      ],   "totalCountid": 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}

Expand
titleExample body
Code Block
languagejson
{   "definitionId": "id",  }
"summary": "Approval summary. Usually issue/page title",
  "userId": "Atlassian user id"
}

Reset approval

Allows 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 approval path is reset via API. The creator of the API will be specified as the agent.

Expand
titleExample body
Code Block
languagejson
{
  "userId": "Atlassian user id"
}

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

Code Block
languagejson
{
  "createComment": true,
  "userId": "Atlassian user id"
}

This will reset the path and generate a comment.

Expand
titleExample response
Code Block
languagejson
{
    "result": [
        {
      },
        {
          "type": "USER",
          "parallelGroupNumber": null,
          "userId": "557058:6e542a10-54a5-44e3-97b4-397df9caf04d",
          "action": "CONSENT",
          "displayName": "Kamil Zarychta",
          "lastUpdated": null,
             "idissueWatchersNotification": "469ENABLED",
 
          "definitionIdcondition": "197",{
            "nameid": "QA",2
          }
      "summary": "QA-33 Demo}
task",      ],
      "collectionIdrejectionSteps": "10000",[],
      "createApprovalCondition": {
        "refIdid": 1
"10068",      },
      "stepsavailableForJSMCustomers": [false
    },
    {
      {
"id": "95",
            "name": "parallel group with rejection steps",
      "typedescription": "USER",
      "collectionId": null,
            "type"steps": "USER",[
         {
          "statustype": "SUCCESSUSER",
          "parallelGroupNumber": null,
          "userId": "6105b29ec51f3a0069c9ccda557058:6e542a10-54a5-44e3-97b4-397df9caf04d",
          "action": "APPROVAL",
          "displayName": "ParsaKamil ShivaZarychta",
          "lastUpdated": null,
          "parallelGroupNumberissueWatchersNotification": null"ENABLED"
        },
         {
          "avatarUrlstype": {"USER",
             "parallelGroupNumber": 1,
          "48x48userId": "https://secure.gravatar.com/avatar/2ed481ded6c12e2eeb9e41992258c212?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-0.png",
557058:6e542a10-54a5-44e3-97b4-397df9caf04d",
          "action": "APPROVAL",
          "displayName": "Kamil Zarychta",
          "32x32lastUpdated": "https://secure.gravatar.com/avatar/2ed481ded6c12e2eeb9e41992258c212?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-0.pngnull,
          "issueWatchersNotification": "ENABLED",
          "condition": {
            "24x24": "https://secure.gravatar.com/avatar/2ed481ded6c12e2eeb9e41992258c212?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-0.png",id": 3
          }
        },
        {
          "16x16type": "https://secure.gravatar.com/avatar/2ed481ded6c12e2eeb9e41992258c212?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-0.png""EMAIL",
          "parallelGroupNumber": 1,
          "email": "kamilzarychta@gmail.com",
         }, "action": "APPROVAL",
                  "action"issueWatchersNotification": "STARTEDENABLED",
        },
        {
          "decisiontype": "ACCEPTEDGROUP",
          "parallelGroupNumber": 1,
          "decisionDategroupId": "2022-09-26T15:32:42.340+00:0083ebf594-d9e8-44c6-8ef6-db8a152d0009",
          "action": "APPROVAL",
          "lastUpdatedrequiredVotes": "2022-09-26T17:32:42+02:00"
1,
          "requiredRejectVotes": 3,
               }"displayName": "administrators",
          "approvalCreatorExcluded": false,
    {          "skipFromApprovalWhenEmpty": false,
          "typeissueWatchersNotification": "USERENABLED",
        }
      ],
      "typerejectionSteps": "USER",[
         {
          "statustype": "SUCCESSHTTP",
            "parallelGroupNumber": null,
          "userIdname": "6105b29ec51f3a0069c9ccdawebhook2",
          "httpMethod": "GET",
          "displayNameurlTemplate": "Parsa Shivahttps://webhook.site/d42d1f3d-74a8-433e-b5a3-961d46505fe4?test=test",
          "headersTemplate": "",
          "parallelGroupNumberbodyTemplate": null, "                ",
          "action": "NOTIFICATION",
          "issueWatchersNotification": "DISABLED"
        }
      ],
      "createApprovalCondition": null,
      "availableForJSMCustomers": false
    }
  ],
  "totalCount": 2
}

Approval

ref-id- In the case of Approval Path for Jira, this is issue id or issue key.

List approvals

GET /approvals/{ref-id}

Return example:

Expand
titleExample response data
Code Block
languagejson
{
  "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}

Expand
titleExample body
Code Block
languagejson
{
  "definitionId": "id",
  "summary": "Approval summary. Usually issue/page title",
  "userId": "Atlassian user id"
}

...

Reset approval

Allows 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 approval path is reset via API. The creator of the API will be specified as the agent.

Expand
titleExample body
Code Block
languagejson
{
  "userId": "Atlassian user    id"
}

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

Code Block
languagejson
{
  "avatarUrlscreateComment": {
                     true,
  "48x48userId": "https://secure.gravatar.com/avatar/2ed481ded6c12e2eeb9e41992258c212?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-0.png",
 Atlassian user id"
}

This will reset the path and generate a comment.

Expand
titleExample response
Code Block
languagejson
{
    "result": [
                "32x32": "https://secure.gravatar.com/avatar/2ed481ded6c12e2eeb9e41992258c212?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-0.png",{
            "id": "469",
            "24x24definitionId": "https://secure.gravatar.com/avatar/2ed481ded6c12e2eeb9e41992258c212?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-0.png"197",
            "name": "Bussines trip",
            "summary": "TRA-33 Trip to Vegas",
            "16x16collectionId": "https://secure.gravatar.com/avatar/2ed481ded6c12e2eeb9e41992258c212?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-0.png"10000",
            "refId": "10068",
      },      "steps": [
             "action": "APPROVAL",   {
                    "decisiontype": "ACCEPTEDUSER",
                    "decisionDatetype": "2022-09-26T15:32:52.128+00:00USER",
                    "lastUpdatedstatus": null"SUCCESS",
                    "userId": "6105b29ec51f3a0069c9ccda",
     },               "displayName": "Parsa {Shiva",
                    "typeparallelGroupNumber": "USER"null,
                    "typeaction": "USERSTARTED",
                    "statusdecision": "SUCCESSACCEPTED",
                    "userIddecisionDate": "6299df401648f2006963deb82022-09-26T15:32:42.340+00:00",
                    "displayNamelastUpdated": "Jessica Smith",2022-09-26T17:32:42+02:00"
                    "parallelGroupNumber": null},
                    "avatarUrls": {
                        "48x48type": "https://secure.gravatar.com/avatar/3f5cd3c6792bea81a464bbb4a2b62396?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FJS-6.png",USER",
                    "type": "USER",
           "32x32         "status": "https://secure.gravatar.com/avatar/3f5cd3c6792bea81a464bbb4a2b62396?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FJS-6.png",SUCCESS",
                    "userId": "6105b29ec51f3a0069c9ccda",
          "24x24          "displayName": "https://secure.gravatar.com/avatar/3f5cd3c6792bea81a464bbb4a2b62396?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FJS-6.png",Parsa Shiva",
                    "parallelGroupNumber": null,
         "16x16           "action": "https://secure.gravatar.com/avatar/3f5cd3c6792bea81a464bbb4a2b62396?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FJS-6.png"APPROVAL",
                    } "decision": "ACCEPTED",
                    "actiondecisionDate": "APPROVAL2022-09-26T15:32:52.128+00:00",
                    "decisionlastUpdated": "ACCEPTED", null
                },
              "decisionDate": "2022-09-27T09:23:07.459+00:00",  {
                    "lastUpdatedtype": null "USER",
                    },"type": "USER",
                 {   "status": "SUCCESS",
                    "typeuserId": "USER6299df401648f2006963deb8",
                    "typedisplayName": "USERJessica Smith",
                    "statusparallelGroupNumber": "SUCCESS"null,
                    "userIdaction": "6299df401648f2006963deb8APPROVAL",
                    "displayNamedecision": "Jessica SmithACCEPTED",
                    "decisionDate"parallelGroupNumber": null: "2022-09-27T09:23:07.459+00:00",
                    "avatarUrlslastUpdated": {null
                },
       "48x48": "https://secure.gravatar.com/avatar/3f5cd3c6792bea81a464bbb4a2b62396?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FJS-6.png",         {
                    "32x32type": "https://secure.gravatar.com/avatar/3f5cd3c6792bea81a464bbb4a2b62396?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FJS-6.png",
   USER",
                    "type": "USER",
                    "24x24status": "https://secure.gravatar.com/avatar/3f5cd3c6792bea81a464bbb4a2b62396?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FJS-6.png",
   SUCCESS",
                    "userId": "6299df401648f2006963deb8",
                    "16x16displayName": "https://secure.gravatar.com/avatar/3f5cd3c6792bea81a464bbb4a2b62396?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FJS-6.png"Jessica Smith",
                    "parallelGroupNumber": }null,
                    "action": "APPROVAL",
                    "decision": "ACCEPTED",
                    "decisionDate": "2022-09-27T09:23:10.706+00:00",
                    "lastUpdated": null
                }
            ],
            "status": "SUCCESS",
            "activeSteps": [],
            "modificationDate": "2022-09-27T09:23:10.706+00:00"
        }
    ],
    "totalCount": 1
}