Applying changes to a renewal
It is possible for a policy change to preempt a future renewal whose state is either draft or bound. When the policy change is bound, the user interface provides the option of applying the changes in the preempting job to the renewal. This is similar to "handle preemption" functionality, but there are differences:
- The copying of information is initiated from the preempting job, not the preempted job.
- The copying of information is optional. If you choose to not copy the information, you can still bind the renewal.
To apply changes from a policy change to a renewal through Cloud API, use the following endpoint:
- POST
job/v1/jobs​/{jobId}/apply-changes-to-renewal
You do not need to provide a request body.
Once the changes are applied to the renewal, you need to quote (or requote) the renewal before it can be bound.
Identifying when a renewal exists
When you execute a policy change from the PolicyCenter user interface, there is a button that identifies a renewal exists and that gives you the option to copy changes to the renewal.
When you execute a policy change from Cloud API, you can identify whether there is an
existing renewal by checking the links
array of the response
payload. If there is an apply-changes-to-renewal
member, the job's
policy has a renewal and you may want to consider applying the policy changes to
that renewal.
apply-changes-to-renewal
member, indicating the changed policy
has a renewal."links": {
..
"activity-patterns": {
"href": "/job/v1/jobs/pc:232/activity-patterns",
"methods": [
"get"
]
},
"apply-changes-to-renewal": {
"href": "/job/v1/jobs/pc:232/apply-changes-to-renewal",
"methods": [
"post"
]
},
"contacts": {
"href": "/job/v1/jobs/pc:232/contacts",
"methods": [
"get"
]
},
...