Creating REST RA Web Service Agent Jobs

To run a REST web service, you need to create a REST RA Web Service Agent Job.

To create a REST RA Web Service Agent Job:

  1. Add a Job object of type WEBSERVICE > REST and select your RA Web Service Agent solution object in the Host field on the Attributes tab.
  2. Select the following tab: 
    • In v9: Web Service
    • In v10 and above: REST
  3. Select the General menu item on the left side of the screen.
  4. Respond to the fields on the right side of the tab.
    5. Field Description

    Connection

    		 A REST RA Web Service Agent Connection object. The Connection object you select can connect to any Web Service agent that's available on the client. For more information on REST RA Web Service Agent Connection objects, see topic Creating REST RA Web Service Agent Connection Objects.

    Write Response to Job Log

    		 When checked, the RA Web Service Agent prints the whole response to the Job log.

    Create Request Reports

    		 Creates and registers a report with the request data. These reports are written to the task_reports directory.

    Create Response Report

    		 Creates and registers a report with the response data. These reports are written to the task_reports directory.

    Connection Timeout

    		 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

    		 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

    When checked, 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

    Execute cURL Command

    Allows you to enter cURL commands for execution. Because this option could be a security concern, it is turned off by default. cURL commands can only be entered when the Specifying General RA Web Service Agent Settings table below in the cURL command line.

    This is useful for example in order to not display the user name and password on the command line.

    https://api.twilio.com/2010-04-01/Accounts/{user}/SMS/Messages.xml -k -i -u {user}:{password}

    URI Endpoint

    		 Dynamically lists the full URI in a non-editable field.

    URI Override

    		 The full URI entered here will override URI, resource, and query parameters for this Job.
  5. Specify request and response settings using the menu items on the left side of the screen as documented in the following topics.

Replacement Values for cURL Commands

Replacement value: Will be replaced by the value of the:
{user} User field for Connection objects with Basic, Digest, or NTLM authentication.
{password} Password field for Connection objects with Basic, Digest, or NTLM authentication.
{client_key} Client Key field for Connection objects with OAuth 1.0a or OAuth 2.0 authentication.
{client_secret} Client Secret field for Connection objects with OAuth 1.0a or OAuth 2.0 authentication.
{authorization_token} Authorization Token field for Connection objects with OAuth 1.0a or OAuth 2.0 authentication.
{token_secret} Token Secret field for Connection objects with OAuth 1.0a authentication.
{access_key} Access Key field for Connection objects with AWS Signed URL authentication.
{secret_access_key} Secret Access Key field for Connection objects with AWS Signed URL authentication.
{verifier} Verifier field for Connection objects with OAuth 1.0a authentication.

Deleting Registered Files

Registered output files for Web Service Jobs are saved to the task_reports directory under the bin directory. They will remain there until you move or delete them.