Get Information about a Specific API Version for Financial Consolidation and Close APIs
Returns details for a specific REST API version for Financial Consolidation and Close.
REST Resource
GET /HyperionPlanning/rest/{api_version}
Required Roles
Service Administrator, Power User, User, Viewer
Request
Supported Media Types: application/json
Parameters
The following table summarizes the parameters.
Table 18-1 Parameters
Name | Description |
---|---|
api_version |
Version of the API you are developing with, such as V1 |
Response
Supported Media Types: application/json
Parameters
The following table summarizes the parameters.
Table 18-2 Parameters
Name | Description |
---|---|
version |
The version, such as V1 |
Example of Response Body
The following shows an example of the response body in JSON format.
{
"version": "v1",
"lifecycle": "active",
"isLatest": true,
"links": [{
"rel": "canonical",
"href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v2"
}, {
"rel": "predecessor-version",
"href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v1"
}]
}