Clear Data By Point of View

Clears the data for a given point of view in a selected cube.

This is an asynchronous call, so use the job status URI to determine whether the operation is complete.

This API is version v3.

Required Roles

Service Administrators

REST Resource

POST /HyperionPlanning/rest/v3/applications/{AppName}/jobs/

Note:

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See Implementation Best Practices for EPM Cloud REST APIs. Using this REST API requires prerequisites. See Prerequisites.

Request

Supported Media Types: application/json

The following table summarizes the client request parameters specific to this job.

Table 23-6 Parameters

Name	Description	Type	Required	Default
jobType	Clear POV	Payload	Yes	None
jobName	Name of the job Example: "Clear POV"	Payload	Yes	None
povDelimiter	Delimiter used in POV values. The delimiter must be enclosed in double quotation marks. Other than a comma, only these delimiters are supported: _ (under score) # (hash) & (ampersand) ~ (tilde) % (percentage) ; (semicolon) : (colon) - (dash) Example: "povDelimiter":":" Note: When submitting multiple POVs for calculation, do not use a comma as the delimiter to separate POV members. Comma is reserved for separating POV groups as shown in this example: FY21:Jan:Actual:Working,FY21:Feb:Actual:Working,FY21:Mar:Actual:Working	Payload	Yes	:: (Double Colon)
povName	Name of the POV to clear Example: "povName":"to FY21:Jan:Actual:Working"	Payload	Yes	None
cubeName	Name of the cube on which clear operation is to be executed Example: "cubeName":"PCM_CLC"	Payload	Yes	PCM_CLC
clearInput	(True|False) Specifies whether to clear input data Example: "clearInput":"true"	Payload	Yes	None
clearAllocatedValues	(True|False) Specifies whether to clear allocated data Example: "clearAllocatedValues":"true"	Payload	Yes	None
clearAdjustmentValues	(True|False) Specifies whether to clear adjustment data Example: "clearAdjustmentValues":"true"	Payload	Yes	None

Sample Payload

{
   "jobType":"Clear POV",
   "jobName":"Clear POV",
   "parameters":{
        "povDelimiter":":",
        "povName":"FY21:Jan:Actual:Working",
        "cubeName":"PCM_CLC",
        "clearInput":"true",
        "clearAllocatedValues":"true",
        "clearAdjustmentValues":"true"
   }
}

Response

Supported Media Types: application/json

Table 23-7 Parameters

Name	Description
jobId	ID of the job that is created
jobName	Name of the job
details	In case of errors, details are published with the error string
status	See Migration Status Codes.
links	Detailed information about the link
href	Links to the API call
action	HTTP call type
rel	Can be self and/or Job-details. If set to Job Status, you can use the href to get the status of the job.
data	Parameters as key value pairs passed in the request

Examples of Response Body

The following examples show the contents of the response body in JSON format:

Example 1: Job is in Progress

{
    "jobId": 26,
    "jobName": "Clear POV",
    "status": -1,
    "descriptiveStatus": "Processing",
    "details": null,
    "links": [
        {
            "href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/BksML40/jobs/26",
            "action": "GET",
            "rel": "self",
        },
        {
            "href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/BksML40/jobs/26/details",
",
            "action": "GET",
            "rel": "job-details "
        }
    ]
}

Example 2: Job Status with No Errors

{
    "jobId": 26,
    "jobName": " Copy POV",
    "status": 0,
    "descriptiveStatus": "Success",
    "details": null
    "links": [
        {
            "rel": "self"
            "href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/jobs/26",
            "action": "GET",
        },
 {
            "rel": "job-details"
            "href": "http://<BASE-URL>/HyperionPlanning/rest/v3/applications/jobs/26/details",
            "action": "GET",
        }