Jump to: navigation, search

GetIndexProperties

Purpose

This service aims to return the configured indexes' searchable fields.

URL

  • GET /Index/GetIndexProperties/

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
Indexes KVList List of configured indexes. true true


Fields KVList

Key ValueType Value Description Mandatory Unique Default
(Index Name) KVList (Index Name) is the name of a configured index.

It is matching names configured within UCS indexing options.

false true


(Index Name) KVList

Key ValueType Value Description Mandatory Unique Default
Description String false true
Fields KVList true true


Fields KVList

Key ValueType Value Description Mandatory Unique Default
(Field Name) KVList false true


(Field Name) KVList

Key ValueType Value Description Mandatory Unique Default
IsSearchable String true or false Is true if the field can be searched in a query. true true
IsSorted String true or false Is true if the field can be returned with a document. Note: An index can contain different types of documents. (Example: Contact, ContactAttribute). Therefore, the entire set of stored field might not be returned. true true

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 18, 2018, at 07:04.