A2019 API Package

 RPA | A2019 API Command/Package| Automation Anywhere - Part-27


A2019 API Package | A2019 API package is used when we want to extract information from any web application with the help of web services.

First of all we will discuss about what is an API.

API or Application Programming Interface is a set of code that allows the transmission of data between a software product and another. So in short, API usually are used to retrieve the information from the web server that is being requested by the user and after retrieving the information sends it back to the user with the desired information. This extraction of data is being performed using various web services methods that are being provided such as REST web services and SOAP web services.

First of all we will discuss how to use REST web service method for data extraction using A2019 Automation Anywhere.

REST web service method - REST provides actions to perform web services operations. We will discuss each of the actions in detail that is being provided under this command. The actions provided under this package are as follows:-

  • Get Method - The Get method reads the information in the form of an entity that is identified by the Request URI. URI stands for Uniform Resource Identifier. We need to enter the following details as an input such as URI, then select the authentication mode if URI contains any authentication process, and assign the output to a dictionary variable data type.
  • Put Method - The Put action replaces the information (in the form of an entity) that is identified by the Request URI. In the properties section we need to pass the URI, select the authentication mode if any, then pass the content type, enter the custom parameters if needed to pass and assign the output to a dictionary variable data type.
  • Post Method - The Post method creates or adds the information (in the form of an entity) which is being identified by the Request URI. In the properties section we need to pass the URI of the application, authentication mode if applicable else select no authentication from the drop down, select the content type from the drop down again, enter the custom parameters if required to pass and assign the output to a dictionary variable data type.
  • Patch Method - The Patch method partially replaces the information (in the form of an entity) which is being identified by the Request URI. In the properties section we need to pass the URI of the application, select the mode of authentication if applicable else select no authentication mode, then select the content type and enter the custom parameters and assign the output to a dictionary variable data type.
  • Delete Method - The Delete method deletes the information (in the form of an entity) which is being identified by the Request URI. In the properties section pass in the URI of the application, select the mode of authentication if applicable else select no authentication, select the content type and enter the custom parameters that needs to be deleted and assign the output to a dictionary variable data type.

Here is the code snippet for the REST web service commands.




In the next section we will discuss about SOAP web service in detail and how to implement SOAP web service method in A2019 Automation Anywhere.

If you have any queries related to this article you can share your queries in the comment section and I will be more than happy to answer all your queries.

Comments