REST API
The Rest API Agents allow interaction with different applications using RESTful APIs.
The Context Provider allows you to get data from a defined RESTful API operation and output the entire contents to the Data Stream for contextual data. All rows in the file are made available to the output endpoint as a single event.
The Action Agent allows you to perform operations using RESTful API. This is useful when exchanging data between different applications when a RESTful API is available from the application.
Limitations:
They only support JSON-based REST APIs.
Pre-requisites
The Agents require a RESTful API metadata configuration file that contains the operations, their parameters, and the output schema of the operations.
Current Version
Please contact XMPro if you're looking for an older agent version.
Context Provider Release Notes
3.14
22 Jan 2025
Repackaged to translate the Agent's properties.
3.13
23 May 2024
Support nested JSON object/array response. Support fetching a Custom Header Auth token via separate REST call.
3.12
28 Nov 2023
Added variable support to Base URL, Username, Password, Bearer Token, and Custom Header Key. Do not use - incorrect GUID results in no upgrade path for this version.
3.11
06 Sep 2022
Repackaged to include the Agents Category.
3.10
21 Sep 2020
Added Bearer and Custom Header authentication options.
3.02
13 Aug 2018
Added OnError endpoint.
3.01
07 Aug 2018
Removed SSL3 protocol support.
3.0
03 Aug 2018
Initial Release.
Action Agent Release Notes
3.39
22 Jan 2025
Repackaged to translate the Agent's properties.
3.38
23 May 2024
Support nested JSON object/array response.
Support fetching a Custom Header Auth token via separate REST call.
Support entering parameters manually, rather than mapping them to Data Stream values.
3.37
11 Apr 2023
Removed Boon Amber authentication type on this generic Agent.
3.36
23 Mar 2023
Added field Authorization Endpoint field for OAuth2 authentication type.
Made OAuth2 field Scope optional.
3.35
01 Mar 2023
Added custom Boon Amber Authentication Type.
3.32
07 Feb 2023
Re-added the OAuth2 Authentication Type option. Added Refresh Client Token Interval (hours) to support the OAuth2 token refresh.
3.31
08 Nov 2022
Removed OAuth2 Authentication Type option until the token is refreshed to avoid a timeout.
3.30
08 Sep 2022
Corrected Authentication Type option from OAuth to OAuth2.
3.29
06 Sep 2022
Repackaged to include the Agent's Category.
3.28
16 May 2022
Added variable support.
3.26
08 Mar 2022
Added OAuth2 authentication option.
3.10
21 Sep 2020
Added Bearer and Custom Header authentication options.
3.04
28 Jan 2019
Duplicate check when adding headers to the http request.
3.03
13 Aug 2018
Fixed the date parsing issue and metadata file refresh issue.
3.02
13 Aug 2018
Added OnError endpoint.
3.01
07 Aug 2018
Removed SSL3 protocol support.
3.00
03 Aug 2018
Initial Release.
Last updated
Was this helpful?