Call_Rest_EndPoint

This will initiate the REST call with message payload and other required parameters. This is an overloaded procedure where the message payload can be a record structure or a XML.

PROCEDURE Call_Rest_EndPoint (
   rest_service_	IN	VARCHAR2,
   message_payload_ 	IN OUT 	NOCOPY type_record_,
   url_params_ 		IN 	type_record_ DEFAULT NULL,
   callback_func_ 	IN 	VARCHAR2,
   http_method_ 	IN 	VARCHAR2,
   http_req_headers_ 	IN 	VARCHAR2 DEFAULT NULL,
   query_parameters_ 	IN 	type_record_ DEFAULT NULL,
   key_ref_ 		IN 	VARCHAR2 DEFAULT NULL,
   fnd_user_ 		IN 	VARCHAR2 DEFAULT NULL,
   sender_ 		IN 	VARCHAR2 DEFAULT NULL,   
   receiver_ 		IN 	VARCHAR2 DEFAULT default_recevier_,
   message_type_ 	IN 	VARCHAR2 DEFAULT 'EVENT',
   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,
   sync_                IN  BOOLEAN  DEFAULT FALSE);
   
PROCEDURE Call_Rest_EndPoint (
   rest_service_	IN	VARCHAR2,
   message_payload_ IN OUT Document,
   url_params_ 		IN 	DOCUMENT DEFAULT NULL,
   callback_func_ 	IN 	VARCHAR2,
   http_method_ 	IN 	VARCHAR2,
   http_req_headers_ 	IN 	VARCHAR2 DEFAULT NULL,
   query_parameters_ 	IN 	type_record_ DEFAULT NULL,
   key_ref_ 		IN 	VARCHAR2 DEFAULT NULL,
   fnd_user_ 		IN 	VARCHAR2 DEFAULT NULL,
   sender_ 		IN 	VARCHAR2 DEFAULT NULL,   
   receiver_ 		IN 	VARCHAR2 DEFAULT default_recevier_,
   message_type_ 	IN 	VARCHAR2 DEFAULT 'EVENT',
   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,
   sync_                IN  BOOLEAN  DEFAULT FALSE);


PROCEDURE Call_Rest_EndPoint (
   rest_service_	IN	VARCHAR2,
   xml_		 	        IN 	CLOB,
   url_params_ 		IN 	type_record_ DEFAULT NULL,
   callback_func_ 	IN 	VARCHAR2,
   http_method_ 	IN 	VARCHAR2,
   http_req_headers_ 	IN 	VARCHAR2 DEFAULT NULL,
   query_parameters_ 	IN 	type_record_ DEFAULT NULL,
   key_ref_ 		IN 	VARCHAR2 DEFAULT NULL,
   fnd_uder_ 		IN 	VARCHAR2 DEFAULT NULL,
   sender_ 		IN 	VARCHAR2 DEFAULT NULL,
   receiver_ 		IN 	VARCHAR2 DEFAULT default_recevier_,
   message_type_ 	IN 	VARCHAR2 DEFAULT 'EVENT',   
   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);

Parameters

rest_service_
   
The name of the BizAPI (EVENT BizAPI).

message_payload_
   
The message payload record or document.

xml_
    The message payload as an XML file.

url_params_
    URL parameters record.

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.

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

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

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.

message_type_
    Optional. The value will be entered in FNDCN_APPLICATION_MESSAGE_TAB.MESSAGE_TYPE.

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_
    Optional notification flag for failed messages.

failed_callback_fun_
    Optional. Name of the failed call back method.

accepted_res_codes_
    Optional. Additional HTTP Response codes to be accepted rather than throwing an Exception.

sync_
    Optional. By default Rest Sender supports asynchronous message flow. This flag should be set to make it synchronous.