› Integration › Web service references › Create a web service reference › Create a RESTful Open API web service reference

Create a RESTful Open API web service reference

Create a RESTful Open API web service reference by doing the following.

  1. On the Web service references page, select New.

    The New web service reference dialog box is displayed.

  2. On the Service type list, select RESTful Open API.
  3. Enter a Name for the web service.
  4. By default, the system automatically saves a new web service reference in your working category. To store the web service reference in a different category, select a category on the Category list.

    The categorization of web services helps restrict their access to specific users.

  5. Specify a valid Open API URL that describes the API.
    If the "Allow all" system setting is disabled, you can only provide a whitelisted web service URL. If the URL connection string is not whitelisted, the connection is denied. See Whitelist a web service URL or a database connection string.
  6. Select the Definition type as JSON or YAML. (Default: JSON)
  7. Select the Method names to use: Use Operation ID or Use HTTP verb. (Default: Use Operation ID)
  8. By default, the "Expect: 100-continue" header is included for POST RESTful API calls. If you need to send POST requests without this header, select Remove Expect 100-Continue header.
  9. To control access to the web service and not just restrict access to the configured TotalAgility Enterprise services account, select one of the following options for Authentication:

    Option Description

    Basic

    Enter the User name and Password for the endpoint.

    OAuth

    Select the OAuth server on the OAuth server list.

    When a RESTful web service with an integrated OAuth server is executed in a process map or form, any expired access tokens are automatically refreshed, and the web service is executed successfully. This action applies only to OAuth servers that have access tokens.

    Certificate

    1. Browse and upload or drag the certificate here to use to authenticate with the web service.

    2. Enter the Certificate password.

      If the certificate is not valid, an error is displayed at runtime.

    3. To view the certificate details, such as Issued to, Issued by, and Validity period, select View certificate, enter the password, and then select Get details.

    OAuth and certificate

    1. Upload the certificate.

    2. Select the OAuth server on the OAuth server list.

    Basic (external)

    Enter the secret name for the username and password stored in the configured external storage.

    Default (Default)

    Uses the Windows credentials of the TotalAgility service account user.

    When the RESTful service is executed through a process or form with Default authentication configured, the account running the TotalAgility services is passed during the web service call.

  10. Add a custom header.
  11. Select Save.