Validate Policy

This operation provides the ability to validate a policy without submitting it.

Resource Representation

Only policies in status Edit can be validated. This can be derived by the presence or absence of the "validate" link.

The resource representation of a policy that can be validated, looks like this:

{
  ... policy properties ...
  "links": [
    {
      "href": "http://://generic/policies/",
      "rel": "self"
    },
    {
      "href": "http://://policies//validate",
      "rel": "policy:validate",
      "httpMethod": "POST"
    }
  ]
}

In the resource representation of a policy that cannot be validated, the "validate" link is not provided:

{
  ... policy properties ...
  "links": [
    {
    "href": "http://://generic/policies/",
    "rel": "self"
    }
  ]
}

Validation

Using this operation the user can validate the policy without finalizing (approving) it. The Validate operation submits the policy for processing as described in the Process Policy section of the Policies Implementation guide, without:

  • resolving existing pend reasons,

  • pending the policy,

  • evaluating the callout rules and policy validation rules with the Exclude From Validation field set to Yes,

  • changing the status of the policy.

After the operation is completed successfully, the request is redirected to policies API and a resource representation of the policy is returned.

Response Messages

This operation provides HTTP status codes as defined in Response Messages. If an error occurs, the appropriate HTTP status code is returned and a notification is sent containing the details of the error.

The following operation specific error can occur:

Code Severity Message Text

POL-HTTP-009

Fatal

Policy must be in status edit.

Authorization

The above described operation is protected by access restriction "policies.validate IP". A grant for this access restriction must be provided. If the access to a policy is restricted by a data access group restriction, then to perform this operation on that policy also a grant for that data access group restriction must be provided with the Update flag set. A read grant must also be given to access the policies resource.