Skip Updates (v2)

Use the Skip Updates (v2) REST 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.

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 22.10, you can skip 22.11 and 22.12 updates, but not 23.01. This gives you better control over monthly and weekly updates.

This REST API is version v2.

Required Roles

Service Administrator

REST Resource

POST /interop/rest/v2/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/json

The following table summarizes the request parameters.

Table 9-114 Parameters

Name Description Type Required Default

type The desired action to be performed (Add, List, or Remove) Payload Yes None

Name	Description	Type	Required	Default
`type`	The desired action to be performed (Add, List, or Remove)	Payload	Yes	None
`version`	The version to be skipped from update, for example, 22.12	Payload	No (Yes, only when the type is `Add`)	None
`comment`	The business reason for skipping an update, such as Year End	Payload	No (Yes, only when the type is `Add`)	None

version

The version to be skipped from update, for example, 22.12

Payload

No

(Yes, only when the type is Add)

None

comment

The business reason for skipping an update, such as Year End

Payload

No

(Yes, only when the type is Add)

None

Example URL and Payload

https://<BASE URL>/interop/rest/v2/services/skipupdate

{   
    "type":"Add",
    "parameters": {
        "version": "22.12",
        "comment": "Year end"
    }
}

Response

Supported Media Types: application/json

Table 9-115 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`	null

Example of Response Body

The following shows an example of the response body in JSON format.

{
	"status": 0,
	"items": null,
	"links": [{
		"rel": "self",
		"href": "https://<BASE URL>/interop/rest/v2/services/skipupdate",
		"data": null,
		"action": "POST"
	}
	"details": null
}

Sample cURL command

curl -X POST -s -u '<USERNAME>:<PASSWORD>' -o response.txt -D respHeader.txt -H 'Content-Type: application/json' -d '{"type":"Add","parameters":{"version":"22.10","comment":"Year End"}}' 'https://<BASE URL>/interop/rest/v2/services/skipupdate'

Common Functions