Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

name path methods description
DuplicateDetectionService
  • /report/duplicates
  • /report/duplicates/{name}
  • /report/duplicates/{name}/csv
  • /report/duplicates/{name}/detection
  • /report/duplicates/{name}/hits
  • /report/duplicates/{name}/xls
  • GET
  • DELETE GET
  • GET
  • DELETE POST
  • GET
  • GET
Manages the creation of reports about potential duplicate records and provides access to results.
JDBCDataSourceService
  • /datasource
  • /datasource/test
  • /datasource/{name}
  • /datasource/{name}/delete
  • /datasource/{name}/used
  • GET POST
  • POST
  • DELETE GET
  • DELETE
  • GET
Management of JDBC data sources.

JDBC data sources can be referenced when configuring a record source of type "JDBC" for a field.

SearchIndexService
  • /index
  • /enginetype/index
  • /enginetype/scoring
  • /import/index
  • /index/cfgsummary
  • /index/{name}
  • /index/{name}/dump
  • /index/{name}/export
  • /index/{name}/import
  • /index/{name}/rebuild
  • /index/{name}/recreate
  • /index/{name}/statistics
  • /index/{name}/status
  • /index/{name}/status-combined
  • /index/{name}/columns/names
  • /index/{name}/dump/status
  • /index/{name}/engine/files
  • /index/{name}/export/status
  • /index/{name}/indexer/abort
  • /index/{name}/indexer/status
  • /index/{name}/record/best
  • /index/{name}/record/candidates
  • /index/{name}/record/{id}
  • /index/{name}/source/columnnames
  • /index/{name}/statistics/{category}
  • /index/{name}/engine/files/{filename}
  • GET
  • GET
  • GET
  • GET
  • GET
  • DELETE GET POST
  • HEAD
  • HEAD
  • POST
  • HEAD
  • HEAD
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • HEAD
  • GET
  • POST
  • POST
  • GET
  • POST
  • GET
  • GET
Manages projects, fields and associated search indexes. Provides the search functionality.

To perform a search request, use either
/index/{name}/record/candidates or
/index/{name}/record/best

ServerInstanceService
  • /server
  • /server/connect
  • /server/list
  • /server/starttime
  • /server/time
  • /server/time-utc
  • /server/{id}
  • /server/settings/checkSSLCertificates
  • POST
  • HEAD
  • GET
  • GET
  • GET
  • GET
  • DELETE
  • GET PUT
Manages the available server instances
SystemService
  • /system/messages
  • /system/smtp
  • /system/messages/count
  • /system/notification/settings
  • /system/notification/types
  • /system/report/settings
  • /system/smtp/test
  • GET
  • DELETE GET POST
  • GET
  • DELETE GET POST
  • GET
  • GET POST
  • POST
Manages general system settings.