Import Supplemental Collection Data for Financial Consolidation and Close
Imports supplemental data to a collection for the frequency dimensions defined in the collection interval of the collection. Returns the success or failure status.
REST Resource
POST /HyperionPlanning/rest/{api_version}/applications/{application}/fcmjobs
Required Roles
Service Administrator
Request
Supported Media Types: application/json
Parameters
Table 20-2 IMPORT_SUPPLEMENTAL_COLLECTION_DATA
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, for example, FCCS or TRCS. See Get Applications. |
Path | Yes | None |
jobName |
Name of the job | String | No | None |
jobType |
Type of the Job. Supported value for this Job IMPORT_SUPPLEMENTAL_COLLECTION_DATA | String | Yes | None |
fileName |
File name to be imported, for example, dataset.csv | String | Yes | None |
collection |
Collection or sub-collection name | String | Yes | None |
year |
The year for which the collection is deployed | String | Yes | None |
period |
Period name for which the collection is deployed | String | Yes | None |
parameter |
Runtime parameter. This is the frequency dimension used for the Collection. | String | No | None |
value |
Runtime parameter value. This is the member value for the dimension specified in the parameter. |
String | No | None |
Table 20-3 Examples of runtime parameters
Parameter | Value |
---|---|
Product | Oracle EPM |
Consolidation | Entity Input |
Movement | Actual |
Examples of request body
Example 1
{
"jobType" : "IMPORT_SUPPLEMENTAL_COLLECTION_DATA",
"parameters": {
"fileName":"import_sdm_data.csv",
"collection":"Investment Detail Collection",
"year":"2019",
"period":"Dec",
"product:"Oracle EPM",
"consolidation":"Entity Input",
}
}
Example 2
{
"jobType" : "IMPORT_SUPPLEMENTAL_COLLECTION_DATA",
"parameters": {
"fileName":"import_sdm_data.csv",
"collection":"Investment Detail Collection",
"year":"2020",
"period":"January",
"category":"Oracle EPM",
"movement":"Actual",
}
}
Example 3
{
"jobType" : "IMPORT_SUPPLEMENTAL_COLLECTION_DATA",
"parameters": {
"fileName":"import_sdm_data.csv",
"collection":"Investment Detail Collection",
"year":"2019",
"period":"December",
"scenario":"Actual",
}
}
Response
Supported Media Types: application/json
Parameters:
Table 20-4 Parameters
Name | Description |
---|---|
type |
FCCS Application type, for example, FCCS |
status |
-1 - In Progress; 0 - Success; 1 - Fail |
details |
In case of errors, details are published with the error string |
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 is an example of the response body in JSON format.
{
"jobId":100000000114040,
"descriptiveStatus":"In Progress",
"details": "In Progress",
"status": -1,
"items": [],
"links": [
{
"rel": "self",
"href": "https://<SERVICE_NAME-<TENANT_NAME.<SERVICE_TYPE.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/FCCS/fcmjobs/100000000114040"
}, {",
"action":"GET"
}
],
}