Atlassian: Issue bulk operations schemas
55 Atlassian schemas with complete fields and constraints.
← Issue bulk operations operations · All schemas
Bulk delete issues — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue Bulk Delete Payload Additional keys: not allowed |
selectedIssueIdsOrKeys | array | Required within parent | List of issue IDs or keys which are to be bulk deleted. These IDs or keys can be from different projects and issue types. write Only: true |
selectedIssueIdsOrKeys[] | string | Each item | write Only: true |
sendBulkNotification | JSON | Optional | |
sendBulkNotification (anyOf 1) | boolean | Alternative | A boolean value that indicates whether to send a bulk change notification when the issues are being deleted. If `true`, dispatches a bulk notification email to users about the updates. Default: true write Only: true |
sendBulkNotification (anyOf 2) | null | Alternative |
Bulk edit issues — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue Bulk Edit Payload Additional keys: not allowed |
editedFieldsInput | Model | Required within parent | Expand Bulk edit issues — request body — body edited Fields Input An object that defines the values to be updated in specified fields of an issue. The structure and content of this parameter vary depending on the type of field being edited. Although the order is not significant, ensure that field IDs align with those in selectedActions. |
selectedActions | array | Required within parent | List of all the field IDs that are to be bulk edited. Each field ID in this list corresponds to a specific attribute of an issue that is set to be modified in the bulk edit operation. The relevant field ID can be obtained by calling the Bulk Edit Get Fields REST API (documentation available on this page itself). write Only: true |
selectedActions[] | string | Each item | write Only: true |
selectedIssueIdsOrKeys | array | Required within parent | List of issue IDs or keys which are to be bulk edited. These IDs or keys can be from different projects and issue types. write Only: true |
selectedIssueIdsOrKeys[] | string | Each item | write Only: true |
sendBulkNotification | JSON | Optional | |
sendBulkNotification (anyOf 1) | boolean | Alternative | A boolean value that indicates whether to send a bulk change notification when the issues are being edited. If `true`, dispatches a bulk notification email to users about the updates. Default: true write Only: true |
sendBulkNotification (anyOf 2) | null | Alternative |
Referenced models: Bulk edit issues — request body — body edited Fields Input
Bulk edit issues — request body — body edited Fields Input
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | write Only: true Additional keys: not allowed |
cascadingSelectFields | array | Optional | Add or clear a cascading select field: * To add, specify `optionId` for both parent and child. * To clear the child, set its `optionId` to null. * To clear both, set the parent's `optionId` to null. |
cascadingSelectFields[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input cascading Select Fields item |
clearableNumberFields | array | Optional | Add or clear a number field: * To add, specify a numeric `value`. * To clear, set `value` to `null`. |
clearableNumberFields[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input clearable Number Fields item |
colorFields | array | Optional | Add or clear a color field: * To add, specify the color `name`. Available colors are: `purple`, `blue`, `green`, `teal`, `yellow`, `orange`, `grey`, `dark purple`, `dark blue`, `dark green`, `dark teal`, `dark yellow`, `dark orange`, `dark grey`. * To clear, set the color `name` to an empty string. |
colorFields[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input color Fields item |
datePickerFields | array | Optional | Add or clear a date picker field: * To add, specify the date in `d/mmm/yy` format or ISO format `dd-mm-yyyy`. * To clear, set `formattedDate` to an empty string. |
datePickerFields[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input date Picker Fields item |
dateTimePickerFields | array | Optional | Add or clear the planned start date and time: * To add, specify the date and time in ISO format for `formattedDateTime`. * To clear, provide an empty string for `formattedDateTime`. |
dateTimePickerFields[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input date Time Picker Fields item |
issueType | Model | Optional | Expand Bulk edit issues — request body — body edited Fields Input issue Type Set the issue type field by providing an `issueTypeId`. |
labelsFields | array | Optional | Edit a labels field: * Options include `ADD`, `REPLACE`, `REMOVE`, or `REMOVE_ALL` for bulk edits. * To clear labels, use the `REMOVE_ALL` option with an empty `labels` array. |
labelsFields[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input labels Fields item |
multipleGroupPickerFields | array | Optional | Add or clear a multi-group picker field: * To add groups, provide an array of groups with `groupName`s. * To clear all groups, use an empty `groups` array. |
multipleGroupPickerFields[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input multiple Group Picker Fields item |
multipleSelectClearableUserPickerFields | array | Optional | Assign or unassign multiple users to/from a field: * To assign, provide an array of user `accountId`s. * To clear, set `users` to `null`. |
multipleSelectClearableUserPickerFields[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input multiple Select Clearable User Picker Fields item |
multipleSelectFields | array | Optional | Add or clear a multi-select field: * To add, provide an array of options with `optionId`s. * To clear, use an empty `options` array. |
multipleSelectFields[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input multiple Select Fields item |
multipleVersionPickerFields | array | Optional | Edit a multi-version picker field like Fix Versions/Affects Versions: * Options include `ADD`, `REPLACE`, `REMOVE`, or `REMOVE_ALL` for bulk edits. * To clear the field, use the `REMOVE_ALL` option with an empty `versions` array. |
multipleVersionPickerFields[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input multiple Version Picker Fields item |
multiselectComponents | Model | Optional | Expand Bulk edit issues — request body — body edited Fields Input multiselect Components Edit a multi select components field: * Options include `ADD`, `REPLACE`, `REMOVE`, or `REMOVE_ALL` for bulk edits. * To clear, use the `REMOVE_ALL` option with an empty `components` array. |
originalEstimateField | Model | Optional | Expand Bulk edit issues — request body — body edited Fields Input original Estimate Field Edit the original estimate field. |
priority | Model | Optional | Expand Bulk edit issues — request body — body edited Fields Input priority Set the priority of an issue by specifying a `priorityId`. |
richTextFields | array | Optional | Add or clear a rich text field: * To add, provide `adfValue`. Note that rich text fields only support ADF values. * To clear, use an empty `richText` object. For ADF format details, refer to: [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure). |
richTextFields[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input rich Text Fields item |
singleGroupPickerFields | array | Optional | Add or clear a single group picker field: * To add, specify the group with `groupName`. * To clear, set `groupName` to an empty string. |
singleGroupPickerFields[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input single Group Picker Fields item |
singleLineTextFields | array | Optional | Add or clear a single line text field: * To add, provide the `text` value. * To clear, set `text` to an empty string. |
singleLineTextFields[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input single Line Text Fields item |
singleSelectClearableUserPickerFields | array | Optional | Edit assignment for single select user picker fields like Assignee/Reporter: * To assign an issue, specify the user's `accountId`. * To unassign an issue, set `user` to `null`. * For automatic assignment, set `accountId` to `-1`. |
singleSelectClearableUserPickerFields[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input single Select Clearable User Picker Fields item |
singleSelectFields | array | Optional | Add or clear a single select field: * To add, specify the option with an `optionId`. * To clear, pass an option with `optionId` as `-1`. |
singleSelectFields[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input single Select Fields item |
singleVersionPickerFields | array | Optional | Add or clear a single version picker field: * To add, specify the version with a `versionId`. * To clear, set `versionId` to `-1`. |
singleVersionPickerFields[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input single Version Picker Fields item |
status | Model | Optional | Expand Bulk edit issues — request body — body edited Fields Input status |
timeTrackingField | Model | Optional | Expand Bulk edit issues — request body — body edited Fields Input time Tracking Field Edit the time tracking field. |
urlFields | array | Optional | Add or clear a URL field: * To add, provide the `url` with the desired URL value. * To clear, set `url` to an empty string. |
urlFields[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input url Fields item |
Referenced models: Bulk edit issues — request body — body edited Fields Input cascading Select Fields item, Bulk edit issues — request body — body edited Fields Input color Fields item, Bulk edit issues — request body — body edited Fields Input date Picker Fields item, Bulk edit issues — request body — body edited Fields Input date Time Picker Fields item, Bulk edit issues — request body — body edited Fields Input original Estimate Field, Bulk edit issues — request body — body edited Fields Input issue Type, Bulk edit issues — request body — body edited Fields Input labels Fields item, Bulk edit issues — request body — body edited Fields Input multiselect Components, Bulk edit issues — request body — body edited Fields Input multiple Group Picker Fields item, Bulk edit issues — request body — body edited Fields Input multiple Select Fields item, Bulk edit issues — request body — body edited Fields Input multiple Select Clearable User Picker Fields item, Bulk edit issues — request body — body edited Fields Input multiple Version Picker Fields item, Bulk edit issues — request body — body edited Fields Input clearable Number Fields item, Bulk edit issues — request body — body edited Fields Input priority, Bulk edit issues — request body — body edited Fields Input rich Text Fields item, Bulk edit issues — request body — body edited Fields Input single Group Picker Fields item, Bulk edit issues — request body — body edited Fields Input single Line Text Fields item, Bulk edit issues — request body — body edited Fields Input single Select Fields item, Bulk edit issues — request body — body edited Fields Input single Select Clearable User Picker Fields item, Bulk edit issues — request body — body edited Fields Input single Version Picker Fields item, Bulk edit issues — request body — body edited Fields Input status, Bulk edit issues — request body — body edited Fields Input time Tracking Field, Bulk edit issues — request body — body edited Fields Input url Fields item
Bulk edit issues — request body — body edited Fields Input cascading Select Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
childOptionValue | Model | Optional | Expand Bulk edit issues — request body — body edited Fields Input single Select Fields item option |
fieldId | string | Required within parent | |
parentOptionValue | Model | Required within parent | Expand Bulk edit issues — request body — body edited Fields Input single Select Fields item option |
Referenced models: Bulk edit issues — request body — body edited Fields Input single Select Fields item option
Bulk edit issues — request body — body edited Fields Input clearable Number Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
fieldId | string | Required within parent | |
value | number | Optional | Format: double |
Bulk edit issues — request body — body edited Fields Input color Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
color | Model | Required within parent | Expand Bulk edit issues — request body — body edited Fields Input color Fields item color |
fieldId | string | Required within parent |
Referenced models: Bulk edit issues — request body — body edited Fields Input color Fields item color
Bulk edit issues — request body — body edited Fields Input color Fields item color
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
name | string | Required within parent |
Bulk edit issues — request body — body edited Fields Input date Picker Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
date | Model | Optional | Expand Bulk edit issues — request body — body edited Fields Input date Picker Fields item date |
fieldId | string | Required within parent |
Referenced models: Bulk edit issues — request body — body edited Fields Input date Picker Fields item date
Bulk edit issues — request body — body edited Fields Input date Picker Fields item date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
formattedDate | string | Required within parent |
Bulk edit issues — request body — body edited Fields Input date Time Picker Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
dateTime | Model | Required within parent | Expand Bulk edit issues — request body — body edited Fields Input date Time Picker Fields item date Time |
fieldId | string | Required within parent |
Referenced models: Bulk edit issues — request body — body edited Fields Input date Time Picker Fields item date Time
Bulk edit issues — request body — body edited Fields Input date Time Picker Fields item date Time
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
formattedDateTime | string | Required within parent |
Bulk edit issues — request body — body edited Fields Input issue Type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
issueTypeId | string | Required within parent |
Bulk edit issues — request body — body edited Fields Input labels Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
bulkEditMultiSelectFieldOption | string | Required within parent | One of: ADD, REMOVE, REPLACE, REMOVE_ALL |
fieldId | string | Required within parent | |
labelProperties | array | Optional | |
labelProperties[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input labels Fields item label Properties item |
labels | array | Required within parent | |
labels[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input color Fields item color |
Referenced models: Bulk edit issues — request body — body edited Fields Input color Fields item color, Bulk edit issues — request body — body edited Fields Input labels Fields item label Properties item
Bulk edit issues — request body — body edited Fields Input labels Fields item label Properties item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
color | string | Optional | One of: GREY_LIGHTEST, GREY_LIGHTER, GREY, GREY_DARKER, GREY_DARKEST, PURPLE_LIGHTEST, PURPLE_LIGHTER, PURPLE, PURPLE_DARKER, PURPLE_DARKEST, BLUE_LIGHTEST, BLUE_LIGHTER, BLUE, BLUE_DARKER, BLUE_DARKEST, TEAL_LIGHTEST, TEAL_LIGHTER, TEAL, TEAL_DARKER, TEAL_DARKEST, GREEN_LIGHTEST, GREEN_LIGHTER, GREEN, GREEN_DARKER, GREEN_DARKEST, LIME_LIGHTEST, LIME_LIGHTER, LIME, LIME_DARKER, LIME_DARKEST, YELLOW_LIGHTEST, YELLOW_LIGHTER, YELLOW, YELLOW_DARKER, YELLOW_DARKEST, ORANGE_LIGHTEST, ORANGE_LIGHTER, ORANGE, ORANGE_DARKER, ORANGE_DARKEST, RED_LIGHTEST, RED_LIGHTER, RED, RED_DARKER, RED_DARKEST, MAGENTA_LIGHTEST, MAGENTA_LIGHTER, MAGENTA, MAGENTA_DARKER, MAGENTA_DARKEST |
name | string | Optional |
Bulk edit issues — request body — body edited Fields Input multiple Group Picker Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
fieldId | string | Required within parent | |
groups | array | Required within parent | |
groups[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input single Group Picker Fields item group |
Referenced models: Bulk edit issues — request body — body edited Fields Input single Group Picker Fields item group
Bulk edit issues — request body — body edited Fields Input multiple Select Clearable User Picker Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
fieldId | string | Required within parent | |
users | array | Optional | |
users[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input single Select Clearable User Picker Fields item user |
Referenced models: Bulk edit issues — request body — body edited Fields Input single Select Clearable User Picker Fields item user
Bulk edit issues — request body — body edited Fields Input multiple Select Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
fieldId | string | Required within parent | |
options | array | Required within parent | |
options[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input single Select Fields item option |
Referenced models: Bulk edit issues — request body — body edited Fields Input single Select Fields item option
Bulk edit issues — request body — body edited Fields Input multiple Version Picker Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
bulkEditMultiSelectFieldOption | string | Required within parent | One of: ADD, REMOVE, REPLACE, REMOVE_ALL |
fieldId | string | Required within parent | |
versions | array | Required within parent | |
versions[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input single Version Picker Fields item version |
Referenced models: Bulk edit issues — request body — body edited Fields Input single Version Picker Fields item version
Bulk edit issues — request body — body edited Fields Input multiselect Components
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
bulkEditMultiSelectFieldOption | string | Required within parent | One of: ADD, REMOVE, REPLACE, REMOVE_ALL |
components | array | Required within parent | |
components[] | Model | Each item | Expand Bulk edit issues — request body — body edited Fields Input multiselect Components components item |
fieldId | string | Required within parent |
Referenced models: Bulk edit issues — request body — body edited Fields Input multiselect Components components item
Bulk edit issues — request body — body edited Fields Input multiselect Components components item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
componentId | integer | Required within parent | Format: int64 |
Bulk edit issues — request body — body edited Fields Input original Estimate Field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
originalEstimateField | string | Required within parent |
Bulk edit issues — request body — body edited Fields Input priority
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
priorityId | string | Required within parent |
Bulk edit issues — request body — body edited Fields Input rich Text Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
fieldId | string | Required within parent | |
richText | Model | Required within parent | Expand Bulk edit issues — request body — body edited Fields Input rich Text Fields item rich Text |
Referenced models: Bulk edit issues — request body — body edited Fields Input rich Text Fields item rich Text
Bulk edit issues — request body — body edited Fields Input rich Text Fields item rich Text
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
adfValue | object | Optional | Additional keys: see wildcard field |
adfValue.* | JSON | Additional keys |
Bulk edit issues — request body — body edited Fields Input single Group Picker Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
fieldId | string | Required within parent | |
group | Model | Required within parent | Expand Bulk edit issues — request body — body edited Fields Input single Group Picker Fields item group |
Referenced models: Bulk edit issues — request body — body edited Fields Input single Group Picker Fields item group
Bulk edit issues — request body — body edited Fields Input single Group Picker Fields item group
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
groupName | string | Required within parent |
Bulk edit issues — request body — body edited Fields Input single Line Text Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
fieldId | string | Required within parent | |
text | string | Required within parent |
Bulk edit issues — request body — body edited Fields Input single Select Clearable User Picker Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
fieldId | string | Required within parent | |
user | Model | Optional | Expand Bulk edit issues — request body — body edited Fields Input single Select Clearable User Picker Fields item user |
Referenced models: Bulk edit issues — request body — body edited Fields Input single Select Clearable User Picker Fields item user
Bulk edit issues — request body — body edited Fields Input single Select Clearable User Picker Fields item user
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
accountId | string | Required within parent |
Bulk edit issues — request body — body edited Fields Input single Select Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Add or clear a single select field: * To add, specify the option with an `optionId`. * To clear, pass an option with `optionId` as `-1`. Additional keys: not allowed |
fieldId | string | Required within parent | |
option | Model | Required within parent | Expand Bulk edit issues — request body — body edited Fields Input single Select Fields item option |
Referenced models: Bulk edit issues — request body — body edited Fields Input single Select Fields item option
Bulk edit issues — request body — body edited Fields Input single Select Fields item option
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
optionId | integer | Optional | Format: int64 |
Bulk edit issues — request body — body edited Fields Input single Version Picker Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
fieldId | string | Required within parent | |
version | Model | Required within parent | Expand Bulk edit issues — request body — body edited Fields Input single Version Picker Fields item version |
Referenced models: Bulk edit issues — request body — body edited Fields Input single Version Picker Fields item version
Bulk edit issues — request body — body edited Fields Input single Version Picker Fields item version
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
versionId | string | Optional |
Bulk edit issues — request body — body edited Fields Input status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
statusId | string | Required within parent |
Bulk edit issues — request body — body edited Fields Input time Tracking Field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
timeRemaining | string | Required within parent |
Bulk edit issues — request body — body edited Fields Input url Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
fieldId | string | Required within parent | |
url | string | Required within parent |
Bulk edit issues — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
taskId | JSON | Optional | |
taskId (anyOf 1) | string | Alternative | |
taskId (anyOf 2) | null | Alternative |
Bulk move issues — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue Bulk Move Payload Additional keys: not allowed |
sendBulkNotification | JSON | Optional | |
sendBulkNotification (anyOf 1) | boolean | Alternative | A boolean value that indicates whether to send a bulk change notification when the issues are being moved. If `true`, dispatches a bulk notification email to users about the updates. Default: true write Only: true |
sendBulkNotification (anyOf 2) | null | Alternative | |
targetToSourcesMapping | object | Required within parent | An object representing the mapping of issues and data related to destination entities, like fields and statuses, that are required during a bulk move. The key is a string that is created by concatenating the following three entities in order, separated by commas. The format is `<project ID or key>,<issueType ID>,<parent ID or key>`. It should be unique across mappings provided in the payload. If you provide multiple mappings for the same key, only one will be processed. However, the operation won't fail, so the error may be hard to track down. * ***Destination project*** (Required): ID or key of the project to which the issues are being moved. * ***Destination issueType*** (Required): ID of the issueType to which the issues are being moved. * ***Destination parent ID or key*** (Optional): ID or key of the issue which will become the parent of the issues being moved. Only required when the destination issueType is a subtask. Additional keys: see wildcard field |
targetToSourcesMapping.* | Model | Additional keys | Expand Bulk move issues — request body — body target To Sources Mapping value |
Referenced models: Bulk move issues — request body — body target To Sources Mapping value
Bulk move issues — request body — body / targetToSourcesMapping / value / targetMandatoryFields / array / item / Field mapping for mandatory fields in target / fields / value / type: adf, raw
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object notation input |
retain | JSON | Optional | |
retain (anyOf 1) | boolean | Alternative | If `true`, will try to retain original non-null issue field values on move. Default: true write Only: true |
retain (anyOf 2) | null | Alternative | |
type | string | Required within parent | Will treat as `MandatoryFieldValueForADF` if type is `adf` Default: raw One of: adf, raw write Only: true |
value | object | Required within parent | Value for each field. Accepts Atlassian Document Format (ADF) for rich text fields like `description`, `environments`. For ADF format details, refer to: [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure) write Only: true |
Bulk move issues — request body — body target To Sources Mapping value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object representing the mapping of issues and data related to destination entities, like fields and statuses, that are required during a bulk move. Additional keys: not allowed |
inferClassificationDefaults | boolean | Required within parent | If `true`, when issues are moved into this target group, they will adopt the target project's default classification, if they don't have a classification already. If they do have a classification, it will be kept the same even after the move. Leave `targetClassification` empty when using this. If `false`, you must provide a `targetClassification` mapping for each classification associated with the selected issues. [Benefit from data classification](https://support.atlassian.com/security-and-access-policies/docs/what-is-data-classification/) write Only: true |
inferFieldDefaults | boolean | Required within parent | If `true`, values from the source issues will be retained for the mandatory fields in the field configuration of the destination project. The `targetMandatoryFields` property shouldn't be defined. If `false`, the user is required to set values for mandatory fields present in the field configuration of the destination project. Provide input by defining the `targetMandatoryFields` property write Only: true |
inferStatusDefaults | boolean | Required within parent | If `true`, the statuses of issues being moved in this target group that are not present in the target workflow will be changed to the default status of the target workflow (see below). Leave `targetStatus` empty when using this. If `false`, you must provide a `targetStatus` for each status not present in the target workflow. The default status in a workflow is referred to as the "initial status". Each workflow has its own unique initial status. When an issue is created, it is automatically assigned to this initial status. Read more about configuring initial statuses: [Configure the initial status | Atlassian Support.](https://support.atlassian.com/jira-cloud-administration/docs/configure-the-initial-status/) write Only: true |
inferSubtaskTypeDefault | boolean | Required within parent | When an issue is moved, its subtasks (if there are any) need to be moved with it. `inferSubtaskTypeDefault` helps with moving the subtasks by picking a random subtask type in the target project. If `true`, subtasks will automatically move to the same project as their parent. When they move: * Their `issueType` will be set to the default for subtasks in the target project. * Values for mandatory fields will be retained from the source issues * Specifying separate mapping for implicit subtasks won’t be allowed. If `false`, you must manually move the subtasks. They will retain the parent which they had in the current project after being moved. write Only: true |
issueIdsOrKeys | array | Required within parent | List of issue IDs or keys to be moved. write Only: true |
issueIdsOrKeys[] | string | Each item | write Only: true |
targetClassification | JSON | Optional | |
targetClassification (anyOf 1) | array | Alternative | List of the objects containing classifications in the source issues and their new values which need to be set during the bulk move operation. It is mandatory to provide source classification to target classification mapping when the source classification is invalid for the target project and issue type. * **You should only define this property when `inferClassificationDefaults` is `false`.** * **In order to provide mapping for issues which don't have a classification, use `"-1"`.** write Only: true |
targetClassification (anyOf 1)[] | Model | Each item | Expand Bulk move issues — request body — body target To Sources Mapping value target Classification array item |
targetClassification (anyOf 2) | null | Alternative | |
targetMandatoryFields | JSON | Optional | |
targetMandatoryFields (anyOf 1) | array | Alternative | List of objects containing mandatory fields in the target field configuration and new values that need to be set during the bulk move operation. The new values will only be applied if the field is mandatory in the target project and at least one issue from the source has that field empty, or if the field context is different in the target project (e.g. project-scoped version fields). **You should only define this property when `inferFieldDefaults` is `false`.** write Only: true |
targetMandatoryFields (anyOf 1)[] | Model | Each item | Expand Bulk move issues — request body — body target To Sources Mapping value target Mandatory Fields array item |
targetMandatoryFields (anyOf 2) | null | Alternative | |
targetStatus | JSON | Optional | |
targetStatus (anyOf 1) | array | Alternative | List of the objects containing statuses in the source workflow and their new values which need to be set during the bulk move operation. The new values will only be applied if the source status is invalid for the target project and issue type. It is mandatory to provide source status to target status mapping when the source status is invalid for the target project and issue type. **You should only define this property when `inferStatusDefaults` is `false`.** write Only: true |
targetStatus (anyOf 1)[] | Model | Each item | Expand Bulk move issues — request body — body target To Sources Mapping value target Status array item |
targetStatus (anyOf 2) | null | Alternative |
Referenced models: Bulk move issues — request body — body target To Sources Mapping value target Classification array item, Bulk move issues — request body — body target To Sources Mapping value target Mandatory Fields array item, Bulk move issues — request body — body target To Sources Mapping value target Status array item
Bulk move issues — request body — body target To Sources Mapping value target Classification array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Classification mapping for classifications in source issues to respective target classification. write Only: true Additional keys: not allowed |
$ (anyOf 1).classifications | object | Required within parent | An object with the key as the ID of the target classification and value with the list of the IDs of the current source classifications. write Only: true Additional keys: see wildcard field |
$ (anyOf 1).classifications.* | array | Additional keys | write Only: true |
$ (anyOf 1).classifications.*[] | string | Each item | write Only: true |
$ (anyOf 1).issueType | string | Optional | ID of the source issueType to which issues present in `issueIdOrKeys` belongs. write Only: true |
$ (anyOf 1).projectKeyOrId | string | Optional | ID or key of the source project to which issues present in `issueIdOrKeys` belongs. write Only: true |
$ (anyOf 2) | null | Alternative |
Bulk move issues — request body — body target To Sources Mapping value target Mandatory Fields array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Field mapping for mandatory fields in target write Only: true Additional keys: not allowed |
$ (anyOf 1).fields | object | Required within parent | Contains the value of mandatory fields write Only: true Additional keys: see wildcard field |
$ (anyOf 1).fields.* | Model | Additional keys | Expand Bulk move issues — request body — body target To Sources Mapping value target Mandatory Fields array item Field mapping for mandatory fields in target fields value |
$ (anyOf 2) | null | Alternative |
Referenced models: Bulk move issues — request body — body target To Sources Mapping value target Mandatory Fields array item Field mapping for mandatory fields in target fields value
Bulk move issues — request body — body target To Sources Mapping value target Mandatory Fields array item Field mapping for mandatory fields in target fields value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Can contain multiple field values of following types depending on `type` key discriminator: {"mapping": {"mandatoryField": "#/components/schemas/MandatoryFieldValue", "mandatoryFieldForADF": "#/components/schemas/MandatoryFieldValueForADF"}, "propertyName": "type"} write Only: true Additional keys: not allowed |
retain | JSON | Optional | |
retain (anyOf 1) | boolean | Alternative | If `true`, will try to retain original non-null issue field values on move. Default: true write Only: true |
retain (anyOf 2) | null | Alternative | |
type | string | Optional | One of: adf, raw |
value | object | Optional | |
$ (anyOf 1) | Model | Alternative | Expand Bulk move issues — request body — body target To Sources Mapping value target Mandatory Fields array item Field mapping for mandatory fields in target fields value List of string of inputs |
$ (anyOf 2) | Model | Alternative | Expand Bulk move issues — request body — body / targetToSourcesMapping / value / targetMandatoryFields / array / item / Field mapping for mandatory fields in target / fields / value / type: adf, raw |
Referenced models: Bulk move issues — request body — body target To Sources Mapping value target Mandatory Fields array item Field mapping for mandatory fields in target fields value List of string of inputs, Bulk move issues — request body — body / targetToSourcesMapping / value / targetMandatoryFields / array / item / Field mapping for mandatory fields in target / fields / value / type: adf, raw
Bulk move issues — request body — body target To Sources Mapping value target Mandatory Fields array item Field mapping for mandatory fields in target fields value List of string of inputs
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List of string of inputs |
retain | JSON | Optional | |
retain (anyOf 1) | boolean | Alternative | If `true`, will try to retain original non-null issue field values on move. Default: true write Only: true |
retain (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | Will treat as `MandatoryFieldValue` if type is `raw` or `empty` Default: raw One of: adf, raw write Only: true |
type (anyOf 2) | null | Alternative | |
value | array | Required within parent | Value for each field. Provide a `list of strings` for non-ADF fields. write Only: true |
value[] | string | Each item | Value for each field. Provide a <code>list of strings</code> for non-ADF fields. write Only: true |
Bulk move issues — request body — body target To Sources Mapping value target Status array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Status mapping for statuses in source workflow to respective target status in target workflow. write Only: true Additional keys: not allowed |
$ (anyOf 1).statuses | object | Required within parent | An object with the key as the ID of the target status and value with the list of the IDs of the current source statuses. write Only: true Additional keys: see wildcard field |
$ (anyOf 1).statuses.* | array | Additional keys | write Only: true |
$ (anyOf 1).statuses.*[] | string | Each item | write Only: true |
$ (anyOf 2) | null | Alternative |
Bulk transition issue statuses — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue Bulk Transition Payload Additional keys: not allowed |
bulkTransitionInputs | array | Required within parent | List of objects and each object has two properties: * Issues that will be bulk transitioned. * TransitionId that corresponds to a specific transition of issues that share the same workflow. write Only: true |
bulkTransitionInputs[] | Model | Each item | Expand Bulk transition issue statuses — request body — body bulk Transition Inputs item |
sendBulkNotification | JSON | Optional | |
sendBulkNotification (anyOf 1) | boolean | Alternative | A boolean value that indicates whether to send a bulk change notification when the issues are being transitioned. If `true`, dispatches a bulk notification email to users about the updates. Default: true write Only: true |
sendBulkNotification (anyOf 2) | null | Alternative |
Referenced models: Bulk transition issue statuses — request body — body bulk Transition Inputs item
Bulk transition issue statuses — request body — body bulk Transition Inputs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | write Only: true Additional keys: not allowed |
selectedIssueIdsOrKeys | array | Required within parent | List of all the issue IDs or keys that are to be bulk transitioned. write Only: true |
selectedIssueIdsOrKeys[] | string | Each item | write Only: true |
transitionId | string | Required within parent | The ID of the transition that is to be performed on the issues. write Only: true |
Bulk watch issues — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue Bulk Watch Or Unwatch Payload Additional keys: not allowed |
selectedIssueIdsOrKeys | array | Required within parent | List of issue IDs or keys which are to be bulk watched or unwatched. These IDs or keys can be from different projects and issue types. write Only: true |
selectedIssueIdsOrKeys[] | string | Each item | write Only: true |
Get available transitions — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Bulk Transition Get Available Transitions Response. |
availableTransitions | JSON | Optional | |
availableTransitions (anyOf 1) | array | Alternative | List of available transitions for bulk transition operation for requested issues grouped by workflow Read only: true |
availableTransitions (anyOf 1)[] | Model | Each item | Expand Get available transitions — response body — available Transitions array item |
availableTransitions (anyOf 2) | null | Alternative | |
endingBefore | JSON | Optional | |
endingBefore (anyOf 1) | string | Alternative | The end cursor for use in pagination. Read only: true |
endingBefore (anyOf 2) | null | Alternative | |
startingAfter | JSON | Optional | |
startingAfter (anyOf 1) | string | Alternative | The start cursor for use in pagination. Read only: true |
startingAfter (anyOf 2) | null | Alternative |
Referenced models: Get available transitions — response body — available Transitions array item
Get available transitions — response body — available Transitions array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
isTransitionsFiltered | JSON | Optional | |
isTransitionsFiltered (anyOf 1) | boolean | Alternative | Indicates whether all the transitions of this workflow are available in the transitions list or not. Read only: true |
isTransitionsFiltered (anyOf 2) | null | Alternative | |
issues | JSON | Optional | |
issues (anyOf 1) | array | Alternative | List of issue keys from the request which are associated with this workflow. Read only: true |
issues (anyOf 1)[] | string | Each item | Read only: true |
issues (anyOf 2) | null | Alternative | |
transitions | JSON | Optional | |
transitions (anyOf 1) | array | Alternative | List of transitions available for issues from the request which are associated with this workflow. **This list includes only those transitions that are common across the issues in this workflow and do not involve any additional field updates.** Read only: true |
transitions (anyOf 1)[] | Model | Each item | Expand Get available transitions — response body — available Transitions array item transitions array item |
transitions (anyOf 2) | null | Alternative |
Referenced models: Get available transitions — response body — available Transitions array item transitions array item
Get available transitions — response body — available Transitions array item transitions array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
to | JSON | Optional | |
to (anyOf 1) | Model | Alternative | Expand Get available transitions — response body — available Transitions array item transitions array item to status Id, status Name The issue status change of the transition. Read only: true |
to (anyOf 2) | null | Alternative | |
transitionId | JSON | Optional | |
transitionId (anyOf 1) | JSON | Alternative | |
transitionId (anyOf 1) (anyOf 1) | integer | Alternative | The unique ID of the transition. Format: int32 Read only: true |
transitionId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
transitionId (anyOf 2) | null | Alternative | |
transitionName | JSON | Optional | |
transitionName (anyOf 1) | string | Alternative | The name of the transition. Read only: true |
transitionName (anyOf 2) | null | Alternative |
Referenced models: Get available transitions — response body — available Transitions array item transitions array item to status Id, status Name
Get available transitions — response body — available Transitions array item transitions array item to status Id, status Name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
statusId | JSON | Optional | |
statusId (anyOf 1) | JSON | Alternative | |
statusId (anyOf 1) (anyOf 1) | integer | Alternative | The unique ID of the status. Format: int32 Read only: true |
statusId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
statusId (anyOf 2) | null | Alternative | |
statusName | JSON | Optional | |
statusName (anyOf 1) | string | Alternative | The name of the status. Read only: true |
statusName (anyOf 2) | null | Alternative |
Get bulk editable fields — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Bulk Edit Get Fields Response. |
endingBefore | JSON | Optional | |
endingBefore (anyOf 1) | string | Alternative | The end cursor for use in pagination. Read only: true |
endingBefore (anyOf 2) | null | Alternative | |
fields | JSON | Optional | |
fields (anyOf 1) | array | Alternative | List of all the fields Read only: true |
fields (anyOf 1)[] | Model | Each item | Expand Get bulk editable fields — response body — fields List of all the fields item |
fields (anyOf 2) | null | Alternative | |
startingAfter | JSON | Optional | |
startingAfter (anyOf 1) | string | Alternative | The start cursor for use in pagination. Read only: true |
startingAfter (anyOf 2) | null | Alternative |
Referenced models: Get bulk editable fields — response body — fields List of all the fields item
Get bulk editable fields — response body — fields List of all the fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the field. |
description (anyOf 2) | null | Alternative | |
fieldOptions | JSON | Optional | |
fieldOptions (anyOf 1) | array | Alternative | A list of options related to the field, applicable in contexts where multiple selections are allowed. |
fieldOptions (anyOf 1)[] | Model | Each item | Expand Get user — response body — groups callback, items, max-results, paging Callback, size callback object |
fieldOptions (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The unique ID of the field. |
id (anyOf 2) | null | Alternative | |
isRequired | JSON | Optional | |
isRequired (anyOf 1) | boolean | Alternative | Indicates whether the field is mandatory for the operation. |
isRequired (anyOf 2) | null | Alternative | |
multiSelectFieldOptions | JSON | Optional | |
multiSelectFieldOptions (anyOf 1) | array | Alternative | Specifies supported actions (like add, replace, remove) on multi-select fields via an enum. |
multiSelectFieldOptions (anyOf 1)[] | string | Each item | Known values: ADD, REMOVE, REPLACE, REMOVE_ALL |
multiSelectFieldOptions (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The display name of the field. |
name (anyOf 2) | null | Alternative | |
searchUrl | JSON | Optional | |
searchUrl (anyOf 1) | string | Alternative | A URL to fetch additional data for the field |
searchUrl (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The type of the field. |
type (anyOf 2) | null | Alternative | |
unavailableMessage | JSON | Optional | |
unavailableMessage (anyOf 1) | string | Alternative | A message indicating why the field is unavailable for editing. |
unavailableMessage (anyOf 2) | null | Alternative |
Referenced models: Get user — response body — groups callback, items, max-results, paging Callback, size callback object
Get bulk issue operation progress — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created | JSON | Optional | |
created (anyOf 1) | JSON | Alternative | |
created (anyOf 1) (anyOf 1) | string | Alternative | A timestamp of when the task was submitted. |
created (anyOf 1) (anyOf 2) | integer | Alternative | |
created (anyOf 2) | null | Alternative | |
failedAccessibleIssues | JSON | Optional | |
failedAccessibleIssues (anyOf 1) | object | Alternative | Map of issue IDs for which the operation failed and that the user has permission to view, to their one or more reasons for failure. These reasons are open-ended text descriptions of the error and are not selected from a predefined list of standard reasons. Additional keys: see wildcard field |
failedAccessibleIssues (anyOf 1).* | array | Additional keys | |
failedAccessibleIssues (anyOf 1).*[] | string | Each item | |
failedAccessibleIssues (anyOf 2) | null | Alternative | |
invalidOrInaccessibleIssueCount | JSON | Optional | |
invalidOrInaccessibleIssueCount (anyOf 1) | JSON | Alternative | |
invalidOrInaccessibleIssueCount (anyOf 1) (anyOf 1) | integer | Alternative | The number of issues that are either invalid or issues that the user doesn't have permission to view, regardless of the success or failure of the operation. Format: int32 |
invalidOrInaccessibleIssueCount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
invalidOrInaccessibleIssueCount (anyOf 2) | null | Alternative | |
processedAccessibleIssues | JSON | Optional | |
processedAccessibleIssues (anyOf 1) | array | Alternative | List of issue IDs for which the operation was successful and that the user has permission to view. |
processedAccessibleIssues (anyOf 1)[] | JSON | Each item | |
processedAccessibleIssues (anyOf 1)[] (anyOf 1) | integer | Alternative | Format: int64 |
processedAccessibleIssues (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
processedAccessibleIssues (anyOf 2) | null | Alternative | |
progressPercent | JSON | Optional | |
progressPercent (anyOf 1) | JSON | Alternative | |
progressPercent (anyOf 1) (anyOf 1) | integer | Alternative | Progress of the task as a percentage. Format: int64 |
progressPercent (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
progressPercent (anyOf 2) | null | Alternative | |
started | JSON | Optional | |
started (anyOf 1) | JSON | Alternative | |
started (anyOf 1) (anyOf 1) | string | Alternative | A timestamp of when the task was started. |
started (anyOf 1) (anyOf 2) | integer | Alternative | |
started (anyOf 2) | null | Alternative | |
status | JSON | Optional | |
status (anyOf 1) | string | Alternative | The status of the task. Known values: ENQUEUED, RUNNING, COMPLETE, FAILED, CANCEL_REQUESTED, CANCELLED, DEAD |
status (anyOf 2) | null | Alternative | |
submittedBy | JSON | Optional | |
submittedBy (anyOf 1) | Model | Alternative | Expand Get user — response body |
submittedBy (anyOf 2) | null | Alternative | |
taskId | JSON | Optional | |
taskId (anyOf 1) | string | Alternative | The ID of the task. Read only: true |
taskId (anyOf 2) | null | Alternative | |
totalIssueCount | JSON | Optional | |
totalIssueCount (anyOf 1) | JSON | Alternative | |
totalIssueCount (anyOf 1) (anyOf 1) | integer | Alternative | The number of issues that the bulk operation was attempted on. Format: int32 |
totalIssueCount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
totalIssueCount (anyOf 2) | null | Alternative | |
updated | JSON | Optional | |
updated (anyOf 1) | JSON | Alternative | |
updated (anyOf 1) (anyOf 1) | string | Alternative | A timestamp of when the task progress was last updated. |
updated (anyOf 1) (anyOf 2) | integer | Alternative | |
updated (anyOf 2) | null | Alternative |
Referenced models: Get user — response body