Mapping Polling APIs

Overview

Polling APIs enable you to use Rapid API in IRM to connect to a system that supports REST APIs to fetch data for access requests and generate reports. This API type enables you to connect a set of three APIs to find data in that system.

To map Polling APIs, select Polling APIs from the Add New Rest API dropdown list to begin adding migration criteria and setting up the integration.

Add New Rest API dropdown with Polling APIs selected

When you select Polling APIs, the Add New Job REST API window displays, containing three APIs to configure.

1st API — Create Job

The first API creates a job in the third-party system. The output of this API is the job ID.

1st API tab for creating a job and returning a job ID
2nd API — Check Job Status

The second API checks the status of the job by passing the job ID. The system checks periodically until the status is complete for that job. The poll interval is every 15 minutes.

📋 Poll limit: You can set the maximum number of times the integration runs. The maximum poll limit is 1–20. If you set it to 0, the system automatically sets it to 1. If it exceeds 20, it is automatically capped at 20.

2nd API tab for checking job status with poll limit setting

In the Output Condition tab of the 2nd API, you can add one or more conditions and set the third-party attributes to be equal to IRM attributes.

Output Condition tab of the 2nd API showing third-party to IRM attribute mapping
3rd API — Fetch Results

The third REST API fetches the results of the job. The system then adds the output to the request.

3rd API tab for fetching job results and attaching output to the request
TrustArc  ·  IRM — Rapid API Polling APIs  ·  support.trustarc.com