Describes the three types of interface field locations that can be assigned to JSON (RESTful) service interface fields.
Restriction: This topic applies only when the Enterprise Server feature is enabled.
Each JSON (RESTful) interface field or group is assigned one of the following locations:
- Body
- An interface field assigned to the
Body location means that it corresponds to the body of the JSON message. Each operation defined in a JSON RESTful service is limited
to one input, and one output field assigned to the
Body location, each of which is typically defined as a group field.
Body is the default location setting for all interface fields.
- Path
- The
Path option is for fields that correspond to the request URI used to invoke the operation. For
Path fields, you specify the corresponding part of the URI in the operation properties. All
Path interface fields must be input fields with a primitive data type, though they may have a nonzero
Occurs value expressed in the actual URI as a comma-separated array.
- Query
- The
Query option can also be applied to fields that correspond to the request URI used to invoke the operation.
Query interface fields correspond to the query string at the end of a request URI. All
Query interface fields must be input fields with a primitive data type, though they may have a nonzero
Occurs value expressed in the actual URI as a comma-separated array.
All interface fields are initially created as
Body fields; however, you can change the location of any field from the
Interface Fields pane in the Interface Mapper. See
To edit field properties for details.
Note: A
Path or
Query interface field does not require mapping if it is intended to be used for output filtering only. See
Output Filtering for details.