Runtime Parameters

This page shows how to pass values to Xtract Universal.iQ service parameters at runtime.

For information on how to create user-defined custom parameters, refer to the documentation of the respective service type:

• Table Parameters
• BAPI Parameters
• Transaction Parameters

About Runtime Parameters

Depending on the HTTP method used to call a service, runtime parameters are either passed as:

• Query parameters in the service URL (HTTP GET). Add parameters at the end of the service URL, separated by '&'. They can be used for filtering or sorting. Example:
  http://[host]:[port]/api/v1/services/[service name]?[param1]=[value]&[param2]=[value]

• Body parameters in the request body of the service (HTTP POST). Body parameters add or update structured data, e.g., to pass tables to Function Module / BAPI services. Example:
  

  {
      "Table":"MARA",
      "Where":"MATNR = 000000000001",
      "Source":"s4hana",
      "Destination":"azure",
      "ResultName":"materials"
  }
  

Pass Query Parameters

Query parameters are added to the service URL when calling services using the HTTP GET method. The sample in the screenshot below shows how to pass a value to the input parameter NAME using a query parameter in Postman.

To add query parameters to a service call:

1. Open the Services menu.
2. Select the service you want to parameterize and click [ Run > Service > Copy URL] to copy the service URL to your clipboard.
3. Paste the copied URL into a browser or automation tool of your choice and add query parameters using the following syntax:
   http://[host]:[port]/service/[service name]/?[param1]=[value]&[param2]=[value]
4. Once the parameter is defined, run the service.

The service runs with the defined parameters.

Pass Body Parameters

Body parameters can be passed as a JSON object in the request body of a service when using the HTTP POST method. The sample in the screenshot below shows how to pass a value to the input parameter NAME using the request body in Postman.

To add body parameters to a request body:

1. Open the Services menu.
2. Select the service you want to parameterize and click Run > Service > Run. The "Run" menu opens.
3. Optional: Enter values using the Input Parameters fields.
4. In the Parameters section, click Save. The parameters are downloaded as a [service name]_input_payload.json file to your machine.
5. In the Service Details section, click to copy the service URL to your clipboard.
6. Paste the copied URL into an automation tool of your choice.
7. Open the [service name]_input_payload.json file and copy the content to your clipboard.
8. Paste the copied content into the request body of your service call in your automation tool.
9. If your parameters do not have values yet, add values directly in the JSON body.
10. Once all parameters are defined, run the service.

The service runs with the defined parameters.

Parameter Overview

Depending on the service type different parameters can be passed in the service URL to filter or sort data.