Get REST API Versions for Planning

You can use REST APIs to get information about which versions are available and supported. Multiple versions might be supported simultaneously.

Note:

An API version is always supported even when deprecated.

Required Roles

Service Administrator, Power User, User, Viewer

REST Resource

GET /HyperionPlanning/rest/

Request

Supported Media Types: application/json

Response

Supported Media Types: application/json

Parameters

The following table summarizes the parameters.

Table 8-3 Parameters

Name	Description
items	Version of the API you are developing with
version	The version, such as v3
lifecycle	Possible values: active, 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.

{	
    "items": [{
        "version": "v1",
        "lifecycle": "deprecated",
        "isLatest": false,
        "links": [{
            "rel": "canonical",
            "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v1"
        }, {
            "rel": "successor-version",
            "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v2"
        }]
    }, {
        "version": "v2",
        "lifecycle": "deprecated",
        "isLatest": false,
        "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"
        }, {
            "rel": "successor-version",
            "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3"
        }]
    }, {
        "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"
        }]
    }],
    "links": [{
        "rel": "self",
        "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/"
    }, {
        "rel": "canonical",
        "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/"
    }, {
        "rel": "current",
        "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3"
    }]
}