ContentApproval Data Type

Approval information

Properties
name data type constraints description
name string   Name of the approval
nameTranslation string   Approval name translation
shortName string   Generated unique short name to be used as slug
minimumRequiredApprovers number   The minimum number of users that have to approve the approval. Default = 1
isOneApproverOnly boolean required The approval must only be approved by 1 user. Default = false
isRolesEnabled boolean required Whether the Approval Roles feature is enabled or not
filterUsers array of string   List of users which can be assigned for this approval
filterExcludedUsers array of string   List of users excluded from being assigned and approving this approval
filterGroups array of string   List of groups which can be assigned for this approval
approvers array of Approver   Approvers info
approveLabel string   Custom approve action button label
rejectLabel string   Custom reject action button label

Example

{
  "name" : "Draft",
  "nameTranslation" : "Review this page",
  "shortName" : "DR",
  "minimumRequiredApprovers" : 1,
  "isOneApproverOnly" : false,
  "isRolesEnabled" : false,
  "filterUsers" : [ "user1", "user2" ],
  "filterExcludedUsers" : [ "user3", "user4" ],
  "filterGroups" : [ "confluence-users", "confluence-administrators" ],
  "approvers" : [ {
    "user" : {
      "name" : "user_1",
      "rolename" : "Project Manager",
      "shortName" : "user_1",
      "fullName" : "User One",
      "pictureUrl" : "/images/icons/profilepics/user1.png"
    },
    "approved" : true,
    "rejected" : false,
    "comment" : "Approval approved, it is fine"
  }, {
    "user" : {
      "name" : "user_2",
      "rolename" : "QA Engineer",
      "shortName" : "user_2",
      "fullName" : "User Two",
      "pictureUrl" : "/images/icons/profilepics/user2.png"
    },
    "approved" : false,
    "rejected" : true,
    "comment" : "Appproval rejected, things missing"
  } ],
  "approveLabel" : "Accept",
  "rejectLabel" : "Deny"
}