Perform Journal Period Updates for Financial Consolidation and Close
Performs journal period update action for the specified period.
Journal period actions supported: OPEN,CLOSE
This API works only for Financial Consolidation and Close.
REST Resource
POST /HyperionPlanning/rest/{api_version}/applications/{application}/journalPeriods/{period}/actions
Required Roles
Service Administrator
Request
Supported Media Types: application/json
Parameters
The following table summarizes the client request.
Table 18-5 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 |
period |
The period for which you are performing the journal action | Path | Yes | None |
parameters |
Parameters for the journal period, for example:
These parameters are described in rows below. |
JSON | Yes | None |
scenario |
The scenario for which you are performing the journal action | JSON | Yes | None |
year |
The year for which you are performing the journal action | JSON | Yes | None |
action |
The journal period action. Supported valid Action values: OPEN, CLOSE | JSON | Yes | None |
Response
Parameters
The following table summarizes the response parameters.
Table 18-6 Parameters
Name | Description |
---|---|
scenario |
Journal scenario, such as Actual |
year |
Journal year, such as FY18 |
period |
Journal period, such as Jan |
action |
Journal period action, such as Open |
Supported Media Types: application/json
Sample JSON Input
{
"scenario": "Actual",
"year": "FY17",
"period": "Jan",
"action": "OPEN"
}
}
Example of Response Body
The following shows an example of the response body.
{
"actionDetail": "Open",
"actionStatus": 0
}