This section provides information on the two types of data sources available for use in aggregated queries: REST queries registered in the Integration module and system queries registered in other modules and solutions.
•REST queries: This type of data source submits queries to URLs using the HTTP protocol. For this type of query, the Type parameter must be completed with "RESTService". This type of query can be registered in the Manage REST Queries section of the Integration module and then configured in the XML file. This registration method forces the query to undergo the authentication process in the system, and allows the system access control policy and audit log to be used for it. It is important to note that, in order to view this type of query in an aggregated query, the authenticated user must have been included in its audience. For details on creating REST queries and defining an audience, see Chapter 15: Integration -> Aggregated Queries -> Manage REST Queries.
The constructor arguments that can be created and their descriptions are listed in the table below.
|
Name |
Required?
|
Default Value |
Description |
|
url |
Yes |
- |
URL to which the HTTP request will point. |
|
method |
No |
POST |
HTTP verb. |
|
headers |
No |
Empty |
Values to be inserted in the header of the HTTP request. This value must be in the following format: name:value,name:value. |
|
parameters |
No |
Empty |
Fixed values to be sent as variables in the body of the HTTP request (when POST is used) or in the QueryString (when GET is used). This value must be in the following format: name:value,name:value.
Below is an example of a completed Arg node for this type of query: <Arg Name="headers" Value="accept:application/json,timeout:3000" />. |
•System queries: This type of data source works similarly to REST query data sources. However, before executing the HTTP request for the API, it authenticates and obtains an authentication token. For this type of query, the Type parameter must be completed with "RMAPI".
In order to authenticate and retrieve data from the system, this type of data source requires the following keys to be edited in the web.config file:
|
Name |
Required? |
Description |
|
ClientID |
Yes |
ID generated for the Integration module when it was registered as an authorized application in the Administration module. |
|
ClientSecret |
Yes |
Client secret generated for the Integration module when it was registered as an authorized application in the Administration module. |
The following constructor argument must also be edited in the file:
|
Name |
Required? |
Description |
|
url |
Yes |
URL for the Modulo Risk Manager API. |