Perform Journal Actions for Financial Consolidation and Close

Performs journal action for the specified journal. Changes the journal status to the new state specified.

Journal actions supported: SUBMIT,APPROVE,POST,UNPOST,REJECT

This API works only for Financial Consolidation and Close.

REST Resource

POST      /HyperionPlanning/rest/{api_version}/applications/{application}/journals/{journalLabel}/actions

Required Roles

Role	Available Actions
Service Administrator	All
Power User	Submit/Post/Unpost: Need Write access to all the members in the journal Approve/Reject. Need Read access to all the members in the journal
User	Approve/Reject. Need Read access to all the members in the journal and Journal option must have been enabled

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request.

Table 18-3 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
journalLabel	Label for the journal	Path	Yes	None
parameters	Parameters for journals, for example: {"parameters" :{ "scenario": "Actual", "year": "FY17", "period": "Jan", "consolidation": "FCCS_Entity Input", "action": "POST" } } These parameter fields are described in rows below.	JSON	Yes	None
scenario	The scenario for which you are performing the journal action	Query	Yes	None
year	The year for which you are performing the journal action	Query	Yes	None
period	The period for which you are performing the journal action	Query	Yes	None
consolidation	The consolidation for which you are performing the journal action	Query	No	Entity Input
action	The journal action. Supported valid Action values: SUBMIT,REJECT,APPROVE,POST,UNPOST	Query	Yes	None

Response

Parameters

The following table summarizes the response parameters.

Table 18-4 Parameters

Name	Description
actionDetail	Journal action, such as Posted
actionStatus	Action status, such as 0

Supported Media Types: application/json

Sample JSON Input

{
       "scenario": "Actual",
       "year": "FY17",
       "period": "Jan",
       "action": "POST"
     }

Example of Response Body

The following shows an example of the response body.

{
       "actionDetail": "Posted",
       "actionStatus": 0
       }