Elep

<h2>Overview</h2>
<span class="lead">
    Generic search
</span>

<h2>Summary</h2>
<span class="lead">
    This endpoint searches the content of the given modules using the provider specified by the "generic_search"
    configuration variable. If the variable is absent, the default provider is "Elastic".
</span>

<h2>Request Arguments</h2>
<table class="table table-hover">
    <thead>
    <tr>
        <th>Name</th>
        <th>Type</th>
        <th>Description</th>
        <th>Required</th>
    </tr>
    </thead>
    <tbody>
    <tr>
        <td>
            q
        </td>
        <td>
            String
        </td>
        <td>
            The search expression.
        </td>
        <td>
            True
        </td>
    </tr>
    <tr>
        <td>
            module_list
        </td>
        <td>
            String
        </td>
        <td>
            Comma delimited list of modules to search. If omitted, all search enabled modules will be queried.
            <br>
            Example: <code>KBDocuments,Bugs</code>
        </td>
        <td>
            False
        </td>
    </tr>
    <tr>
        <td>
            max_num
        </td>
        <td>
            Integer
        </td>
        <td>
            A maximum number of records to return. Default is 20.
        </td>
        <td>
            False
        </td>
    </tr>
    <tr>
        <td>
            offset
        </td>
        <td>
            Integer
        </td>
        <td>
            The number of records to skip over before records are returned. Default is 0.
        </td>
        <td>
            False
        </td>
    </tr>
    </tbody>
</table>

<h3>Request</h3>
<pre class="pre-scrollable">
{
}
</pre>

<h2>Response Arguments</h2>
<table class="table table-hover">
    <thead>
    <tr>
        <th>Name</th>
        <th>Type</th>
        <th>Description</th>
    </tr>
    </thead>
    <tbody>
    <tr>
        <td>
            next_offset
        </td>
        <td>
            Integer
        </td>
        <td>
            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
            records.
        </td>
    </tr>
    <tr>
        <td>
            total
        </td>
        <td>
            Integer
        </td>
        <td>
            The number of records found.
        </td>
    </tr>
    <tr>
        <td>
            records
        </td>
        <td>
            Array
        </td>
        <td>
            An array of results containing matched records.
        </td>
    </tr>
    </tbody>
</table>

<h3>Response</h3>
<pre class="pre-scrollable">
{
    "next_offset": -1,
    "total": 1,
    "records": [
        {
            "name": "Connecting to the Internet",
            "description": "To connect your device to the Internet, use any application that accesses the Internet. You can connect using either Wi-Fi or Bluetooth.",
            "url": "portal/index.php#KBContents/60142236-bad3-11e9-9d32-3c15c2d57622" (for portal)
            "url": "#KBContents/60142236-bad3-11e9-9d32-3c15c2d57622" (for base)
        }
    ]
}
</pre>

<h2>Change Log</h2>
<table class="table table-hover">
    <tr>
        <th>Version</th>
        <th>Change</th>
    </tr>
    <tr>
        <td>
            v11.9
        </td>
        <td>
            Added <code>/genericsearch</code> GET/POST endpoint.
        </td>
    </tr>
</table>