Atlassian: Bulk edit dashboards

← Dashboards operations · Get started

Operation atlassian.bulkeditdashboards

Provider route: PUT /{cloudId}/rest/api/3/dashboard/bulk/edit. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["dashboards"]["bulkEditDashboards"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.dashboards.bulkEditDashboards(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.dashboards.bulk_edit_dashboards(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.cloudId	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
body	Model	Required within parent	Expand Bulk edit dashboards — request body — body

Referenced models: Bulk edit dashboards — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Bulk edit dashboards — response body

Referenced models: Bulk edit dashboards — response body

Schemas

26 more schemas are linked from the tables above, on the schema pages.

Bulk edit dashboards — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Details of a request to bulk edit shareable entity. Additional keys: not allowed
action	string	Required within parent	Allowed action for bulk edit shareable entity One of: changeOwner, changePermission, addPermission, removePermission
changeOwnerDetails	Model	Optional	Expand Bulk edit dashboards — request body — body change Owner Details The details of change owner action.
entityIds	array	Required within parent	The id list of shareable entities to be changed. Unique items: true
entityIds[]	integer	Each item	Format: int64
extendAdminPermissions	boolean	Optional	Whether the actions are executed by users with Administer Jira global permission.
permissionDetails	Model	Optional	Expand Bulk edit dashboards — request body — body permission Details The permission details to be changed.

Referenced models: Bulk edit dashboards — request body — body change Owner Details, Bulk edit dashboards — request body — body permission Details

Bulk edit dashboards — response body

Field	Type	Presence	Description and constraints
$	object	Root	Details of a request to bulk edit shareable entity.
action	JSON	Optional
action (anyOf 1)	string	Alternative	Allowed action for bulk edit shareable entity Known values: changeOwner, changePermission, addPermission, removePermission
action (anyOf 2)	null	Alternative
entityErrors	JSON	Optional
entityErrors (anyOf 1)	object	Alternative	The mapping dashboard id to errors if any. Additional keys: see wildcard field
entityErrors (anyOf 1).*	Model	Additional keys	Expand Bulk edit dashboards — response body — entity Errors The mapping dashboard id to errors if any value
entityErrors (anyOf 2)	null	Alternative

Referenced models: Bulk edit dashboards — response body — entity Errors The mapping dashboard id to errors if any value

Bulk edit dashboards — request body — body change Owner Details

Field	Type	Presence	Description and constraints
$	object	Root	Details for changing owners of shareable entities Additional keys: not allowed
autofixName	boolean	Required within parent	Whether the name is fixed automatically if it's duplicated after changing owner.
newOwner	string	Required within parent	The account id of the new owner.

Bulk edit dashboards — request body — body permission Details

Field	Type	Presence	Description and constraints
$	object	Root	Details for permissions of shareable entities Additional keys: not allowed
editPermissions	array	Required within parent	The edit permissions for the shareable entities.
editPermissions[]	Model	Each item	Expand Create filter — request body — body edit Permissions item
sharePermissions	array	Required within parent	The share permissions for the shareable entities.
sharePermissions[]	Model	Each item	Expand Create filter — request body — body edit Permissions item

Referenced models: Create filter — request body — body edit Permissions item

Bulk edit dashboards — response body — entity Errors The mapping dashboard id to errors if any value

Field	Type	Presence	Description and constraints
$	object	Root	Errors of bulk edit action.
errorMessages	JSON	Optional
errorMessages (anyOf 1)	array	Alternative	The error messages.
errorMessages (anyOf 1)[]	string	Each item
errorMessages (anyOf 2)	null	Alternative
errors	JSON	Optional
errors (anyOf 1)	object	Alternative	The errors. Additional keys: see wildcard field
errors (anyOf 1).*	string	Additional keys
errors (anyOf 2)	null	Alternative

Create filter — request body — body edit Permissions item

Field	Type	Presence	Description and constraints
$	object	Root	Details of a share permission for the filter. Additional keys: not allowed
group	Model	Optional	Expand Send notification for issue — request body — body to groups item 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.
id	integer	Optional	The unique identifier of the share permission. Format: int64 Read only: true
project	Model	Optional	Expand Create filter — request body — body edit Permissions item project 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`. For a request, specify the `id` for the project.
role	Model	Optional	Expand Create filter — request body — body edit Permissions item role The project role that the filter is shared with. For 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	string	Required within parent	The type of share permission: * `user` Shared with a user. * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well. * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well. * `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`. * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified. * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`. * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request. One of: user, group, project, projectRole, global, loggedin, authenticated, project-unknown
user	Model	Optional	Expand Create filter — request body — body edit Permissions item user The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user.

Referenced models: Send notification for issue — request body — body to groups item, Create filter — request body — body edit Permissions item project, Create filter — request body — body edit Permissions item role, Create filter — request body — body edit Permissions item user

Send notification for issue — request body — body to groups item

Field	Type	Presence	Description and constraints
$	object	Root	Details about a group. Additional keys: not allowed
groupId	JSON	Optional
groupId (anyOf 1)	string	Alternative	The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*.
groupId (anyOf 2)	null	Alternative
name	string	Optional	The name of group.
self	string	Optional	The URL for these group details. Format: uri Read only: true

Create filter — request body — body edit Permissions item user

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
accountId	string	Optional	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Maximum length: 128
active	boolean	Optional	Whether the user is active.
avatarUrls	Model	Optional	Expand Create filter — request body — body edit Permissions item user avatar Urls The avatars of the user.
displayName	string	Optional	The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
key	string	Optional	This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The key of the user.
name	string	Optional	This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The username of the user.
self	string	Optional	The URL of the user. Format: uri

Referenced models: Create filter — request body — body edit Permissions item user avatar Urls

Assign issue — request body — body groups callback

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed

Policy, approvals and errors

SDK function policy ID: atlassian.bulkeditdashboards. Catalog operation: bulkeditdashboards. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["write:jira-work"]

Official provider source