Rename Application Snapshot (v1)
This API renames a snapshot in EPM Cloud instances to a desired name. This gives you flexibility in naming your snapshots.
This REST API is version v1.
Required Roles
Service Administrator
Power User assigned to the Migration Administrator Profitability and Cost Management application role
REST Resource
PUT /interop/rest/{api_version}/renamesnapshot
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-67 Parameters
Name | Description | Type | Required | Default |
---|---|---|---|---|
{api_version} |
The version of the API, such as v1. | Path | Yes | None |
snapshotName |
The name of the snapshot to be renamed. | Form | Yes | None |
newSnapshotName |
The desired name of the existing snapshot. | Form | Yes | None |
Response
Supported Media Types: application/json
Table 9-68 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/renamesnapshot",
"rel":"self",
"data":null,
"action":"PUT"
}
],
"details":null,
"status":0
}