Attribute
(Name of Setting) | Description | Allowed Values |
|---|
Http Method
(httpMethod) | Provide the HTTP method of this REST method should respond to. | 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) | Defines the path of the REST method in relation to the parent resource. | 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) | | Multiexcerpt include |
|---|
| SpaceWithExcerpt | INTERNAL |
|---|
| MultiExcerptName | isVerbatimPath |
|---|
| PageWithExcerpt | INTERNAL:_designer_excerpts_stereotypes |
|---|
| shouldDisplayInlineCommentsInIncludes | false |
|---|
|
| true | Path should be treated as verbatim, path normalization is disabled. |
| false (default) | Path should be URL encoded. |
Blob Body Content Type
(blobBodyContentType) | Specify a default the content type for Blob response parameters from this endpoint. This must be a list of valid Accept headers (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 attribute must be left unset if no Blob output parameters are used. In future versions, the effect of this attribute may be extended to other contexts as well.
|
| a list of valid media rangesrange | e.g. applicationimage/msexcelpng
Default is application/octet-stream if not specified. |
Reject Other Response Content Types
(rejectOtherResponseContentTypes)
| The xUML Runtime performs a verification of the content-type header for REST responsescalls. Specify whether to return an error (HTTP 406, not acceptable) on responses for requests 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 "contentContent-typeType" header does not match the values value 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"Content-type Type" header mismatch, and let the service handle this. |
Accepted Request Content Types
(acceptedRequestContentType)
| Provide a list of content types this REST endpoint acceptsyou accept as a response. This must be a list of valid Accept "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 attribute must be left unset if no Blob output parameters are used. In future versions, the effect of this attribute may be extended to other contexts as well.
|
| a list of valid media ranges | e.g. application/xhtml+xml image/jpeg;image/png
Default is application/octet-stream if not specified. |
Reject Other Request Content Types
(rejectOtherRequestContentTypes)
| Specify whether to return an error on requests for responses 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" the content types the service returns (Blob Body Content Type of service) 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 "Accept" header mismatch and let the service handle this. |