Import Consolidation Journals

This REST API is used to execute an Import Consolidation Journals job using the job name. Before executing this job, you should create an Import Consolidation Journals job in Financial Consolidation and Close.

For details on this task, see "Importing Consolidation Journals" in Working with Financial Consolidation and Close.

This REST API returns the job ID, job status and job details after starting the Import Consolidation Journals job.

REST Resource

POST /HyperionPlanning/rest/{api_version}/applications/{application}/jobs

Required Roles

Service Administrator

Request

Supported Media Types: application/json

Table 18-13 Parameters

Name	Description	Type	Required	Default
`api_version`	Version of the API you are working with: v3	Path	Yes	None
`application`	The name of the application Get the application name by using the Get Applications API. See Get Applications.	Path	Yes	None
`jobName`	Name of the job should be an existing journal import job: `<job name>`	String	Yes	None
`jobType`	Type of Job. Supported value: `IMPORT_JOURNAL`	String	Yes	None
`fileName`	Name of the file from which the journal entries are to be imported	String	No	File specified in the Job
`errorFileName`	Name of the log file in which messages generated during the import process are to be recorded	String	No	None

Example of Request Body

{
    "jobType": "IMPORT_JOURNAL",
    "jobName": "IMPORT1",
    "parameters": {
       "fileName": "TestImport1.jlf",
       "errorFileName": "DHQA_TestImport1_error.log"
    }
}

Response Body

Supported Media Types: application/json

Table 18-14 Parameters

Name	Description
`type`	Application type, for example, FCCS
`status`	Status of the job: -1 =In progress; 0 = Success; 1 = Fail
`details`	In case of errors, details are published with the error string.in the job error file and Job Console.
`descriptiveStatus`	The status of the job, such as Completed or Error
`items`	Collection of Notification categories
`links`	Detailed information about the link
`href`	Links to API call
`action`	The HTTP call type
`rel`	Relationship type. Possible values: self

Example of Response Body:

The following shows an example of the response body in JSON format.

{
"links":[
{
"rel": "self",
"href": " https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/FccsRef3/jobs/13",
"action": "GET"
},
{
"rel": "job-details",
"href": " https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/
/applications/FccsRef3/jobs/13/details",
"action": "GET"
}
],
"descriptiveStatus": "Processing",
"status": -1,
"jobId": 13,
"jobName": "JIMPORT1",
"details": null
}