Versions Compared

Old Version 8

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.

...

  • Key name - provide your name for the API key, up to 40 characters long.

  • Key value - non-modifable 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.

...

  • 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-modifable modifiable field, the time when the key was created.

  • Last modified - non-modifable modifiable field, the time when the key was last modified.

  • Last usage - non-modifable modifiable field, the time when the key was last used.

  • Usage Count - non-modifable modifiable field, counter that shows how many times the key was used.

...

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

...

Definition

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

List

...

of space definitions

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

List of global definitions

GET /approval-definitions

Expand
titleExample response data
Code Block
languagejson
{
  "result": [
    {
      "id": "3845",
      "definitionIdname": "35with rejection steps",
      "namedescription": "Approval Name",
      "summarycollectionId": "Ticket Summary"null,
      "collectionIdsteps": "10002",[
      "refId": "10004",
      "steps": [         {
          "type": "USER",
          "statusparallelGroupNumber": "SUCCESS"1,
          "userId": "557058:aea7ac026e542a10-75c154a5-4f4744e3-9beb97b4-dd89777d4949397df9caf04d",
          "displayNameaction": "Krzysztof BogdanCONSENT",
          "avatarUrlsdisplayName": {
 "Kamil Zarychta",
          "48x48lastUpdated": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/557058:aea7ac02-75c1-4f47-9beb-dd89777d4949/f795c3d7-bee3-4444-9d39-0b18b81cb20b/48", null,
             "32x32issueWatchersNotification": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/557058:aea7ac02-75c1-4f47-9beb-dd89777d4949/f795c3d7-bee3-4444-9d39-0b18b81cb20b/32",
 "ENABLED"
        },
        {
          "24x24type": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/557058:aea7ac02-75c1-4f47-9beb-dd89777d4949/f795c3d7-bee3-4444-9d39-0b18b81cb20b/24","EMAIL",
            "16x16parallelGroupNumber": 1,
          "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/557058:aea7ac02-75c1-4f47-9beb-dd89777d4949/f795c3d7-bee3-4444-9d39-0b18b81cb20b/16"email": "kamilzarychta@gmail.com",
           }"action": "NOTIFICATION",
          "actionissueWatchersNotification": "STARTED",ENABLED"
        },
      "decision": "ACCEPTED",  {
          "decisionDatetype": "2021-09-30T13:51:01.676+00:00"HTTP",
        }  "parallelGroupNumber": 1,
   ],       "statusname": "IN_PROGRESSwebhook",
    }   ],   "totalCounthttpMethod": "POST",
 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
{   "definitionId": "id",   "summaryurlTemplate": "Approval summary. Usually issue/page title",https://webhook.site/d42d1f3d-74a8-433e-b5a3-961d46505fe4?test=test",
          "userIdheadersTemplate": "Atlassian user 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.

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

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

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

This will reset the path and generate a comment.

Expand
Code Block
languagejson
{Content-Type: application/json\nAccept: application/json",
          "bodyTemplate": "{\"pages\":[\"${ref.id}\"]}",
          "action": "NOTIFICATION",
          "issueWatchersNotification": "DISABLED"
        }
      ],
      "resultrejectionSteps": [
        {

           "idtype": "469HTTP",
 
          "definitionIdparallelGroupNumber": "197"null,
 
          "name": "QAasd",
            "summaryhttpMethod": "QA-33 Demo taskPOST",
 
          "collectionIdurlTemplate": "10000",
 https://2e98-91-220-222-198.ngrok-free.app/connect/jira/webhook-with-message",
          "refIdheadersTemplate": "10068",
            "stepsbodyTemplate": ["                ",
{            "action": "NOTIFICATION",
          "typeissueWatchersNotification": "USERDISABLED",
        }
      ],
      "typeavailableForJSMCustomers": "USER" false
    },
    {
      "id": "98",
       "statusname": "SUCCESSonly confluence users",
      "description": "",
      "collectionId": null,
      "userIdsteps": "6105b29ec51f3a0069c9ccda",[
        {
           "displayNametype": "Parsa ShivaGROUP",
          "parallelGroupNumber": null,
          "parallelGroupNumbergroupId": null"06a60c65-1cb8-4ea8-997a-3dc3dafc6ceb",
          "action": "APPROVAL",
          "avatarUrlsrequiredVotes": {1,
          "requiredRejectVotes": 1,
            "48x48displayName": "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""confluence-users",
          "approvalCreatorExcluded": true,
             "skipFromApprovalWhenEmpty": false,
          "32x32issueWatchersNotification": "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",
  "ENABLED"
        }
      ],
      "rejectionSteps": [],
      "24x24availableForJSMCustomers": "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",
                        "16x16": "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"
         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:

Expand
titleExample response data
Code Block
languagejson
{
  "result": [
    {
      "id": "38",
   },   "definitionId": "35",
      "name": "Approval  Name",
      "actionsummary": "STARTEDTicket Summary",
      "collectionId": "10002",
      "refId": "10004",
      "decisionsteps": "ACCEPTED",[
        {
           "decisionDatetype": "2022-09-26T15:32:42.340+00:00USER",
          "status": "SUCCESS",
          "lastUpdateduserId": "2022-09-26T17:32:42+02:00"557058:aea7ac02-75c1-4f47-9beb-dd89777d4949",
          "displayName":      }"Krzysztof Bogdan",
          "action": "STARTED",
    {      "decision": "ACCEPTED",
             "typedecisionDate": "USER",2021-09-30T13:51:01.676+00:00"
        }
      ],
      "typestatus": "USERIN_PROGRESS",
    }
               "status": "SUCCESS"],
                    "userId"totalCount": "6105b29ec51f3a0069c9ccda",
                    "displayName": "Parsa Shiva1
}

...

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
{
  "definitionId": "id",
  "summary": "Approval summary. Usually issue/page title",
  "userId": "Atlassian user 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.

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

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

Code Block
{
  "createComment": true,
   "parallelGroupNumberuserId": null,
 "Atlassian user id"
}

This will reset the path and generate a comment.

Expand
Code Block
languagejson
{
    "result": [
        {
   "avatarUrls": {        "id": "469",
               "48x48": "https://secure.gravatar.com/avatar/2ed481ded6c12e2eeb9e41992258c212?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-0.pngdefinitionId": "197",
            "name": "Page content approval",
            "32x32summary": "https://secure.gravatar.com/avatar/2ed481ded6c12e2eeb9e41992258c212?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-0.pngNDA-33 Documentation",
            "collectionId": "10000",
            "24x24refId": "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",10068",
            "steps": [
                {
"16x16": "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"                     }"type": "USER",
                    "actionstatus": "APPROVALSUCCESS",
                    "decisionuserId": "ACCEPTED6105b29ec51f3a0069c9ccda",
                    "decisionDatedisplayName": "2022-09-26T15:32:52.128+00:00Parsa Shiva",
                    "lastUpdatedparallelGroupNumber": null,
                 }   "action": "STARTED",
                {    "decision": "ACCEPTED",
                    "typedecisionDate": "USER2022-09-26T15:32:42.340+00:00",
                    "typelastUpdated": "USER",2022-09-26T17:32:42+02:00"
                    "status": "SUCCESS"},
                {
   "userId": "6299df401648f2006963deb8",
                    "displayNametype": "Jessica SmithUSER",
         
          "parallelGroupNumber": null,          "status": "SUCCESS",
         "avatarUrls": {          "userId": "6105b29ec51f3a0069c9ccda",
             "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",       "displayName": "Parsa Shiva",
                    "32x32": "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",
  parallelGroupNumber": null,
                     "24x24action": "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",
                    "16x16decisionDate": "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"
 2022-09-26T15:32:52.128+00:00",
                  },  "lastUpdated": null
                 "action": "APPROVAL"},
                {
   "decision": "ACCEPTED",
                    "decisionDatetype": "2022-09-27T09:23:07.459+00:00USER",
                    "lastUpdated": null            "type": "USER",
    },                 {"status": "SUCCESS",
                    "typeuserId": "USER6299df401648f2006963deb8",
                    "typedisplayName": "USERJessica Smith",
                    "statusparallelGroupNumber": "SUCCESS"null,
                    "userIdaction": "6299df401648f2006963deb8APPROVAL",
                    "displayNamedecision": "Jessica SmithACCEPTED",
                    "parallelGroupNumber": null"decisionDate": "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",
                    "status": "SUCCESS",
              "24x24": "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",     "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
}