Running a Pipeline
Executes a Pipeline based on job parameters and variables that you select.
The Pipeline jobtype supports running a Pipeline based on the variable list (depends on how many variables have been defined for the Pipeline in the Data Integration user interface.)
Prerequisites:
-
You must have predefined the Pipeline to run it.
-
You must have the required privileges to execute a Pipeline.
REST Resource
/aif/rest/{api_version}/jobs
Required Roles
Service Administrator
Request
Supported Media Types: application/json
Method:
POST
Payload:
{
"jobName": "DAILYLOAD",
"jobType": "pipeline",
"variables": {
"STARTPERIOD": "Jan-23",
"ENDPERIOD": "Jan-23",
"IMPORTMODE": "Replace",
"EXPORTMODE": "Merge",
"ATTACH_LOGS": "N",
"SEND_MAIL": "ALWAYS",
"SEND_TO": "user@company.com"
}
}
REST Payload Description
The following table summarizes the REST payload.
Table 15-7 Parameters
Name | Description | Type | Required | Default |
---|---|---|---|---|
api_version |
V1 | Path | Yes | |
jobType |
PIPELINE | JSON payload | Yes | |
jobName |
The Pipeline code defined for the Pipeline in Data Integration. The code can contain up to 30 alphanumeric characters with a minimum of 3 characters and a maximum of 30 characters. This code cannot be updated after a Pipeline is created. |
JSON payload | Yes | |
variables |
Name of the variable(s) used in the Pipeline. The list depends on how many variables have been defined in the Pipeline. The default out-of-box variables include:
Use of a substitution variable in the
Using a |
JSON payload | No | |
STARTPERIOD |
The first period for which data is to be loaded. This period name must be defined in Data Integration Period mapping. You can also specify a Planning substitution variable whereby a substitution variable can be specified instead of the actual Year/Month member names for the start period. The convention is {Month#&CurYr}{&FcstMonth#&CurYr}; for example, {Jan#&CurYr}{&FcstMonth#&CurYr}. A combination of both actual member names as well as substitution variables is supported. This parameter is supported in the Planning, Tax Reporting, and Financial Consolidation and Close business processes. It is functional for both your service applications and cloud deployments derived from on-premises data sources. |
Yes | ||
ENDPERIOD |
The last period for which data is to be loaded. This period name must be defined in Data Integration period mapping. You can also specify a Planning substitution variable whereby a substitution variable can be specified instead of the actual Year/Month member names for the start period. The convention is {Month#&CurYr}{&FcstMonth#&CurYr}; for example, {Jan#&CurYr}{&FcstMonth#&CurYr}. A combination of both actual member names as well as substitution variables is supported. This parameter is supported in the Planning, Tax Reporting, and Financial Consolidation and Close business processes. It is functional for both your service applications and cloud deployments derived from on-premises data sources. |
JSON payload | Yes | |
IMPORTMODE |
Determines how the data is imported into Data Integration.
Acceptable values are:
|
Yes | ||
exportMode |
Determines how the data is exported into Data Integration.
Acceptable values for Planning business processes are:
Acceptable values for Financial Consolidation and Close and Tax Reporting are:
|
Yes | ||
ATTACH_LOGS |
|
No | ||
SEND_MAIL |
Determines when an email is sent when a Pipeline is run. Options include:
For variables, the default value is set in the Pipeline definition. Overriding individual variables is done by passing it in the JSON payload, for example, STARTPERIOD. |
|||
SEND_TO |
Determines the recipient email ID for the email notification. Email IDs are comma separated. |
No |