Auto Light Dark
Auto Light Dark

Section Approval on Data Center

Get approval macro details

Path

/rest/approvalmacro/1.0/approval

Method

POST

Request body

JSON
{
  "type": "macro", // Type = Macro
  "pageId": 12386312, // The Confluence Page ID
  "macroId": "b566d425-af37-489b-b8e9-b263a80813ba", // Stored in the Wiki Markup (Unique to Page Version)
  "uuid": "b476b98-edfd-4d37-81fd-a2c919f41421", // Unique Identifier stored in Macro Parameters
  "version": 1 // The Confluence Page Version
}

Response body

JSON
{
  "type": "macro",
  "status": "pending",
  "spaceId": 10747905,
  "creatorUsername": "ff8080819ac4480f019ac448ea4a0000",
  "pageId": 12386312,
  "macroId": "b566d425-af37-489b-b8e9-b263a80813ba",
  "title": "Test approval macro",
  "requestNotifications": true,
  "statusNotifications": true,
  "expireOnEdit": true,
  "quorumSize": 1,
  "postCommentsEnabled": false,
  "members": [
    {
      "approvalId": 3,
      "userKey": "ff8080819ac4480f019ac448ea4a0000",
      "status": "pending",
      "date": 1791904123100,
      "avatarUrl": "/confluence/images/icons/profilepics/default.svg",
      "displayName": "John",
      "username": "john"
    }
  ],
  "version": 1,
  "uuid": "b476b98-edfd-4d37-81fd-a2c919f41421",
  "superseded": false,
  "created": 1791904123099,
  "updated": 1791904123099
}

Possible errors

  • 404

    • No Page exists as provided

    • No Page Version exists as provided

    • No Approvals for Confluence Record exists as provided

  • 401

    • Anonymous User

    • No Permissions on the Space (Space Permissions)

    • No Permissions on the Page (Page Restrictions)

  • 400

    • Invalid JSON

See response body (JSON) for detailed error information.

Approve or reject a macro approval

Path

/rest/approvalmacro/1.0/approval/action

Method

POST

Request body

JSON
{
  "type": "macro",
  "action": "rejected", // "rejected" or "approved"
  "pageId": 12386312, // The Confluence Page ID
  "macroId": "b566d425-af37-489b-b8e9-b263a80813ba", // Macro ID stored in the Wiki Markup (Unique to Page Version)
  "uuid": "b476b98-edfd-4d37-81fd-a2c919f41421", // Unique Identifier stored in Macro Parameters
  "version": 1 // The Confluence Page Version
}

Response

  • 200 OK

Possible errors

  • 404

    • No Page exists as provided

    • No Page Version exists as provided

    • No Approvals for Confluence Record exists as provided

  • 401

    • Anonymous User

    • No Permissions on the Space (Space Permissions)

    • No Permissions on the Page (Page Restrictions)

  • 400

    • Invalid Request - e.g. trying to change an old page version

    • Invalid JSON

See response body (JSON) for detailed error information.