Create a new Home dashboard.

Notice

The behavior of this endpoint has changed in v11. For a description of behavior in v11, refer to POST /<module>. If you continue to use v10 of the API, your REST calls should behave as below. But, it is advisable to upgrade to v11.
Migrating to v11:
Recommended Replacement: POST /Dashboards
The Home module is no longer the default dashboard_module. To specify the Home module, include it in the Request Body.
v11: POST /Dashboards with the following in the Request Body: {"dashboard_module":"Home"}

Request Arguments

Name Type Description Required
<record field> <record field type> The name value list of fields to populate. True

Request

{
    "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
        }]
    }
}

Response Arguments

Name Type Description
<record field> <record field type> Returns the fields for the newly created dashboard.

Response

{
  "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"
}

Change Log

Version Change
v11 Behavior has changed. Please see POST /Dashboards for the designated replacement.
v10 Added /Dashboards POST endpoint.