Configuration
This section explains each of the properties in the configuration blade.

Property | Description |
---|---|
Collection | This associates this Agent to a specific Collection and defaults to that of the current Data Stream. |
Polling Interval (seconds) | A timespan to specify how often should the Agent check for new data/changes or update its cache. |
Property | Description |
---|---|
Base Url | |
Metadata File | The metadata configuration file includes the operations available, their operations, and the output schema of the operations. |
Use Authentication | Tick to provide REST API Authentication details; or connect to REST API anonymously. |
Authentication Type | The authentication methods supported are:
(applies when Use Authentication is ticked)
|
Username | The username required to access the API (applies to Basic Authentication Type only). |
Password | The password required to access the API (applies to Basic Authentication Type only). |
Bearer Token | The token for accessing the API (applies to Bearer Token Authentication Type only). |
Custom Header Key | The HTTP header key is added to the request headers (applies to Custom Header Authentication Type only). |
Custom Header Value | The HTTP header value is added to the request headers (applies to Custom Header Authentication Type only). |
Property | Description |
---|---|
Operation | The operation to be performed. The list is populated from the uploaded metadata configuration file. |
Result Entity | The entity against which the operation is performed (applies when reponseSchema is specified in the metadata JSON file). The list of entities is populated from the uploaded metadata configuration file. |
The properties grid is populated an operation is selected.
Property | Description |
---|---|
Parameter | The parameter specified in the uploaded metadata configuration file. |
Value | The static value of the parameter. |
Name | Description |
---|---|
Output | An event per record from the Rest API will be made available to this endpoint with attributes matching the configured schema. |
Error | If errors are encountered during the execution of this Agent, they will be published on this endpoint. |
Last modified 2mo ago