Call_Rest_EP_Empty_Body_Sync2¶

This will initiate the synchronous REST call with an empty message payload. This method can be used to send BINARY (BLOB) data which there is no payload send from PL/SQL end since the data is retrieved by the middle tier later. Since this is a synchronous call, response of the rest service can be received as a CLOB. This method uses document structure for structural parameters.

PROCEDURE Call_Rest_EP_Empty_Body_Sync2 (
   xml_                    OUT    CLOB,
   rest_service_           IN     VARCHAR2,
   url_params_             IN     Document DEFAULT NULL,
   callback_func_          IN     VARCHAR2 DEFAULT NULL,
   http_method_            IN     VARCHAR2,
   http_req_headers_       IN     VARCHAR2 DEFAULT NULL,
   query_parameters_       IN     Document DEFAULT NULL,
   header_params_          IN     Document DEFAULT NULL,
   incld_resp_info_        IN     BOOLEAN DEFAULT NULL,
   fnd_user_               IN     VARCHAR2 DEFAULT NULL,
   key_ref_                IN     VARCHAR2 DEFAULT NULL,
   blob_info_              IN     VARCHAR2 DEFAULT NULL,
   sender_                 IN     VARCHAR2 DEFAULT NULL,
   receiver_               IN     VARCHAR2 DEFAULT default_recevier_,
   subject_                IN     VARCHAR2 DEFAULT NULL,
   in_order_               IN     BOOLEAN  DEFAULT FALSE,
   fail_notify_            IN     BOOLEAN  DEFAULT FALSE,
   failed_callback_fun_    IN     VARCHAR2 DEFAULT NULL,
   accepted_res_codes_     IN     VARCHAR2 DEFAULT NULL,
   auth_params_            IN     Document DEFAULT NULL);

PROCEDURE Call_Rest_EP_Empty_Body_Sync2 (
   response_               OUT    BLOB,
   rest_service_           IN     VARCHAR2,
   url_params_             IN     Document DEFAULT NULL,
   callback_func_          IN     VARCHAR2 DEFAULT NULL,
   http_method_            IN     VARCHAR2,
   http_req_headers_       IN     VARCHAR2 DEFAULT NULL,
   query_parameters_       IN     Document DEFAULT NULL,
   header_params_          IN     Document DEFAULT NULL,
   incld_resp_info_        IN     BOOLEAN DEFAULT NULL,
   fnd_user_               IN     VARCHAR2 DEFAULT NULL,
   key_ref_                IN     VARCHAR2 DEFAULT NULL,
   blob_info_              IN     VARCHAR2 DEFAULT NULL,
   sender_                 IN     VARCHAR2 DEFAULT NULL,
   receiver_               IN     VARCHAR2 DEFAULT default_recevier_,
   subject_                IN     VARCHAR2 DEFAULT NULL,
   in_order_               IN     BOOLEAN  DEFAULT FALSE,
   fail_notify_            IN     BOOLEAN  DEFAULT FALSE,
   failed_callback_fun_    IN     VARCHAR2 DEFAULT NULL,
   accepted_res_codes_     IN     VARCHAR2 DEFAULT NULL,
   auth_params_            IN     Document DEFAULT NULL);

Parameters¶

xml_

Response of the Rest Service as a CLOB

response_

Response of the Rest Service as a BLOB

rest_service_

The name of the Rest Service.

url_params_ URL parameters document.

callback_func_ Name of the Callback PL/SQL method.

http_method_ HTTP request method type.

http_req_headers_ Additional HTTP request headers.

query_parameters_ Optional. Query parameters of the URL.

header_params_ Optional. Header parameters.

include_resp_info_ Optional. Include the response code and response headers in the response.

fnd_user_ Optional. Can be used to pass the fnd_user who initiated the prediction call to the callback function.

key_ref_ Optional. Can be used to pass the key_ref_ of the business object to the callback function.

blob_info_ Details on BLOB data field such as Table Name, BLOB Column name and Key field and Key value.

sender_ Optional identity of sending organization. The value will be entered in FNDCN_APPLICATION_MESSAGE_TAB.SENDER.

receiver_ Optional identity of receiving organization. The value will be entered in FNDCN_APPLICATION_MESSAGE_TAB.RECEIVER.

subject_ Optional subject. The value will be entered in FNDCN_APPLICATION_MESSAGE_TAB.SUBJECT.

in_order_ Flag denoting if the message should be put to an InOrder queue. Default FALSE. If TRUE and it is not possible to find a queue or the found queue is not InOrder, an exception will be raised.

fail_notify_ Flag denoting if a notification should be sent when the request is failed. Default FALSE.

failed_callback_fun_ Optional. Name of the Callback PL/SQL method that needs to call for a failed request.

accepted_res_codes_ Optional. Rest sender can return a response based on the standard http response codes raised by each http operations. Accepted response codes in Rest Sender are 200. 202, 204, 500, 401, 301, 302, 303 and 400. If the http response code does not belong to above accepted set, Rest Sender will throw an error. Hence, if a particular response code which does not belong to above accepted response codes, but need to accept by Rest Sender, those response codes can be set as the value for this parameter. When setting more than one accepted codes, should use co

auth_params_ Optional. Authorization Parameters