Editing a REST API URL

This procedure describes how to edit the REST API URL settings, which enables you to specify the endpoint where the REST API is sent. You can set parameters at both the endpoint (REST Web Service server location) and authentication to expose them to the end user, which connects to different applications from different connection profiles of this job type.

Begin

  1. In the URL Location field, click .

    The RESTful API Endpoint settings window appears.

  2. If you want to change the URL, in the RESTful API URL field, type or edit the URL.

  3. Add parameters by clicking and select one of the following:

    • A previously defined parameter from the list

    • A new parameter by selecting Create Parameter and then click either In Jobform or In Connection Profile and then type the parameters, as described in General Parameters.

      NOTE: If you want to restore the URL to the previous defined URL, click Reset.

  4. If REST API URL requires authorization, select the This RESTful URL requires authentication checkbox and select one of the following:

    • Basic: Sends an encrypted request with user name and password to the server. For more information about REST API basic authentication parameters, see REST API Authentication Parameters

    • OAuth2: Sends a secured request to the server using OAuth 2.0 protocol. For information about the OAuth2 parameters, see OAuth2 Parameters.

    • AWS: Sends a secured request to the server using AWS. For information about AWS parameters, see AWS Parameters.

    • Google Service Account: Sends a secured request to the server using Google services. For more information about Google Service Account parameters, see Google Service Account Parameters.

  5. Click Save.