Collections

Data in LucidWorks is organized into Collections. A collection contains data that is logically distinct from data in other collections. Collections have their own Data Sources, Settings, Fields, and Role Mappings. In other words, collections are distinct except that they happen to run in the same instance of LucidWorks.

API Entry Points

/api/collections: Get a list of available collection names

/api/collections/collection: Get details or remove a collection

List Collection Names

GET /api/collections

Input

Path Parameters

None

Query Parameters

None

Output

Output Content

A JSON List of Maps mapping Collection keys to values.

Response Codes

200: success ok

Examples

Get a list of all collections and their locations:

Input

curl 'http://localhost:8888/api/collections'

Output

[
    {
        "name": "new_collection",
        "instance_dir": "new_collection_1"
    },
    {
        "name": "collection 1",
        "instance_dir": "collection1_0"
    },
    {
        "name": "social",
        "instance_dir": "socialdata"
    }
]

Create Collection

POST /api/collections

Input

Path Parameters

None

Query Parameters

None

Input content

JSON block with all keys.

Because collection templates are based on an instance_dir, it's recommended to specify either parameter when creating a new collection, not both.

Output

Output Content

JSON representation of new collection

Return Codes

201: created

Examples

Create a new collection called "social" and specify that the collection should be stored with the other collections in the $LWE_HOME/data/solr/cores directory, but in a directory called "socialdata".

Input

curl -H 'Content-type: application/json' -d '{"name": "social", "instance_dir":"socialdata"}'
     'http://localhost:8888/api/collections'

Output

{
    "name": "social"
}

List Information for Specific Collection

GET /api/collections/collection

Input

Path Parameters

Query Parameters

None

Output

Output Content

JSON representation of the collection.

Response Codes

200: success ok

Examples

Get the collection information for the "social" collection:

Input

curl 'http://localhost:8888/api/collections/social'

Output

{
   "name":"social",
   "instance_dir":"socialdata"
}

Delete Collection

DELETE /api/collections/collection

To delete the index for a collection without deleting the entire collection, see the Collection Index Delete API.

Deleting a collection will delete all associated indexes and settings, but not alerts or manually created users. Use the Alerts API (LucidWorks Enterprise only) or the Users API to delete those.

Input

Path Parameters

Query Parameters

None

Input content

None

Output

Output Content

None

Return Codes

204: success no content

404: not found

Examples

Delete the "social" collection:

Input

curl -X DELETE 'http://localhost:8888/api/collections/social'

Output

None.

Version

LucidWorks REST API Reference

Alerts API