Rename Application Snapshot (v2)

The Rename Application Snapshot (v2) REST API renames a snapshot in EPM Cloud instances to a desired name. This gives you flexibility in naming your snapshots.

This API is version v2.

Required Roles

Service Administrator

Power User assigned to the Migration Administrator Profitability and Cost Management application role

REST Resource

PUT /interop/rest/v2/snapshots/rename

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-69 Parameters

Name	Description	Type	Required	Default
snapshotName	The name of the snapshot to be renamed.	Payload	Yes	None
newSnapshotName	The desired name of the existing snapshot.	Payload	Yes	None

Example URL and Payload

https://<BASE URL>/interop/rest/v2/snapshots/rename

{
	"snapshotName": "Artifact Snapshot",
	"newSnapshotName": "Backup_snapshot"
}

Response

Supported Media Types: application/json

Parameters:

Table 9-70 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

{
    "details": null,
    "status": 0,
    "links": [
        {
            "href": " https://<SERVICE_NAME>-
            <TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/snapshots/rename",
            "action": "PUT",
            "rel": "self",
            "data": null
        }
    ]
}

Sample cURL Command

curl -X PUT -s -u '<USERNAME>:<PASSWORD>' -o response.txt -D respHeader.txt -H 
'Content-Type: application/json' -d '{"snapshotName":"Artifact Snapshot" , "newSnapshotName" : 
"Original snapshot"}' 'https://<BASE URL>/interop/rest/v2/snapshots/rename'