truesearch.query
================

Search the TrueSearch index for files and directories in ``path`` and its subdirectories.

TrueSearch uses the index that answers macOS Spotlight searches through SMB. Middleware converts the filters into a Spotlight query. Thus, a query gets the same results as a Spotlight search from a Mac.

.. raw:: html

    <div id="json-schema">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    <div class="accordion" id="accordionCall_parameters">
    <div class="card">
    <div class="card-header" id="headingCall_parameters">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters">
    <div class="card-body pl-5">
    <span class="badge badge-dark value-type">Type: array</span><br/>
    <span class="badge badge-info no-additional">No Additional Items</span><h4>Tuple Validation</h4>
    <h5>Parameter 1: data</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>data</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>The directory to search, the filters, the options, and the user.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_path">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_path">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_path" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_path" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_path')" type="button"><span class="property-name">path</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_path" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_path" id="Call_parameters_items_i0_path">
    <div class="card-body pl-5">
    <h4>Path</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>The directory to search. Use an absolute path in a dataset that TrueSearch indexes. TrueSearch indexes each dataset that contains an SMB share with Spotlight search enabled, or a WebShare share with search enabled. If <code>path</code> is above the indexed directory of the dataset, TrueSearch searches all of the indexed directory.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_path_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_username">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_username">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_username" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_username" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_username')" type="button"><span class="property-name">username</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_username" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_username" id="Call_parameters_items_i0_username">
    <div class="card-body pl-5">
    <h4>Username</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>The user to search as. The user must be able to access <code>path</code>. The results include only the files and directories that this user can access. An administrator can use this to see what the user can find. If <code>username</code> is <code>null</code>, the search runs as root and returns all matches.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i0_username_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_username_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_username_anyOf_i0" id="Call_parameters_items_i0_username_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_username_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_username_anyOf_i1" id="Call_parameters_items_i0_username_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_username_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i0_username_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_username_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_recursive">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_recursive">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_recursive" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_recursive" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_recursive')" type="button"><span class="property-name">recursive</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_recursive" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_recursive" id="Call_parameters_items_i0_recursive">
    <div class="card-body pl-5">
    <h4>Recursive</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/>
    <span class="description"><p>Also search the indexed datasets that are mounted beneath <code>path</code>. Each dataset has a separate index. Without <code>recursive</code>, the query searches only the dataset that contains <code>path</code>. With <code>recursive</code>, the query merges the results of all datasets, newest first. <code>limit</code> applies to the merged results.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_query-filters">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_query-filters">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_query-filters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_query-filters" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_query-filters')" type="button"><span class="property-name">query-filters</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_query-filters" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_query-filters" id="Call_parameters_items_i0_query-filters">
    <div class="card-body pl-5">
    <h4>Query-Filters</h4><span class="badge badge-dark value-type">Type: array</span> <span class="badge badge-success default-value">Default: []</span><br/>
    <span class="description"><p>Filters can also use <code>macos_kind</code>, <code>tags</code>, and <code>comment</code>. These fields are not in the results.</p>
    </span>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0_query-filters_items">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i0_query-filters_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="p">[</span>
    <span class="w">        </span><span class="s2">"name"</span><span class="p">,</span>
    <span class="w">        </span><span class="s2">"="</span><span class="p">,</span>
    <span class="w">        </span><span class="s2">"bob"</span>
    <span class="w">    </span><span class="p">]</span>
    <span class="p">]</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i0_query-filters_ex2"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="p">[</span>
    <span class="w">        </span><span class="s2">"OR"</span><span class="p">,</span>
    <span class="w">        </span><span class="p">[</span>
    <span class="w">            </span><span class="p">[</span>
    <span class="w">                </span><span class="s2">"name"</span><span class="p">,</span>
    <span class="w">                </span><span class="s2">"="</span><span class="p">,</span>
    <span class="w">                </span><span class="s2">"bob"</span>
    <span class="w">            </span><span class="p">],</span>
    <span class="w">            </span><span class="p">[</span>
    <span class="w">                </span><span class="s2">"name"</span><span class="p">,</span>
    <span class="w">                </span><span class="s2">"="</span><span class="p">,</span>
    <span class="w">                </span><span class="s2">"larry"</span>
    <span class="w">            </span><span class="p">]</span>
    <span class="w">        </span><span class="p">]</span>
    <span class="w">    </span><span class="p">]</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_query-options">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_query-options">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_query-options" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_query-options" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_query-options')" type="button"><span class="property-name">query-options</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_query-options" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_query-options" id="Call_parameters_items_i0_query-options">
    <div class="card-body pl-5">
    <h4>TruesearchQueryOptions</h4><span class="badge badge-dark value-type">Type: object</span> <span class="badge badge-success default-value">Default: {"limit": 100}</span><br/>
    <span class="description"><p>Options for the results of the query.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_query-options_limit">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_query-options_limit">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_query-options_limit" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_query-options_limit" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_query-options_limit')" type="button"><span class="property-name">limit</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_query-options_limit" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_query-options_limit" id="Call_parameters_items_i0_query-options_limit">
    <div class="card-body pl-5">
    <h4>Limit</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 100</span><br/>
    <span class="description"><p>The maximum number of entries to return.</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i0_query-options_limit_number">Value must be greater or equal to <code>1</code> and lesser or equal to <code>1000</code></span></p>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value">
    <div class="card">
    <div class="card-header" id="headingReturn_value">
    <h2 class="mb-0">
    <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value">
    <div class="card-body pl-5">
    <h4>Result</h4><span class="badge badge-dark value-type">Type: array of object</span><br/>
    <span class="description"><p>The entries that match, with the newest entries first.</p>
    </span>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Return_value_items">
    <h4>TruesearchEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_items_path">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_path">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_path" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_path" data-toggle="collapse" onclick="setAnchor('#Return_value_items_path')" type="button"><span class="property-name">path</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_path" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_path" id="Return_value_items_path">
    <div class="card-body pl-5">
    <h4>Path</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>The absolute path of the file or directory.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_name" data-toggle="collapse" onclick="setAnchor('#Return_value_items_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_name" id="Return_value_items_name">
    <div class="card-body pl-5">
    <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>The name of the file or directory.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_type">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_type">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_type" data-toggle="collapse" onclick="setAnchor('#Return_value_items_type')" type="button"><span class="property-name">type</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_type" id="Return_value_items_type">
    <div class="card-body pl-5">
    <h4>Type</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>The type of the file or directory. <code>OTHER</code> is a FIFO, a socket, or a device file.</p>
    </span><div class="enum-value" id="Return_value_items_type_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"DIRECTORY"</li><li class="list-group-item enum-item">"FILE"</li><li class="list-group-item enum-item">"SYMLINK"</li><li class="list-group-item enum-item">"OTHER"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_size">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_size">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_size" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_size" data-toggle="collapse" onclick="setAnchor('#Return_value_items_size')" type="button"><span class="property-name">size</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_size" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_size" id="Return_value_items_size">
    <div class="card-body pl-5">
    <h4>Size</h4><br/>
    <span class="description"><p>The size in bytes.</p>
    </span><div class="any-of-value" id="Return_value_items_size_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_items_size_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_size_anyOf_i0" id="Return_value_items_size_anyOf_i0" onclick="setAnchor('#Return_value_items_size_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_size_anyOf_i1" id="Return_value_items_size_anyOf_i1" onclick="setAnchor('#Return_value_items_size_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_items_size_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: integer</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_items_size_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_mode">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_mode">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_mode" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_mode" data-toggle="collapse" onclick="setAnchor('#Return_value_items_mode')" type="button"><span class="property-name">mode</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_mode" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_mode" id="Return_value_items_mode">
    <div class="card-body pl-5">
    <h4>Mode</h4><br/>
    <span class="description"><p>The file mode, as <code>st_mode</code> gives it.</p>
    </span><div class="any-of-value" id="Return_value_items_mode_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_items_mode_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_mode_anyOf_i0" id="Return_value_items_mode_anyOf_i0" onclick="setAnchor('#Return_value_items_mode_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_mode_anyOf_i1" id="Return_value_items_mode_anyOf_i1" onclick="setAnchor('#Return_value_items_mode_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_items_mode_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: integer</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_items_mode_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_uid">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_uid">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_uid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_uid" data-toggle="collapse" onclick="setAnchor('#Return_value_items_uid')" type="button"><span class="property-name">uid</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_uid" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_uid" id="Return_value_items_uid">
    <div class="card-body pl-5">
    <h4>Uid</h4><br/>
    <span class="description"><p>The user ID of the owner.</p>
    </span><div class="any-of-value" id="Return_value_items_uid_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_items_uid_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_uid_anyOf_i0" id="Return_value_items_uid_anyOf_i0" onclick="setAnchor('#Return_value_items_uid_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_uid_anyOf_i1" id="Return_value_items_uid_anyOf_i1" onclick="setAnchor('#Return_value_items_uid_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_items_uid_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: integer</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_items_uid_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_gid">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_gid">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_gid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_gid" data-toggle="collapse" onclick="setAnchor('#Return_value_items_gid')" type="button"><span class="property-name">gid</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_gid" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_gid" id="Return_value_items_gid">
    <div class="card-body pl-5">
    <h4>Gid</h4><br/>
    <span class="description"><p>The group ID of the owner group.</p>
    </span><div class="any-of-value" id="Return_value_items_gid_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_items_gid_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_gid_anyOf_i0" id="Return_value_items_gid_anyOf_i0" onclick="setAnchor('#Return_value_items_gid_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_gid_anyOf_i1" id="Return_value_items_gid_anyOf_i1" onclick="setAnchor('#Return_value_items_gid_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_items_gid_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: integer</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_items_gid_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_mtime">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_mtime">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_mtime" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_mtime" data-toggle="collapse" onclick="setAnchor('#Return_value_items_mtime')" type="button"><span class="property-name">mtime</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_mtime" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_mtime" id="Return_value_items_mtime">
    <div class="card-body pl-5">
    <h4>Mtime</h4><br/>
    <span class="description"><p>The last time that the data changed.</p>
    </span><div class="any-of-value" id="Return_value_items_mtime_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_items_mtime_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_mtime_anyOf_i0" id="Return_value_items_mtime_anyOf_i0" onclick="setAnchor('#Return_value_items_mtime_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_mtime_anyOf_i1" id="Return_value_items_mtime_anyOf_i1" onclick="setAnchor('#Return_value_items_mtime_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_items_mtime_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><span class="badge badge-info value-type">Format: date-time</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_items_mtime_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_btime">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_btime">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_btime" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_btime" data-toggle="collapse" onclick="setAnchor('#Return_value_items_btime')" type="button"><span class="property-name">btime</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_btime" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_btime" id="Return_value_items_btime">
    <div class="card-body pl-5">
    <h4>Btime</h4><br/>
    <span class="description"><p>The time that the file was created.</p>
    </span><div class="any-of-value" id="Return_value_items_btime_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_items_btime_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_btime_anyOf_i0" id="Return_value_items_btime_anyOf_i0" onclick="setAnchor('#Return_value_items_btime_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_btime_anyOf_i1" id="Return_value_items_btime_anyOf_i1" onclick="setAnchor('#Return_value_items_btime_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_items_btime_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><span class="badge badge-info value-type">Format: date-time</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_items_btime_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_atime">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_atime">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_atime" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_atime" data-toggle="collapse" onclick="setAnchor('#Return_value_items_atime')" type="button"><span class="property-name">atime</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_atime" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_atime" id="Return_value_items_atime">
    <div class="card-body pl-5">
    <h4>Atime</h4><br/>
    <span class="description"><p>The last time that the file was read.</p>
    </span><div class="any-of-value" id="Return_value_items_atime_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_items_atime_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_atime_anyOf_i0" id="Return_value_items_atime_anyOf_i0" onclick="setAnchor('#Return_value_items_atime_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_atime_anyOf_i1" id="Return_value_items_atime_anyOf_i1" onclick="setAnchor('#Return_value_items_atime_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_items_atime_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><span class="badge badge-info value-type">Format: date-time</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_items_atime_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_inode">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_inode">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_inode" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_inode" data-toggle="collapse" onclick="setAnchor('#Return_value_items_inode')" type="button"><span class="property-name">inode</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_inode" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_inode" id="Return_value_items_inode">
    <div class="card-body pl-5">
    <h4>Inode</h4><br/>
    <span class="description"><p>The inode number, as <code>st_ino</code> gives it.</p>
    </span><div class="any-of-value" id="Return_value_items_inode_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_items_inode_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_inode_anyOf_i0" id="Return_value_items_inode_anyOf_i0" onclick="setAnchor('#Return_value_items_inode_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_inode_anyOf_i1" id="Return_value_items_inode_anyOf_i1" onclick="setAnchor('#Return_value_items_inode_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_items_inode_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: integer</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_items_inode_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_handle">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_handle">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_handle" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_handle" data-toggle="collapse" onclick="setAnchor('#Return_value_items_handle')" type="button"><span class="property-name">handle</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_handle" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_handle" id="Return_value_items_handle">
    <div class="card-body pl-5">
    <h4>Handle</h4><br/>
    <span class="description"><p>A file handle, encoded in base64. Use it on the NAS to open the file in a race-free manner. It identifies the file uniquely in its dataset for the lifetime of the file.</p>
    </span><div class="any-of-value" id="Return_value_items_handle_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_items_handle_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_handle_anyOf_i0" id="Return_value_items_handle_anyOf_i0" onclick="setAnchor('#Return_value_items_handle_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_handle_anyOf_i1" id="Return_value_items_handle_anyOf_i1" onclick="setAnchor('#Return_value_items_handle_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_items_handle_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_items_handle_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* READONLY_ADMIN

