The service settings define the URL location for the REST API, as well as data retrieval options.
API Service Settings
| Setting | Description |
|---|---|
| Server | |
| API Server Path | The URL of the REST API server. The REST API must be installed to a Web server machine. Normally the URL is http://ServerName/InterActionAPI. For example, if you install the REST API to a server named http://IAServer/InterActionAPI (or |
| Data Retrieval | |
| Maximum Result Count | Defines the maximum number of InterAction records that can be returned in a search. The default of 10000 is usually sufficient. Note that applications that call the API can implement paging to bring back the results in smaller groups, so it would be rare to reach this limit. |
| Default Results per Page | Defines the default page size for API applications that implement paging. The applications can define a different page size if necessary. |
Advanced API Settings - Timeout Settings You don't typically need to change these settings. All of these values should be entered in minutes. | |
| Close Timeout | The timeout for the closing of a connection to the service. If a close exceeds the time out value, the call is terminated. |
| Open Timeout | The timeout for the opening of a connection to the service. If an open exceeds the time out value, the call is terminated. |
| Receive Timeout | The timeout for an individual receive response from the service. If a call exceeds the time out value, the call is terminated. |
| Send Timeout | The timeout for an individual send request to the service. If a call exceeds the time out value, the call is terminated. |
| Advanced API Settings - Message Settings | |
| Maximum Received Message Size | The maximum allowable message size that can be received in a single request to the service. Value should be entered in megabytes. You don’t typically need to change this setting. |
Configure the API Service Settings
- From the main entity list in InterAction Administrator, double-click InterAction API Configuration.
- Choose Service Configuration.
In the Service Configuration dialog box, enter the API Server Path, Maximum Result Count, and Default Results per Page settings.
See the “API Service Settings” in the table above for details about these settings.
- Choose Advanced API Settings.
Enter the Timeout Settings and Maximum Received Message Size settings.
See the “API Service Settings” in the table above for details about these settings.
- Choose OK to close the Advanced API Settings dialog box.
- Choose OK to close the Service Configuration dialog box.