Newer Versions

v2.1
v2.0

Older Versions

v1.6
v1.7

LucidWorks Enterprise v1.8

Support Resources

LucidWorks Forum
KnowledgeBase

This is the documentation for LucidWorks Enterprise v1.8. The most current release is v2.1.

compared with
Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (7)

View Page History
h2. API Entry Point

{{[/api/collections/_collection-name_/arr/_list-name_?handlerName=/_handlerName_|#search-comp-get]}}: {{[/api/collections/_collection-name_/components/_list-name_?handlerName=/_handlerName_|#search-comp-get]}}: [List|#search-comp-get] or [update|#search-comp-put] search components for a search handler.

{anchor:search-comp-get}
h2. List Search Components for a Search Handler

!Rest API^bullet.jpg! {{GET /api/collections/_collection-name_/arr/_list-name_?handlerName=/_handlerName_}} /api/collections/_collection-name_/components/_list-name_?handlerName=/_handlerName_}}

h4. {bgcolor:#FEECC4}{*}Input{*}{bgcolor}
|| Key || Description ||
| collection | The collection name |
| list-name | one of: "components", "first-components", "last-components" "all", "first", "last" |

*Query Parameters*

{code:borderStyle=solid|borderColor=#666666}
curl 'http://localhost:8888/api/collections/social/arr/components?handlerName=/lucid' 'http://localhost:8888/api/collections/social/components/all?handlerName=/lucid'
{code}

h2. Update Search Components for Search Handler

!Rest API^bullet.jpg! {{PUT /api/collections/_collection-name_/arr/_list-name_?handlerName=/_handlerName_}} /api/collections/_collection-name_/components/_list-name_?handlerName=/_handlerName_}}

h4. {bgcolor:#FEECC4}{*}Input{*}{bgcolor}
|| Key || Description ||
|collection | The collection name |
|list-name | one of: "components", "first-components", "last-components" "all", "first", "last" |

*Query Parameters*
*Input*
{code:borderStyle=solid|borderColor=#666666}
curl -v -X PUT http://localhost:8888/api/collections/social/arr/components?handlerName=/lucid http://localhost:8888/api/collections/social/components/all?handlerName=/lucid
-H "Accept: application/json"
-H "Content-Type: application/json"