Monitor Enterprise Journals for Financial Consolidation and Close

Returns the status of Journals for the given parameters.

Note:

• If all journals for given parameters are closed, then the output status would be '0' and detail text specifies that all journals are closed.
• If any journal for the given parameters is in Open status (Pending, Open with Preparer, Open with Approver etc.), then the output status would be '-1'.
• In case of error, a positive number will be returned in status.

REST Resource

POST      /rest/ej/{api_version}/jobs/

Required Roles

Service Administrator and Power User

Request

Supported Media Types: application/json

The following table summarizes the client request.

Table 21-2 Parameters

Name	Description	Path	Required
api_version	Version of the API you are working with, such as v1.	Yes	Yes
jobType	The name of the job EJ_MONITOR_JOURNALS.	No	Yes
year	The name of the year, such as 2021, 2022 etc.	No	No
period	The name of the period, such as Jan, Feb etc.	No	No
filterName	The name of the filter. For example, Journal status filter.	No	Yes

Note:

Either the combination of Year and Period or the Filter Name must be passed. If Year and Period can be part of filter, then Filter Name is sufficient in the parameters.

Example of request body

{

    "jobType": "EJ_MONITOR_JOURNALS",

    "parameters": {

        "year": "2022",

        "period": "Jan",

        "filterName": "Jan22_ERPDirectJournals"

    }

}            

Response

Supported Media Types: application/json

Parameters:

Table 21-3 Parameters

Name	Description
details	Journal Name and Status. First 100 journals only. Shows Open journals first. In case of errors, details are published with the error string.
status	See Migration Status Codes
links	Detailed information about the link
href	Links to the API call
action	The HTTP call type
rel	Relationship type (self, Job Status). if set to Job Status, you can use the href to get the status of the operation

Examples of Response Body

The following is an example of the response body in JSON format when all journals are closed:

{
    "status": 0,
    "details": "All journals for the given filter are closed.",
    "links": [
        {
            "rel": "self",
     "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>/HyperionPlanning/rest/ej/{api_version}/jobs/rest/ej/v1/jobs/monitorJournals?year=2022&period=Jan&filterName=ERP_Direct",
     "action": "GET"
        }
    ],
    "type": "EPM",
}           

The following is an example of the response body in JSON format when any journal status is open:

{
    "status": -1,
    "details": "Journal_NonDirect1|2022|Jan|1000000001, Status:Open with Preparer; \n
  Journal_NonDirect1|2022|Jan|1000000002, Status:Closed",
    "links": [
        {
            "rel": "self",
            "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com
HyperionPlanning/rest/ej/{api_version}/jobs/monitorJournals?year=2022&period=Jan&filterName=EJ_NonDirect ",
            "action": "GET"
        }
    ],
    "type": "EPM",
}