Configuration APIs
Configurations are at the core of building semantic and recommender applications with the ADF Search Application. Each configuration holds settings of a single application and the ADF database allows you to store multiple such configurations, each under a unique ID.
The configuration-related API calls allow you to:
create new configurations
POST /api/configurations– Allows you to create a new configuration. The response will contain the configuration's ID, which serves as a unique identifier of the configuration in the ADF Search Application database.
get logs, settings and metadata of existing configurations
GET /api/configurations– Returns a list of all existing configurations together with their metadata (including ID) and settings as well as the ID of the default (active) configuration.GET /api/configurations/{configId}– Returns settings and metadata of a single configuration identified by its ID.GET /api/configurations/{configId}/logs– Lists logs (change history) of a single configuration identified by its ID.GET /api/configurations/active– Returns the settings and metadata (including an ID) of the active (default) configuration. An active (default) configuration is a configuration pre-selected on the main user interface.GET /api/configurations/default– Returns the default settings of an ADF Search Application configuration. You can edit the response of this request and use it to create a new configuration withPOST /api/configurations.GET /api/configurations/visible– Returns settings and metadata of ADF Search Application configurations that are available for selection on the main user interface .
update configurations
PUT /api/configurations/{configId}– Allows you to edit settings of a configuration identified by its ID.
activate a configuration
POST /api/configurations/{configId}/set– Sets an ADF Search Application configuration identified by its ID as an active (default) configuration. An active configuration is a configuration pre-selected on the main user interface.
delete configurations
DELETE /api/configurations/{configId}– Allows you to delete a configuration identified by its ID.