Retrieve Journal Details for Financial Consolidation and Close

Returns the journal details for the given scenario, year, period, consolidation, and the journal name.

This API works only for Financial Consolidation and Close.

REST Resource

GET       /HyperionPlanning/rest/{api_version}/applications/{application}/journals/{journal label}?q={"scenario":"Actual","year":"FY16","period":"Jan","consolidation":"Entity Input","lineItems":"true"}

Request

Supported Media Types: application/json

The following table summarizes the client request.

Table 12-12 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
journal label The label of the journal for which to retrieve journal details Path Yes None
q Filters to retrieve the journal, for example:
q={"scenario":"Actual","year":"FY16","period":"Jan","consolidation":"Entity Input"}
Query Yes None
scenario Scenario for the journal, for example: "scenario":"Actual" Query Yes None
year Year for the journal, for example: "Year":"FY16 Query Yes None
period Period for the journal, for example: "period":"Jan" Query Yes None
consolidation Consolidation for the journal, for example: "consolidation": "Entity Input" Query No Entity Input
lineItems Line items for the journal. Valid values are true or false. Query No True

Response

Parameters

The following table summarizes the response parameters.

Table 12-13 Parameters

Name Description
  First-level attributes related to the journal, such as:

[{
         "scenario": "Actual",
         "createdOn": "2018-07-30 06:22:47.516",
         "modifiedBy": "epm_default_cloud_admin",
         "journalType": "Regular",
         "createdBy": "epm_default_cloud_admin",
         "balanceType": "Balanced",
         "postedBy": null,
         "year": "FY17",
         "description": "JournalDesc1",
         "group": "grp1",
         "status": "Working",
         "label": "J4",
         "currency": "Entity Currency",
         "period": "Jan"]
}]
lineItems List of line items for the journal, followed by line items attributes, such as:

[{
         "account": "Balance",
         "amount": "200,
         "amountType: Credit":,
         "description": null,
         "movement": "No Movement",
         "entity": "Total Geography",
         "dataSource": Journal Input
}]

Supported Media Types: application/json

Example of Response Body

The following shows an example of the response body.

{
       "scenario": "Actual",
       "createdOn": "2018-07-26 10:21:35.634",
       "modifiedBy": "epm_default_cloud_admin",
       "journalType": "Regular",
       "createdBy": "epm_default_cloud_admin",
       "balanceType": "Balanced",
       "postedBy": null,
       "journalLineItems",
       {
       "account": "Balance",
       "amount": "200",
       "amountType": "Credit",
       "description": null,
       "movement": "No Movement",
       "entity": "Total Geography",
       "dataSource": "Journal Input",
       }
       ],,
       "journalUrl": null,
       "year": "FY17",
       "description": "Journal Desc",
       "group": "grp1",
       "status": "Working",
       "label": "J2",
       "period": "Jan"
        }
}