/Dashboards/ POST

Create a new dashboard.

Notice

This endpoint is not supported in v11. 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:
For more information on behavior in v11, refer to POST /<module>.
Recommended Replacement: POST /Dashboards
The module name is no longer part of the path. To specify a module name, include it in the Request Body. For example, to create an Accounts module dashboard, use
v11: POST /Dashboards with the following in the Request Body: {"dashboard_module":"Accounts"}

Request Arguments

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

Request

{
    "name": "New Dashboard for Accounts Module",
    "dashboard_module": "Accounts",
    "view_name": "records",
    "metadata": {
        "components": [{
            "rows": [[{
                "view": {
                    "type": "dashablelist",
                    "label": "TPL_DASHLET_MY_MODULE",
                    "display_columns": ["name","billing_address_city"]
                },
                "context": {"module":"Accounts"},
                "width": 12
            }]],
            "width": 12
        }]
    }
}

Response Arguments

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

Response

{
  "id": "8f9cd3d1-ce5d-e8d4-12d8-56cf674d2600",
  "name": "New Dashboard for Accounts Module",
  "date_entered": "2016-02-25T12:44:27-08:00",
  "date_modified": "2016-02-25T12:44:27-08:00",
  "modified_user_id": "1",
  "modified_by_name": "Administrator",
  "created_by": "1",
  "created_by_name": "Administrator",
  "description": "",
  "deleted": false,
  "dashboard_module": "Accounts",
  "view_name": "records",
  "metadata": {
    "components": [
      {
        "rows": [
          [
            {
              "view": {
                "type": "dashablelist",
                "label": "TPL_DASHLET_MY_MODULE",
                "display_columns": [
                  "name",
                  "billing_address_city"
                ]
              },
              "context": {
                "module": "Accounts"
              },
              "width": 12
            }
          ]
        ],
        "width": 12
      }
    ]
  },
  "following": "",
  "my_favorite": false,
  "tag": [],
  "assigned_user_id": "1",
  "assigned_user_name": "Administrator",
  "_acl": {
    "fields": {}
  },
  "view": "records",
  "_module": "Dashboards"
}

Change Log

Version	Change
v11	No longer supported. Please use POST /Dashboards instead.
v10	Added `/Dashboards/<module>` POST endpoint.