ParamValue

Summary

Outbound parameter value.

Description

Represents an API method parameter used in OutboundProfiles.

Fields

Field Name	Type	Since Version	Description
name	String		The parameter name.
paramType	String		The type of parameter type. Can be one of: body, query, path, form, or header.
type	String		The parameter data type. Can be one of: string, integer, etc.
value	String		The parameter value. Can be a regular value, or a selector, e.g.: ${params.path.id}.
required	Boolean		Indicates whether or not the parameter is required for the backend API.
exclude	Boolean		Indicates whether or not the parameter is excluded for the backend API.
additional	Boolean		Indicates whether or not the parameter is an additional parameter (does not replace an existing parameter).

Example JSON

{
  "name" : "id",
  "paramType" : "query",
  "type" : "string",
  "value" : "${params.path.id}",
  "required" : true,
  "exclude" : false,
  "additional" : false
}