Software AG Products 10.7 | Service Development Help | Properties | REST API Descriptor Properties | REST Definition Parameter Properties
 
REST Definition Parameter Properties
When you select a parameter on the REST Definitions tab, the Properties view displays information about the parameter, such as the name, description, and whether or not it is required.
Property
Description
Name
Parameter name. The parameter name corresponds to the name of a variable in the signature of the service used as an operation in the REST API descriptor.
Description
Parameter description. Integration Server obtains the description from the Comments property value for the variable in the signature of the service used an operation in the REST API descriptor.
Reference definition
If the parameter is a reference to a REST definition, displays the name of the referenced REST definition.
Required
Whether or not the parameter is required. A value of True indicates the parameter is squired. A value of False indicates the parameter is optional.