<!-- /* * Your installation or use of this SugarCRM file is subject to the applicable * terms available at * http://support.sugarcrm.com/Resources/Master_Subscription_Agreements/. * If you do not agree to all of the applicable terms or do not have the * authority to bind the entity as an authorized representative, then do not * install or use this SugarCRM file. * * Copyright (C) SugarCRM Inc. All rights reserved. */ --> <h2>Overview</h2> <span class="lead"> List current user's filtered Home dashboards. </span> <h2>Summary</h2> <span class="lead"> This endpoint will return a set of Home dashboards filtered by an expression. 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. </span> <h2>Notice</h2> <span class="lead"> <strong>The behavior of this endpoint has changed in v11.</strong> For a description of behavior in v11, refer to <a href="module_filter_get_help.html">GET /&lt;module&gt;</a>. If you continue to use v10 of the API, your REST calls should behave as before. But, it is advisable to upgrade to v11. Slight differences exist in the GET method of v10 vs v11.<br/> <strong>Migrating to v11:</strong><br/> Recommended Replacement: <code class="codesample">GET /Dashboards</code><br/><br/> The Home module is no longer the default <code class="codesample">dashboard_module</code>. To get the Home module dashboard, include the following filter parameter.<br/> <strong>v11: </strong> <code class="codesample">GET /Dashboards?filter[0][dashboard_module]=Home</code><br/><br/> name, id. etc. are no longer specified as default fields. To retain the default fields, use<br/> <strong>v11: </strong> <code class="codesample">GET /Dashboards?filter[0][dashboard_module]=Home&amp;fields=id,name,view_name</code> </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": "c630c772-faca-2051-6a42-56fab2e73e42", "name": "New Home Dashboard", "date_modified": "2016-03-29T09:49:06-07:00", "view_name": "", "_acl": { "fields": {} }, "view": "", "_module": "Dashboards" }, { "id": "15677f2c-f00d-c59a-6fbe-56fab1f33732", "name": "Home Dashboard2", "date_modified": "2016-03-29T09:47:25-07:00", "view_name": "", "_acl": { "fields": {} }, "view": "", "_module": "Dashboards" }, { "id": "d509b3da-29f6-7b23-7cce-56fab1a6335b", "name": "Accounts Dashboard", "date_modified": "2016-03-29T09:46:00-07:00", "view_name": "records", "_acl": { "fields": {} }, "view": "records", "_module": "Dashboards" }, { "id": "cc4982cd-0bdf-bad4-d079-56fab4bdddf1", "name": "Activity Stream Dashboard", "date_modified": "2016-03-29T09:57:58-07:00", "view_name": "activities", "_acl": { "fields": {} }, "view": "activities", "_module": "Dashboards" } ] } </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> Behavior has changed. Please see <a href="module_filter_get_help.html">GET /Dashboards</a> for the designated replacement. </td> </tr> <tr> <td>v10</td> <td>Added <code>/Dashboards</code> GET endpoint.</td> </tr> </tbody> </table>