{"id":20100,"date":"2020-07-01T10:15:04","date_gmt":"2020-07-01T10:15:04","guid":{"rendered":"http:\/\/www.greytrix.com\/blogs\/sagex3\/?p=20100"},"modified":"2022-03-09T10:05:46","modified_gmt":"2022-03-09T10:05:46","slug":"the-narration-of-function-and-its-parameter-used-to-call-an-external-outgoing-rest-web-service-from-asyrrestcli-library","status":"publish","type":"post","link":"https:\/\/www.greytrix.com\/blogs\/sagex3\/2020\/07\/01\/the-narration-of-function-and-its-parameter-used-to-call-an-external-outgoing-rest-web-service-from-asyrrestcli-library\/","title":{"rendered":"The narration of function and its parameter used to call an external\/outgoing REST web service from ASYRRESTCLI library"},"content":{"rendered":"\n

The function “EXEC_REST_WS” is used to call an\nexternal\/outgoing REST web service from ASYRESTCLI library and returns the\nstatus of the operation, the  parameters\nused in the function are described below,<\/p>\n\n\n\n\n\n

Parameter\n1:<\/strong><\/p>\n\n\n\n

Code               :<\/strong>NAME<\/p>\n\n\n\n

Data Type       :<\/strong>Char<\/p>\n\n\n\n

Description     : <\/strong>Name of the REST web service created.<\/p>\n\n\n\n

Parameter 2:<\/strong><\/p>\n\n\n\n

Code               :<\/strong>HTTPMETHOD<\/p>\n\n\n\n

Data Type       :<\/strong>Clbfile<\/p>\n\n\n\n

Description     : <\/strong>HTTP methods can be used on any endpoint\nwhich map to application create, read, update, and delete (CRUD) operations:<\/p>\n\n\n\n

\n HTTP method<\/strong>\n <\/td>\n CRUD<\/strong>\n <\/td>\n Action<\/strong>\n <\/td><\/tr><\/thead>
\n GET\n <\/td>\n Read\n <\/td>\n Returns requested data\n <\/td><\/tr>
\n POST\n <\/td>\n Create\n <\/td>\n Creates a new record\n <\/td><\/tr>
\n PUT \n <\/td>\n Update\n <\/td>\n Updates an existing record\n <\/td><\/tr>
\n DELETE\n <\/td>\n Delete\n <\/td>\n Deletes an existing record\n <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

.<\/p>\n\n\n\n

Parameter 3:<\/strong><\/p>\n\n\n\n

Code               :<\/strong>SUBURL<\/p>\n\n\n\n

Data Type       :<\/strong>Char<\/p>\n\n\n\n

Description     :<\/strong> It is a sub-URL that appends to the main\nURL ,Main URL which specified while creating REST web service in x3.<\/p>\n\n\n\n

Parameter 4:<\/strong><\/p>\n\n\n\n

Code               :<\/strong>PARAM_COD<\/p>\n\n\n\n

Data Type       :<\/strong>Char Array<\/p>\n\n\n\n

Description     : <\/strong>Names that can be used as URL parameters.<\/p>\n\n\n\n

Parameter 5:<\/strong><\/p>\n\n\n\n

Code               :<\/strong>PARAM_VAL<\/p>\n\n\n\n

Data Type       :<\/strong> Char Array<\/p>\n\n\n\n

Description     : <\/strong>Values corresponding to property names\ndefined in PARAMS_COD.<\/p>\n\n\n\n

Parameter 6:<\/strong><\/p>\n\n\n\n

Code               :<\/strong>HEADER_COD<\/p>\n\n\n\n

Data Type       :<\/strong> Char Array<\/p>\n\n\n\n

Description     : <\/strong>Names that can be sent in the request header\nas parameters..<\/p>\n\n\n\n

Parameter 7:<\/strong><\/p>\n\n\n\n

Code               :<\/strong>HEADER_VAL<\/p>\n\n\n\n

Data Type       :<\/strong> Char Array<\/p>\n\n\n\n

Description     :<\/strong>Values corresponding to property name\ndefined in HEADER_COD.<\/p>\n\n\n\n

Parameter 8:<\/strong><\/p>\n\n\n\n

Code               :<\/strong>DATA<\/p>\n\n\n\n

Data Type       :<\/strong>Clbfile<\/p>\n\n\n\n

Description     : <\/strong>Data that is sent with POST and PUT methods.<\/p>\n\n\n\n

Parameter 9:<\/strong><\/p>\n\n\n\n

Code               :<\/strong>Mode<\/p>\n\n\n\n

Data Type       :<\/strong>Integer<\/p>\n\n\n\n

Description     : <\/strong>If 1, the web service is called in ‘future’\nmode; if 0, the ‘wait’ mode is used.<\/p>\n\n\n\n

The difference between Wait and Future mode, wait mode is synchronous ,\nthe call has to wait until receives a response back from the external REST web\nservice, while on the Future ( asynchronous) a unique identifier is created,\nand you can later on retrieve the result of your external call  with that\nUUID.<\/p>\n\n\n\n

Parameter 10:<\/strong><\/p>\n\n\n\n

Code               :<\/strong> RETURNS<\/p>\n\n\n\n

Data Type       :<\/strong>Char<\/p>\n\n\n\n

Description     : <\/strong>If empty, the whole JSON feed is returned in\nRESBODY; if not empty, only the value of the corresponding property is returned\nin RESBODY.<\/p>\n\n\n\n

Parameter 11:<\/strong><\/p>\n\n\n\n

Code               :<\/strong> RESHEAD<\/p>\n\n\n\n

Data Type       :<\/strong>Clbfile<\/p>\n\n\n\n

Description     : <\/strong>The response header returned by the web\nservice.<\/p>\n\n\n\n

Parameter 12:<\/strong><\/p>\n\n\n\n

Code               :<\/strong> RESBODY<\/p>\n\n\n\n

Data Type       :<\/strong> Clbfile<\/p>\n\n\n\n

Description     :<\/strong> The response body returned by the web\nservice.<\/p>\n\n\n\n

Conclusion:<\/strong><\/p>\n\n\n\n

This blog helps\nto understand what are the parameters with \nits description and data type  used in EXEC_REST_WS function and also how to\nuse synchronous and asynchronous mode.<\/p>\n\n\n\n

Related Keywords:<\/strong> REST web\nservices,EXEC_REST_WS,ASYRESTCLI,Parameters of EXEC_REST_WS function, Wait and\nFuture Mode, Synchronous and Asynchronous mode.<\/p>\n\n\n\n

Subscribe for more blogs!!!<\/strong><\/p>\n\n\n\n

About Us<\/strong><\/h2>\n\n\n\n

Greytrix \u2013 a globally recognized and one of the oldest Sage Development Partners is a one-stop solution provider for Sage ERP and Sage CRM organizational needs. Being acknowledged and rewarded for multi-man years of experience and expertise, we bring complete end-to-end assistance for your technical consultations, product customizations, data migration, system integrations, third-party add-on development, and implementation competence.<\/p>\n\n\n\n

Greytrix has some unique integration solutions developed for Sage CRM<\/a> with Sage ERPs namely Sage X3<\/a>, Sage Intacct<\/a>, Sage 100<\/a>, Sage 500<\/a>, and Sage 300<\/a>. We also offer best-in-class Sage ERP and Sage CRM customization and development services to Business Partners, End Users, and Sage PSG worldwide. Greytrix helps in the migration of Sage CRM from Salesforce | ACT! | SalesLogix | Goldmine | Sugar CRM | Maximizer. Our Sage CRM Product Suite includes addons like  Greytrix Business Manager, Sage CRM Project Manager, Sage CRM Resource Planner, Sage CRM Contract Manager, Sage CRM Event Manager, Sage CRM Budget Planner, Gmail Integration, Sage CRM Mobile Service Signature, Sage CRM CTI Framework.<\/p>\n\n\n\n

Greytrix is a recognized Sage Champion Partner for GUMU™ Sage X3 \u2013 Sage CRM integration listed on Sage Marketplace<\/a> and Sage CRM \u2013 Sage Intacct integration listed on Sage Intacct Marketplace<\/a>. The GUMU™ Cloud framework<\/a> by Greytrix forms the backbone of cloud integrations that are managed in real-time for the processing and execution of application programs at the click of a button.<\/p>\n\n\n\n

For more information on our integration solutions, please contact us at sage@greytrix.com<\/a>. We will be glad to assist you.<\/p>\n","protected":false},"excerpt":{"rendered":"

The function “EXEC_REST_WS” is used to call an external\/outgoing REST web service from ASYRESTCLI library and returns the status of the operation, the  parameters used in the function are described below, Parameter 1: Code               :NAME Data Type       :Char Description     : Name of the REST web service created. Parameter 2: Code               :HTTPMETHOD Data Type       :Clbfile Description    \u2026 Read More »<\/a><\/span><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[8,2796,11],"tags":[3008,3004,3006,2398],"class_list":["post-20100","post","type-post","status-publish","format-standard","hentry","category-sage-erp-x3","category-technical","category-tips","tag-asyrrestcll","tag-narration-of-function","tag-rest-web-service","tag-web-service"],"_links":{"self":[{"href":"https:\/\/www.greytrix.com\/blogs\/sagex3\/wp-json\/wp\/v2\/posts\/20100","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.greytrix.com\/blogs\/sagex3\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.greytrix.com\/blogs\/sagex3\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.greytrix.com\/blogs\/sagex3\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.greytrix.com\/blogs\/sagex3\/wp-json\/wp\/v2\/comments?post=20100"}],"version-history":[{"count":2,"href":"https:\/\/www.greytrix.com\/blogs\/sagex3\/wp-json\/wp\/v2\/posts\/20100\/revisions"}],"predecessor-version":[{"id":24776,"href":"https:\/\/www.greytrix.com\/blogs\/sagex3\/wp-json\/wp\/v2\/posts\/20100\/revisions\/24776"}],"wp:attachment":[{"href":"https:\/\/www.greytrix.com\/blogs\/sagex3\/wp-json\/wp\/v2\/media?parent=20100"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.greytrix.com\/blogs\/sagex3\/wp-json\/wp\/v2\/categories?post=20100"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.greytrix.com\/blogs\/sagex3\/wp-json\/wp\/v2\/tags?post=20100"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}