Private clientEnables admins to archive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) archived in the process and the errors encountered, if any.
Note that:
Permissions required: Jira admin or site admin: global permission
License required: Premium or Enterprise
Signed-in users only: This API can't be accessed anonymously.
Optional callback: undefinedEnables admins to archive up to 100,000 issues in a single request using JQL, returning the URL to check the status of the submitted request.
You can use the get task and cancel task APIs to manage the request.
Note that:
Permissions required: Jira admin or site admin: global permission
License required: Premium or Enterprise
Signed-in users only: This API can't be accessed anonymously.
Rate limiting: Only a single request per user can be active at any given time.
Enables admins to archive up to 100,000 issues in a single request using JQL, returning the URL to check the status of the submitted request.
You can use the get task and cancel task APIs to manage the request.
Note that:
Permissions required: Jira admin or site admin: global permission
License required: Premium or Enterprise
Signed-in users only: This API can't be accessed anonymously.
Rate limiting: Only a single request per user can be active at any given time.
Optional callback: undefinedAssigns an issue to a user. Use this operation when the calling user does not have the Edit Issues permission but has the Assign issue permission for the project that the issue is in.
If name or accountId is set to:
"-1", the issue is assigned to the default assignee for the project.null, the issue is set to unassigned.This operation can be accessed anonymously.
Permissions required:
Assigns an issue to a user. Use this operation when the calling user does not have the Edit Issues permission but has the Assign issue permission for the project that the issue is in.
If name or accountId is set to:
"-1", the issue is assigned to the default assignee for the project.null, the issue is set to unassigned.This operation can be accessed anonymously.
Permissions required:
Optional callback: undefinedCreates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be applied, to move the issue or subtask to a workflow step other than the default start step, and issue properties set.
The content of the issue or subtask is defined using update and fields. The fields that can be set in the issue
or subtask are determined using the Get create issue metadata. These are
the same fields that appear on the issue's create screen. Note that the description, environment, and any
textarea type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom
fields (textfield) accept a string and don't handle Atlassian Document Format content.
Creating a subtask differs from creating an issue as follows:
issueType must be set to a subtask issue type (use Get create issue
metadata to find subtask issue types).parent must contain the ID or key of the parent issue.In a next-gen project any issue may be made a child providing that the parent and child are members of the same project.
Permissions required: Browse projects and Create issues project permissions for the project in which the issue or subtask is created.
Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be applied, to move the issue or subtask to a workflow step other than the default start step, and issue properties set.
The content of the issue or subtask is defined using update and fields. The fields that can be set in the issue
or subtask are determined using the Get create issue metadata. These are
the same fields that appear on the issue's create screen. Note that the description, environment, and any
textarea type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom
fields (textfield) accept a string and don't handle Atlassian Document Format content.
Creating a subtask differs from creating an issue as follows:
issueType must be set to a subtask issue type (use Get create issue
metadata to find subtask issue types).parent must contain the ID or key of the parent issue.In a next-gen project any issue may be made a child providing that the parent and child are members of the same project.
Permissions required: Browse projects and Create issues project permissions for the project in which the issue or subtask is created.
Optional callback: undefinedCreates upto 50 issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may be applied, to move the issues or subtasks to a workflow step other than the default start step, and issue properties set.
The content of each issue or subtask is defined using update and fields. The fields that can be set in the
issue or subtask are determined using the Get create issue metadata. These
are the same fields that appear on the issues' create screens. Note that the description, environment, and any
textarea type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom
fields (textfield) accept a string and don't handle Atlassian Document Format content.
Creating a subtask differs from creating an issue as follows:
issueType must be set to a subtask issue type (use Get create issue
metadata to find subtask issue types).parent the must contain the ID or key of the parent issue.Permissions required: Browse projects and Create issues project permissions for the project in which each issue or subtask is created.
Creates upto 50 issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may be applied, to move the issues or subtasks to a workflow step other than the default start step, and issue properties set.
The content of each issue or subtask is defined using update and fields. The fields that can be set in the
issue or subtask are determined using the Get create issue metadata. These
are the same fields that appear on the issues' create screens. Note that the description, environment, and any
textarea type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom
fields (textfield) accept a string and don't handle Atlassian Document Format content.
Creating a subtask differs from creating an issue as follows:
issueType must be set to a subtask issue type (use Get create issue
metadata to find subtask issue types).parent the must contain the ID or key of the parent issue.Permissions required: Browse projects and Create issues project permissions for the project in which each issue or subtask is created.
Optional parameters: Version3.Version3Parameters.CreateIssuesOptional callback: undefinedDeletes an issue.
An issue cannot be deleted if it has one or more subtasks. To delete an issue with subtasks, set deleteSubtasks.
This causes the issue's subtasks to be deleted with the issue.
This operation can be accessed anonymously.
Permissions required:
Deletes an issue.
An issue cannot be deleted if it has one or more subtasks. To delete an issue with subtasks, set deleteSubtasks.
This causes the issue's subtasks to be deleted with the issue.
This operation can be accessed anonymously.
Permissions required:
Optional callback: undefinedPerforms an issue transition and, if the transition has a screen, updates the fields from the transition screen.
SortByCategory To update the fields on the transition screen, specify the fields in the fields or update
parameters in the request body. Get details about the fields using Get
transitions with the transitions.fields expand.
This operation can be accessed anonymously.
Permissions required:
Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.
SortByCategory To update the fields on the transition screen, specify the fields in the fields or update
parameters in the request body. Get details about the fields using Get
transitions with the transitions.fields expand.
This operation can be accessed anonymously.
Permissions required:
Optional callback: undefinedEdits an issue. A transition may be applied and issue properties updated as part of the edit.
The edits to the issue's fields are defined using update and fields. The fields that can be edited are
determined using Get edit issue metadata.
The parent field may be set by key or ID. For standard issue types, the parent may be removed by setting
update.parent.set.none to true. Note that the description, environment, and any textarea type custom
fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (textfield)
accept a string and don't handle Atlassian Document Format content.
Connect apps having an app user with Administer Jira global
permission, and Forge apps acting on behalf of users with Administer
Jira global permission, can override the screen security
configuration using overrideScreenSecurity and overrideEditableFlag.
This operation can be accessed anonymously.
Permissions required:
Edits an issue. A transition may be applied and issue properties updated as part of the edit.
The edits to the issue's fields are defined using update and fields. The fields that can be edited are
determined using Get edit issue metadata.
The parent field may be set by key or ID. For standard issue types, the parent may be removed by setting
update.parent.set.none to true. Note that the description, environment, and any textarea type custom
fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (textfield)
accept a string and don't handle Atlassian Document Format content.
Connect apps having an app user with Administer Jira global
permission, and Forge apps acting on behalf of users with Administer
Jira global permission, can override the screen security
configuration using overrideScreenSecurity and overrideEditableFlag.
This operation can be accessed anonymously.
Permissions required:
Optional callback: undefinedEnables admins to retrieve details of all archived issues. Upon a successful request, the admin who submitted it will receive an email with a link to download a CSV file with the issue details.
Note that this API only exports the values of system fields and archival-specific fields (ArchivedBy and
ArchivedDate). Custom fields aren't supported.
Permissions required: Jira admin or site admin: global permission
License required: Premium or Enterprise
Signed-in users only: This API can't be accessed anonymously.
Rate limiting: Only a single request can be active at any given time.
Enables admins to retrieve details of all archived issues. Upon a successful request, the admin who submitted it will receive an email with a link to download a CSV file with the issue details.
Note that this API only exports the values of system fields and archival-specific fields (ArchivedBy and
ArchivedDate). Custom fields aren't supported.
Permissions required: Jira admin or site admin: global permission
License required: Premium or Enterprise
Signed-in users only: This API can't be accessed anonymously.
Rate limiting: Only a single request can be active at any given time.
Optional parameters: Version3.Version3Parameters.ExportArchivedIssuesOptional callback: undefinedReturns a paginated list of all changelogs for an issue sorted by date, starting from the oldest.
This operation can be accessed anonymously.
Permissions required:
Returns a paginated list of all changelogs for an issue sorted by date, starting from the oldest.
This operation can be accessed anonymously.
Permissions required:
Optional callback: undefinedReturns changelogs for an issue specified by a list of changelog IDs.
This operation can be accessed anonymously.
Permissions required:
Returns changelogs for an issue specified by a list of changelog IDs.
This operation can be accessed anonymously.
Permissions required:
Optional callback: undefinedReturns details of projects, issue types within projects, and, when requested, the create screen fields for each issue type for the user. Use the information to populate the requests in Create issue and Create issues.
The request can be restricted to specific projects or issue types using the query parameters. The response will contain information for the valid projects, issue types, or project and issue type combinations requested. Note that invalid project, issue type, or project and issue type combinations do not generate errors.
This operation can be accessed anonymously.
Permissions required: Create issues project permission in the requested projects.
Returns details of projects, issue types within projects, and, when requested, the create screen fields for each issue type for the user. Use the information to populate the requests in Create issue and Create issues.
The request can be restricted to specific projects or issue types using the query parameters. The response will contain information for the valid projects, issue types, or project and issue type combinations requested. Note that invalid project, issue type, or project and issue type combinations do not generate errors.
This operation can be accessed anonymously.
Permissions required: Create issues project permission in the requested projects.
Optional parameters: Version3.Version3Parameters.GetCreateIssueMetaOptional callback: undefinedReturns the edit screen fields for an issue that are visible to and editable by the user. Use the information to populate the requests in Edit issue.
This endpoint will check for these conditions:
overrideScreenSecurity=true skips this condition.overrideScreenSecurity=true skips this condition.overrideEditableFlag=true skips this condition.jira.issue.editable property to false. overrideEditableFlag=true skips this condition.jira.permission.* workflow properties.Fields hidden using Issue layout settings page remain editable.
Connect apps having an app user with Administer Jira global permission, and Forge apps acting on behalf of users with Administer Jira global permission, can return additional details using:
overrideScreenSecurity When this flag is true, then this endpoint skips checking if fields are available
through screens, and field configuration (conditions 1. and 2. from the list above).overrideEditableFlag When this flag is true, then this endpoint skips checking if workflow is present and if
the current step is editable (conditions 6. and 7. from the list above).This operation can be accessed anonymously.
Permissions required:
Note: For any fields to be editable the user must have the Edit issues project permission for the issue.
Returns the edit screen fields for an issue that are visible to and editable by the user. Use the information to populate the requests in Edit issue.
This endpoint will check for these conditions:
overrideScreenSecurity=true skips this condition.overrideScreenSecurity=true skips this condition.overrideEditableFlag=true skips this condition.jira.issue.editable property to false. overrideEditableFlag=true skips this condition.jira.permission.* workflow properties.Fields hidden using Issue layout settings page remain editable.
Connect apps having an app user with Administer Jira global permission, and Forge apps acting on behalf of users with Administer Jira global permission, can return additional details using:
overrideScreenSecurity When this flag is true, then this endpoint skips checking if fields are available
through screens, and field configuration (conditions 1. and 2. from the list above).overrideEditableFlag When this flag is true, then this endpoint skips checking if workflow is present and if
the current step is editable (conditions 6. and 7. from the list above).This operation can be accessed anonymously.
Permissions required:
Note: For any fields to be editable the user must have the Edit issues project permission for the issue.
Optional callback: undefinedReturns all issue events.
Permissions required: Administer Jira global permission.
Returns all issue events.
Permissions required: Administer Jira global permission.
Optional callback: undefinedReturns the details for an issue.
The issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is not returned. The issue key returned in the response is the key of the issue found.
This operation can be accessed anonymously.
Permissions required:
Returns the details for an issue.
The issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is not returned. The issue key returned in the response is the key of the issue found.
This operation can be accessed anonymously.
Permissions required:
Optional callback: undefinedReturns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status.
Note, if a request is made for a transition that does not exist or cannot be performed on the issue, given its status, the response will return any empty transitions list.
This operation can be accessed anonymously.
Permissions required: A list or transition is returned only when the user has:
However, if the user does not have the Transition issues project permission the response will not list any transitions.
Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status.
Note, if a request is made for a transition that does not exist or cannot be performed on the issue, given its status, the response will return any empty transitions list.
This operation can be accessed anonymously.
Permissions required: A list or transition is returned only when the user has:
However, if the user does not have the Transition issues project permission the response will not list any transitions.
Optional callback: undefinedCreates an email notification for an issue and adds it to the mail queue.
Permissions required:
Creates an email notification for an issue and adds it to the mail queue.
Permissions required:
Optional callback: undefinedEnables admins to unarchive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) unarchived in the process and the errors encountered, if any.
Note that:
Permissions required: Jira admin or site admin: global permission
License required: Premium or Enterprise
Signed-in users only: This API can't be accessed anonymously.
Enables admins to unarchive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) unarchived in the process and the errors encountered, if any.
Note that:
Permissions required: Jira admin or site admin: global permission
License required: Premium or Enterprise
Signed-in users only: This API can't be accessed anonymously.
Optional callback: undefined
Enables admins to archive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) archived in the process and the errors encountered, if any.
Note that:
Permissions required: Jira admin or site admin: global permission
License required: Premium or Enterprise
Signed-in users only: This API can't be accessed anonymously.