Kourier Integrator Online Help
Enter the parameters associated with this outbound REST resource. You can define any number of parameters for the resource and reference those parameters in the SELECT statement. Parameters are passed in the URL as query strings.
The REST Export Parameters window opens when you click the Add link that appears next to the Parameters option on the REST Export Specification screen. Enter the required parameters in this window and click the Done button when your are finished.
Enter each parameter in it's respective field.
|
Format |
Description |
|
Name |
Enter the name of the parameter. |
|
In |
Indicates if this parameter should be specified in a query string or in a request header. Possible values are: query or header. |
|
Default |
Indicates that this parameter will have the value specified in the GET URL. For example, if the parameter name was CustomerID and the URL being processed was “http://dev.koretech.com/kourier/api/RWS/CUSTOMER/115” the value of CustomerID would be 115. |
|
Required |
Indicates that this parameter must contain a value. |
|
Field Type |
Select a field type from the Field Type drop-down menu. A detailed list of Field Types and their example usage can be found here. |
|
Edits |
Enter any Import Conversion and Validation. Edits must enclosed by the double or single quote characters. Multiple edits may be separated by the pipe (|) character. |
|
Min Length |
Enter the minimum number of characters. If a user enters less than the minimum number of characters, they will receive an error when they attempt to run the export. |
|
Max Length |
Enter a 0 (zero) if there is no maximum length, otherwise enter the maximum number of characters. |
|
Comments |
You may enter a text string describing the parameter. The text string must be enclosed by the double or single quote characters. |
If the passed parameter does not meet the constraints specified, the REST request will not be processed and an error message is returned.