Running Data Rules in Data Management
Executes a Data Management data load rule based on the start period and end period, and import or export options that you specify.
Prerequisites
-
Data Rules: Data load rules define how Integrations load data from a file. You must have predefined data load rules to load data.
-
You must have the required privileges to execute a specific data rule.
REST Resource
POST /aif/rest/{api_version}/jobs
Required Roles
Service Administrator, Power User
Request
Supported
Media Types: application/json
Parameters
The following table summarizes the client request.
Table 16-5 Parameters
Name | Description | Type | Required | Default |
---|---|---|---|---|
api_version |
Version of the API you are working with, such as V1 | Path | Yes | None |
jobType |
should be set to "DATARULE" | Yes | None | |
jobName |
The name of a data load rule defined in Data Management. You should enclose the rule name in quotation marks if it contains a space. | Yes | None | |
startPeriod |
The first period for which data is to be loaded. This period name must be defined in Data Management period mapping. | Yes | None | |
endPeriod |
The last period for which data is to be loaded. This period name must be defined in Data Management period mapping. | Yes | None | |
importMode |
Determines how the data is imported into Data Management.
Acceptable values are:
|
Yes | None | |
exportMode |
Determines how the data is exported into Data Management.
Acceptable values for Planning Modules and Planning are:
Acceptable values for Financial Consolidation and Close and Tax Reporting are:
|
Yes | None | |
fileName |
An optional file name. If you do not specify a file name, this API imports the data contained in the file name specified in the load data rule. The data file must already reside in the Inbox prior to data rule execution. Import data files from the EPM INBOX accessible from the
Applications-Inbox/Outbox Explorer using a file name. Reference
the files in this folder using
|
Yes | None |
Example URL
https://<BASE-URL>/aif/rest/V1/jobs
Example of Request Body
{"jobType":"DATARULE",
"jobName":"aso to bso dr",
"startPeriod":"Dec-18",
"endPeriod":"Dec-18",
"importMode":"REPLACE",
"exportMode":"NONE",
"fileName":"#epminbox/TestData.txt"
}
Response
Supported Media Types:
application/json
Table 16-6 Parameters
Name | Description |
---|---|
|
Status of the job: -1 = in progress; 0 = success; 1 = error; 2 = cancel pending; 3 = cancelled; 4 = invalid parameter |
|
A text representation of the job status, with one of the following values" RUNNING," "SUCCESS," and"FAILED". |
|
The process ID generated in Data Management for the job |
|
Log File containing entries for this execution. |
|
Name of the output file generated, if any. |
|
Type of the process executed. Will contain "COMM_LOAD_BALANCES" for all Data Rule executions |
|
Login name of the user used to execute the rule. |
|
Returns the exception stack trace in case of an application error |
Example of Response Body
The following shows an example of the response body in JSON format.
{
"jobStatus": "RUNNING",
"jobId": 2019,
"logFileName": "\outbox\logs\Account Reconciliation Manager_2019.log",
"outputFileName": null,
"processType": "COMM_LOAD_BALANCES",
"executedBy": "admin",
"status": -1,
"links": [1],
0: {
"rel": "self",
"href": "https://<BASE-URL>/aif/rest/V1/jobs/2019",
"action": "GET",
}
"details": null
}