content/rest-api/rest-fts-advanced.dita

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
<topic id="topic_lhc_sy4_1v">
  <title>Advanced</title>
  <body>
    <section><title>Index Partition Definition </title>
     <dl>
       <dlentry id="g-api-index">
         <dt>GET /api/pindex</dt>
         <dd><p>Get information about an index partition.</p> <p><b>Permission Required
         </b>: cluster.bucket[<varname>bucket_name</varname>].fts!read</p>
            <p><b>Role Required</b>: FTS-Searcher, FTS-Admin</p><codeblock spectitle="Sample response">{
    "pindexes": {
        "myFirstIndex_6cc599ab7a85bf3b_0": {
            "indexName": "myFirstIndex",
            "indexParams": "",
            "indexType": "blackhole",
            "indexUUID": "6cc599ab7a85bf3b",
            "name": "myFirstIndex_6cc599ab7a85bf3b_0",
            "sourceName": "",
            "sourceParams": "",
            "sourcePartitions": "",
            "sourceType": "nil",
            "sourceUUID": "",
            "uuid": "2d9ecb8b574a9f6a"
        }
    },
    "status": "ok"
}</codeblock></dd> </dlentry>
       <dlentry id="g-api-index-name">
         <dt>GET /api/pindex/{pindexName}</dt>
         <dd><p></p> <p><b>Permission Required
         </b>: cluster.bucket[<varname>bucket_name</varname>].fts!read</p>
            <p><b>Role Required</b>: FTS-Searcher, FTS-Admin</p></dd>
       </dlentry>
     </dl> 
    </section>
    <section><title>Index Partition Querying </title>
<dl>
  <dlentry id="g-api-index-name-count">
    <dt>GET /api/pindex/{pindexName}/count</dt>
    <dd><p></p> <p><b>Permission Required
    </b>: cluster.bucket[<varname>bucket_name</varname>].fts!read</p>
            <p><b>Role Required</b>: FTS-Searcher, FTS-Admin</p></dd>
  </dlentry>
  <dlentry id="p-api-index-name-query">
    <dt>POST /api/pindex/{pindexName}/query</dt>
    <dd><p></p> <p><b>Permission Required </b>: cluster.bucket[<varname>bucket_name</varname>].fts!write</p>
            <p><b>Role Required</b>: FTS-Admin</p></dd>
  </dlentry>
</dl>
</section>
    <section><title>FTS Memory Quota</title>
    <dl>
      <dlentry id="p-api-fts-memory-quota">
        <dt>POST /pools/default</dt>
        <dd><p/><p><b>Permission Required </b>:
              cluster.bucket[<varname>bucket_name</varname>].fts!manage</p><p><b>Role Required</b>:
              FTS-Admin</p>Specify the <parmname>ftsMemoryQuota</parmname> parameter with an integer
            value (example: ftsMemoryQuota=512) to set the memory quota for the full text search
            (FTS) service. </dd>
      </dlentry>
    </dl>
    </section>
  </body>
</topic>