Atlassian · Schema

PageOfDashboards

A page containing dashboard details.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
dashboards array List of dashboards.
maxResults integer The maximum number of results that could be on the page.
next string The URL of the next page of results, if any.
prev string The URL of the previous page of results, if any.
startAt integer The index of the first item returned on the page.
total integer The number of results on the page.
View JSON Schema on GitHub

JSON Schema

atlassian-pageofdashboards-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PageOfDashboards",
  "title": "PageOfDashboards",
  "additionalProperties": false,
  "description": "A page containing dashboard details.",
  "properties": {
    "dashboards": {
      "description": "List of dashboards.",
      "items": {
        "$ref": "#/components/schemas/Dashboard"
      },
      "readOnly": true,
      "type": "array"
    },
    "maxResults": {
      "description": "The maximum number of results that could be on the page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "next": {
      "description": "The URL of the next page of results, if any.",
      "readOnly": true,
      "type": "string"
    },
    "prev": {
      "description": "The URL of the previous page of results, if any.",
      "readOnly": true,
      "type": "string"
    },
    "startAt": {
      "description": "The index of the first item returned on the page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "total": {
      "description": "The number of results on the page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    }
  },
  "type": "object"
}