Atlassian · Schema

Dashboard

Details of a dashboard.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
automaticRefreshMs	integer	The automatic refresh interval for the dashboard in milliseconds.
description	string
editPermissions	array	The details of any edit share permissions for the dashboard.
id	string	The ID of the dashboard.
isFavourite	boolean	Whether the dashboard is selected as a favorite by the user.
isWritable	boolean	Whether the current user has permission to edit the dashboard.
name	string	The name of the dashboard.
owner	object	The owner of the dashboard.
popularity	integer	The number of users who have this dashboard as a favorite.
rank	integer	The rank of this dashboard.
self	string	The URL of these dashboard details.
sharePermissions	array	The details of any view share permissions for the dashboard.
systemDashboard	boolean	Whether the current dashboard is system dashboard.
view	string	The URL of the dashboard.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Dashboard",
  "title": "Dashboard",
  "additionalProperties": false,
  "description": "Details of a dashboard.",
  "properties": {
    "automaticRefreshMs": {
      "description": "The automatic refresh interval for the dashboard in milliseconds.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "description": {
      "type": "string"
    },
    "editPermissions": {
      "description": "The details of any edit share permissions for the dashboard.",
      "items": {
        "$ref": "#/components/schemas/SharePermission"
      },
      "readOnly": true,
      "type": "array"
    },
    "id": {
      "description": "The ID of the dashboard.",
      "readOnly": true,
      "type": "string"
    },
    "isFavourite": {
      "description": "Whether the dashboard is selected as a favorite by the user.",
      "readOnly": true,
      "type": "boolean"
    },
    "isWritable": {
      "description": "Whether the current user has permission to edit the dashboard.",
      "readOnly": true,
      "type": "boolean"
    },
    "name": {
      "description": "The name of the dashboard.",
      "readOnly": true,
      "type": "string"
    },
    "owner": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserBean"
        }
      ],
      "description": "The owner of the dashboard.",
      "readOnly": true
    },
    "popularity": {
      "description": "The number of users who have this dashboard as a favorite.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "rank": {
      "description": "The rank of this dashboard.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "self": {
      "description": "The URL of these dashboard details.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "sharePermissions": {
      "description": "The details of any view share permissions for the dashboard.",
      "items": {
        "$ref": "#/components/schemas/SharePermission"
      },
      "readOnly": true,
      "type": "array"
    },
    "systemDashboard": {
      "description": "Whether the current dashboard is system dashboard.",
      "readOnly": true,
      "type": "boolean"
    },
    "view": {
      "description": "The URL of the dashboard.",
      "readOnly": true,
      "type": "string"
    }
  },
  "type": "object"
}