Elep

<span class="lead">
    Create a new Home dashboard.
</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_post_help.html">POST /&lt;module&gt;</a>. If you continue to use v10 of the API,
    your REST calls should behave as below. But, it is advisable to upgrade to v11.<br/>
    <strong>Migrating to v11:</strong><br/>
    Recommended Replacement: <code class="codesample">POST /Dashboards</code><br/>
    The Home module is no longer the default <code class="codesample">dashboard_module</code>. To specify the Home
    module, include it in the Request Body.<br/>
    <strong>v11: </strong><code class="codesample">POST /Dashboards</code> with the following in the Request Body:
    <code class="codesample">{"dashboard_module":"Home"}</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>&lt;record field&gt;</td>
        <td>&lt;record field type&gt;</td>
        <td>The name value list of fields to populate.</td>
        <td>True</td>
    </tr>
    </tbody>
</table>

<h3>Request</h3>
<pre class="pre-scrollable">
{
    "name": "New Home Dashboard",
    "dashboard_module": "Home",
    "view_name": "",
    "metadata": {
        "components": [{
            "rows": [[{
                "width": 12,
                "view": {
                    "limit": 10,
                    "visibility": "user",
                    "label": "Active Tasks",
                    "type": "active-tasks",
                    "module": null,
                    "template": "tabbed-dashlet"
                }
            }]],
            "width": 12
        }]
    }
}
</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>&lt;record field&gt;</td>
        <td>&lt;record field type&gt;</td>
        <td>Returns the fields for the newly created dashboard.</td>
    </tr>
    </tbody>
</table>

<h3>Response</h3>
<pre class="pre-scrollable">
{
  "id": "4ccda6fa-fa02-9c8e-215f-56cf72f98fcb",
  "name": "New Home Dashboard",
  "date_entered": "2016-02-25T13:30:51-08:00",
  "date_modified": "2016-02-25T13:30:51-08:00",
  "modified_user_id": "1",
  "modified_by_name": "Administrator",
  "created_by": "1",
  "created_by_name": "Administrator",
  "description": "",
  "deleted": false,
  "dashboard_module": "Home",
  "view_name": "",
  "metadata": {
    "components": [
      {
        "rows": [
          [
            {
              "width": 12,
              "view": {
                "limit": 10,
                "visibility": "user",
                "label": "Active Tasks",
                "type": "active-tasks",
                "module": null,
                "template": "tabbed-dashlet"
              }
            }
          ]
        ],
        "width": 12
      }
    ]
  },
  "following": "",
  "my_favorite": false,
  "tag": [],
  "assigned_user_id": "1",
  "assigned_user_name": "Administrator",
  "_acl": {
    "fields": {}
  },
  "view": "",
  "_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_post_help.html">POST /Dashboards</a>
            for the designated replacement.
        </td>
    </tr>
    <tr>
        <td>v10</td>
        <td>Added <code>/Dashboards</code> POST endpoint.</td>
    </tr>
    </tbody>
</table>