You are currently browsing legacy 3.0 version of documentation. Click here to switch to the newest 6.0 version.
    We can help you with migration to the latest RavenDB
    Contact Us Now
    see on GitHub

    Commands: Indexes: How to get index terms?

    GetTerms will retrieve all stored terms for a field of an index.

    Syntax

    curl \
	http://{serverName}/databases/{databaseName}/terms/{indexName}? \
		field={field} \
		&pageSize={pageSize} \
		&start={start} \
		&fromValue={fromValue} \
	-X GET

    Request

    Query parameter Required Description
    indexName Yes Name of an index
    field Yes Index field
    fromValue No Starting point for a query, used for paging
    pageSize No Maximum number of terms that will be returned

    Response

    Status code Description
    200 OK
    Return Value Description
    payload array of strings

    Example I

    curl -X GET "http://localhost:8080/databases/NorthWind/terms/Orders/Totals?field=Company&pageSize=128&fromValue=" 

< HTTP/1.1 200 OK
["companies/1","companies/10", ... ]
    see on GitHub

    related articlesRelated Articles

    Home / Docs / Client Api / Commands / Indexes / How To / Get Index Terms