Get Page Approval Details

Path

/rest/approvalmacro/1.0/approval

Method

POST

Request Body


{
	"type": 	"page",		// Type = Macro
	"pageId": 	786462,		// The Confluence Page ID
	"version": 	1			// The Confluence Page Version
}
CODE


Response Body


{
	"type": 				"page",
	"creatorUsername":		"ff80808160e8c8810160e8d6a1210000",
	"pageId":				786462,
	"title":				"Test",
	"requestNotifications":	true,
	"statusNotifications":	true,
	"expireOnEdit":			false,
	"quorumSize":			0,
	"postCommentsEnabled":	false,
	"members": [
		{
			"approvalId":	14,
			"userKey":		"ff80808160e8c8810160e8d6a1210000",
			"status":		"approved",
			"date":			1550055298599,
			"avatarUrl":	"/confluence/download/attachments/65573/user-avatar",
			"displayName":	"John"
		}
	],
	"version":		1,
	"superseded":	false
}
CODE


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.

Create or Update a Page Approval

Path

/rest/approvalmacro/1.0/approval/page

Method

PUT

Request Body


{
	"title":	"Test Space Home",
	"members":	["ff80808160e8c8810160e8d6a1210000"],
	"pageId":"2621443",
	"requestNotificationsEnabled":true,
	"statusNotificationsEnabled":true,
	"expiryDate":"", // YYYY-MM-DD or empty string
	"quorumSize":0
}
CODE


Response

  • 200 OK

Response Body


{
	"type": 				"page",
	"creatorUsername":		"ff80808160e8c8810160e8d6a1210000",
	"pageId":				786462,
	"title":				"Test",
	"requestNotifications":	true,
	"statusNotifications":	true,
	"expireOnEdit":			false,
	"quorumSize":			0,
	"postCommentsEnabled":	false,
	"members": [
		{
			"approvalId":	14,
			"userKey":		"ff80808160e8c8810160e8d6a1210000",
			"status":		"approved",
			"date":			1550055298599,
			"avatarUrl":	"/confluence/download/attachments/65573/user-avatar",
			"displayName":	"John"
		}
	],
	"version":		1,
	"superseded":	false
}
CODE


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.

Approve/Reject a Page Approval

Path

/rest/approvalmacro/1.0/approval/action

Method

POST

Request Body


{
	"type":		"page",
	"action":	"rejected", 	// "rejected" or "approved"
	"pageId":	786462, 		// The Confluence Page ID
	"version":	1				// The Confluence Page Version
}
CODE


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.