{
  "opencollection": "1.0.0",
  "info": {
    "name": "Atlassian Admin Account Dashboards API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Dashboards",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Atlassian Bulk Edit Dashboards",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.atlassian.com/rest/api/3/dashboard/bulk/edit",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk edit dashboards. Maximum number of dashboards to be edited at the same time is 100.<br><br>**[Permissions](#permissions) required:** None<br><br>The dashboards to be updated must be owned by the user, or the user must be an administrator."
        },
        {
          "info": {
            "name": "Atlassian Get Available Gadgets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/dashboard/gadgets"
          },
          "docs": "Gets a list of all available gadgets that can be added to all dashboards.<br><br>**[Permissions](#permissions) required:** None."
        },
        {
          "info": {
            "name": "Atlassian Search For Dashboards",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/dashboard/search",
            "params": [
              {
                "name": "dashboardName",
                "value": "",
                "type": "query",
                "description": "String used to perform a case-insensitive partial match with `name`."
              },
              {
                "name": "accountId",
                "value": "",
                "type": "query",
                "description": "User account ID used to return dashboards with the matching `owner.accountId`. This parameter cannot be used with the `owner` parameter."
              },
              {
                "name": "owner",
                "value": "",
                "type": "query",
                "description": "This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return dashboards with the matching `owner.name`. This parameter cannot be used with the `accountId` parameter."
              },
              {
                "name": "groupname",
                "value": "",
                "type": "query",
                "description": "As a group's name can change, use of `groupId` is recommended. Group name used to return dashboards that are shared with a group that matches `sharePermissions.group.name`. This parameter cannot be used with the `groupId` parameter."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "query",
                "description": "Group ID used to return dashboards that are shared with a group that matches `sharePermissions.group.groupId`. This parameter cannot be used with the `groupname` parameter."
              },
              {
                "name": "projectId",
                "value": "",
                "type": "query",
                "description": "Project ID used to returns dashboards that are shared with a project that matches `sharePermissions.project.id`."
              },
              {
                "name": "orderBy",
                "value": "",
                "type": "query",
                "description": "[Order](#ordering) the results by a field:\n\n *  `description` Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use.\n *  `favourite_count` Sorts by dashboard popularity.\n *  `id` Sorts by dashboard ID.\n *  `is_favourite` Sorts by whether the dashboard is marked as a favorite.\n *  `name` Sorts by dashboard name.\n *  `owner` Sorts by dashboard owner name."
              },
              {
                "name": "startAt",
                "value": "",
                "type": "query",
                "description": "The index of the first item to return in a page of results (page offset)."
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return per page."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "The status to filter by. It may be active, archived or deleted."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Use [expand](#expansion) to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `description` Returns the description of the dashboard.\n *  `owner` Returns the owner of the dashboard.\n *  `viewUrl` Returns the URL that is used to view the dashboard.\n *  `favourite` Returns `isFavourite`, an indicator of whether the user has set the dashboard as a favorite.\n *  `favouritedCount` Returns `popularity`, a count of how many users have set this dashboard as a favorite.\n *  `sharePermissions` Returns details of the share permissions defined for the dashboard.\n *  `editPermissions` Returns details of the edit permissions defined for the dashboard.\n *  `isWritable` Returns whether the current user has permission to edit the dashboard."
              }
            ]
          },
          "docs": "Returns a [paginated](#pagination) list of dashboards. This operation is similar to [Get dashboards](#api-rest-api-3-dashboard-get) except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned.<br><br>This operation can be accessed anonymously.<br><br>**[Permissions](#permissions) required:** The following dashboards that match th"
        },
        {
          "info": {
            "name": "Atlassian Get Gadgets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/dashboard/:dashboardId/gadget",
            "params": [
              {
                "name": "dashboardId",
                "value": "",
                "type": "path",
                "description": "The ID of the dashboard."
              },
              {
                "name": "moduleKey",
                "value": "",
                "type": "query",
                "description": "The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: `moduleKey=key:one&moduleKey=key:two`."
              },
              {
                "name": "uri",
                "value": "",
                "type": "query",
                "description": "The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: `uri=/rest/example/uri/1&uri=/rest/example/uri/2`."
              },
              {
                "name": "gadgetId",
                "value": "",
                "type": "query",
                "description": "The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: `gadgetId=10000&gadgetId=10001`."
              }
            ]
          },
          "docs": "Returns a list of dashboard gadgets on a dashboard.<br><br>This operation returns:<br><br> *  Gadgets from a list of IDs, when `id` is set.<br> *  Gadgets with a module key, when `moduleKey` is set.<br> *  Gadgets from a list of URIs, when `uri` is set.<br> *  All gadgets, when no other parameters are set.<br><br>This operation can be accessed anonymously.<br><br>**[Permissions](#permissions) required:** None."
        },
        {
          "info": {
            "name": "Atlassian Add Gadget To Dashboard",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.atlassian.com/rest/api/3/dashboard/:dashboardId/gadget",
            "params": [
              {
                "name": "dashboardId",
                "value": "",
                "type": "path",
                "description": "The ID of the dashboard."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds a gadget to a dashboard.<br><br>**[Permissions](#permissions) required:** None."
        },
        {
          "info": {
            "name": "Atlassian Update Gadget On Dashboard",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.atlassian.com/rest/api/3/dashboard/:dashboardId/gadget/:gadgetId",
            "params": [
              {
                "name": "dashboardId",
                "value": "",
                "type": "path",
                "description": "The ID of the dashboard."
              },
              {
                "name": "gadgetId",
                "value": "",
                "type": "path",
                "description": "The ID of the gadget."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Changes the title, position, and color of the gadget on a dashboard.<br><br>**[Permissions](#permissions) required:** None."
        },
        {
          "info": {
            "name": "Atlassian Remove Gadget From Dashboard",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/rest/api/3/dashboard/:dashboardId/gadget/:gadgetId",
            "params": [
              {
                "name": "dashboardId",
                "value": "",
                "type": "path",
                "description": "The ID of the dashboard."
              },
              {
                "name": "gadgetId",
                "value": "",
                "type": "path",
                "description": "The ID of the gadget."
              }
            ]
          },
          "docs": "Removes a dashboard gadget from a dashboard.<br><br>When a gadget is removed from a dashboard, other gadgets in the same column are moved up to fill the emptied position.<br><br>**[Permissions](#permissions) required:** None."
        },
        {
          "info": {
            "name": "Atlassian Get Dashboard Item Property Keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/dashboard/:dashboardId/items/:itemId/properties",
            "params": [
              {
                "name": "dashboardId",
                "value": "",
                "type": "path",
                "description": "The ID of the dashboard."
              },
              {
                "name": "itemId",
                "value": "",
                "type": "path",
                "description": "The ID of the dashboard item."
              }
            ]
          },
          "docs": "Returns the keys of all properties for a dashboard item.<br><br>This operation can be accessed anonymously.<br><br>**[Permissions](#permissions) required:** The user must be the owner of the dashboard or have the dashboard shared with them. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users, and is accessible to anonymous users whe"
        },
        {
          "info": {
            "name": "Atlassian Get Dashboard Item Property",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
            "params": [
              {
                "name": "dashboardId",
                "value": "",
                "type": "path",
                "description": "The ID of the dashboard."
              },
              {
                "name": "itemId",
                "value": "",
                "type": "path",
                "description": "The ID of the dashboard item."
              },
              {
                "name": "propertyKey",
                "value": "",
                "type": "path",
                "description": "The key of the dashboard item property."
              }
            ]
          },
          "docs": "Returns the key and value of a dashboard item property.<br><br>A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see [Adding and customizing gadgets](https://confluence.atlassian.com/x/7AeiLQ).<br><br>When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item "
        },
        {
          "info": {
            "name": "Atlassian Set Dashboard Item Property",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.atlassian.com/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
            "params": [
              {
                "name": "dashboardId",
                "value": "",
                "type": "path",
                "description": "The ID of the dashboard."
              },
              {
                "name": "itemId",
                "value": "",
                "type": "path",
                "description": "The ID of the dashboard item."
              },
              {
                "name": "propertyKey",
                "value": "",
                "type": "path",
                "description": "The key of the dashboard item property. The maximum length is 255 characters. For dashboard items with a spec URI and no complete module key, if the provided propertyKey is equal to \"config\", the request body's JSON must be an object with all keys and values as strings."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.<br><br>A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see [Adding and customizing gadgets](https://confluence.atlassian.com/x/7AeiLQ).<br><br>When an app creates a dashboard item it registers a callback to receiv"
        },
        {
          "info": {
            "name": "Atlassian Delete Dashboard Item Property",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/rest/api/3/dashboard/:dashboardId/items/:itemId/properties/:propertyKey",
            "params": [
              {
                "name": "dashboardId",
                "value": "",
                "type": "path",
                "description": "The ID of the dashboard."
              },
              {
                "name": "itemId",
                "value": "",
                "type": "path",
                "description": "The ID of the dashboard item."
              },
              {
                "name": "propertyKey",
                "value": "",
                "type": "path",
                "description": "The key of the dashboard item property."
              }
            ]
          },
          "docs": "Deletes a dashboard item property.<br><br>This operation can be accessed anonymously.<br><br>**[Permissions](#permissions) required:** The user must be the owner of the dashboard. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard."
        },
        {
          "info": {
            "name": "Atlassian Get Dashboard",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/dashboard/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dashboard."
              }
            ]
          },
          "docs": "Returns a dashboard.<br><br>This operation can be accessed anonymously.<br><br>**[Permissions](#permissions) required:** None.<br><br>However, to get a dashboard, the dashboard must be shared with the user or the user must own it. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users."
        },
        {
          "info": {
            "name": "Atlassian Update Dashboard",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.atlassian.com/rest/api/3/dashboard/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dashboard to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a dashboard, replacing all the dashboard details with those provided.<br><br>**[Permissions](#permissions) required:** None<br><br>The dashboard to be updated must be owned by the user."
        },
        {
          "info": {
            "name": "Atlassian Delete Dashboard",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/rest/api/3/dashboard/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dashboard."
              }
            ]
          },
          "docs": "Deletes a dashboard.<br><br>**[Permissions](#permissions) required:** None<br><br>The dashboard to be deleted must be owned by the user."
        },
        {
          "info": {
            "name": "Atlassian Copy Dashboard",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.atlassian.com/rest/api/3/dashboard/:id/copy",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Copies a dashboard. Any values provided in the `dashboard` parameter replace those in the copied dashboard.<br><br>**[Permissions](#permissions) required:** None<br><br>The dashboard to be copied must be owned by or shared with the user."
        },
        {
          "info": {
            "name": "Atlassian Get All Dashboards",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/dashboard",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "The filter applied to the list of dashboards. Valid values are:\n\n *  `favourite` Returns dashboards the user has marked as favorite.\n *  `my` Returns dashboards owned by the user."
              },
              {
                "name": "startAt",
                "value": "",
                "type": "query",
                "description": "The index of the first item to return in a page of results (page offset)."
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return per page."
              }
            ]
          },
          "docs": "Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.<br><br>This operation can be accessed anonymously.<br><br>**[Permissions](#permissions) required:** None."
        },
        {
          "info": {
            "name": "Atlassian Create Dashboard",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.atlassian.com/rest/api/3/dashboard",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a dashboard.<br><br>**[Permissions](#permissions) required:** None."
        }
      ]
    }
  ],
  "bundled": true
}