Kourier Integrator User Guide

Designing REST Resources > REST Export Specification > REST Export Parameters

REST Export Parameters

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.

Each parameter should be entered on a single line and may include any number of keywords to specify additional constraints on the parameter value passed in the query string. 

Usage

Enter each parameter on a separate line. 

Format

Description

COMMENT

You may enter a text string describing the parameter. The text string must be enclosed by the double or single quote characters.

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.

EDIT

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.

MAXLEN

Enter a 0 (zero) if there is no maximum length, otherwise enter the maximum number of characters.

MINLEN

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.

 

REQUIRED

Indicates that this parameter must contain a value.


If the passed parameter does not meet the constraints specified, the REST request will not be processed and an error message is returned.