atlassian.com – jira

Tools (489)

Extracted live via the executor SDK.

• announcementBanner.getBanner

  Returns the current announcement banner configuration.

  Permissions required: Administer Jira global permission.

• announcementBanner.setBanner

  Updates the announcement banner configuration.

  Permissions required: Administer Jira global permission.

• applicationRoles.getAllApplicationRoles

  Returns all application roles. In Jira, application roles are managed using the Application access configuration page.

  Permissions required: Administer Jira global permission.

• applicationRoles.getApplicationRole

  Returns an application role.

  Permissions required: Administer Jira global permission.

• appMigration.appIssueFieldValueUpdateResourceUpdateIssueFieldsPut

  Updates the value of a custom field added by Connect apps on one or more issues. The values of up to 200 custom fields can be updated.

  Permissions required: Only Connect apps can make this request.

• appMigration.migrationResourceUpdateEntityPropertiesValuePut

  Updates the values of multiple entity properties for an object, up to 50 updates per request. This operation is for use by Connect apps during app migration.

• appMigration.migrationResourceWorkflowRuleSearchPost

  Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling Connect app.

• appProperties.addonPropertiesResourceDeleteAddonPropertyDelete

  Deletes an app's property.

  Permissions required: Only a Connect app whose key matches addonKey can make this request.

• appProperties.addonPropertiesResourceGetAddonPropertiesGet

  Gets all the properties of an app.

  Permissions required: Only a Connect app whose key matches addonKey can make this request. Additionally, Forge apps published on the Marketplace can access properties of Connect apps they were migrated from.

• appProperties.addonPropertiesResourceGetAddonPropertyGet

  Returns the key and value of an app's property.

  Permissions required: Only a Connect app whose key matches addonKey can make this request. Additionally, Forge apps published on the Marketplace can access properties of Connect apps they were migrated from.

• appProperties.addonPropertiesResourcePutAddonPropertyPut

  Sets the value of an app's property. Use this resource to store custom data for your app.

  The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

  Permissions required: Only a Connect app whose key matches addonKey can make this request.

• auditRecords.getAuditRecords

  Returns a list of audit records. The list can be filtered to include items:

  • where each item in filter has at least one match in any of these fields:

    • summary
    • category
    • eventSource
    • objectItem.name If the object is a user, account ID is available to filter.
    • objectItem.parentName
    • objectItem.typeName
    • changedValues.changedFrom
    • changedValues.changedTo
    • remoteAddress

    For example, if filter contains man ed, an audit record containing summary": "User added to group" and "category": "group management" is returned.

  • created on or after a date and time.

  • created or or before a date and time.

  Permissions required: Administer Jira global permission.

• avatars.deleteAvatar

  Deletes an avatar from a project or issue type.

  Permissions required: Administer Jira global permission.

• avatars.getAllSystemAvatars

  Returns a list of system avatar details by owner type, where the owner types are issue type, project, or user.

  This operation can be accessed anonymously.

  Permissions required: None.

• avatars.getAvatarImageById

  Returns a project or issue type avatar image by ID.

  This operation can be accessed anonymously.

  Permissions required:

  • For system avatars, none.
  • For custom project avatars, Browse projects project permission for the project the avatar belongs to.
  • For custom issue type avatars, Browse projects project permission for at least one project the issue type is used in.
• avatars.getAvatarImageByOwner

  Returns the avatar image for a project or issue type.

  This operation can be accessed anonymously.

  Permissions required:

  • For system avatars, none.
  • For custom project avatars, Browse projects project permission for the project the avatar belongs to.
  • For custom issue type avatars, Browse projects project permission for at least one project the issue type is used in.
• avatars.getAvatarImageByType

  Returns the default project or issue type avatar image.

  This operation can be accessed anonymously.

  Permissions required: None.

• avatars.getAvatars

  Returns the system and custom avatars for a project or issue type.

  This operation can be accessed anonymously.

  Permissions required:

  • for custom project avatars, Browse projects project permission for the project the avatar belongs to.
  • for custom issue type avatars, Browse projects project permission for at least one project the issue type is used in.
  • for system avatars, none.
• avatars.storeAvatar

  Loads a custom avatar for a project or issue type.

  Specify the avatar's local file location in the body of the request. Also, include the following headers:

  • X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers.
  • Content-Type: image/image type Valid image types are JPEG, GIF, or PNG.

  For example:
  curl --request POST

  --user email@example.com:<api_token>

  --header 'X-Atlassian-Token: no-check'

  --header 'Content-Type: image/< image_type>'

  --data-binary "<@/path/to/file/with/your/avatar>"

  --url 'https://your-domain.atlassian.net/rest/api/3/universal_avatar/type/{type}/owner/{entityId}'

  The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.

  The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.

  After creating the avatar use:

  • Update issue type to set it as the issue type's displayed avatar.
  • Set project avatar to set it as the project's displayed avatar.

  Permissions required: Administer Jira global permission.

• dashboards.addGadget

  Adds a gadget to a dashboard.

  Permissions required: None.

• dashboards.copyDashboard

  Copies a dashboard. Any values provided in the dashboard parameter replace those in the copied dashboard.

  Permissions required: None

  The dashboard to be copied must be owned by or shared with the user.

• dashboards.createDashboard

  Creates a dashboard.

  Permissions required: None.

• dashboards.deleteDashboard

  Deletes a dashboard.

  Permissions required: None

  The dashboard to be deleted must be owned by the user.

• dashboards.deleteDashboardItemProperty

  Deletes a dashboard item property.

  This operation can be accessed anonymously.

  Permissions required: The user must be the owner of the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard.

• dashboards.getAllAvailableDashboardGadgets

  Gets a list of all available gadgets that can be added to all dashboards.

  Permissions required: None.

• dashboards.getAllDashboards

  Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

  This operation can be accessed anonymously.

  Permissions required: None.

• dashboards.getAllGadgets

  Returns a list of dashboard gadgets on a dashboard.

  This operation returns:

  • Gadgets from a list of IDs, when id is set.
  • Gadgets with a module key, when moduleKey is set.
  • Gadgets from a list of URIs, when uri is set.
  • All gadgets, when no other parameters are set.

  This operation can be accessed anonymously.

  Permissions required: None.

• dashboards.getDashboard

  Returns a dashboard.

  This operation can be accessed anonymously.

  Permissions required: None.

  However, to get a dashboard, the dashboard must be shared with the user or the user must own it. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.

• dashboards.getDashboardItemProperty

  Returns the key and value of a dashboard item property.

  A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgets.

  When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item's content or configuration details. For more information on working with dashboard items, see Building a dashboard item for a JIRA Connect add-on and the Dashboard Item documentation.

  There is no resource to set or get dashboard items.

  This operation can be accessed anonymously.

  Permissions required: The user must be the owner of the dashboard or have the dashboard shared with them. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users, and is accessible to anonymous users when Jira’s anonymous access is permitted.

• dashboards.getDashboardItemPropertyKeys

  Returns the keys of all properties for a dashboard item.

  This operation can be accessed anonymously.

  Permissions required: The user must be the owner of the dashboard or have the dashboard shared with them. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users, and is accessible to anonymous users when Jira’s anonymous access is permitted.

• dashboards.getDashboardsPaginated

  Returns a paginated list of dashboards. This operation is similar to Get dashboards except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned.

  This operation can be accessed anonymously.

  Permissions required: The following dashboards that match the query parameters are returned:

  • Dashboards owned by the user. Not returned for anonymous users.
  • Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
  • Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
  • Dashboards shared with a public project.
  • Dashboards shared with the public.
• dashboards.removeGadget

  Removes a dashboard gadget from a dashboard.

  When a gadget is removed from a dashboard, other gadgets in the same column are moved up to fill the emptied position.

  Permissions required: None.

• dashboards.setDashboardItemProperty

  Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.

  A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgets.

  When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item's content or configuration details. For more information on working with dashboard items, see Building a dashboard item for a JIRA Connect add-on and the Dashboard Item documentation.

  There is no resource to set or get dashboard items.

  The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

  This operation can be accessed anonymously.

  Permissions required: The user must be the owner of the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard.

• dashboards.updateDashboard

  Updates a dashboard, replacing all the dashboard details with those provided.

  Permissions required: None

  The dashboard to be updated must be owned by the user.

• dashboards.updateGadget

  Changes the title, position, and color of the gadget on a dashboard.

  Permissions required: None.

• dynamicModules.dynamicModulesResourceGetModulesGet

  Returns all modules registered dynamically by the calling app.

  Permissions required: Only Connect apps can make this request.

• dynamicModules.dynamicModulesResourceRegisterModulesPost

  Registers a list of modules.

  Permissions required: Only Connect apps can make this request.

• dynamicModules.dynamicModulesResourceRemoveModulesDelete

  Remove all or a list of modules registered by the calling app.

  Permissions required: Only Connect apps can make this request.

• filters.changeFilterOwner

  Changes the owner of the filter.

  Permissions required: Permission to access Jira. However, the user must own the filter or have the Administer Jira global permission.

• filters.createFilter

  Creates a filter. The filter is shared according to the default share scope. The filter is not selected as a favorite.

  Permissions required: Permission to access Jira.

• filters.deleteFavouriteForFilter

  Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user's favorites list. For example, if the user favorites a public filter that is subsequently made private (and is therefore no longer visible on their favorites list) they cannot remove it from their favorites list.

  Permissions required: Permission to access Jira.

• filters.deleteFilter

  Delete a filter.

  Permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permission.

• filters.getColumns

  Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in List View with the Columns set to Filter.

  This operation can be accessed anonymously.

  Permissions required: None, however, column details are only returned for:

  • filters owned by the user.
  • filters shared with a group that the user is a member of.
  • filters shared with a private project that the user has Browse projects project permission for.
  • filters shared with a public project.
  • filters shared with the public.
• filters.getFavouriteFilters

  Returns the visible favorite filters of the user.

  This operation can be accessed anonymously.

  Permissions required: A favorite filter is only visible to the user where the filter is:

  • owned by the user.
  • shared with a group that the user is a member of.
  • shared with a private project that the user has Browse projects project permission for.
  • shared with a public project.
  • shared with the public.

  For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

• filters.getFilter

  Returns a filter.

  This operation can be accessed anonymously.

  Permissions required: None, however, the filter is only returned where it is:

  • owned by the user.
  • shared with a group that the user is a member of.
  • shared with a private project that the user has Browse projects project permission for.
  • shared with a public project.
  • shared with the public.
• filters.getFilters

  Returns all filters. Deprecated, use Search for filters that supports search and pagination.

  This operation can be accessed anonymously.

  Permissions required: None, however, only the following filters are returned:

  • filters owned by the user.
  • filters shared with a group that the user is a member of.
  • filters shared with a private project that the user has Browse projects project permission for.
  • filters shared with a public project.
  • filters shared with the public.
• filters.getFiltersPaginated

  Returns a paginated list of filters. Use this operation to get:

  • specific filters, by defining id only.
  • filters that match all of the specified attributes. For example, all filters for a user with a particular word in their name. When multiple attributes are specified only filters matching all attributes are returned.

  This operation can be accessed anonymously.

  Permissions required: None, however, only the following filters that match the query parameters are returned:

  • filters owned by the user.
  • filters shared with a group that the user is a member of.
  • filters shared with a private project that the user has Browse projects project permission for.
  • filters shared with a public project.
  • filters shared with the public.
• filters.getMyFilters

  Returns the filters owned by the user. If includeFavourites is true, the user's visible favorite filters are also returned.

  Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

  • owned by the user.
  • shared with a group that the user is a member of.
  • shared with a private project that the user has Browse projects project permission for.
  • shared with a public project.
  • shared with the public.

  For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

• filters.resetColumns

  Reset the user's column configuration for the filter to the default.

  Permissions required: Permission to access Jira, however, columns are only reset for:

  • filters owned by the user.
  • filters shared with a group that the user is a member of.
  • filters shared with a private project that the user has Browse projects project permission for.
  • filters shared with a public project.
  • filters shared with the public.
• filters.setColumns

  Sets the columns for a filter. Only navigable fields can be set as columns. Use Get fields to get the list fields in Jira. A navigable field has navigable set to true.

  The parameters for this resource are expressed as HTML form data. For example, in curl:

  curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/filter/10000/columns

  Permissions required: Permission to access Jira, however, columns are only set for:

  • filters owned by the user.
  • filters shared with a group that the user is a member of.
  • filters shared with a private project that the user has Browse projects project permission for.
  • filters shared with a public project.
  • filters shared with the public.
• filters.setFavouriteForFilter

  Add a filter as a favorite for the user.

  Permissions required: Permission to access Jira, however, the user can only favorite:

  • filters owned by the user.
  • filters shared with a group that the user is a member of.
  • filters shared with a private project that the user has Browse projects project permission for.
  • filters shared with a public project.
  • filters shared with the public.
• filters.updateFilter

  Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

  Permissions required: Permission to access Jira, however the user must own the filter.

• filterSharing.addSharePermission

  Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

  Be aware that this operation uses different objects for updating share permissions compared to Update filter.

  Permissions required: Share dashboards and filters global permission and the user must own the filter.

• filterSharing.deleteSharePermission

  Deletes a share permission from a filter.

  Permissions required: Permission to access Jira and the user must own the filter.

• filterSharing.getDefaultShareScope

  Returns the default sharing settings for new filters and dashboards for a user.

  Permissions required: Permission to access Jira.

• filterSharing.getSharePermission

  Returns a share permission for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.

  This operation can be accessed anonymously.

  Permissions required: None, however, a share permission is only returned for:

  • filters owned by the user.
  • filters shared with a group that the user is a member of.
  • filters shared with a private project that the user has Browse projects project permission for.
  • filters shared with a public project.
  • filters shared with the public.
• filterSharing.getSharePermissions

  Returns the share permissions for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.

  This operation can be accessed anonymously.

  Permissions required: None, however, share permissions are only returned for:

  • filters owned by the user.
  • filters shared with a group that the user is a member of.
  • filters shared with a private project that the user has Browse projects project permission for.
  • filters shared with a public project.
  • filters shared with the public.
• filterSharing.setDefaultShareScope

  Sets the default sharing for new filters and dashboards for a user.

  Permissions required: Permission to access Jira.

• groupAndUserPicker.findUsersAndGroups

  Returns a list of users and groups matching a string. The string is used:

  • for users, to find a case-insensitive match with display name and e-mail address. Note that if a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.
  • for groups, to find a case-sensitive match with group name.

  For example, if the string tin is used, records with the display name Tina, email address sarah@tinplatetraining.com, and the group accounting would be returned.

  Optionally, the search can be refined to:

  • the projects and issue types associated with a custom field, such as a user picker. The search can then be further refined to return only users and groups that have permission to view specific:

    • projects.
    • issue types.

    If multiple projects or issue types are specified, they must be a subset of those enabled for the custom field or no results are returned. For example, if a field is enabled for projects A, B, and C then the search could be limited to projects B and C. However, if the search is limited to projects B and D, nothing is returned.

  • not return Connect app users and groups.

  • return groups that have a case-insensitive match with the query.

  The primary use case for this resource is to populate a picker field suggestion list with users or groups. To this end, the returned object includes an html field for each list. This field highlights the matched query term in the item name with the HTML strong tag. Also, each list is wrapped in a response object that contains a header for use in a picker, specifically Showing X of Y matching groups.

  This operation can be accessed anonymously.

  Permissions required: Browse users and groups global permission.

• groups.addUserToGroup

  Adds a user to a group.

  Permissions required: Site administration (that is, member of the site-admin group).

• groups.bulkGetGroups

  Returns a paginated list of groups.

  Permissions required: Browse users and groups global permission.

• groups.createGroup

  Creates a group.

  Permissions required: Site administration (that is, member of the site-admin group).

• groups.findGroups

  Returns a list of groups whose names contain a query string. A list of group names can be provided to exclude groups from the results.

  The primary use case for this resource is to populate a group picker suggestions list. To this end, the returned object includes the html field where the matched query term is highlighted in the group name with the HTML strong tag. Also, the groups list is wrapped in a response object that contains a header for use in the picker, specifically Showing X of Y matching groups.

  The list returns with the groups sorted. If no groups match the list criteria, an empty list is returned.

  This operation can be accessed anonymously.

  Permissions required: Browse projects project permission. Anonymous calls and calls by users without the required permission return an empty list.

  Browse users and groups global permission. Without this permission, calls where query is not an exact match to an existing group will return an empty list.

• groups.getGroup

  This operation is deprecated, use group/member.

  Returns all users in a group.

  Permissions required: Administer Jira global permission.

• groups.getUsersFromGroup

  Returns a paginated list of all users in a group.

  Note that users are ordered by username, however the username is not returned in the results due to privacy reasons.

  Permissions required: Administer Jira global permission.

• groups.removeGroup

  Deletes a group.

  Permissions required: Site administration (that is, member of the site-admin strategic group).

• groups.removeUserFromGroup

  Removes a user from a group.

  Permissions required: Site administration (that is, member of the site-admin group).

• instanceInformation.getLicense

  Returns licensing information about the Jira instance.

  Permissions required: None.

• issueAttachments.addAttachment

  Adds one or more attachments to an issue. Attachments are posted as multipart/form-data (RFC 1867).

  Note that:

  • The request must have a X-Atlassian-Token: no-check header, if not it is blocked. See Special headers for more information.
  • The name of the multipart/form-data parameter that contains the attachments must be file.

  The following examples upload a file called myfile.txt to the issue TEST-123:

  curl

  curl --location --request POST 'https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachments' -u 'email@example.com:<api_token>' -H 'X-Atlassian-Token: no-check' --form 'file=@"myfile.txt"'

  Node.js

  // This code sample uses the 'node-fetch' and 'form-data' libraries: // https://www.npmjs.com/package/node-fetch // https://www.npmjs.com/package/form-data const fetch = require('node-fetch'); const FormData = require('form-data'); const fs = require('fs');
   const filePath = 'myfile.txt'; const form = new FormData(); const stats = fs.statSync(filePath); const fileSizeInBytes = stats.size; const fileStream = fs.createReadStream(filePath);
   form.append('file', fileStream, {knownLength: fileSizeInBytes});
   fetch('https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachments', {     method: 'POST',     body: form,     headers: {         'Authorization': `Basic ${Buffer.from(             'email@example.com:'         ).toString('base64')}`,         'Accept': 'application/json',         'X-Atlassian-Token': 'no-check'     } })     .then(response => {         console.log(             `Response: ${response.status} ${response.statusText}`         );         return response.text();     })     .then(text => console.log(text))     .catch(err => console.error(err));

  Java

  // This code sample uses the  'Unirest' library: // http://unirest.io/java.html HttpResponse response = Unirest.post("https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments")         .basicAuth("email@example.com", "")         .header("Accept", "application/json")         .header("X-Atlassian-Token", "no-check")         .field("file", new File("myfile.txt"))         .asJson();
           System.out.println(response.getBody());

  Python

  # This code sample uses the 'requests' library: # http://docs.python-requests.org import requests from requests.auth import HTTPBasicAuth import json
   url = "https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments"
   auth = HTTPBasicAuth("email@example.com", "")
   headers = {    "Accept": "application/json",    "X-Atlassian-Token": "no-check" }
   response = requests.request(    "POST",    url,    headers = headers,    auth = auth,    files = {         "file": ("myfile.txt", open("myfile.txt","rb"), "application-type")    } )
   print(json.dumps(json.loads(response.text), sort_keys=True, indent=4, separators=(",", ": ")))

  PHP

  // This code sample uses the 'Unirest' library: // http://unirest.io/php.html Unirest\Request::auth('email@example.com', '');
   $headers = array(   'Accept' => 'application/json',   'X-Atlassian-Token' => 'no-check' );
   $parameters = array(   'file' => File::add('myfile.txt') );
   $response = Unirest\Request::post(   'https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments',   $headers,   $parameters );
   var_dump($response)

  Forge

  // This sample uses Atlassian Forge and the `form-data` library. // https://developer.atlassian.com/platform/forge/ // https://www.npmjs.com/package/form-data import api from "@forge/api"; import FormData from "form-data";
   const form = new FormData(); form.append('file', fileStream, {knownLength: fileSizeInBytes});
   const response = await api.asApp().requestJira('/rest/api/2/issue/{issueIdOrKey}/attachments', {     method: 'POST',     body: form,     headers: {         'Accept': 'application/json',         'X-Atlassian-Token': 'no-check'     } });
   console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());

  Tip: Use a client library. Many client libraries have classes for handling multipart POST operations. For example, in Java, the Apache HTTP Components library provides a MultiPartEntity class for multipart POST operations.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse Projects and Create attachments project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueAttachments.expandAttachmentForHumans

  Returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned and metadata for the ZIP archive. Currently, only the ZIP archive format is supported.

  Use this operation to retrieve data that is presented to the user, as this operation returns the metadata for the attachment itself, such as the attachment's ID and name. Otherwise, use Get contents metadata for an expanded attachment, which only returns the metadata for the attachment's contents.

  This operation can be accessed anonymously.

  Permissions required: For the issue containing the attachment:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueAttachments.expandAttachmentForMachines

  Returns the metadata for the contents of an attachment, if it is an archive. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned. Currently, only the ZIP archive format is supported.

  Use this operation if you are processing the data without presenting it to the user, as this operation only returns the metadata for the contents of the attachment. Otherwise, to retrieve data to present to the user, use Get all metadata for an expanded attachment which also returns the metadata for the attachment itself, such as the attachment's ID and name.

  This operation can be accessed anonymously.

  Permissions required: For the issue containing the attachment:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueAttachments.getAttachment

  Returns the metadata for an attachment. Note that the attachment itself is not returned.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueAttachments.getAttachmentContent

  Returns the contents of an attachment. A Range header can be set to define a range of bytes within the attachment to download. See the HTTP Range header standard for details.

  To return a thumbnail of the attachment, use Get attachment thumbnail.

  This operation can be accessed anonymously.

  Permissions required: For the issue containing the attachment:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueAttachments.getAttachmentMeta

  Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed.

  Note that there are also project permissions that restrict whether users can create and delete attachments.

  This operation can be accessed anonymously.

  Permissions required: None.

• issueAttachments.getAttachmentThumbnail

  Returns the thumbnail of an attachment.

  To return the attachment contents, use Get attachment content.

  This operation can be accessed anonymously.

  Permissions required: For the issue containing the attachment:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueAttachments.removeAttachment

  Deletes an attachment from an issue.

  This operation can be accessed anonymously.

  Permissions required: For the project holding the issue containing the attachment:

  • Delete own attachments project permission to delete an attachment created by the calling user.
  • Delete all attachments project permission to delete an attachment created by any user.
• issueCommentProperties.deleteCommentProperty

  Deletes a comment property.

  Permissions required: either of:

  • Edit All Comments project permission to delete a property from any comment.
  • Edit Own Comments project permission to delete a property from a comment created by the user.

  Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.

• issueCommentProperties.getCommentProperty

  Returns the value of a comment property.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
• issueCommentProperties.getCommentPropertyKeys

  Returns the keys of all the properties of a comment.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
• issueCommentProperties.setCommentProperty

  Creates or updates the value of a property for a comment. Use this resource to store custom data against a comment.

  The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

  Permissions required: either of:

  • Edit All Comments project permission to create or update the value of a property on any comment.
  • Edit Own Comments project permission to create or update the value of a property on a comment created by the user.

  Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.

• issueComments.addComment

  Adds a comment to an issue.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects and Add comments project permission for the project that the issue containing the comment is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueComments.deleteComment

  Deletes a comment.

  Permissions required:

  • Browse projects project permission for the project that the issue containing the comment is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • Delete all comments project permission to delete any comment or Delete own comments to delete comment created by the user,
  • If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
• issueComments.getComment

  Returns a comment.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project containing the comment.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
• issueComments.getComments

  Returns all comments for an issue.

  This operation can be accessed anonymously.

  Permissions required: Comments are included in the response where the user has:

  • Browse projects project permission for the project containing the comment.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • If the comment has visibility restrictions, belongs to the group or has the role visibility is role visibility is restricted to.
• issueComments.getCommentsByIds

  Returns a paginated list of comments specified by a list of comment IDs.

  This operation can be accessed anonymously.

  Permissions required: Comments are returned where the user:

  • has Browse projects project permission for the project containing the comment.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
• issueComments.updateComment

  Updates a comment.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project that the issue containing the comment is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • Edit all comments project permission to update any comment or Edit own comments to update comment created by the user.
  • If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
• issueCustomFieldConfigurationApps.getCustomFieldConfiguration

  Returns a paginated list of configurations for a custom field created by a Forge app.

  The result can be filtered by one of these criteria:

  • id.
  • fieldContextId.
  • issueId.
  • projectKeyOrId and issueTypeId.

  Otherwise, all configurations are returned.

  Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that created the custom field.

• issueCustomFieldConfigurationApps.updateCustomFieldConfiguration

  Update the configuration for contexts of a custom field created by a Forge app.

  Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that created the custom field.

• issueCustomFieldContexts.addIssueTypesToContext

  Adds issue types to a custom field context, appending the issue types to the issue types list.

  A custom field context without any issue types applies to all issue types. Adding issue types to such a custom field context would result in it applying to only the listed issue types.

  If any of the issue types exists in the custom field context, the operation fails and no issue types are added.

  Permissions required: Administer Jira global permission.

• issueCustomFieldContexts.assignProjectsToCustomFieldContext

  Assigns a custom field context to projects.

  If any project in the request is assigned to any context of the custom field, the operation fails.

  Permissions required: Administer Jira global permission.

• issueCustomFieldContexts.createCustomFieldContext

  Creates a custom field context.

  If projectIds is empty, a global context is created. A global context is one that applies to all project. If issueTypeIds is empty, the context applies to all issue types.

  Permissions required: Administer Jira global permission.

• issueCustomFieldContexts.deleteCustomFieldContext

  Deletes a custom field context.

  Permissions required: Administer Jira global permission.

• issueCustomFieldContexts.getContextsForField

  Returns a paginated list of contexts for a custom field. Contexts can be returned as follows:

  • With no other parameters set, all contexts.
  • By defining id only, all contexts from the list of IDs.
  • By defining isAnyIssueType, limit the list of contexts returned to either those that apply to all issue types (true) or those that apply to only a subset of issue types (false)
  • By defining isGlobalContext, limit the list of contexts return to either those that apply to all projects (global contexts) (true) or those that apply to only a subset of projects (false).

  Permissions required: Administer Jira global permission.

• issueCustomFieldContexts.getCustomFieldContextsForProjectsAndIssueTypes

  Returns a paginated list of project and issue type mappings and, for each mapping, the ID of a custom field context that applies to the project and issue type.

  If there is no custom field context assigned to the project then, if present, the custom field context that applies to all projects is returned if it also applies to the issue type or all issue types. If a custom field context is not found, the returned custom field context ID is null.

  Duplicate project and issue type mappings cannot be provided in the request.

  The order of the returned values is the same as provided in the request.

  Permissions required: Administer Jira global permission.

• issueCustomFieldContexts.getDefaultValues

  Returns a paginated list of defaults for a custom field. The results can be filtered by contextId, otherwise all values are returned. If no defaults are set for a context, nothing is returned.
  The returned object depends on type of the custom field:

  • CustomFieldContextDefaultValueDate (type datepicker) for date fields.
  • CustomFieldContextDefaultValueDateTime (type datetimepicker) for date-time fields.
  • CustomFieldContextDefaultValueSingleOption (type option.single) for single choice select lists and radio buttons.
  • CustomFieldContextDefaultValueMultipleOption (type option.multiple) for multiple choice select lists and checkboxes.
  • CustomFieldContextDefaultValueCascadingOption (type option.cascading) for cascading select lists.
  • CustomFieldContextSingleUserPickerDefaults (type single.user.select) for single users.
  • CustomFieldContextDefaultValueMultiUserPicker (type multi.user.select) for user lists.
  • CustomFieldContextDefaultValueSingleGroupPicker (type grouppicker.single) for single choice group pickers.
  • CustomFieldContextDefaultValueMultipleGroupPicker (type grouppicker.multiple) for multiple choice group pickers.
  • CustomFieldContextDefaultValueURL (type url) for URLs.
  • CustomFieldContextDefaultValueProject (type project) for project pickers.
  • CustomFieldContextDefaultValueFloat (type float) for floats (floating-point numbers).
  • CustomFieldContextDefaultValueLabels (type labels) for labels.
  • CustomFieldContextDefaultValueTextField (type textfield) for text fields.
  • CustomFieldContextDefaultValueTextArea (type textarea) for text area fields.
  • CustomFieldContextDefaultValueReadOnly (type readonly) for read only (text) fields.
  • CustomFieldContextDefaultValueMultipleVersion (type version.multiple) for single choice version pickers.
  • CustomFieldContextDefaultValueSingleVersion (type version.single) for multiple choice version pickers.

  Forge custom fields types are also supported, returning:

  • CustomFieldContextDefaultValueForgeStringFieldBean (type forge.string) for Forge string fields.
  • CustomFieldContextDefaultValueForgeMultiStringFieldBean (type forge.string.list) for Forge string collection fields.
  • CustomFieldContextDefaultValueForgeObjectFieldBean (type forge.object) for Forge object fields.
  • CustomFieldContextDefaultValueForgeDateTimeFieldBean (type forge.datetime) for Forge date-time fields.
  • CustomFieldContextDefaultValueForgeGroupFieldBean (type forge.group) for Forge group fields.
  • CustomFieldContextDefaultValueForgeMultiGroupFieldBean (type forge.group.list) for Forge group collection fields.
  • CustomFieldContextDefaultValueForgeNumberFieldBean (type forge.number) for Forge number fields.
  • CustomFieldContextDefaultValueForgeUserFieldBean (type forge.user) for Forge user fields.
  • CustomFieldContextDefaultValueForgeMultiUserFieldBean (type forge.user.list) for Forge user collection fields.

  Permissions required: Administer Jira global permission.

• issueCustomFieldContexts.getIssueTypeMappingsForContexts

  Returns a paginated list of context to issue type mappings for a custom field. Mappings are returned for all contexts or a list of contexts. Mappings are ordered first by context ID and then by issue type ID.

  Permissions required: Administer Jira global permission.

• issueCustomFieldContexts.getProjectContextMapping

  Returns a paginated list of context to project mappings for a custom field. The result can be filtered by contextId. Otherwise, all mappings are returned. Invalid IDs are ignored.

  Permissions required: Administer Jira global permission.

• issueCustomFieldContexts.removeCustomFieldContextFromProjects

  Removes a custom field context from projects.

  A custom field context without any projects applies to all projects. Removing all projects from a custom field context would result in it applying to all projects.

  If any project in the request is not assigned to the context, or the operation would result in two global contexts for the field, the operation fails.

  Permissions required: Administer Jira global permission.

• issueCustomFieldContexts.removeIssueTypesFromContext

  Removes issue types from a custom field context.

  A custom field context without any issue types applies to all issue types.

  Permissions required: Administer Jira global permission.

• issueCustomFieldContexts.setDefaultValues

  Sets default for contexts of a custom field. Default are defined using these objects:

  • CustomFieldContextDefaultValueDate (type datepicker) for date fields.
  • CustomFieldContextDefaultValueDateTime (type datetimepicker) for date-time fields.
  • CustomFieldContextDefaultValueSingleOption (type option.single) for single choice select lists and radio buttons.
  • CustomFieldContextDefaultValueMultipleOption (type option.multiple) for multiple choice select lists and checkboxes.
  • CustomFieldContextDefaultValueCascadingOption (type option.cascading) for cascading select lists.
  • CustomFieldContextSingleUserPickerDefaults (type single.user.select) for single users.
  • CustomFieldContextDefaultValueMultiUserPicker (type multi.user.select) for user lists.
  • CustomFieldContextDefaultValueSingleGroupPicker (type grouppicker.single) for single choice group pickers.
  • CustomFieldContextDefaultValueMultipleGroupPicker (type grouppicker.multiple) for multiple choice group pickers.
  • CustomFieldContextDefaultValueURL (type url) for URLs.
  • CustomFieldContextDefaultValueProject (type project) for project pickers.
  • CustomFieldContextDefaultValueFloat (type float) for floats (floating-point numbers).
  • CustomFieldContextDefaultValueLabels (type labels) for labels.
  • CustomFieldContextDefaultValueTextField (type textfield) for text fields.
  • CustomFieldContextDefaultValueTextArea (type textarea) for text area fields.
  • CustomFieldContextDefaultValueReadOnly (type readonly) for read only (text) fields.
  • CustomFieldContextDefaultValueMultipleVersion (type version.multiple) for single choice version pickers.
  • CustomFieldContextDefaultValueSingleVersion (type version.single) for multiple choice version pickers.

  Forge custom fields types are also supported, returning:

  • CustomFieldContextDefaultValueForgeStringFieldBean (type forge.string) for Forge string fields.
  • CustomFieldContextDefaultValueForgeMultiStringFieldBean (type forge.string.list) for Forge string collection fields.
  • CustomFieldContextDefaultValueForgeObjectFieldBean (type forge.object) for Forge object fields.
  • CustomFieldContextDefaultValueForgeDateTimeFieldBean (type forge.datetime) for Forge date-time fields.
  • CustomFieldContextDefaultValueForgeGroupFieldBean (type forge.group) for Forge group fields.
  • CustomFieldContextDefaultValueForgeMultiGroupFieldBean (type forge.group.list) for Forge group collection fields.
  • CustomFieldContextDefaultValueForgeNumberFieldBean (type forge.number) for Forge number fields.
  • CustomFieldContextDefaultValueForgeUserFieldBean (type forge.user) for Forge user fields.
  • CustomFieldContextDefaultValueForgeMultiUserFieldBean (type forge.user.list) for Forge user collection fields.

  Only one type of default object can be included in a request. To remove a default for a context, set the default parameter to null.

  Permissions required: Administer Jira global permission.

• issueCustomFieldContexts.updateCustomFieldContext

  Updates a custom field context.

  Permissions required: Administer Jira global permission.

• issueCustomFieldOptions.createCustomFieldOption

  Creates options and, where the custom select field is of the type Select List (cascading), cascading options for a custom select field. The options are added to a context of the field.

  The maximum number of options that can be created per request is 1000 and each field can have a maximum of 10000 options.

  This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options (apps) operations.

  Permissions required: Administer Jira global permission.

• issueCustomFieldOptions.deleteCustomFieldOption

  Deletes a custom field option.

  Options with cascading options cannot be deleted without deleting the cascading options first.

  This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options (apps) operations.

  Permissions required: Administer Jira global permission.

• issueCustomFieldOptions.getCustomFieldOption

  Returns a custom field option. For example, an option in a select list.

  Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options resource, it cannot be used with issue field select list options created by Connect apps.

  This operation can be accessed anonymously.

  Permissions required: The custom field option is returned as follows:

  • if the user has the Administer Jira global permission.
  • if the user has the Browse projects project permission for at least one project the custom field is used in, and the field is visible in at least one layout the user has permission to view.
• issueCustomFieldOptions.getOptionsForContext

  Returns a paginated list of all custom field option for a context. Options are returned first then cascading options, in the order they display in Jira.

  This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options (apps) operations.

  Permissions required: Administer Jira global permission.

• issueCustomFieldOptions.reorderCustomFieldOptions

  Changes the order of custom field options or cascading options in a context.

  This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options (apps) operations.

  Permissions required: Administer Jira global permission.

• issueCustomFieldOptions.updateCustomFieldOption

  Updates the options of a custom field.

  If any of the options are not found, no options are updated. Options where the values in the request match the current values aren't updated and aren't reported in the response.

  Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options resource, it cannot be used with issue field select list options created by Connect apps.

  Permissions required: Administer Jira global permission.

• issueCustomFieldOptionsApps.createIssueFieldOption

  Creates an option for a select list issue field.

  Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

  Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

• issueCustomFieldOptionsApps.deleteIssueFieldOption

  Deletes an option from a select list issue field.

  Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

  Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

• issueCustomFieldOptionsApps.getAllIssueFieldOptions

  Returns a paginated list of all the options of a select list issue field. A select list issue field is a type of issue field that enables a user to select a value from a list of options.

  Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

  Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

• issueCustomFieldOptionsApps.getIssueFieldOption

  Returns an option from a select list issue field.

  Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

  Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

• issueCustomFieldOptionsApps.getSelectableIssueFieldOptions

  Returns a paginated list of options for a select list issue field that can be viewed and selected by the user.

  Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

  Permissions required: Permission to access Jira.

• issueCustomFieldOptionsApps.getVisibleIssueFieldOptions

  Returns a paginated list of options for a select list issue field that can be viewed by the user.

  Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

  Permissions required: Permission to access Jira.

• issueCustomFieldOptionsApps.replaceIssueFieldOption

  Deselects an issue-field select-list option from all issues where it is selected. A different option can be selected to replace the deselected option. The update can also be limited to a smaller set of issues by using a JQL query.

  Connect and Forge app users with Administer Jira global permission can override the screen security configuration using overrideScreenSecurity and overrideEditableFlag.

  This is an asynchronous operation. The response object contains a link to the long-running task.

  Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

  Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

• issueCustomFieldOptionsApps.updateIssueFieldOption

  Updates or creates an option for a select list issue field. This operation requires that the option ID is provided when creating an option, therefore, the option ID needs to be specified as a path and body parameter. The option ID provided in the path and body must be identical.

  Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

  Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

• issueCustomFieldValuesApps.updateCustomFieldValue

  Updates the value of a custom field on one or more issues. Custom fields can only be updated by the Forge app that created them.

  Permissions required: Only the app that created the custom field can update its values with this operation.

• issueCustomFieldValuesApps.updateMultipleCustomFieldValues

  Updates the value of one or more custom fields on one or more issues. Combinations of custom field and issue should be unique within the request. Custom fields can only be updated by the Forge app that created them.

  Permissions required: Only the app that created the custom field can update its values with this operation.

• issueFieldConfigurations.assignFieldConfigurationSchemeToProject

  Assigns a field configuration scheme to a project. If the field configuration scheme ID is null, the operation assigns the default field configuration scheme.

  Field configuration schemes can only be assigned to classic projects.

  Permissions required: Administer Jira global permission.

• issueFieldConfigurations.createFieldConfiguration

  Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional.

  This operation can only create configurations for use in company-managed (classic) projects.

  Permissions required: Administer Jira global permission.

• issueFieldConfigurations.createFieldConfigurationScheme

  Creates a field configuration scheme.

  This operation can only create field configuration schemes used in company-managed (classic) projects.

  Permissions required: Administer Jira global permission.

• issueFieldConfigurations.deleteFieldConfiguration

  Deletes a field configuration.

  This operation can only delete configurations used in company-managed (classic) projects.

  Permissions required: Administer Jira global permission.

• issueFieldConfigurations.deleteFieldConfigurationScheme

  Deletes a field configuration scheme.

  This operation can only delete field configuration schemes used in company-managed (classic) projects.

  Permissions required: Administer Jira global permission.

• issueFieldConfigurations.getAllFieldConfigurations

  Returns a paginated list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria:

  • a list of field configuration item IDs.
  • whether the field configuration is a default.
  • whether the field configuration name or description contains a query string.

  Only field configurations used in company-managed (classic) projects are returned.

  Permissions required: Administer Jira global permission.

• issueFieldConfigurations.getAllFieldConfigurationSchemes

  Returns a paginated list of field configuration schemes.

  Only field configuration schemes used in classic projects are returned.

  Permissions required: Administer Jira global permission.

• issueFieldConfigurations.getFieldConfigurationItems

  Returns a paginated list of all fields for a configuration.

  Only the fields from configurations used in company-managed (classic) projects are returned.

  Permissions required: Administer Jira global permission.

• issueFieldConfigurations.getFieldConfigurationSchemeMappings

  Returns a paginated list of field configuration issue type items.

  Only items used in classic projects are returned.

  Permissions required: Administer Jira global permission.

• issueFieldConfigurations.getFieldConfigurationSchemeProjectMapping

  Returns a paginated list of field configuration schemes and, for each scheme, a list of the projects that use it.

  The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme.

  Only field configuration schemes used in classic projects are returned.

  Permissions required: Administer Jira global permission.

• issueFieldConfigurations.removeIssueTypesFromGlobalFieldConfigurationScheme

  Removes issue types from the field configuration scheme.

  This operation can only modify field configuration schemes used in company-managed (classic) projects.

  Permissions required: Administer Jira global permission.

• issueFieldConfigurations.setFieldConfigurationSchemeMapping

  Assigns issue types to field configurations on field configuration scheme.

  This operation can only modify field configuration schemes used in company-managed (classic) projects.

  Permissions required: Administer Jira global permission.

• issueFieldConfigurations.updateFieldConfiguration

  Updates a field configuration. The name and the description provided in the request override the existing values.

  This operation can only update configurations used in company-managed (classic) projects.

  Permissions required: Administer Jira global permission.

• issueFieldConfigurations.updateFieldConfigurationItems

  Updates fields in a field configuration. The properties of the field configuration fields provided override the existing values.

  This operation can only update field configurations used in company-managed (classic) projects.

  The operation can set the renderer for text fields to the default text renderer (text-renderer) or wiki style renderer (wiki-renderer). However, the renderer cannot be updated for fields using the autocomplete renderer (autocomplete-renderer).

  Permissions required: Administer Jira global permission.

• issueFieldConfigurations.updateFieldConfigurationScheme

  Updates a field configuration scheme.

  This operation can only update field configuration schemes used in company-managed (classic) projects.

  Permissions required: Administer Jira global permission.

• issueFields.createCustomField

  Creates a custom field.

  Permissions required: Administer Jira global permission.

• issueFields.deleteCustomField

  Deletes a custom field. The custom field is deleted whether it is in the trash or not. See Edit or delete a custom field for more information on trashing and deleting custom fields.

  This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

  Permissions required: Administer Jira global permission.

• issueFields.getContextsForFieldDeprecated

  Returns a paginated list of the contexts a field is used in. Deprecated, use Get custom field contexts.

  Permissions required: Administer Jira global permission.

• issueFields.getFields

  Returns system and custom issue fields according to the following rules:

  • Fields that cannot be added to the issue navigator are always returned.
  • Fields that cannot be placed on an issue screen are always returned.
  • Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches.
  • For all other fields, this operation only returns the fields that the user has permission to view (that is, the field is used in at least one project that the user has Browse Projects project permission for.)

  This operation can be accessed anonymously.

  Permissions required: None.

• issueFields.getFieldsPaginated

  Returns a paginated list of fields for Classic Jira projects. The list can include:

  • all fields
  • specific fields, by defining id
  • fields that contain a string in the field name or description, by defining query
  • specific fields that contain a string in the field name or description, by defining id and query

  Only custom fields can be queried, type must be set to custom.

  Permissions required: Administer Jira global permission.

• issueFields.getTrashedFieldsPaginated

  Returns a paginated list of fields in the trash. The list may be restricted to fields whose field name or description partially match a string.

  Only custom fields can be queried, type must be set to custom.

  Permissions required: Administer Jira global permission.

• issueFields.restoreCustomField

  Restores a custom field from trash. See Edit or delete a custom field for more information on trashing and deleting custom fields.

  Permissions required: Administer Jira global permission.

• issueFields.trashCustomField

  Moves a custom field to trash. See Edit or delete a custom field for more information on trashing and deleting custom fields.

  Permissions required: Administer Jira global permission.

• issueFields.updateCustomField

  Updates a custom field.

  Permissions required: Administer Jira global permission.

• issueLinks.deleteIssueLink

  Deletes an issue link.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse project project permission for all the projects containing the issues in the link.
  • Link issues project permission for at least one of the projects containing issues in the link.
  • If issue-level security is configured, permission to view both of the issues.
• issueLinks.getIssueLink

  Returns an issue link.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse project project permission for all the projects containing the linked issues.
  • If issue-level security is configured, permission to view both of the issues.
• issueLinks.linkIssues

  Creates a link between two issues. Use this operation to indicate a relationship between two issues and optionally add a comment to the from (outward) issue. To use this resource the site must have Issue Linking enabled.

  This resource returns nothing on the creation of an issue link. To obtain the ID of the issue link, use https://your-domain.atlassian.net/rest/api/3/issue/[linked issue key]?fields=issuelinks.

  If the link request duplicates a link, the response indicates that the issue link was created. If the request included a comment, the comment is added.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse project project permission for all the projects containing the issues to be linked,
  • Link issues project permission on the project containing the from (outward) issue,
  • If issue-level security is configured, issue-level security permission to view the issue.
  • If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
• issueLinkTypes.createIssueLinkType

  Creates an issue link type. Use this operation to create descriptions of the reasons why issues are linked. The issue link type consists of a name and descriptions for a link's inward and outward relationships.

  To use this operation, the site must have issue linking enabled.

  Permissions required: Administer Jira global permission.

• issueLinkTypes.deleteIssueLinkType

  Deletes an issue link type.

  To use this operation, the site must have issue linking enabled.

  Permissions required: Administer Jira global permission.

• issueLinkTypes.getIssueLinkType

  Returns an issue link type.

  To use this operation, the site must have issue linking enabled.

  This operation can be accessed anonymously.

  Permissions required: Browse projects project permission for a project in the site.

• issueLinkTypes.getIssueLinkTypes

  Returns a list of all issue link types.

  To use this operation, the site must have issue linking enabled.

  This operation can be accessed anonymously.

  Permissions required: Browse projects project permission for a project in the site.

• issueLinkTypes.updateIssueLinkType

  Updates an issue link type.

  To use this operation, the site must have issue linking enabled.

  Permissions required: Administer Jira global permission.

• issueNavigatorSettings.getIssueNavigatorDefaultColumns

  Returns the default issue navigator columns.

  Permissions required: Administer Jira global permission.

• issueNavigatorSettings.setIssueNavigatorDefaultColumns

  Sets the default issue navigator columns.

  The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl:

  curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/settings/columns

  If no column details are sent, then all default columns are removed.

  A navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using Get fields.

  Permissions required: Administer Jira global permission.

• issueNotificationSchemes.addNotifications

  Adds notifications to a notification scheme. You can add up to 1000 notifications per request.

  Permissions required: Administer Jira global permission.

• issueNotificationSchemes.createNotificationScheme

  Creates a notification scheme with notifications. You can create up to 1000 notifications per request.

  Permissions required: Administer Jira global permission.

• issueNotificationSchemes.deleteNotificationScheme

  Deletes a notification scheme.

  Permissions required: Administer Jira global permission.

• issueNotificationSchemes.getNotificationScheme

  Returns a notification scheme, including the list of events and the recipients who will receive notifications for those events.

  Permissions required: Permission to access Jira, however, the user must have permission to administer at least one project associated with the notification scheme.

• issueNotificationSchemes.getNotificationSchemes

  Returns a paginated list of notification schemes ordered by the display name.

  Note that you should allow for events without recipients to appear in responses.

  Permissions required: Permission to access Jira, however, the user must have permission to administer at least one project associated with a notification scheme for it to be returned.

• issueNotificationSchemes.getNotificationSchemeToProjectMappings

  Returns a paginated mapping of project that have notification scheme assigned. You can provide either one or multiple notification scheme IDs or project IDs to filter by. If you don't provide any, this will return a list of all mappings. Note that only company-managed (classic) projects are supported. This is because team-managed projects don't have a concept of a default notification scheme. The mappings are ordered by projectId.

  Permissions required: Permission to access Jira.

• issueNotificationSchemes.removeNotificationFromNotificationScheme

  Removes a notification from a notification scheme.

  Permissions required: Administer Jira global permission.

• issueNotificationSchemes.updateNotificationScheme

  Updates a notification scheme.

  Permissions required: Administer Jira global permission.

• issuePriorities.createPriority

  Creates an issue priority.

  Permissions required: Administer Jira global permission.

• issuePriorities.deletePriority

  Deletes an issue priority.

  This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

  Permissions required: Administer Jira global permission.

• issuePriorities.getPriorities

  Returns the list of all issue priorities.

  Permissions required: Permission to access Jira.

• issuePriorities.getPriority

  Returns an issue priority.

  Permissions required: Permission to access Jira.

• issuePriorities.movePriorities

  Changes the order of issue priorities.

  Permissions required: Administer Jira global permission.

• issuePriorities.searchPriorities

  Returns a paginated list of priorities. The list can contain all priorities or a subset determined by any combination of these criteria:

  • a list of priority IDs. Any invalid priority IDs are ignored.
  • whether the field configuration is a default. This returns priorities from company-managed (classic) projects only, as there is no concept of default priorities in team-managed projects.

  Permissions required: Permission to access Jira.

• issuePriorities.setDefaultPriority

  Sets default issue priority.

  Permissions required: Administer Jira global permission.

• issuePriorities.updatePriority

  Updates an issue priority.

  Permissions required: Administer Jira global permission.

• issueProperties.bulkDeleteIssueProperty

  Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.

  The criteria the filter used to identify eligible issues are:

  • entityIds Only issues from this list are eligible.
  • currentValue Only issues with the property set to this value are eligible.

  If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible.

  If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

  This operation is:

  • transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
  • asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

  Permissions required:

  • Browse projects project permission for each project containing issues.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • Edit issues project permission for each issue.
• issueProperties.bulkSetIssuePropertiesByIssue

  Sets or updates entity property values on issues. Up to 10 entity properties can be specified for each issue and up to 100 issues included in the request.

  The value of the request body must be a valid, non-empty JSON.

  This operation is:

  • asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.
  • non-transactional. Updating some entities may fail. Such information will available in the task result.

  Permissions required:

  • Browse projects and Edit issues project permissions for the project containing the issue.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueProperties.bulkSetIssueProperty

  Sets a property value on multiple issues.

  The value set can be a constant or determined by a Jira expression. Expressions must be computable with constant complexity when applied to a set of issues. Expressions must also comply with the restrictions that apply to all Jira expressions.

  The issues to be updated can be specified by a filter.

  The filter identifies issues eligible for update using these criteria:

  • entityIds Only issues from this list are eligible.

  • currentValue Only issues with the property set to this value are eligible.

  • hasProperty:

    • If true, only issues with the property are eligible.
    • If false, only issues without the property are eligible.

  If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible.

  If an invalid combination of criteria is provided, an error is returned. For example, specifying a currentValue and hasProperty as false would not match any issues (because without the property the property cannot have a value).

  The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

  This operation is:

  • transactional, either all eligible issues are updated or, when errors occur, none are updated.
  • asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

  Permissions required:

  • Browse projects project permission for each project containing issues.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • Edit issues project permission for each issue.
• issueProperties.bulkSetIssuesPropertiesList

  Sets or updates a list of entity property values on issues. A list of up to 10 entity properties can be specified along with up to 10,000 issues on which to set or update that list of entity properties.

  The value of the request body must be a valid, non-empty JSON. The maximum length of single issue property value is 32768 characters. This operation can be accessed anonymously.

  This operation is:

  • transactional, either all properties are updated in all eligible issues or, when errors occur, no properties are updated.
  • asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

  Permissions required:

  • Browse projects and Edit issues project permissions for the project containing the issue.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueProperties.deleteIssueProperty

  Deletes an issue's property.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects and Edit issues project permissions for the project containing the issue.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueProperties.getIssueProperty

  Returns the key and value of an issue's property.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project containing the issue.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueProperties.getIssuePropertyKeys

  Returns the URLs and keys of an issue's properties.

  This operation can be accessed anonymously.

  Permissions required: Property details are only returned where the user has:

  • Browse projects project permission for the project containing the issue.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueProperties.setIssueProperty

  Sets the value of an issue's property. Use this resource to store custom data against an issue.

  The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects and Edit issues project permissions for the project containing the issue.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueRemoteLinks.createOrUpdateRemoteIssueLink

  Creates or updates a remote issue link for an issue.

  If a globalId is provided and a remote issue link with that global ID is found it is updated. Any fields without values in the request are set to null. Otherwise, the remote issue link is created.

  This operation requires issue linking to be active.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects and Link issues project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueRemoteLinks.deleteRemoteIssueLinkByGlobalId

  Deletes the remote issue link from the issue using the link's global ID. Where the global ID includes reserved URL characters these must be escaped in the request. For example, pass system=http://www.mycompany.com/support&id=1 as system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1.

  This operation requires issue linking to be active.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects and Link issues project permission for the project that the issue is in.
  • If issue-level security is implemented, issue-level security permission to view the issue.
• issueRemoteLinks.deleteRemoteIssueLinkById

  Deletes a remote issue link from an issue.

  This operation requires issue linking to be active.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects, Edit issues, and Link issues project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueRemoteLinks.getRemoteIssueLinkById

  Returns a remote issue link for an issue.

  This operation requires issue linking to be active.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueRemoteLinks.getRemoteIssueLinks

  Returns the remote issue links for an issue. When a remote issue link global ID is provided the record with that global ID is returned, otherwise all remote issue links are returned. Where a global ID includes reserved URL characters these must be escaped in the request. For example, pass system=http://www.mycompany.com/support&id=1 as system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1.

  This operation requires issue linking to be active.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueRemoteLinks.updateRemoteIssueLink

  Updates a remote issue link for an issue.

  Note: Fields without values in the request are set to null.

  This operation requires issue linking to be active.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects and Link issues project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueResolutions.createResolution

  Creates an issue resolution.

  Permissions required: Administer Jira global permission.

• issueResolutions.deleteResolution

  Deletes an issue resolution.

  This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

  Permissions required: Administer Jira global permission.

• issueResolutions.getResolution

  Returns an issue resolution value.

  Permissions required: Permission to access Jira.

• issueResolutions.getResolutions

  Returns a list of all issue resolution values.

  Permissions required: Permission to access Jira.

• issueResolutions.moveResolutions

  Changes the order of issue resolutions.

  Permissions required: Administer Jira global permission.

• issueResolutions.searchResolutions

  Returns a paginated list of resolutions. The list can contain all resolutions or a subset determined by any combination of these criteria:

  • a list of resolutions IDs.
  • whether the field configuration is a default. This returns resolutions from company-managed (classic) projects only, as there is no concept of default resolutions in team-managed projects.

  Permissions required: Permission to access Jira.

• issueResolutions.setDefaultResolution

  Sets default issue resolution.

  Permissions required: Administer Jira global permission.

• issueResolutions.updateResolution

  Updates an issue resolution.

  Permissions required: Administer Jira global permission.

• issues.assignIssue

  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:

  • Browse Projects and Assign Issues project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issues.createIssue

  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.

• issues.createIssues

  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.

• issues.deleteIssue

  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:

  • Browse projects and Delete issues project permission for the project containing the issue.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issues.doTransition

  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:

  • Browse projects and Transition issues project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issues.editIssue

  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:

  • Browse projects and Edit issues project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issues.getChangeLogs

  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:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issues.getChangeLogsByIds

  Returns changelogs for an issue specified by a list of changelog IDs.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issues.getCreateIssueMeta

  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.

• issues.getEditIssueMeta

  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:

  1. Field is available on a field screen - through screen, screen scheme, issue type screen scheme, and issue type scheme configuration. overrideScreenSecurity=true skips this condition.
  2. Field is visible in the field configuration. overrideScreenSecurity=true skips this condition.
  3. Field is shown on the issue: each field has different conditions here. For example: Attachment field only shows if attachments are enabled. Assignee only shows if user has permissions to assign the issue.
  4. If a field is custom then it must have valid custom field context, applicable for its project and issue type. All system fields are assumed to have context in all projects and all issue types.
  5. Issue has a project, issue type, and status defined.
  6. Issue is assigned to a valid workflow, and the current status has assigned a workflow step. overrideEditableFlag=true skips this condition.
  7. The current workflow step is editable. This is true by default, but can be disabled by setting the jira.issue.editable property to false. overrideEditableFlag=true skips this condition.
  8. User has Edit issues permission.
  9. Workflow permissions allow editing a field. This is true by default but can be modified using 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:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.

  Note: For any fields to be editable the user must have the Edit issues project permission for the issue.

• issues.getEvents

  Returns all issue events.

  Permissions required: Administer Jira global permission.

• issues.getIssue

  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:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issues.getTransitions

  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:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.

  However, if the user does not have the Transition issues project permission the response will not list any transitions.

• issues.notify

  Creates an email notification for an issue and adds it to the mail queue.

  Permissions required:

  • Browse Projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueSearch.getIssuePickerResource

  Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.

  This operation returns two lists:

  • History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.
  • Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter.

  This operation can be accessed anonymously.

  Permissions required: None.

• issueSearch.matchIssues

  Checks whether one or more issues would be returned by one or more JQL queries.

  Permissions required: None, however, issues are only matched against JQL queries where the user has:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueSearch.searchForIssuesUsingJql

  Searches for issues using JQL.

  If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

  This operation can be accessed anonymously.

  Permissions required: Issues are included in the response where the user has:

  • Browse projects project permission for the project containing the issue.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueSearch.searchForIssuesUsingJqlPost

  Searches for issues using JQL.

  There is a GET version of this resource that can be used for smaller JQL query expressions.

  This operation can be accessed anonymously.

  Permissions required: Issues are included in the response where the user has:

  • Browse projects project permission for the project containing the issue.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueSecurityLevel.getIssueSecurityLevel

  Returns details of an issue security level.

  Use Get issue security scheme to obtain the IDs of issue security levels associated with the issue security scheme.

  This operation can be accessed anonymously.

  Permissions required: None.

• issueSecurityLevel.getIssueSecurityLevelMembers

  Returns issue security level members.

  Only issue security level members in context of classic projects are returned.

  Permissions required: Administer Jira global permission.

• issueSecuritySchemes.getIssueSecurityScheme

  Returns an issue security scheme along with its security levels.

  Permissions required:

  • Administer Jira global permission.
  • Administer Projects project permission for a project that uses the requested issue security scheme.
• issueSecuritySchemes.getIssueSecuritySchemes

  Returns all issue security schemes.

  Permissions required: Administer Jira global permission.

• issueTypeProperties.deleteIssueTypeProperty

  Deletes the issue type property.

  Permissions required: Administer Jira global permission.

• issueTypeProperties.getIssueTypeProperty

  Returns the key and value of the issue type property.

  This operation can be accessed anonymously.

  Permissions required:

  • Administer Jira global permission to get the details of any issue type.
  • Browse projects project permission to get the details of any issue types associated with the projects the user has permission to browse.
• issueTypeProperties.getIssueTypePropertyKeys

  Returns all the issue type property keys of the issue type.

  This operation can be accessed anonymously.

  Permissions required:

  • Administer Jira global permission to get the property keys of any issue type.
  • Browse projects project permission to get the property keys of any issue types associated with the projects the user has permission to browse.
• issueTypeProperties.setIssueTypeProperty

  Creates or updates the value of the issue type property. Use this resource to store and update data against an issue type.

  The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

  Permissions required: Administer Jira global permission.

• issueTypes.createIssueType

  Creates an issue type and adds it to the default issue type scheme.

  Permissions required: Administer Jira global permission.

• issueTypes.createIssueTypeAvatar

  Loads an avatar for the issue type.

  Specify the avatar's local file location in the body of the request. Also, include the following headers:

  • X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers.
  • Content-Type: image/image type Valid image types are JPEG, GIF, or PNG.

  For example:
  curl --request POST \ --user email@example.com:<api_token> \ --header 'X-Atlassian-Token: no-check' \ --header 'Content-Type: image/< image_type>' \ --data-binary "<@/path/to/file/with/your/avatar>" \ --url 'https://your-domain.atlassian.net/rest/api/3/issuetype/{issueTypeId}'This

  The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.

  The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.

  After creating the avatar, use Update issue type to set it as the issue type's displayed avatar.

  Permissions required: Administer Jira global permission.

• issueTypes.deleteIssueType

  Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type (alternativeIssueTypeId). A list of alternative issue types are obtained from the Get alternative issue types resource.

  Permissions required: Administer Jira global permission.

• issueTypes.getAlternativeIssueTypes

  Returns a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme.

  This operation can be accessed anonymously.

  Permissions required: None.

• issueTypes.getIssueAllTypes

  Returns all issue types.

  This operation can be accessed anonymously.

  Permissions required: Issue types are only returned as follows:

  • if the user has the Administer Jira global permission, all issue types are returned.
  • if the user has the Browse projects project permission for one or more projects, the issue types associated with the projects the user has permission to browse are returned.
• issueTypes.getIssueType

  Returns an issue type.

  This operation can be accessed anonymously.

  Permissions required: Browse projects project permission in a project the issue type is associated with or Administer Jira global permission.

• issueTypes.getIssueTypesForProject

  Returns issue types for a project.

  This operation can be accessed anonymously.

  Permissions required: Browse projects project permission in the relevant project or Administer Jira global permission.

• issueTypes.updateIssueType

  Updates the issue type.

  Permissions required: Administer Jira global permission.

• issueTypeSchemes.addIssueTypesToIssueTypeScheme

  Adds issue types to an issue type scheme.

  The added issue types are appended to the issue types list.

  If any of the issue types exist in the issue type scheme, the operation fails and no issue types are added.

  Permissions required: Administer Jira global permission.

• issueTypeSchemes.assignIssueTypeSchemeToProject

  Assigns an issue type scheme to a project.

  If any issues in the project are assigned issue types not present in the new scheme, the operation will fail. To complete the assignment those issues must be updated to use issue types in the new scheme.

  Issue type schemes can only be assigned to classic projects.

  Permissions required: Administer Jira global permission.

• issueTypeSchemes.createIssueTypeScheme

  Creates an issue type scheme.

  Permissions required: Administer Jira global permission.

• issueTypeSchemes.deleteIssueTypeScheme

  Deletes an issue type scheme.

  Only issue type schemes used in classic projects can be deleted.

  Any projects assigned to the scheme are reassigned to the default issue type scheme.

  Permissions required: Administer Jira global permission.

• issueTypeSchemes.getAllIssueTypeSchemes

  Returns a paginated list of issue type schemes.

  Only issue type schemes used in classic projects are returned.

  Permissions required: Administer Jira global permission.

• issueTypeSchemes.getIssueTypeSchemeForProjects

  Returns a paginated list of issue type schemes and, for each issue type scheme, a list of the projects that use it.

  Only issue type schemes used in classic projects are returned.

  Permissions required: Administer Jira global permission.

• issueTypeSchemes.getIssueTypeSchemesMapping

  Returns a paginated list of issue type scheme items.

  Only issue type scheme items used in classic projects are returned.

  Permissions required: Administer Jira global permission.

• issueTypeSchemes.removeIssueTypeFromIssueTypeScheme

  Removes an issue type from an issue type scheme.

  This operation cannot remove:

  • any issue type used by issues.
  • any issue types from the default issue type scheme.
  • the last standard issue type from an issue type scheme.

  Permissions required: Administer Jira global permission.

• issueTypeSchemes.reorderIssueTypesInIssueTypeScheme

  Changes the order of issue types in an issue type scheme.

  The request body parameters must meet the following requirements:

  • all of the issue types must belong to the issue type scheme.
  • either after or position must be provided.
  • the issue type in after must not be in the issue type list.

  Permissions required: Administer Jira global permission.

• issueTypeSchemes.updateIssueTypeScheme

  Updates an issue type scheme.

  Permissions required: Administer Jira global permission.

• issueTypeScreenSchemes.appendMappingsForIssueTypeScreenScheme

  Appends issue type to screen scheme mappings to an issue type screen scheme.

  Permissions required: Administer Jira global permission.

• issueTypeScreenSchemes.assignIssueTypeScreenSchemeToProject

  Assigns an issue type screen scheme to a project.

  Issue type screen schemes can only be assigned to classic projects.

  Permissions required: Administer Jira global permission.

• issueTypeScreenSchemes.createIssueTypeScreenScheme

  Creates an issue type screen scheme.

  Permissions required: Administer Jira global permission.

• issueTypeScreenSchemes.deleteIssueTypeScreenScheme

  Deletes an issue type screen scheme.

  Permissions required: Administer Jira global permission.

• issueTypeScreenSchemes.getIssueTypeScreenSchemeMappings

  Returns a paginated list of issue type screen scheme items.

  Only issue type screen schemes used in classic projects are returned.

  Permissions required: Administer Jira global permission.

• issueTypeScreenSchemes.getIssueTypeScreenSchemeProjectAssociations

  Returns a paginated list of issue type screen schemes and, for each issue type screen scheme, a list of the projects that use it.

  Only issue type screen schemes used in classic projects are returned.

  Permissions required: Administer Jira global permission.

• issueTypeScreenSchemes.getIssueTypeScreenSchemes

  Returns a paginated list of issue type screen schemes.

  Only issue type screen schemes used in classic projects are returned.

  Permissions required: Administer Jira global permission.

• issueTypeScreenSchemes.getProjectsForIssueTypeScreenScheme

  Returns a paginated list of projects associated with an issue type screen scheme.

  Only company-managed projects associated with an issue type screen scheme are returned.

  Permissions required: Administer Jira global permission.

• issueTypeScreenSchemes.removeMappingsFromIssueTypeScreenScheme

  Removes issue type to screen scheme mappings from an issue type screen scheme.

  Permissions required: Administer Jira global permission.

• issueTypeScreenSchemes.updateDefaultScreenScheme

  Updates the default screen scheme of an issue type screen scheme. The default screen scheme is used for all unmapped issue types.

  Permissions required: Administer Jira global permission.

• issueTypeScreenSchemes.updateIssueTypeScreenScheme

  Updates an issue type screen scheme.

  Permissions required: Administer Jira global permission.

• issueVotes.addVote

  Adds the user's vote to an issue. This is the equivalent of the user clicking Vote on an issue in Jira.

  This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

  Permissions required:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueVotes.getVotes

  Returns details about the votes on an issue.

  This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project that the issue is ini
  • If issue-level security is configured, issue-level security permission to view the issue.

  Note that users with the necessary permissions for this operation but without the View voters and watchers project permissions are not returned details in the voters field.

• issueVotes.removeVote

  Deletes a user's vote from an issue. This is the equivalent of the user clicking Unvote on an issue in Jira.

  This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

  Permissions required:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueWatchers.addWatcher

  Adds a user as a watcher of an issue by passing the account ID of the user. For example, "5b10ac8d82e05b22cc7d4ef5". If no user is specified the calling user is added.

  This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

  Permissions required:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • To add users other than themselves to the watchlist, Manage watcher list project permission for the project that the issue is in.
• issueWatchers.getIssueWatchers

  Returns the watchers for an issue.

  This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project that the issue is ini
  • If issue-level security is configured, issue-level security permission to view the issue.
  • To see details of users on the watchlist other than themselves, View voters and watchers project permission for the project that the issue is in.
• issueWatchers.getIsWatchingIssueBulk

  Returns, for the user, details of the watched status of issues from a list. If an issue ID is invalid, the returned watched status is false.

  This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

  Permissions required:

  • Browse projects project permission for the project that the issue is in
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueWatchers.removeWatcher

  Deletes a user as a watcher of an issue.

  This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

  Permissions required:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • To remove users other than themselves from the watchlist, Manage watcher list project permission for the project that the issue is in.
• issueWorklogProperties.deleteWorklogProperty

  Deletes a worklog property.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
• issueWorklogProperties.getWorklogProperty

  Returns the value of a worklog property.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
• issueWorklogProperties.getWorklogPropertyKeys

  Returns the keys of all properties for a worklog.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
• issueWorklogProperties.setWorklogProperty

  Sets the value of a worklog property. Use this operation to store custom data against the worklog.

  The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • Edit all worklogs project permission to update any worklog or Edit own worklogs to update worklogs created by the user.
  • If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
• issueWorklogs.addWorklog

  Adds a worklog to an issue.

  Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects and Work on issues project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
• issueWorklogs.deleteWorklog

  Deletes a worklog from an issue.

  Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • Delete all worklogs project permission to delete any worklog or Delete own worklogs to delete worklogs created by the user,
  • If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
• issueWorklogs.getIdsOfWorklogsDeletedSince

  Returns a list of IDs and delete timestamps for worklogs deleted after a date and time.

  This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs.

  This resource does not return worklogs deleted during the minute preceding the request.

  Permissions required: Permission to access Jira.

• issueWorklogs.getIdsOfWorklogsModifiedSince

  Returns a list of IDs and update timestamps for worklogs updated after a date and time.

  This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs.

  This resource does not return worklogs updated during the minute preceding the request.

  Permissions required: Permission to access Jira, however, worklogs are only returned where either of the following is true:

  • the worklog is set as Viewable by All Users.
  • the user is a member of a project role or group with permission to view the worklog.
• issueWorklogs.getIssueWorklog

  Returns worklogs for an issue, starting from the oldest worklog or from the worklog started on or after a date and time.

  Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

  This operation can be accessed anonymously.

  Permissions required: Workloads are only returned where the user has:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
• issueWorklogs.getWorklog

  Returns a worklog.

  Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
• issueWorklogs.getWorklogsForIds

  Returns worklog details for a list of worklog IDs.

  The returned list of worklogs is limited to 1000 items.

  Permissions required: Permission to access Jira, however, worklogs are only returned where either of the following is true:

  • the worklog is set as Viewable by All Users.
  • the user is a member of a project role or group with permission to view the worklog.
• issueWorklogs.updateWorklog

  Updates a worklog.

  Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

  This operation can be accessed anonymously.

  Permissions required:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • Edit all worklogs project permission to update any worklog or Edit own worklogs to update worklogs created by the user.
  • If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
• jiraExpressions.analyseExpression

  Analyses and validates Jira expressions.

  As an experimental feature, this operation can also attempt to type-check the expressions.

  Learn more about Jira expressions in the documentation.

  Permissions required: None.

• jiraExpressions.evaluateJiraExpression

  Evaluates a Jira expression and returns its value.

  This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.

  Context variables

  The following context variables are available to Jira expressions evaluated by this resource. Their presence depends on various factors; usually you need to manually request them in the context object sent in the payload, but some of them are added automatically under certain conditions.

  • user (User): The current user. Always available and equal to null if the request is anonymous.
  • app (App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).
  • issue (Issue): The current issue. Available only when the issue is provided in the request context object.
  • issues (List of Issues): A collection of issues matching a JQL query. Available only when JQL is provided in the request context object.
  • project (Project): The current project. Available only when the project is provided in the request context object.
  • sprint (Sprint): The current sprint. Available only when the sprint is provided in the request context object.
  • board (Board): The current board. Available only when the board is provided in the request context object.
  • serviceDesk (ServiceDesk): The current service desk. Available only when the service desk is provided in the request context object.
  • customerRequest (CustomerRequest): The current customer request. Available only when the customer request is provided in the request context object.

  Also, custom context variables can be passed in the request with their types. Those variables can be accessed by key in the Jira expression. These variable types are available for use in a custom context:

  • user: A user specified as an Atlassian account ID.
  • issue: An issue specified by ID or key. All the fields of the issue object are available in the Jira expression.
  • json: A JSON object containing custom content.
  • list: A JSON list of user, issue, or json variable types.

  This operation can be accessed anonymously.

  Permissions required: None. However, an expression may return different results for different users depending on their permissions. For example, different users may see different comments on the same issue.
  Permission to access Jira Software is required to access Jira Software context variables (board and sprint) or fields (for example, issue.sprint).

• jiraSettings.getAdvancedSettings

  Returns the application properties that are accessible on the Advanced Settings page. To navigate to the Advanced Settings page in Jira, choose the Jira icon > Jira settings > System, General Configuration and then click Advanced Settings (in the upper right).

  Permissions required: Administer Jira global permission.

• jiraSettings.getApplicationProperty

  Returns all application properties or an application property.

  If you specify a value for the key parameter, then an application property is returned as an object (not in an array). Otherwise, an array of all editable application properties is returned. See Set application property for descriptions of editable properties.

  Permissions required: Administer Jira global permission.

• jiraSettings.getConfiguration

  Returns the global settings in Jira. These settings determine whether optional features (for example, subtasks, time tracking, and others) are enabled. If time tracking is enabled, this operation also returns the time tracking configuration.

  Permissions required: Permission to access Jira.

• jiraSettings.setApplicationProperty

  Changes the value of an application property. For example, you can change the value of the jira.clone.prefix from its default value of CLONE - to Clone - if you prefer sentence case capitalization. Editable properties are described below along with their default values.

  Advanced settings

  The advanced settings below are also accessible in Jira.

  Key	Description	Default value
  jira.clone.prefix	The string of text prefixed to the title of a cloned issue.	CLONE -
  jira.date.picker.java.format	The date format for the Java (server-side) generated dates. This must be the same as the jira.date.picker.javascript.format format setting.	d/MMM/yy
  jira.date.picker.javascript.format	The date format for the JavaScript (client-side) generated dates. This must be the same as the jira.date.picker.java.format format setting.	%e/%b/%y
  jira.date.time.picker.java.format	The date format for the Java (server-side) generated date times. This must be the same as the jira.date.time.picker.javascript.format format setting.	dd/MMM/yy h:mm a
  jira.date.time.picker.javascript.format	The date format for the JavaScript (client-side) generated date times. This must be the same as the jira.date.time.picker.java.format format setting.	%e/%b/%y %I:%M %p
  jira.issue.actions.order	The default order of actions (such as Comments or Change history) displayed on the issue view.	asc
  jira.table.cols.subtasks	The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue.	issuetype, status, assignee, progress
  jira.view.issue.links.sort.order	The sort order of the list of issue links on the issue view.	type, status, priority
  jira.comment.collapsing.minimum.hidden	The minimum number of comments required for comment collapsing to occur. A value of 0 disables comment collapsing.	4
  jira.newsletter.tip.delay.days	The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of -1 disables this feature.	7

  Look and feel

  The settings listed below adjust the look and feel.

  Key	Description	Default value
  jira.lf.date.time	The time format.	h:mm a
  jira.lf.date.day	The day format.	EEEE h:mm a
  jira.lf.date.complete	The date and time format.	dd/MMM/yy h:mm a
  jira.lf.date.dmy	The date format.	dd/MMM/yy
  jira.date.time.picker.use.iso8061	When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard.	false
  jira.lf.logo.url	The URL of the logo image file.	/images/icon-jira-logo.png
  jira.lf.logo.show.application.title	Controls the visibility of the application title on the sidebar.	false
  jira.lf.favicon.url	The URL of the favicon.	/favicon.ico
  jira.lf.favicon.hires.url	The URL of the high-resolution favicon.	/images/64jira.png
  jira.lf.navigation.bgcolour	The background color of the sidebar.	#0747A6
  jira.lf.navigation.highlightcolour	The color of the text and logo of the sidebar.	#DEEBFF
  jira.lf.hero.button.base.bg.colour	The background color of the hero button.	#3b7fc4
  jira.title	The text for the application title. The application title can also be set in General settings.	Jira
  jira.option.globalsharing	Whether filters and dashboards can be shared with anyone signed into Jira.	true
  xflow.product.suggestions.enabled	Whether to expose product suggestions for other Atlassian products within Jira.	true

  Other settings

  Key	Description	Default value
  jira.issuenav.criteria.autoupdate	Whether instant updates to search criteria is active.	true

  Note: Be careful when changing application properties and advanced settings.

  Permissions required: Administer Jira global permission.

• jql.getAutoComplete

  Returns reference data for JQL searches. This is a downloadable version of the documentation provided in Advanced searching - fields reference and Advanced searching - functions reference, along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder.

  To filter visible field details by project or collapse non-unique fields by field type then Get field reference data (POST) can be used.

  This operation can be accessed anonymously.

  Permissions required: None.

• jql.getAutoCompletePost

  Returns reference data for JQL searches. This is a downloadable version of the documentation provided in Advanced searching - fields reference and Advanced searching - functions reference, along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder.

  This operation can filter the custom fields returned by project. Invalid project IDs in projectIds are ignored. System fields are always returned.

  It can also return the collapsed field for custom fields. Collapsed fields enable searches to be performed across all fields with the same name and of the same field type. For example, the collapsed field Component - Component[Dropdown] enables dropdown fields Component - cf[10061] and Component - cf[10062] to be searched simultaneously.

  Permissions required: None.

• jql.getFieldAutoCompleteForQueryString

  Returns the JQL search auto complete suggestions for a field.

  Suggestions can be obtained by providing:

  • fieldName to get a list of all values for the field.
  • fieldName and fieldValue to get a list of values containing the text in fieldValue.
  • fieldName and predicateName to get a list of all predicate values for the field.
  • fieldName, predicateName, and predicateValue to get a list of predicate values containing the text in predicateValue.

  This operation can be accessed anonymously.

  Permissions required: None.

• jql.migrateQueries

  Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.

  You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the migration guide.

  Permissions required: Permission to access Jira.

• jql.parseJqlQueries

  Parses and validates JQL queries.

  Validation is performed in context of the current user.

  This operation can be accessed anonymously.

  Permissions required: None.

• jql.sanitiseJqlQueries

  Sanitizes one or more JQL queries by converting readable details into IDs where a user doesn't have permission to view the entity.

  For example, if the query contains the clause project = 'Secret project', and a user does not have browse permission for the project "Secret project", the sanitized query replaces the clause with project = 12345" (where 12345 is the ID of the project). If a user has the required permission, the clause is not sanitized. If the account ID is null, sanitizing is performed for an anonymous user.

  Note that sanitization doesn't make the queries GDPR-compliant, because it doesn't remove user identifiers (username or user key). If you need to make queries GDPR-compliant, use Convert user identifiers to account IDs in JQL queries.

  Before sanitization each JQL query is parsed. The queries are returned in the same order that they were passed.

  Permissions required: Administer Jira global permission.

• labels.getAllLabels

  Returns a paginated list of labels.

• licenseMetrics.getApproximateApplicationLicenseCount

  Returns the total approximate user account for a specific jira licence application key. Please note this information is cached with a 7-day lifecycle and could be stale at the time of call.

  Application Key

  An application key represents a specific version of Jira. See {@link ApplicationKey} for details

  Permissions required: Administer Jira global permission.

• licenseMetrics.getApproximateLicenseCount

  Returns the total approximate user account across all jira licenced application keys. Please note this information is cached with a 7-day lifecycle and could be stale at the time of call.

  Permissions required: Administer Jira global permission.

• myself.deleteLocale

  Deprecated, use Update a user profile from the user management REST API instead.

  Deletes the locale of the user, which restores the default setting.

  Permissions required: Permission to access Jira.

• myself.getCurrentUser

  Returns details for the current user.

  Permissions required: Permission to access Jira.

• myself.getLocale

  Returns the locale for the user.

  If the user has no language preference set (which is the default setting) or this resource is accessed anonymous, the browser locale detected by Jira is returned. Jira detects the browser locale using the Accept-Language header in the request. However, if this doesn't match a locale available Jira, the site default locale is returned.

  This operation can be accessed anonymously.

  Permissions required: None.

• myself.getPreference

  Returns the value of a preference of the current user.

  Note that these keys are deprecated:

  • jira.user.locale The locale of the user. By default this is not set and the user takes the locale of the instance.
  • jira.user.timezone The time zone of the user. By default this is not set and the user takes the timezone of the instance.

  Use Update a user profile from the user management REST API to manage timezone and locale instead.

  Permissions required: Permission to access Jira.

• myself.removePreference

  Deletes a preference of the user, which restores the default value of system defined settings.

  Note that these keys are deprecated:

  • jira.user.locale The locale of the user. By default, not set. The user takes the instance locale.
  • jira.user.timezone The time zone of the user. By default, not set. The user takes the instance timezone.

  Use Update a user profile from the user management REST API to manage timezone and locale instead.

  Permissions required: Permission to access Jira.

• myself.setLocale

  Deprecated, use Update a user profile from the user management REST API instead.

  Sets the locale of the user. The locale must be one supported by the instance of Jira.

  Permissions required: Permission to access Jira.

• myself.setPreference

  Creates a preference for the user or updates a preference's value by sending a plain text string. For example, false. An arbitrary preference can be created with the value containing up to 255 characters. In addition, the following keys define system preferences that can be set or created:

  • user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html.
  • user.notify.own.changes Whether the user gets notified of their own changes. Defaults to false.
  • user.default.share.private Whether new filters are set to private. Defaults to true.
  • user.keyboard.shortcuts.disabled Whether keyboard shortcuts are disabled. Defaults to false.
  • user.autowatch.disabled Whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.

  Note that these keys are deprecated:

  • jira.user.locale The locale of the user. By default, not set. The user takes the instance locale.
  • jira.user.timezone The time zone of the user. By default, not set. The user takes the instance timezone.

  Use Update a user profile from the user management REST API to manage timezone and locale instead.

  Permissions required: Permission to access Jira.

• permissions.getAllPermissions

  Returns all permissions, including:

  • global permissions.
  • project permissions.
  • global permissions added by plugins.

  Permissions required: Administer Jira global permission.

• permissions.getBulkPermissions

  Returns:

  • for a list of global permissions, the global permissions granted to a user.
  • for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues a user can access or manipulate.

  If no account ID is provided, the operation returns details for the logged in user.

  Note that:

  • Invalid project and issue IDs are ignored.
  • A maximum of 1000 projects and 1000 issues can be checked.
  • Null values in globalPermissions, projectPermissions, projectPermissions.projects, and projectPermissions.issues are ignored.
  • Empty strings in projectPermissions.permissions are ignored.

  This operation can be accessed anonymously.

  Permissions required: Administer Jira global permission to check the permissions for other users, otherwise none. However, Connect apps can make a call from the app server to the product to obtain permission details for any user, without admin permission. This Connect app ability doesn't apply to calls made using AP.request() in a browser.

• permissions.getMyPermissions

  Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, issue or comment context.

  The user is reported as having a project permission:

  • in the global context, if the user has the project permission in any project.
  • for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
  • for an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.
  • for a comment, where the user has both the permission to browse the comment and the project permission for the comment's parent issue. Only the BROWSE_PROJECTS permission is supported. If a commentId is provided whose permissions does not equal BROWSE_PROJECTS, a 400 error will be returned.

  This means that users may be shown as having an issue permission (such as EDIT_ISSUES) in the global context or a project context but may not have the permission for any or all issues. For example, if Reporters have the EDIT_ISSUES permission a user would be shown as having this permission in the global context or the context of a project, because any user can be a reporter. However, if they are not the user who reported the issue queried they would not have EDIT_ISSUES permission for that issue.

  Global permissions are unaffected by context.

  This operation can be accessed anonymously.

  Permissions required: None.

• permissions.getPermittedProjects

  Returns all the projects where the user is granted a list of project permissions.

  This operation can be accessed anonymously.

  Permissions required: None.

• permissionSchemes.createPermissionGrant

  Creates a permission grant in a permission scheme.

  Permissions required: Administer Jira global permission.

• permissionSchemes.createPermissionScheme

  Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.

  Permissions required: Administer Jira global permission.

• permissionSchemes.deletePermissionScheme

  Deletes a permission scheme.

  Permissions required: Administer Jira global permission.

• permissionSchemes.deletePermissionSchemeEntity

  Deletes a permission grant from a permission scheme. See About permission schemes and grants for more details.

  Permissions required: Administer Jira global permission.

• permissionSchemes.getAllPermissionSchemes

  Returns all permission schemes.

  About permission schemes and grants

  A permission scheme is a collection of permission grants. A permission grant consists of a holder and a permission.

  Holder object

  The holder object contains information about the user or group being granted the permission. For example, the Administer projects permission is granted to a group named Teams in space administrators. In this case, the type is "type": "group", and the parameter is the group name, "parameter": "Teams in space administrators" and the value is group ID, "value": "ca85fac0-d974-40ca-a615-7af99c48d24f". The holder object is defined by the following properties:

  • type Identifies the user or group (see the list of types below).
  • parameter As a group's name can change, use of value is recommended. The value of this property depends on the type. For example, if the type is a group, then you need to specify the group name.
  • value The value of this property depends on the type. If the type is a group, then you need to specify the group ID. For other type it has the same value as parameter

  The following types are available. The expected values for parameter and value are given in parentheses (some types may not have a parameter or value):

  • anyone Grant for anonymous users.
  • applicationRole Grant for users with access to the specified application (application name, application name). See Update product access settings for more information.
  • assignee Grant for the user currently assigned to an issue.
  • group Grant for the specified group (parameter : group name, value : group ID).
  • groupCustomField Grant for a user in the group selected in the specified custom field (parameter : custom field ID, value : custom field ID).
  • projectLead Grant for a project lead.
  • projectRole Grant for the specified project role (parameter :project role ID, value : project role ID).
  • reporter Grant for the user who reported the issue.
  • sd.customer.portal.only Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See Customizing Jira Service Desk permissions for more information.
  • user Grant for the specified user (parameter : user ID - historically this was the userkey but that is deprecated and the account ID should be used, value : user ID).
  • userCustomField Grant for a user selected in the specified custom field (parameter : custom field ID, value : custom field ID).

  Built-in permissions

  The built-in Jira permissions are listed below. Apps can also define custom permissions. See the project permission and global permission module documentation for more information.

  Project permissions

  • ADMINISTER_PROJECTS
  • BROWSE_PROJECTS
  • MANAGE_SPRINTS_PERMISSION (Jira Software only)
  • SERVICEDESK_AGENT (Jira Service Desk only)
  • VIEW_DEV_TOOLS (Jira Software only)
  • VIEW_READONLY_WORKFLOW

  Issue permissions

  • ASSIGNABLE_USER
  • ASSIGN_ISSUES
  • CLOSE_ISSUES
  • CREATE_ISSUES
  • DELETE_ISSUES
  • EDIT_ISSUES
  • LINK_ISSUES
  • MODIFY_REPORTER
  • MOVE_ISSUES
  • RESOLVE_ISSUES
  • SCHEDULE_ISSUES
  • SET_ISSUE_SECURITY
  • TRANSITION_ISSUES

  Voters and watchers permissions

  • MANAGE_WATCHERS
  • VIEW_VOTERS_AND_WATCHERS

  Comments permissions

  • ADD_COMMENTS
  • DELETE_ALL_COMMENTS
  • DELETE_OWN_COMMENTS
  • EDIT_ALL_COMMENTS
  • EDIT_OWN_COMMENTS

  Attachments permissions

  • CREATE_ATTACHMENTS
  • DELETE_ALL_ATTACHMENTS
  • DELETE_OWN_ATTACHMENTS

  Time tracking permissions

  • DELETE_ALL_WORKLOGS
  • DELETE_OWN_WORKLOGS
  • EDIT_ALL_WORKLOGS
  • EDIT_OWN_WORKLOGS
  • WORK_ON_ISSUES

  Permissions required: Permission to access Jira.

• permissionSchemes.getPermissionScheme

  Returns a permission scheme.

  Permissions required: Permission to access Jira.

• permissionSchemes.getPermissionSchemeGrant

  Returns a permission grant.

  Permissions required: Permission to access Jira.

• permissionSchemes.getPermissionSchemeGrants

  Returns all permission grants for a permission scheme.

  Permissions required: Permission to access Jira.

• permissionSchemes.updatePermissionScheme

  Updates a permission scheme. Below are some important things to note when using this resource:

  • If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
  • If you want to update only the name and description, then do not send a permissions list in the request.
  • Sending an empty list will remove all permission grants from the permission scheme.

  If you want to add or delete a permission grant instead of updating the whole list, see Create permission grant or Delete permission scheme entity.

  See About permission schemes and grants for more details.

  Permissions required: Administer Jira global permission.

• projectAvatars.createProjectAvatar

  Loads an avatar for a project.

  Specify the avatar's local file location in the body of the request. Also, include the following headers:

  • X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers.
  • Content-Type: image/image type Valid image types are JPEG, GIF, or PNG.

  For example:
  curl --request POST

  --user email@example.com:<api_token>

  --header 'X-Atlassian-Token: no-check'

  --header 'Content-Type: image/< image_type>'

  --data-binary "<@/path/to/file/with/your/avatar>"

  --url 'https://your-domain.atlassian.net/rest/api/3/project/{projectIdOrKey}/avatar2'

  The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.

  The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.

  After creating the avatar use Set project avatar to set it as the project's displayed avatar.

  Permissions required: Administer projects project permission.

• projectAvatars.deleteProjectAvatar

  Deletes a custom avatar from a project. Note that system avatars cannot be deleted.

  Permissions required: Administer projects project permission.

• projectAvatars.getAllProjectAvatars

  Returns all project avatars, grouped by system and custom avatars.

  This operation can be accessed anonymously.

  Permissions required: Browse projects project permission for the project.

• projectAvatars.updateProjectAvatar

  Sets the avatar displayed for a project.

  Use Load project avatar to store avatars against the project, before using this operation to set the displayed avatar.

  Permissions required: Administer projects project permission.

• projectCategories.createProjectCategory

  Creates a project category.

  Permissions required: Administer Jira global permission.

• projectCategories.getAllProjectCategories

  Returns all project categories.

  Permissions required: Permission to access Jira.

• projectCategories.getProjectCategoryById

  Returns a project category.

  Permissions required: Permission to access Jira.

• projectCategories.removeProjectCategory

  Deletes a project category.

  Permissions required: Administer Jira global permission.

• projectCategories.updateProjectCategory

  Updates a project category.

  Permissions required: Administer Jira global permission.

• projectComponents.createComponent

  Creates a component. Use components to provide containers for issues within a project.

  This operation can be accessed anonymously.

  Permissions required: Administer projects project permission for the project in which the component is created or Administer Jira global permission.

• projectComponents.deleteComponent

  Deletes a component.

  This operation can be accessed anonymously.

  Permissions required: Administer projects project permission for the project containing the component or Administer Jira global permission.

• projectComponents.getComponent

  Returns a component.

  This operation can be accessed anonymously.

  Permissions required: Browse projects project permission for project containing the component.

• projectComponents.getComponentRelatedIssues

  Returns the counts of issues assigned to the component.

  This operation can be accessed anonymously.

  Permissions required: None.

• projectComponents.getProjectComponents

  Returns all components in a project. See the Get project components paginated resource if you want to get a full list of components with pagination.

  This operation can be accessed anonymously.

  Permissions required: Browse Projects project permission for the project.

• projectComponents.getProjectComponentsPaginated

  Returns a paginated list of all components in a project. See the Get project components resource if you want to get a full list of versions without pagination.

  This operation can be accessed anonymously.

  Permissions required: Browse Projects project permission for the project.

• projectComponents.updateComponent

  Updates a component. Any fields included in the request are overwritten. If leadAccountId is an empty string ("") the component lead is removed.

  This operation can be accessed anonymously.

  Permissions required: Administer projects project permission for the project containing the component or Administer Jira global permission.

• projectEmail.getProjectEmail

  Returns the project's sender email address.

  Permissions required: Browse projects project permission for the project.

• projectEmail.updateProjectEmail

  Sets the project's sender email address.

  If emailAddress is an empty string, the default email address is restored.

  Permissions required: Browse projects project permission for the project.

• projectFeatures.getFeaturesForProject

  Returns the list of features for a project.

• projectFeatures.toggleFeatureForProject

  Sets the state of a project feature.

• projectKeyAndNameValidation.getValidProjectKey

  Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key.

  Permissions required: None.

• projectKeyAndNameValidation.getValidProjectName

  Checks that a project name isn't in use. If the name isn't in use, the passed string is returned. If the name is in use, this operation attempts to generate a valid project name based on the one supplied, usually by adding a sequence number. If a valid project name cannot be generated, a 404 response is returned.

  Permissions required: None.

• projectKeyAndNameValidation.validateProjectKey

  Validates a project key by confirming the key is a valid string and not in use.

  Permissions required: None.

• projectPermissionSchemes.assignPermissionScheme

  Assigns a permission scheme with a project. See Managing project permissions for more information about permission schemes.

  Permissions required: Administer Jira global permission

• projectPermissionSchemes.getAssignedPermissionScheme

  Gets the permission scheme associated with the project.

  Permissions required: Administer Jira global permission or Administer projects project permission.

• projectPermissionSchemes.getProjectIssueSecurityScheme

  Returns the issue security scheme associated with the project.

  Permissions required: Administer Jira global permission or the Administer Projects project permission.

• projectPermissionSchemes.getSecurityLevelsForProject

  Returns all issue security levels for the project that the user has access to.

  This operation can be accessed anonymously.

  Permissions required: Browse projects global permission for the project, however, issue security levels are only returned for authenticated user with Set Issue Security global permission for the project.

• projectProperties.deleteProjectProperty

  Deletes the property from a project.

  This operation can be accessed anonymously.

  Permissions required: Administer Jira global permission or Administer Projects project permission for the project containing the property.

• projectProperties.getProjectProperty

  Returns the value of a project property.

  This operation can be accessed anonymously.

  Permissions required: Browse Projects project permission for the project containing the property.

• projectProperties.getProjectPropertyKeys

  Returns all project property keys for the project.

  This operation can be accessed anonymously.

  Permissions required: Browse Projects project permission for the project.

• projectProperties.setProjectProperty

  Sets the value of the project property. You can use project properties to store custom data against the project.

  The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

  This operation can be accessed anonymously.

  Permissions required: Administer Jira global permission or Administer Projects project permission for the project in which the property is created.

• projectRoleActors.addActorUsers

  Adds actors to a project role for the project.

  To replace all actors for the project, use Set actors for project role.

  This operation can be accessed anonymously.

  Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

• projectRoleActors.addProjectRoleActorsToRole

  Adds default actors to a role. You may add groups or users, but you cannot add groups and users in the same request.

  Changing a project role's default actors does not affect project role members for projects already created.

  Permissions required: Administer Jira global permission.

• projectRoleActors.deleteActor

  Deletes actors from a project role for the project.

  To remove default actors from the project role, use Delete default actors from project role.

  This operation can be accessed anonymously.

  Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

• projectRoleActors.deleteProjectRoleActorsFromRole

  Deletes the default actors from a project role. You may delete a group or user, but you cannot delete a group and a user in the same request.

  Changing a project role's default actors does not affect project role members for projects already created.

  Permissions required: Administer Jira global permission.

• projectRoleActors.getProjectRoleActorsForRole

  Returns the default actors for the project role.

  Permissions required: Administer Jira global permission.

• projectRoleActors.setActors

  Sets the actors for a project role for a project, replacing all existing actors.

  To add actors to the project without overwriting the existing list, use Add actors to project role.

  Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

• projectRoles.createProjectRole

  Creates a new project role with no default actors. You can use the Add default actors to project role operation to add default actors to the project role after creating it.

  Note that although a new project role is available to all projects upon creation, any default actors that are associated with the project role are not added to projects that existed prior to the role being created.<

  Permissions required: Administer Jira global permission.

• projectRoles.deleteProjectRole

  Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use.

  Permissions required: Administer Jira global permission.

• projectRoles.fullyUpdateProjectRole

  Updates the project role's name and description. You must include both a name and a description in the request.

  Permissions required: Administer Jira global permission.

• projectRoles.getAllProjectRoles

  Gets a list of all project roles, complete with project role details and default actors.

  About project roles

  Project roles are a flexible way to to associate users and groups with projects. In Jira Cloud, the list of project roles is shared globally with all projects, but each project can have a different set of actors associated with it (unlike groups, which have the same membership throughout all Jira applications).

  Project roles are used in permission schemes, email notification schemes, issue security levels, comment visibility, and workflow conditions.

  Members and actors

  In the Jira REST API, a member of a project role is called an actor. An actor is a group or user associated with a project role.

  Actors may be set as default members of the project role or set at the project level:

  • Default actors: Users and groups that are assigned to the project role for all newly created projects. The default actors can be removed at the project level later if desired.
  • Actors: Users and groups that are associated with a project role for a project, which may differ from the default actors. This enables you to assign a user to different roles in different projects.

  Permissions required: Administer Jira global permission.

• projectRoles.getProjectRole

  Returns a project role's details and actors associated with the project. The list of actors is sorted by display name.

  To check whether a user belongs to a role based on their group memberships, use Get user with the groups expand parameter selected. Then check whether the user keys and groups match with the actors returned for the project.

  This operation can be accessed anonymously.

  Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

• projectRoles.getProjectRoleById

  Gets the project role details and the default actors associated with the role. The list of default actors is sorted by display name.

  Permissions required: Administer Jira global permission.

• projectRoles.getProjectRoleDetails

  Returns all project roles and the details for each role. Note that the list of project roles is common to all projects.

  This operation can be accessed anonymously.

  Permissions required: Administer Jira global permission or Administer projects project permission for the project.

• projectRoles.getProjectRoles

  Returns a list of project roles for the project returning the name and self URL for each role.

  Note that all project roles are shared with all projects in Jira Cloud. See Get all project roles for more information.

  This operation can be accessed anonymously.

  Permissions required: Administer Projects project permission for any project on the site or Administer Jira global permission.

• projectRoles.partialUpdateProjectRole

  Updates either the project role's name or its description.

  You cannot update both the name and description at the same time using this operation. If you send a request with a name and a description only the name is updated.

  Permissions required: Administer Jira global permission.

• projects.archiveProject

  Archives a project. You can't delete a project if it's archived. To delete an archived project, restore the project and then delete it. To restore a project, use the Jira UI.

  Permissions required: Administer Jira global permission.

• projects.createProject

  Creates a project based on a project type template, as shown in the following table:

  Project Type Key	Project Template Key
  business	com.atlassian.jira-core-project-templates:jira-core-simplified-content-management, com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval, com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking, com.atlassian.jira-core-project-templates:jira-core-simplified-process-control, com.atlassian.jira-core-project-templates:jira-core-simplified-procurement, com.atlassian.jira-core-project-templates:jira-core-simplified-project-management, com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment, com.atlassian.jira-core-project-templates:jira-core-simplified-task-tracking
  service_desk	com.atlassian.servicedesk:simplified-it-service-management, com.atlassian.servicedesk:simplified-general-service-desk-it, com.atlassian.servicedesk:simplified-general-service-desk-business, com.atlassian.servicedesk:simplified-internal-service-desk, com.atlassian.servicedesk:simplified-external-service-desk, com.atlassian.servicedesk:simplified-hr-service-desk, com.atlassian.servicedesk:simplified-facilities-service-desk, com.atlassian.servicedesk:simplified-legal-service-desk, com.atlassian.servicedesk:simplified-analytics-service-desk, com.atlassian.servicedesk:simplified-marketing-service-desk, com.atlassian.servicedesk:simplified-finance-service-desk
  software	com.pyxis.greenhopper.jira:gh-simplified-agility-kanban, com.pyxis.greenhopper.jira:gh-simplified-agility-scrum, com.pyxis.greenhopper.jira:gh-simplified-basic, com.pyxis.greenhopper.jira:gh-simplified-kanban-classic, com.pyxis.greenhopper.jira:gh-simplified-scrum-classic
  The project types are available according to the installed Jira features as follows:

  • Jira Core, the default, enables business projects.
  • Jira Service Management enables service_desk projects.
  • Jira Software enables software projects.

  To determine which features are installed, go to Jira settings > Apps > Manage apps and review the System Apps list. To add Jira Software or Jira Service Management into a JIRA instance, use Jira settings > Apps > Finding new apps. For more information, see Managing add-ons.

  Permissions required: Administer Jira global permission.

• projects.deleteProject

  Deletes a project.

  You can't delete a project if it's archived. To delete an archived project, restore the project and then delete it. To restore a project, use the Jira UI.

  Permissions required: Administer Jira global permission.

• projects.deleteProjectAsynchronously

  Deletes a project asynchronously.

  This operation is:

  • transactional, that is, if part of the delete fails the project is not deleted.
  • asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

  Permissions required: Administer Jira global permission.

• projects.getAllProjects

  Returns all projects visible to the user. Deprecated, use Get projects paginated that supports search and pagination.

  This operation can be accessed anonymously.

  Permissions required: Projects are returned only where the user has Browse Projects or Administer projects project permission for the project.

• projects.getAllStatuses

  Returns the valid statuses for a project. The statuses are grouped by issue type, as each project has a set of valid issue types and each issue type has a set of valid statuses.

  This operation can be accessed anonymously.

  Permissions required: Browse Projects project permission for the project.

• projects.getHierarchy

  Get the issue type hierarchy for a next-gen project.

  The issue type hierarchy for a project consists of:

  • Epic at level 1 (optional).
  • One or more issue types at level 0 such as Story, Task, or Bug. Where the issue type Epic is defined, these issue types are used to break down the content of an epic.
  • Subtask at level -1 (optional). This issue type enables level 0 issue types to be broken down into components. Issues based on a level -1 issue type must have a parent issue.

  Permissions required: Browse projects project permission for the project.

• projects.getNotificationSchemeForProject

  Gets a notification scheme associated with the project. Deprecated, use Get notification schemes paginated supporting search and pagination.

  Permissions required: Administer Jira global permission or Administer Projects project permission.

• projects.getProject

  Returns the project details for a project.

  This operation can be accessed anonymously.

  Permissions required: Browse projects project permission for the project.

• projects.getRecent

  Returns a list of up to 20 projects recently viewed by the user that are still visible to the user.

  This operation can be accessed anonymously.

  Permissions required: Projects are returned only where the user has one of:

  • Browse Projects project permission for the project.
  • Administer Projects project permission for the project.
  • Administer Jira global permission.
• projects.restore

  Restores a project that has been archived or placed in the Jira recycle bin.

  Permissions required: Administer Jira global permission.

• projects.searchProjects

  Returns a paginated list of projects visible to the user.

  This operation can be accessed anonymously.

  Permissions required: Projects are returned only where the user has one of:

  • Browse Projects project permission for the project.
  • Administer Projects project permission for the project.
  • Administer Jira global permission.
• projects.updateProject

  Updates the project details of a project.

  All parameters are optional in the body of the request.

  Permissions required: Administer Jira global permission.

• projects.updateProjectType

  Deprecated, this feature is no longer supported and no alternatives are available, see Convert project to a different template or type. Updates a project type. The project type can be updated for classic projects only, project type cannot be updated for next-gen projects.

  Permissions required: Administer Jira global permission.

• projectTypes.getAccessibleProjectTypeByKey

  Returns a project type if it is accessible to the user.

  Permissions required: Permission to access Jira.

• projectTypes.getAllAccessibleProjectTypes

  Returns all project types with a valid license.

• projectTypes.getAllProjectTypes

  Returns all project types, whether or not the instance has a valid license for each type.

  This operation can be accessed anonymously.

  Permissions required: None.

• projectTypes.getProjectTypeByKey

  Returns a project type.

  This operation can be accessed anonymously.

  Permissions required: None.

• projectVersions.createVersion

  Creates a project version.

  This operation can be accessed anonymously.

  Permissions required: Administer Jira global permission or Administer Projects project permission for the project the version is added to.

• projectVersions.deleteAndReplaceVersion

  Deletes a project version.

  Alternative versions can be provided to update issues that use the deleted version in fixVersion, affectedVersion, or any version picker custom fields. If alternatives are not provided, occurrences of fixVersion, affectedVersion, and any version picker custom field, that contain the deleted version, are cleared. Any replacement version must be in the same project as the version being deleted and cannot be the version being deleted.

  This operation can be accessed anonymously.

  Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.

• projectVersions.deleteVersion

  Deletes a project version.

  Deprecated, use Delete and replace version that supports swapping version values in custom fields, in addition to the swapping for fixVersion and affectedVersion provided in this resource.

  Alternative versions can be provided to update issues that use the deleted version in fixVersion or affectedVersion. If alternatives are not provided, occurrences of fixVersion and affectedVersion that contain the deleted version are cleared.

  This operation can be accessed anonymously.

  Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.

• projectVersions.getProjectVersions

  Returns all versions in a project. The response is not paginated. Use Get project versions paginated if you want to get the versions in a project with pagination.

  This operation can be accessed anonymously.

  Permissions required: Browse Projects project permission for the project.

• projectVersions.getProjectVersionsPaginated

  Returns a paginated list of all versions in a project. See the Get project versions resource if you want to get a full list of versions without pagination.

  This operation can be accessed anonymously.

  Permissions required: Browse Projects project permission for the project.

• projectVersions.getVersion

  Returns a project version.

  This operation can be accessed anonymously.

  Permissions required: Browse projects project permission for the project containing the version.

• projectVersions.getVersionRelatedIssues

  Returns the following counts for a version:

  • Number of issues where the fixVersion is set to the version.
  • Number of issues where the affectedVersion is set to the version.
  • Number of issues where a version custom field is set to the version.

  This operation can be accessed anonymously.

  Permissions required: Browse projects project permission for the project that contains the version.

• projectVersions.getVersionUnresolvedIssues

  Returns counts of the issues and unresolved issues for the project version.

  This operation can be accessed anonymously.

  Permissions required: Browse projects project permission for the project that contains the version.

• projectVersions.mergeVersions

  Merges two project versions. The merge is completed by deleting the version specified in id and replacing any occurrences of its ID in fixVersion with the version ID specified in moveIssuesTo.

  Consider using Delete and replace version instead. This resource supports swapping version values in fixVersion, affectedVersion, and custom fields.

  This operation can be accessed anonymously.

  Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.

• projectVersions.moveVersion

  Modifies the version's sequence within the project, which affects the display order of the versions in Jira.

  This operation can be accessed anonymously.

  Permissions required: Browse projects project permission for the project that contains the version.

• projectVersions.updateVersion

  Updates a project version.

  This operation can be accessed anonymously.

  Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.

• rest.getPrecomputations
• rest.updatePrecomputations
• screens.addFieldToDefaultScreen

  Adds a field to the default tab of the default screen.

  Permissions required: Administer Jira global permission.

• screens.createScreen

  Creates a screen with a default field tab.

  Permissions required: Administer Jira global permission.

• screens.deleteScreen

  Deletes a screen. A screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft.

  Only screens used in classic projects can be deleted.

• screens.getAvailableScreenFields

  Returns the fields that can be added to a tab on a screen.

  Permissions required: Administer Jira global permission.

• screens.getScreens

  Returns a paginated list of all screens or those specified by one or more screen IDs.

  Permissions required: Administer Jira global permission.

• screens.getScreensForField

  Returns a paginated list of the screens a field is used in.

  Permissions required: Administer Jira global permission.

• screens.updateScreen

  Updates a screen. Only screens used in classic projects can be updated.

  Permissions required: Administer Jira global permission.

• screenSchemes.createScreenScheme

  Creates a screen scheme.

  Permissions required: Administer Jira global permission.

• screenSchemes.deleteScreenScheme

  Deletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme.

  Only screens schemes used in classic projects can be deleted.

  Permissions required: Administer Jira global permission.

• screenSchemes.getScreenSchemes

  Returns a paginated list of screen schemes.

  Only screen schemes used in classic projects are returned.

  Permissions required: Administer Jira global permission.

• screenSchemes.updateScreenScheme

  Updates a screen scheme. Only screen schemes used in classic projects can be updated.

  Permissions required: Administer Jira global permission.

• screenTabFields.addScreenTabField

  Adds a field to a screen tab.

  Permissions required: Administer Jira global permission.

• screenTabFields.getAllScreenTabFields

  Returns all fields for a screen tab.

  Permissions required:

  • Administer Jira global permission.
  • Administer projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.
• screenTabFields.moveScreenTabField

  Moves a screen tab field.

  If after and position are provided in the request, position is ignored.

  Permissions required: Administer Jira global permission.

• screenTabFields.removeScreenTabField

  Removes a field from a screen tab.

  Permissions required: Administer Jira global permission.

• screenTabs.addScreenTab

  Creates a tab for a screen.

  Permissions required: Administer Jira global permission.

• screenTabs.deleteScreenTab

  Deletes a screen tab.

  Permissions required: Administer Jira global permission.

• screenTabs.getAllScreenTabs

  Returns the list of tabs for a screen.

  Permissions required:

  • Administer Jira global permission.
  • Administer projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.
• screenTabs.moveScreenTab

  Moves a screen tab.

  Permissions required: Administer Jira global permission.

• screenTabs.renameScreenTab

  Updates the name of a screen tab.

  Permissions required: Administer Jira global permission.

• serverInfo.getServerInfo

  Returns information about the Jira instance.

  This operation can be accessed anonymously.

  Permissions required: None.

• status.createStatuses

  Creates statuses for a global or project scope.

  Permissions required:

  • Administer projects project permission.
  • Administer Jira project permission.
• status.deleteStatusesById

  Deletes statuses by ID.

  Permissions required:

  • Administer projects project permission.
  • Administer Jira project permission.
• status.getStatusesById

  Returns a list of the statuses specified by one or more status IDs.

  Permissions required:

  • Administer projects project permission.
  • Administer Jira project permission.
• status.search

  Returns a paginated list of statuses that match a search on name or project.

  Permissions required:

  • Administer projects project permission.
  • Administer Jira project permission.
• status.updateStatuses

  Updates statuses by ID.

  Permissions required:

  • Administer projects project permission.
  • Administer Jira project permission.
• tasks.cancelTask

  Cancels a task.

  Permissions required: either of:

  • Administer Jira global permission.
  • Creator of the task.
• tasks.getTask

  Returns the status of a long-running asynchronous task.

  When a task has finished, this operation returns the JSON blob applicable to the task. See the documentation of the operation that created the task for details. Task details are not permanently retained. As of September 2019, details are retained for 14 days although this period may change without notice.

  Permissions required: either of:

  • Administer Jira global permission.
  • Creator of the task.
• timeTracking.getAvailableTimeTrackingImplementations

  Returns all time tracking providers. By default, Jira only has one time tracking provider: JIRA provided time tracking. However, you can install other time tracking providers via apps from the Atlassian Marketplace. For more information on time tracking providers, see the documentation for the Time Tracking Provider module.

  Permissions required: Administer Jira global permission.

• timeTracking.getSelectedTimeTrackingImplementation

  Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a successful but empty response is returned.

  Permissions required: Administer Jira global permission.

• timeTracking.getSharedTimeTrackingConfiguration

  Returns the time tracking settings. This includes settings such as the time format, default time unit, and others. For more information, see Configuring time tracking.

  Permissions required: Administer Jira global permission.

• timeTracking.selectTimeTrackingImplementation

  Selects a time tracking provider.

  Permissions required: Administer Jira global permission.

• timeTracking.setSharedTimeTrackingConfiguration

  Sets the time tracking settings.

  Permissions required: Administer Jira global permission.

• uiModificationsApps.createUiModification

  Creates a UI modification. UI modification can only be created by Forge apps.

  Each app can define up to 100 UI modifications. Each UI modification can define up to 1000 contexts.

  Permissions required:

  • None if the UI modification is created without contexts.
  • Browse projects project permission for one or more projects, if the UI modification is created with contexts.
• uiModificationsApps.deleteUiModification

  Deletes a UI modification. All the contexts that belong to the UI modification are deleted too. UI modification can only be deleted by Forge apps.

  Permissions required: None.

• uiModificationsApps.getUiModifications

  Gets UI modifications. UI modifications can only be retrieved by Forge apps.

  Permissions required: None.

• uiModificationsApps.updateUiModification

  Updates a UI modification. UI modification can only be updated by Forge apps.

  Each UI modification can define up to 1000 contexts.

  Permissions required:

  • None if the UI modification is created without contexts.
  • Browse projects project permission for one or more projects, if the UI modification is created with contexts.
• userProperties.deleteUserProperty

  Deletes a property from a user.

  Note: This operation does not access the user properties created and maintained in Jira.

  Permissions required:

  • Administer Jira global permission, to delete a property from any user.
  • Access to Jira, to delete a property from the calling user's record.
• userProperties.getUserProperty

  Returns the value of a user's property. If no property key is provided Get user property keys is called.

  Note: This operation does not access the user properties created and maintained in Jira.

  Permissions required:

  • Administer Jira global permission, to get a property from any user.
  • Access to Jira, to get a property from the calling user's record.
• userProperties.getUserPropertyKeys

  Returns the keys of all properties for a user.

  Note: This operation does not access the user properties created and maintained in Jira.

  Permissions required:

  • Administer Jira global permission, to access the property keys on any user.
  • Access to Jira, to access the calling user's property keys.
• userProperties.setUserProperty

  Sets the value of a user's property. Use this resource to store custom data against a user.

  Note: This operation does not access the user properties created and maintained in Jira.

  Permissions required:

  • Administer Jira global permission, to set a property on any user.
  • Access to Jira, to set a property on the calling user's record.
• users.bulkGetUsers

  Returns a paginated list of the users specified by one or more account IDs.

  Permissions required: Permission to access Jira.

• users.bulkGetUsersMigration

  Returns the account IDs for the users specified in the key or username parameters. Note that multiple key or username parameters can be specified.

  Permissions required: Permission to access Jira.

• users.createUser

  Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated.

  If the user exists and has access to Jira, the operation returns a 201 status. If the user exists but does not have access to Jira, the operation returns a 400 status.

  Permissions required: Administer Jira global permission.

• users.getAllUsers

  Returns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account.

  Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

  Permissions required: Browse users and groups global permission.

• users.getAllUsersDefault

  Returns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account.

  Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

  Permissions required: Browse users and groups global permission.

• users.getUser

  Returns a user.

  Privacy controls are applied to the response based on the user's preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

  Permissions required: Browse users and groups global permission.

• users.getUserDefaultColumns

  Returns the default issue table columns for the user. If accountId is not passed in the request, the calling user's details are returned.

  Permissions required:

  • Administer Jira global permission, to get the column details for any user.
  • Permission to access Jira, to get the calling user's column details.
• users.getUserEmail

  Returns a user's email address. This API is only available to apps approved by Atlassian, according to these guidelines.

• users.getUserEmailBulk

  Returns a user's email address. This API is only available to apps approved by Atlassian, according to these guidelines.

• users.getUserGroups

  Returns the groups to which a user belongs.

  Permissions required: Browse users and groups global permission.

• users.removeUser

  Deletes a user. If the operation completes successfully then the user is removed from Jira's user base. This operation does not delete the user's Atlassian account.

  Permissions required: Site administration (that is, membership of the site-admin group).

• users.resetUserColumns

  Resets the default issue table columns for the user to the system default. If accountId is not passed, the calling user's default columns are reset.

  Permissions required:

  • Administer Jira global permission, to set the columns on any user.
  • Permission to access Jira, to set the calling user's columns.
• users.setUserColumns

  Sets the default issue table columns for the user. If an account ID is not passed, the calling user's default columns are set. If no column details are sent, then all default columns are removed.

  The parameters for this resource are expressed as HTML form data. For example, in curl:

  curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5'

  Permissions required:

  • Administer Jira global permission, to set the columns on any user.
  • Permission to access Jira, to set the calling user's columns.
• userSearch.findAssignableUsers

  Returns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be assigned to:

  • a new issue, by providing the projectKeyOrId.
  • an updated issue, by providing the issueKey.
  • to an issue during a transition (workflow action), by providing the issueKey and the transition id in actionDescriptorId. You can obtain the IDs of an issue's valid transitions using the transitions option in the expand parameter of Get issue.

  In all these cases, you can pass an account ID to determine if a user can be assigned to an issue. The user is returned in the response if they can be assigned to the issue or issue transition.

  This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that can be assigned the issue. This means the operation usually returns fewer users than specified in maxResults. To get all the users who can be assigned the issue, use Get all users and filter the records in your code.

  Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

  Permissions required: Permission to access Jira.

• userSearch.findBulkAssignableUsers

  Returns a list of users who can be assigned issues in one or more projects. The list may be restricted to users whose attributes match a string.

  This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that can be assigned issues in the projects. This means the operation usually returns fewer users than specified in maxResults. To get all the users who can be assigned issues in the projects, use Get all users and filter the records in your code.

  Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

  This operation can be accessed anonymously.

  Permissions required: None.

• userSearch.findUserKeysByQuery

  Finds users with a structured query and returns a paginated list of user keys.

  This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the structured query, use Get all users and filter the records in your code.

  Permissions required: Browse users and groups global permission.

  The query statements are:

  • is assignee of PROJ Returns the users that are assignees of at least one issue in project PROJ.
  • is assignee of (PROJ-1, PROJ-2) Returns users that are assignees on the issues PROJ-1 or PROJ-2.
  • is reporter of (PROJ-1, PROJ-2) Returns users that are reporters on the issues PROJ-1 or PROJ-2.
  • is watcher of (PROJ-1, PROJ-2) Returns users that are watchers on the issues PROJ-1 or PROJ-2.
  • is voter of (PROJ-1, PROJ-2) Returns users that are voters on the issues PROJ-1 or PROJ-2.
  • is commenter of (PROJ-1, PROJ-2) Returns users that have posted a comment on the issues PROJ-1 or PROJ-2.
  • is transitioner of (PROJ-1, PROJ-2) Returns users that have performed a transition on issues PROJ-1 or PROJ-2.
  • [propertyKey].entity.property.path is "property value" Returns users with the entity property value.

  The list of issues can be extended as needed, as in (PROJ-1, PROJ-2, ... PROJ-n). Statements can be combined using the AND and OR operators to form more complex queries. For example:

  is assignee of PROJ AND [propertyKey].entity.property.path is "property value"

• userSearch.findUsers

  Returns a list of users that match the search string and property.

  This operation first applies a filter to match the search string and property, and then takes the filtered users in the range defined by startAt and maxResults, up to the thousandth user. To get all the users who match the search string and property, use Get all users and filter the records in your code.

  This operation can be accessed anonymously.

  Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

  Permissions required: Browse users and groups global permission. Anonymous calls or calls by users without the required permission return empty search results.

• userSearch.findUsersByQuery

  Finds users with a structured query and returns a paginated list of user details.

  This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the structured query, use Get all users and filter the records in your code.

  Permissions required: Browse users and groups global permission.

  The query statements are:

  • is assignee of PROJ Returns the users that are assignees of at least one issue in project PROJ.
  • is assignee of (PROJ-1, PROJ-2) Returns users that are assignees on the issues PROJ-1 or PROJ-2.
  • is reporter of (PROJ-1, PROJ-2) Returns users that are reporters on the issues PROJ-1 or PROJ-2.
  • is watcher of (PROJ-1, PROJ-2) Returns users that are watchers on the issues PROJ-1 or PROJ-2.
  • is voter of (PROJ-1, PROJ-2) Returns users that are voters on the issues PROJ-1 or PROJ-2.
  • is commenter of (PROJ-1, PROJ-2) Returns users that have posted a comment on the issues PROJ-1 or PROJ-2.
  • is transitioner of (PROJ-1, PROJ-2) Returns users that have performed a transition on issues PROJ-1 or PROJ-2.
  • [propertyKey].entity.property.path is "property value" Returns users with the entity property value.

  The list of issues can be extended as needed, as in (PROJ-1, PROJ-2, ... PROJ-n). Statements can be combined using the AND and OR operators to form more complex queries. For example:

  is assignee of PROJ AND [propertyKey].entity.property.path is "property value"

• userSearch.findUsersForPicker

  Returns a list of users whose attributes match the query term. The returned object includes the html field where the matched query term is highlighted with the HTML strong tag. A list of account IDs can be provided to exclude users from the results.

  This operation takes the users in the range defined by maxResults, up to the thousandth user, and then returns only the users from that range that match the query term. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the query term, use Get all users and filter the records in your code.

  Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

  This operation can be accessed anonymously.

  Permissions required: Browse users and groups global permission. Anonymous calls and calls by users without the required permission return search results for an exact name match only.

• userSearch.findUsersWithAllPermissions

  Returns a list of users who fulfill these criteria:

  • their user attributes match a search string.
  • they have a set of permissions for a project or issue.

  If no search string is provided, a list of all users with the permissions is returned.

  This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the search string and have permission for the project or issue. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the search string and have permission for the project or issue, use Get all users and filter the records in your code.

  Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

  This operation can be accessed anonymously.

  Permissions required:

  • Administer Jira global permission, to get users for any project.
  • Administer Projects project permission for a project, to get users for that project.
• userSearch.findUsersWithBrowsePermission

  Returns a list of users who fulfill these criteria:

  • their user attributes match a search string.
  • they have permission to browse issues.

  Use this resource to find users who can browse:

  • an issue, by providing the issueKey.
  • any issue in a project, by providing the projectKey.

  This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the search string and have permission to browse issues. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the search string and have permission to browse issues, use Get all users and filter the records in your code.

  Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

  This operation can be accessed anonymously.

  Permissions required: Browse users and groups global permission. Anonymous calls and calls by users without the required permission return empty search results.

• webhooks.deleteWebhookById

  Removes webhooks by ID. Only webhooks registered by the calling app are removed. If webhooks created by other apps are specified, they are ignored.

  Permissions required: Only Connect and OAuth 2.0 apps can use this operation.

• webhooks.getDynamicWebhooksForApp

  Returns a paginated list of the webhooks registered by the calling app.

  Permissions required: Only Connect and OAuth 2.0 apps can use this operation.

• webhooks.getFailedWebhooks

  Returns webhooks that have recently failed to be delivered to the requesting app after the maximum number of retries.

  After 72 hours the failure may no longer be returned by this operation.

  The oldest failure is returned first.

  This method uses a cursor-based pagination. To request the next page use the failure time of the last webhook on the list as the failedAfter value or use the URL provided in next.

  Permissions required: Only Connect apps can use this operation.

• webhooks.refreshWebhooks

  Extends the life of webhook. Webhooks registered through the REST API expire after 30 days. Call this operation to keep them alive.

  Unrecognized webhook IDs (those that are not found or belong to other apps) are ignored.

  Permissions required: Only Connect and OAuth 2.0 apps can use this operation.

• webhooks.registerDynamicWebhooks

  Registers webhooks.

  NOTE: for non-public OAuth apps, webhooks are delivered only if there is a match between the app owner and the user who registered a dynamic webhook.

  Permissions required: Only Connect and OAuth 2.0 apps can use this operation.

• workflows.createWorkflow

  Creates a workflow. You can define transition rules using the shapes detailed in the following sections. If no transitional rules are specified the default system transition rules are used.

  Conditions

  Conditions enable workflow rules that govern whether a transition can execute.

  Always false condition

  A condition that always fails.

  {   "type": "AlwaysFalseCondition" }

  Block transition until approval

  A condition that blocks issue transition if there is a pending approval.

  {   "type": "BlockInProgressApprovalCondition" }

  Compare number custom field condition

  A condition that allows transition if a comparison between a number custom field and a value is true.

  {   "type": "CompareNumberCFCondition",   "configuration": {     "comparator": "=",     "fieldId": "customfield_10029",     "fieldValue": 2   } }

  • comparator One of the supported comparator: =, >, and <.

  • fieldId The custom numeric field ID. Allowed field types:

    • com.atlassian.jira.plugin.system.customfieldtypes:float
    • com.pyxis.greenhopper.jira:jsw-story-points

  • fieldValue The value for comparison.

  Hide from user condition

  A condition that hides a transition from users. The transition can only be triggered from a workflow function or REST API operation.

  {   "type": "RemoteOnlyCondition" }

  Only assignee condition

  A condition that allows only the assignee to execute a transition.

  {   "type": "AllowOnlyAssignee" }

  Only Bamboo notifications workflow condition

  A condition that makes the transition available only to Bamboo build notifications.

  {   "type": "OnlyBambooNotificationsCondition" }

  Only reporter condition

  A condition that allows only the reporter to execute a transition.

  {   "type": "AllowOnlyReporter" }

  Permission condition

  A condition that allows only users with a permission to execute a transition.

  {   "type": "PermissionCondition",   "configuration": {       "permissionKey": "BROWSE_PROJECTS"   } }

  • permissionKey The permission required to perform the transition. Allowed values: built-in or app defined permissions.

  Previous status condition

  A condition that allows a transition based on whether an issue has or has not transitioned through a status.

  {   "type": "PreviousStatusCondition",   "configuration": {     "ignoreLoopTransitions": true,     "includeCurrentStatus": true,     "mostRecentStatusOnly": true,     "reverseCondition": true,     "previousStatus": {       "id": "5"     }   } }

  By default this condition allows the transition if the status, as defined by its ID in the previousStatus object, matches any previous issue status, unless:

  • ignoreLoopTransitions is true, then loop transitions (from and to the same status) are ignored.
  • includeCurrentStatus is true, then the current issue status is also checked.
  • mostRecentStatusOnly is true, then only the issue's preceding status (the one immediately before the current status) is checked.
  • reverseCondition is true, then the status must not be present.

  Separation of duties condition

  A condition that prevents a user to perform the transition, if the user has already performed a transition on the issue.

  {   "type": "SeparationOfDutiesCondition",   "configuration": {     "fromStatus": {       "id": "5"     },     "toStatus": {       "id": "6"     }   } }

  • fromStatus OPTIONAL. An object containing the ID of the source status of the transition that is blocked. If omitted any transition to toStatus is blocked.
  • toStatus An object containing the ID of the target status of the transition that is blocked.

  Subtask blocking condition

  A condition that blocks transition on a parent issue if any of its subtasks are in any of one or more statuses.

  {   "type": "SubTaskBlockingCondition",   "configuration": {     "statuses": [       {         "id": "1"       },       {         "id": "3"       }     ]   } }

  • statuses A list of objects containing status IDs.

  User is in any group condition

  A condition that allows users belonging to any group from a list of groups to execute a transition.

  {   "type": "UserInAnyGroupCondition",   "configuration": {     "groups": [       "administrators",       "atlassian-addons-admin"     ]   } }

  • groups A list of group names.

  User is in any project role condition

  A condition that allows only users with at least one project roles from a list of project roles to execute a transition.

  {   "type": "InAnyProjectRoleCondition",   "configuration": {     "projectRoles": [       {         "id": "10002"       },       {         "id": "10003"       },       {         "id": "10012"       },       {         "id": "10013"       }     ]   } }

  • projectRoles A list of objects containing project role IDs.

  User is in custom field condition

  A condition that allows only users listed in a given custom field to execute the transition.

  {   "type": "UserIsInCustomFieldCondition",   "configuration": {     "allowUserInField": false,     "fieldId": "customfield_10010"   } }

  • allowUserInField If true only a user who is listed in fieldId can perform the transition, otherwise, only a user who is not listed in fieldId can perform the transition.
  • fieldId The ID of the field containing the list of users.

  User is in group condition

  A condition that allows users belonging to a group to execute a transition.

  {   "type": "UserInGroupCondition",   "configuration": {     "group": "administrators"   } }

  • group The name of the group.

  User is in group custom field condition

  A condition that allows users belonging to a group specified in a custom field to execute a transition.

  {   "type": "InGroupCFCondition",   "configuration": {     "fieldId": "customfield_10012"   } }

  • fieldId The ID of the field. Allowed field types:

    • com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker
    • com.atlassian.jira.plugin.system.customfieldtypes:grouppicker
    • com.atlassian.jira.plugin.system.customfieldtypes:select
    • com.atlassian.jira.plugin.system.customfieldtypes:multiselect
    • com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons
    • com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes
    • com.pyxis.greenhopper.jira:gh-epic-status

  User is in project role condition

  A condition that allows users with a project role to execute a transition.

  {   "type": "InProjectRoleCondition",   "configuration": {     "projectRole": {       "id": "10002"     }   } }

  • projectRole An object containing the ID of a project role.

  Value field condition

  A conditions that allows a transition to execute if the value of a field is equal to a constant value or simply set.

  {   "type": "ValueFieldCondition",   "configuration": {     "fieldId": "assignee",     "fieldValue": "qm:6e1ecee6-8e64-4db6-8c85-916bb3275f51:54b56885-2bd2-4381-8239-78263442520f",     "comparisonType": "NUMBER",     "comparator": "="   } }

  • fieldId The ID of a field used in the comparison.
  • fieldValue The expected value of the field.
  • comparisonType The type of the comparison. Allowed values: STRING, NUMBER, DATE, DATE_WITHOUT_TIME, or OPTIONID.
  • comparator One of the supported comparator: >, >=, =, <=, <, !=.

  Notes:

  • If you choose the comparison type STRING, only = and != are valid options.
  • You may leave fieldValue empty when comparison type is != to indicate that a value is required in the field.
  • For date fields without time format values as yyyy-MM-dd, and for those with time as yyyy-MM-dd HH:mm. For example, for July 16 2021 use 2021-07-16, for 8:05 AM use 2021-07-16 08:05, and for 4 PM: 2021-07-16 16:00.

  Validators

  Validators check that any input made to the transition is valid before the transition is performed.

  Date field validator

  A validator that compares two dates.

  {   "type": "DateFieldValidator",   "configuration": {       "comparator": ">",       "date1": "updated",       "date2": "created",       "expression": "1d",       "includeTime": true     } }

  • comparator One of the supported comparator: >, >=, =, <=, <, or !=.

  • date1 The date field to validate. Allowed field types:

    • com.atlassian.jira.plugin.system.customfieldtypes:datepicker
    • com.atlassian.jira.plugin.system.customfieldtypes:datetime
    • com.atlassian.jpo:jpo-custom-field-baseline-end
    • com.atlassian.jpo:jpo-custom-field-baseline-start
    • duedate
    • created
    • updated
    • resolutiondate

  • date2 The second date field. Required, if expression is not passed. Allowed field types:

    • com.atlassian.jira.plugin.system.customfieldtypes:datepicker
    • com.atlassian.jira.plugin.system.customfieldtypes:datetime
    • com.atlassian.jpo:jpo-custom-field-baseline-end
    • com.atlassian.jpo:jpo-custom-field-baseline-start
    • duedate
    • created
    • updated
    • resolutiondate

  • expression An expression specifying an offset. Required, if date2 is not passed. Offsets are built with a number, with - as prefix for the past, and one of these time units: d for day, w for week, m for month, or y for year. For example, -2d means two days into the past and 1w means one week into the future. The now keyword enables a comparison with the current date.

  • includeTime If true, then the time part of the data is included for the comparison. If the field doesn't have a time part, 00:00:00 is used.

  Windows date validator

  A validator that checks that a date falls on or after a reference date and before or on the reference date plus a number of days.

  {   "type": "WindowsDateValidator",   "configuration": {       "date1": "customfield_10009",       "date2": "created",       "windowsDays": 5     } }

  • date1 The date field to validate. Allowed field types:

    • com.atlassian.jira.plugin.system.customfieldtypes:datepicker
    • com.atlassian.jira.plugin.system.customfieldtypes:datetime
    • com.atlassian.jpo:jpo-custom-field-baseline-end
    • com.atlassian.jpo:jpo-custom-field-baseline-start
    • duedate
    • created
    • updated
    • resolutiondate

  • date2 The reference date. Allowed field types:

    • com.atlassian.jira.plugin.system.customfieldtypes:datepicker
    • com.atlassian.jira.plugin.system.customfieldtypes:datetime
    • com.atlassian.jpo:jpo-custom-field-baseline-end
    • com.atlassian.jpo:jpo-custom-field-baseline-start
    • duedate
    • created
    • updated
    • resolutiondate

  • windowsDays A positive integer indicating a number of days.

  Field required validator

  A validator that checks fields are not empty. By default, if a field is not included in the current context it's ignored and not validated.

  {     "type": "FieldRequiredValidator",     "configuration": {         "ignoreContext": true,         "errorMessage": "Hey",         "fieldIds": [             "versions",             "customfield_10037",             "customfield_10003"         ]     } }

  • ignoreContext If true, then the context is ignored and all the fields are validated.
  • errorMessage OPTIONAL. The error message displayed when one or more fields are empty. A default error message is shown if an error message is not provided.
  • fieldIds The list of fields to validate.

  Field changed validator

  A validator that checks that a field value is changed. However, this validation can be ignored for users from a list of groups.

  {     "type": "FieldChangedValidator",     "configuration": {         "fieldId": "comment",         "errorMessage": "Hey",         "exemptedGroups": [             "administrators",             "atlassian-addons-admin"         ]     } }

  • fieldId The ID of a field.
  • errorMessage OPTIONAL. The error message displayed if the field is not changed. A default error message is shown if the error message is not provided.
  • exemptedGroups OPTIONAL. The list of groups.

  Field has single value validator

  A validator that checks that a multi-select field has only one value. Optionally, the validation can ignore values copied from subtasks.

  {     "type": "FieldHasSingleValueValidator",     "configuration": {         "fieldId": "attachment,         "excludeSubtasks": true     } }

  • fieldId The ID of a field.
  • excludeSubtasks If true, then values copied from subtasks are ignored.

  Parent status validator

  A validator that checks the status of the parent issue of a subtask. Ìf the issue is not a subtask, no validation is performed.

  {     "type": "ParentStatusValidator",     "configuration": {         "parentStatuses": [             {               "id":"1"             },             {               "id":"2"             }         ]     } }

  • parentStatus The list of required parent issue statuses.

  Permission validator

  A validator that checks the user has a permission.

  {   "type": "PermissionValidator",   "configuration": {       "permissionKey": "ADMINISTER_PROJECTS"   } }

  • permissionKey The permission required to perform the transition. Allowed values: built-in or app defined permissions.

  Previous status validator

  A validator that checks if the issue has held a status.

  {   "type": "PreviousStatusValidator",   "configuration": {       "mostRecentStatusOnly": false,       "previousStatus": {           "id": "15"       }   } }

  • mostRecentStatusOnly If true, then only the issue's preceding status (the one immediately before the current status) is checked.
  • previousStatus An object containing the ID of an issue status.

  Regular expression validator

  A validator that checks the content of a field against a regular expression.

  {   "type": "RegexpFieldValidator",   "configuration": {       "regExp": "[0-9]",       "fieldId": "customfield_10029"   } }

  • regExpA regular expression.

  • fieldId The ID of a field. Allowed field types:

    • com.atlassian.jira.plugin.system.customfieldtypes:select
    • com.atlassian.jira.plugin.system.customfieldtypes:multiselect
    • com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons
    • com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes
    • com.atlassian.jira.plugin.system.customfieldtypes:textarea
    • com.atlassian.jira.plugin.system.customfieldtypes:textfield
    • com.atlassian.jira.plugin.system.customfieldtypes:url
    • com.atlassian.jira.plugin.system.customfieldtypes:float
    • com.pyxis.greenhopper.jira:jsw-story-points
    • com.pyxis.greenhopper.jira:gh-epic-status
    • description
    • summary

  User permission validator

  A validator that checks if a user has a permission. Obsolete. You may encounter this validator when getting transition rules and can pass it when updating or creating rules, for example, when you want to duplicate the rules from a workflow on a new workflow.

  {     "type": "UserPermissionValidator",     "configuration": {         "permissionKey": "BROWSE_PROJECTS",         "nullAllowed": false,         "username": "TestUser"     } }

  • permissionKey The permission to be validated. Allowed values: built-in or app defined permissions.
  • nullAllowed If true, allows the transition when username is empty.
  • username The username to validate against the permissionKey.

  Post functions

  Post functions carry out any additional processing required after a Jira workflow transition is executed.

  Fire issue event function

  A post function that fires an event that is processed by the listeners.

  {   "type": "FireIssueEventFunction",   "configuration": {     "event": {       "id":"1"     }   } }

  Note: If provided, this post function overrides the default FireIssueEventFunction. Can be included once in a transition.

  • event An object containing the ID of the issue event.

  Update issue status

  A post function that sets issue status to the linked status of the destination workflow status.

  {   "type": "UpdateIssueStatusFunction" }

  Note: This post function is a default function in global and directed transitions. It can only be added to the initial transition and can only be added once.

  Create comment

  A post function that adds a comment entered during the transition to an issue.

  {   "type": "CreateCommentFunction" }

  Note: This post function is a default function in global and directed transitions. It can only be added to the initial transition and can only be added once.

  Store issue

  A post function that stores updates to an issue.

  {   "type": "IssueStoreFunction" }

  Note: This post function can only be added to the initial transition and can only be added once.

  Assign to current user function

  A post function that assigns the issue to the current user if the current user has the ASSIGNABLE_USER permission.

  {     "type": "AssignToCurrentUserFunction" }

  Note: This post function can be included once in a transition.

  Assign to lead function

  A post function that assigns the issue to the project or component lead developer.

  {     "type": "AssignToLeadFunction" }

  Note: This post function can be included once in a transition.

  Assign to reporter function

  A post function that assigns the issue to the reporter.

  {     "type": "AssignToReporterFunction" }

  Note: This post function can be included once in a transition.

  Clear field value function

  A post function that clears the value from a field.

  {   "type": "ClearFieldValuePostFunction",   "configuration": {     "fieldId": "assignee"   } }

  • fieldId The ID of the field.

  Copy value from other field function

  A post function that copies the value of one field to another, either within an issue or from parent to subtask.

  {   "type": "CopyValueFromOtherFieldPostFunction",   "configuration": {     "sourceFieldId": "assignee",     "destinationFieldId": "creator",     "copyType": "same"   } }

  • sourceFieldId The ID of the source field.
  • destinationFieldId The ID of the destination field.
  • copyType Use same to copy the value from a field inside the issue, or parent to copy the value from the parent issue.

  Create Crucible review workflow function

  A post function that creates a Crucible review for all unreviewed code for the issue.

  {     "type": "CreateCrucibleReviewWorkflowFunction" }

  Note: This post function can be included once in a transition.

  Set issue security level based on user's project role function

  A post function that sets the issue's security level if the current user has a project role.

  {   "type": "SetIssueSecurityFromRoleFunction",   "configuration": {     "projectRole": {         "id":"10002"     },     "issueSecurityLevel": {         "id":"10000"     }   } }

  • projectRole An object containing the ID of the project role.
  • issueSecurityLevel OPTIONAL. The object containing the ID of the security level. If not passed, then the security level is set to none.

  Trigger a webhook function

  A post function that triggers a webhook.

  {   "type": "TriggerWebhookFunction",   "configuration": {     "webhook": {       "id": "1"     }   } }

  • webhook An object containing the ID of the webhook listener to trigger.

  Update issue custom field function

  A post function that updates the content of an issue custom field.

  {   "type": "UpdateIssueCustomFieldPostFunction",   "configuration": {     "mode": "append",     "fieldId": "customfield_10003",     "fieldValue": "yikes"   } }

  • mode Use replace to override the field content with fieldValue or append to add fieldValue to the end of the field content.
  • fieldId The ID of the field.
  • fieldValue The update content.

  Update issue field function

  A post function that updates a simple issue field.

  {   "type": "UpdateIssueFieldFunction",   "configuration": {     "fieldId": "assignee",     "fieldValue": "5f0c277e70b8a90025a00776"   } }

  • fieldId The ID of the field. Allowed field types:

    • assignee
    • description
    • environment
    • priority
    • resolution
    • summary
    • timeoriginalestimate
    • timeestimate
    • timespent

  • fieldValue The update value.

  • If the fieldId is assignee, the fieldValue should be one of these values:

    • an account ID.
    • automatic.
    • a blank string, which sets the value to unassigned.

  Connect rules

  Connect rules are conditions, validators, and post functions of a transition that are registered by Connect apps. To create a rule registered by the app, the app must be enabled and the rule's module must exist.

  {   "type": "appKey__moduleKey",   "configuration": {     "value":"{\"isValid\":\"true\"}"   } }

  • type A Connect rule key in a form of appKey__moduleKey.
  • value The stringified JSON configuration of a Connect rule.

  Forge rules

  Forge transition rules are not yet supported.

  Permissions required: Administer Jira global permission.

• workflows.deleteInactiveWorkflow

  Deletes a workflow.

  The workflow cannot be deleted if it is:

  • an active workflow.
  • a system workflow.
  • associated with any workflow scheme.
  • associated with any draft workflow scheme.

  Permissions required: Administer Jira global permission.

• workflows.getAllWorkflows

  Returns all workflows in Jira or a workflow. Deprecated, use Get workflows paginated.

  If the workflowName parameter is specified, the workflow is returned as an object (not in an array). Otherwise, an array of workflow objects is returned.

  Permissions required: Administer Jira global permission.

• workflows.getWorkflowsPaginated

  Returns a paginated list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned.

  This operation does not return next-gen workflows.

  Permissions required: Administer Jira global permission.

• workflowSchemeDrafts.createWorkflowSchemeDraftFromParent

  Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an active workflow scheme can only have one draft workflow scheme.

  Permissions required: Administer Jira global permission.

• workflowSchemeDrafts.deleteDraftDefaultWorkflow

  Resets the default workflow for a workflow scheme's draft. That is, the default workflow is set to Jira's system workflow (the jira workflow).

  Permissions required: Administer Jira global permission.

• workflowSchemeDrafts.deleteDraftWorkflowMapping

  Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft.

  Permissions required: Administer Jira global permission.

• workflowSchemeDrafts.deleteWorkflowSchemeDraft

  Deletes a draft workflow scheme.

  Permissions required: Administer Jira global permission.

• workflowSchemeDrafts.deleteWorkflowSchemeDraftIssueType

  Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft.

  Permissions required: Administer Jira global permission.

• workflowSchemeDrafts.getDraftDefaultWorkflow

  Returns the default workflow for a workflow scheme's draft. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira.

  Permissions required: Administer Jira global permission.

• workflowSchemeDrafts.getDraftWorkflow

  Returns the workflow-issue type mappings for a workflow scheme's draft.

  Permissions required: Administer Jira global permission.

• workflowSchemeDrafts.getWorkflowSchemeDraft

  Returns the draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to the active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is modified, then the changes in the draft are copied back to the active workflow scheme. See Configuring workflow schemes for more information.
  Note that:

  • Only active workflow schemes can have draft workflow schemes.
  • An active workflow scheme can only have one draft workflow scheme.

  Permissions required: Administer Jira global permission.

• workflowSchemeDrafts.getWorkflowSchemeDraftIssueType

  Returns the issue type-workflow mapping for an issue type in a workflow scheme's draft.

  Permissions required: Administer Jira global permission.

• workflowSchemeDrafts.publishDraftWorkflowScheme

  Publishes a draft workflow scheme.

  Where the draft workflow includes new workflow statuses for an issue type, mappings are provided to update issues with the original workflow status to the new workflow status.

  This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain updates.

  Permissions required: Administer Jira global permission.

• workflowSchemeDrafts.setWorkflowSchemeDraftIssueType

  Sets the workflow for an issue type in a workflow scheme's draft.

  Permissions required: Administer Jira global permission.

• workflowSchemeDrafts.updateDraftDefaultWorkflow

  Sets the default workflow for a workflow scheme's draft.

  Permissions required: Administer Jira global permission.

• workflowSchemeDrafts.updateDraftWorkflowMapping

  Sets the issue types for a workflow in a workflow scheme's draft. The workflow can also be set as the default workflow for the draft workflow scheme. Unmapped issues types are mapped to the default workflow.

  Permissions required: Administer Jira global permission.

• workflowSchemeDrafts.updateWorkflowSchemeDraft

  Updates a draft workflow scheme. If a draft workflow scheme does not exist for the active workflow scheme, then a draft is created. Note that an active workflow scheme can only have one draft workflow scheme.

  Permissions required: Administer Jira global permission.

• workflowSchemeProjectAssociations.assignSchemeToProject

  Assigns a workflow scheme to a project. This operation is performed only when there are no issues in the project.

  Workflow schemes can only be assigned to classic projects.

  Permissions required: Administer Jira global permission.

• workflowSchemeProjectAssociations.getWorkflowSchemeProjectAssociations

  Returns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a list of the requested projects associated with it. Any team-managed or non-existent projects in the request are ignored and no errors are returned.

  If the project is associated with the Default Workflow Scheme no ID is returned. This is because the way the Default Workflow Scheme is stored means it has no ID.

  Permissions required: Administer Jira global permission.

• workflowSchemes.createWorkflowScheme

  Creates a workflow scheme.

  Permissions required: Administer Jira global permission.

• workflowSchemes.deleteDefaultWorkflow

  Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow (the jira workflow).

  Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be published in Jira.

  Permissions required: Administer Jira global permission.

• workflowSchemes.deleteWorkflowMapping

  Deletes the workflow-issue type mapping for a workflow in a workflow scheme.

  Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira.

  Permissions required: Administer Jira global permission.

• workflowSchemes.deleteWorkflowScheme

  Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at least one project).

  Permissions required: Administer Jira global permission.

• workflowSchemes.deleteWorkflowSchemeIssueType

  Deletes the issue type-workflow mapping for an issue type in a workflow scheme.

  Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow scheme can be published in Jira.

  Permissions required: Administer Jira global permission.

• workflowSchemes.getAllWorkflowSchemes

  Returns a paginated list of all workflow schemes, not including draft workflow schemes.

  Permissions required: Administer Jira global permission.

• workflowSchemes.getDefaultWorkflow

  Returns the default workflow for a workflow scheme. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira.

  Permissions required: Administer Jira global permission.

• workflowSchemes.getWorkflow

  Returns the workflow-issue type mappings for a workflow scheme.

  Permissions required: Administer Jira global permission.

• workflowSchemes.getWorkflowScheme

  Returns a workflow scheme.

  Permissions required: Administer Jira global permission.

• workflowSchemes.getWorkflowSchemeIssueType

  Returns the issue type-workflow mapping for an issue type in a workflow scheme.

  Permissions required: Administer Jira global permission.

• workflowSchemes.setWorkflowSchemeIssueType

  Sets the workflow for an issue type in a workflow scheme.

  Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The draft workflow scheme can be published in Jira.

  Permissions required: Administer Jira global permission.

• workflowSchemes.updateDefaultWorkflow

  Sets the default workflow for a workflow scheme.

  Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request object and a draft workflow scheme is created or updated with the new default workflow. The draft workflow scheme can be published in Jira.

  Permissions required: Administer Jira global permission.

• workflowSchemes.updateWorkflowMapping

  Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow.

  Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new workflow-issue types mappings. The draft workflow scheme can be published in Jira.

  Permissions required: Administer Jira global permission.

• workflowSchemes.updateWorkflowScheme

  Updates a workflow scheme, including the name, default workflow, issue type to project mappings, and more. If the workflow scheme is active (that is, being used by at least one project), then a draft workflow scheme is created or updated instead, provided that updateDraftIfNeeded is set to true.

  Permissions required: Administer Jira global permission.

• workflowStatusCategories.getStatusCategories

  Returns a list of all status categories.

  Permissions required: Permission to access Jira.

• workflowStatusCategories.getStatusCategory

  Returns a status category. Status categories provided a mechanism for categorizing statuses.

  Permissions required: Permission to access Jira.

• workflowStatuses.getStatus

  Returns a status. The status must be associated with an active workflow to be returned.

  If a name is used on more than one status, only the status found first is returned. Therefore, identifying the status by its ID may be preferable.

  This operation can be accessed anonymously.

  Permissions required: None.

• workflowStatuses.getStatuses

  Returns a list of all statuses associated with active workflows.

  This operation can be accessed anonymously.

  Permissions required: None.

• workflowTransitionProperties.createWorkflowTransitionProperty

  Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

  Permissions required: Administer Jira global permission.

• workflowTransitionProperties.deleteWorkflowTransitionProperty

  Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

  Permissions required: Administer Jira global permission.

• workflowTransitionProperties.getWorkflowTransitionProperties

  Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

  Permissions required: Administer Jira global permission.

• workflowTransitionProperties.updateWorkflowTransitionProperty

  Updates a workflow transition by changing the property value. Trying to update a property that does not exist results in a new property being added to the transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

  Permissions required: Administer Jira global permission.

• workflowTransitionRules.deleteWorkflowTransitionRuleConfigurations

  Deletes workflow transition rules from one or more workflows. These rule types are supported:

  • post functions
  • conditions
  • validators

  Only rules created by the calling Connect app can be deleted.

  Permissions required: Only Connect apps can use this operation.

• workflowTransitionRules.getWorkflowTransitionRuleConfigurations

  Returns a paginated list of workflows with transition rules. The workflows can be filtered to return only those containing workflow transition rules:

  • of one or more transition rule types, such as workflow post functions.
  • matching one or more transition rule keys.

  Only workflows containing transition rules created by the calling Connect app are returned.

  Due to server-side optimizations, workflows with an empty list of rules may be returned; these workflows can be ignored.

  Permissions required: Only Connect apps can use this operation.

• workflowTransitionRules.updateWorkflowTransitionRuleConfigurations

  Updates configuration of workflow transition rules. The following rule types are supported:

  • post functions
  • conditions
  • validators

  Only rules created by the calling Connect app can be updated.

  To assist with app migration, this operation can be used to:

  • Disable a rule.
  • Add a tag. Use this to filter rules in the Get workflow transition rule configurations.

  Rules are enabled if the disabled parameter is not provided.

  Permissions required: Only Connect apps can use this operation.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools