Retrieve Journal Details for Oracle Financial Consolidation and Close Cloud

Returns the journal details for the given scenario, year, period and the journal name. Fetching line items is optional; the default is false.

This API works only for Oracle Financial Consolidation and Close Cloud.

REST Resource

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

Request

Supported Media Types: application/json

The following table summarizes the client request.

Table 12-9 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
q Filters to retrieve the journal, for example:
q={"scenario":"Actual","year":"FY16","period":"Jan"}
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
lineItems Line items for the journal. Valid values are true or false.
Query No None

Response

Parameters

The following table summarizes the response parameters.

Table 12-10 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",
         "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"
        }
}