--- title: "Bulk edit dashboards" method: PUT path: "/rest/api/2/dashboard/bulk/edit" tags: ["Dashboards"] --- # Bulk edit dashboards `PUT /rest/api/2/dashboard/bulk/edit` Bulk edit dashboards. Maximum number of dashboards to be edited at the same time is 100. **[Permissions](#permissions) required:** None The dashboards to be updated must be owned by the user, or the user must be an administrator. ## Request body - BulkEditShareableEntityRequest — Details of a request to bulk edit shareable entity. - `action` 'changeOwner' | 'changePermission' | 'addPermission' | 'removePermission', required — Allowed action for bulk edit shareable entity - `changeOwnerDetails` BulkChangeOwnerDetails — Details for changing owners of shareable entities - `autofixName` boolean, required — Whether the name is fixed automatically if it's duplicated after changing owner. - `newOwner` string, required — The account id of the new owner. - `entityIds` integer[], required — The id list of shareable entities to be changed. - `extendAdminPermissions` boolean — Whether the actions are executed by users with Administer Jira global permission. - `permissionDetails` PermissionDetails — Details for permissions of shareable entities - `editPermissions` SharePermission[], required — The edit permissions for the shareable entities. - `group` GroupName — Details about a group. - `groupId` string, nullable — The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*. - `name` string — The name of group. - `self` string, uri — The URL for these group details. - `id` integer — The unique identifier of the share permission. - `project` Project — Details about a project. - `archived` boolean — Whether the project is archived. - `archivedBy` User — A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests. - `accountType` 'atlassian' | 'app' | 'customer' | 'unknown' — The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk - `active` boolean — Whether the user is active. - `appType` string — The app type of the user account when accountType is 'app'. Can take the following values: * `service` Service Account * `agent` Rovo Agent Account * `unknown` Unknown app type - `applicationRoles` SimpleListWrapperApplicationRole - `callback` ListWrapperCallbackApplicationRole - `items` ApplicationRole[] - … - `max-results` integer - `pagingCallback` ListWrapperCallbackApplicationRole - `size` integer - `avatarUrls` AvatarUrlsBean - `16x16` string, uri — The URL of the item's 16x16 pixel avatar. - `24x24` string, uri — The URL of the item's 24x24 pixel avatar. - `32x32` string, uri — The URL of the item's 32x32 pixel avatar. - `48x48` string, uri — The URL of the item's 48x48 pixel avatar. - `displayName` string — The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. - `emailAddress` string — The email address of the user. Depending on the user’s privacy setting, this may be returned as null. - `expand` string — Expand options that include additional user details in the response. - `groups` SimpleListWrapperGroupName - `callback` ListWrapperCallbackGroupName - `items` GroupName[] - … - `max-results` integer - `pagingCallback` ListWrapperCallbackGroupName - `size` integer - `guest` boolean — Whether the user is a guest. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `locale` string — The locale of the user. Depending on the user’s privacy setting, this may be returned as null. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `self` string, uri — The URL of the user. - `timeZone` string — The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. - `archivedDate` string, date-time — The date when the project was archived. - `assigneeType` 'PROJECT_LEAD' | 'UNASSIGNED' — The default assignee when creating issues for this project. - `avatarUrls` AvatarUrlsBean - `16x16` string, uri — The URL of the item's 16x16 pixel avatar. - `24x24` string, uri — The URL of the item's 24x24 pixel avatar. - `32x32` string, uri — The URL of the item's 32x32 pixel avatar. - `48x48` string, uri — The URL of the item's 48x48 pixel avatar. - `components` ProjectComponent[] — List of the components contained in the project. - `ari` string — Compass component's ID. Can't be updated. Not required for creating a Project Component. - `assignee` User — A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests. - `accountType` 'atlassian' | 'app' | 'customer' | 'unknown' — The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk - `active` boolean — Whether the user is active. - `appType` string — The app type of the user account when accountType is 'app'. Can take the following values: * `service` Service Account * `agent` Rovo Agent Account * `unknown` Unknown app type - `applicationRoles` SimpleListWrapperApplicationRole - … - `avatarUrls` AvatarUrlsBean - … - `displayName` string — The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. - `emailAddress` string — The email address of the user. Depending on the user’s privacy setting, this may be returned as null. - `expand` string — Expand options that include additional user details in the response. - `groups` SimpleListWrapperGroupName - … - `guest` boolean — Whether the user is a guest. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `locale` string — The locale of the user. Depending on the user’s privacy setting, this may be returned as null. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `self` string, uri — The URL of the user. - `timeZone` string — The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. - `assigneeType` 'PROJECT_DEFAULT' | 'COMPONENT_LEAD' | 'PROJECT_LEAD' | 'UNASSIGNED' — The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values: * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in. * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component. * `UNASSIGNED` an assignee is not set for issues created with this component. * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in. Default value: `PROJECT_DEFAULT`. Optional when creating or updating a component. - `description` string — The description for the component. Optional when creating or updating a component. - `id` string — The unique identifier for the component. - `isAssigneeTypeValid` boolean — Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned. - `lead` User — A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests. - `accountType` 'atlassian' | 'app' | 'customer' | 'unknown' — The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk - `active` boolean — Whether the user is active. - `appType` string — The app type of the user account when accountType is 'app'. Can take the following values: * `service` Service Account * `agent` Rovo Agent Account * `unknown` Unknown app type - `applicationRoles` SimpleListWrapperApplicationRole - … - `avatarUrls` AvatarUrlsBean - … - `displayName` string — The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. - `emailAddress` string — The email address of the user. Depending on the user’s privacy setting, this may be returned as null. - `expand` string — Expand options that include additional user details in the response. - `groups` SimpleListWrapperGroupName - … - `guest` boolean — Whether the user is a guest. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `locale` string — The locale of the user. Depending on the user’s privacy setting, this may be returned as null. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `self` string, uri — The URL of the user. - `timeZone` string — The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. - `leadAccountId` string — The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. - `leadUserName` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `metadata` object — Compass component's metadata. Can't be updated. Not required for creating a Project Component. - `name` string — The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters. - `project` string — The key of the project the component is assigned to. Required when creating a component. Can't be updated. - `projectId` integer — The ID of the project the component is assigned to. - `realAssignee` User — A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests. - `accountType` 'atlassian' | 'app' | 'customer' | 'unknown' — The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk - `active` boolean — Whether the user is active. - `appType` string — The app type of the user account when accountType is 'app'. Can take the following values: * `service` Service Account * `agent` Rovo Agent Account * `unknown` Unknown app type - `applicationRoles` SimpleListWrapperApplicationRole - … - `avatarUrls` AvatarUrlsBean - … - `displayName` string — The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. - `emailAddress` string — The email address of the user. Depending on the user’s privacy setting, this may be returned as null. - `expand` string — Expand options that include additional user details in the response. - `groups` SimpleListWrapperGroupName - … - `guest` boolean — Whether the user is a guest. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `locale` string — The locale of the user. Depending on the user’s privacy setting, this may be returned as null. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `self` string, uri — The URL of the user. - `timeZone` string — The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. - `realAssigneeType` 'PROJECT_DEFAULT' | 'COMPONENT_LEAD' | 'PROJECT_LEAD' | 'UNASSIGNED' — The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values: * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in. * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in. * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues. * `PROJECT_DEFAULT` when none of the preceding cases are true. - `self` string, uri — The URL of the component. - `deleted` boolean — Whether the project is marked as deleted. - `deletedBy` User — A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests. - `accountType` 'atlassian' | 'app' | 'customer' | 'unknown' — The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk - `active` boolean — Whether the user is active. - `appType` string — The app type of the user account when accountType is 'app'. Can take the following values: * `service` Service Account * `agent` Rovo Agent Account * `unknown` Unknown app type - `applicationRoles` SimpleListWrapperApplicationRole - `callback` ListWrapperCallbackApplicationRole - `items` ApplicationRole[] - … - `max-results` integer - `pagingCallback` ListWrapperCallbackApplicationRole - `size` integer - `avatarUrls` AvatarUrlsBean - `16x16` string, uri — The URL of the item's 16x16 pixel avatar. - `24x24` string, uri — The URL of the item's 24x24 pixel avatar. - `32x32` string, uri — The URL of the item's 32x32 pixel avatar. - `48x48` string, uri — The URL of the item's 48x48 pixel avatar. - `displayName` string — The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. - `emailAddress` string — The email address of the user. Depending on the user’s privacy setting, this may be returned as null. - `expand` string — Expand options that include additional user details in the response. - `groups` SimpleListWrapperGroupName - `callback` ListWrapperCallbackGroupName - `items` GroupName[] - … - `max-results` integer - `pagingCallback` ListWrapperCallbackGroupName - `size` integer - `guest` boolean — Whether the user is a guest. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `locale` string — The locale of the user. Depending on the user’s privacy setting, this may be returned as null. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `self` string, uri — The URL of the user. - `timeZone` string — The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. - `deletedDate` string, date-time — The date when the project was marked as deleted. - `description` string — A brief description of the project. - `email` string — An email address associated with the project. - `expand` string — Expand options that include additional project details in the response. - `favourite` boolean — Whether the project is selected as a favorite. - `id` string — The ID of the project. - `insight` ProjectInsight — Additional details about a project. - `lastIssueUpdateTime` string, date-time — The last issue update time. - `totalIssueCount` integer — Total issue count. - `isPrivate` boolean — Whether the project is private from the user's perspective. This means the user can't see the project or any associated issues. - `issueTypeHierarchy` Hierarchy — The project issue type hierarchy. - `baseLevelId` integer — The ID of the base level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - `levels` SimplifiedHierarchyLevel[] — Details about the hierarchy level. - `aboveLevelId` integer — The ID of the level above this one in the hierarchy. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - `belowLevelId` integer — The ID of the level below this one in the hierarchy. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - `externalUuid` string, uuid — The external UUID of the hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - `hierarchyLevelNumber` integer - `id` integer — The ID of the hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - `issueTypeIds` integer[] — The issue types available in this hierarchy level. - `level` integer — The level of this item in the hierarchy. - `name` string — The name of this hierarchy level. - `projectConfigurationId` integer — The ID of the project configuration. This property is deprecated, see [Change oticen: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - `issueTypes` IssueTypeDetails[] — List of the issue types available in the project. - `avatarId` integer — The ID of the issue type's avatar. - `description` string — The description of the issue type. - `entityId` string, uuid — Unique ID for next-gen projects. - `hierarchyLevel` integer — Hierarchy level of the issue type. - `iconUrl` string — The URL of the issue type's avatar. - `id` string — The ID of the issue type. - `name` string — The name of the issue type. - `scope` Scope — The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). - `project` ProjectDetails — Details about a project. - … - `type` 'PROJECT' | 'TEMPLATE' — The type of scope. - `self` string — The URL of these issue type details. - `subtask` boolean — Whether this issue type is used to create subtasks. - `key` string — The key of the project. - `landingPageInfo` ProjectLandingPageInfo - `attributes` object - `boardId` integer - `boardName` string - `projectKey` string - `projectType` string - `queueCategory` string - `queueId` integer - `queueName` string - `simpleBoard` boolean - `simplified` boolean - `url` string - `lead` User — A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests. - `accountType` 'atlassian' | 'app' | 'customer' | 'unknown' — The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk - `active` boolean — Whether the user is active. - `appType` string — The app type of the user account when accountType is 'app'. Can take the following values: * `service` Service Account * `agent` Rovo Agent Account * `unknown` Unknown app type - `applicationRoles` SimpleListWrapperApplicationRole - `callback` ListWrapperCallbackApplicationRole - `items` ApplicationRole[] - … - `max-results` integer - `pagingCallback` ListWrapperCallbackApplicationRole - `size` integer - `avatarUrls` AvatarUrlsBean - `16x16` string, uri — The URL of the item's 16x16 pixel avatar. - `24x24` string, uri — The URL of the item's 24x24 pixel avatar. - `32x32` string, uri — The URL of the item's 32x32 pixel avatar. - `48x48` string, uri — The URL of the item's 48x48 pixel avatar. - `displayName` string — The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. - `emailAddress` string — The email address of the user. Depending on the user’s privacy setting, this may be returned as null. - `expand` string — Expand options that include additional user details in the response. - `groups` SimpleListWrapperGroupName - `callback` ListWrapperCallbackGroupName - `items` GroupName[] - … - `max-results` integer - `pagingCallback` ListWrapperCallbackGroupName - `size` integer - `guest` boolean — Whether the user is a guest. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `locale` string — The locale of the user. Depending on the user’s privacy setting, this may be returned as null. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `self` string, uri — The URL of the user. - `timeZone` string — The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. - `name` string — The name of the project. - `permissions` ProjectPermissions — Permissions which a user has on a project. - `canEdit` boolean — Whether the logged user can edit the project. - `projectCategory` ProjectCategory — A project category. - `description` string — The description of the project category. - `id` string — The ID of the project category. - `name` string — The name of the project category. Required on create, optional on update. - `self` string, uri — The URL of the project category. - `projectTypeKey` 'software' | 'service_desk' | 'business' — The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. - `properties` object — Map of project properties - `retentionTillDate` string, date-time — The date when the project is deleted permanently. - `roles` object — The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-2-role-post). - `self` string, uri — The URL of the project details. - `simplified` boolean — Whether the project is simplified. - `style` 'classic' | 'next-gen' — The type of the project. - `url` string — A link to information about this project, such as project documentation. - `uuid` string, uuid — Unique ID for next-gen projects. - `versions` Version[] — The versions defined in the project. For more information, see [Create version](#api-rest-api-2-version-post). - `approvers` VersionApprover[] — If the expand option `approvers` is used, returns a list containing the approvers for this version. - `accountId` string — The Atlassian account ID of the approver. - `declineReason` string — A description of why the user is declining the approval. - `description` string — A description of what the user is approving within the specified version. - `status` string — The status of the approval, which can be *PENDING*, *APPROVED*, or *DECLINED* - `archived` boolean — Indicates that the version is archived. Optional when creating or updating a version. - `description` string — The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes. - `driver` string — The Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option `driver` is used, returns the Atlassian account ID of the driver. - `expand` string — Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include: * `operations` Returns the list of operations available for this version. * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*. * `driver` Returns the Atlassian account ID of the version driver. * `approvers` Returns a list containing approvers for this version. Optional for create and update. - `id` string — The ID of the version. - `issuesStatusForFixVersion` VersionIssuesStatus — Counts of the number of issues in various statuses. - `done` integer — Count of issues with status *done*. - `inProgress` integer — Count of issues with status *in progress*. - `toDo` integer — Count of issues with status *to do*. - `unmapped` integer — Count of issues with a status other than *to do*, *in progress*, and *done*. - `moveUnfixedIssuesTo` string, uri — The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version. - `name` string — The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters. - `operations` SimpleLink[] — If the expand option `operations` is used, returns the list of operations available for this version. - `href` string - `iconClass` string - `id` string - `label` string - `styleClass` string - `title` string - `weight` integer - `overdue` boolean — Indicates that the version is overdue. - `project` string — Deprecated. Use `projectId`. - `projectId` integer — The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version. - `releaseDate` string, date — The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version. - `released` boolean — Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version. - `self` string, uri — The URL of the version. - `startDate` string, date — The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version. - `userReleaseDate` string — The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format. - `userStartDate` string — The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format. - `role` ProjectRole — Details about the roles in a project. - `actors` RoleActor[] — The list of users who act in this role. - `actorGroup` ProjectRoleGroup — Details of the group associated with the role. - `displayName` string — The display name of the group. - `groupId` string — The ID of the group. - `name` string — The name of the group. As a group's name can change, use of `groupId` is recommended to identify the group. - `actorUser` ProjectRoleUser — Details of the user associated with the role. - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown* if the record is deleted and corrupted, for example, as the result of a server import. - `avatarUrl` string, uri — The avatar of the role actor. - `displayName` string — The display name of the role actor. For users, depending on the user’s privacy setting, this may return an alternative value for the user's name. - `id` integer — The ID of the role actor. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `type` 'atlassian-group-role-actor' | 'atlassian-user-role-actor' — The type of role actor. - `admin` boolean — Whether this role is the admin role for the project. - `currentUserRole` boolean — Whether the calling user is part of this role. - `default` boolean — Whether this role is the default role for the project - `description` string — The description of the project role. - `id` integer — The ID of the project role. - `name` string — The name of the project role. - `roleConfigurable` boolean — Whether the roles are configurable for this project. - `scope` Scope — The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). - `project` ProjectDetails — Details about a project. - `avatarUrls` AvatarUrlsBean - … - `id` string — The ID of the project. - `key` string — The key of the project. - `name` string — The name of the project. - `projectCategory` UpdatedProjectCategory — A project category. - … - `projectTypeKey` 'software' | 'service_desk' | 'business' — The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. - `self` string — The URL of the project details. - `simplified` boolean — Whether or not the project is simplified. - `type` 'PROJECT' | 'TEMPLATE' — The type of scope. - `self` string, uri — The URL the project role details. - `translatedName` string — The translated name of the project role. - `type` 'user' | 'group' | 'project' | 'projectRole' | 'global' | 'loggedin' | 'authenticated' | 'project-unknown', required — 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. - `user` UserBean - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. - `active` boolean — Whether the user is active. - `avatarUrls` UserBeanAvatarUrls - `16x16` string, uri — The URL of the user's 16x16 pixel avatar. - `24x24` string, uri — The URL of the user's 24x24 pixel avatar. - `32x32` string, uri — The URL of the user's 32x32 pixel avatar. - `48x48` string, uri — The URL of the user's 48x48 pixel avatar. - `displayName` string — The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. - `key` string — 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 — 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, uri — The URL of the user. - `sharePermissions` SharePermission[], required — The share permissions for the shareable entities. - `group` GroupName — Details about a group. - `groupId` string, nullable — The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*. - `name` string — The name of group. - `self` string, uri — The URL for these group details. - `id` integer — The unique identifier of the share permission. - `project` Project — Details about a project. - `archived` boolean — Whether the project is archived. - `archivedBy` User — A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests. - `accountType` 'atlassian' | 'app' | 'customer' | 'unknown' — The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk - `active` boolean — Whether the user is active. - `appType` string — The app type of the user account when accountType is 'app'. Can take the following values: * `service` Service Account * `agent` Rovo Agent Account * `unknown` Unknown app type - `applicationRoles` SimpleListWrapperApplicationRole - `callback` ListWrapperCallbackApplicationRole - `items` ApplicationRole[] - … - `max-results` integer - `pagingCallback` ListWrapperCallbackApplicationRole - `size` integer - `avatarUrls` AvatarUrlsBean - `16x16` string, uri — The URL of the item's 16x16 pixel avatar. - `24x24` string, uri — The URL of the item's 24x24 pixel avatar. - `32x32` string, uri — The URL of the item's 32x32 pixel avatar. - `48x48` string, uri — The URL of the item's 48x48 pixel avatar. - `displayName` string — The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. - `emailAddress` string — The email address of the user. Depending on the user’s privacy setting, this may be returned as null. - `expand` string — Expand options that include additional user details in the response. - `groups` SimpleListWrapperGroupName - `callback` ListWrapperCallbackGroupName - `items` GroupName[] - … - `max-results` integer - `pagingCallback` ListWrapperCallbackGroupName - `size` integer - `guest` boolean — Whether the user is a guest. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `locale` string — The locale of the user. Depending on the user’s privacy setting, this may be returned as null. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `self` string, uri — The URL of the user. - `timeZone` string — The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. - `archivedDate` string, date-time — The date when the project was archived. - `assigneeType` 'PROJECT_LEAD' | 'UNASSIGNED' — The default assignee when creating issues for this project. - `avatarUrls` AvatarUrlsBean - `16x16` string, uri — The URL of the item's 16x16 pixel avatar. - `24x24` string, uri — The URL of the item's 24x24 pixel avatar. - `32x32` string, uri — The URL of the item's 32x32 pixel avatar. - `48x48` string, uri — The URL of the item's 48x48 pixel avatar. - `components` ProjectComponent[] — List of the components contained in the project. - `ari` string — Compass component's ID. Can't be updated. Not required for creating a Project Component. - `assignee` User — A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests. - `accountType` 'atlassian' | 'app' | 'customer' | 'unknown' — The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk - `active` boolean — Whether the user is active. - `appType` string — The app type of the user account when accountType is 'app'. Can take the following values: * `service` Service Account * `agent` Rovo Agent Account * `unknown` Unknown app type - `applicationRoles` SimpleListWrapperApplicationRole - … - `avatarUrls` AvatarUrlsBean - … - `displayName` string — The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. - `emailAddress` string — The email address of the user. Depending on the user’s privacy setting, this may be returned as null. - `expand` string — Expand options that include additional user details in the response. - `groups` SimpleListWrapperGroupName - … - `guest` boolean — Whether the user is a guest. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `locale` string — The locale of the user. Depending on the user’s privacy setting, this may be returned as null. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `self` string, uri — The URL of the user. - `timeZone` string — The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. - `assigneeType` 'PROJECT_DEFAULT' | 'COMPONENT_LEAD' | 'PROJECT_LEAD' | 'UNASSIGNED' — The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values: * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in. * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component. * `UNASSIGNED` an assignee is not set for issues created with this component. * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in. Default value: `PROJECT_DEFAULT`. Optional when creating or updating a component. - `description` string — The description for the component. Optional when creating or updating a component. - `id` string — The unique identifier for the component. - `isAssigneeTypeValid` boolean — Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned. - `lead` User — A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests. - `accountType` 'atlassian' | 'app' | 'customer' | 'unknown' — The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk - `active` boolean — Whether the user is active. - `appType` string — The app type of the user account when accountType is 'app'. Can take the following values: * `service` Service Account * `agent` Rovo Agent Account * `unknown` Unknown app type - `applicationRoles` SimpleListWrapperApplicationRole - … - `avatarUrls` AvatarUrlsBean - … - `displayName` string — The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. - `emailAddress` string — The email address of the user. Depending on the user’s privacy setting, this may be returned as null. - `expand` string — Expand options that include additional user details in the response. - `groups` SimpleListWrapperGroupName - … - `guest` boolean — Whether the user is a guest. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `locale` string — The locale of the user. Depending on the user’s privacy setting, this may be returned as null. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `self` string, uri — The URL of the user. - `timeZone` string — The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. - `leadAccountId` string — The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. - `leadUserName` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `metadata` object — Compass component's metadata. Can't be updated. Not required for creating a Project Component. - `name` string — The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters. - `project` string — The key of the project the component is assigned to. Required when creating a component. Can't be updated. - `projectId` integer — The ID of the project the component is assigned to. - `realAssignee` User — A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests. - `accountType` 'atlassian' | 'app' | 'customer' | 'unknown' — The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk - `active` boolean — Whether the user is active. - `appType` string — The app type of the user account when accountType is 'app'. Can take the following values: * `service` Service Account * `agent` Rovo Agent Account * `unknown` Unknown app type - `applicationRoles` SimpleListWrapperApplicationRole - … - `avatarUrls` AvatarUrlsBean - … - `displayName` string — The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. - `emailAddress` string — The email address of the user. Depending on the user’s privacy setting, this may be returned as null. - `expand` string — Expand options that include additional user details in the response. - `groups` SimpleListWrapperGroupName - … - `guest` boolean — Whether the user is a guest. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `locale` string — The locale of the user. Depending on the user’s privacy setting, this may be returned as null. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `self` string, uri — The URL of the user. - `timeZone` string — The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. - `realAssigneeType` 'PROJECT_DEFAULT' | 'COMPONENT_LEAD' | 'PROJECT_LEAD' | 'UNASSIGNED' — The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values: * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in. * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in. * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues. * `PROJECT_DEFAULT` when none of the preceding cases are true. - `self` string, uri — The URL of the component. - `deleted` boolean — Whether the project is marked as deleted. - `deletedBy` User — A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests. - `accountType` 'atlassian' | 'app' | 'customer' | 'unknown' — The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk - `active` boolean — Whether the user is active. - `appType` string — The app type of the user account when accountType is 'app'. Can take the following values: * `service` Service Account * `agent` Rovo Agent Account * `unknown` Unknown app type - `applicationRoles` SimpleListWrapperApplicationRole - `callback` ListWrapperCallbackApplicationRole - `items` ApplicationRole[] - … - `max-results` integer - `pagingCallback` ListWrapperCallbackApplicationRole - `size` integer - `avatarUrls` AvatarUrlsBean - `16x16` string, uri — The URL of the item's 16x16 pixel avatar. - `24x24` string, uri — The URL of the item's 24x24 pixel avatar. - `32x32` string, uri — The URL of the item's 32x32 pixel avatar. - `48x48` string, uri — The URL of the item's 48x48 pixel avatar. - `displayName` string — The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. - `emailAddress` string — The email address of the user. Depending on the user’s privacy setting, this may be returned as null. - `expand` string — Expand options that include additional user details in the response. - `groups` SimpleListWrapperGroupName - `callback` ListWrapperCallbackGroupName - `items` GroupName[] - … - `max-results` integer - `pagingCallback` ListWrapperCallbackGroupName - `size` integer - `guest` boolean — Whether the user is a guest. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `locale` string — The locale of the user. Depending on the user’s privacy setting, this may be returned as null. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `self` string, uri — The URL of the user. - `timeZone` string — The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. - `deletedDate` string, date-time — The date when the project was marked as deleted. - `description` string — A brief description of the project. - `email` string — An email address associated with the project. - `expand` string — Expand options that include additional project details in the response. - `favourite` boolean — Whether the project is selected as a favorite. - `id` string — The ID of the project. - `insight` ProjectInsight — Additional details about a project. - `lastIssueUpdateTime` string, date-time — The last issue update time. - `totalIssueCount` integer — Total issue count. - `isPrivate` boolean — Whether the project is private from the user's perspective. This means the user can't see the project or any associated issues. - `issueTypeHierarchy` Hierarchy — The project issue type hierarchy. - `baseLevelId` integer — The ID of the base level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - `levels` SimplifiedHierarchyLevel[] — Details about the hierarchy level. - `aboveLevelId` integer — The ID of the level above this one in the hierarchy. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - `belowLevelId` integer — The ID of the level below this one in the hierarchy. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - `externalUuid` string, uuid — The external UUID of the hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - `hierarchyLevelNumber` integer - `id` integer — The ID of the hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - `issueTypeIds` integer[] — The issue types available in this hierarchy level. - `level` integer — The level of this item in the hierarchy. - `name` string — The name of this hierarchy level. - `projectConfigurationId` integer — The ID of the project configuration. This property is deprecated, see [Change oticen: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - `issueTypes` IssueTypeDetails[] — List of the issue types available in the project. - `avatarId` integer — The ID of the issue type's avatar. - `description` string — The description of the issue type. - `entityId` string, uuid — Unique ID for next-gen projects. - `hierarchyLevel` integer — Hierarchy level of the issue type. - `iconUrl` string — The URL of the issue type's avatar. - `id` string — The ID of the issue type. - `name` string — The name of the issue type. - `scope` Scope — The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). - `project` ProjectDetails — Details about a project. - … - `type` 'PROJECT' | 'TEMPLATE' — The type of scope. - `self` string — The URL of these issue type details. - `subtask` boolean — Whether this issue type is used to create subtasks. - `key` string — The key of the project. - `landingPageInfo` ProjectLandingPageInfo - `attributes` object - `boardId` integer - `boardName` string - `projectKey` string - `projectType` string - `queueCategory` string - `queueId` integer - `queueName` string - `simpleBoard` boolean - `simplified` boolean - `url` string - `lead` User — A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests. - `accountType` 'atlassian' | 'app' | 'customer' | 'unknown' — The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk - `active` boolean — Whether the user is active. - `appType` string — The app type of the user account when accountType is 'app'. Can take the following values: * `service` Service Account * `agent` Rovo Agent Account * `unknown` Unknown app type - `applicationRoles` SimpleListWrapperApplicationRole - `callback` ListWrapperCallbackApplicationRole - `items` ApplicationRole[] - … - `max-results` integer - `pagingCallback` ListWrapperCallbackApplicationRole - `size` integer - `avatarUrls` AvatarUrlsBean - `16x16` string, uri — The URL of the item's 16x16 pixel avatar. - `24x24` string, uri — The URL of the item's 24x24 pixel avatar. - `32x32` string, uri — The URL of the item's 32x32 pixel avatar. - `48x48` string, uri — The URL of the item's 48x48 pixel avatar. - `displayName` string — The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. - `emailAddress` string — The email address of the user. Depending on the user’s privacy setting, this may be returned as null. - `expand` string — Expand options that include additional user details in the response. - `groups` SimpleListWrapperGroupName - `callback` ListWrapperCallbackGroupName - `items` GroupName[] - … - `max-results` integer - `pagingCallback` ListWrapperCallbackGroupName - `size` integer - `guest` boolean — Whether the user is a guest. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `locale` string — The locale of the user. Depending on the user’s privacy setting, this may be returned as null. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `self` string, uri — The URL of the user. - `timeZone` string — The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. - `name` string — The name of the project. - `permissions` ProjectPermissions — Permissions which a user has on a project. - `canEdit` boolean — Whether the logged user can edit the project. - `projectCategory` ProjectCategory — A project category. - `description` string — The description of the project category. - `id` string — The ID of the project category. - `name` string — The name of the project category. Required on create, optional on update. - `self` string, uri — The URL of the project category. - `projectTypeKey` 'software' | 'service_desk' | 'business' — The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. - `properties` object — Map of project properties - `retentionTillDate` string, date-time — The date when the project is deleted permanently. - `roles` object — The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-2-role-post). - `self` string, uri — The URL of the project details. - `simplified` boolean — Whether the project is simplified. - `style` 'classic' | 'next-gen' — The type of the project. - `url` string — A link to information about this project, such as project documentation. - `uuid` string, uuid — Unique ID for next-gen projects. - `versions` Version[] — The versions defined in the project. For more information, see [Create version](#api-rest-api-2-version-post). - `approvers` VersionApprover[] — If the expand option `approvers` is used, returns a list containing the approvers for this version. - `accountId` string — The Atlassian account ID of the approver. - `declineReason` string — A description of why the user is declining the approval. - `description` string — A description of what the user is approving within the specified version. - `status` string — The status of the approval, which can be *PENDING*, *APPROVED*, or *DECLINED* - `archived` boolean — Indicates that the version is archived. Optional when creating or updating a version. - `description` string — The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes. - `driver` string — The Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option `driver` is used, returns the Atlassian account ID of the driver. - `expand` string — Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include: * `operations` Returns the list of operations available for this version. * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*. * `driver` Returns the Atlassian account ID of the version driver. * `approvers` Returns a list containing approvers for this version. Optional for create and update. - `id` string — The ID of the version. - `issuesStatusForFixVersion` VersionIssuesStatus — Counts of the number of issues in various statuses. - `done` integer — Count of issues with status *done*. - `inProgress` integer — Count of issues with status *in progress*. - `toDo` integer — Count of issues with status *to do*. - `unmapped` integer — Count of issues with a status other than *to do*, *in progress*, and *done*. - `moveUnfixedIssuesTo` string, uri — The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version. - `name` string — The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters. - `operations` SimpleLink[] — If the expand option `operations` is used, returns the list of operations available for this version. - `href` string - `iconClass` string - `id` string - `label` string - `styleClass` string - `title` string - `weight` integer - `overdue` boolean — Indicates that the version is overdue. - `project` string — Deprecated. Use `projectId`. - `projectId` integer — The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version. - `releaseDate` string, date — The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version. - `released` boolean — Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version. - `self` string, uri — The URL of the version. - `startDate` string, date — The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version. - `userReleaseDate` string — The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format. - `userStartDate` string — The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format. - `role` ProjectRole — Details about the roles in a project. - `actors` RoleActor[] — The list of users who act in this role. - `actorGroup` ProjectRoleGroup — Details of the group associated with the role. - `displayName` string — The display name of the group. - `groupId` string — The ID of the group. - `name` string — The name of the group. As a group's name can change, use of `groupId` is recommended to identify the group. - `actorUser` ProjectRoleUser — Details of the user associated with the role. - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown* if the record is deleted and corrupted, for example, as the result of a server import. - `avatarUrl` string, uri — The avatar of the role actor. - `displayName` string — The display name of the role actor. For users, depending on the user’s privacy setting, this may return an alternative value for the user's name. - `id` integer — The ID of the role actor. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `type` 'atlassian-group-role-actor' | 'atlassian-user-role-actor' — The type of role actor. - `admin` boolean — Whether this role is the admin role for the project. - `currentUserRole` boolean — Whether the calling user is part of this role. - `default` boolean — Whether this role is the default role for the project - `description` string — The description of the project role. - `id` integer — The ID of the project role. - `name` string — The name of the project role. - `roleConfigurable` boolean — Whether the roles are configurable for this project. - `scope` Scope — The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). - `project` ProjectDetails — Details about a project. - `avatarUrls` AvatarUrlsBean - … - `id` string — The ID of the project. - `key` string — The key of the project. - `name` string — The name of the project. - `projectCategory` UpdatedProjectCategory — A project category. - … - `projectTypeKey` 'software' | 'service_desk' | 'business' — The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. - `self` string — The URL of the project details. - `simplified` boolean — Whether or not the project is simplified. - `type` 'PROJECT' | 'TEMPLATE' — The type of scope. - `self` string, uri — The URL the project role details. - `translatedName` string — The translated name of the project role. - `type` 'user' | 'group' | 'project' | 'projectRole' | 'global' | 'loggedin' | 'authenticated' | 'project-unknown', required — 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. - `user` UserBean - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. - `active` boolean — Whether the user is active. - `avatarUrls` UserBeanAvatarUrls - `16x16` string, uri — The URL of the user's 16x16 pixel avatar. - `24x24` string, uri — The URL of the user's 24x24 pixel avatar. - `32x32` string, uri — The URL of the user's 32x32 pixel avatar. - `48x48` string, uri — The URL of the user's 48x48 pixel avatar. - `displayName` string — The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. - `key` string — 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 — 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, uri — The URL of the user. ## Response `200` Returned if the request is successful. - BulkEditShareableEntityResponse — Details of a request to bulk edit shareable entity. - `action` 'changeOwner' | 'changePermission' | 'addPermission' | 'removePermission', required — Allowed action for bulk edit shareable entity - `entityErrors` object — The mapping dashboard id to errors if any. ## Other responses - `400` — Returned if the request is not valid. - `401` — Returned if the authentication credentials are incorrect or missing. --- [API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api/versions/a26541c2f8bd/schema)