Replace named user POV

Replaces existing POV selections with the supplied map. Each supplied dimension must resolve to a single valid member; invalid references fail. Access to another user requires administrator privileges.

Required Roles

Access to another user requires administrator privileges.

REST Resource

PUT /HyperionPlanning/rest/v3/applications/{application}/users/{username}/pov

Request

Parameters:

Table 3-65 Request Parameters

Name Description Type Required Default
application The name of the application. path Yes None
username User login name. Access to another user requires administrator privileges. path Yes None
pov Dimension names mapped to one selected member expression per dimension. payload Yes None
pov.Scenario The member selected for the Scenario dimension. payload When supplying the containing object None
pov.Version The member selected for the Version dimension. payload When supplying the containing object None
pov.Entity The member selected for the Entity dimension. payload When supplying the containing object None

Send a required request body with Content-Type: application/json.

Dimension-name to member-name POV selections.

The payload rows describe the fields in the following request examples. Other supported options and conditional requirements are described above.

Example request body:

{
  "pov": {
    "Scenario": "Actual",
    "Version": "Working",
    "Entity": "East"
  }
}

Example URL

https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/users/planner1/pov

Response

Supported Media Types: application/json

Table 3-66 Response Parameters

Name Description
pov Dimension names mapped to one selected member expression per dimension.
pov.Scenario The member selected for the Scenario dimension.
pov.Version The member selected for the Version dimension.
pov.Entity The member selected for the Entity dimension.
links Links to this resource and related operations.
links[].rel The relationship of the linked resource to this resource.
links[].href The URL of the linked resource.
links[].action The HTTP method used to access the linked resource.

Sample Response

The following shows an example response.

{
  "pov": {
    "Scenario": "Actual",
    "Version": "Working",
    "Entity": "East"
  },
  "links": [
    {
      "rel": "self",
      "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision",
      "action": "GET"
    }
  ]
}