| Tagged Value | Description | Allowed Values |
|---|
Http Method
(httpMethod) | | Multiexcerpt include |
|---|
| MultiExcerptName | httpMethod |
|---|
| PageWithExcerpt | REST |
|---|
|
| a valid HTTP method | GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS |
| none | - method name, if it is one of: GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS (with optional trailing '/')
- GET otherwise
|
Relative Path
(relativePath) | | Multiexcerpt include |
|---|
| MultiExcerptName | relativePath |
|---|
| PageWithExcerpt | REST |
|---|
|
| none | The name of the REST method will be used. |
| any valid string | The given name will be used. The relative path may also contain variables (REST path parameters, specified as :<variable name>) and can be segmented like e.g. /date=:<a date variable>. |
Is Verbatim Path
(isVerbatimPath) | Disable most of the path normalization. All escaping must be done manually, leading or trailing whitespaces are preserved. | Multiexcerpt |
|---|
| MultiExcerptName | isVerbatimPath |
|---|
| This is what still will be done, if isVerbatimPath is set to true: - variable discovery
The E2E Runtime will try to find and replace variables (:<my variable name>). - colon escaping
If the path contains a colon that (and that does not indicate a path parameter), you can escape this colon by another one, like :: (e.g. /myAPI/resource/aText::anotherText/:variable). - correction of segment delimiters
The E2E Compiler adds a leading slash (if not present), removes trailing slashes (if present) and removes duplicates slashes, e.g. myAPI//resource/:variable/ becomes /myAPI/resource/:variable.
|
| true | Path should be treated as verbatim, path normalization is disabled. |
| false (default) | Path should be URL encoded. |
Blob Body Content Type
(blobBodyContentType) | | Multiexcerpt |
|---|
| MultiExcerptName | blobBodyContentType |
|---|
| Specify a default the content type for Blob response parameters from this endpoint. This must be a list of valid media ranges (as defined in RFC 7231) that the request will be sending. The Runtime generates a matching "Content-Type" header to your request.
Refer to Handling Blobs in the REST Interface for a deeper explanation and some examples.
| Info |
|---|
| This tag must be left unset if no Blob output parameters are used. In future versions, the effect of this tag may be extended to other contexts as well.
|
|
| a list of valid media ranges | e.g. application/msexcel
Default is application/octet-stream if not specified. |
Reject Other Response Content Type
(rejectOtherResponseContentTypes) | | Multiexcerpt |
|---|
| MultiExcerptName | rejectOtherResponseContentTypes |
|---|
| Runtime 2021.6 Builder 7.15.0 0 The xUML Runtime performs a verification of the content-type header for REST responses. Specify whether to return an error (HTTP 406, not acceptable) on responses with a content type that does not conform with the content types specified in Blob Body Content Type .
Refer to Handling Blobs in the REST Interface for a deeper explanation and some examples. |
| true | - Reject to perform adapter call if the header "content-type" does not match the values listed in Blob Body Content Type (default) .
- Exception:
RESTLM/48: Request content type not declared as accepted by the service
|
| false | Perform the adapter call in spite of content-type header mismatch, and let the service handle this. |
Accepted Request Content Type
(acceptedRequestContentType) | | Multiexcerpt |
|---|
| MultiExcerptName | acceptedRequestContentType |
|---|
| Runtime 2021.6 Builder 7.15.0 0 Provide a list of content types this REST endpoint acceptsyou accept as a response. This must be a list of valid media ranges "accept" headers as defined in RFC 7231. The Runtime generates a matching "Accept" header to your request.
Refer to Handling Blobs in the REST Interface for a deeper explanation and some examples. | Info |
|---|
| This tag must be left unset if no Blob output parameters are used. In future versions, the effect of this tag may be extended to other contexts as well.
|
|
| a list of valid media ranges | e.g. application/xhtml+xml
Default is application/octet-stream if not specified. |
Reject Other Request Content Types
(rejectOtherRequestContentTypes) | | Multiexcerpt |
|---|
| MultiExcerptName | rejectOtherRequestContentTypes |
|---|
| Runtime 2021.6 Builder 7.15.0 0 Specify whether to return an error on requests with a content type that does not conform with the content types specified in Accepted Request Content Type .
Refer to Handling Blobs in the REST Interface for a deeper explanation and some examples. |
| true | - Reject to perform adapter call if the header "accept" does not match the values listed in Accepted Request Content Type (default).
- Exception:
Set "accept" header does not accept any of declared response content types
|
| false | Perform the adapter call in spite of accept header mismatch and let the service handle this. |