Elep

<h2>Overview</h2>
<span class="lead">
    List a set of cases accessible to a contact with portal visibility.
</span>

<h2>Summary</h2>
<span class="lead">
    This endpoint will return a set of cases filtered by an expression which are accesible to a contact with portal visibility.
    The filter can be applied to multiple fields and have multiple and/or conditions in it. Alternatively, you may use an existing filter by
    specifying its id. If both a filter definition and a filter id are passed, the two filters will be joined with an
    <code>AND</code>. Care will need to be taken to make sure that any filters used have appropriate indexes on the
    server side otherwise the runtime of the endpoint will be very long. For more information, refer to <a href="module_filter_get_help.html">GET /&lt;module&gt;</a>
</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>filter</td>
        <td>String</td>
        <td>See <a href="module_filter_get_help.html">Filter API</a>.</td>
        <td>False</td>
    </tr>
    <tr>
        <td>filter_id</td>
        <td>String</td>
        <td>
            Identifier for a preexisting filter. See <a href="module_filter_get_help.html">
            the Filter API</a> for details.
        </td>
        <td>False</td>
    </tr>
    <tr>
        <td>max_num</td>
        <td>Integer</td>
        <td>
            Max number of records that can be returned. Default is 20, unless overruled by your Sugar configuration.
        </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>
    <tr>
        <td>fields</td>
        <td>String</td>
        <td>
            Comma delimited list of fields to return. Each field may be represented either by string, or by map
            containing field name and additional field parameters (applicable to link and collection fields).
            The fields <code>id</code> and <code>date_modified</code> will always be returned.
            For more details on additional field parameters, see
            <a href="module_record_link_link_name_filter_get_help.html">Relate API</a> and
            <a href="module_record_collection_collection_name_get_help.html">Collection API</a>.
        </td>
        <td>False</td>
    </tr>
    <tr>
        <td>order_by</td>
        <td>String</td>
        <td>See <a href="module_filter_get_help.html">Filter API</a>.</td>
        <td>False</td>
    </tr>
    <tr>
        <td>deleted</td>
        <td>Boolean</td>
        <td>Boolean to show deleted records in the result set.</td>
        <td>False</td>
    </tr>
    </tbody>
</table>

<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>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,
  "records": [
    {
      "id": "d509b3da-29f6-7b23-7cce-56fab1a6335b",
      "name": "Need help",
      "date_modified": "2016-03-29T09:46:00-07:00",
      "_acl": {
        "fields": {}
      },
      "_module": "Cases"
    },
    {
      "id": "cc4982cd-0bdf-bad4-d079-56fab4bdddf1",
      "name": "Having trouble",
      "date_modified": "2016-03-29T09:57:58-07:00",
      "_acl": {
        "fields": {}
      },
      "_module": "Cases"
    }
  ]
}
</pre>

<h2>Change Log</h2>
<table class="table table-hover">
    <thead>
    <tr>
        <th>Version</th>
        <th>Change</th>
    </tr>
    </thead>
    <tbody>
    <tr>
        <td>v11</td>
        <td>Added <code>/Contact/:record/Cases</code> GET endpoint.</td>
    </tr>
    </tbody>
</table>