Policy#

• REST API
• API Version: 7.1

Prerequisites#

See QuickStart

Examples#

Now that we have the connection object webApi, we can get the instance of PolicyApi.

var policy = webApi.getPolicyApi();

We have access to the functionalities that Policy Api has.

Available functions#

Create a policy configuration#

Create a policy configuration. In this example we will see how to add minimum or 2 reviewers to the pull request.

String repoId = g.getRepository("my-repository").getId();
var scope = new ArrayList<>();
var obj = new HashMap<String, Object>(){{
    put("repositoryId", repoId);
    put("refName", "refs/heads/develop");
    put("matchKind", "exact");
}};

scope.add(obj);

var settings = new HashMap<String, Object>(){{
    put("minimumApproverCount", 2); // setting the minimum approvers count
    put("creatorVoteCounts", false);
    put("scope", scope);
}};

// You need type Id to create a policy configuration and you get the type Id by running getPolicyTypes method
policy.createPolicyConfiguration("fa74gfbfd-cfnb-45rc-9dfa-490fhf74tfg1dd", true, false, settings);

Delete a policy configuration#

Delete a policy configuration using configuration id.

policy.deletePolicyConfiguration(2);

Get a list of policy configurations#

Get a list of all available policy configurations.

policy.getPolicyConfigurations();

Get a policy configuration#

Get a policy configuration using id.

policy.getPolicyConfiguration(1);

Update a policy configuration#

Update an existing policy configuration. You need t he configuration id to update the specific configuration.

One such example here.

policy.updatePolicyConfiguration(
    1, // configuration id
    "fa74gfbfd-cfnb-45rc-9dfa-490fhf74tfg1dd", // Type id
    true, // Is Enabled
    false, // is blocking
    settings // Map of settings to update the configuration
);

Get a list of policy types#

Get a list of all policy types.

policy.getPolicyTypes();