Getting Information About a Specific REST API Version for Enterprise Profitability and Cost Management

Returns information about a specific REST API version for Enterprise Profitability and Cost Management.

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 23-2 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

The following table summarizes the response parameters.

Table 23-3 Parameters

Attribute	Description
version	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://<BASE-URL>/HyperionPlanning/rest/v3"
    }, {
        "rel": "predecessor-version",
        "href": "https://<BASE-URL>/HyperionPlanning/rest/v2"
    }]
}