Rest API

Overview

The Rest API allows programmatic, remote access to the configuration and operation of LWE.  Most high-level aspects of the configuration can be managed through the REST API.  Access to search is handled by issuing requests to Solr; those are documented in the Solr Wiki.

General Principles

Error Response Format

Quick Start

Getting Started Indexing

APIs

• Collections: groups of documents that are logically separate 
  • Activities: control schedules for resource-intensive operations
    • Status: the status of currently running Activities
    • History: Stats for the last 10 runs of an Activity
  • Data Sources: the conduits by which data enters LWE
    • Schedules: govern when data is imported
    • Status: the status of currently running Datasources
    • History: Stats for the last 10 runs of a Datasource
  • Fields: how data from a single document is organized in LWE
  • Info: information about the collection
  • Index: interact with the index
  • JDBC Drivers: ability to load arbitrary jdbc driver for database indexing
  • Settings: many different query- and index-time settings
• Logs: provides access to information about LWE's log files
• Security
  • Users
  • Roles