Get Filters with All Possible Values

Returns all filter types with all possible values by which users can filter planning units for a given application. For every value, there is a label (in the client locale) representation and an integer value. The labels are shown to end users to pick from, but whenever possible, the client should submit the integer value that is unique to the server. Every application supports several types of filters that are indicated by the type field.

Name is optional. The defIndex is the index in the value array for the default selection value.

REST Resource

GET /HyperionPlanning/rest/{api_version}/applications/{application}/pufilters

Request

Supported Media Types: application/json

Parameters:

The following table summarizes the client request.

Table 5-54 Parameters

Name Description Type Required Default
api_version Version of the API you are developing with Path Yes None
application The name of the application Path Yes None
q Optionally, return filters for limited or full functionality. Options are listed here. Query No None
0 Returns filters for limited Approvals functionality - useful for mobile clients. Query No None
1 Returns filters for full Approvals functionality; default is 1. Query No None

Example URL

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/PS4app1/pufilters?q={"options":"0"}

Response

Supported Media Types: application/json

Parameters:

Table 5-55 Parameters

Name Description
Names Planning unit available actions
aliases Aliases for values to be displayed instead of labels if user preference is defined as such
name Name for the filter
type Type of the filter
values Integer values; usually the client will submit this value to indicate the selected filter
labels Labels for values to be displayed in the client for the filter
defIndex Index of the value to be displayed as the default value

Example of Response Body

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

{
    "items": [{
        "aliases": ["Forecast"],
        "name": "Scenarios",
        "type": 1,
        "values": [50218],
        "labels": ["Forecast"],
        "defIndex": 0
    }, {
        "aliases": ["BU Version_1"],
        "name": "Versions",
        "type": 2,
        "values": [1500],
        "labels": ["BU Version_1"],
        "defIndex": 0
    }, {
        "aliases": null,
        "name": "SubStatus",
        "type": 3,
        "values": [0, 1, 2, 3, 4, 10008, 10009, 10000],
   "labels": ["", "Processing", "Aborted", "Validating", "No Additional Approval Required", "Invalid Data", "Additional Approval Required", "Failed"],
        "defIndex": 0
    }, {
        "aliases": null,
        "name": "Status",
        "type": 4,
        "values": [2, 3, 4, 5, 6],
        "labels": ["Under Review", "Approved", "Signed Off", "Not Signed Off", "Frozen"],
        "defIndex": 0
    }],
    "links": [{
        "rel": "self",
        "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/PS4app1/pufilters?q=%7Boptions:%220%22%7D",
        "action": "GET"
    }],
}