Execute a process
The resource POST /processes/request serves as the main way to execute the Extraction Process. It supports the following input parameters:
...
Parameter name
...
Description
...
Usage
...
Type
...
processID
...
Filtering based on the process ID
...
Execute a process
The resource POST /processes/requests serve as the main way to execute the Extraction Process. It supports the following input parameters:
Parameter name | Description | Usage | Type |
|---|---|---|---|
processID | Filtering based on the process ID | Mandatory | String |
loadType | Delta type of the load, default value is “F” (Full load) | Optional | “F“ | ”D” | ”I” | ”L” |
truncate | Option to truncate the table before the data load, the default value is “” (Don’t truncate) | Optional | “X“ | ““ |
packageSize | Option to set the number of rows for each package, the default value is 10.000 | Optional | Int |
previewMode | Option to view data from a source before Extraction Process. It is important to specify the package size parameter, max value is 1000; default is 20 | Optional | “X“ | ““ |
variant | The existing standard SAP variant name for the extractor process report. | Optional | String |
filter | If the Fetcher has been configured to accept filter specifications, they can be specified using this parameter | Optional | JSON object |
All input parameters are case-insensitive.
Example of REST API call:
POST | http://servername:portnumber/dvd/glue/api/v3_1/processes/requestrequests?sap-client=clientnumber |
|---|
JSON body:
| Code Block | ||
|---|---|---|
| ||
{
"processid": "z99_sflight_p",
"loadType": "F",
"filter": [
{
"fieldname": "CARRID",
"selopt": [
{
"sign": "I",
"option": "EQ",
"low": "AA",
"high": ""
},
{
"sign": "I",
"option": "EQ",
"low": "578",
"high": ""
}
]
},
{
"fieldname": "CONNID",
"selopt": [
{
"sign": "I",
"option": "EQ",
"low": "17",
"high": ""
}
]
}
]
} |
...
Parameter name | Description | Usage | Type | |
|---|---|---|---|---|
from | The lowest value of the START_TIME, represented as a timestamp | Optional | Format -YYYYMMDDHHMMSS | |
to | The highest value of the START_TIME, represented as a timestamp | Optional | Format - YYYYMMDDHHMMSS | |
requestId | Specific number of the requestId | Specific number of the request | Optional | String |
processId | Filtering based on the Extraction process ID | Optional | String |
All input parameters are case insensitive.
Example of REST API call:
...
GET
...
http://servername:portnumber/dvd/glue/api/v3_1/processes/requests?sap-client=clientnumber
JSON body:
| Code Block | ||
|---|---|---|
| ||
{
"processid": "ZTS_SFLIGHT_E",
} |
Example of the REST API output:
...
| language | json |
|---|
...
status | Request status | Optional | “N“ | ”P” | ”R” | ”E” | ”S” | ”F” |
deltaType | Defines whether Processes use one of the delta type or are FULL load onlys | Optional | "FULL" | "TMSTMP" | "TRIGGER" | "VALUE" |
loadType | Delta type of the load | Optional | “F“ | ”D” | ”I” | ”L” |
from | The lowest value of the START_TIME, represented as a timestamp | Optional | Format -YYYYMMDDHHMMSS |
to | The highest value of the START_TIME, represented as a timestamp | Optional | Format - YYYYMMDDHHMMSS |
All input parameters are case-insensitive.
Example of REST API call:
GET | http://servername:portnumber/dvd/glue/api/v3_1/processes/requests?sap-client=clientnumber |
|---|
JSON body:
| Code Block | ||
|---|---|---|
| ||
{
"requests": [
{
"processid": "ZTEST_SFLIGHT_P",
"status": "R",
"deltaType": "FULL"
},
{
"processid": "ZMS_FIFO_DMTD_TO_GLUE_P"
}
]
} |
Example of the REST API output:
| Code Block | ||
|---|---|---|
| ||
{ "requests": [ { "systemId": "NSD", "processId": "ZMS_FIFO_DMTD_TO_GLUE_P", "requestId": 307785, "status": "E", "deltaType": "FULL", "loadType": "", "jobname": "", "jobcount": "", "variantName": "", "variantText": "", "rowsRead": 0, "rowsWritten": 0, "startTime": 20200701083200.6769300, "endTime": 0, "elapsedTime": 78131650.8542170, "fetcherType": "FIFO Fetcher", "consumerType": "GLUE Table Consumer" }, { "systemId": "NSD", "processId": "ZTEST_SFLIGHT_P", "requestId": 557553, "status": "R", "deltaType": "FULL", "loadType": "F", "jobname": "ZDVD_GLUEZTEST_SFLIGHT_P", "jobcount": "15444500", "systemIdvariantName": "NSD", "requestId": 280606, "statusvariantText": "S", "rowsRead": 117,4914, "rowsWritten": 117,0, "startTime": 2020021714344220221222144452.7944975199450, "endTime": 0, "endTime": 20200217143510.167021, "elapsedTime": 273679.3725240188970, "fetcherType": "SAP Table Fetcher", "consumerType": "GLUE Table Consumer" } ] } |
Status values:
N New
P Pending
R RunningR Running
E Ended with an error
F Failed
S Ended successfully
Space
Delta type values:
FULL Full loads only (no delta enabled)
TMSTMP Timestamp delta
TRIGGER Trigger delta
VALUE Value delta
Functionality is implemented in the SAP class /DVD/GL_EXT2_API_REQUESTS_V3_1