Clear Data

This REST API is used to execute a Clear Data job using the profile name. Before executing this job, you should create a Clear Data job in Tax Reporting.

For details on this task, see "Using Clear Data Jobs" in Administering Tax Reporting

This REST API returns the job ID after starting the job.

REST Resource

POST/HyperionPlanning/rest/{api_version}/applications/{application}/jobs

Required Roles

Service Administrator

Request

Supported Media Types: application/json

Parameters

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

Table 22-5 Clear Data

Name	Description	Type	Required	Default
`api_version`	Version of the API you are working with: v3	Path	Yes	None
`application`	The name of the application Get the application name by using the Get Applications API, for example, FCCS or TRCS. See Get Applications.	Path	Yes	None
`jobName`	Name of the job should be: `Execute Profile`	Payload	Yes	None
`jobType`	Type of Job. Supported value: `CLEAR_DATA`	Payload	Yes	None
`ProfileName`	Name of the saved clear data job	Payload	Yes	None

Example of Request Body

{
  "jobType": "CLEAR_DATA",
  "jobName": "Execute Profile",
     "parameters": {
             "ProfileName": "ClearJobTesting"
      }
}

Response Body

Supported Media Types: application/json

Table 22-6 Parameters

Name	Description
`type`	Tax Reporting Application type, for example, TRCS
`status`	Status of the job: -1 =In progress; 0 = Success; 1 = Fail
`details`	In case of errors, details are published with the error string.
`descriptiveStatus`	The status of the job, such as Completed or Error
`items`	Collection of Notification categories
`links`	Detailed information about the link
`href`	Links to API call
`action`	The HTTP call type
`rel`	Relationship type. Possible values: self

Example of Response Body

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

{
  "jobId": 46,
  "jobName": "Clear Data",
    "descriptiveStatus": "Processing",
    "details": null,
    "status": -1,
    "links": [
        {
            "href": "https://https://<BASE-URL>/HyperionPlanning/rest/v3/applications/<applicationName>/jobs/<JobId>",
            "rel": "self",
            "action": "GET"
        },
        {
            "href":"https://https://<BASE-URL>/HyperionPlanning/rest/v3/applications/<applicationName>/jobs/<JobId>/details",
            "rel": "job-details",
            "action": "GET"
        }
    ]
}