Individual Rights Manager Release - October 2, 2023

Release Version: v.2023.09.02
Release Date: October 2, 2023

In this release:

Key Features and Enhancements

Rapid API: Multiple REST API Dependencies
Ability to Upload .msg Files in Intake Forms
New Sub-Status Column and Filter in Main Request Page

Feature Details

Rapid API: Multiple REST API Dependencies

Benefits

Users need the ability to connect two Rest APIs, where the output of the first API can be the input of the second API.

Details

This enhancement enables users to connect two Rest APIs. Users can now create a Single API or link APIs in the Mapping tab.

Single APIs are stand alone APIs. Users cannot edit the single API to create and link a new API.
Linked APIs are also separate APIs that connect two APIs but users cannot delete either of the APIs to create a Single API.

Creating a Single API

From the Intake Form tab, under Mappings, select an Intake Form you wish to integrate. Then, select Single API from the Add New Rest API dropdown list.
In the Settings tab, select whether the integration is for Request or Task (1). Then, click Add Criteria (2) to add the criteria to be applied on the map. You can select multiple criteria as needed. Select a use case for API Usage from the list (3). Each use case can pair to any API method. Then, set the mapping (4) to Not Required if the current API call is not required, or set it to Required to require the API calls at all times if there are updates and to record the integration logs.
In the URL tab, select the HTTPS Method to use in the workflow (1) and enter the custom API URL (2) and URL Parameters (3). To use Variable Keys in URL input, it must be formatted specifically as [[${variable}]]. For example, https://www.website.com/[[${variable}]].
In the Params, Headers, and Body tabs, enter the keys and select a value for each key. You can also edit and delete the parameters you added.

Params Tab

Headers Tab

Body Tab

If you selected Verify Data in DSR Systems as API Usage in Step 2, IRM dynamically displays the Response Mapping tab.
Click Save to save the integration setup or you can also click Save & Add Another API to add more APIs.

Creating Linked APIs

From the Intake Form tab, under Mappings, select an Intake Form you wish to integrate. Then select Linked APIs from the Add New Rest API dropdown list.
In the Add New Rest API window, set up the 1st and 2nd API.

Setting Up the 1st API

a. In the 1st API Settings tab, select whether the integration is for Request or Task. Then, click Add Criteria to add the criteria to be applied on the map. You can select multiple criteria as needed. Select a use case for API Usage from the list. Each use case can pair to any API method. Then, set the mapping to Not Required if the current API call is not required, or set it to Required to require the API calls at all times if there are updates and to record the integration logs.

b. In the 1st API URL tab, select the HTTPS Method to use in the workflow and enter the custom API URL and URL Parameters. To use Variable Keys in URL input, it must be formatted specifically as [[${variable}]]. For example, https://www.website.com/[[${variable}]].

c. In the 1st API Params, Headers, and Body tabs, enter the keys and select a value for each key. You can also edit and delete the parameters you added.

Params Tab

Headers Tab

Body Tab

d. In the 1st API Output tab, input a JSON body to be used as input to the 2nd API.

If you delete or change the Output JSON Variable or the URL parameter and the keys or parameters are already used in the 2nd API or mapped in the 2nd API, an error message displays in the modal and in the log when you execute the integration.

Changed or Deleted Variables

Changed or Deleted URL Variables

If you change the JSON variable (or URL variable) in the 1st API, IRM displays a warning that states, “Changing the JSON variable (or URL variable) will result to loss in mapping connection with the 2nd API."

Setting Up the 2nd API

a. In the 2nd API Settings tab, note that the components such as Migration Criteria, API Usage, and Mapping requirement are disabled since the values are inherited and can only be set in the 1st API.

b. In the 2nd API URL tab, select the HTTPS Method to use in the workflow and enter the custom API URL and URL Parameters. To use Variable Keys in URL input, it must be formatted specifically as [[${variable}]]. For example, https://www.website.com/[[${variable}]].

c. The 2nd API Params, Headers, and Body tabs, contain the form metadata, fields, and the 2nd API Output variable.

Params Tab

Headers Tab

Body Tab

d. Click Save to save the integration set up or you can also click Save & Add Another API to add more Linked APIs.