Establishing the Connection between the REST Agent and the Target System

{"URL":["/*.*/awa/pa_view_sheet_ra_webservice_rest_connection"],"heroDescriptionIdentifier":"ice_hero_CONN_REST","customCards":[{"id":"ice_specific_CONN_REST","title":"Overview of the REST Connection Parameters","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_REST/*.*/Agent%20Guide/Content/REST/REST_Connection.htm","languages":["en-us"]},{"id":"ice_authenticate_CONN_REST","title":"Defining the General Section","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_REST/*.*/Agent%20Guide/Content/REST/REST_Connection_Authenticate.htm","languages":["en-us"]},{"id":"ice_resources_CONN_REST","title":"Defining the Resources","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_REST/*.*/Agent%20Guide/Content/REST/REST_Connection_Resources.htm","languages":["en-us"]},{"id":"ice_HTTP_CONN","title":"Defining the HTTP Request Headers","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_REST/*.*/Agent%20Guide/Content/REST/REST_Connection_HTTP_Request_Headers.htm","languages":["en-us"]},{"id":"ice_Query_CONN_REST","title":"Defining the Query Parameters","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_REST/*.*/Agent%20Guide/Content/REST/REST_Connection_Query_Params.htm","languages":["en-us"]},{"id":"ice_Proxy_CONN_REST","title":"Defining the Proxy Section","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_REST/*.*/Agent%20Guide/Content/REST/REST_Connection_Proxy.htm","languages":["en-us"]},{"id":"ice_Advanced_CONN_REST","title":"Defining the Advanced Section","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_REST/*.*/Agent%20Guide/Content/REST/REST_Connection_Advanced.htm","languages":["en-us"]},{"id":"ice_related_information_CONN_REST","title":"Related Information","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_REST/*.*/Agent%20Guide/Content/REST/REST_Connection.htm","languages":["en-us"]}]}

To make the communication between the REST Agent and the REST Web Service possible, you need Connection objects. Automic Automation Connection objects store all the connection information to a service endpoint and define the security protocol and corresponding credential information.

REST Connection objects play an additional role. They let you predefine global parameters that will be then available for selection when creating REST Jobs, namely the HTTP request header, the query parameters and the resource.

As an administrator user, you create the REST Connection objects. As a developer or object designer, you assign the respective Connection object to the REST Jobs.

This topic explains how to start creating a REST Connection object and provides links to the topics that describe how to fully configure it.

To Create a REST Agent Connection Object

In the Process Assembly perspective, right-click where you want to add the object and select Add > Add Object.
On the Add Object dialog, select Connection > WEBSERVICEREST > RESTCONNECTION Connection.
On the Object Name dialog enter a meaningful Name and, optionally, a Title that let you identify the purpose of this Connection object later on.
Click OK. The Connection object definition view opens to the Web Service page.
In URL Endpoint enter the URL endpoint where the Web Service that you want to connect to resides.
Select the Authentication method that the Agent will use to authenticate to the target system. Depending on your selection, you will have to configure different parameters. For more information, see Configuring the Authentication Methods for the REST Agent.
Define the Resources, see Defining Resources for REST Agent Connection Objects.
Define the HTTP Request Headers, see Defining the HTTP Request Headers for REST Agent Connection Objects.
Define the Query Parameters, see Defining the Query Parameters for REST Agent Connection Objects.
Define a Proxy server, see Using a Proxy Server to Establish the Connection.
Define the Advanced options, see Defining Timeouts and Redirects for REST Agent Connection Objects.
Save the object.