Retrieve Enterprise Journals for Financial Consolidation and Close
Returns the list of journals ready to validate or ready to post based on the parameter sent.
This API works only for Financial Consolidation and Close.
REST Resource
GET /HyperionPlanning/rest/ej/{api_version}/ejjournals
Required Roles
Service Administrator
Request URL with Optional Parameters
GET /HyperionPlanning/rest/ej/{api_version}/ejjournals?Year=2018&Period=Jan&PostingStatus=ReadyToPost&ValidationStatus=ReadyToValidate
Supported Media Types: application/json
Parameters
The following table summarizes the client request.
"Year", "Period", "PostStatus" and "ValidationStatus" are optional. If "Year" and "Period" are not passed, journals from all year and period are listed.
By default, only ReadyToPost journals are listed, however you can provide any valid value for the PostingStatus parameter to get corresponding journals.If a valid value is provided for "ValidationStatus", journals are listed based on the provided value.
Table 21-10 Parameters
Name | Description | Type | Required | Default |
---|---|---|---|---|
api_version |
Version of the API you are developing with: v1 | Path | Yes | None |
Year |
Year for which to list journals, for example, Year=2018. If you do not specify a Year and Period, journals from all Years and Periods are listed. | Query | No | All Years |
Period |
Period for the journal, for example: Period=Jan. If you do not specify a Year and Period, journals from all Years and Periods are listed. If you specify only Year or only Period, journals from all Years and Periods are listed. | Query | No | All Periods |
Postingstatus |
Posting status for the journal, for example:
Valid values are |
Query | No | ReadyToPost |
ValidationStatus |
Validation status for the journal.
Valid Values are |
Query | No | None |
Response
Supported Media Types: application/json
Example of Response Body
The following shows an example of the response body.
{
"items": [
{
"year": 2020
"period": "Jan",
"journalId": "100000001",
"instanceId": "100000000008821",
"link": {
"rel": "content",
""https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/ej/v1/ejjournals/100000000008821",
"action": "GET"
}
}
{
"year": 2020
"period": "Jan",
"journalId": "100000002",
"instanceId": "100000000008822",
"link": {
"rel": "content",
"https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/ej/v1/ejjournals/100000000008822",
"action": "GET"
}
}
],
"link": {
"rel": "self",
"https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/ej/v1/ejjournals",
"action": "GET"
}
"error": null,{
"type": "EPM"
}