Skip to content

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

FieldTypePresenceDescription and constraints
$objectRootIssue Bulk Delete Payload
Additional keys: not allowed
selectedIssueIdsOrKeysarrayRequired within parentList 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[]stringEach itemwrite Only: true
sendBulkNotificationJSONOptional
sendBulkNotification (anyOf 1)booleanAlternativeA 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)nullAlternative

Bulk edit issues — request body — body

FieldTypePresenceDescription and constraints
$objectRootIssue Bulk Edit Payload
Additional keys: not allowed
editedFieldsInputModelRequired within parentExpand 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.
selectedActionsarrayRequired within parentList 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[]stringEach itemwrite Only: true
selectedIssueIdsOrKeysarrayRequired within parentList 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[]stringEach itemwrite Only: true
sendBulkNotificationJSONOptional
sendBulkNotification (anyOf 1)booleanAlternativeA 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)nullAlternative

Referenced models: Bulk edit issues — request body — body edited Fields Input

Bulk edit issues — request body — body edited Fields Input

FieldTypePresenceDescription and constraints
$objectRootwrite Only: true
Additional keys: not allowed
cascadingSelectFieldsarrayOptionalAdd 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[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input cascading Select Fields item
clearableNumberFieldsarrayOptionalAdd or clear a number field:

* To add, specify a numeric `value`.
* To clear, set `value` to `null`.
clearableNumberFields[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input clearable Number Fields item
colorFieldsarrayOptionalAdd 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[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input color Fields item
datePickerFieldsarrayOptionalAdd 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[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input date Picker Fields item
dateTimePickerFieldsarrayOptionalAdd 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[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input date Time Picker Fields item
issueTypeModelOptionalExpand Bulk edit issues — request body — body edited Fields Input issue Type
Set the issue type field by providing an `issueTypeId`.
labelsFieldsarrayOptionalEdit 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[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input labels Fields item
multipleGroupPickerFieldsarrayOptionalAdd 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[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input multiple Group Picker Fields item
multipleSelectClearableUserPickerFieldsarrayOptionalAssign or unassign multiple users to/from a field:

* To assign, provide an array of user `accountId`s.
* To clear, set `users` to `null`.
multipleSelectClearableUserPickerFields[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input multiple Select Clearable User Picker Fields item
multipleSelectFieldsarrayOptionalAdd or clear a multi-select field:

* To add, provide an array of options with `optionId`s.
* To clear, use an empty `options` array.
multipleSelectFields[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input multiple Select Fields item
multipleVersionPickerFieldsarrayOptionalEdit 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[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input multiple Version Picker Fields item
multiselectComponentsModelOptionalExpand 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.
originalEstimateFieldModelOptionalExpand Bulk edit issues — request body — body edited Fields Input original Estimate Field
Edit the original estimate field.
priorityModelOptionalExpand Bulk edit issues — request body — body edited Fields Input priority
Set the priority of an issue by specifying a `priorityId`.
richTextFieldsarrayOptionalAdd 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[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input rich Text Fields item
singleGroupPickerFieldsarrayOptionalAdd or clear a single group picker field:

* To add, specify the group with `groupName`.
* To clear, set `groupName` to an empty string.
singleGroupPickerFields[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input single Group Picker Fields item
singleLineTextFieldsarrayOptionalAdd or clear a single line text field:

* To add, provide the `text` value.
* To clear, set `text` to an empty string.
singleLineTextFields[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input single Line Text Fields item
singleSelectClearableUserPickerFieldsarrayOptionalEdit 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[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input single Select Clearable User Picker Fields item
singleSelectFieldsarrayOptionalAdd or clear a single select field:

* To add, specify the option with an `optionId`.
* To clear, pass an option with `optionId` as `-1`.
singleSelectFields[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input single Select Fields item
singleVersionPickerFieldsarrayOptionalAdd or clear a single version picker field:

* To add, specify the version with a `versionId`.
* To clear, set `versionId` to `-1`.
singleVersionPickerFields[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input single Version Picker Fields item
statusModelOptionalExpand Bulk edit issues — request body — body edited Fields Input status
timeTrackingFieldModelOptionalExpand Bulk edit issues — request body — body edited Fields Input time Tracking Field
Edit the time tracking field.
urlFieldsarrayOptionalAdd or clear a URL field:

* To add, provide the `url` with the desired URL value.
* To clear, set `url` to an empty string.
urlFields[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
childOptionValueModelOptionalExpand Bulk edit issues — request body — body edited Fields Input single Select Fields item option
fieldIdstringRequired within parent
parentOptionValueModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
fieldIdstringRequired within parent
valuenumberOptionalFormat: double

Bulk edit issues — request body — body edited Fields Input color Fields item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
colorModelRequired within parentExpand Bulk edit issues — request body — body edited Fields Input color Fields item color
fieldIdstringRequired 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
namestringRequired within parent

Bulk edit issues — request body — body edited Fields Input date Picker Fields item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
dateModelOptionalExpand Bulk edit issues — request body — body edited Fields Input date Picker Fields item date
fieldIdstringRequired 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
formattedDatestringRequired within parent

Bulk edit issues — request body — body edited Fields Input date Time Picker Fields item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
dateTimeModelRequired within parentExpand Bulk edit issues — request body — body edited Fields Input date Time Picker Fields item date Time
fieldIdstringRequired 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
formattedDateTimestringRequired within parent

Bulk edit issues — request body — body edited Fields Input issue Type

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
issueTypeIdstringRequired within parent

Bulk edit issues — request body — body edited Fields Input labels Fields item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bulkEditMultiSelectFieldOptionstringRequired within parentOne of: ADD, REMOVE, REPLACE, REMOVE_ALL
fieldIdstringRequired within parent
labelPropertiesarrayOptional
labelProperties[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input labels Fields item label Properties item
labelsarrayRequired within parent
labels[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
colorstringOptionalOne 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
namestringOptional

Bulk edit issues — request body — body edited Fields Input multiple Group Picker Fields item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
fieldIdstringRequired within parent
groupsarrayRequired within parent
groups[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
fieldIdstringRequired within parent
usersarrayOptional
users[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
fieldIdstringRequired within parent
optionsarrayRequired within parent
options[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bulkEditMultiSelectFieldOptionstringRequired within parentOne of: ADD, REMOVE, REPLACE, REMOVE_ALL
fieldIdstringRequired within parent
versionsarrayRequired within parent
versions[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bulkEditMultiSelectFieldOptionstringRequired within parentOne of: ADD, REMOVE, REPLACE, REMOVE_ALL
componentsarrayRequired within parent
components[]ModelEach itemExpand Bulk edit issues — request body — body edited Fields Input multiselect Components components item
fieldIdstringRequired 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
componentIdintegerRequired within parentFormat: int64

Bulk edit issues — request body — body edited Fields Input original Estimate Field

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
originalEstimateFieldstringRequired within parent

Bulk edit issues — request body — body edited Fields Input priority

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
priorityIdstringRequired within parent

Bulk edit issues — request body — body edited Fields Input rich Text Fields item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
fieldIdstringRequired within parent
richTextModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
adfValueobjectOptionalAdditional keys: see wildcard field
adfValue.*JSONAdditional keys

Bulk edit issues — request body — body edited Fields Input single Group Picker Fields item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
fieldIdstringRequired within parent
groupModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
groupNamestringRequired within parent

Bulk edit issues — request body — body edited Fields Input single Line Text Fields item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
fieldIdstringRequired within parent
textstringRequired within parent

Bulk edit issues — request body — body edited Fields Input single Select Clearable User Picker Fields item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
fieldIdstringRequired within parent
userModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
accountIdstringRequired within parent

Bulk edit issues — request body — body edited Fields Input single Select Fields item

FieldTypePresenceDescription and constraints
$objectRootAdd 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
fieldIdstringRequired within parent
optionModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
optionIdintegerOptionalFormat: int64

Bulk edit issues — request body — body edited Fields Input single Version Picker Fields item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
fieldIdstringRequired within parent
versionModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
versionIdstringOptional

Bulk edit issues — request body — body edited Fields Input status

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
statusIdstringRequired within parent

Bulk edit issues — request body — body edited Fields Input time Tracking Field

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
timeRemainingstringRequired within parent

Bulk edit issues — request body — body edited Fields Input url Fields item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
fieldIdstringRequired within parent
urlstringRequired within parent

Bulk edit issues — response body

FieldTypePresenceDescription and constraints
$objectRoot
taskIdJSONOptional
taskId (anyOf 1)stringAlternative
taskId (anyOf 2)nullAlternative

Bulk move issues — request body — body

FieldTypePresenceDescription and constraints
$objectRootIssue Bulk Move Payload
Additional keys: not allowed
sendBulkNotificationJSONOptional
sendBulkNotification (anyOf 1)booleanAlternativeA 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)nullAlternative
targetToSourcesMappingobjectRequired within parentAn 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.*ModelAdditional keysExpand 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

FieldTypePresenceDescription and constraints
$objectRootAn object notation input
retainJSONOptional
retain (anyOf 1)booleanAlternativeIf `true`, will try to retain original non-null issue field values on move.
Default: true
write Only: true
retain (anyOf 2)nullAlternative
typestringRequired within parentWill treat as `MandatoryFieldValueForADF` if type is `adf`
Default: raw
One of: adf, raw
write Only: true
valueobjectRequired within parentValue 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

FieldTypePresenceDescription and constraints
$objectRootAn 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
inferClassificationDefaultsbooleanRequired within parentIf `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
inferFieldDefaultsbooleanRequired within parentIf `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
inferStatusDefaultsbooleanRequired within parentIf `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
inferSubtaskTypeDefaultbooleanRequired within parentWhen 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
issueIdsOrKeysarrayRequired within parentList of issue IDs or keys to be moved.
write Only: true
issueIdsOrKeys[]stringEach itemwrite Only: true
targetClassificationJSONOptional
targetClassification (anyOf 1)arrayAlternativeList 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)[]ModelEach itemExpand Bulk move issues — request body — body target To Sources Mapping value target Classification array item
targetClassification (anyOf 2)nullAlternative
targetMandatoryFieldsJSONOptional
targetMandatoryFields (anyOf 1)arrayAlternativeList 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)[]ModelEach itemExpand Bulk move issues — request body — body target To Sources Mapping value target Mandatory Fields array item
targetMandatoryFields (anyOf 2)nullAlternative
targetStatusJSONOptional
targetStatus (anyOf 1)arrayAlternativeList 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)[]ModelEach itemExpand Bulk move issues — request body — body target To Sources Mapping value target Status array item
targetStatus (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeClassification mapping for classifications in source issues to respective target classification.
write Only: true
Additional keys: not allowed
$ (anyOf 1).classificationsobjectRequired within parentAn 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.*arrayAdditional keyswrite Only: true
$ (anyOf 1).classifications.*[]stringEach itemwrite Only: true
$ (anyOf 1).issueTypestringOptionalID of the source issueType to which issues present in `issueIdOrKeys` belongs.
write Only: true
$ (anyOf 1).projectKeyOrIdstringOptionalID or key of the source project to which issues present in `issueIdOrKeys` belongs.
write Only: true
$ (anyOf 2)nullAlternative

Bulk move issues — request body — body target To Sources Mapping value target Mandatory Fields array item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeField mapping for mandatory fields in target
write Only: true
Additional keys: not allowed
$ (anyOf 1).fieldsobjectRequired within parentContains the value of mandatory fields
write Only: true
Additional keys: see wildcard field
$ (anyOf 1).fields.*ModelAdditional keysExpand 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)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootCan 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
retainJSONOptional
retain (anyOf 1)booleanAlternativeIf `true`, will try to retain original non-null issue field values on move.
Default: true
write Only: true
retain (anyOf 2)nullAlternative
typestringOptionalOne of: adf, raw
valueobjectOptional
$ (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootList of string of inputs
retainJSONOptional
retain (anyOf 1)booleanAlternativeIf `true`, will try to retain original non-null issue field values on move.
Default: true
write Only: true
retain (anyOf 2)nullAlternative
typeJSONOptional
type (anyOf 1)stringAlternativeWill treat as `MandatoryFieldValue` if type is `raw` or `empty`
Default: raw
One of: adf, raw
write Only: true
type (anyOf 2)nullAlternative
valuearrayRequired within parentValue for each field. Provide a `list of strings` for non-ADF fields.
write Only: true
value[]stringEach itemValue 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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeStatus mapping for statuses in source workflow to respective target status in target workflow.
write Only: true
Additional keys: not allowed
$ (anyOf 1).statusesobjectRequired within parentAn 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.*arrayAdditional keyswrite Only: true
$ (anyOf 1).statuses.*[]stringEach itemwrite Only: true
$ (anyOf 2)nullAlternative

Bulk transition issue statuses — request body — body

FieldTypePresenceDescription and constraints
$objectRootIssue Bulk Transition Payload
Additional keys: not allowed
bulkTransitionInputsarrayRequired within parentList 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[]ModelEach itemExpand Bulk transition issue statuses — request body — body bulk Transition Inputs item
sendBulkNotificationJSONOptional
sendBulkNotification (anyOf 1)booleanAlternativeA 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)nullAlternative

Referenced models: Bulk transition issue statuses — request body — body bulk Transition Inputs item

Bulk transition issue statuses — request body — body bulk Transition Inputs item

FieldTypePresenceDescription and constraints
$objectRootwrite Only: true
Additional keys: not allowed
selectedIssueIdsOrKeysarrayRequired within parentList of all the issue IDs or keys that are to be bulk transitioned.
write Only: true
selectedIssueIdsOrKeys[]stringEach itemwrite Only: true
transitionIdstringRequired within parentThe ID of the transition that is to be performed on the issues.
write Only: true

Bulk watch issues — request body — body

FieldTypePresenceDescription and constraints
$objectRootIssue Bulk Watch Or Unwatch Payload
Additional keys: not allowed
selectedIssueIdsOrKeysarrayRequired within parentList 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[]stringEach itemwrite Only: true

Get available transitions — response body

FieldTypePresenceDescription and constraints
$objectRootBulk Transition Get Available Transitions Response.
availableTransitionsJSONOptional
availableTransitions (anyOf 1)arrayAlternativeList of available transitions for bulk transition operation for requested issues grouped by workflow
Read only: true
availableTransitions (anyOf 1)[]ModelEach itemExpand Get available transitions — response body — available Transitions array item
availableTransitions (anyOf 2)nullAlternative
endingBeforeJSONOptional
endingBefore (anyOf 1)stringAlternativeThe end cursor for use in pagination.
Read only: true
endingBefore (anyOf 2)nullAlternative
startingAfterJSONOptional
startingAfter (anyOf 1)stringAlternativeThe start cursor for use in pagination.
Read only: true
startingAfter (anyOf 2)nullAlternative

Referenced models: Get available transitions — response body — available Transitions array item

Get available transitions — response body — available Transitions array item

FieldTypePresenceDescription and constraints
$objectRoot
isTransitionsFilteredJSONOptional
isTransitionsFiltered (anyOf 1)booleanAlternativeIndicates whether all the transitions of this workflow are available in the transitions list or not.
Read only: true
isTransitionsFiltered (anyOf 2)nullAlternative
issuesJSONOptional
issues (anyOf 1)arrayAlternativeList of issue keys from the request which are associated with this workflow.
Read only: true
issues (anyOf 1)[]stringEach itemRead only: true
issues (anyOf 2)nullAlternative
transitionsJSONOptional
transitions (anyOf 1)arrayAlternativeList 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)[]ModelEach itemExpand Get available transitions — response body — available Transitions array item transitions array item
transitions (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
toJSONOptional
to (anyOf 1)ModelAlternativeExpand 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)nullAlternative
transitionIdJSONOptional
transitionId (anyOf 1)JSONAlternative
transitionId (anyOf 1) (anyOf 1)integerAlternativeThe unique ID of the transition.
Format: int32
Read only: true
transitionId (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
transitionId (anyOf 2)nullAlternative
transitionNameJSONOptional
transitionName (anyOf 1)stringAlternativeThe name of the transition.
Read only: true
transitionName (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
statusIdJSONOptional
statusId (anyOf 1)JSONAlternative
statusId (anyOf 1) (anyOf 1)integerAlternativeThe unique ID of the status.
Format: int32
Read only: true
statusId (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
statusId (anyOf 2)nullAlternative
statusNameJSONOptional
statusName (anyOf 1)stringAlternativeThe name of the status.
Read only: true
statusName (anyOf 2)nullAlternative

Get bulk editable fields — response body

FieldTypePresenceDescription and constraints
$objectRootBulk Edit Get Fields Response.
endingBeforeJSONOptional
endingBefore (anyOf 1)stringAlternativeThe end cursor for use in pagination.
Read only: true
endingBefore (anyOf 2)nullAlternative
fieldsJSONOptional
fields (anyOf 1)arrayAlternativeList of all the fields
Read only: true
fields (anyOf 1)[]ModelEach itemExpand Get bulk editable fields — response body — fields List of all the fields item
fields (anyOf 2)nullAlternative
startingAfterJSONOptional
startingAfter (anyOf 1)stringAlternativeThe start cursor for use in pagination.
Read only: true
startingAfter (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the field.
description (anyOf 2)nullAlternative
fieldOptionsJSONOptional
fieldOptions (anyOf 1)arrayAlternativeA list of options related to the field, applicable in contexts where multiple selections are allowed.
fieldOptions (anyOf 1)[]ModelEach itemExpand Get user — response body — groups callback, items, max-results, paging Callback, size callback object
fieldOptions (anyOf 2)nullAlternative
idJSONOptional
id (anyOf 1)stringAlternativeThe unique ID of the field.
id (anyOf 2)nullAlternative
isRequiredJSONOptional
isRequired (anyOf 1)booleanAlternativeIndicates whether the field is mandatory for the operation.
isRequired (anyOf 2)nullAlternative
multiSelectFieldOptionsJSONOptional
multiSelectFieldOptions (anyOf 1)arrayAlternativeSpecifies supported actions (like add, replace, remove) on multi-select fields via an enum.
multiSelectFieldOptions (anyOf 1)[]stringEach itemKnown values: ADD, REMOVE, REPLACE, REMOVE_ALL
multiSelectFieldOptions (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeThe display name of the field.
name (anyOf 2)nullAlternative
searchUrlJSONOptional
searchUrl (anyOf 1)stringAlternativeA URL to fetch additional data for the field
searchUrl (anyOf 2)nullAlternative
typeJSONOptional
type (anyOf 1)stringAlternativeThe type of the field.
type (anyOf 2)nullAlternative
unavailableMessageJSONOptional
unavailableMessage (anyOf 1)stringAlternativeA message indicating why the field is unavailable for editing.
unavailableMessage (anyOf 2)nullAlternative

Referenced models: Get user — response body — groups callback, items, max-results, paging Callback, size callback object

Get bulk issue operation progress — response body

FieldTypePresenceDescription and constraints
$objectRoot
createdJSONOptional
created (anyOf 1)JSONAlternative
created (anyOf 1) (anyOf 1)stringAlternativeA timestamp of when the task was submitted.
created (anyOf 1) (anyOf 2)integerAlternative
created (anyOf 2)nullAlternative
failedAccessibleIssuesJSONOptional
failedAccessibleIssues (anyOf 1)objectAlternativeMap 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).*arrayAdditional keys
failedAccessibleIssues (anyOf 1).*[]stringEach item
failedAccessibleIssues (anyOf 2)nullAlternative
invalidOrInaccessibleIssueCountJSONOptional
invalidOrInaccessibleIssueCount (anyOf 1)JSONAlternative
invalidOrInaccessibleIssueCount (anyOf 1) (anyOf 1)integerAlternativeThe 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
invalidOrInaccessibleIssueCount (anyOf 2)nullAlternative
processedAccessibleIssuesJSONOptional
processedAccessibleIssues (anyOf 1)arrayAlternativeList of issue IDs for which the operation was successful and that the user has permission to view.
processedAccessibleIssues (anyOf 1)[]JSONEach item
processedAccessibleIssues (anyOf 1)[] (anyOf 1)integerAlternativeFormat: int64
processedAccessibleIssues (anyOf 1)[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
processedAccessibleIssues (anyOf 2)nullAlternative
progressPercentJSONOptional
progressPercent (anyOf 1)JSONAlternative
progressPercent (anyOf 1) (anyOf 1)integerAlternativeProgress of the task as a percentage.
Format: int64
progressPercent (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
progressPercent (anyOf 2)nullAlternative
startedJSONOptional
started (anyOf 1)JSONAlternative
started (anyOf 1) (anyOf 1)stringAlternativeA timestamp of when the task was started.
started (anyOf 1) (anyOf 2)integerAlternative
started (anyOf 2)nullAlternative
statusJSONOptional
status (anyOf 1)stringAlternativeThe status of the task.
Known values: ENQUEUED, RUNNING, COMPLETE, FAILED, CANCEL_REQUESTED, CANCELLED, DEAD
status (anyOf 2)nullAlternative
submittedByJSONOptional
submittedBy (anyOf 1)ModelAlternativeExpand Get user — response body
submittedBy (anyOf 2)nullAlternative
taskIdJSONOptional
taskId (anyOf 1)stringAlternativeThe ID of the task.
Read only: true
taskId (anyOf 2)nullAlternative
totalIssueCountJSONOptional
totalIssueCount (anyOf 1)JSONAlternative
totalIssueCount (anyOf 1) (anyOf 1)integerAlternativeThe number of issues that the bulk operation was attempted on.
Format: int32
totalIssueCount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalIssueCount (anyOf 2)nullAlternative
updatedJSONOptional
updated (anyOf 1)JSONAlternative
updated (anyOf 1) (anyOf 1)stringAlternativeA timestamp of when the task progress was last updated.
updated (anyOf 1) (anyOf 2)integerAlternative
updated (anyOf 2)nullAlternative

Referenced models: Get user — response body

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.