UNIFYBroker Rest API Operation

Overview

The UNIFYBroker Rest API operation is an extension of the Rest API Operation and allows UNIFYNow to invoke UNIFYBroker operations via the UNIFYBroker Rest API.

The UNIFYBroker Rest API operation uses the Rest API agent. It does not use the UNIFYBroker agent.

Technical Requirements

The UNIFYBroker Rest API operation requires:

  • An instance of UNIFYBroker v5.0 or greater
  • An unobstructed network route between UNIFYNow and UNIFYBroker on the UNIFYBroker Rest API port: 59991

Usage

The UNIFYBroker Rest API operation can be used to invoke the internal UNIFYBroker operations which have been made available though the UNIFYBroker Rest API.

Success / Failure Result

The operation is always considered a success if the web request succeeds. If the request cannot be sent or the response is not received 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 UNIFYBroker Rest API operation requires the following by way of configuration:

Name
Description
Operation Type The type of UNIFYBroker operation to invoke.
Connector ID The GUID identifier of the UNIFYBroker connector for which to operate on.
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.
CHECK: A Rest API agent is required to configure a UNIFYBroker Rest API operation.


Standard Operation Rest API Operation UNIFYBroker

Is this article helpful for you?