Atlassian: Issues schemas

← Issues operations · All schemas

Archive issue(s) by JQL — request body — body

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

Archive issue(s) by issue ID key — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	List of Issue Ids Or Keys that are to be archived or unarchived Additional keys: not allowed
issueIdsOrKeys	array	Optional
issueIdsOrKeys[]	string	Each item

Archive issue(s) by issue ID key — response body

Field	Type	Presence	Description and constraints
$	object	Root	Number of archived/unarchived issues and list of errors that occurred during the action, if any.
errors	JSON	Optional
errors (anyOf 1)	Model	Alternative	Expand Archive issue(s) by issue ID key — response body — errors issue Is Subtask, issues In Archived Projects, issues In Unlicensed Projects, issues Not Found, user Does Not Have Permission
errors (anyOf 2)	null	Alternative
numberOfIssuesUpdated	JSON	Optional
numberOfIssuesUpdated (anyOf 1)	JSON	Alternative
numberOfIssuesUpdated (anyOf 1) (anyOf 1)	integer	Alternative	Format: int64
numberOfIssuesUpdated (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
numberOfIssuesUpdated (anyOf 2)	null	Alternative

Referenced models: Archive issue(s) by issue ID key — response body — errors issue Is Subtask, issues In Archived Projects, issues In Unlicensed Projects, issues Not Found, user Does Not Have Permission

Archive issue(s) by issue ID key — response body — errors issue Is Subtask, issues In Archived Projects, issues In Unlicensed Projects, issues Not Found, user Does Not Have Permission

Field	Type	Presence	Description and constraints
$	object	Root
issueIsSubtask	JSON	Optional
issueIsSubtask (anyOf 1)	Model	Alternative	Expand Archive issue(s) by issue ID key — response body — errors issue Is Subtask, issues In Archived Projects, issues In Unlicensed Projects, issues Not Found, user Does Not Have Permission issue Is Subtask count, issue Ids Or Keys, message
issueIsSubtask (anyOf 2)	null	Alternative
issuesInArchivedProjects	JSON	Optional
issuesInArchivedProjects (anyOf 1)	Model	Alternative	Expand Archive issue(s) by issue ID key — response body — errors issue Is Subtask, issues In Archived Projects, issues In Unlicensed Projects, issues Not Found, user Does Not Have Permission issue Is Subtask count, issue Ids Or Keys, message
issuesInArchivedProjects (anyOf 2)	null	Alternative
issuesInUnlicensedProjects	JSON	Optional
issuesInUnlicensedProjects (anyOf 1)	Model	Alternative	Expand Archive issue(s) by issue ID key — response body — errors issue Is Subtask, issues In Archived Projects, issues In Unlicensed Projects, issues Not Found, user Does Not Have Permission issue Is Subtask count, issue Ids Or Keys, message
issuesInUnlicensedProjects (anyOf 2)	null	Alternative
issuesNotFound	JSON	Optional
issuesNotFound (anyOf 1)	Model	Alternative	Expand Archive issue(s) by issue ID key — response body — errors issue Is Subtask, issues In Archived Projects, issues In Unlicensed Projects, issues Not Found, user Does Not Have Permission issue Is Subtask count, issue Ids Or Keys, message
issuesNotFound (anyOf 2)	null	Alternative
userDoesNotHavePermission	JSON	Optional
userDoesNotHavePermission (anyOf 1)	Model	Alternative	Expand Archive issue(s) by issue ID key — response body — errors issue Is Subtask, issues In Archived Projects, issues In Unlicensed Projects, issues Not Found, user Does Not Have Permission issue Is Subtask count, issue Ids Or Keys, message
userDoesNotHavePermission (anyOf 2)	null	Alternative

Referenced models: Archive issue(s) by issue ID key — response body — errors issue Is Subtask, issues In Archived Projects, issues In Unlicensed Projects, issues Not Found, user Does Not Have Permission issue Is Subtask count, issue Ids Or Keys, message

Archive issue(s) by issue ID key — response body — errors issue Is Subtask, issues In Archived Projects, issues In Unlicensed Projects, issues Not Found, user Does Not Have Permission issue Is Subtask count, issue Ids Or Keys, message

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Optional
count (anyOf 1)	JSON	Alternative
count (anyOf 1) (anyOf 1)	integer	Alternative	Format: int64
count (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
count (anyOf 2)	null	Alternative
issueIdsOrKeys	JSON	Optional
issueIdsOrKeys (anyOf 1)	array	Alternative	Unique items: true
issueIdsOrKeys (anyOf 1)[]	string	Each item
issueIdsOrKeys (anyOf 2)	null	Alternative
message	JSON	Optional
message (anyOf 1)	string	Alternative
message (anyOf 2)	null	Alternative

Assign issue — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. Additional keys: not allowed
accountId	string	Optional	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests. Maximum length: 128
accountType	string	Optional	The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk One of: atlassian, app, customer, unknown Read only: true
active	boolean	Optional	Whether the user is active. Read only: true
appType	string	Optional	The app type of the user account when accountType is 'app'. Can take the following values: * `service` Service Account * `agent` Rovo Agent Account * `unknown` Unknown app type Read only: true
applicationRoles	Model	Optional	Expand Assign issue — request body — body application Roles The application roles the user is assigned to. Read only: true
avatarUrls	Model	Optional	Expand Assign issue — request body — body avatar Urls The avatars of the user. Read only: true
displayName	string	Optional	The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. Read only: true
emailAddress	string	Optional	The email address of the user. Depending on the user’s privacy setting, this may be returned as null. Read only: true
expand	string	Optional	Expand options that include additional user details in the response. Read only: true
groups	Model	Optional	Expand Assign issue — request body — body groups The groups that the user belongs to. Read only: true
guest	boolean	Optional	Whether the user is a guest. Read only: true
key	string	Optional	This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
locale	string	Optional	The locale of the user. Depending on the user’s privacy setting, this may be returned as null. Read only: true
name	string	Optional	This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
self	string	Optional	The URL of the user. Format: uri Read only: true
timeZone	string	Optional	The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. Read only: true

Referenced models: Assign issue — request body — body avatar Urls, Assign issue — request body — body application Roles, Assign issue — request body — body groups

Assign issue — request body — body application Roles

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
callback	Model	Optional	Expand Assign issue — request body — body groups callback
items	array	Optional
items[]	Model	Each item	Expand Assign issue — request body — body application Roles items item
max-results	integer	Optional	Format: int32
pagingCallback	Model	Optional	Expand Assign issue — request body — body groups callback
size	integer	Optional	Format: int32

Referenced models: Assign issue — request body — body application Roles items item, Assign issue — request body — body groups callback

Assign issue — request body — body application Roles items item

Field	Type	Presence	Description and constraints
$	object	Root	Details of an application role. Additional keys: not allowed
defaultGroups	array	Optional	The groups that are granted default access for this application role. As a group's name can change, use of `defaultGroupsDetails` is recommended to identify a groups. Unique items: true
defaultGroups[]	string	Each item
defaultGroupsDetails	array	Optional	The groups that are granted default access for this application role.
defaultGroupsDetails[]	Model	Each item	Expand Send notification for issue — request body — body to groups item
defined	boolean	Optional	Deprecated.
groupDetails	array	Optional	The groups associated with the application role.
groupDetails[]	Model	Each item	Expand Send notification for issue — request body — body to groups item
groups	array	Optional	The groups associated with the application role. As a group's name can change, use of `groupDetails` is recommended to identify a groups. Unique items: true
groups[]	string	Each item
hasUnlimitedSeats	boolean	Optional
key	string	Optional	The key of the application role.
name	string	Optional	The display name of the application role.
numberOfSeats	integer	Optional	The maximum count of users on your license. Format: int32
platform	boolean	Optional	Indicates if the application role belongs to Jira platform (`jira-core`).
remainingSeats	integer	Optional	The count of users remaining on your license. Format: int32
selectedByDefault	boolean	Optional	Determines whether this application role should be selected by default on user creation.
userCount	integer	Optional	The number of users counting against your license. Format: int32
userCountDescription	string	Optional	The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.

Referenced models: Send notification for issue — request body — body to groups item

Assign issue — request body — body avatar Urls

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
16x16	string	Optional	The URL of the item's 16x16 pixel avatar. Format: uri
24x24	string	Optional	The URL of the item's 24x24 pixel avatar. Format: uri
32x32	string	Optional	The URL of the item's 32x32 pixel avatar. Format: uri
48x48	string	Optional	The URL of the item's 48x48 pixel avatar. Format: uri

Assign issue — request body — body groups

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
callback	Model	Optional	Expand Assign issue — request body — body groups callback
items	array	Optional
items[]	Model	Each item	Expand Send notification for issue — request body — body to groups item
max-results	integer	Optional	Format: int32
pagingCallback	Model	Optional	Expand Assign issue — request body — body groups callback
size	integer	Optional	Format: int32

Referenced models: Assign issue — request body — body groups callback, Send notification for issue — request body — body to groups item

Assign issue — request body — body groups callback

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

Bulk create issue — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: allowed
issueUpdates	array	Optional
issueUpdates[]	Model	Each item	Expand Edit issue — request body — body

Referenced models: Edit issue — request body — body

Bulk create issue — response body

Field	Type	Presence	Description and constraints
$	object	Root	Details about the issues created and the errors for requests that failed.
errors	JSON	Optional
errors (anyOf 1)	array	Alternative	Error details for failed issue creation requests. Read only: true
errors (anyOf 1)[]	Model	Each item	Expand Bulk create issue — response body — errors Error details for failed issue creation requests item
errors (anyOf 2)	null	Alternative
issues	JSON	Optional
issues (anyOf 1)	array	Alternative	Details of the issues created. Read only: true
issues (anyOf 1)[]	Model	Each item	Expand Create issue — response body
issues (anyOf 2)	null	Alternative

Referenced models: Bulk create issue — response body — errors Error details for failed issue creation requests item, Create issue — response body

Bulk create issue — response body — errors Error details for failed issue creation requests item

Field	Type	Presence	Description and constraints
$	object	Root
elementErrors	JSON	Optional
elementErrors (anyOf 1)	Model	Alternative	Expand Validate project key — response body
elementErrors (anyOf 2)	null	Alternative
failedElementNumber	JSON	Optional
failedElementNumber (anyOf 1)	JSON	Alternative
failedElementNumber (anyOf 1) (anyOf 1)	integer	Alternative	Format: int32
failedElementNumber (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
failedElementNumber (anyOf 2)	null	Alternative
status	JSON	Optional
status (anyOf 1)	JSON	Alternative
status (anyOf 1) (anyOf 1)	integer	Alternative	Format: int32
status (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
status (anyOf 2)	null	Alternative

Referenced models: Validate project key — response body

Bulk fetch changelogs — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request bean for bulk changelog retrieval Additional keys: not allowed
fieldIds	array	Optional	List of field IDs to filter changelogs Maximum items: 10 Minimum items: 0 Unique items: true
fieldIds[]	string	Each item	List of field IDs to filter changelogs
issueIdsOrKeys	array	Required within parent	List of issue IDs/keys to fetch changelogs for Maximum items: 1000 Minimum items: 1
issueIdsOrKeys[]	string	Each item	List of issue IDs/keys to fetch changelogs for
maxResults	integer	Optional	The maximum number of items to return per page Default: 1000 Format: int32 Maximum: 10000 Minimum: 1
nextPageToken	string	Optional	The cursor for pagination

Bulk fetch changelogs — response body

Field	Type	Presence	Description and constraints
$	object	Root	A page of changelogs which is designed to handle multiple issues
issueChangeLogs	JSON	Optional
issueChangeLogs (anyOf 1)	array	Alternative	The list of issues changelogs. Read only: true
issueChangeLogs (anyOf 1)[]	Model	Each item	Expand Bulk fetch changelogs — response body — issue Change Logs The list of issues changelogs item
issueChangeLogs (anyOf 2)	null	Alternative
nextPageToken	JSON	Optional
nextPageToken (anyOf 1)	string	Alternative	Continuation token to fetch the next page. If this result represents the last or the only page, this token will be null. Read only: true
nextPageToken (anyOf 2)	null	Alternative

Referenced models: Bulk fetch changelogs — response body — issue Change Logs The list of issues changelogs item

Bulk fetch changelogs — response body — issue Change Logs The list of issues changelogs item

Field	Type	Presence	Description and constraints
$	object	Root	List of changelogs that belong to single issue
changeHistories	JSON	Optional
changeHistories (anyOf 1)	array	Alternative	List of changelogs that belongs to given issueId. Read only: true
changeHistories (anyOf 1)[]	Model	Each item	Expand Get changelogs — response body — values The list of items item
changeHistories (anyOf 2)	null	Alternative
issueId	JSON	Optional
issueId (anyOf 1)	string	Alternative	The ID of the issue. Read only: true
issueId (anyOf 2)	null	Alternative

Referenced models: Get changelogs — response body — values The list of items item

Bulk fetch issues — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
expand	array	Optional	Use [expand](#expansion) to include additional information about issues in the response. Note that, unlike the majority of instances where `expand` is specified, `expand` is defined as a list of values. The expand options are: * `renderedFields` Returns field values rendered in HTML format. * `names` Returns the display name of each field. * `schema` Returns the schema describing a field type. * `transitions` Returns all possible transitions for the issue. * `operations` Returns all possible operations for the issue. * `editmeta` Returns information about how each field can be edited. * `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. This returns a maximum of 40 changelogs. If you require more, please refer to [Bulk fetch changelogs](#api-rest-api-3-changelog-bulkfetch-post). * `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version. To request up to 1000 issues in a single call, do not include `changelog`, `editmeta`, `operations`, `renderedFields`, `transitions`, or `versionedRepresentations` in `expand`. Requests that include any of these can include at most 100 issues; larger requests are rejected with a 400 error.
expand[]	string	Each item
fields	array	Optional	A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: * `*all` Returns all fields. * `*navigable` Returns navigable fields. * Any issue field, prefixed with a minus to exclude. The default is `*navigable`. Examples: * `summary,comment` Returns the summary and comments fields only. * `-description` Returns all navigable (default) fields except description. * `*all,-comment` Returns all fields except comments. Multiple `fields` parameters can be included in a request. Note: All navigable fields are returned by default. This differs from [GET issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields. To request up to 1000 issues in a single call, explicitly list the fields you need: at least one field must be a positive include (a request containing only exclusions is not eligible), the `*all` and `*navigable` wildcards and the default navigable field set are not eligible for the higher limit, no more than 100 fields may be listed, and none of the included fields returns multiple values (for example `comment`, `worklog`, or `attachment`). Requests that do not meet these conditions can include at most 100 issues; larger requests are rejected with a 400 error.
fields[]	string	Each item
fieldsByKeys	boolean	Optional	Reference fields by their key (rather than ID). The default is `false`.
issueIdsOrKeys	array	Required within parent	An array of issue IDs or issue keys to fetch. You can mix issue IDs and keys in the same query. You can request up to 100 issues per call. Requests can include up to 1000 issues per call when they meet all of the conditions described for the `fields` and `expand` parameters. Requests that exceed the applicable limit are rejected with a 400 error.
issueIdsOrKeys[]	string	Each item
properties	array	Optional	A list of issue property keys of issue properties to be included in the results. A maximum of 5 issue property keys can be specified.
properties[]	string	Each item

Bulk fetch issues — response body

Field	Type	Presence	Description and constraints
$	object	Root	The list of requested issues & fields.
issueErrors	JSON	Optional
issueErrors (anyOf 1)	array	Alternative	When Jira can't return an issue enumerated in a request due to a retriable error or payload constraint, we'll return the respective issue ID with a corresponding error message. This list is empty when there are no errors Issues which aren't found or that the user doesn't have permission to view won't be returned in this list. Read only: true
issueErrors (anyOf 1)[]	Model	Each item	Expand Bulk fetch issues — response body — issue Errors array item
issueErrors (anyOf 2)	null	Alternative
issues	JSON	Optional
issues (anyOf 1)	array	Alternative	The list of issues. Read only: true
issues (anyOf 1)[]	Model	Each item	Expand Get issue — response body
issues (anyOf 2)	null	Alternative

Referenced models: Get issue — response body, Bulk fetch issues — response body — issue Errors array item

Bulk fetch issues — response body — issue Errors array item

Field	Type	Presence	Description and constraints
$	object	Root	Describes the error that occurred when retrieving data for a particular issue.
errorMessage	JSON	Optional
errorMessage (anyOf 1)	string	Alternative	The error that occurred when fetching this issue. Read only: true
errorMessage (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the issue. Read only: true
id (anyOf 2)	null	Alternative

Create issue — response body

Field	Type	Presence	Description and constraints
$	object	Root	Details about a created issue or subtask.
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the created issue or subtask. Read only: true
id (anyOf 2)	null	Alternative
key	JSON	Optional
key (anyOf 1)	string	Alternative	The key of the created issue or subtask. Read only: true
key (anyOf 2)	null	Alternative
self	JSON	Optional
self (anyOf 1)	string	Alternative	The URL of the created issue or subtask. Read only: true
self (anyOf 2)	null	Alternative
transition	JSON	Optional
transition (anyOf 1)	Model	Alternative	Expand Create issue — response body — watchers error Collection, status, warning Collection The response code and messages related to any requested transition. Read only: true
transition (anyOf 2)	null	Alternative
watchers	JSON	Optional
watchers (anyOf 1)	Model	Alternative	Expand Create issue — response body — watchers error Collection, status, warning Collection The response code and messages related to any requested watchers. Read only: true
watchers (anyOf 2)	null	Alternative

Referenced models: Create issue — response body — watchers error Collection, status, warning Collection

Create issue — response body — watchers error Collection, status, warning Collection

Field	Type	Presence	Description and constraints
$	object	Root
errorCollection	JSON	Optional
errorCollection (anyOf 1)	Model	Alternative	Expand Validate project key — response body
errorCollection (anyOf 2)	null	Alternative
status	JSON	Optional
status (anyOf 1)	JSON	Alternative
status (anyOf 1) (anyOf 1)	integer	Alternative	Format: int32
status (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
status (anyOf 2)	null	Alternative
warningCollection	JSON	Optional
warningCollection (anyOf 1)	Model	Alternative	Expand Create issue — response body — watchers error Collection, status, warning Collection warning Collection warnings
warningCollection (anyOf 2)	null	Alternative

Referenced models: Validate project key — response body, Create issue — response body — watchers error Collection, status, warning Collection warning Collection warnings

Create issue — response body — watchers error Collection, status, warning Collection warning Collection warnings

Field	Type	Presence	Description and constraints
$	object	Root
warnings	JSON	Optional
warnings (anyOf 1)	array	Alternative
warnings (anyOf 1)[]	string	Each item
warnings (anyOf 2)	null	Alternative

Edit issue — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Details of an issue update request. Additional keys: allowed
fields	object	Optional	List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use `update`. Fields included in here cannot be included in `update`. Additional keys: see wildcard field
fields.*	JSON	Additional keys
historyMetadata	Model	Optional	Expand Edit issue — request body — body history Metadata Additional issue history details.
properties	array	Optional	Details of issue properties to be add or update.
properties[]	Model	Each item	Expand Edit issue — request body — body properties item
transition	Model	Optional	Expand Edit issue — request body — body transition Details of a transition. Required when performing a transition, optional when creating or editing an issue.
update	object	Optional	A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in `fields`. Additional keys: see wildcard field
update.*	array	Additional keys
update.*[]	Model	Each item	Expand Edit issue — request body — body update value item

Referenced models: Edit issue — request body — body properties item, Edit issue — request body — body update value item, Edit issue — request body — body history Metadata, Edit issue — request body — body transition

Edit issue — request body — body history Metadata

Field	Type	Presence	Description and constraints
$	object	Root	Details of issue history metadata. Additional keys: allowed
activityDescription	string	Optional	The activity described in the history record.
activityDescriptionKey	string	Optional	The key of the activity described in the history record.
actor	Model	Optional	Expand Edit issue — request body — body history Metadata actor Details of the user whose action created the history record.
cause	Model	Optional	Expand Edit issue — request body — body history Metadata actor Details of the cause that triggered the creation the history record.
description	string	Optional	The description of the history record.
descriptionKey	string	Optional	The description key of the history record.
emailDescription	string	Optional	The description of the email address associated the history record.
emailDescriptionKey	string	Optional	The description key of the email address associated the history record.
extraData	object	Optional	Additional arbitrary information about the history record. Additional keys: see wildcard field
extraData.*	string	Additional keys
generator	Model	Optional	Expand Edit issue — request body — body history Metadata actor Details of the system that generated the history record.
type	string	Optional	The type of the history record.

Referenced models: Edit issue — request body — body history Metadata actor

Edit issue — request body — body history Metadata actor

Field	Type	Presence	Description and constraints
$	object	Root	Details of user or system associated with a issue history metadata item. Additional keys: allowed
avatarUrl	string	Optional	The URL to an avatar for the user or system associated with a history record.
displayName	string	Optional	The display name of the user or system associated with a history record.
displayNameKey	string	Optional	The key of the display name of the user or system associated with a history record.
id	string	Optional	The ID of the user or system associated with a history record.
type	string	Optional	The type of the user or system associated with a history record.
url	string	Optional	The URL of the user or system associated with a history record.

Edit issue — request body — body properties item

Field	Type	Presence	Description and constraints
$	object	Root	An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/). Additional keys: not allowed
key	string	Optional	The key of the property. Required on create and update.
value	JSON	Optional	The value of the property. Required on create and update.

Edit issue — request body — body transition

Field	Type	Presence	Description and constraints
$	object	Root	Details of an issue transition. Additional keys: allowed
expand	string	Optional	Expand options that include additional transition details in the response. Read only: true
fields	object	Optional	Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request. Read only: true Additional keys: see wildcard field
fields.*	Model	Additional keys	Expand Edit issue — request body — body transition fields value
hasScreen	boolean	Optional	Whether there is a screen associated with the issue transition. Read only: true
id	string	Optional	The ID of the issue transition. Required when specifying a transition to undertake.
isAvailable	boolean	Optional	Whether the transition is available to be performed. Read only: true
isConditional	boolean	Optional	Whether the issue has to meet criteria before the issue transition is applied. Read only: true
isGlobal	boolean	Optional	Whether the issue transition is global, that is, the transition is applied to issues regardless of their status. Read only: true
isInitial	boolean	Optional	Whether this is the initial issue transition for the workflow. Read only: true
looped	boolean	Optional
name	string	Optional	The name of the issue transition. Read only: true
to	Model	Optional	Expand Edit issue — request body — body transition to Details of the issue status after the transition. Read only: true

Referenced models: Edit issue — request body — body transition fields value, Edit issue — request body — body transition to

Edit issue — request body — body transition fields value

Field	Type	Presence	Description and constraints
$	object	Root	The metadata describing an issue field. Additional keys: not allowed
allowedValues	array	Optional	The list of values allowed in the field. Read only: true
allowedValues[]	JSON	Each item	Read only: true
autoCompleteUrl	string	Optional	The URL that can be used to automatically complete the field. Read only: true
configuration	object	Optional	The configuration properties. Read only: true Additional keys: see wildcard field
configuration.*	JSON	Additional keys	Read only: true
defaultValue	JSON	Optional	The default value of the field. Read only: true
hasDefaultValue	boolean	Optional	Whether the field has a default value. Read only: true
key	string	Required within parent	The key of the field. Read only: true
name	string	Required within parent	The name of the field. Read only: true
operations	array	Required within parent	The list of operations that can be performed on the field. Read only: true
operations[]	string	Each item	Read only: true
required	boolean	Required within parent	Whether the field is required. Read only: true
schema	Model	Required within parent	Expand Edit issue — request body — body transition fields value schema The data type of the field. Read only: true

Referenced models: Edit issue — request body — body transition fields value schema

Edit issue — request body — body transition fields value schema

Field	Type	Presence	Description and constraints
$	object	Root	The schema of a field. Additional keys: not allowed
configuration	object	Optional	If the field is a custom field, the configuration of the field. Read only: true Additional keys: see wildcard field
configuration.*	JSON	Additional keys	Read only: true
custom	string	Optional	If the field is a custom field, the URI of the field. Read only: true
customId	integer	Optional	If the field is a custom field, the custom ID of the field. Format: int64 Read only: true
items	string	Optional	When the data type is an array, the name of the field items within the array. Read only: true
system	string	Optional	If the field is a system field, the name of the field. Read only: true
type	string	Required within parent	The data type of the field. Read only: true

Edit issue — request body — body transition to

Field	Type	Presence	Description and constraints
$	object	Root	A status. Additional keys: allowed
description	string	Optional	The description of the status. Read only: true
iconUrl	string	Optional	The URL of the icon used to represent the status. Read only: true
id	string	Optional	The ID of the status. Read only: true
name	string	Optional	The name of the status. Read only: true
scope	Model	Optional	Expand Create permission scheme — request body — body scope The scope of the field. Read only: true
self	string	Optional	The URL of the status. Read only: true
statusCategory	Model	Optional	Expand Edit issue — request body — body transition to status Category The category assigned to the status. Read only: true

Referenced models: Create permission scheme — request body — body scope, Edit issue — request body — body transition to status Category

Edit issue — request body — body transition to status Category

Field	Type	Presence	Description and constraints
$	object	Root	A status category. Additional keys: allowed
colorName	string	Optional	The name of the color used to represent the status category. Read only: true
id	integer	Optional	The ID of the status category. Format: int64 Read only: true
key	string	Optional	The key of the status category. Read only: true
name	string	Optional	The name of the status category. Read only: true
self	string	Optional	The URL of the status category. Read only: true

Edit issue — request body — body update value item

Field	Type	Presence	Description and constraints
$	object	Root	Details of an operation to perform on a field. Additional keys: not allowed
add	JSON	Optional	The value to add to the field.
copy	JSON	Optional	The field value to copy from another issue.
edit	JSON	Optional	The value to edit in the field.
remove	JSON	Optional	The value to removed from the field.
set	JSON	Optional	The value to set in the field.

Export archived issue(s) — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Details of a filter for exporting archived issues. Additional keys: allowed
archivedBy	array	Optional	List archived issues archived by a specified account ID.
archivedBy[]	string	Each item
archivedDateRange	Model	Optional	Expand Export archived issue(s) — request body — body archived Date Range
issueTypes	array	Optional	List archived issues with a specified issue type ID.
issueTypes[]	string	Each item
projects	array	Optional	List archived issues with a specified project key.
projects[]	string	Each item
reporters	array	Optional	List archived issues where the reporter is a specified account ID.
reporters[]	string	Each item

Referenced models: Export archived issue(s) — request body — body archived Date Range

Export archived issue(s) — request body — body archived Date Range

Field	Type	Presence	Description and constraints
$	object	Root	List issues archived within a specified date range. Additional keys: not allowed
dateAfter	string	Required within parent	List issues archived after a specified date, passed in the YYYY-MM-DD format.
dateBefore	string	Required within parent	List issues archived before a specified date provided in the YYYY-MM-DD format.

Export archived issue(s) — response body

Field	Type	Presence	Description and constraints
$	object	Root	The response for status request for a running/completed export task.
fileUrl	JSON	Optional
fileUrl (anyOf 1)	string	Alternative
fileUrl (anyOf 2)	null	Alternative
payload	JSON	Optional
payload (anyOf 1)	string	Alternative
payload (anyOf 2)	null	Alternative
progress	JSON	Optional
progress (anyOf 1)	JSON	Alternative
progress (anyOf 1) (anyOf 1)	integer	Alternative	Format: int64
progress (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
progress (anyOf 2)	null	Alternative
status	JSON	Optional
status (anyOf 1)	string	Alternative
status (anyOf 2)	null	Alternative
submittedTime	JSON	Optional
submittedTime (anyOf 1)	JSON	Alternative
submittedTime (anyOf 1) (anyOf 1)	string	Alternative
submittedTime (anyOf 1) (anyOf 2)	integer	Alternative
submittedTime (anyOf 2)	null	Alternative
taskId	JSON	Optional
taskId (anyOf 1)	string	Alternative
taskId (anyOf 2)	null	Alternative

Get changelogs by I Ds — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	A list of changelog IDs. Additional keys: not allowed
changelogIds	array	Required within parent	The list of changelog IDs. Unique items: true
changelogIds[]	integer	Each item	Format: int64

Get changelogs by I Ds — response body

Field	Type	Presence	Description and constraints
$	object	Root	A page of changelogs.
histories	JSON	Optional
histories (anyOf 1)	array	Alternative	The list of changelogs. Read only: true
histories (anyOf 1)[]	Model	Each item	Expand Get changelogs — response body — values The list of items item
histories (anyOf 2)	null	Alternative
maxResults	JSON	Optional
maxResults (anyOf 1)	JSON	Alternative
maxResults (anyOf 1) (anyOf 1)	integer	Alternative	The maximum number of results that could be on the page. Format: int32 Read only: true
maxResults (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maxResults (anyOf 2)	null	Alternative
startAt	JSON	Optional
startAt (anyOf 1)	JSON	Alternative
startAt (anyOf 1) (anyOf 1)	integer	Alternative	The index of the first item returned on the page. Format: int32 Read only: true
startAt (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startAt (anyOf 2)	null	Alternative
total	JSON	Optional
total (anyOf 1)	JSON	Alternative
total (anyOf 1) (anyOf 1)	integer	Alternative	The number of results on the page. Format: int32 Read only: true
total (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total (anyOf 2)	null	Alternative

Referenced models: Get changelogs — response body — values The list of items item

Get changelogs — response body

Field	Type	Presence	Description and constraints
$	object	Root	A page of items.
isLast	JSON	Optional
isLast (anyOf 1)	boolean	Alternative	Whether this is the last page. Read only: true
isLast (anyOf 2)	null	Alternative
maxResults	JSON	Optional
maxResults (anyOf 1)	JSON	Alternative
maxResults (anyOf 1) (anyOf 1)	integer	Alternative	The maximum number of items that could be returned. Format: int32 Read only: true
maxResults (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maxResults (anyOf 2)	null	Alternative
nextPage	JSON	Optional
nextPage (anyOf 1)	string	Alternative	If there is another page of results, the URL of the next page. Format: uri Read only: true
nextPage (anyOf 2)	null	Alternative
self	JSON	Optional
self (anyOf 1)	string	Alternative	The URL of the page. Format: uri Read only: true
self (anyOf 2)	null	Alternative
startAt	JSON	Optional
startAt (anyOf 1)	JSON	Alternative
startAt (anyOf 1) (anyOf 1)	integer	Alternative	The index of the first item returned. Format: int64 Read only: true
startAt (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startAt (anyOf 2)	null	Alternative
total	JSON	Optional
total (anyOf 1)	JSON	Alternative
total (anyOf 1) (anyOf 1)	integer	Alternative	The number of items returned. Format: int64 Read only: true
total (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total (anyOf 2)	null	Alternative
values	JSON	Optional
values (anyOf 1)	array	Alternative	The list of items. Read only: true
values (anyOf 1)[]	Model	Each item	Expand Get changelogs — response body — values The list of items item
values (anyOf 2)	null	Alternative

Referenced models: Get changelogs — response body — values The list of items item

Get changelogs — response body — values The list of items item

Field	Type	Presence	Description and constraints
$	object	Root	A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated.
author	JSON	Optional
author (anyOf 1)	Model	Alternative	Expand Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone The user who made the change. Read only: true
author (anyOf 2)	null	Alternative
created	JSON	Optional
created (anyOf 1)	JSON	Alternative
created (anyOf 1) (anyOf 1)	string	Alternative	The date on which the change took place. Read only: true
created (anyOf 1) (anyOf 2)	integer	Alternative
created (anyOf 2)	null	Alternative
historyMetadata	JSON	Optional
historyMetadata (anyOf 1)	Model	Alternative	Expand Get changelogs — response body — values The list of items item history Metadata Details of issue history metadata The history metadata associated with the changed. Read only: true
historyMetadata (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the changelog. Read only: true
id (anyOf 2)	null	Alternative
items	JSON	Optional
items (anyOf 1)	array	Alternative	The list of items changed. Read only: true
items (anyOf 1)[]	Model	Each item	Expand Get changelogs — response body — values The list of items item items The list of items changed item
items (anyOf 2)	null	Alternative

Referenced models: Get changelogs — response body — values The list of items item items The list of items changed item, Get changelogs — response body — values The list of items item history Metadata Details of issue history metadata, Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone

Get changelogs — response body — values The list of items item history Metadata Details of issue history metadata

Field	Type	Presence	Description and constraints
$	object	Root	Details of issue history metadata. Additional keys: allowed
activityDescription	JSON	Optional
activityDescription (anyOf 1)	string	Alternative	The activity described in the history record.
activityDescription (anyOf 2)	null	Alternative
activityDescriptionKey	JSON	Optional
activityDescriptionKey (anyOf 1)	string	Alternative	The key of the activity described in the history record.
activityDescriptionKey (anyOf 2)	null	Alternative
actor	JSON	Optional
actor (anyOf 1)	Model	Alternative	Expand Get changelogs — response body — values The list of items item history Metadata Details of issue history metadata actor avatar Url, display Name, display Name Key, id, type, url Details of the user whose action created the history record.
actor (anyOf 2)	null	Alternative
cause	JSON	Optional
cause (anyOf 1)	Model	Alternative	Expand Get changelogs — response body — values The list of items item history Metadata Details of issue history metadata actor avatar Url, display Name, display Name Key, id, type, url Details of the cause that triggered the creation the history record.
cause (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	The description of the history record.
description (anyOf 2)	null	Alternative
descriptionKey	JSON	Optional
descriptionKey (anyOf 1)	string	Alternative	The description key of the history record.
descriptionKey (anyOf 2)	null	Alternative
emailDescription	JSON	Optional
emailDescription (anyOf 1)	string	Alternative	The description of the email address associated the history record.
emailDescription (anyOf 2)	null	Alternative
emailDescriptionKey	JSON	Optional
emailDescriptionKey (anyOf 1)	string	Alternative	The description key of the email address associated the history record.
emailDescriptionKey (anyOf 2)	null	Alternative
extraData	JSON	Optional
extraData (anyOf 1)	object	Alternative	Additional arbitrary information about the history record. Additional keys: see wildcard field
extraData (anyOf 1).*	string	Additional keys
extraData (anyOf 2)	null	Alternative
generator	JSON	Optional
generator (anyOf 1)	Model	Alternative	Expand Get changelogs — response body — values The list of items item history Metadata Details of issue history metadata actor avatar Url, display Name, display Name Key, id, type, url Details of the system that generated the history record.
generator (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	The type of the history record.
type (anyOf 2)	null	Alternative

Referenced models: Get changelogs — response body — values The list of items item history Metadata Details of issue history metadata actor avatar Url, display Name, display Name Key, id, type, url

Get changelogs — response body — values The list of items item history Metadata Details of issue history metadata actor avatar Url, display Name, display Name Key, id, type, url

Field	Type	Presence	Description and constraints
$	object	Root	Details of user or system associated with a issue history metadata item. Additional keys: allowed
avatarUrl	JSON	Optional
avatarUrl (anyOf 1)	string	Alternative	The URL to an avatar for the user or system associated with a history record.
avatarUrl (anyOf 2)	null	Alternative
displayName	JSON	Optional
displayName (anyOf 1)	string	Alternative	The display name of the user or system associated with a history record.
displayName (anyOf 2)	null	Alternative
displayNameKey	JSON	Optional
displayNameKey (anyOf 1)	string	Alternative	The key of the display name of the user or system associated with a history record.
displayNameKey (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the user or system associated with a history record.
id (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	The type of the user or system associated with a history record.
type (anyOf 2)	null	Alternative
url	JSON	Optional
url (anyOf 1)	string	Alternative	The URL of the user or system associated with a history record.
url (anyOf 2)	null	Alternative

Get changelogs — response body — values The list of items item items The list of items changed item

Field	Type	Presence	Description and constraints
$	object	Root	A change item.
field	JSON	Optional
field (anyOf 1)	string	Alternative	The name of the field changed. Read only: true
field (anyOf 2)	null	Alternative
fieldId	JSON	Optional
fieldId (anyOf 1)	string	Alternative	The ID of the field changed. Read only: true
fieldId (anyOf 2)	null	Alternative
fieldtype	JSON	Optional
fieldtype (anyOf 1)	string	Alternative	The type of the field changed. Read only: true
fieldtype (anyOf 2)	null	Alternative
from	JSON	Optional
from (anyOf 1)	string	Alternative	The details of the original value. Read only: true
from (anyOf 2)	null	Alternative
fromString	JSON	Optional
fromString (anyOf 1)	string	Alternative	The details of the original value as a string. Read only: true
fromString (anyOf 2)	null	Alternative
to	JSON	Optional
to (anyOf 1)	string	Alternative	The details of the new value. Read only: true
to (anyOf 2)	null	Alternative
toString	JSON	Optional
toString (anyOf 1)	string	Alternative	The details of the new value as a string. Read only: true
toString (anyOf 2)	null	Alternative

Get create field metadata for a project and issue type id — response body

Field	Type	Presence	Description and constraints
$	object	Root	A page of CreateMetaIssueType with Field. Additional keys: allowed
fields	JSON	Optional
fields (anyOf 1)	array	Alternative	The collection of FieldCreateMetaBeans. Read only: true
fields (anyOf 1)[]	Model	Each item	Expand Get create field metadata for a project and issue type id — response body — results array item
fields (anyOf 2)	null	Alternative
maxResults	JSON	Optional
maxResults (anyOf 1)	JSON	Alternative
maxResults (anyOf 1) (anyOf 1)	integer	Alternative	The maximum number of items to return per page. Format: int32 Read only: true
maxResults (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maxResults (anyOf 2)	null	Alternative
results	JSON	Optional
results (anyOf 1)	array	Alternative
results (anyOf 1)[]	Model	Each item	Expand Get create field metadata for a project and issue type id — response body — results array item
results (anyOf 2)	null	Alternative
startAt	JSON	Optional
startAt (anyOf 1)	JSON	Alternative
startAt (anyOf 1) (anyOf 1)	integer	Alternative	The index of the first item returned. Format: int64 Read only: true
startAt (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startAt (anyOf 2)	null	Alternative
total	JSON	Optional
total (anyOf 1)	JSON	Alternative
total (anyOf 1) (anyOf 1)	integer	Alternative	The total number of items in all pages. Format: int64 Read only: true
total (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total (anyOf 2)	null	Alternative

Referenced models: Get create field metadata for a project and issue type id — response body — results array item

Get create field metadata for a project and issue type id — response body — results array item

Field	Type	Presence	Description and constraints
$	object	Root	The metadata describing an issue field for createmeta.
allowedValues	JSON	Optional
allowedValues (anyOf 1)	array	Alternative	The list of values allowed in the field. Read only: true
allowedValues (anyOf 1)[]	JSON	Each item	Read only: true
allowedValues (anyOf 2)	null	Alternative
autoCompleteUrl	JSON	Optional
autoCompleteUrl (anyOf 1)	string	Alternative	The URL that can be used to automatically complete the field. Read only: true
autoCompleteUrl (anyOf 2)	null	Alternative
configuration	JSON	Optional
configuration (anyOf 1)	object	Alternative	The configuration properties. Read only: true Additional keys: see wildcard field
configuration (anyOf 1).*	JSON	Additional keys	Read only: true
configuration (anyOf 2)	null	Alternative
defaultValue	JSON	Optional
defaultValue (anyOf 1)	JSON	Alternative	The default value of the field. Read only: true
defaultValue (anyOf 2)	null	Alternative
fieldId	JSON	Optional
fieldId (anyOf 1)	string	Alternative	The field id. Read only: true
fieldId (anyOf 2)	null	Alternative
hasDefaultValue	JSON	Optional
hasDefaultValue (anyOf 1)	boolean	Alternative	Whether the field has a default value. Read only: true
hasDefaultValue (anyOf 2)	null	Alternative
key	JSON	Optional
key (anyOf 1)	string	Alternative	The key of the field. Read only: true
key (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the field. Read only: true
name (anyOf 2)	null	Alternative
operations	JSON	Optional
operations (anyOf 1)	array	Alternative	The list of operations that can be performed on the field. Read only: true
operations (anyOf 1)[]	string	Each item	Read only: true
operations (anyOf 2)	null	Alternative
required	JSON	Optional
required (anyOf 1)	boolean	Alternative	Whether the field is required. Read only: true
required (anyOf 2)	null	Alternative
schema	JSON	Optional
schema (anyOf 1)	Model	Alternative	Expand Create custom field — response body — schema The schema of a field The data type of the field. Read only: true
schema (anyOf 2)	null	Alternative

Referenced models: Create custom field — response body — schema The schema of a field

Get create issue metadata — response body

Field	Type	Presence	Description and constraints
$	object	Root	The wrapper for the issue creation metadata for a list of projects.
expand	JSON	Optional
expand (anyOf 1)	string	Alternative	Expand options that include additional project details in the response. Read only: true
expand (anyOf 2)	null	Alternative
projects	JSON	Optional
projects (anyOf 1)	array	Alternative	List of projects and their issue creation metadata. Read only: true
projects (anyOf 1)[]	Model	Each item	Expand Get create issue metadata — response body — projects List of projects and their issue creation metadata item
projects (anyOf 2)	null	Alternative

Referenced models: Get create issue metadata — response body — projects List of projects and their issue creation metadata item

Get create issue metadata — response body — projects List of projects and their issue creation metadata item

Field	Type	Presence	Description and constraints
$	object	Root	Details of the issue creation metadata for a project.
avatarUrls	JSON	Optional
avatarUrls (anyOf 1)	Model	Alternative	Expand Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48 List of the project's avatars, returning the avatar size and associated URL. Read only: true
avatarUrls (anyOf 2)	null	Alternative
expand	JSON	Optional
expand (anyOf 1)	string	Alternative	Expand options that include additional project issue create metadata details in the response. Read only: true
expand (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the project. Read only: true
id (anyOf 2)	null	Alternative
issuetypes	JSON	Optional
issuetypes (anyOf 1)	array	Alternative	List of the issue types supported by the project. Read only: true
issuetypes (anyOf 1)[]	Model	Each item	Expand Get create metadata issue types for a project — response body — create Meta Issue Type array item
issuetypes (anyOf 2)	null	Alternative
key	JSON	Optional
key (anyOf 1)	string	Alternative	The key of the project. Read only: true
key (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the project. Read only: true
name (anyOf 2)	null	Alternative
self	JSON	Optional
self (anyOf 1)	string	Alternative	The URL of the project. Read only: true
self (anyOf 2)	null	Alternative

Referenced models: Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48, Get create metadata issue types for a project — response body — create Meta Issue Type array item

Get create metadata issue types for a project — response body

Field	Type	Presence	Description and constraints
$	object	Root	A page of CreateMetaIssueTypes. Additional keys: allowed
createMetaIssueType	JSON	Optional
createMetaIssueType (anyOf 1)	array	Alternative	write Only: true
createMetaIssueType (anyOf 1)[]	Model	Each item	Expand Get create metadata issue types for a project — response body — create Meta Issue Type array item
createMetaIssueType (anyOf 2)	null	Alternative
issueTypes	JSON	Optional
issueTypes (anyOf 1)	array	Alternative	The list of CreateMetaIssueType. Read only: true
issueTypes (anyOf 1)[]	Model	Each item	Expand Get create metadata issue types for a project — response body — create Meta Issue Type array item
issueTypes (anyOf 2)	null	Alternative
maxResults	JSON	Optional
maxResults (anyOf 1)	JSON	Alternative
maxResults (anyOf 1) (anyOf 1)	integer	Alternative	The maximum number of items to return per page. Format: int32 Read only: true
maxResults (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maxResults (anyOf 2)	null	Alternative
startAt	JSON	Optional
startAt (anyOf 1)	JSON	Alternative
startAt (anyOf 1) (anyOf 1)	integer	Alternative	The index of the first item returned. Format: int64 Read only: true
startAt (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startAt (anyOf 2)	null	Alternative
total	JSON	Optional
total (anyOf 1)	JSON	Alternative
total (anyOf 1) (anyOf 1)	integer	Alternative	The total number of items in all pages. Format: int64 Read only: true
total (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total (anyOf 2)	null	Alternative

Referenced models: Get create metadata issue types for a project — response body — create Meta Issue Type array item

Get create metadata issue types for a project — response body — create Meta Issue Type array item

Field	Type	Presence	Description and constraints
$	object	Root	Details of the issue creation metadata for an issue type.
avatarId	JSON	Optional
avatarId (anyOf 1)	JSON	Alternative
avatarId (anyOf 1) (anyOf 1)	integer	Alternative	The ID of the issue type's avatar. Format: int64 Read only: true
avatarId (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
avatarId (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	The description of the issue type. Read only: true
description (anyOf 2)	null	Alternative
entityId	JSON	Optional
entityId (anyOf 1)	string	Alternative	Unique ID for next-gen projects. Format: uuid Read only: true
entityId (anyOf 2)	null	Alternative
expand	JSON	Optional
expand (anyOf 1)	string	Alternative	Expand options that include additional issue type metadata details in the response. Read only: true
expand (anyOf 2)	null	Alternative
fields	JSON	Optional
fields (anyOf 1)	object	Alternative	List of the fields available when creating an issue for the issue type. Read only: true Additional keys: see wildcard field
fields (anyOf 1).*	Model	Additional keys	Expand Get edit issue metadata — response body — fields object value
fields (anyOf 2)	null	Alternative
hierarchyLevel	JSON	Optional
hierarchyLevel (anyOf 1)	JSON	Alternative
hierarchyLevel (anyOf 1) (anyOf 1)	integer	Alternative	Hierarchy level of the issue type. Format: int32 Read only: true
hierarchyLevel (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hierarchyLevel (anyOf 2)	null	Alternative
iconUrl	JSON	Optional
iconUrl (anyOf 1)	string	Alternative	The URL of the issue type's avatar. Read only: true
iconUrl (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the issue type. Read only: true
id (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the issue type. Read only: true
name (anyOf 2)	null	Alternative
scope	JSON	Optional
scope (anyOf 1)	Model	Alternative	Expand Get status — response body — scope project, type Details of the next-gen projects the issue type is available in. Read only: true
scope (anyOf 2)	null	Alternative
self	JSON	Optional
self (anyOf 1)	string	Alternative	The URL of these issue type details. Read only: true
self (anyOf 2)	null	Alternative
subtask	JSON	Optional
subtask (anyOf 1)	boolean	Alternative	Whether this issue type is used to create subtasks. Read only: true
subtask (anyOf 2)	null	Alternative

Referenced models: Get edit issue metadata — response body — fields object value, Get status — response body — scope project, type

Get edit issue metadata — response body

Field	Type	Presence	Description and constraints
$	object	Root	A list of editable field details.
fields	JSON	Optional
fields (anyOf 1)	object	Alternative	Read only: true Additional keys: see wildcard field
fields (anyOf 1).*	Model	Additional keys	Expand Get edit issue metadata — response body — fields object value
fields (anyOf 2)	null	Alternative

Referenced models: Get edit issue metadata — response body — fields object value

Get edit issue metadata — response body — fields object value

Field	Type	Presence	Description and constraints
$	object	Root	The metadata describing an issue field.
allowedValues	JSON	Optional
allowedValues (anyOf 1)	array	Alternative	The list of values allowed in the field. Read only: true
allowedValues (anyOf 1)[]	JSON	Each item	Read only: true
allowedValues (anyOf 2)	null	Alternative
autoCompleteUrl	JSON	Optional
autoCompleteUrl (anyOf 1)	string	Alternative	The URL that can be used to automatically complete the field. Read only: true
autoCompleteUrl (anyOf 2)	null	Alternative
configuration	JSON	Optional
configuration (anyOf 1)	object	Alternative	The configuration properties. Read only: true Additional keys: see wildcard field
configuration (anyOf 1).*	JSON	Additional keys	Read only: true
configuration (anyOf 2)	null	Alternative
defaultValue	JSON	Optional
defaultValue (anyOf 1)	JSON	Alternative	The default value of the field. Read only: true
defaultValue (anyOf 2)	null	Alternative
hasDefaultValue	JSON	Optional
hasDefaultValue (anyOf 1)	boolean	Alternative	Whether the field has a default value. Read only: true
hasDefaultValue (anyOf 2)	null	Alternative
key	JSON	Optional
key (anyOf 1)	string	Alternative	The key of the field. Read only: true
key (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the field. Read only: true
name (anyOf 2)	null	Alternative
operations	JSON	Optional
operations (anyOf 1)	array	Alternative	The list of operations that can be performed on the field. Read only: true
operations (anyOf 1)[]	string	Each item	Read only: true
operations (anyOf 2)	null	Alternative
required	JSON	Optional
required (anyOf 1)	boolean	Alternative	Whether the field is required. Read only: true
required (anyOf 2)	null	Alternative
schema	JSON	Optional
schema (anyOf 1)	Model	Alternative	Expand Create custom field — response body — schema The schema of a field The data type of the field. Read only: true
schema (anyOf 2)	null	Alternative

Referenced models: Create custom field — response body — schema The schema of a field

Get events — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	Details about an issue event.
id	JSON	Optional
id (anyOf 1)	JSON	Alternative
id (anyOf 1) (anyOf 1)	integer	Alternative	The ID of the event. Format: int64 Read only: true
id (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the event. Read only: true
name (anyOf 2)	null	Alternative

Get issue limit report — response body

Field	Type	Presence	Description and constraints
$	object	Root
entitiesBreachingLimit	JSON	Optional
entitiesBreachingLimit (anyOf 1)	object	Alternative	For each field, the ids of the individual entities breaching the limit, grouped by the id or key of the issue they belong to. Fields that hold a single value, such as description and environment, map to an empty list because the issue itself identifies the breaching content Additional keys: see wildcard field
entitiesBreachingLimit (anyOf 1).*	object	Additional keys	Additional keys: see wildcard field
entitiesBreachingLimit (anyOf 1).*.*	array	Additional keys
entitiesBreachingLimit (anyOf 1).*.*[]	JSON	Each item
entitiesBreachingLimit (anyOf 1).*.*[] (anyOf 1)	integer	Alternative	Format: int64
entitiesBreachingLimit (anyOf 1).*.*[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
entitiesBreachingLimit (anyOf 2)	null	Alternative
issuesApproachingLimit	JSON	Optional
issuesApproachingLimit (anyOf 1)	object	Alternative	A list of ids of issues approaching the limit and their field count Additional keys: see wildcard field
issuesApproachingLimit (anyOf 1).*	object	Additional keys	Additional keys: see wildcard field
issuesApproachingLimit (anyOf 1).*.*	JSON	Additional keys
issuesApproachingLimit (anyOf 1).*.* (anyOf 1)	integer	Alternative	Format: int64
issuesApproachingLimit (anyOf 1).*.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issuesApproachingLimit (anyOf 2)	null	Alternative
issuesBreachingLimit	JSON	Optional
issuesBreachingLimit (anyOf 1)	object	Alternative	A list of ids of issues breaching the limit and their field count Additional keys: see wildcard field
issuesBreachingLimit (anyOf 1).*	object	Additional keys	Additional keys: see wildcard field
issuesBreachingLimit (anyOf 1).*.*	JSON	Additional keys
issuesBreachingLimit (anyOf 1).*.* (anyOf 1)	integer	Alternative	Format: int64
issuesBreachingLimit (anyOf 1).*.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issuesBreachingLimit (anyOf 2)	null	Alternative
limits	JSON	Optional
limits (anyOf 1)	object	Alternative	The fields and their defined limits Additional keys: see wildcard field
limits (anyOf 1).*	JSON	Additional keys
limits (anyOf 1).* (anyOf 1)	integer	Alternative	Format: int32
limits (anyOf 1).* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
limits (anyOf 2)	null	Alternative

Get issue — response body

Field	Type	Presence	Description and constraints
$	object	Root	Details about an issue.
changelog	JSON	Optional
changelog (anyOf 1)	Model	Alternative	Expand Get changelogs by I Ds — response body Details of changelogs associated with the issue. Read only: true
changelog (anyOf 2)	null	Alternative
editmeta	JSON	Optional
editmeta (anyOf 1)	Model	Alternative	Expand Get edit issue metadata — response body The metadata for the fields on the issue that can be amended. Read only: true
editmeta (anyOf 2)	null	Alternative
expand	JSON	Optional
expand (anyOf 1)	string	Alternative	Expand options that include additional issue details in the response. Read only: true
expand (anyOf 2)	null	Alternative
fields	JSON	Optional
fields (anyOf 1)	object	Alternative	Additional keys: see wildcard field
fields (anyOf 1).*	JSON	Additional keys
fields (anyOf 2)	null	Alternative
fieldsToInclude	JSON	Optional
fieldsToInclude (anyOf 1)	Model	Alternative	Expand Get issue — response body — fields To Include actually Included, excluded, included
fieldsToInclude (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the issue. Read only: true
id (anyOf 2)	null	Alternative
key	JSON	Optional
key (anyOf 1)	string	Alternative	The key of the issue. Read only: true
key (anyOf 2)	null	Alternative
names	JSON	Optional
names (anyOf 1)	object	Alternative	The ID and name of each field present on the issue. Read only: true Additional keys: see wildcard field
names (anyOf 1).*	string	Additional keys	Read only: true
names (anyOf 2)	null	Alternative
operations	JSON	Optional
operations (anyOf 1)	Model	Alternative	Expand Get issue — response body — operations link Groups The operations that can be performed on the issue. Read only: true
operations (anyOf 2)	null	Alternative
properties	JSON	Optional
properties (anyOf 1)	object	Alternative	Details of the issue properties identified in the request. Read only: true Additional keys: see wildcard field
properties (anyOf 1).*	JSON	Additional keys	Read only: true
properties (anyOf 2)	null	Alternative
renderedFields	JSON	Optional
renderedFields (anyOf 1)	object	Alternative	The rendered value of each field present on the issue. Read only: true Additional keys: see wildcard field
renderedFields (anyOf 1).*	JSON	Additional keys	Read only: true
renderedFields (anyOf 2)	null	Alternative
schema	JSON	Optional
schema (anyOf 1)	object	Alternative	The schema describing each field present on the issue. Read only: true Additional keys: see wildcard field
schema (anyOf 1).*	Model	Additional keys	Expand Create custom field — response body — schema The schema of a field
schema (anyOf 2)	null	Alternative
self	JSON	Optional
self (anyOf 1)	string	Alternative	The URL of the issue details. Format: uri Read only: true
self (anyOf 2)	null	Alternative
transitions	JSON	Optional
transitions (anyOf 1)	array	Alternative	The transitions that can be performed on the issue. Read only: true
transitions (anyOf 1)[]	Model	Each item	Expand Get transitions — response body — transitions List of issue transitions item
transitions (anyOf 2)	null	Alternative
versionedRepresentations	JSON	Optional
versionedRepresentations (anyOf 1)	object	Alternative	The versions of each field on the issue. Read only: true Additional keys: see wildcard field
versionedRepresentations (anyOf 1).*	object	Additional keys	Read only: true Additional keys: see wildcard field
versionedRepresentations (anyOf 1).*.*	JSON	Additional keys	Read only: true
versionedRepresentations (anyOf 2)	null	Alternative

Referenced models: Get issue — response body — fields To Include actually Included, excluded, included, Get transitions — response body — transitions List of issue transitions item, Get edit issue metadata — response body, Create custom field — response body — schema The schema of a field, Get issue — response body — operations link Groups, Get changelogs by I Ds — response body

Get issue — response body — fields To Include actually Included, excluded, included

Field	Type	Presence	Description and constraints
$	object	Root
actuallyIncluded	JSON	Optional
actuallyIncluded (anyOf 1)	array	Alternative	Unique items: true
actuallyIncluded (anyOf 1)[]	string	Each item
actuallyIncluded (anyOf 2)	null	Alternative
excluded	JSON	Optional
excluded (anyOf 1)	array	Alternative	Unique items: true
excluded (anyOf 1)[]	string	Each item
excluded (anyOf 2)	null	Alternative
included	JSON	Optional
included (anyOf 1)	array	Alternative	Unique items: true
included (anyOf 1)[]	string	Each item
included (anyOf 2)	null	Alternative

Get issue — response body — operations link Groups

Field	Type	Presence	Description and constraints
$	object	Root	Details of the operations that can be performed on the issue. Additional keys: allowed
linkGroups	JSON	Optional
linkGroups (anyOf 1)	array	Alternative	Details of the link groups defining issue operations. Read only: true
linkGroups (anyOf 1)[]	Model	Each item	Expand Get issue — response body — operations link Groups link Groups array item
linkGroups (anyOf 2)	null	Alternative

Referenced models: Get issue — response body — operations link Groups link Groups array item

Get issue — response body — operations link Groups link Groups array item

Field	Type	Presence	Description and constraints
$	object	Root	Details a link group, which defines issue operations.
groups	JSON	Optional
groups (anyOf 1)	array	Alternative
groups (anyOf 1)[]	Model	Each item	Expand Get issue — response body — operations link Groups link Groups array item
groups (anyOf 2)	null	Alternative
header	JSON	Optional
header (anyOf 1)	Model	Alternative	Expand Get version — response body — operations array item
header (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative
id (anyOf 2)	null	Alternative
links	JSON	Optional
links (anyOf 1)	array	Alternative
links (anyOf 1)[]	Model	Each item	Expand Get version — response body — operations array item
links (anyOf 2)	null	Alternative
styleClass	JSON	Optional
styleClass (anyOf 1)	string	Alternative
styleClass (anyOf 2)	null	Alternative
weight	JSON	Optional
weight (anyOf 1)	JSON	Alternative
weight (anyOf 1) (anyOf 1)	integer	Alternative	Format: int32
weight (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
weight (anyOf 2)	null	Alternative

Referenced models: Get issue — response body — operations link Groups link Groups array item, Get version — response body — operations array item

Get transitions — response body

Field	Type	Presence	Description and constraints
$	object	Root	List of issue transitions.
expand	JSON	Optional
expand (anyOf 1)	string	Alternative	Expand options that include additional transitions details in the response. Read only: true
expand (anyOf 2)	null	Alternative
transitions	JSON	Optional
transitions (anyOf 1)	array	Alternative	List of issue transitions. Read only: true
transitions (anyOf 1)[]	Model	Each item	Expand Get transitions — response body — transitions List of issue transitions item
transitions (anyOf 2)	null	Alternative

Referenced models: Get transitions — response body — transitions List of issue transitions item

Get transitions — response body — transitions List of issue transitions item

Field	Type	Presence	Description and constraints
$	object	Root	Details of an issue transition. Additional keys: allowed
expand	JSON	Optional
expand (anyOf 1)	string	Alternative	Expand options that include additional transition details in the response. Read only: true
expand (anyOf 2)	null	Alternative
fields	JSON	Optional
fields (anyOf 1)	object	Alternative	Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request. Read only: true Additional keys: see wildcard field
fields (anyOf 1).*	Model	Additional keys	Expand Get edit issue metadata — response body — fields object value
fields (anyOf 2)	null	Alternative
hasScreen	JSON	Optional
hasScreen (anyOf 1)	boolean	Alternative	Whether there is a screen associated with the issue transition. Read only: true
hasScreen (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the issue transition. Required when specifying a transition to undertake.
id (anyOf 2)	null	Alternative
isAvailable	JSON	Optional
isAvailable (anyOf 1)	boolean	Alternative	Whether the transition is available to be performed. Read only: true
isAvailable (anyOf 2)	null	Alternative
isConditional	JSON	Optional
isConditional (anyOf 1)	boolean	Alternative	Whether the issue has to meet criteria before the issue transition is applied. Read only: true
isConditional (anyOf 2)	null	Alternative
isGlobal	JSON	Optional
isGlobal (anyOf 1)	boolean	Alternative	Whether the issue transition is global, that is, the transition is applied to issues regardless of their status. Read only: true
isGlobal (anyOf 2)	null	Alternative
isInitial	JSON	Optional
isInitial (anyOf 1)	boolean	Alternative	Whether this is the initial issue transition for the workflow. Read only: true
isInitial (anyOf 2)	null	Alternative
looped	JSON	Optional
looped (anyOf 1)	boolean	Alternative
looped (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the issue transition. Read only: true
name (anyOf 2)	null	Alternative
to	JSON	Optional
to (anyOf 1)	Model	Alternative	Expand Get status — response body Details of the issue status after the transition. Read only: true
to (anyOf 2)	null	Alternative

Referenced models: Get edit issue metadata — response body — fields object value, Get status — response body

Send notification for issue — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Details about a notification. Additional keys: allowed
htmlBody	string	Optional	The HTML body of the email notification for the issue.
restrict	Model	Optional	Expand Send notification for issue — request body — body restrict Restricts the notifications to users with the specified permissions.
subject	string	Optional	The subject of the email notification for the issue. If this is not specified, then the subject is set to the issue key and summary.
textBody	string	Optional	The plain text body of the email notification for the issue.
to	Model	Optional	Expand Send notification for issue — request body — body to The recipients of the email notification for the issue.

Referenced models: Send notification for issue — request body — body to, Send notification for issue — request body — body restrict

Send notification for issue — request body — body restrict

Field	Type	Presence	Description and constraints
$	object	Root	Details of the group membership or permissions needed to receive the notification. Additional keys: not allowed
groupIds	array	Optional	List of groupId memberships required to receive the notification.
groupIds[]	string	Each item
groups	array	Optional	List of group memberships required to receive the notification.
groups[]	Model	Each item	Expand Send notification for issue — request body — body to groups item
permissions	array	Optional	List of permissions required to receive the notification.
permissions[]	Model	Each item	Expand Send notification for issue — request body — body restrict permissions item

Referenced models: Send notification for issue — request body — body to groups item, Send notification for issue — request body — body restrict permissions item

Send notification for issue — request body — body restrict permissions item

Field	Type	Presence	Description and constraints
$	object	Root	Details of the permission. Additional keys: allowed
id	string	Optional	The ID of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions.
key	string	Optional	The key of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions.

Send notification for issue — request body — body to

Field	Type	Presence	Description and constraints
$	object	Root	Details of the users and groups to receive the notification. Additional keys: allowed
assignee	boolean	Optional	Whether the notification should be sent to the issue's assignees.
groupIds	array	Optional	List of groupIds to receive the notification.
groupIds[]	string	Each item
groups	array	Optional	List of groups to receive the notification.
groups[]	Model	Each item	Expand Send notification for issue — request body — body to groups item
reporter	boolean	Optional	Whether the notification should be sent to the issue's reporter.
users	array	Optional	List of users to receive the notification.
users[]	Model	Each item	Expand Add comment — request body — body author
voters	boolean	Optional	Whether the notification should be sent to the issue's voters.
watchers	boolean	Optional	Whether the notification should be sent to the issue's watchers.

Referenced models: Send notification for issue — request body — body to groups item, Add comment — request body — body author

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

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