RESTPoints Method Fields
The configurable fields available to edit are based the Method/Path (i.e. the HTTP verb) selected.
Field | Description | Notes |
|---|---|---|
Enabled | Click the checkbox to enable the RESTPoint. | |
Description | An optional description for the RESTPoint. | |
HTTP Method | Required. The method the RESTPoint will use. | Supported methods: GET; DELETE; HEAD; OPTIONS; PUT; PATCH; and POST |
Path | Required. The path must start with a forward slash and may contain one or more path parameter placeholders in the form of {name} as described by the @Path annotation in the JAX-RS API. | The combination of the Method and Path must be unique within the project. |
Authentication | The default authentication is the same as the project, however, the default authentication can be overridden on a specific RESTPoint. | Each enabled RESTPoint must have at least one authentication method defined. |
Produces | The MIME media type that the RESTPoint will return in the REST Response. | The available MIME media types are: application/json, application/xml, text/xml, text/plain, text/csv, text/html, application/octet-stream application/x-www-form-urlencoded |
Consumes | The MIME media type that the RESTPoint expects as the content of the REST Request. | This field is only enabled for PUT, PATCH, and POST methods. |
Action Set | Required. The Action Set to which the RESTPoint maps. | |
Input Properties | This table is populated automatically based on the existing Action Set called in the RESTPoint configuration. The Property column reflects the Action Set input property and is not editable. The type column reflects the defined input property type initially but is editable. The available types are ARRAY, BOOLEAN, NUMBER, BYTES, OBJECT, STRING, and XML. The Source column is the location from which the input parameter originates. If Source is left blank, then the value passed to the Action Set for that input property will be undefined. There are thirteen possible sources.
|