Rest API Operation

Overview

The Rest API operation is used to send a request to a RESTful web service. This can be used to trigger operations or events in the system which provides the RESTful web service.

Technical Requirements

The Rest API operation requires a system which provides a RESTful web service which provides a resource which:

  1. Triggers an internal action or operation.
  2. Uses the HTTP methods GET or POST
  3. Does not require any authorization or validation which requires additional requests or specialized header information.
  4. Does not require multiple requests or other actions based on values contained in the response message.

Usage

The Rest API operation can be used in any part of an operation list and how it is used is reliant on the nature of the action it will invoke.

Success/Failure Results

The operation is always considered a success if the web request succeeds. If the request cannot be sent, the response is not received, or the response status code does not match the expected status code (see Configuration below) the operation will fail and prevent the operation list from continuing operation.

Configuration

In addition to the common operation configuration settings shared by all standard operations, the Rest API has a number of configuration options:

Name
Description
Relative URI The URI for the request relative to the base URI configured in the Rest API agent. For example: /api/v1/user/jim
Request Type The HTTP method for the request.
Expected Response Status The expected HTTP status code in the response message. Consult the documentation for the RESTful web service being connected to for more information on which status to select.
Run Asynchronously If checked, the operation list will continue without waiting for the REST request to complete and the operation will always succeed, regardless of the outcome of the request.
Request Values Zero or more attribute names and values can be added to include in the request. If POST is selected for the Request Type these values will be included in the request body. If GET is selected for Request Type, these values will be added to the URL query string.
CHECK: A Rest API agent is required to configure a Rest API operation.


Standard Operation Rest API Operation

Is this article helpful for you?