Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

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

 

variant

The existing variant name for the extractor process report.

Optional

 

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/request?sap-client=

800

clientnumber

JSON body:

Code Block
languagejson
{
    "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": ""
                }
            ]
        }
    ]
}

...

Functionality is implemented in the SAP class /DVD/GL_EXT2_API_SCHEDULE._V3

List and monitor available requests for a process

Resource GET /processes/requests serve as the main way to list all available Requests that have been executed. It supports the following input parameters:

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 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/

request

requests?sap-client=

800

clientnumber

JSON body:

Code Block
languagejson
{
  "processid": "ZTS_SFLIGHT_E",
  "requestid":
"280606",
  "from": "2020021413385",
  "to": "20200226133853"
}

Example of the REST API output:

...

Functionality is implemented in the SAP class /DVD/GL_EXT2_API_REQUESTS. _V3