Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.
This operation can be accessed anonymously.
required: None.
643 matches
60 actions
Jira
60 actions
Productivity/Jira
Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.
This operation can be accessed anonymously.
required: None.
{
"type": "object",
"properties": {
"filter": {
"type": "string",
"enum": [
"my",
"favourite"
]
},
"maxResults": {
"type": "integer",
"format": "int32"
},
"startAt": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}{
"type": "object",
"description": "A page containing dashboard details.",
"properties": {
"dashboards": {
"type": "array",
"description": "List of dashboards.",
"items": {
"type": "object",
"description": "Details of a dashboard.",
"properties": {
"automaticRefreshMs": {
"type": "integer",
"format": "int32",
"description": "The automatic refresh interval for the dashboard in milliseconds."
},
"description": {
"type": "string"
},
"editPermissions": {
"type": "array",
"description": "The details of any edit share permissions for the dashboard.",
"items": {
"type": "object",
"description": "Details of a share permission for the filter.",
"required": [
"type"
],
"properties": {
"group": {
"description": "The group that the filter is shared with. For a request, specify the `groupId` or `name` property for the group. As a group's name can change, use of `groupId` is recommended.",
"type": "object"
},
"id": {
"type": "integer",
"format": "int64",
"description": "The unique identifier of the share permission."
},
"project": {
"description": "The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`. \nFor a request, specify the `id` for the project.",
"type": "object"
},
"role": {
"description": "The project role that the filter is shared with. \nFor a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in.",
"type": "object"
},
"type": {
"type": "string",
"description": "The type of share permission:\n\n * `user` Shared with a user.\n * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n * `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`.\n * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.",
"enum": [
"user",
"group",
"project",
"projectRole",
"global",
"loggedin",
"authenticated",
"project-unknown"
]
},
"user": {
"description": "The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user.",
"type": "object"
}
},
"additionalProperties": false
}
},
"id": {
"type": "string",
"description": "The ID of the dashboard."
},
"isFavourite": {
"type": "boolean",
"description": "Whether the dashboard is selected as a favorite by the user."
},
"isWritable": {
"type": "boolean",
"description": "Whether the current user has permission to edit the dashboard."
},
"name": {
"type": "string",
"description": "The name of the dashboard."
},
"owner": {
"description": "The owner of the dashboard.",
"type": "object"
},
"popularity": {
"type": "integer",
"format": "int64",
"description": "The number of users who have this dashboard as a favorite."
},
"rank": {
"type": "integer",
"format": "int32",
"description": "The rank of this dashboard."
},
"self": {
"type": "string",
"format": "uri",
"description": "The URL of these dashboard details."
},
"sharePermissions": {
"type": "array",
"description": "The details of any view share permissions for the dashboard.",
"items": {
"type": "object",
"description": "Details of a share permission for the filter.",
"required": [
"type"
],
"properties": {
"group": {
"description": "The group that the filter is shared with. For a request, specify the `groupId` or `name` property for the group. As a group's name can change, use of `groupId` is recommended.",
"type": "object"
},
"id": {
"type": "integer",
"format": "int64",
"description": "The unique identifier of the share permission."
},
"project": {
"description": "The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`. \nFor a request, specify the `id` for the project.",
"type": "object"
},
"role": {
"description": "The project role that the filter is shared with. \nFor a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in.",
"type": "object"
},
"type": {
"type": "string",
"description": "The type of share permission:\n\n * `user` Shared with a user.\n * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n * `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`.\n * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.",
"enum": [
"user",
"group",
"project",
"projectRole",
"global",
"loggedin",
"authenticated",
"project-unknown"
]
},
"user": {
"description": "The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user.",
"type": "object"
}
},
"additionalProperties": false
}
},
"systemDashboard": {
"type": "boolean",
"description": "Whether the current dashboard is system dashboard."
},
"view": {
"type": "string",
"description": "The URL of the dashboard."
}
},
"additionalProperties": false
}
},
"maxResults": {
"type": "integer",
"format": "int32",
"description": "The maximum number of results that could be on the page."
},
"next": {
"type": "string",
"description": "The URL of the next page of results, if any."
},
"prev": {
"type": "string",
"description": "The URL of the previous page of results, if any."
},
"startAt": {
"type": "integer",
"format": "int32",
"description": "The index of the first item returned on the page."
},
"total": {
"type": "integer",
"format": "int32",
"description": "The number of results on the page."
}
},
"additionalProperties": false
}