Get Information about a Specific REST API Version for Planning

You can use REST APIs to get information about a specific REST API version for Planning.

Required Roles

Service Administrator, Power User, User, Viewer

REST Resource

GET /HyperionPlanning/rest/{api_version}

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request.

Table 8-4 Parameters

Name	Description	Type	Required	Default
api_version	Version of the API you are working with, such as V3	Path	Yes	None

Response Body

Supported Media Types: application/json

Parameters

The following table summarizes the response parameters.

Table 8-5 Parameters

Attribute	Description
version	The version, such as v3
lifecycle	Lifecycle of the resource, active or deprecated
isLatest	Whether this resource is the latest, true or false

Example of Response Body

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

{
    "version": "v3",
    "lifecycle": "active",
    "isLatest": true,
    "links": [{
        "rel": "canonical",
        "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3"
    }, {
        "rel": "predecessor-version",
        "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v2"
    }]
}