REST Parameter Object | Scheer PAS Documentation

This page explains the REST Import Rules in Bridge context. If you were looking for the same information regarding the PAS Designer, refer to OpenAPI Import Rules in the Designer guide.

Parameter objects can be defined inline or be a reference to a parameter of the parameters list.

Element	Used By Importer	Description	More Information at ...
`name`		The name of the parameter. Parameter names are case sensitive. If in is "path", the name field must correspond to the associated path segment from the path. For all other cases, the name corresponds to the parameter name based on the in property.	See Path Templating for further information.
`in`	( )	The location of the parameter. Possible values are "query", "header", "path" or "body". "formData" is not supported by the importer and ignored.
`description`		A brief description of the parameter
`required`		Determines whether this parameter is mandatory. If true, the multiplicity of the parameter is set to 1, else it is set to 0..1.
`schema`		If in is "body", schema defines the type used for the body parameter.	Schema Object
`type`		if in is other than "body", type defines the type of the parameter. integer: the base type Integer is used. number: the base type Float is used. boolean: the base type Boolean is used. string: the type depends on the format.byte: the base type Blob is used.date-time: the base type DateTime is used.otherwise the base type String is used. array: the parameter will be an <<E2EArray>> and the class of items is used as arrayElement. If `type` is not given at all, and the definition has no properties, it will be imported as `urn:Base Types.Any`.
`format`		The format of the object is used to be more specific when the type is string.
`items`		The item is a schema object to define the type of element in the array. Only used if type is array.	Schema Object