REST Agent Jobs: Web Services Settings

{"URL":["/*.*/awa/pa_view_sheet_ra_webservice_rest_job"],"heroDescriptionIdentifier":"ice_hero_REST_Job","customCards":[{"id":"ice_General_REST_Job","title":"Defining the General Section","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_REST/*.*/Agent%20Guide/Content/REST/REST_Jobs_WebServices.htm","languages":["en-us"]},{"id":"ice_Advanced_REST_Job","title":"Defining the Advanced Section","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_REST/*.*/Agent%20Guide/Content/REST/REST_Jobs_WebServices.htm","languages":["en-us"]},{"id":"ice_Integration_Report","title":"Integration Reports","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_REST/*.*/Agent%20Guide/Content/REST/REST_Jobs_IntegrationReports.htm","languages":["en-us"]},{"id":"ice_WSJob_script_REST","title":"Setting Web Service Job Parameters through Scripts","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_REST/*.*/Agent%20Guide/Content/REST/REST_Using_Scripts.htm","languages":["en-us"]},{"id":"ice_related_information_REST_Job","title":"Related Information","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_REST/*.*/Agent%20Guide/Content/REST/REST_Jobs_WebServices.htm","languages":["en-us"]}]}

REST Agent Jobs let you define requests with complex queries and responses in one single object. They also lets you parse the values returned in the response into various types of outputs that you can use, for example, in subsequent Jobs in a Workflow.

A REST Agent Job consists of several definition pages. Some of them are common to all Integration Agents. Others are common to all executable objects in Automic Automation.

Important!

Registered output files for REST Agent Jobs are saved to the task_reports directory under the bin directory. They will remain there until you move or delete them. For information about this functionality, please refer to the Automic Automation product documentation at Registering External Output Files.

Defining REST Agent Web Services Job Properties

On the Web Services page, you define the parameters relevant to run that job on REST from Automic Automation:

  • Enable the connection between the Job and the target Web Service

  • Determine the content of the execution reports

  • Specify the target Web Service endpoint

  • Define the timeout

General Section

    • Connection

      • Select the Connection object that establishes the connection between the REST Agent and the target REST Web Service. For more information, see Establishing the Connection between the REST Agent and the Target System.

    • Write response to Job Log

      • Select it if you want the REST Agent to print the whole response to the Job log.

    • Create Request Reports

      • Select it if you want to create and register a report with the request data. These reports are written to the task_reports directory.

    • Create Response Report

      • Select it if you want to create and register a report with the response data. These reports are written to the task_reports directory.

    • URI Endpoint

      • This field is read-only. It dynamically lists the full URI on the target REST Web Service as defined in URL Endpoint in the Connection object, see .

    • Override URI Endpoint

      • The full URI that you enter here will override the URI, resource, and query parameters for this Job. You need to do this if, for example, you have duplicated an existing and already configured REST Job and you want to adjust some of its parameters.

Advanced Section

    • Connection Timeout

      • Define the number of seconds before timing out while attempting to connect to the URL endpoint. When set to 0, the connection never times out. When no timeout is specified, the Job's Connection object setting is used.

    • Read Timeout

      • Define the number of seconds before timing out when waiting for a method call. When set to 0, the read never times out. When no timeout is specified, the Job's Connection object setting is used.

    • Trace Performance Metrics

      • If you select this option, statistics on how long the call and parsings took are written to the Job report. Additionally, the following object variables are set with the metrics that can be reported upon:

      • COMPILE_REQUEST_DURATION
      • COMPILE_RESPONSE_DURATION
      • ROUNDTRIP_DURATION

Notes

See also: