Skip Updates (v1)
Use the Skip Updates (v1) API to add, list, or remove a skip update request. Using this API, you can ask Oracle to skip applying a monthly update to an environment, or remove all previous skip update requests so that the environment is updated to the main code line. This allows you to skip updates to an EPM Cloud production environment at times when you need to complete time-sensitive tasks, for example, closing a quarter, without creating a service request.
This topic describes the original version of this REST API. You can also use the simplified v2 version of the REST API. The v2 version contains all parameters in the payload and does not require URL encoding while calling the REST APIs. This makes the v2 API easier to use. The v2 version is backwards compatible.
You can also list the skip update requests currently specified for an environment. You can set skip update requests for a maximum of two update cycles. You cannot skip updates for an environment that is on a one-off patch. Additionally, you cannot skip monthly updates that are more than two months apart from the update that the environment is currently on. For example, if the environment is currently on 20.12, you can skip 21.01 and 21.02 updates, but not 21.03. This gives you better control over monthly and weekly updates.
This REST API is version v1.
Required Roles
Service Administrator
REST Resource
POST /interop/rest/v1/services/skipupdate
Note:
Before using the REST resources, you must understand how to access the REST resources and other important concepts. See Implementation Best Practices for EPM Cloud REST APIs. Using this REST API requires prerequisites. See Prerequisites.
Request
Supported Media Types: application/x-www-form-urlencoded
The following table summarizes the request parameters.
Table 9-112 Parameters
Name | Description | Type | Required | Default |
---|---|---|---|---|
type |
The desired action to be performed (Add, List, or Remove) | Form | Yes | None |
version |
The version to be skipped from update, for example, 20.12 | Form |
No (Yes, only when the type is |
None |
comment |
The business reason for skipping an update, such as Year End |
Form |
No (Yes, only when the type is |
None |
Response
Supported Media Types: application/json
Table 9-113 Parameters
Name | Description |
---|---|
details |
In the case of errors, details are published with the error string |
status |
See Migration Status Codes |
links |
Detailed information about the link |
href |
Links to API call or status API |
action |
The HTTP call type |
rel |
Possible values: self or Job Status . If the value is set to Job Status , you can use the href to get the status
|
data |
Parameters as key value pairs passed in the request |
Example of Response Body
The following shows an example of the response body in JSON format.
{
"links":[{
"https://<BASE URL>/interop/rest/v1/services/skipupdate",
"rel":"self",
"data":null,
"action":"POST"
}
],
"details":null,
"status":0
}