About the Operation Parameters
When you select the
Parameters for an operation,
Designer displays a list of the input parameters in the REST resource service that corresponds to the operation. For each parameter,
Designer displays the following information:
Name, which matches the name of the input parameter in the corresponding service.
Source, which indicates the source of the parameters in the incoming request. The source corresponds to the “in” field for a fixed field in a parameter object as defined by the Swagger specification. A parameter can have one of the following source values:
QUERY
HEADER
PATH
FORMDATA
BODY
Designer assigns the parameter a Source value. If an input parameter for a service is a document or document reference, Designer assigns the parameter a source of BODY. You cannot change the source of a parameter set to BODY.
Description, which provides a description of the parameter.
Designer obtains the description from the
Comments property for the parameter in the corresponding REST resource service.
Required, which indicates whether or not the parameter is required in the input.
Designer obtains this value from the
Required property for the parameter in the corresponding REST resource service.
You can change the name, description, or required values for a parameter by modifying the parameter in the corresponding REST resource service. However, you can only change the source for a parameter in the REST API descriptor. Additionally, you can only change the source if the source value is not set to BODY.
