The Designer can handle blob parameters in the body of a REST interface for requests and responses. Blobs may contain different content types. How the content types should be handled can be configured on client and server side by four attributes provided by stereotype REST Operation for REST APIs and REST adapters.
This is only available for manually created REST interfaces. You cannot change REST operations that have been imported to a connector.
Find below an overview on these attributes and what combinations make sense. Accepted Request Content Type Reject Other Request Content Types Blob Body Content Type Reject Other Response Content Type You can only change the settings for adapter calls once you have copied the REST interface from the connector to your own service implementation - or if you have defined it manually from the beginning. Blob Body Content Type Reject Other Response Content Type Specifies if the REST adapter should reject calls to this endpoint if a request uses a custom content type that does not match the content types listed in Blob Body Content Type. Accepted Request Content Type Reject Other Request Content Types Specifies if the REST adapter should reject calls to this endpoint if a request uses a custom content type that does not match the content types listed in Accepted Request Content Type . The RESTAPI_BlobContent_Example and the RESTAdapter_BlobContent_Example implement a server and a client that exchange blob content (pictures). They have the following blob content setup implemented: The following table shows some example calls and how they would be executed. The following table shows some error cases and their consequences if you do not rely on the automatically generated headers but set your own headers instead. Reject Other Request Content Types = trueLocation Direction Attribute Description Service Request Define which content types the endpoint accepts. Define if other content types should be rejected with HTTP 406 (Not Acceptable). Response Define which content types the endpoint can return to the client. Define if the service should reject the request with HTTP 415 (Unsupported Media Type) if the client request has divergent accept headers. Adapter Request
Specify which content type you are sending with your request. The Runtime generates a matching "Content-Type" header to your request.
This can be the case if you set the content-type header manually. If set to true, and the content-type header does not match, the adapter does not contact the endpoint at all but rejects calls with an exception (Request content type not declared as accepted by the service).Response Specify a list of content types you accept as a response. The Runtime generates a matching "Accept" header to your request.
This can be the case if you set the accept header manually. If set to true, and the accept header does not match, the adapter does not contact the endpoint at all but rejects calls with an exception (Set "accept" header does not accept any of declared response content types).Examples
Server (RESTAPI_BlobContent_Example) Content Type Settings Description Store a picture POST /picture Accepted Request Content Type image/png;image/jpeg The server can store PNGs and JPGs. Return a picture by id GET /picture/<an id> Blob Body Content Type image/png The server returns PNGs upon request. Client (RESTAdapter_BlobContent_Example) Content Type Settings Send a picture POST /picture Blob Body Content Type image/png The client sends PNGs. Retrieve a picture GET /picture/<an id> Accepted Request Content Type image/png;image/jpeg The client accepts PNGs and JPGs as a response. Good Cases
Client Generated Header Server 1 Store a picture POST /picture Content-Type: image/png → accepts request ← returns id
HTTP 2012 Retrieve a picture GET /picture/123456 Accept: image/png → accepts request Content-Type: image/png ← returns picture PNG Error Cases
Client Custom Header Server 1 Store a picture, wrong content type POST /picture Content-Type: image/svg+xml → accepts request handles wrong content type internally 2 Store a picture, wrong content type,
server rejects other content typesPOST /picture Content-Type: image/svg+xml → ← HTTP 406 (not acceptable) 3 Retrieve a picture, wrong content type GET /picture/123456 Accept: image/svg+xml → accepts request handles wrong content type internally 4 Retrieve a picture, wrong content type,
server rejects other content typesGET /picture/123456 Accept: image/svg+xml → Reject Other Response Content Type = true ← HTTP 415 (Unsupported Media Type)
On this Page:
RESTAPI_BlobContent_Example
 |
Click the icon to download a simple example model that shows the implementation of a REST API that receives and returns Blob content with Scheer PAS Designer. |
RESTAdapter_BlobContent_Example
|
Click the icon to download a simple example model that shows how to handle Blob content with a REST call in Scheer PAS Designer. |
Overview
Content Tools