Package io.github.primelib.jira4j.restv3.api

Interface JiraRESTV3Api

@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public interface JiraRESTV3Api

  • Method Details

    • addActorUsers

      ProjectRole addActorUsers(@NotNull @NotNull String projectIdOrKey, @NotNull @NotNull Long id, @NotNull @NotNull ActorsMap actorsMap)
      Add actors to project role

      Adds actors to a project role for the project. To replace all actors for the project, use [Set actors for project role](#api-rest-api-3-project-projectIdOrKey-role-id-put). This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)
      id - The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
      actorsMap - The groups or users to associate with the project role for this project. Provide the user account ID, group name, or group ID. As a group's name can change, use of group ID is recommended. (required)

    • addAttachment

      List<Attachment> addAttachment(@NotNull @NotNull String issueIdOrKey)
      Add attachment

      Adds one or more attachments to an issue. Attachments are posted as multipart/form-data ([RFC 1867](https://www.ietf.org/rfc/rfc1867.txt)). Note that: * The request must have a X-Atlassian-Token: no-check header, if not it is blocked. See [Special headers](#special-request-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 protected]:&lt;api_token&gt;' -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 protected]:' ).toString('base64')}`, 'Accept': 'application/json', 'X-Atlassian-Token': 'no-check' } }) .then(response =&gt; { console.log( Response: ${response.status} ${response.statusText} ); return response.text(); }) .then(text =&gt; console.log(text)) .catch(err =&gt; 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 protected]", "") .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 protected]", "") 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 protected]', ''); $headers = array( 'Accept' =&gt; 'application/json', 'X-Atlassian-Token' =&gt; 'no-check' ); $parameters = array( 'file' =&gt; 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](http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntity.html) class for multipart POST operations. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse Projects* and *Create attachments* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue that attachments are added to. (required)

    • addComment

      Comment addComment(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull Comment comment, @Nullable @Nullable String expand)
      Add comment

      Adds a comment to an issue. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Add comments* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      comment - (required)
      expand - Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML. (optional)

    • addFieldToDefaultScreen

      Object addFieldToDefaultScreen(@NotNull @NotNull String fieldId)
      Add field to default screen

      Adds a field to the default tab of the default screen. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      fieldId - The ID of the field. (required)

    • addGadget

      DashboardGadget addGadget(@NotNull @NotNull Long dashboardId, @NotNull @NotNull DashboardGadgetSettings dashboardGadgetSettings)
      Add gadget to dashboard

      Adds a gadget to a dashboard. **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [write:jira-work, read:jira-work]

      Parameters:
      dashboardId - The ID of the dashboard. (required)
      dashboardGadgetSettings - (required)

    • addIssueTypesToContext

      Object addIssueTypesToContext(@NotNull @NotNull String fieldId, @NotNull @NotNull Long contextId, @NotNull @NotNull IssueTypeIds issueTypeIds)
      Add issue types to context

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field. (required)
      contextId - The ID of the context. (required)
      issueTypeIds - (required)

    • addIssueTypesToIssueTypeScheme

      Object addIssueTypesToIssueTypeScheme(@NotNull @NotNull Long issueTypeSchemeId, @NotNull @NotNull IssueTypeIds issueTypeIds)
      Add issue types to issue type scheme

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeSchemeId - The ID of the issue type scheme. (required)
      issueTypeIds - (required)

    • addNotifications

      Object addNotifications(@NotNull @NotNull String id, @NotNull @NotNull AddNotificationsDetails addNotificationsDetails)
      Add notifications to notification scheme

      Adds notifications to a notification scheme. You can add up to 1000 notifications per request. *Deprecated: The notification type EmailAddress is no longer supported in Cloud. Refer to the [changelog](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-1031) for more details.* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the notification scheme. (required)
      addNotificationsDetails - (required)

    • addProjectRoleActorsToRole

      ProjectRole addProjectRoleActorsToRole(@NotNull @NotNull Long id, @NotNull @NotNull ActorInputBean actorInputBean)
      Add default actors to project role

      Adds [default actors](#api-rest-api-3-resolution-get) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
      actorInputBean - (required)

    • addScreenTab

      ScreenableTab addScreenTab(@NotNull @NotNull Long screenId, @NotNull @NotNull ScreenableTab screenableTab)
      Create screen tab

      Creates a tab for a screen. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      screenId - The ID of the screen. (required)
      screenableTab - (required)

    • addScreenTabField

      ScreenableField addScreenTabField(@NotNull @NotNull Long screenId, @NotNull @NotNull Long tabId, @NotNull @NotNull AddFieldBean addFieldBean)
      Add screen tab field

      Adds a field to a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      screenId - The ID of the screen. (required)
      tabId - The ID of the screen tab. (required)
      addFieldBean - (required)

    • addSecurityLevel

      Object addSecurityLevel(@NotNull @NotNull String schemeId, @NotNull @NotNull AddSecuritySchemeLevelsRequestBean addSecuritySchemeLevelsRequestBean)
      Add issue security levels

      Adds levels and levels' members to the issue security scheme. You can add up to 100 levels per request. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      schemeId - The ID of the issue security scheme. (required)
      addSecuritySchemeLevelsRequestBean - (required)

    • addSecurityLevelMembers

      Object addSecurityLevelMembers(@NotNull @NotNull String schemeId, @NotNull @NotNull String levelId, @NotNull @NotNull SecuritySchemeMembersRequest securitySchemeMembersRequest)
      Add issue security level members

      Adds members to the issue security level. You can add up to 100 members per request. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      schemeId - The ID of the issue security scheme. (required)
      levelId - The ID of the issue security level. (required)
      securitySchemeMembersRequest - (required)

    • addSharePermission

      List<SharePermission> addSharePermission(@NotNull @NotNull Long id, @NotNull @NotNull SharePermissionInputBean sharePermissionInputBean)
      Add share permission

      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](#api-rest-api-3-filter-id-put). **[Permissions](#permissions) required:** *Share dashboards and filters* [global permission](https://confluence.atlassian.com/x/x4dKLg) and the user must own the filter. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      id - The ID of the filter. (required)
      sharePermissionInputBean - (required)

    • addUserToGroup

      Group addUserToGroup(@NotNull @NotNull UpdateUserToGroupBean updateUserToGroupBean, @Nullable @Nullable String groupname, @Nullable @Nullable String groupId)
      Add user to group

      Adds a user to a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      updateUserToGroupBean - The user to add to the group. (required)
      groupname - As a group's name can change, use of groupId is recommended to identify a group. The name of the group. This parameter cannot be used with the groupId parameter. (optional)
      groupId - The ID of the group. This parameter cannot be used with the groupName parameter. (optional)

    • addVote

      Object addVote(@NotNull @NotNull String issueIdOrKey)
      Add vote

      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](https://confluence.atlassian.com/x/uYXKM) for details. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)

    • addWatcher

      Object addWatcher(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String body)
      Add watcher

      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](https://confluence.atlassian.com/x/uYXKM) for details. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * To add users other than themselves to the watchlist, *Manage watcher list* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      body - The account ID of the user. Note that username cannot be used due to privacy changes. (required)

    • addWorklog

      Worklog addWorklog(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull Worklog worklog, @Nullable @Nullable Boolean notifyUsers, @Nullable @Nullable String adjustEstimate, @Nullable @Nullable String newEstimate, @Nullable @Nullable String reduceBy, @Nullable @Nullable String expand, @Nullable @Nullable Boolean overrideEditableFlag)
      Add worklog

      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](https://confluence.atlassian.com/x/qoXKM). This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Work on issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key the issue. (required)
      worklog - (required)
      notifyUsers - Whether users watching the issue are notified by email. (optional, defaults to true)
      adjustEstimate - Defines how to update the issue's time estimate, the options are: * new Sets the estimate to a specific value, defined in newEstimate. * leave Leaves the estimate unchanged. * manual Reduces the estimate by amount specified in reduceBy. * auto Reduces the estimate by the value of timeSpent in the worklog. (optional, defaults to auto)
      newEstimate - The value to set as the issue's remaining time estimate, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when adjustEstimate is new. (optional)
      reduceBy - The amount to reduce the issue's remaining estimate by, as days (\\#d), hours (\\#h), or minutes (\\#m). For example, *2d*. Required when adjustEstimate is manual. (optional)
      expand - Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts properties, which returns worklog properties. (optional)
      overrideEditableFlag - Whether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) can use this flag. (optional, defaults to false)

    • addonPropertiesResourceDeleteAddonPropertyDelete

      void addonPropertiesResourceDeleteAddonPropertyDelete(@NotNull @NotNull String addonKey, @NotNull @NotNull String propertyKey)
      Delete app property

      Deletes an app's property. **[Permissions](#permissions) required:** Only a Connect app whose key matches addonKey can make this request.

      Parameters:
      addonKey - The key of the app, as defined in its descriptor. (required)
      propertyKey - The key of the property. (required)

    • addonPropertiesResourceDeleteAppPropertyDelete

      void addonPropertiesResourceDeleteAppPropertyDelete(@NotNull @NotNull String propertyKey)
      Delete app property (Forge)

      Deletes a Forge app's property. **[Permissions](#permissions) required:** Only Forge apps can make this request.

      Parameters:
      propertyKey - The key of the property. (required)

    • addonPropertiesResourceGetAddonPropertiesGet

      PropertyKeys addonPropertiesResourceGetAddonPropertiesGet(@NotNull @NotNull String addonKey)
      Get app properties

      Gets all the properties of an app. **[Permissions](#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](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/).

      Parameters:
      addonKey - The key of the app, as defined in its descriptor. (required)

    • addonPropertiesResourceGetAddonPropertyGet

      EntityProperty addonPropertiesResourceGetAddonPropertyGet(@NotNull @NotNull String addonKey, @NotNull @NotNull String propertyKey)
      Get app property

      Returns the key and value of an app's property. **[Permissions](#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](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/).

      Parameters:
      addonKey - The key of the app, as defined in its descriptor. (required)
      propertyKey - The key of the property. (required)

    • addonPropertiesResourcePutAddonPropertyPut

      OperationMessage addonPropertiesResourcePutAddonPropertyPut(@NotNull @NotNull String addonKey, @NotNull @NotNull String propertyKey, @NotNull @NotNull Object body)
      Set app property

      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](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters. **[Permissions](#permissions) required:** Only a Connect app whose key matches addonKey can make this request.

      Parameters:
      addonKey - The key of the app, as defined in its descriptor. (required)
      propertyKey - The key of the property. (required)
      body - (required)

    • addonPropertiesResourcePutAppPropertyPut

      OperationMessage addonPropertiesResourcePutAppPropertyPut(@NotNull @NotNull String propertyKey, @NotNull @NotNull Object body)
      Set app property (Forge)

      Sets the value of a Forge app's property. These values can be retrieved in [Jira expressions](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/) through the app [context variable](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#context-variables). For other use cases, use the [Storage API](https://developer.atlassian.com/platform/forge/runtime-reference/storage-api/). The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters. **[Permissions](#permissions) required:** Only Forge apps can make this request.

      Parameters:
      propertyKey - The key of the property. (required)
      body - (required)

    • analyseExpression

      JiraExpressionsAnalysis analyseExpression(@NotNull @NotNull JiraExpressionForAnalysis jiraExpressionForAnalysis, @Nullable @Nullable String check)
      Analyse Jira expression

      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](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/). **[Permissions](#permissions) required**: None. Authentication - Required Scopes: [read:jira-work, read:jira-user]

      Parameters:
      jiraExpressionForAnalysis - The Jira expressions to analyse. (required)
      check - The check to perform: * syntax Each expression's syntax is checked to ensure the expression can be parsed. Also, syntactic limits are validated. For example, the expression's length. * type EXPERIMENTAL. Each expression is type checked and the final type of the expression inferred. Any type errors that would result in the expression failure at runtime are reported. For example, accessing properties that don't exist or passing the wrong number of arguments to functions. Also performs the syntax check. * complexity EXPERIMENTAL. Determines the formulae for how many [expensive operations](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#expensive-operations) each expression may execute. (optional, defaults to syntax)

    • appIssueFieldValueUpdateResourceUpdateIssueFieldsPut

      Object appIssueFieldValueUpdateResourceUpdateIssueFieldsPut(@NotNull @NotNull UUID atlassianTransferId, @NotNull @NotNull ConnectCustomFieldValues connectCustomFieldValues)
      Bulk update custom field value

      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](#permissions) required:** Only Connect apps can make this request

      Parameters:
      atlassianTransferId - The ID of the transfer. (required)
      connectCustomFieldValues - (required)

    • appendMappingsForIssueTypeScreenScheme

      Object appendMappingsForIssueTypeScreenScheme(@NotNull @NotNull String issueTypeScreenSchemeId, @NotNull @NotNull IssueTypeScreenSchemeMappingDetails issueTypeScreenSchemeMappingDetails)
      Append mappings to issue type screen scheme

      Appends issue type to screen scheme mappings to an issue type screen scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeScreenSchemeId - The ID of the issue type screen scheme. (required)
      issueTypeScreenSchemeMappingDetails - (required)

    • archiveIssues

      IssueArchivalSyncResponse archiveIssues(@NotNull @NotNull IssueArchivalSyncRequest issueArchivalSyncRequest)
      Archive issue(s) by issue ID/key

      Enables admins to archive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) archived in the process and the errors encountered, if any. **Note that:** * you can't archive subtasks directly, only through their parent issues * you can only archive issues from software, service management, and business projects **[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg) **License required:** Premium or Enterprise **Signed-in users only:** This API can't be accessed anonymously. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueArchivalSyncRequest - Contains a list of issue keys or IDs to be archived. (required)

    • archiveIssuesAsync

      String archiveIssuesAsync(@NotNull @NotNull ArchiveIssueAsyncRequest archiveIssueAsyncRequest)
      Archive issue(s) by JQL

      Enables admins to archive up to 100,000 issues in a single request using JQL, returning the URL to check the status of the submitted request. You can use the [get task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-get) and [cancel task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-cancel-post) APIs to manage the request. **Note that:** * you can't archive subtasks directly, only through their parent issues * you can only archive issues from software, service management, and business projects **[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg) **License required:** Premium or Enterprise **Signed-in users only:** This API can't be accessed anonymously. **Rate limiting:** Only a single request per jira instance can be active at any given time. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      archiveIssueAsyncRequest - A JQL query specifying the issues to archive. Note that subtasks can only be archived through their parent issues. (required)

    • archiveProject

      Object archiveProject(@NotNull @NotNull String projectIdOrKey)
      Archive project

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)

    • assignFieldConfigurationSchemeToProject

      Object assignFieldConfigurationSchemeToProject(@NotNull @NotNull FieldConfigurationSchemeProjectAssociation fieldConfigurationSchemeProjectAssociation)
      Assign field configuration scheme to project

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldConfigurationSchemeProjectAssociation - (required)

    • assignIssue

      Object assignIssue(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull User user)
      Assign issue

      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](#permissions) required:** * *Browse Projects* and *Assign Issues* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue to be assigned. (required)
      user - The request object with the user that the issue is assigned to. (required)

    • assignIssueTypeSchemeToProject

      Object assignIssueTypeSchemeToProject(@NotNull @NotNull IssueTypeSchemeProjectAssociation issueTypeSchemeProjectAssociation)
      Assign issue type scheme to project

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeSchemeProjectAssociation - (required)

    • assignIssueTypeScreenSchemeToProject

      Object assignIssueTypeScreenSchemeToProject(@NotNull @NotNull IssueTypeScreenSchemeProjectAssociation issueTypeScreenSchemeProjectAssociation)
      Assign issue type screen scheme to project

      Assigns an issue type screen scheme to a project. Issue type screen schemes can only be assigned to classic projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeScreenSchemeProjectAssociation - (required)

    • assignPermissionScheme

      PermissionScheme assignPermissionScheme(@NotNull @NotNull String projectKeyOrId, @NotNull @NotNull IdBean idBean, @Nullable @Nullable String expand)
      Assign permission scheme

      Assigns a permission scheme with a project. See [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for more information about permission schemes. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      projectKeyOrId - The project ID or project key (case sensitive). (required)
      idBean - (required)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: * all Returns all expandable information. * field Returns information about the custom field granted the permission. * group Returns information about the group that is granted the permission. * permissions Returns all permission grants for each permission scheme. * projectRole Returns information about the project role granted the permission. * user Returns information about the user who is granted the permission. (optional)

    • assignProjectsToCustomFieldContext

      Object assignProjectsToCustomFieldContext(@NotNull @NotNull String fieldId, @NotNull @NotNull Long contextId, @NotNull @NotNull ProjectIds projectIds)
      Assign custom field context to projects

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field. (required)
      contextId - The ID of the context. (required)
      projectIds - (required)

    • assignSchemeToProject

      Object assignSchemeToProject(@NotNull @NotNull WorkflowSchemeProjectAssociation workflowSchemeProjectAssociation)
      Assign workflow scheme to project

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      workflowSchemeProjectAssociation - (required)

    • associateSchemesToProjects

      void associateSchemesToProjects(@NotNull @NotNull AssociateSecuritySchemeWithProjectDetails associateSecuritySchemeWithProjectDetails)
      Associate security scheme to project

      Associates an issue security scheme with a project and remaps security levels of issues to the new levels, if provided. This operation is [asynchronous](#async). Follow the location link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      associateSecuritySchemeWithProjectDetails - (required)

    • bulkDeleteIssueProperty

      void bulkDeleteIssueProperty(@NotNull @NotNull String propertyKey, @NotNull @NotNull IssueFilterForBulkPropertyDelete issueFilterForBulkPropertyDelete)
      Bulk delete issue property

      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](#async). Follow the location link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. **[Permissions](#permissions) required:** * *Browse projects* [ project permission](https://confluence.atlassian.com/x/yodKLg) for each project containing issues. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for each issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      propertyKey - The key of the property. (required)
      issueFilterForBulkPropertyDelete - (required)

    • bulkEditDashboards

      BulkEditShareableEntityResponse bulkEditDashboards(@NotNull @NotNull BulkEditShareableEntityRequest bulkEditShareableEntityRequest)
      Bulk edit dashboards

      Bulk edit dashboards. Maximum number of dashboards to be edited at the same time is 100. **[Permissions](#permissions) required:** None The dashboards to be updated must be owned by the user, or the user must be an administrator. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      bulkEditShareableEntityRequest - The details of dashboards being updated in bulk. (required)

    • bulkGetGroups

      PageBeanGroupDetails bulkGetGroups(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Set<String> groupId, @Nullable @Nullable Set<String> groupName, @Nullable @Nullable String accessType, @Nullable @Nullable String applicationKey)
      Bulk get groups

      Returns a [paginated](#pagination) list of groups. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [read:jira-user]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      groupId - The ID of a group. To specify multiple IDs, pass multiple groupId parameters. For example, groupId=5b10a2844c20165700ede21g&amp;groupId=5b10ac8d82e05b22cc7d4ef5. (optional)
      groupName - The name of a group. To specify multiple names, pass multiple groupName parameters. For example, groupName=administrators&amp;groupName=jira-software-users. (optional)
      accessType - The access level of a group. Valid values: 'site-admin', 'admin', 'user'. (optional)
      applicationKey - The application key of the product user groups to search for. Valid values: 'jira-servicedesk', 'jira-software', 'jira-product-discovery', 'jira-core'. (optional)

    • bulkGetUsers

      PageBeanUser bulkGetUsers(@NotNull @NotNull List<String> accountId, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable List<String> username, @Nullable @Nullable List<String> key)
      Bulk get users

      Returns a [paginated](#pagination) list of the users specified by one or more account IDs. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-user]

      Parameters:
      accountId - The account ID of a user. To specify multiple users, pass multiple accountId parameters. For example, accountId=5b10a2844c20165700ede21g&amp;accountId=5b10ac8d82e05b22cc7d4ef5. (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 10)
      username - This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      key - This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)

    • bulkGetUsersMigration

      List<UserMigrationBean> bulkGetUsersMigration(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable List<String> username, @Nullable @Nullable List<String> key)
      Get account IDs for users

      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](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-user]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 10)
      username - Username of a user. To specify multiple users, pass multiple copies of this parameter. For example, username=fred&amp;username=barney. Required if key isn't provided. Cannot be provided if key is present. (optional)
      key - Key of a user. To specify multiple users, pass multiple copies of this parameter. For example, key=fred&amp;key=barney. Required if username isn't provided. Cannot be provided if username is present. (optional)

    • bulkSetIssuePropertiesByIssue

      void bulkSetIssuePropertiesByIssue(@NotNull @NotNull MultiIssueEntityProperties multiIssueEntityProperties)
      Bulk set issue properties by issue

      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](http://tools.ietf.org/html/rfc4627), non-empty JSON. This operation is: * [asynchronous](#async). Follow the location link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. * non-transactional. Updating some entities may fail. Such information will available in the task result. **[Permissions](#permissions) required:** * *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      multiIssueEntityProperties - Details of the issue properties to be set or updated. Note that if an issue is not found, it is ignored. (required)

    • bulkSetIssueProperty

      void bulkSetIssueProperty(@NotNull @NotNull String propertyKey, @NotNull @NotNull BulkIssuePropertyUpdateRequest bulkIssuePropertyUpdateRequest)
      Bulk set issue property

      Sets a property value on multiple issues. The value set can be a constant or determined by a [Jira expression](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/). Expressions must be computable with constant complexity when applied to a set of issues. Expressions must also comply with the [restrictions](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#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](#async). Follow the location link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for each project containing issues. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for each issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      propertyKey - The key of the property. The maximum length is 255 characters. (required)
      bulkIssuePropertyUpdateRequest - (required)

    • bulkSetIssuesPropertiesList

      void bulkSetIssuesPropertiesList(@NotNull @NotNull IssueEntityProperties issueEntityProperties)
      Bulk set issues properties by list

      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](http://tools.ietf.org/html/rfc4627), 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](#async). Follow the location link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. **[Permissions](#permissions) required:** * *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueEntityProperties - Issue properties to be set or updated with values. (required)

    • cancelTask

      Object cancelTask(@NotNull @NotNull String taskId)
      Cancel task

      Cancels a task. **[Permissions](#permissions) required:** either of: * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Creator of the task. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      taskId - The ID of the task. (required)

    • changeFilterOwner

      Object changeFilterOwner(@NotNull @NotNull Long id, @NotNull @NotNull ChangeFilterOwner changeFilterOwner)
      Change filter owner

      Changes the owner of the filter. **[Permissions](#permissions) required:** Permission to access Jira. However, the user must own the filter or have the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [write:jira-work]

      Parameters:
      id - The ID of the filter to update. (required)
      changeFilterOwner - The account ID of the new owner of the filter. (required)

    • copyDashboard

      Dashboard copyDashboard(@NotNull @NotNull String id, @NotNull @NotNull DashboardDetails dashboardDetails)
      Copy dashboard

      Copies a dashboard. Any values provided in the dashboard parameter replace those in the copied dashboard. **[Permissions](#permissions) required:** None The dashboard to be copied must be owned by or shared with the user. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      id - (required)
      dashboardDetails - Dashboard details. (required)

    • createComponent

      ProjectComponent createComponent(@NotNull @NotNull ProjectComponent projectComponent)
      Create component

      Creates a component. Use components to provide containers for issues within a project. Use components to provide containers for issues within a project. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the component is created or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      projectComponent - (required)

    • createCustomField

      FieldDetails createCustomField(@NotNull @NotNull CustomFieldDefinitionJsonBean customFieldDefinitionJsonBean)
      Create custom field

      Creates a custom field. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      customFieldDefinitionJsonBean - Definition of the custom field to be created (required)

    • createCustomFieldContext

      CreateCustomFieldContext createCustomFieldContext(@NotNull @NotNull String fieldId, @NotNull @NotNull CreateCustomFieldContext createCustomFieldContext)
      Create custom field context

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field. (required)
      createCustomFieldContext - (required)

    • createCustomFieldOption

      CustomFieldCreatedContextOptionsList createCustomFieldOption(@NotNull @NotNull String fieldId, @NotNull @NotNull Long contextId, @NotNull @NotNull BulkCustomFieldOptionCreateRequest bulkCustomFieldOptionCreateRequest)
      Create custom field options (context)

      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)](#api-group-issue-custom-field-options--apps-) operations.** **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field. (required)
      contextId - The ID of the context. (required)
      bulkCustomFieldOptionCreateRequest - (required)

    • createDashboard

      Dashboard createDashboard(@NotNull @NotNull DashboardDetails dashboardDetails)
      Create dashboard

      Creates a dashboard. **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      dashboardDetails - Dashboard details. (required)

    • createFieldConfiguration

      FieldConfiguration createFieldConfiguration(@NotNull @NotNull FieldConfigurationDetails fieldConfigurationDetails)
      Create field configuration

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldConfigurationDetails - (required)

    • createFieldConfigurationScheme

      FieldConfigurationScheme createFieldConfigurationScheme(@NotNull @NotNull UpdateFieldConfigurationSchemeDetails updateFieldConfigurationSchemeDetails)
      Create field configuration scheme

      Creates a field configuration scheme. This operation can only create field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      updateFieldConfigurationSchemeDetails - The details of the field configuration scheme. (required)

    • createFilter

      Filter createFilter(@NotNull @NotNull Filter filter, @Nullable @Nullable String expand, @Nullable @Nullable Boolean overrideSharePermissions)
      Create filter

      Creates a filter. The filter is shared according to the [default share scope](#api-rest-api-3-filter-post). The filter is not selected as a favorite. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      filter - The filter to create. (required)
      expand - Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. * subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000]. (optional)
      overrideSharePermissions - EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be created. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, defaults to false)

    • createGroup

      Group createGroup(@NotNull @NotNull AddGroupBean addGroupBean)
      Create group

      Creates a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      addGroupBean - The name of the group. (required)

    • createIssue

      CreatedIssue createIssue(@NotNull @NotNull IssueUpdateDetails issueUpdateDetails, @Nullable @Nullable Boolean updateHistory)
      Create issue

      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](#api-rest-api-3-issue-createmeta-get). 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](#api-rest-api-3-issue-createmeta-get) 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](#permissions) required:** *Browse projects* and *Create issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project in which the issue or subtask is created. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueUpdateDetails - (required)
      updateHistory - Whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira. When provided, the issue type and request type are added to the user's history for a project. These values are then used to provide defaults on the issue create screen. (optional, defaults to false)

    • createIssueFieldOption

      IssueFieldOption createIssueFieldOption(@NotNull @NotNull String fieldKey, @NotNull @NotNull IssueFieldOptionCreateBean issueFieldOptionCreateBean)
      Create issue field option

      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](#api-group-Issue-custom-field-options) resource. Each field can have a maximum of 10000 options, and each option can have a maximum of 10000 scopes. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldKey - The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the fieldKey value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the jiraIssueFields module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field" (required)
      issueFieldOptionCreateBean - (required)

    • createIssueLinkType

      IssueLinkType createIssueLinkType(@NotNull @NotNull IssueLinkType issueLinkType)
      Create issue link type

      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](https://confluence.atlassian.com/x/yoXKM) enabled. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueLinkType - (required)

    • createIssueSecurityScheme

      SecuritySchemeId createIssueSecurityScheme(@NotNull @NotNull CreateIssueSecuritySchemeDetails createIssueSecuritySchemeDetails)
      Create issue security scheme

      Creates a security scheme with security scheme levels and levels' members. You can create up to 100 security scheme levels and security scheme levels' members per request. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      createIssueSecuritySchemeDetails - (required)

    • createIssueType

      IssueTypeDetails createIssueType(@NotNull @NotNull IssueTypeCreateBean issueTypeCreateBean)
      Create issue type

      Creates an issue type and adds it to the default issue type scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeCreateBean - (required)

    • createIssueTypeAvatar

      Avatar createIssueTypeAvatar(@NotNull @NotNull String id, @NotNull @NotNull Integer size, @NotNull @NotNull Object body, @Nullable @Nullable Integer x, @Nullable @Nullable Integer y)
      Load issue type avatar

      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](#special-request-headers). * Content-Type: image/image type Valid image types are JPEG, GIF, or PNG. For example: curl --request POST \\ --user [email protected]:&amp;lt;api_token&amp;gt; \\ --header 'X-Atlassian-Token: no-check' \\ --header 'Content-Type: image/&amp;lt; image_type&amp;gt;' \\ --data-binary "&amp;lt;@/path/to/file/with/your/avatar&amp;gt;" \\ --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](#api-rest-api-3-issuetype-id-put) to set it as the issue type's displayed avatar. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the issue type. (required)
      size - The length of each side of the crop region. (required)
      body - (required)
      x - The X coordinate of the top-left corner of the crop region. (optional, defaults to 0)
      y - The Y coordinate of the top-left corner of the crop region. (optional, defaults to 0)

    • createIssueTypeScheme

      IssueTypeSchemeID createIssueTypeScheme(@NotNull @NotNull IssueTypeSchemeDetails issueTypeSchemeDetails)
      Create issue type scheme

      Creates an issue type scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeSchemeDetails - (required)

    • createIssueTypeScreenScheme

      IssueTypeScreenSchemeId createIssueTypeScreenScheme(@NotNull @NotNull IssueTypeScreenSchemeDetails issueTypeScreenSchemeDetails)
      Create issue type screen scheme

      Creates an issue type screen scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeScreenSchemeDetails - An issue type screen scheme bean. (required)

    • createIssues

      CreatedIssues createIssues(@NotNull @NotNull IssuesUpdateBean issuesUpdateBean)
      Bulk create issue

      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](#api-rest-api-3-issue-createmeta-get). 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](#api-rest-api-3-issue-createmeta-get) to find subtask issue types). * parent the must contain the ID or key of the parent issue. **[Permissions](#permissions) required:** *Browse projects* and *Create issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project in which each issue or subtask is created. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issuesUpdateBean - (required)

    • createNotificationScheme

      NotificationSchemeId createNotificationScheme(@NotNull @NotNull CreateNotificationSchemeDetails createNotificationSchemeDetails)
      Create notification scheme

      Creates a notification scheme with notifications. You can create up to 1000 notifications per request. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      createNotificationSchemeDetails - (required)

    • createOrUpdateRemoteIssueLink

      RemoteIssueLinkIdentifies createOrUpdateRemoteIssueLink(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull RemoteIssueLinkRequest remoteIssueLinkRequest)
      Create or update remote issue link

      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](https://confluence.atlassian.com/x/yoXKM). This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      remoteIssueLinkRequest - (required)

    • createPermissionGrant

      PermissionGrant createPermissionGrant(@NotNull @NotNull Long schemeId, @NotNull @NotNull PermissionGrant permissionGrant, @Nullable @Nullable String expand)
      Create permission grant

      Creates a permission grant in a permission scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      schemeId - The ID of the permission scheme in which to create a new permission grant. (required)
      permissionGrant - The permission grant to create. (required)
      expand - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: * permissions Returns all permission grants for each permission scheme. * user Returns information about the user who is granted the permission. * group Returns information about the group that is granted the permission. * projectRole Returns information about the project role granted the permission. * field Returns information about the custom field granted the permission. * all Returns all expandable information. (optional)

    • createPermissionScheme

      PermissionScheme createPermissionScheme(@NotNull @NotNull PermissionScheme permissionScheme, @Nullable @Nullable String expand)
      Create permission scheme

      Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      permissionScheme - The permission scheme to create. (required)
      expand - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: * all Returns all expandable information. * field Returns information about the custom field granted the permission. * group Returns information about the group that is granted the permission. * permissions Returns all permission grants for each permission scheme. * projectRole Returns information about the project role granted the permission. * user Returns information about the user who is granted the permission. (optional)

    • createPriority

      PriorityId createPriority(@NotNull @NotNull CreatePriorityDetails createPriorityDetails)
      Create priority

      Creates an issue priority. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      createPriorityDetails - (required)

    • createProject

      ProjectIdentifiers createProject(@NotNull @NotNull CreateProjectDetails createProjectDetails)
      Create project

      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-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-design-service-desk, com.atlassian.servicedesk:simplified-sales-service-desk, com.atlassian.servicedesk:simplified-blank-project-business, com.atlassian.servicedesk:simplified-blank-project-it, com.atlassian.servicedesk:simplified-finance-service-desk, com.atlassian.servicedesk:next-gen-it-service-desk, com.atlassian.servicedesk:next-gen-hr-service-desk, com.atlassian.servicedesk:next-gen-legal-service-desk, com.atlassian.servicedesk:next-gen-marketing-service-desk, com.atlassian.servicedesk:next-gen-facilities-service-desk, com.atlassian.servicedesk:next-gen-general-it-service-desk, com.atlassian.servicedesk:next-gen-general-business-service-desk, com.atlassian.servicedesk:next-gen-analytics-service-desk, com.atlassian.servicedesk:next-gen-finance-service-desk, com.atlassian.servicedesk:next-gen-design-service-desk, com.atlassian.servicedesk:next-gen-sales-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** &gt; **Apps** &gt; **Manage apps** and review the System Apps list. To add Jira Software or Jira Service Management into a JIRA instance, use **Jira settings** &gt; **Apps** &gt; **Finding new apps**. For more information, see [ Managing add-ons](https://confluence.atlassian.com/x/S31NLg). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      createProjectDetails - The JSON representation of the project being created. (required)

    • createProjectAvatar

      Avatar createProjectAvatar(@NotNull @NotNull String projectIdOrKey, @NotNull @NotNull Object body, @Nullable @Nullable Integer x, @Nullable @Nullable Integer y, @Nullable @Nullable Integer size)
      Load project avatar

      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](#special-request-headers). * Content-Type: image/image type Valid image types are JPEG, GIF, or PNG. For example: curl --request POST --user [email protected]:&amp;lt;api_token&amp;gt; --header 'X-Atlassian-Token: no-check' --header 'Content-Type: image/&amp;lt; image_type&amp;gt;' --data-binary "&amp;lt;@/path/to/file/with/your/avatar&amp;gt;" --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](#api-rest-api-3-project-projectIdOrKey-avatar-put) to set it as the project's displayed avatar. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      projectIdOrKey - The ID or (case-sensitive) key of the project. (required)
      body - (required)
      x - The X coordinate of the top-left corner of the crop region. (optional, defaults to 0)
      y - The Y coordinate of the top-left corner of the crop region. (optional, defaults to 0)
      size - The length of each side of the crop region. (optional)

    • createProjectCategory

      ProjectCategory createProjectCategory(@NotNull @NotNull ProjectCategory projectCategory)
      Create project category

      Creates a project category. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      projectCategory - (required)

    • createProjectRole

      ProjectRole createProjectRole(@NotNull @NotNull CreateUpdateRoleRequestBean createUpdateRoleRequestBean)
      Create project role

      Creates a new project role with no [default actors](#api-rest-api-3-resolution-get). You can use the [Add default actors to project role](#api-rest-api-3-role-id-actors-post) 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.*&lt; **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      createUpdateRoleRequestBean - (required)

    • createRelatedWork

      VersionRelatedWork createRelatedWork(@NotNull @NotNull String id, @NotNull @NotNull VersionRelatedWork versionRelatedWork)
      Create related work

      Creates a related work for the given version. You can only create a generic link type of related works via this API. relatedWorkId will be auto-generated UUID, that does not need to be provided. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Resolve issues:* and *Edit issues* [Managing project permissions](https://confluence.atlassian.com/adminjiraserver/managing-project-permissions-938847145.html) for the project that contains the version. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      id - (required)
      versionRelatedWork - (required)

    • createResolution

      ResolutionId createResolution(@NotNull @NotNull CreateResolutionDetails createResolutionDetails)
      Create resolution

      Creates an issue resolution. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      createResolutionDetails - (required)

    • createScreen

      Screen createScreen(@NotNull @NotNull ScreenDetails screenDetails)
      Create screen

      Creates a screen with a default field tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      screenDetails - (required)

    • createScreenScheme

      ScreenSchemeId createScreenScheme(@NotNull @NotNull ScreenSchemeDetails screenSchemeDetails)
      Create screen scheme

      Creates a screen scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      screenSchemeDetails - (required)

    • createStatuses

      List<JiraStatus> createStatuses(@NotNull @NotNull StatusCreateRequest statusCreateRequest)
      Bulk create statuses

      Creates statuses for a global or project scope. **[Permissions](#permissions) required:** * *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg) * *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg) Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      statusCreateRequest - Details of the statuses being created and their scope. (required)

    • createUiModification

      UiModificationIdentifiers createUiModification(@NotNull @NotNull CreateUiModificationDetails createUiModificationDetails)
      Create UI modification

      Creates a UI modification. UI modification can only be created by Forge apps. Each app can define up to 3000 UI modifications. Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications. **[Permissions](#permissions) required:** * *None* if the UI modification is created without contexts. * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the UI modification is created with contexts. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      createUiModificationDetails - Details of the UI modification. (required)

    • createUser

      User createUser(@NotNull @NotNull NewUserDetails newUserDetails)
      Create user

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

      Parameters:
      newUserDetails - Details about the user to be created. (required)

    • createVersion

      Version createVersion(@NotNull @NotNull Version version)
      Create version

      Creates a project version. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project the version is added to. Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      version - (required)

    • createWorkflow

      @Deprecated WorkflowIDs createWorkflow(@NotNull @NotNull CreateWorkflowDetails createWorkflowDetails)
      Deprecated.
      Create workflow

      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. Note: This only applies to company-managed scoped workflows. Use [bulk create workflows](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/#api-rest-api-3-workflows-create-post) to create both team and company-managed scoped workflows. #### 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: =, &amp;gt;, and &amp;lt;. * 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 (deprecated) ##### 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](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions) 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: &amp;gt;, &amp;gt;=, =, &amp;lt;=, &amp;lt;, !=. **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": "&gt;", "date1": "updated", "date2": "created", "expression": "1d", "includeTime": true } } * comparator One of the supported comparator: &amp;gt;, &amp;gt;=, =, &amp;lt;=, &amp;lt;, 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](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions) 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](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions) 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 (deprecated) ##### 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      createWorkflowDetails - The workflow details. (required)

    • createWorkflowScheme

      WorkflowScheme createWorkflowScheme(@NotNull @NotNull WorkflowScheme workflowScheme)
      Create workflow scheme

      Creates a workflow scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      workflowScheme - (required)

    • createWorkflowSchemeDraftFromParent

      WorkflowScheme createWorkflowSchemeDraftFromParent(@NotNull @NotNull Long id)
      Create draft workflow scheme

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the active workflow scheme that the draft is created from. (required)

    • createWorkflowTransitionProperty

      WorkflowTransitionProperty createWorkflowTransitionProperty(@NotNull @NotNull Long transitionId, @NotNull @NotNull String key, @NotNull @NotNull String workflowName, @NotNull @NotNull WorkflowTransitionProperty workflowTransitionProperty, @Nullable @Nullable String workflowMode)
      Create workflow transition property

      Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      transitionId - The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition. (required)
      key - The key of the property being added, also known as the name of the property. Set this to the same value as the key defined in the request body. (required)
      workflowName - The name of the workflow that the transition belongs to. (required)
      workflowTransitionProperty - (required)
      workflowMode - The workflow status. Set to *live* for inactive workflows or *draft* for draft workflows. Active workflows cannot be edited. (optional, defaults to live)

    • createWorkflows

      WorkflowCreateResponse createWorkflows(@NotNull @NotNull WorkflowCreateRequest workflowCreateRequest)
      Bulk create workflows

      Create workflows and related statuses. **[Permissions](#permissions) required:** * *Administer Jira* project permission to create all, including global-scoped, workflows * *Administer projects* project permissions to create project-scoped workflows Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      workflowCreateRequest - (required)

    • deleteActor

      void deleteActor(@NotNull @NotNull String projectIdOrKey, @NotNull @NotNull Long id, @Nullable @Nullable String user, @Nullable @Nullable String group, @Nullable @Nullable String groupId)
      Delete actors from project role

      Deletes actors from a project role for the project. To remove default actors from the project role, use [Delete default actors from project role](#api-rest-api-3-role-id-actors-delete). This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)
      id - The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
      user - The user account ID of the user to remove from the project role. (optional)
      group - The name of the group to remove from the project role. This parameter cannot be used with the groupId parameter. As a group's name can change, use of groupId is recommended. (optional)
      groupId - The ID of the group to remove from the project role. This parameter cannot be used with the group parameter. (optional)

    • deleteAndReplaceVersion

      Object deleteAndReplaceVersion(@NotNull @NotNull String id, @NotNull @NotNull DeleteAndReplaceVersionBean deleteAndReplaceVersionBean)
      Delete and replace version

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version. Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      id - The ID of the version. (required)
      deleteAndReplaceVersionBean - (required)

    • deleteAvatar

      void deleteAvatar(@NotNull @NotNull String type, @NotNull @NotNull String owningObjectId, @NotNull @NotNull Long id)
      Delete avatar

      Deletes an avatar from a project or issue type. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      type - The avatar type. (required)
      owningObjectId - The ID of the item the avatar is associated with. (required)
      id - The ID of the avatar. (required)

    • deleteComment

      void deleteComment(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String id)
      Delete comment

      Deletes a comment. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * *Delete all comments*[ project permission](https://confluence.atlassian.com/x/yodKLg) 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. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      id - The ID of the comment. (required)

    • deleteCommentProperty

      void deleteCommentProperty(@NotNull @NotNull String commentId, @NotNull @NotNull String propertyKey)
      Delete comment property

      Deletes a comment property. **[Permissions](#permissions) required:** either of: * *Edit All Comments* [project permission](https://confluence.atlassian.com/x/yodKLg) to delete a property from any comment. * *Edit Own Comments* [project permission](https://confluence.atlassian.com/x/yodKLg) 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. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      commentId - The ID of the comment. (required)
      propertyKey - The key of the property. (required)

    • deleteComponent

      void deleteComponent(@NotNull @NotNull String id, @Nullable @Nullable String moveIssuesTo)
      Delete component

      Deletes a component. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the component or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      id - The ID of the component. (required)
      moveIssuesTo - The ID of the component to replace the deleted component. If this value is null no replacement is made. (optional)

    • deleteCustomField

      void deleteCustomField(@NotNull @NotNull String id)
      Delete custom field

      Deletes a custom field. The custom field is deleted whether it is in the trash or not. See [Edit or delete a custom field](https://confluence.atlassian.com/x/Z44fOw) for more information on trashing and deleting custom fields. This operation is [asynchronous](#async). Follow the location link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of a custom field. (required)

    • deleteCustomFieldContext

      Object deleteCustomFieldContext(@NotNull @NotNull String fieldId, @NotNull @NotNull Long contextId)
      Delete custom field context

      Deletes a [ custom field context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field. (required)
      contextId - The ID of the context. (required)

    • deleteCustomFieldOption

      void deleteCustomFieldOption(@NotNull @NotNull String fieldId, @NotNull @NotNull Long contextId, @NotNull @NotNull Long optionId)
      Delete custom field options (context)

      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)](#api-group-issue-custom-field-options--apps-) operations.** **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field. (required)
      contextId - The ID of the context from which an option should be deleted. (required)
      optionId - The ID of the option to delete. (required)

    • deleteDashboard

      void deleteDashboard(@NotNull @NotNull String id)
      Delete dashboard

      Deletes a dashboard. **[Permissions](#permissions) required:** None The dashboard to be deleted must be owned by the user. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      id - The ID of the dashboard. (required)

    • deleteDashboardItemProperty

      Object deleteDashboardItemProperty(@NotNull @NotNull String dashboardId, @NotNull @NotNull String itemId, @NotNull @NotNull String propertyKey)
      Delete dashboard item property

      Deletes a dashboard item property. This operation can be accessed anonymously. **[Permissions](#permissions) required:** The user must be the owner of the dashboard. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      dashboardId - The ID of the dashboard. (required)
      itemId - The ID of the dashboard item. (required)
      propertyKey - The key of the dashboard item property. (required)

    • deleteDefaultWorkflow

      WorkflowScheme deleteDefaultWorkflow(@NotNull @NotNull Long id, @Nullable @Nullable Boolean updateDraftIfNeeded)
      Delete default workflow

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme. (required)
      updateDraftIfNeeded - Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to false. (optional)

    • deleteDraftDefaultWorkflow

      WorkflowScheme deleteDraftDefaultWorkflow(@NotNull @NotNull Long id)
      Delete draft default workflow

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme that the draft belongs to. (required)

    • deleteDraftWorkflowMapping

      void deleteDraftWorkflowMapping(@NotNull @NotNull Long id, @NotNull @NotNull String workflowName)
      Delete issue types for workflow in draft workflow scheme

      Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme that the draft belongs to. (required)
      workflowName - The name of the workflow. (required)

    • deleteFavouriteForFilter

      Filter deleteFavouriteForFilter(@NotNull @NotNull Long id, @Nullable @Nullable String expand)
      Remove filter as favorite

      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](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      id - The ID of the filter. (required)
      expand - Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. * subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000]. (optional)

    • deleteFieldConfiguration

      Object deleteFieldConfiguration(@NotNull @NotNull Long id)
      Delete field configuration

      Deletes a field configuration. This operation can only delete configurations used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the field configuration. (required)

    • deleteFieldConfigurationScheme

      Object deleteFieldConfigurationScheme(@NotNull @NotNull Long id)
      Delete field configuration scheme

      Deletes a field configuration scheme. This operation can only delete field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the field configuration scheme. (required)

    • deleteFilter

      void deleteFilter(@NotNull @NotNull Long id)
      Delete filter

      Delete a filter. **[Permissions](#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](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [write:jira-work]

      Parameters:
      id - The ID of the filter to delete. (required)

    • deleteInactiveWorkflow

      void deleteInactiveWorkflow(@NotNull @NotNull String entityId)
      Delete inactive workflow

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      entityId - The entity ID of the workflow. (required)

    • deleteIssue

      void deleteIssue(@NotNull @NotNull String issueIdOrKey, @Nullable @Nullable String deleteSubtasks)
      Delete issue

      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](#permissions) required:** * *Browse projects* and *Delete issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      deleteSubtasks - Whether the issue's subtasks are deleted when the issue is deleted. (optional, defaults to false)

    • deleteIssueFieldOption

      Object deleteIssueFieldOption(@NotNull @NotNull String fieldKey, @NotNull @NotNull Long optionId)
      Delete issue field option

      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](#api-group-Issue-custom-field-options) resource. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldKey - The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the fieldKey value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the jiraIssueFields module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field" (required)
      optionId - The ID of the option to be deleted. (required)

    • deleteIssueLink

      void deleteIssueLink(@NotNull @NotNull String linkId)
      Delete issue link

      Deletes an issue link. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * Browse project [project permission](https://confluence.atlassian.com/x/yodKLg) for all the projects containing the issues in the link. * *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for at least one of the projects containing issues in the link. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, permission to view both of the issues. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      linkId - The ID of the issue link. (required)

    • deleteIssueLinkType

      void deleteIssueLinkType(@NotNull @NotNull String issueLinkTypeId)
      Delete issue link type

      Deletes an issue link type. To use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueLinkTypeId - The ID of the issue link type. (required)

    • deleteIssueProperty

      void deleteIssueProperty(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String propertyKey)
      Delete issue property

      Deletes an issue's property. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The key or ID of the issue. (required)
      propertyKey - The key of the property. (required)

    • deleteIssueType

      void deleteIssueType(@NotNull @NotNull String id, @Nullable @Nullable String alternativeIssueTypeId)
      Delete issue type

      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](#api-rest-api-3-issuetype-id-alternatives-get) resource. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the issue type. (required)
      alternativeIssueTypeId - The ID of the replacement issue type. (optional)

    • deleteIssueTypeProperty

      void deleteIssueTypeProperty(@NotNull @NotNull String issueTypeId, @NotNull @NotNull String propertyKey)
      Delete issue type property

      Deletes the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeId - The ID of the issue type. (required)
      propertyKey - The key of the property. Use [Get issue type property keys](#api-rest-api-3-issuetype-issueTypeId-properties-get) to get a list of all issue type property keys. (required)

    • deleteIssueTypeScheme

      Object deleteIssueTypeScheme(@NotNull @NotNull Long issueTypeSchemeId)
      Delete issue type scheme

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeSchemeId - The ID of the issue type scheme. (required)

    • deleteIssueTypeScreenScheme

      Object deleteIssueTypeScreenScheme(@NotNull @NotNull String issueTypeScreenSchemeId)
      Delete issue type screen scheme

      Deletes an issue type screen scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeScreenSchemeId - The ID of the issue type screen scheme. (required)

    • deleteLocale

      @Deprecated Object deleteLocale()
      Deprecated.
      Delete locale

      Deprecated, use [ Update a user profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) from the user management REST API instead. Deletes the locale of the user, which restores the default setting. **[Permissions](#permissions) required:** Permission to access Jira.

    • deleteNotificationScheme

      Object deleteNotificationScheme(@NotNull @NotNull String notificationSchemeId)
      Delete notification scheme

      Deletes a notification scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      notificationSchemeId - The ID of the notification scheme. (required)

    • deletePermissionScheme

      void deletePermissionScheme(@NotNull @NotNull Long schemeId)
      Delete permission scheme

      Deletes a permission scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      schemeId - The ID of the permission scheme being deleted. (required)

    • deletePermissionSchemeEntity

      void deletePermissionSchemeEntity(@NotNull @NotNull Long schemeId, @NotNull @NotNull Long permissionId)
      Delete permission scheme grant

      Deletes a permission grant from a permission scheme. See [About permission schemes and grants](../api-group-permission-schemes/#about-permission-schemes-and-grants) for more details. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      schemeId - The ID of the permission scheme to delete the permission grant from. (required)
      permissionId - The ID of the permission grant to delete. (required)

    • deletePriority

      @Deprecated void deletePriority(@NotNull @NotNull String id, @NotNull @NotNull String replaceWith)
      Deprecated.
      Delete priority

      *Deprecated: please refer to the* [changelog](https://developer.atlassian.com/changelog/#CHANGE-1066) *for more details.* Deletes an issue priority. This operation is [asynchronous](#async). Follow the location link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the issue priority. (required)
      replaceWith - The ID of the issue priority that will replace the currently selected resolution. (required)

    • deleteProject

      void deleteProject(@NotNull @NotNull String projectIdOrKey, @Nullable @Nullable Boolean enableUndo)
      Delete project

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)
      enableUndo - Whether this project is placed in the Jira recycle bin where it will be available for restoration. (optional, defaults to true)

    • deleteProjectAsynchronously

      void deleteProjectAsynchronously(@NotNull @NotNull String projectIdOrKey)
      Delete project asynchronously

      Deletes a project asynchronously. This operation is: * transactional, that is, if part of the delete fails the project is not deleted. * [asynchronous](#async). Follow the location link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)

    • deleteProjectAvatar

      void deleteProjectAvatar(@NotNull @NotNull String projectIdOrKey, @NotNull @NotNull Long id)
      Delete project avatar

      Deletes a custom avatar from a project. Note that system avatars cannot be deleted. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      projectIdOrKey - The project ID or (case-sensitive) key. (required)
      id - The ID of the avatar. (required)

    • deleteProjectProperty

      void deleteProjectProperty(@NotNull @NotNull String projectIdOrKey, @NotNull @NotNull String propertyKey)
      Delete project property

      Deletes the [property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties) from a project. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the property. Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)
      propertyKey - The project property key. Use [Get project property keys](#api-rest-api-3-project-projectIdOrKey-properties-get) to get a list of all project property keys. (required)

    • deleteProjectRole

      void deleteProjectRole(@NotNull @NotNull Long id, @Nullable @Nullable Long swap)
      Delete project role

      Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the project role to delete. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
      swap - The ID of the project role that will replace the one being deleted. (optional)

    • deleteProjectRoleActorsFromRole

      ProjectRole deleteProjectRoleActorsFromRole(@NotNull @NotNull Long id, @Nullable @Nullable String user, @Nullable @Nullable String groupId, @Nullable @Nullable String group)
      Delete default actors from project role

      Deletes the [default actors](#api-rest-api-3-resolution-get) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
      user - The user account ID of the user to remove as a default actor. (optional)
      groupId - The group ID of the group to be removed as a default actor. This parameter cannot be used with the group parameter. (optional)
      group - The group name of the group to be removed as a default actor.This parameter cannot be used with the groupId parameter. As a group's name can change, use of groupId is recommended. (optional)

    • deleteRelatedWork

      void deleteRelatedWork(@NotNull @NotNull String versionId, @NotNull @NotNull String relatedWorkId)
      Delete related work

      Deletes the given related work for the given version. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Resolve issues:* and *Edit issues* [Managing project permissions](https://confluence.atlassian.com/adminjiraserver/managing-project-permissions-938847145.html) for the project that contains the version. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      versionId - The ID of the version that the target related work belongs to. (required)
      relatedWorkId - The ID of the related work to delete. (required)

    • deleteRemoteIssueLinkByGlobalId

      void deleteRemoteIssueLinkByGlobalId(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String globalId)
      Delete remote issue link by global ID

      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&amp;id=1 as system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1. This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM). This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is implemented, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      globalId - The global ID of a remote issue link. (required)

    • deleteRemoteIssueLinkById

      void deleteRemoteIssueLinkById(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String linkId)
      Delete remote issue link by ID

      Deletes a remote issue link from an issue. This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM). This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects*, *Edit issues*, and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      linkId - The ID of a remote issue link. (required)

    • deleteResolution

      void deleteResolution(@NotNull @NotNull String id, @NotNull @NotNull String replaceWith)
      Delete resolution

      Deletes an issue resolution. This operation is [asynchronous](#async). Follow the location link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the issue resolution. (required)
      replaceWith - The ID of the issue resolution that will replace the currently selected resolution. (required)

    • deleteScreen

      void deleteScreen(@NotNull @NotNull Long screenId)
      Delete screen

      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. Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      screenId - The ID of the screen. (required)

    • deleteScreenScheme

      void deleteScreenScheme(@NotNull @NotNull String screenSchemeId)
      Delete screen scheme

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      screenSchemeId - The ID of the screen scheme. (required)

    • deleteScreenTab

      void deleteScreenTab(@NotNull @NotNull Long screenId, @NotNull @NotNull Long tabId)
      Delete screen tab

      Deletes a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      screenId - The ID of the screen. (required)
      tabId - The ID of the screen tab. (required)

    • deleteSecurityScheme

      Object deleteSecurityScheme(@NotNull @NotNull String schemeId)
      Delete issue security scheme

      Deletes an issue security scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      schemeId - The ID of the issue security scheme. (required)

    • deleteSharePermission

      void deleteSharePermission(@NotNull @NotNull Long id, @NotNull @NotNull Long permissionId)
      Delete share permission

      Deletes a share permission from a filter. **[Permissions](#permissions) required:** Permission to access Jira and the user must own the filter. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      id - The ID of the filter. (required)
      permissionId - The ID of the share permission. (required)

    • deleteStatusesById

      Object deleteStatusesById(@NotNull @NotNull List<String> id)
      Bulk delete Statuses

      Deletes statuses by ID. **[Permissions](#permissions) required:** * *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg) * *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg) Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Min items 1, Max items 50 (required)

    • deleteUiModification

      Object deleteUiModification(@NotNull @NotNull String uiModificationId)
      Delete UI modification

      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](#permissions) required:** None.

      Parameters:
      uiModificationId - The ID of the UI modification. (required)

    • deleteUserProperty

      void deleteUserProperty(@NotNull @NotNull String propertyKey, @Nullable @Nullable String accountId, @Nullable @Nullable String userKey, @Nullable @Nullable String username)
      Delete user property

      Deletes a property from a user. Note: This operation does not access the [user properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to delete a property from any user. * Access to Jira, to delete a property from the calling user's record. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      propertyKey - The key of the user's property. (required)
      accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. (optional)
      userKey - This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)

    • deleteVersion

      @Deprecated void deleteVersion(@NotNull @NotNull String id, @Nullable @Nullable String moveFixIssuesTo, @Nullable @Nullable String moveAffectedIssuesTo)
      Deprecated.
      Delete version

      Deletes a project version. Deprecated, use [ Delete and replace version](#api-rest-api-3-version-id-removeAndSwap-post) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version. Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      id - The ID of the version. (required)
      moveFixIssuesTo - The ID of the version to update fixVersion to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted. (optional)
      moveAffectedIssuesTo - The ID of the version to update affectedVersion to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted. (optional)

    • deleteWebhookById

      void deleteWebhookById(@NotNull @NotNull ContainerForWebhookIDs containerForWebhookIDs)
      Delete webhooks by ID

      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](#permissions) required:** Only [Connect](https://developer.atlassian.com/cloud/jira/platform/#connect-apps) and [OAuth 2.0](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps) apps can use this operation. Authentication - Required Scopes: [read:jira-work, manage:jira-webhook]

      Parameters:
      containerForWebhookIDs - (required)

    • deleteWorkflowMapping

      void deleteWorkflowMapping(@NotNull @NotNull Long id, @NotNull @NotNull String workflowName, @Nullable @Nullable Boolean updateDraftIfNeeded)
      Delete issue types for workflow in workflow scheme

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme. (required)
      workflowName - The name of the workflow. (required)
      updateDraftIfNeeded - Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to false. (optional)

    • deleteWorkflowScheme

      Object deleteWorkflowScheme(@NotNull @NotNull Long id)
      Delete workflow scheme

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, *schemeId=10301*. (required)

    • deleteWorkflowSchemeDraft

      void deleteWorkflowSchemeDraft(@NotNull @NotNull Long id)
      Delete draft workflow scheme

      Deletes a draft workflow scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the active workflow scheme that the draft was created from. (required)

    • deleteWorkflowSchemeDraftIssueType

      WorkflowScheme deleteWorkflowSchemeDraftIssueType(@NotNull @NotNull Long id, @NotNull @NotNull String issueType)
      Delete workflow for issue type in draft workflow scheme

      Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme that the draft belongs to. (required)
      issueType - The ID of the issue type. (required)

    • deleteWorkflowSchemeIssueType

      WorkflowScheme deleteWorkflowSchemeIssueType(@NotNull @NotNull Long id, @NotNull @NotNull String issueType, @Nullable @Nullable Boolean updateDraftIfNeeded)
      Delete workflow for issue type in workflow scheme

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme. (required)
      issueType - The ID of the issue type. (required)
      updateDraftIfNeeded - Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to false. (optional)

    • deleteWorkflowTransitionProperty

      void deleteWorkflowTransitionProperty(@NotNull @NotNull Long transitionId, @NotNull @NotNull String key, @NotNull @NotNull String workflowName, @Nullable @Nullable String workflowMode)
      Delete workflow transition property

      Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      transitionId - The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition. (required)
      key - The name of the transition property to delete, also known as the name of the property. (required)
      workflowName - The name of the workflow that the transition belongs to. (required)
      workflowMode - The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited. (optional)

    • deleteWorkflowTransitionRuleConfigurations

      WorkflowTransitionRulesUpdateErrors deleteWorkflowTransitionRuleConfigurations(@NotNull @NotNull WorkflowsWithTransitionRulesDetails workflowsWithTransitionRulesDetails)
      Delete workflow transition rule configurations

      Deletes workflow transition rules from one or more workflows. These rule types are supported: * [post functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/) * [conditions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-condition/) * [validators](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-validator/) Only rules created by the calling Connect app can be deleted. **[Permissions](#permissions) required:** Only Connect apps can use this operation.

      Parameters:
      workflowsWithTransitionRulesDetails - (required)

    • deleteWorklog

      void deleteWorklog(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String id, @Nullable @Nullable Boolean notifyUsers, @Nullable @Nullable String adjustEstimate, @Nullable @Nullable String newEstimate, @Nullable @Nullable String increaseBy, @Nullable @Nullable Boolean overrideEditableFlag)
      Delete worklog

      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](https://confluence.atlassian.com/x/qoXKM). This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * *Delete all worklogs*[ project permission](https://confluence.atlassian.com/x/yodKLg) 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. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      id - The ID of the worklog. (required)
      notifyUsers - Whether users watching the issue are notified by email. (optional, defaults to true)
      adjustEstimate - Defines how to update the issue's time estimate, the options are: * new Sets the estimate to a specific value, defined in newEstimate. * leave Leaves the estimate unchanged. * manual Increases the estimate by amount specified in increaseBy. * auto Reduces the estimate by the value of timeSpent in the worklog. (optional, defaults to auto)
      newEstimate - The value to set as the issue's remaining time estimate, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when adjustEstimate is new. (optional)
      increaseBy - The amount to increase the issue's remaining estimate by, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when adjustEstimate is manual. (optional)
      overrideEditableFlag - Whether the work log entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with admin permission can use this flag. (optional, defaults to false)

    • deleteWorklogProperty

      void deleteWorklogProperty(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String worklogId, @NotNull @NotNull String propertyKey)
      Delete worklog property

      Deletes a worklog property. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      worklogId - The ID of the worklog. (required)
      propertyKey - The key of the property. (required)

    • doTransition

      Object doTransition(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull IssueUpdateDetails issueUpdateDetails)
      Transition issue

      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](#api-rest-api-3-issue-issueIdOrKey-transitions-get) with the transitions.fields expand. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Transition issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      issueUpdateDetails - (required)

    • dynamicModulesResourceGetModulesGet

      ConnectModules dynamicModulesResourceGetModulesGet()
      Get modules

      Returns all modules registered dynamically by the calling app. **[Permissions](#permissions) required:** Only Connect apps can make this request.

    • dynamicModulesResourceRegisterModulesPost

      void dynamicModulesResourceRegisterModulesPost(@NotNull @NotNull ConnectModules connectModules)
      Register modules

      Registers a list of modules. **[Permissions](#permissions) required:** Only Connect apps can make this request.

      Parameters:
      connectModules - (required)

    • dynamicModulesResourceRemoveModulesDelete

      void dynamicModulesResourceRemoveModulesDelete(@Nullable @Nullable List<String> moduleKey)
      Remove modules

      Remove all or a list of modules registered by the calling app. **[Permissions](#permissions) required:** Only Connect apps can make this request.

      Parameters:
      moduleKey - The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter. For example, moduleKey=dynamic-attachment-entity-property&amp;moduleKey=dynamic-select-field. Nonexistent keys are ignored. (optional)

    • editIssue

      Object editIssue(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull IssueUpdateDetails issueUpdateDetails, @Nullable @Nullable Boolean notifyUsers, @Nullable @Nullable Boolean overrideScreenSecurity, @Nullable @Nullable Boolean overrideEditableFlag, @Nullable @Nullable Boolean returnIssue, @Nullable @Nullable String expand)
      Edit issue

      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](#api-rest-api-3-issue-issueIdOrKey-editmeta-get). 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](https://confluence.atlassian.com/x/x4dKLg), and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), can override the screen security configuration using overrideScreenSecurity and overrideEditableFlag. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      issueUpdateDetails - (required)
      notifyUsers - Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored. (optional, defaults to true)
      overrideScreenSecurity - Whether screen security is overridden to enable hidden fields to be edited. Available to Connect app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, defaults to false)
      overrideEditableFlag - Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, defaults to false)
      returnIssue - Whether the response should contain the issue with fields edited in this request. The returned issue will have the same format as in the [Get issue API](#api-rest-api-3-issue-issueidorkey-get). (optional, defaults to false)
      expand - The Get issue API expand parameter to use in the response if the returnIssue parameter is true. (optional)

    • evaluateJiraExpression

      JiraExpressionResult evaluateJiraExpression(@NotNull @NotNull JiraExpressionEvalRequestBean jiraExpressionEvalRequestBean, @Nullable @Nullable String expand)
      Evaluate Jira expression

      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](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/) 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](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user)): The current user. Always available and equal to null if the request is anonymous. * app ([App](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#app)): The [Connect app](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) that made the request. Available only for authenticated requests made by Connect Apps (read more here: [Authentication for Connect apps](https://developer.atlassian.com/cloud/jira/platform/security-for-connect-apps/)). * issue ([Issue](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#issue)): The current issue. Available only when the issue is provided in the request context object. * issues ([List](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#list) of [Issues](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#issue)): A collection of issues matching a JQL query. Available only when JQL is provided in the request context object. * project ([Project](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#project)): The current project. Available only when the project is provided in the request context object. * sprint ([Sprint](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#sprint)): The current sprint. Available only when the sprint is provided in the request context object. * board ([Board](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#board)): The current board. Available only when the board is provided in the request context object. * serviceDesk ([ServiceDesk](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#servicedesk)): The current service desk. Available only when the service desk is provided in the request context object. * customerRequest ([CustomerRequest](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#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](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user) specified as an Atlassian account ID. * issue: An [issue](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#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](#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). Authentication - Required Scopes: [read:jira-work, read:jira-user]

      Parameters:
      jiraExpressionEvalRequestBean - The Jira expression and the evaluation context. (required)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts meta.complexity that returns information about the expression complexity. For example, the number of expensive operations used by the expression and how close the expression is to reaching the [complexity limit](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#restrictions). Useful when designing and debugging your expressions. (optional)

    • expandAttachmentForHumans

      AttachmentArchiveMetadataReadable expandAttachmentForHumans(@NotNull @NotNull String id)
      Get all metadata for an expanded attachment

      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](#api-rest-api-3-attachment-id-expand-raw-get), which only returns the metadata for the attachment's contents. This operation can be accessed anonymously. **[Permissions](#permissions) required:** For the issue containing the attachment: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the attachment. (required)

    • expandAttachmentForMachines

      AttachmentArchiveImpl expandAttachmentForMachines(@NotNull @NotNull String id)
      Get contents metadata for an expanded attachment

      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](#api-rest-api-3-attachment-id-expand-human-get) which also returns the metadata for the attachment itself, such as the attachment's ID and name. This operation can be accessed anonymously. **[Permissions](#permissions) required:** For the issue containing the attachment: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the attachment. (required)

    • exportArchivedIssues

      ExportArchivedIssuesTaskProgressResponse exportArchivedIssues(@NotNull @NotNull ArchivedIssuesFilterRequest archivedIssuesFilterRequest)
      Export archived issue(s)

      Enables admins to retrieve details of all archived issues. Upon a successful request, the admin who submitted it will receive an email with a link to download a CSV file with the issue details. Note that this API only exports the values of system fields and archival-specific fields (ArchivedBy and ArchivedDate). Custom fields aren't supported. **[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg) **License required:** Premium or Enterprise **Signed-in users only:** This API can't be accessed anonymously. **Rate limiting:** Only a single request can be active at any given time. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      archivedIssuesFilterRequest - You can filter the issues in your request by the projects, archivedBy, archivedDate, issueTypes, and reporters fields. All filters are optional. If you don't provide any filters, you'll get a list of up to one million archived issues. (required)

    • findAssignableUsers

      List<User> findAssignableUsers(@Nullable @Nullable String query, @Nullable @Nullable String sessionId, @Nullable @Nullable String username, @Nullable @Nullable String accountId, @Nullable @Nullable String project, @Nullable @Nullable String issueKey, @Nullable @Nullable Integer startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Integer actionDescriptorId, @Nullable @Nullable Boolean recommend)
      Find users assignable to issues

      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](#api-rest-api-3-issue-issueIdOrKey-get). 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](#api-rest-api-3-users-search-get) 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](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Assign issues* [project permission](https://confluence.atlassian.com/x/yodKLg) Authentication - Required Scopes: [read:jira-user]

      Parameters:
      query - A query string that is matched against user attributes, such as displayName, and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a displayName of *John Smith* and a user with an emailAddress of *[email protected]*. Required, unless username or accountId is specified. (optional)
      sessionId - The sessionId of this request. SessionId is the same until the assignee is set. (optional)
      username - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - A query string that is matched exactly against user accountId. Required, unless query is specified. (optional)
      project - The project ID or project key (case sensitive). Required, unless issueKey is specified. (optional)
      issueKey - The key of the issue. Required, unless project is specified. (optional)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return. This operation may return less than the maximum number of items even if more are available. The operation fetches users up to the maximum and then, from the fetched users, returns only the users that can be assigned to the issue. (optional, defaults to 50)
      actionDescriptorId - The ID of the transition. (optional)
      recommend - (optional, defaults to false)

    • findBulkAssignableUsers

      List<User> findBulkAssignableUsers(@NotNull @NotNull String projectKeys, @Nullable @Nullable String query, @Nullable @Nullable String username, @Nullable @Nullable String accountId, @Nullable @Nullable Integer startAt, @Nullable @Nullable Integer maxResults)
      Find users assignable to projects

      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](#api-rest-api-3-users-search-get) 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](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [read:jira-user]

      Parameters:
      projectKeys - A list of project keys (case sensitive). This parameter accepts a comma-separated list. (required)
      query - A query string that is matched against user attributes, such as displayName and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a displayName of *John Smith* and a user with an emailAddress of *[email protected]*. Required, unless accountId is specified. (optional)
      username - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - A query string that is matched exactly against user accountId. Required, unless query is specified. (optional)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)

    • findGroups

      FoundGroups findGroups(@Nullable @Nullable String accountId, @Nullable @Nullable String query, @Nullable @Nullable List<String> exclude, @Nullable @Nullable List<String> excludeId, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Boolean caseInsensitive, @Nullable @Nullable String userName)
      Find groups

      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](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg). Anonymous calls and calls by users without the required permission return an empty list. *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Without this permission, calls where query is not an exact match to an existing group will return an empty list. Authentication - Required Scopes: [read:jira-user]

      Parameters:
      accountId - This parameter is deprecated, setting it does not affect the results. To find groups containing a particular user, use [Get user groups](#api-rest-api-3-user-groups-get). (optional)
      query - The string to find in group names. (optional)
      exclude - As a group's name can change, use of excludeGroupIds is recommended to identify a group. A group to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, exclude=group1&amp;exclude=group2. This parameter cannot be used with the excludeGroupIds parameter. (optional)
      excludeId - A group ID to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, excludeId=group1-id&amp;excludeId=group2-id. This parameter cannot be used with the excludeGroups parameter. (optional)
      maxResults - The maximum number of groups to return. The maximum number of groups that can be returned is limited by the system property jira.ajax.autocomplete.limit. (optional)
      caseInsensitive - Whether the search for groups should be case insensitive. (optional, defaults to false)
      userName - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)

    • findUserKeysByQuery

      PageBeanUserKey findUserKeysByQuery(@NotNull @NotNull String query, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResult)
      Find user keys by query

      Finds users with a structured query and returns a [paginated](#pagination) 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](#api-rest-api-3-users-search-get) and filter the records in your code. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). 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" Authentication - Required Scopes: [read:jira-user]

      Parameters:
      query - The search query. (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResult - The maximum number of items to return per page. (optional, defaults to 100)

    • findUsers

      List<User> findUsers(@Nullable @Nullable String query, @Nullable @Nullable String username, @Nullable @Nullable String accountId, @Nullable @Nullable Integer startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable String property)
      Find users

      Returns a list of active 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](#api-rest-api-3-users-search-get) 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](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls or calls by users without the required permission return empty search results. Authentication - Required Scopes: [read:jira-user]

      Parameters:
      query - A query string that is matched against user attributes ( displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a displayName of *John Smith* and a user with an emailAddress of *[email protected]*. Required, unless accountId or property is specified. (optional)
      username - (optional)
      accountId - A query string that is matched exactly against a user accountId. Required, unless query or property is specified. (optional)
      startAt - The index of the first item to return in a page of filtered results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      property - A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of nested from {"something":{"nested":1,"other":2}} use thepropertykey.something.nested=1. Required, unless accountId or query is specified. (optional)

    • findUsersAndGroups

      FoundUsersAndGroups findUsersAndGroups(@NotNull @NotNull String query, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Boolean showAvatar, @Nullable @Nullable String fieldId, @Nullable @Nullable List<String> projectId, @Nullable @Nullable List<String> issueTypeId, @Nullable @Nullable String avatarSize, @Nullable @Nullable Boolean caseInsensitive, @Nullable @Nullable Boolean excludeConnectAddons)
      Find users and groups

      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 *[email protected]*, 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](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/yodKLg). Authentication - Required Scopes: [read:jira-work]

      Parameters:
      query - The search string. (required)
      maxResults - The maximum number of items to return in each list. (optional, defaults to 50)
      showAvatar - Whether the user avatar should be returned. If an invalid value is provided, the default value is used. (optional, defaults to false)
      fieldId - The custom field ID of the field this request is for. (optional)
      projectId - The ID of a project that returned users and groups must have permission to view. To include multiple projects, provide an ampersand-separated list. For example, projectId=10000&amp;projectId=10001. This parameter is only used when fieldId is present. (optional)
      issueTypeId - The ID of an issue type that returned users and groups must have permission to view. To include multiple issue types, provide an ampersand-separated list. For example, issueTypeId=10000&amp;issueTypeId=10001. Special values, such as -1 (all standard issue types) and -2 (all subtask issue types), are supported. This parameter is only used when fieldId is present. (optional)
      avatarSize - The size of the avatar to return. If an invalid value is provided, the default value is used. (optional, defaults to xsmall)
      caseInsensitive - Whether the search for groups should be case insensitive. (optional, defaults to false)
      excludeConnectAddons - Whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used. (optional, defaults to false)

    • findUsersByQuery

      PageBeanUser findUsersByQuery(@NotNull @NotNull String query, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Find users by query

      Finds users with a structured query and returns a [paginated](#pagination) 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](#api-rest-api-3-users-search-get) and filter the records in your code. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). 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" Authentication - Required Scopes: [read:jira-user]

      Parameters:
      query - The search query. (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 100)

    • findUsersForPicker

      FoundUsers findUsersForPicker(@NotNull @NotNull String query, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Boolean showAvatar, @Nullable @Nullable List<String> exclude, @Nullable @Nullable List<String> excludeAccountIds, @Nullable @Nullable String avatarSize, @Nullable @Nullable Boolean excludeConnectUsers)
      Find users for picker

      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](#api-rest-api-3-users-search-get) 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](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and calls by users without the required permission return search results for an exact name match only. Authentication - Required Scopes: [read:jira-user]

      Parameters:
      query - A query string that is matched against user attributes, such as displayName, and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a displayName of *John Smith* and a user with an emailAddress of *[email protected]*. (required)
      maxResults - The maximum number of items to return. The total number of matched users is returned in total. (optional, defaults to 50)
      showAvatar - Include the URI to the user's avatar. (optional, defaults to false)
      exclude - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      excludeAccountIds - A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&amp;excludeAccountIds=5b10ac8d82e05b22cc7d4ef5. Cannot be provided with exclude. (optional)
      avatarSize - (optional)
      excludeConnectUsers - (optional, defaults to false)

    • findUsersWithAllPermissions

      List<User> findUsersWithAllPermissions(@NotNull @NotNull String permissions, @Nullable @Nullable String query, @Nullable @Nullable String username, @Nullable @Nullable String accountId, @Nullable @Nullable String issueKey, @Nullable @Nullable String projectKey, @Nullable @Nullable Integer startAt, @Nullable @Nullable Integer maxResults)
      Find users with permissions

      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](#api-rest-api-3-users-search-get) 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](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to get users for any project. * *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project, to get users for that project. Authentication - Required Scopes: [read:jira-user]

      Parameters:
      permissions - A comma separated list of permissions. Permissions can be specified as any: * permission returned by [Get all permissions](#api-rest-api-3-permissions-get). * custom project permission added by Connect apps. * (deprecated) one of the following: * ASSIGNABLE\\_USER * ASSIGN\\_ISSUE * ATTACHMENT\\_DELETE\\_ALL * ATTACHMENT\\_DELETE\\_OWN * BROWSE * CLOSE\\_ISSUE * COMMENT\\_DELETE\\_ALL * COMMENT\\_DELETE\\_OWN * COMMENT\\_EDIT\\_ALL * COMMENT\\_EDIT\\_OWN * COMMENT\\_ISSUE * CREATE\\_ATTACHMENT * CREATE\\_ISSUE * DELETE\\_ISSUE * EDIT\\_ISSUE * LINK\\_ISSUE * MANAGE\\_WATCHER\\_LIST * MODIFY\\_REPORTER * MOVE\\_ISSUE * PROJECT\\_ADMIN * RESOLVE\\_ISSUE * SCHEDULE\\_ISSUE * SET\\_ISSUE\\_SECURITY * TRANSITION\\_ISSUE * VIEW\\_VERSION\\_CONTROL * VIEW\\_VOTERS\\_AND\\_WATCHERS * VIEW\\_WORKFLOW\\_READONLY * WORKLOG\\_DELETE\\_ALL * WORKLOG\\_DELETE\\_OWN * WORKLOG\\_EDIT\\_ALL * WORKLOG\\_EDIT\\_OWN * WORK\\_ISSUE (required)
      query - A query string that is matched against user attributes, such as displayName and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a displayName of *John Smith* and a user with an emailAddress of *[email protected]*. Required, unless accountId is specified. (optional)
      username - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - A query string that is matched exactly against user accountId. Required, unless query is specified. (optional)
      issueKey - The issue key for the issue. (optional)
      projectKey - The project key for the project (case sensitive). (optional)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)

    • findUsersWithBrowsePermission

      List<User> findUsersWithBrowsePermission(@Nullable @Nullable String query, @Nullable @Nullable String username, @Nullable @Nullable String accountId, @Nullable @Nullable String issueKey, @Nullable @Nullable String projectKey, @Nullable @Nullable Integer startAt, @Nullable @Nullable Integer maxResults)
      Find users with browse permission

      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](#api-rest-api-3-users-search-get) 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](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and calls by users without the required permission return empty search results. Authentication - Required Scopes: [read:jira-user]

      Parameters:
      query - A query string that is matched against user attributes, such as displayName and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a displayName of *John Smith* and a user with an emailAddress of *[email protected]*. Required, unless accountId is specified. (optional)
      username - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - A query string that is matched exactly against user accountId. Required, unless query is specified. (optional)
      issueKey - The issue key for the issue. Required, unless projectKey is specified. (optional)
      projectKey - The project key for the project (case sensitive). Required, unless issueKey is specified. (optional)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)

    • fullyUpdateProjectRole

      ProjectRole fullyUpdateProjectRole(@NotNull @NotNull Long id, @NotNull @NotNull CreateUpdateRoleRequestBean createUpdateRoleRequestBean)
      Fully update project role

      Updates the project role's name and description. You must include both a name and a description in the request. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
      createUpdateRoleRequestBean - (required)

    • getAccessibleProjectTypeByKey

      ProjectType getAccessibleProjectTypeByKey(@NotNull @NotNull String projectTypeKey)
      Get accessible project type by key

      Returns a [project type](https://confluence.atlassian.com/x/Var1Nw) if it is accessible to the user. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectTypeKey - The key of the project type. (required)

    • getAdvancedSettings

      List<ApplicationProperty> getAdvancedSettings()
      Get advanced settings

      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 &gt; **Jira settings** &gt; **System**, **General Configuration** and then click **Advanced Settings** (in the upper right). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

    • getAllAccessibleProjectTypes

      List<ProjectType> getAllAccessibleProjectTypes()
      Get licensed project types

      Returns all [project types](https://confluence.atlassian.com/x/Var1Nw) with a valid license. Authentication - Required Scopes: [read:jira-work]

    • getAllApplicationRoles

      List<ApplicationRole> getAllApplicationRoles()
      Get all application roles

      Returns all application roles. In Jira, application roles are managed using the [Application access configuration](https://confluence.atlassian.com/x/3YxjL) page. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

    • getAllAvailableDashboardGadgets

      AvailableDashboardGadgetsResponse getAllAvailableDashboardGadgets()
      Get available gadgets

      Gets a list of all available gadgets that can be added to all dashboards. **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

    • getAllDashboards

      PageOfDashboards getAllDashboards(@Nullable @Nullable String filter, @Nullable @Nullable Integer startAt, @Nullable @Nullable Integer maxResults)
      Get all dashboards

      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](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      filter - The filter applied to the list of dashboards. Valid values are: * favourite Returns dashboards the user has marked as favorite. * my Returns dashboards owned by the user. (optional)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 20)

    • getAllFieldConfigurations

      PageBeanFieldConfigurationDetails getAllFieldConfigurations(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Set<Long> id, @Nullable @Nullable Boolean isDefault, @Nullable @Nullable String query)
      Get all field configurations

      Returns a [paginated](#pagination) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      id - The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&amp;id=10001. (optional)
      isDefault - If *true* returns default field configurations only. (optional, defaults to false)
      query - The query string used to match against field configuration names and descriptions. (optional)

    • getAllFieldgRnfigurationSchemes

      PageBeanFieldConfigurationScheme getAllFieldgRnfigurationSchemes(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Set<Long> id)
      Get all fieldg rnfiguration schemes

      Returns a [paginated](#pagination) list of field configuration schemes. Only field configuration schemes used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      id - The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&amp;id=10001. (optional)

    • getAllGadgets

      DashboardGadgetResponse getAllGadgets(@NotNull @NotNull Long dashboardId, @Nullable @Nullable List<String> moduleKey, @Nullable @Nullable List<String> uri, @Nullable @Nullable List<Long> gadgetId)
      Get gadgets

      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](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      dashboardId - The ID of the dashboard. (required)
      moduleKey - The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: moduleKey=key:one&amp;moduleKey=key:two. (optional)
      uri - The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: uri=/rest/example/uri/1&amp;uri=/rest/example/uri/2. (optional)
      gadgetId - The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: gadgetId=10000&amp;gadgetId=10001. (optional)

    • getAllIssueFieldOptions

      PageBeanIssueFieldOption getAllIssueFieldOptions(@NotNull @NotNull String fieldKey, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Get all issue field options

      Returns a [paginated](#pagination) list of all the options of a select list issue field. A select list issue field is a type of [issue field](https://developer.atlassian.com/cloud/jira/platform/modules/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](#api-group-Issue-custom-field-options) resource. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldKey - The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the fieldKey value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the jiraIssueFields module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field" (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)

    • getAllIssueTypeSchemes

      PageBeanIssueTypeScheme getAllIssueTypeSchemes(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Set<Long> id, @Nullable @Nullable String orderBy, @Nullable @Nullable String expand, @Nullable @Nullable String queryString)
      Get all issue type schemes

      Returns a [paginated](#pagination) list of issue type schemes. Only issue type schemes used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      id - The list of issue type schemes IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&amp;id=10001. (optional)
      orderBy - [Order](#ordering) the results by a field: * name Sorts by issue type scheme name. * id Sorts by issue type scheme ID. (optional, defaults to id)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * projects For each issue type schemes, returns information about the projects the issue type scheme is assigned to. * issueTypes For each issue type schemes, returns information about the issueTypes the issue type scheme have. (optional)
      queryString - String used to perform a case-insensitive partial match with issue type scheme name. (optional)

    • getAllLabels

      PageBeanString getAllLabels(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Get all labels

      Returns a [paginated](#pagination) list of labels. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 1000)

    • getAllPermissionSchemes

      PermissionSchemes getAllPermissionSchemes(@Nullable @Nullable String expand)
      Get all permission schemes

      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](https://confluence.atlassian.com/x/3YxjL) 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](https://confluence.atlassian.com/x/24dKLg) 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](https://confluence.atlassian.com/x/yodKLg) are listed below. Apps can also define custom permissions. See the [project permission](https://developer.atlassian.com/cloud/jira/platform/modules/project-permission/) and [global permission](https://developer.atlassian.com/cloud/jira/platform/modules/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](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      expand - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: * all Returns all expandable information. * field Returns information about the custom field granted the permission. * group Returns information about the group that is granted the permission. * permissions Returns all permission grants for each permission scheme. * projectRole Returns information about the project role granted the permission. * user Returns information about the user who is granted the permission. (optional)

    • getAllPermissions

      Permissions getAllPermissions()
      Get all permissions

      Returns all permissions, including: * global permissions. * project permissions. * global permissions added by plugins. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

    • getAllProjectAvatars

      ProjectAvatars getAllProjectAvatars(@NotNull @NotNull String projectIdOrKey)
      Get all project avatars

      Returns all project avatars, grouped by system and custom avatars. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectIdOrKey - The ID or (case-sensitive) key of the project. (required)

    • getAllProjectCategories

      List<ProjectCategory> getAllProjectCategories()
      Get all project categories

      Returns all project categories. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

    • getAllProjectRoles

      List<ProjectRole> getAllProjectRoles()
      Get all project roles

      Gets a list of all project roles, complete with project role details and default actors. ### About project roles ### [Project roles](https://support.atlassian.com/jira-cloud-administration/docs/manage-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](#api-rest-api-3-permissionscheme-get), [email notification schemes](#api-rest-api-3-notificationscheme-get), [issue security levels](#api-rest-api-3-issuesecurityschemes-get), [comment visibility](#api-rest-api-3-comment-list-post), 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](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/#Specifying-'default-members'-for-a-project-role) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

    • getAllProjectTypes

      List<ProjectType> getAllProjectTypes()
      Get all project types

      Returns all [project types](https://confluence.atlassian.com/x/Var1Nw), whether or not the instance has a valid license for each type. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

    • getAllProjects

      @Deprecated List<Project> getAllProjects(@Nullable @Nullable String expand, @Nullable @Nullable Integer recent, @Nullable @Nullable List<String> properties)
      Deprecated.
      Get all projects

      Returns all projects visible to the user. Deprecated, use [ Get projects paginated](#api-rest-api-3-project-search-get) that supports search and pagination. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Projects are returned only where the user has *Browse Projects* or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: * description Returns the project description. * issueTypes Returns all issue types associated with the project. * lead Returns information about the project lead. * projectKeys Returns all project keys associated with the project. (optional)
      recent - Returns the user's most recently accessed projects. You may specify the number of results to return up to a maximum of 20. If access is anonymous, then the recently accessed projects are based on the current HTTP session. (optional)
      properties - A list of project properties to return for the project. This parameter accepts a comma-separated list. (optional)

    • getAllScreenTabFields

      List<ScreenableField> getAllScreenTabFields(@NotNull @NotNull Long screenId, @NotNull @NotNull Long tabId, @Nullable @Nullable String projectKey)
      Get all screen tab fields

      Returns all fields for a screen tab. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme. Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      screenId - The ID of the screen. (required)
      tabId - The ID of the screen tab. (required)
      projectKey - The key of the project. (optional)

    • getAllScreenTabs

      List<ScreenableTab> getAllScreenTabs(@NotNull @NotNull Long screenId, @Nullable @Nullable String projectKey)
      Get all screen tabs

      Returns the list of tabs for a screen. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme. Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      screenId - The ID of the screen. (required)
      projectKey - The key of the project. (optional)

    • getAllStatuses

      List<IssueTypeWithStatus> getAllStatuses(@NotNull @NotNull String projectIdOrKey)
      Get all statuses for project

      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](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)

    • getAllSystemAvatars

      SystemAvatars getAllSystemAvatars(@NotNull @NotNull String type)
      Get system avatars by type

      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](#permissions) required:** None. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      type - The avatar type. (required)

    • getAllUsers

      List<User> getAllUsers(@Nullable @Nullable Integer startAt, @Nullable @Nullable Integer maxResults)
      Get all users

      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](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [read:jira-user]

      Parameters:
      startAt - The index of the first item to return. (optional, defaults to 0)
      maxResults - The maximum number of items to return. (optional, defaults to 50)

    • getAllUsersDefault

      List<User> getAllUsersDefault(@Nullable @Nullable Integer startAt, @Nullable @Nullable Integer maxResults)
      Get all users default

      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](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [read:jira-user]

      Parameters:
      startAt - The index of the first item to return. (optional, defaults to 0)
      maxResults - The maximum number of items to return. (optional, defaults to 50)

    • getAllWorkflowSchemes

      PageBeanWorkflowScheme getAllWorkflowSchemes(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Get all workflow schemes

      Returns a [paginated](#pagination) list of all workflow schemes, not including draft workflow schemes. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)

    • getAllWorkflows

      @Deprecated List<DeprecatedWorkflow> getAllWorkflows(@Nullable @Nullable String workflowName)
      Deprecated.
      Get all workflows

      Returns all workflows in Jira or a workflow. Deprecated, use [Get workflows paginated](#api-rest-api-3-workflow-search-get). 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      workflowName - The name of the workflow to be returned. Only one workflow can be specified. (optional)

    • getAlternativeIssueTypes

      List<IssueTypeDetails> getAlternativeIssueTypes(@NotNull @NotNull String id)
      Get alternative issue types

      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](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the issue type. (required)

    • getApplicationProperty

      List<ApplicationProperty> getApplicationProperty(@Nullable @Nullable String key, @Nullable @Nullable String permissionLevel, @Nullable @Nullable String keyFilter)
      Get application property

      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](#api-rest-api-3-application-properties-id-put) for descriptions of editable properties. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      key - The key of the application property. (optional)
      permissionLevel - The permission level of all items being returned in the list. (optional)
      keyFilter - When a key isn't provided, this filters the list of results by the application property key using a regular expression. For example, using jira.lf.* will return all application properties with keys that start with *jira.lf.*. (optional)

    • getApplicationRole

      ApplicationRole getApplicationRole(@NotNull @NotNull String key)
      Get application role

      Returns an application role. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

      Parameters:
      key - The key of the application role. Use the [Get all application roles](#api-rest-api-3-applicationrole-get) operation to get the key for each application role. (required)

    • getApproximateApplicationLicenseCount

      LicenseMetric getApproximateApplicationLicenseCount(@NotNull @NotNull String applicationKey)
      Get approximate application license count

      Returns the total approximate number of user accounts for a single Jira license. Note that this information is cached with a 7-day lifecycle and could be stale at the time of call. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      applicationKey - The ID of the application, represents a specific version of Jira. (required)

    • getApproximateLicenseCount

      LicenseMetric getApproximateLicenseCount()
      Get approximate license count

      Returns the approximate number of user accounts across all Jira licenses. Note that this information is cached with a 7-day lifecycle and could be stale at the time of call. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

    • getAssignedPermissionScheme

      PermissionScheme getAssignedPermissionScheme(@NotNull @NotNull String projectKeyOrId, @Nullable @Nullable String expand)
      Get assigned permission scheme

      Gets the [permission scheme](https://confluence.atlassian.com/x/yodKLg) associated with the project. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg). Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectKeyOrId - The project ID or project key (case sensitive). (required)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: * all Returns all expandable information. * field Returns information about the custom field granted the permission. * group Returns information about the group that is granted the permission. * permissions Returns all permission grants for each permission scheme. * projectRole Returns information about the project role granted the permission. * user Returns information about the user who is granted the permission. (optional)

    • getAttachment

      AttachmentMetadata getAttachment(@NotNull @NotNull String id)
      Get attachment metadata

      Returns the metadata for an attachment. Note that the attachment itself is not returned. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the attachment. (required)

    • getAttachmentContent

      Object getAttachmentContent(@NotNull @NotNull String id, @Nullable @Nullable Boolean redirect)
      Get attachment content

      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](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range) for details. To return a thumbnail of the attachment, use [Get attachment thumbnail](#api-rest-api-3-attachment-thumbnail-id-get). This operation can be accessed anonymously. **[Permissions](#permissions) required:** For the issue containing the attachment: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the attachment. (required)
      redirect - Whether a redirect is provided for the attachment download. Clients that do not automatically follow redirects can set this to false to avoid making multiple requests to download the attachment. (optional, defaults to true)

    • getAttachmentMeta

      AttachmentSettings getAttachmentMeta()
      Get Jira attachment settings

      Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed. Note that there are also [project permissions](https://confluence.atlassian.com/x/yodKLg) that restrict whether users can create and delete attachments. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

    • getAttachmentThumbnail

      Object getAttachmentThumbnail(@NotNull @NotNull String id, @Nullable @Nullable Boolean redirect, @Nullable @Nullable Boolean fallbackToDefault, @Nullable @Nullable Integer width, @Nullable @Nullable Integer height)
      Get attachment thumbnail

      Returns the thumbnail of an attachment. To return the attachment contents, use [Get attachment content](#api-rest-api-3-attachment-content-id-get). This operation can be accessed anonymously. **[Permissions](#permissions) required:** For the issue containing the attachment: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the attachment. (required)
      redirect - Whether a redirect is provided for the attachment download. Clients that do not automatically follow redirects can set this to false to avoid making multiple requests to download the attachment. (optional, defaults to true)
      fallbackToDefault - Whether a default thumbnail is returned when the requested thumbnail is not found. (optional, defaults to true)
      width - The maximum width to scale the thumbnail to. (optional)
      height - The maximum height to scale the thumbnail to. (optional)

    • getAuditRecords

      AuditRecords getAuditRecords(@Nullable @Nullable Integer offset, @Nullable @Nullable Integer limit, @Nullable @Nullable String filter, @Nullable @Nullable String from, @Nullable @Nullable String to)
      Get audit records

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      offset - The number of records to skip before returning the first result. (optional, defaults to 0)
      limit - The maximum number of results to return. (optional, defaults to 1000)
      filter - The strings to match with audit field content, space separated. (optional)
      from - The date and time on or after which returned audit records must have been created. If to is provided from must be before to or no audit records are returned. (optional)
      to - The date and time on or before which returned audit results must have been created. If from is provided to must be after from or no audit records are returned. (optional)

    • getAutoComplete

      JQLReferenceData getAutoComplete()
      Get field reference data (GET)

      Returns reference data for JQL searches. This is a downloadable version of the documentation provided in [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ) and [Advanced searching - functions reference](https://confluence.atlassian.com/x/hgORLQ), 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)](#api-rest-api-3-jql-autocompletedata-post) can be used. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

    • getAutoCompletePost

      JQLReferenceData getAutoCompletePost(@NotNull @NotNull SearchAutoCompleteFilter searchAutoCompleteFilter)
      Get field reference data (POST)

      Returns reference data for JQL searches. This is a downloadable version of the documentation provided in [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ) and [Advanced searching - functions reference](https://confluence.atlassian.com/x/hgORLQ), 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](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      searchAutoCompleteFilter - (required)

    • getAvailableScreenFields

      List<ScreenableField> getAvailableScreenFields(@NotNull @NotNull Long screenId)
      Get available screen fields

      Returns the fields that can be added to a tab on a screen. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      screenId - The ID of the screen. (required)

    • getAvailableTimeTrackingImplementations

      List<TimeTrackingProvider> getAvailableTimeTrackingImplementations()
      Get all time tracking providers

      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](https://developer.atlassian.com/cloud/jira/platform/modules/time-tracking-provider/) module. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

    • getAvatarImageByID

      void getAvatarImageByID(@NotNull @NotNull String type, @NotNull @NotNull Long id, @Nullable @Nullable String size, @Nullable @Nullable String format)
      Get avatar image by ID

      Returns a project or issue type avatar image by ID. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * For system avatars, none. * For custom project avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project the avatar belongs to. * For custom issue type avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for at least one project the issue type is used in. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      type - The icon type of the avatar. (required)
      id - The ID of the avatar. (required)
      size - The size of the avatar image. If not provided the default size is returned. (optional)
      format - The format to return the avatar image in. If not provided the original content format is returned. (optional)

    • getAvatarImageByOwner

      void getAvatarImageByOwner(@NotNull @NotNull String type, @NotNull @NotNull String entityId, @Nullable @Nullable String size, @Nullable @Nullable String format)
      Get avatar image by owner

      Returns the avatar image for a project or issue type. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * For system avatars, none. * For custom project avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project the avatar belongs to. * For custom issue type avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for at least one project the issue type is used in. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      type - The icon type of the avatar. (required)
      entityId - The ID of the project or issue type the avatar belongs to. (required)
      size - The size of the avatar image. If not provided the default size is returned. (optional)
      format - The format to return the avatar image in. If not provided the original content format is returned. (optional)

    • getAvatarImageByType

      void getAvatarImageByType(@NotNull @NotNull String type, @Nullable @Nullable String size, @Nullable @Nullable String format)
      Get avatar image by type

      Returns the default project or issue type avatar image. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      type - The icon type of the avatar. (required)
      size - The size of the avatar image. If not provided the default size is returned. (optional)
      format - The format to return the avatar image in. If not provided the original content format is returned. (optional)

    • getAvatars

      Avatars getAvatars(@NotNull @NotNull String type, @NotNull @NotNull String entityId)
      Get avatars

      Returns the system and custom avatars for a project or issue type. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * for custom project avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project the avatar belongs to. * for custom issue type avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for at least one project the issue type is used in. * for system avatars, none. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      type - The avatar type. (required)
      entityId - The ID of the item the avatar is associated with. (required)

    • getBanner

      AnnouncementBannerConfiguration getBanner()
      Get announcement banner configuration

      Returns the current announcement banner configuration. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

    • getBulkPermissions

      BulkPermissionGrants getBulkPermissions(@NotNull @NotNull BulkPermissionsRequestBean bulkPermissionsRequestBean)
      Get bulk permissions

      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. **Deprecation notice:** The required OAuth 2.0 scopes will be updated on June 15, 2024. * **Classic**: read:jira-work * **Granular**: read:permission:jira This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) 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.

      Parameters:
      bulkPermissionsRequestBean - Details of the permissions to check. (required)

    • getBulkScreenTabs

      void getBulkScreenTabs(@Nullable @Nullable Set<Long> screenId, @Nullable @Nullable Set<Long> tabId, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResult)
      Get bulk screen tabs

      Returns the list of tabs for a bulk of screens. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      screenId - The list of screen IDs. To include multiple screen IDs, provide an ampersand-separated list. For example, screenId=10000&amp;screenId=10001. (optional)
      tabId - The list of tab IDs. To include multiple tab IDs, provide an ampersand-separated list. For example, tabId=10000&amp;tabId=10001. (optional)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResult - The maximum number of items to return per page. The maximum number is 100, (optional, defaults to 100)

    • getChangeLogs

      PageBeanChangelog getChangeLogs(@NotNull @NotNull String issueIdOrKey, @Nullable @Nullable Integer startAt, @Nullable @Nullable Integer maxResults)
      Get changelogs

      Returns a [paginated](#pagination) list of all changelogs for an issue sorted by date, starting from the oldest. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 100)

    • getChangeLogsByIds

      PageOfChangelogs getChangeLogsByIds(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull IssueChangelogIds issueChangelogIds)
      Get changelogs by IDs

      Returns changelogs for an issue specified by a list of changelog IDs. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      issueChangelogIds - (required)

    • getColumns

      List<ColumnItem> getColumns(@NotNull @NotNull Long id)
      Get columns

      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](#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](https://confluence.atlassian.com/x/yodKLg) for. * filters shared with a public project. * filters shared with the public. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the filter. (required)

    • getComment

      Comment getComment(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String id, @Nullable @Nullable String expand)
      Get comment

      Returns a comment. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      id - The ID of the comment. (required)
      expand - Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML. (optional)

    • getCommentProperty

      EntityProperty getCommentProperty(@NotNull @NotNull String commentId, @NotNull @NotNull String propertyKey)
      Get comment property

      Returns the value of a comment property. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      commentId - The ID of the comment. (required)
      propertyKey - The key of the property. (required)

    • getCommentPropertyKeys

      PropertyKeys getCommentPropertyKeys(@NotNull @NotNull String commentId)
      Get comment property keys

      Returns the keys of all the properties of a comment. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      commentId - The ID of the comment. (required)

    • getComments

      PageOfComments getComments(@NotNull @NotNull String issueIdOrKey, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable String orderBy, @Nullable @Nullable String expand)
      Get comments

      Returns all comments for an issue. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Comments are included in the response where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 5000)
      orderBy - [Order](#ordering) the results by a field. Accepts *created* to sort comments by their created date. (optional)
      expand - Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML. (optional)

    • getCommentsByIds

      PageBeanComment getCommentsByIds(@NotNull @NotNull IssueCommentListRequestBean issueCommentListRequestBean, @Nullable @Nullable String expand)
      Get comments by IDs

      Returns a [paginated](#pagination) list of comments specified by a list of comment IDs. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Comments are returned where the user: * has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueCommentListRequestBean - The list of comment IDs. (required)
      expand - Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts a comma-separated list. Expand options include: * renderedBody Returns the comment body rendered in HTML. * properties Returns the comment's properties. (optional)

    • getComponent

      ProjectComponent getComponent(@NotNull @NotNull String id)
      Get component

      Returns a component. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for project containing the component. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the component. (required)

    • getComponentRelatedIssues

      ComponentIssuesCount getComponentRelatedIssues(@NotNull @NotNull String id)
      Get component issues count

      Returns the counts of issues assigned to the component. This operation can be accessed anonymously. **Deprecation notice:** The required OAuth 2.0 scopes will be updated on June 15, 2024. * **Classic**: read:jira-work * **Granular**: read:field:jira, read:project.component:jira **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the component. (required)

    • getConfiguration

      Configuration getConfiguration()
      Get global settings

      Returns the [global settings](https://confluence.atlassian.com/x/qYXKM) 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](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-user]

    • getContextsForField

      PageBeanCustomFieldContext getContextsForField(@NotNull @NotNull String fieldId, @Nullable @Nullable Boolean isAnyIssueType, @Nullable @Nullable Boolean isGlobalContext, @Nullable @Nullable Set<Long> contextId, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Get custom field contexts

      Returns a [paginated](#pagination) list of [ contexts](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field. (required)
      isAnyIssueType - Whether to return contexts that apply to all issue types. (optional)
      isGlobalContext - Whether to return contexts that apply to all projects. (optional)
      contextId - The list of context IDs. To include multiple contexts, separate IDs with ampersand: contextId=10000&amp;contextId=10001. (optional)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)

    • getContextsForFieldDeprecated

      @Deprecated PageBeanContext getContextsForFieldDeprecated(@NotNull @NotNull String fieldId, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Deprecated.
      Get contexts for a field

      Returns a [paginated](#pagination) list of the contexts a field is used in. Deprecated, use [ Get custom field contexts](#api-rest-api-3-field-fieldId-context-get). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      fieldId - The ID of the field to return contexts for. (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 20)

    • getCreateIssueMeta

      @Deprecated IssueCreateMetadata getCreateIssueMeta(@Nullable @Nullable List<String> projectIds, @Nullable @Nullable List<String> projectKeys, @Nullable @Nullable List<String> issuetypeIds, @Nullable @Nullable List<String> issuetypeNames, @Nullable @Nullable String expand)
      Deprecated.
      Get create issue metadata

      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](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post). 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](#permissions) required:** *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) in the requested projects. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectIds - List of project IDs. This parameter accepts a comma-separated list. Multiple project IDs can also be provided using an ampersand-separated list. For example, projectIds=10000,10001&amp;projectIds=10020,10021. This parameter may be provided with projectKeys. (optional)
      projectKeys - List of project keys. This parameter accepts a comma-separated list. Multiple project keys can also be provided using an ampersand-separated list. For example, projectKeys=proj1,proj2&amp;projectKeys=proj3. This parameter may be provided with projectIds. (optional)
      issuetypeIds - List of issue type IDs. This parameter accepts a comma-separated list. Multiple issue type IDs can also be provided using an ampersand-separated list. For example, issuetypeIds=10000,10001&amp;issuetypeIds=10020,10021. This parameter may be provided with issuetypeNames. (optional)
      issuetypeNames - List of issue type names. This parameter accepts a comma-separated list. Multiple issue type names can also be provided using an ampersand-separated list. For example, issuetypeNames=name1,name2&amp;issuetypeNames=name3. This parameter may be provided with issuetypeIds. (optional)
      expand - Use [expand](#expansion) to include additional information about issue metadata in the response. This parameter accepts projects.issuetypes.fields, which returns information about the fields in the issue creation screen for each issue type. Fields hidden from the screen are not returned. Use the information to populate the fields and update fields in [Create issue](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post). (optional)

    • getCreateIssueMetaIssueTypeId

      PageOfCreateMetaIssueTypeWithField getCreateIssueMetaIssueTypeId(@NotNull @NotNull String projectIdOrKey, @NotNull @NotNull String issueTypeId, @Nullable @Nullable Integer startAt, @Nullable @Nullable Integer maxResults)
      Get create field metadata for a project and issue type id

      Returns a page of field metadata for a specified project and issuetype id. Use the information to populate the requests in [ Create issue](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post). This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) in the requested projects. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectIdOrKey - The ID or key of the project. (required)
      issueTypeId - The issuetype ID. (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)

    • getCreateIssueMetaIssueTypes

      PageOfCreateMetaIssueTypes getCreateIssueMetaIssueTypes(@NotNull @NotNull String projectIdOrKey, @Nullable @Nullable Integer startAt, @Nullable @Nullable Integer maxResults)
      Get create metadata issue types for a project

      Returns a page of issue type metadata for a specified project. Use the information to populate the requests in [ Create issue](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post). This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) in the requested projects. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectIdOrKey - The ID or key of the project. (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)

    • getCurrentUser

      User getCurrentUser(@Nullable @Nullable String expand)
      Get current user

      Returns details for the current user. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-user]

      Parameters:
      expand - Use [expand](#expansion) to include additional information about user in the response. This parameter accepts a comma-separated list. Expand options include: * groups Returns all groups, including nested groups, the user belongs to. * applicationRoles Returns the application roles the user is assigned to. (optional)

    • getCustomFieldConfiguration

      PageBeanContextualConfiguration getCustomFieldConfiguration(@NotNull @NotNull String fieldIdOrKey, @Nullable @Nullable Set<Long> id, @Nullable @Nullable Set<Long> fieldContextId, @Nullable @Nullable Long issueId, @Nullable @Nullable String projectKeyOrId, @Nullable @Nullable String issueTypeId, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Get custom field configurations

      Returns a [paginated](#pagination) list of configurations for a custom field of a [type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/) created by a [Forge app](https://developer.atlassian.com/platform/forge/). The result can be filtered by one of these criteria: * id. * fieldContextId. * issueId. * projectKeyOrId and issueTypeId. Otherwise, all configurations are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the Forge app that provided the custom field type. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldIdOrKey - The ID or key of the custom field, for example customfield_10000. (required)
      id - The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: id=10000&amp;id=10001. Can't be provided with fieldContextId, issueId, projectKeyOrId, or issueTypeId. (optional)
      fieldContextId - The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: fieldContextId=10000&amp;fieldContextId=10001. Can't be provided with id, issueId, projectKeyOrId, or issueTypeId. (optional)
      issueId - The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with projectKeyOrId, or issueTypeId. (optional)
      projectKeyOrId - The ID or key of the project to filter results by. Must be provided with issueTypeId. Can't be provided with issueId. (optional)
      issueTypeId - The ID of the issue type to filter results by. Must be provided with projectKeyOrId. Can't be provided with issueId. (optional)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 100)

    • getCustomFieldContextsForProjectsAndIssueTypes

      PageBeanContextForProjectAndIssueType getCustomFieldContextsForProjectsAndIssueTypes(@NotNull @NotNull String fieldId, @NotNull @NotNull ProjectIssueTypeMappings projectIssueTypeMappings, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Get custom field contexts for projects and issue types

      Returns a [paginated](#pagination) list of project and issue type mappings and, for each mapping, the ID of a [custom field context](https://confluence.atlassian.com/x/k44fOw) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field. (required)
      projectIssueTypeMappings - The list of project and issue type mappings. (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)

    • getCustomFieldOption

      CustomFieldOption getCustomFieldOption(@NotNull @NotNull String id)
      Get custom field option

      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](#api-group-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](#permissions) required:** The custom field option is returned as follows: * if the user has the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * if the user has the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) 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. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the custom field option. (required)

    • getDashboard

      Dashboard getDashboard(@NotNull @NotNull String id)
      Get dashboard

      Returns a dashboard. This operation can be accessed anonymously. **[Permissions](#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](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the dashboard. (required)

    • getDashboardItemProperty

      EntityProperty getDashboardItemProperty(@NotNull @NotNull String dashboardId, @NotNull @NotNull String itemId, @NotNull @NotNull String propertyKey)
      Get dashboard item property

      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](https://confluence.atlassian.com/x/7AeiLQ). 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](https://developer.atlassian.com/server/jira/platform/guide-building-a-dashboard-item-for-a-jira-connect-add-on-33746254/) and the [Dashboard Item](https://developer.atlassian.com/cloud/jira/platform/modules/dashboard-item/) documentation. There is no resource to set or get dashboard items. This operation can be accessed anonymously. **[Permissions](#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](https://confluence.atlassian.com/x/x4dKLg) 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\\\\u2019s anonymous access is permitted. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      dashboardId - The ID of the dashboard. (required)
      itemId - The ID of the dashboard item. (required)
      propertyKey - The key of the dashboard item property. (required)

    • getDashboardItemPropertyKeys

      PropertyKeys getDashboardItemPropertyKeys(@NotNull @NotNull String dashboardId, @NotNull @NotNull String itemId)
      Get dashboard item property keys

      Returns the keys of all properties for a dashboard item. This operation can be accessed anonymously. **[Permissions](#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](https://confluence.atlassian.com/x/x4dKLg) 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\\\\u2019s anonymous access is permitted. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      dashboardId - The ID of the dashboard. (required)
      itemId - The ID of the dashboard item. (required)

    • getDashboardsPaginated

      PageBeanDashboard getDashboardsPaginated(@Nullable @Nullable String dashboardName, @Nullable @Nullable String accountId, @Nullable @Nullable String owner, @Nullable @Nullable String groupname, @Nullable @Nullable String groupId, @Nullable @Nullable Long projectId, @Nullable @Nullable String orderBy, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable String status, @Nullable @Nullable String expand)
      Search for dashboards

      Returns a [paginated](#pagination) list of dashboards. This operation is similar to [Get dashboards](#api-rest-api-3-dashboard-get) 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](#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. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      dashboardName - String used to perform a case-insensitive partial match with name. (optional)
      accountId - User account ID used to return dashboards with the matching owner.accountId. This parameter cannot be used with the owner parameter. (optional)
      owner - This parameter is deprecated because of privacy changes. Use accountId instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return dashboards with the matching owner.name. This parameter cannot be used with the accountId parameter. (optional)
      groupname - As a group's name can change, use of groupId is recommended. Group name used to return dashboards that are shared with a group that matches sharePermissions.group.name. This parameter cannot be used with the groupId parameter. (optional)
      groupId - Group ID used to return dashboards that are shared with a group that matches sharePermissions.group.groupId. This parameter cannot be used with the groupname parameter. (optional)
      projectId - Project ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id. (optional)
      orderBy - [Order](#ordering) the results by a field: * description Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use. * favourite_count Sorts by dashboard popularity. * id Sorts by dashboard ID. * is_favourite Sorts by whether the dashboard is marked as a favorite. * name Sorts by dashboard name. * owner Sorts by dashboard owner name. (optional, defaults to name)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      status - The status to filter by. It may be active, archived or deleted. (optional, defaults to active)
      expand - Use [expand](#expansion) to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include: * description Returns the description of the dashboard. * owner Returns the owner of the dashboard. * viewUrl Returns the URL that is used to view the dashboard. * favourite Returns isFavourite, an indicator of whether the user has set the dashboard as a favorite. * favouritedCount Returns popularity, a count of how many users have set this dashboard as a favorite. * sharePermissions Returns details of the share permissions defined for the dashboard. * editPermissions Returns details of the edit permissions defined for the dashboard. * isWritable Returns whether the current user has permission to edit the dashboard. (optional)

    • getDefaultShareScope

      DefaultShareScope getDefaultShareScope()
      Get default share scope

      Returns the default sharing settings for new filters and dashboards for a user. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

    • getDefaultValues

      PageBeanCustomFieldContextDefaultValue getDefaultValues(@NotNull @NotNull String fieldId, @Nullable @Nullable Set<Long> contextId, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Get custom field contexts default values

      Returns a [paginated](#pagination) 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](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/#data-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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field, for example customfield\\_10000. (required)
      contextId - The IDs of the contexts. (optional)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)

    • getDefaultWorkflow

      DefaultWorkflow getDefaultWorkflow(@NotNull @NotNull Long id, @Nullable @Nullable Boolean returnDraftIfExists)
      Get default workflow

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme. (required)
      returnDraftIfExists - Set to true to return the default workflow for the workflow scheme's draft rather than scheme itself. If the workflow scheme does not have a draft, then the default workflow for the workflow scheme is returned. (optional, defaults to false)

    • getDraftDefaultWorkflow

      DefaultWorkflow getDraftDefaultWorkflow(@NotNull @NotNull Long id)
      Get draft default workflow

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme that the draft belongs to. (required)

    • getDraftWorkflow

      IssueTypesWorkflowMapping getDraftWorkflow(@NotNull @NotNull Long id, @Nullable @Nullable String workflowName)
      Get issue types for workflows in draft workflow scheme

      Returns the workflow-issue type mappings for a workflow scheme's draft. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme that the draft belongs to. (required)
      workflowName - The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow. (optional)

    • getDynamicWebhooksForApp

      PageBeanWebhook getDynamicWebhooksForApp(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Get dynamic webhooks for app

      Returns a [paginated](#pagination) list of the webhooks registered by the calling app. **[Permissions](#permissions) required:** Only [Connect](https://developer.atlassian.com/cloud/jira/platform/#connect-apps) and [OAuth 2.0](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps) apps can use this operation. Authentication - Required Scopes: [read:jira-work, manage:jira-webhook]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 100)

    • getEditIssueMeta

      IssueUpdateMetadata getEditIssueMeta(@NotNull @NotNull String issueIdOrKey, @Nullable @Nullable Boolean overrideScreenSecurity, @Nullable @Nullable Boolean overrideEditableFlag)
      Get edit issue metadata

      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](#api-rest-api-3-issue-issueIdOrKey-put). 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](https://support.atlassian.com/jira-cloud-administration/docs/change-a-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](https://support.atlassian.com/jira-cloud-administration/docs/use-workflow-properties/) the jira.issue.editable property to false. overrideEditableFlag=true skips this condition. 8. User has [Edit issues permission](https://support.atlassian.com/jira-cloud-administration/docs/permissions-for-company-managed-projects/). 9. Workflow permissions allow editing a field. This is true by default but [can be modified](https://support.atlassian.com/jira-cloud-administration/docs/use-workflow-properties/) using jira.permission.* workflow properties. Fields hidden using [Issue layout settings page](https://support.atlassian.com/jira-software-cloud/docs/configure-field-layout-in-the-issue-view/) remain editable. Connect apps having an app user with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), 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](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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](https://confluence.atlassian.com/x/yodKLg) for the issue. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      overrideScreenSecurity - Whether hidden fields are returned. Available to Connect app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, defaults to false)
      overrideEditableFlag - Whether non-editable fields are returned. Available to Connect app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, defaults to false)

    • getEvents

      List<IssueEvent> getEvents()
      Get events

      Returns all issue events. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

    • getFailedWebhooks

      FailedWebhooks getFailedWebhooks(@Nullable @Nullable Integer maxResults, @Nullable @Nullable Long after)
      Get failed webhooks

      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](#permissions) required:** Only [Connect apps](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) can use this operation. Authentication - Required Scopes: [read:jira-work, manage:jira-webhook]

      Parameters:
      maxResults - The maximum number of webhooks to return per page. If obeying the maxResults directive would result in records with the same failure time being split across pages, the directive is ignored and all records with the same failure time included on the page. (optional)
      after - The time after which any webhook failure must have occurred for the record to be returned, expressed as milliseconds since the UNIX epoch. (optional)

    • getFavouriteFilters

      List<Filter> getFavouriteFilters(@Nullable @Nullable String expand)
      Get favorite filters

      Returns the visible favorite filters of the user. This operation can be accessed anonymously. **[Permissions](#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](https://confluence.atlassian.com/x/yodKLg) 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. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      expand - Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. * subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000]. (optional)

    • getFeaturesForProject

      ContainerForProjectFeatures getFeaturesForProject(@NotNull @NotNull String projectIdOrKey)
      Get project features

      Returns the list of features for a project. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectIdOrKey - The ID or (case-sensitive) key of the project. (required)

    • getFieldAutoCompleteForQueryString

      AutoCompleteSuggestions getFieldAutoCompleteForQueryString(@Nullable @Nullable String fieldName, @Nullable @Nullable String fieldValue, @Nullable @Nullable String predicateName, @Nullable @Nullable String predicateValue)
      Get field auto complete suggestions

      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](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      fieldName - The name of the field. (optional)
      fieldValue - The partial field item name entered by the user. (optional)
      predicateName - The name of the [ CHANGED operator predicate](https://confluence.atlassian.com/x/hQORLQ#Advancedsearching-operatorsreference-CHANGEDCHANGED) for which the suggestions are generated. The valid predicate operators are *by*, *from*, and *to*. (optional)
      predicateValue - The partial predicate item name entered by the user. (optional)

    • getFieldConfigurationItems

      PageBeanFieldConfigurationItem getFieldConfigurationItems(@NotNull @NotNull Long id, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Get field configuration items

      Returns a [paginated](#pagination) list of all fields for a configuration. Only the fields from configurations used in company-managed (classic) projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the field configuration. (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)

    • getFieldConfigurationSchemeMappings

      PageBeanFieldConfigurationIssueTypeItem getFieldConfigurationSchemeMappings(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Set<Long> fieldConfigurationSchemeId)
      Get field configuration issue type items

      Returns a [paginated](#pagination) list of field configuration issue type items. Only items used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      fieldConfigurationSchemeId - The list of field configuration scheme IDs. To include multiple field configuration schemes separate IDs with ampersand: fieldConfigurationSchemeId=10000&amp;fieldConfigurationSchemeId=10001. (optional)

    • getFieldConfigurationSchemeProjectMapping

      PageBeanFieldConfigurationSchemeProjects getFieldConfigurationSchemeProjectMapping(@NotNull @NotNull Set<Long> projectId, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Get field configuration schemes for projects

      Returns a [paginated](#pagination) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      projectId - The list of project IDs. To include multiple projects, separate IDs with ampersand: projectId=10000&amp;projectId=10001. (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)

    • getFields

      List<FieldDetails> getFields()
      Get fields

      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](https://confluence.atlassian.com/x/yodKLg) for.) This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

    • getFieldsPaginated

      PageBeanField getFieldsPaginated(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable List<String> type, @Nullable @Nullable Set<String> id, @Nullable @Nullable String query, @Nullable @Nullable String orderBy, @Nullable @Nullable String expand)
      Get fields paginated

      Returns a [paginated](#pagination) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [read:jira-work]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      type - The type of fields to search. (optional)
      id - The IDs of the custom fields to return or, where query is specified, filter. (optional)
      query - String used to perform a case-insensitive partial match with field names or descriptions. (optional)
      orderBy - [Order](#ordering) the results by a field: * contextsCount sorts by the number of contexts related to a field * lastUsed sorts by the date when the value of the field last changed * name sorts by the field name * screensCount sorts by the number of screens related to a field (optional)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * key returns the key for each field * lastUsed returns the date when the value of the field last changed * screensCount returns the number of screens related to a field * contextsCount returns the number of contexts related to a field * isLocked returns information about whether the field is [locked](https://confluence.atlassian.com/x/ZSN7Og) * searcherKey returns the searcher key for each custom field (optional)

    • getFilter

      Filter getFilter(@NotNull @NotNull Long id, @Nullable @Nullable String expand, @Nullable @Nullable Boolean overrideSharePermissions)
      Get filter

      Returns a filter. This operation can be accessed anonymously. **[Permissions](#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](https://confluence.atlassian.com/x/yodKLg) for. * shared with a public project. * shared with the public. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the filter to return. (required)
      expand - Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. * subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000]. (optional)
      overrideSharePermissions - EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, defaults to false)

    • getFiltersPaginated

      PageBeanFilterDetails getFiltersPaginated(@Nullable @Nullable String filterName, @Nullable @Nullable String accountId, @Nullable @Nullable String owner, @Nullable @Nullable String groupname, @Nullable @Nullable String groupId, @Nullable @Nullable Long projectId, @Nullable @Nullable Set<Long> id, @Nullable @Nullable String orderBy, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable String expand, @Nullable @Nullable Boolean overrideSharePermissions)
      Search for filters

      Returns a [paginated](#pagination) 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](#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](https://confluence.atlassian.com/x/yodKLg) for. * filters shared with a public project. * filters shared with the public. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      filterName - String used to perform a case-insensitive partial match with name. (optional)
      accountId - User account ID used to return filters with the matching owner.accountId. This parameter cannot be used with owner. (optional)
      owner - This parameter is deprecated because of privacy changes. Use accountId instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return filters with the matching owner.name. This parameter cannot be used with accountId. (optional)
      groupname - As a group's name can change, use of groupId is recommended to identify a group. Group name used to returns filters that are shared with a group that matches sharePermissions.group.groupname. This parameter cannot be used with the groupId parameter. (optional)
      groupId - Group ID used to returns filters that are shared with a group that matches sharePermissions.group.groupId. This parameter cannot be used with the groupname parameter. (optional)
      projectId - Project ID used to returns filters that are shared with a project that matches sharePermissions.project.id. (optional)
      id - The list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&amp;id=10001. Do not exceed 200 filter IDs. (optional)
      orderBy - [Order](#ordering) the results by a field: * description Sorts by filter description. Note that this sorting works independently of whether the expand to display the description field is in use. * favourite_count Sorts by the count of how many users have this filter as a favorite. * is_favourite Sorts by whether the filter is marked as a favorite. * id Sorts by filter ID. * name Sorts by filter name. * owner Sorts by the ID of the filter owner. * is_shared Sorts by whether the filter is shared. (optional, defaults to name)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      expand - Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * description Returns the description of the filter. * favourite Returns an indicator of whether the user has set the filter as a favorite. * favouritedCount Returns a count of how many users have set this filter as a favorite. * jql Returns the JQL query that the filter uses. * owner Returns the owner of the filter. * searchUrl Returns a URL to perform the filter's JQL query. * sharePermissions Returns the share permissions defined for the filter. * editPermissions Returns the edit permissions defined for the filter. * isWritable Returns whether the current user has permission to edit the filter. * subscriptions Returns the users that are subscribed to the filter. * viewUrl Returns a URL to view the filter. (optional)
      overrideSharePermissions - EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, defaults to false)

    • getGroup

      @Deprecated Group getGroup(@Nullable @Nullable String groupname, @Nullable @Nullable String groupId, @Nullable @Nullable String expand)
      Deprecated.
      Get group

      This operation is deprecated, use [group/member](#api-rest-api-3-group-member-get). Returns all users in a group. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [read:jira-user]

      Parameters:
      groupname - As a group's name can change, use of groupId is recommended to identify a group. The name of the group. This parameter cannot be used with the groupId parameter. (optional)
      groupId - The ID of the group. This parameter cannot be used with the groupName parameter. (optional)
      expand - List of fields to expand. (optional)

    • getHierarchy

      @Deprecated ProjectIssueTypeHierarchy getHierarchy(@NotNull @NotNull Long projectId)
      Deprecated.
      Get project issue type hierarchy

      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](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectId - The ID of the project. (required)

    • getIdsOfWorklogsDeletedSince

      ChangedWorklogs getIdsOfWorklogsDeletedSince(@Nullable @Nullable Long since)
      Get IDs of deleted worklogs

      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](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      since - The date and time, as a UNIX timestamp in milliseconds, after which deleted worklogs are returned. (optional, defaults to 0)

    • getIdsOfWorklogsModifiedSince

      ChangedWorklogs getIdsOfWorklogsModifiedSince(@Nullable @Nullable Long since, @Nullable @Nullable String expand)
      Get IDs of updated worklogs

      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](#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. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      since - The date and time, as a UNIX timestamp in milliseconds, after which updated worklogs are returned. (optional, defaults to 0)
      expand - Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts properties that returns the properties of each worklog. (optional)

    • getIsWatchingIssueBulk

      BulkIssueIsWatching getIsWatchingIssueBulk(@NotNull @NotNull IssueList issueList)
      Get is watching issue bulk

      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](https://confluence.atlassian.com/x/uYXKM) for details. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueList - A list of issue IDs. (required)

    • getIssue

      IssueBean getIssue(@NotNull @NotNull String issueIdOrKey, @Nullable @Nullable List<String> fields, @Nullable @Nullable Boolean fieldsByKeys, @Nullable @Nullable String expand, @Nullable @Nullable List<String> properties, @Nullable @Nullable Boolean updateHistory)
      Get issue

      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](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      fields - A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values: * *all Returns all fields. * *navigable Returns navigable fields. * Any issue field, prefixed with a minus to exclude. Examples: * summary,comment Returns only the summary and comments fields. * -description Returns all (default) fields except description. * *navigable,-comment Returns all navigable fields except comment. This parameter may be specified multiple times. For example, fields=field1,field2&amp; fields=field3. Note: All fields are returned by default. This differs from [Search for issues using JQL (GET)](#api-rest-api-3-search-get) and [Search for issues using JQL (POST)](#api-rest-api-3-search-post) where the default is all navigable fields. (optional)
      fieldsByKeys - Whether fields in fields are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID. (optional, defaults to false)
      expand - Use [expand](#expansion) to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include: * renderedFields Returns field values rendered in HTML format. * names Returns the display name of each field. * schema Returns the schema describing a field type. * transitions Returns all possible transitions for the issue. * editmeta Returns information about how each field can be edited. * changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * versionedRepresentations Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the fields parameter is ignored. (optional)
      properties - A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: * *all Returns all issue properties. * Any issue property key, prefixed with a minus to exclude. Examples: * *all Returns all properties. * *all,-prop1 Returns all properties except prop1. * prop1,prop2 Returns prop1 and prop2 properties. This parameter may be specified multiple times. For example, properties=prop1,prop2&amp; properties=prop3. (optional)
      updateHistory - Whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira. This also populates the [JQL issues search](#api-rest-api-3-search-get) lastViewed field. (optional, defaults to false)

    • getIssueAllTypes

      List<IssueTypeDetails> getIssueAllTypes()
      Get all issue types for user

      Returns all issue types. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Issue types are only returned as follows: * if the user has the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), all issue types are returned. * if the user has the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, the issue types associated with the projects the user has permission to browse are returned. Authentication - Required Scopes: [read:jira-work]

    • getIssueFieldOption

      IssueFieldOption getIssueFieldOption(@NotNull @NotNull String fieldKey, @NotNull @NotNull Long optionId)
      Get issue field option

      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](#api-group-Issue-custom-field-options) resource. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldKey - The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the fieldKey value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the jiraIssueFields module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field" (required)
      optionId - The ID of the option to be returned. (required)

    • getIssueLink

      IssueLink getIssueLink(@NotNull @NotNull String linkId)
      Get issue link

      Returns an issue link. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse project* [project permission](https://confluence.atlassian.com/x/yodKLg) for all the projects containing the linked issues. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, permission to view both of the issues. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      linkId - The ID of the issue link. (required)

    • getIssueLinkType

      IssueLinkType getIssueLinkType(@NotNull @NotNull String issueLinkTypeId)
      Get issue link type

      Returns an issue link type. To use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project in the site. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueLinkTypeId - The ID of the issue link type. (required)

    • getIssueLinkTypes

      IssueLinkTypes getIssueLinkTypes()
      Get issue link types

      Returns a list of all issue link types. To use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project in the site. Authentication - Required Scopes: [read:jira-work]

    • getIssueNavigatorDefaultColumns

      List<ColumnItem> getIssueNavigatorDefaultColumns()
      Get issue navigator default columns

      Returns the default issue navigator columns. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

    • getIssuePickerResource

      IssuePickerSuggestions getIssuePickerResource(@Nullable @Nullable String query, @Nullable @Nullable String currentJQL, @Nullable @Nullable String currentIssueKey, @Nullable @Nullable String currentProjectId, @Nullable @Nullable Boolean showSubTasks, @Nullable @Nullable Boolean showSubTaskParent)
      Get issue picker suggestions

      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](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      query - A string to match against text fields in the issue such as title, description, or comments. (optional)
      currentJQL - A JQL query defining a list of issues to search for the query term. Note that username and userkey cannot be used as search terms for this parameter, due to privacy reasons. Use accountId instead. (optional)
      currentIssueKey - The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query. (optional)
      currentProjectId - The ID of a project that suggested issues must belong to. (optional)
      showSubTasks - Indicate whether to include subtasks in the suggestions list. (optional)
      showSubTaskParent - When currentIssueKey is a subtask, whether to include the parent issue in the suggestions if it matches the query. (optional)

    • getIssueProperty

      EntityProperty getIssueProperty(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String propertyKey)
      Get issue property

      Returns the key and value of an issue's property. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueIdOrKey - The key or ID of the issue. (required)
      propertyKey - The key of the property. (required)

    • getIssuePropertyKeys

      PropertyKeys getIssuePropertyKeys(@NotNull @NotNull String issueIdOrKey)
      Get issue property keys

      Returns the URLs and keys of an issue's properties. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Property details are only returned where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueIdOrKey - The key or ID of the issue. (required)

    • getIssueSecurityLevel

      SecurityLevel getIssueSecurityLevel(@NotNull @NotNull String id)
      Get issue security level

      Returns details of an issue security level. Use [Get issue security scheme](#api-rest-api-3-issuesecurityschemes-id-get) to obtain the IDs of issue security levels associated with the issue security scheme. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the issue security level. (required)

    • getIssueSecurityLevelMembers

      PageBeanIssueSecurityLevelMember getIssueSecurityLevelMembers(@NotNull @NotNull Long issueSecuritySchemeId, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Set<String> issueSecurityLevelId, @Nullable @Nullable String expand)
      Get issue security level members

      Returns issue security level members. Only issue security level members in context of classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueSecuritySchemeId - The ID of the issue security scheme. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) operation to get a list of issue security scheme IDs. (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      issueSecurityLevelId - The list of issue security level IDs. To include multiple issue security levels separate IDs with ampersand: issueSecurityLevelId=10000&amp;issueSecurityLevelId=10001. (optional)
      expand - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * all Returns all expandable information. * field Returns information about the custom field granted the permission. * group Returns information about the group that is granted the permission. * projectRole Returns information about the project role granted the permission. * user Returns information about the user who is granted the permission. (optional)

    • getIssueSecurityScheme

      SecurityScheme getIssueSecurityScheme(@NotNull @NotNull Long id)
      Get issue security scheme

      Returns an issue security scheme along with its security levels. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project that uses the requested issue security scheme. Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      id - The ID of the issue security scheme. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) operation to get a list of issue security scheme IDs. (required)

    • getIssueSecuritySchemes

      SecuritySchemes getIssueSecuritySchemes()
      Get issue security schemes

      Returns all [issue security schemes](https://confluence.atlassian.com/x/J4lKLg). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

    • getIssueType

      IssueTypeDetails getIssueType(@NotNull @NotNull String id)
      Get issue type

      Returns an issue type. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) in a project the issue type is associated with or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the issue type. (required)

    • getIssueTypeMappingsForContexts

      PageBeanIssueTypeToContextMapping getIssueTypeMappingsForContexts(@NotNull @NotNull String fieldId, @Nullable @Nullable List<Long> contextId, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Get issue types for custom field context

      Returns a [paginated](#pagination) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field. (required)
      contextId - The ID of the context. To include multiple contexts, provide an ampersand-separated list. For example, contextId=10001&amp;contextId=10002. (optional)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)

    • getIssueTypeProperty

      EntityProperty getIssueTypeProperty(@NotNull @NotNull String issueTypeId, @NotNull @NotNull String propertyKey)
      Get issue type property

      Returns the key and value of the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties). This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) to get the details of any issue type. * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) to get the details of any issue types associated with the projects the user has permission to browse. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueTypeId - The ID of the issue type. (required)
      propertyKey - The key of the property. Use [Get issue type property keys](#api-rest-api-3-issuetype-issueTypeId-properties-get) to get a list of all issue type property keys. (required)

    • getIssueTypePropertyKeys

      PropertyKeys getIssueTypePropertyKeys(@NotNull @NotNull String issueTypeId)
      Get issue type property keys

      Returns all the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties) keys of the issue type. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) to get the property keys of any issue type. * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) to get the property keys of any issue types associated with the projects the user has permission to browse. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueTypeId - The ID of the issue type. (required)

    • getIssueTypeSchemeForProjects

      PageBeanIssueTypeSchemeProjects getIssueTypeSchemeForProjects(@NotNull @NotNull Set<Long> projectId, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Get issue type schemes for projects

      Returns a [paginated](#pagination) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      projectId - The list of project IDs. To include multiple project IDs, provide an ampersand-separated list. For example, projectId=10000&amp;projectId=10001. (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)

    • getIssueTypeSchemesMapping

      PageBeanIssueTypeSchemeMapping getIssueTypeSchemesMapping(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Set<Long> issueTypeSchemeId)
      Get issue type scheme items

      Returns a [paginated](#pagination) list of issue type scheme items. Only issue type scheme items used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      issueTypeSchemeId - The list of issue type scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, issueTypeSchemeId=10000&amp;issueTypeSchemeId=10001. (optional)

    • getIssueTypeScreenSchemeMappings

      PageBeanIssueTypeScreenSchemeItem getIssueTypeScreenSchemeMappings(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Set<Long> issueTypeScreenSchemeId)
      Get issue type screen scheme items

      Returns a [paginated](#pagination) list of issue type screen scheme items. Only issue type screen schemes used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      issueTypeScreenSchemeId - The list of issue type screen scheme IDs. To include multiple issue type screen schemes, separate IDs with ampersand: issueTypeScreenSchemeId=10000&amp;issueTypeScreenSchemeId=10001. (optional)

    • getIssueTypeScreenSchemeProjectAssociations

      PageBeanIssueTypeScreenSchemesProjects getIssueTypeScreenSchemeProjectAssociations(@NotNull @NotNull Set<Long> projectId, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Get issue type screen schemes for projects

      Returns a [paginated](#pagination) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      projectId - The list of project IDs. To include multiple projects, separate IDs with ampersand: projectId=10000&amp;projectId=10001. (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)

    • getIssueTypeScreenSchemes

      PageBeanIssueTypeScreenScheme getIssueTypeScreenSchemes(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Set<Long> id, @Nullable @Nullable String queryString, @Nullable @Nullable String orderBy, @Nullable @Nullable String expand)
      Get issue type screen schemes

      Returns a [paginated](#pagination) list of issue type screen schemes. Only issue type screen schemes used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      id - The list of issue type screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&amp;id=10001. (optional)
      queryString - String used to perform a case-insensitive partial match with issue type screen scheme name. (optional)
      orderBy - [Order](#ordering) the results by a field: * name Sorts by issue type screen scheme name. * id Sorts by issue type screen scheme ID. (optional, defaults to id)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts projects that, for each issue type screen schemes, returns information about the projects the issue type screen scheme is assigned to. (optional)

    • getIssueTypesForProject

      List<IssueTypeDetails> getIssueTypesForProject(@NotNull @NotNull Long projectId, @Nullable @Nullable Integer level)
      Get issue types for project

      Returns issue types for a project. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) in the relevant project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectId - The ID of the project. (required)
      level - The level of the issue type to filter by. Use: * -1 for Subtask. * 0 for Base. * 1 for Epic. (optional)

    • getIssueWatchers

      Watchers getIssueWatchers(@NotNull @NotNull String issueIdOrKey)
      Get issue watchers

      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](https://confluence.atlassian.com/x/uYXKM) for details. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is ini * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)

    • getIssueWorklog

      PageOfWorklogs getIssueWorklog(@NotNull @NotNull String issueIdOrKey, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Long startedAfter, @Nullable @Nullable Long startedBefore, @Nullable @Nullable String expand)
      Get issue worklogs

      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](https://confluence.atlassian.com/x/qoXKM). This operation can be accessed anonymously. **[Permissions](#permissions) required:** Workloads are only returned where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 5000)
      startedAfter - The worklog start date and time, as a UNIX timestamp in milliseconds, after which worklogs are returned. (optional)
      startedBefore - The worklog start date and time, as a UNIX timestamp in milliseconds, before which worklogs are returned. (optional)
      expand - Use [expand](#expansion) to include additional information about worklogs in the response. This parameter acceptsproperties, which returns worklog properties. (optional)

    • getLicense

      License getLicense()
      Get license

      Returns licensing information about the Jira instance. **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [manage:jira-configuration]

    • getLocale

      Locale getLocale()
      Get locale

      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](#permissions) required:** None. Authentication - Required Scopes: [manage:jira-configuration]

    • getMyFilters

      List<Filter> getMyFilters(@Nullable @Nullable String expand, @Nullable @Nullable Boolean includeFavourites)
      Get my filters

      Returns the filters owned by the user. If includeFavourites is true, the user's visible favorite filters are also returned. **[Permissions](#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](https://confluence.atlassian.com/x/yodKLg) 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. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      expand - Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. * subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000]. (optional)
      includeFavourites - Include the user's favorite filters in the response. (optional, defaults to false)

    • getMyPermissions

      Permissions getMyPermissions(@Nullable @Nullable String projectKey, @Nullable @Nullable String projectId, @Nullable @Nullable String issueKey, @Nullable @Nullable String issueId, @Nullable @Nullable String permissions, @Nullable @Nullable String projectUuid, @Nullable @Nullable String projectConfigurationUuid, @Nullable @Nullable String commentId)
      Get my permissions

      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. **Deprecation notice:** The required OAuth 2.0 scopes will be updated on February 15, 2024. * **Classic**: read:jira-work * **Granular**: read:permission:jira This operation can be accessed anonymously. **[Permissions](#permissions) required:** None.

      Parameters:
      projectKey - The key of project. Ignored if projectId is provided. (optional)
      projectId - The ID of project. (optional)
      issueKey - The key of the issue. Ignored if issueId is provided. (optional)
      issueId - The ID of the issue. (optional)
      permissions - A list of permission keys. (Required) This parameter accepts a comma-separated list. To get the list of available permissions, use [Get all permissions](#api-rest-api-3-permissions-get). (optional)
      projectUuid - (optional)
      projectConfigurationUuid - (optional)
      commentId - The ID of the comment. (optional)

    • getNotificationScheme

      NotificationScheme getNotificationScheme(@NotNull @NotNull Long id, @Nullable @Nullable String expand)
      Get notification scheme

      Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events. **[Permissions](#permissions) required:** Permission to access Jira, however, the user must have permission to administer at least one project associated with the notification scheme. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the notification scheme. Use [Get notification schemes paginated](#api-rest-api-3-notificationscheme-get) to get a list of notification scheme IDs. (required)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * all Returns all expandable information * field Returns information about any custom fields assigned to receive an event * group Returns information about any groups assigned to receive an event * notificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information * projectRole Returns information about any project roles assigned to receive an event * user Returns information about any users assigned to receive an event (optional)

    • getNotificationSchemeForProject

      NotificationScheme getNotificationSchemeForProject(@NotNull @NotNull String projectKeyOrId, @Nullable @Nullable String expand)
      Get project notification scheme

      Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg) associated with the project. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg). Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectKeyOrId - The project ID or project key (case sensitive). (required)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * all Returns all expandable information * field Returns information about any custom fields assigned to receive an event * group Returns information about any groups assigned to receive an event * notificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information * projectRole Returns information about any project roles assigned to receive an event * user Returns information about any users assigned to receive an event (optional)

    • getNotificationSchemeToProjectMappings

      PageBeanNotificationSchemeAndProjectMappingJsonBean getNotificationSchemeToProjectMappings(@Nullable @Nullable String startAt, @Nullable @Nullable String maxResults, @Nullable @Nullable Set<String> notificationSchemeId, @Nullable @Nullable Set<String> projectId)
      Get projects using notification schemes paginated

      Returns a [paginated](#pagination) 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](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      notificationSchemeId - The list of notifications scheme IDs to be filtered out (optional)
      projectId - The list of project IDs to be filtered out (optional)

    • getNotificationSchemes

      PageBeanNotificationScheme getNotificationSchemes(@Nullable @Nullable String startAt, @Nullable @Nullable String maxResults, @Nullable @Nullable Set<String> id, @Nullable @Nullable Set<String> projectId, @Nullable @Nullable Boolean onlyDefault, @Nullable @Nullable String expand)
      Get notification schemes paginated

      Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) ordered by the display name. *Note that you should allow for events without recipients to appear in responses.* **[Permissions](#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. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      id - The list of notification schemes IDs to be filtered by (optional)
      projectId - The list of projects IDs to be filtered by (optional)
      onlyDefault - When set to true, returns only the default notification scheme. If you provide project IDs not associated with the default, returns an empty page. The default value is false. (optional, defaults to false)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * all Returns all expandable information * field Returns information about any custom fields assigned to receive an event * group Returns information about any groups assigned to receive an event * notificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information * projectRole Returns information about any project roles assigned to receive an event * user Returns information about any users assigned to receive an event (optional)

    • getOptionsForContext

      PageBeanCustomFieldContextOption getOptionsForContext(@NotNull @NotNull String fieldId, @NotNull @NotNull Long contextId, @Nullable @Nullable Long optionId, @Nullable @Nullable Boolean onlyOptions, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Get custom field options (context)

      Returns a [paginated](#pagination) 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)](#api-group-issue-custom-field-options--apps-) operations.** **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field. (required)
      contextId - The ID of the context. (required)
      optionId - The ID of the option. (optional)
      onlyOptions - Whether only options are returned. (optional, defaults to false)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 100)

    • getPermissionScheme

      PermissionScheme getPermissionScheme(@NotNull @NotNull Long schemeId, @Nullable @Nullable String expand)
      Get permission scheme

      Returns a permission scheme. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      schemeId - The ID of the permission scheme to return. (required)
      expand - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: * all Returns all expandable information. * field Returns information about the custom field granted the permission. * group Returns information about the group that is granted the permission. * permissions Returns all permission grants for each permission scheme. * projectRole Returns information about the project role granted the permission. * user Returns information about the user who is granted the permission. (optional)

    • getPermissionSchemeGrant

      PermissionGrant getPermissionSchemeGrant(@NotNull @NotNull Long schemeId, @NotNull @NotNull Long permissionId, @Nullable @Nullable String expand)
      Get permission scheme grant

      Returns a permission grant. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      schemeId - The ID of the permission scheme. (required)
      permissionId - The ID of the permission grant. (required)
      expand - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: * all Returns all expandable information. * field Returns information about the custom field granted the permission. * group Returns information about the group that is granted the permission. * permissions Returns all permission grants for each permission scheme. * projectRole Returns information about the project role granted the permission. * user Returns information about the user who is granted the permission. (optional)

    • getPermissionSchemeGrants

      PermissionGrants getPermissionSchemeGrants(@NotNull @NotNull Long schemeId, @Nullable @Nullable String expand)
      Get permission scheme grants

      Returns all permission grants for a permission scheme. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      schemeId - The ID of the permission scheme. (required)
      expand - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: * permissions Returns all permission grants for each permission scheme. * user Returns information about the user who is granted the permission. * group Returns information about the group that is granted the permission. * projectRole Returns information about the project role granted the permission. * field Returns information about the custom field granted the permission. * all Returns all expandable information. (optional)

    • getPermittedProjects

      PermittedProjects getPermittedProjects(@NotNull @NotNull PermissionsKeysBean permissionsKeysBean)
      Get permitted projects

      Returns all the projects where the user is granted a list of project permissions. **Deprecation notice:** The required OAuth 2.0 scopes will be updated on February 15, 2024. * **Classic**: read:jira-work * **Granular**: read:permission:jira, read:project:jira This operation can be accessed anonymously. **[Permissions](#permissions) required:** None.

      Parameters:
      permissionsKeysBean - (required)

    • getPrecomputations

      PageBeanJqlFunctionPrecomputationBean getPrecomputations(@Nullable @Nullable List<String> functionKey, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable String orderBy)
      Get precomputations (apps)

      Returns the list of a function's precomputations along with information about when they were created, updated, and last used. Each precomputation has a value \\- the JQL fragment to replace the custom function clause with. **[Permissions](#permissions) required:** This API is only accessible to apps and apps can only inspect their own functions.

      Parameters:
      functionKey - The function key in format: * Forge: ari:cloud:ecosystem::extension/[App ID]/[Environment ID]/static/[Function key from manifest] * Connect: [App key]__[Module key] (optional)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 100)
      orderBy - [Order](#ordering) the results by a field: * functionKey Sorts by the functionKey. * used Sorts by the used timestamp. * created Sorts by the created timestamp. * updated Sorts by the updated timestamp. (optional)

    • getPreference

      String getPreference(@NotNull @NotNull String key)
      Get preference

      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. These system preferences keys will be deprecated by 15/07/2024. You can still retrieve these keys, but it will not have any impact on Notification behaviour. * *user.notifiy.own.changes* Whether the user gets notified of their own changes. * *user.notifications.watcher* Whether the user gets notified when they are watcher. * *user.notifications.assignee* Whether the user gets notified when they are assignee. * *user.notifications.reporter* Whether the user gets notified when they are reporter. * *user.notifications.mentions* Whether the user gets notified when they are mentions. Use [ Update a user profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) from the user management REST API to manage timezone and locale instead. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      key - The key of the preference. (required)

    • getPriorities

      @Deprecated List<Priority> getPriorities()
      Deprecated.
      Get priorities

      Returns the list of all issue priorities. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

    • getPriority

      Priority getPriority(@NotNull @NotNull String id)
      Get priority

      Returns an issue priority. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the issue priority. (required)

    • getProject

      Project getProject(@NotNull @NotNull String projectIdOrKey, @Nullable @Nullable String expand, @Nullable @Nullable List<String> properties)
      Get project

      Returns the [project details](https://confluence.atlassian.com/x/ahLpNw) for a project. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include: * description The project description. * issueTypes The issue types associated with the project. * lead The project lead. * projectKeys All project keys associated with the project. * issueTypeHierarchy The project issue type hierarchy. (optional)
      properties - A list of project properties to return for the project. This parameter accepts a comma-separated list. (optional)

    • getProjectCategoryById

      ProjectCategory getProjectCategoryById(@NotNull @NotNull Long id)
      Get project category by ID

      Returns a project category. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the project category. (required)

    • getProjectComponents

      List<ProjectComponent> getProjectComponents(@NotNull @NotNull String projectIdOrKey, @Nullable @Nullable String componentSource)
      Get project components

      Returns all components in a project. See the [Get project components paginated](#api-rest-api-3-project-projectIdOrKey-component-get) resource if you want to get a full list of components with pagination. If your project uses Compass components, this API will return a paginated list of Compass components that are linked to issues in that project. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)
      componentSource - The source of the components to return. Can be jira (default), compass or auto. When auto is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to jira. (optional, defaults to jira)

    • getProjectComponentsPaginated

      PageBeanComponentWithIssueCount getProjectComponentsPaginated(@NotNull @NotNull String projectIdOrKey, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable String orderBy, @Nullable @Nullable String componentSource, @Nullable @Nullable String query)
      Get project components paginated

      Returns a [paginated](#pagination) list of all components in a project. See the [Get project components](#api-rest-api-3-project-projectIdOrKey-components-get) resource if you want to get a full list of versions without pagination. If your project uses Compass components, this API will return a list of Compass components that are linked to issues in that project. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      orderBy - [Order](#ordering) the results by a field: * description Sorts by the component description. * issueCount Sorts by the count of issues associated with the component. * lead Sorts by the user key of the component's project lead. * name Sorts by component name. (optional)
      componentSource - The source of the components to return. Can be jira (default), compass or auto. When auto is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to jira. (optional, defaults to jira)
      query - Filter the results using a literal string. Components with a matching name or description are returned (case insensitive). (optional)

    • getProjectContextMapping

      PageBeanCustomFieldContextProjectMapping getProjectContextMapping(@NotNull @NotNull String fieldId, @Nullable @Nullable Set<Long> contextId, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Get project mappings for custom field context

      Returns a [paginated](#pagination) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field, for example customfield\\_10000. (required)
      contextId - The list of context IDs. To include multiple context, separate IDs with ampersand: contextId=10000&amp;contextId=10001. (optional)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)

    • getProjectEmail

      ProjectEmailAddress getProjectEmail(@NotNull @NotNull Long projectId)
      Get project's sender email

      Returns the [project's sender email address](https://confluence.atlassian.com/x/dolKLg). **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      projectId - The project ID. (required)

    • getProjectIssueSecurityScheme

      SecurityScheme getProjectIssueSecurityScheme(@NotNull @NotNull String projectKeyOrId)
      Get project issue security scheme

      Returns the [issue security scheme](https://confluence.atlassian.com/x/J4lKLg) associated with the project. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or the *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg). Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectKeyOrId - The project ID or project key (case sensitive). (required)

    • getProjectProperty

      EntityProperty getProjectProperty(@NotNull @NotNull String projectIdOrKey, @NotNull @NotNull String propertyKey)
      Get project property

      Returns the value of a [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties). This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the property. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)
      propertyKey - The project property key. Use [Get project property keys](#api-rest-api-3-project-projectIdOrKey-properties-get) to get a list of all project property keys. (required)

    • getProjectPropertyKeys

      PropertyKeys getProjectPropertyKeys(@NotNull @NotNull String projectIdOrKey)
      Get project property keys

      Returns all [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties) keys for the project. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)

    • getProjectRole

      ProjectRole getProjectRole(@NotNull @NotNull String projectIdOrKey, @NotNull @NotNull Long id, @Nullable @Nullable Boolean excludeInactiveUsers)
      Get project role for project

      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](#api-rest-api-3-user-get) 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](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)
      id - The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
      excludeInactiveUsers - Exclude inactive users. (optional, defaults to false)

    • getProjectRoleActorsForRole

      ProjectRole getProjectRoleActorsForRole(@NotNull @NotNull Long id)
      Get default actors for project role

      Returns the [default actors](#api-rest-api-3-resolution-get) for the project role. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)

    • getProjectRoleById

      ProjectRole getProjectRoleById(@NotNull @NotNull Long id)
      Get project role by ID

      Gets the project role details and the default actors associated with the role. The list of default actors is sorted by display name. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)

    • getProjectRoleDetails

      List<ProjectRoleDetails> getProjectRoleDetails(@NotNull @NotNull String projectIdOrKey, @Nullable @Nullable Boolean currentMember, @Nullable @Nullable Boolean excludeConnectAddons)
      Get project role details

      Returns all [project roles](https://support.atlassian.com/jira-cloud-administration/docs/manage-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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)
      currentMember - Whether the roles should be filtered to include only those the user is assigned to. (optional, defaults to false)
      excludeConnectAddons - (optional, defaults to false)

    • getProjectRoles

      Map<String,URI> getProjectRoles(@NotNull @NotNull String projectIdOrKey)
      Get project roles for project

      Returns a list of [project roles](https://support.atlassian.com/jira-cloud-administration/docs/manage-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](#api-rest-api-3-role-get) for more information. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for any project on the site or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)

    • getProjectTypeByKey

      ProjectType getProjectTypeByKey(@NotNull @NotNull String projectTypeKey)
      Get project type by key

      Returns a [project type](https://confluence.atlassian.com/x/Var1Nw). This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectTypeKey - The key of the project type. (required)

    • getProjectVersions

      List<Version> getProjectVersions(@NotNull @NotNull String projectIdOrKey, @Nullable @Nullable String expand)
      Get project versions

      Returns all versions in a project. The response is not paginated. Use [Get project versions paginated](#api-rest-api-3-project-projectIdOrKey-version-get) if you want to get the versions in a project with pagination. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts operations, which returns actions that can be performed on the version. (optional)

    • getProjectVersionsPaginated

      PageBeanVersion getProjectVersionsPaginated(@NotNull @NotNull String projectIdOrKey, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable String orderBy, @Nullable @Nullable String query, @Nullable @Nullable String status, @Nullable @Nullable String expand)
      Get project versions paginated

      Returns a [paginated](#pagination) list of all versions in a project. See the [Get project versions](#api-rest-api-3-project-projectIdOrKey-versions-get) resource if you want to get a full list of versions without pagination. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      orderBy - [Order](#ordering) the results by a field: * description Sorts by version description. * name Sorts by version name. * releaseDate Sorts by release date, starting with the oldest date. Versions with no release date are listed last. * sequence Sorts by the order of appearance in the user interface. * startDate Sorts by start date, starting with the oldest date. Versions with no start date are listed last. (optional)
      query - Filter the results using a literal string. Versions with matching name or description are returned (case insensitive). (optional)
      status - A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are released, unreleased, and archived. (optional)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * issuesstatus Returns the number of issues in each status category for each version. * operations Returns actions that can be performed on the specified version. * driver Returns the Atlassian account ID of the version driver. * approvers Returns a list containing the approvers for this version. (optional)

    • getProjectsForIssueTypeScreenScheme

      PageBeanProjectDetails getProjectsForIssueTypeScreenScheme(@NotNull @NotNull Long issueTypeScreenSchemeId, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable String query)
      Get issue type screen scheme projects

      Returns a [paginated](#pagination) list of projects associated with an issue type screen scheme. Only company-managed projects associated with an issue type screen scheme are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeScreenSchemeId - The ID of the issue type screen scheme. (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      query - (optional)

    • getRecent

      List<Project> getRecent(@Nullable @Nullable String expand, @Nullable @Nullable List<Object> properties)
      Get recent projects

      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](#permissions) required:** Projects are returned only where the user has one of: * *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [read:jira-work]

      Parameters:
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: * description Returns the project description. * projectKeys Returns all project keys associated with a project. * lead Returns information about the project lead. * issueTypes Returns all issue types associated with the project. * url Returns the URL associated with the project. * permissions Returns the permissions associated with the project. * insight EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project. * * Returns the project with all available expand options. (optional)
      properties - EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list. Invalid property names are ignored. (optional)

    • getRelatedWork

      List<VersionRelatedWork> getRelatedWork(@NotNull @NotNull String id)
      Get related work

      Returns related work items for the given version id. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the version. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the version. (required)

    • getRemoteIssueLinkById

      RemoteIssueLink getRemoteIssueLinkById(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String linkId)
      Get remote issue link by ID

      Returns a remote issue link for an issue. This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM). This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      linkId - The ID of the remote issue link. (required)

    • getRemoteIssueLinks

      RemoteIssueLink getRemoteIssueLinks(@NotNull @NotNull String issueIdOrKey, @Nullable @Nullable String globalId)
      Get remote issue links

      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&amp;id=1 as system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1. This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM). This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      globalId - The global ID of the remote issue link. (optional)

    • getResolution

      Resolution getResolution(@NotNull @NotNull String id)
      Get resolution

      Returns an issue resolution value. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the issue resolution value. (required)

    • getResolutions

      @Deprecated List<Resolution> getResolutions()
      Deprecated.
      Get resolutions

      Returns a list of all issue resolution values. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

    • getScreenSchemes

      PageBeanScreenScheme getScreenSchemes(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Set<Long> id, @Nullable @Nullable String expand, @Nullable @Nullable String queryString, @Nullable @Nullable String orderBy)
      Get screen schemes

      Returns a [paginated](#pagination) list of screen schemes. Only screen schemes used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 25)
      id - The list of screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&amp;id=10001. (optional)
      expand - Use [expand](#expansion) include additional information in the response. This parameter accepts issueTypeScreenSchemes that, for each screen schemes, returns information about the issue type screen scheme the screen scheme is assigned to. (optional)
      queryString - String used to perform a case-insensitive partial match with screen scheme name. (optional)
      orderBy - [Order](#ordering) the results by a field: * id Sorts by screen scheme ID. * name Sorts by screen scheme name. (optional)

    • getScreens

      PageBeanScreen getScreens(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Set<Long> id, @Nullable @Nullable String queryString, @Nullable @Nullable Set<String> scope, @Nullable @Nullable String orderBy)
      Get screens

      Returns a [paginated](#pagination) list of all screens or those specified by one or more screen IDs. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 100)
      id - The list of screen IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&amp;id=10001. (optional)
      queryString - String used to perform a case-insensitive partial match with screen name. (optional)
      scope - The scope filter string. To filter by multiple scope, provide an ampersand-separated list. For example, scope=GLOBAL&amp;scope=PROJECT. (optional)
      orderBy - [Order](#ordering) the results by a field: * id Sorts by screen ID. * name Sorts by screen name. (optional)

    • getScreensForField

      PageBeanScreenWithTab getScreensForField(@NotNull @NotNull String fieldId, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable String expand)
      Get screens for a field

      Returns a [paginated](#pagination) list of the screens a field is used in. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      fieldId - The ID of the field to return screens for. (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 100)
      expand - Use [expand](#expansion) to include additional information about screens in the response. This parameter accepts tab which returns details about the screen tabs the field is used in. (optional)

    • getSecurityLevelMembers

      PageBeanSecurityLevelMember getSecurityLevelMembers(@Nullable @Nullable String startAt, @Nullable @Nullable String maxResults, @Nullable @Nullable Set<String> id, @Nullable @Nullable Set<String> schemeId, @Nullable @Nullable Set<String> levelId, @Nullable @Nullable String expand)
      Get issue security level members

      Returns a [paginated](#pagination) list of issue security level members. Only issue security level members in the context of classic projects are returned. Filtering using parameters is inclusive: if you specify both security scheme IDs and level IDs, the result will include all issue security level members from the specified schemes and levels. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      id - The list of issue security level member IDs. To include multiple issue security level members separate IDs with an ampersand: id=10000&amp;id=10001. (optional)
      schemeId - The list of issue security scheme IDs. To include multiple issue security schemes separate IDs with an ampersand: schemeId=10000&amp;schemeId=10001. (optional)
      levelId - The list of issue security level IDs. To include multiple issue security levels separate IDs with an ampersand: levelId=10000&amp;levelId=10001. (optional)
      expand - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * all Returns all expandable information * field Returns information about the custom field granted the permission * group Returns information about the group that is granted the permission * projectRole Returns information about the project role granted the permission * user Returns information about the user who is granted the permission (optional)

    • getSecurityLevels

      PageBeanSecurityLevel getSecurityLevels(@Nullable @Nullable String startAt, @Nullable @Nullable String maxResults, @Nullable @Nullable Set<String> id, @Nullable @Nullable Set<String> schemeId, @Nullable @Nullable Boolean onlyDefault)
      Get issue security levels

      Returns a [paginated](#pagination) list of issue security levels. Only issue security levels in the context of classic projects are returned. Filtering using IDs is inclusive: if you specify both security scheme IDs and level IDs, the result will include both specified issue security levels and all issue security levels from the specified schemes. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      id - The list of issue security scheme level IDs. To include multiple issue security levels, separate IDs with an ampersand: id=10000&amp;id=10001. (optional)
      schemeId - The list of issue security scheme IDs. To include multiple issue security schemes, separate IDs with an ampersand: schemeId=10000&amp;schemeId=10001. (optional)
      onlyDefault - When set to true, returns multiple default levels for each security scheme containing a default. If you provide scheme and level IDs not associated with the default, returns an empty page. The default value is false. (optional, defaults to false)

    • getSecurityLevelsForProject

      ProjectIssueSecurityLevels getSecurityLevelsForProject(@NotNull @NotNull String projectKeyOrId)
      Get project issue security levels

      Returns all [issue security](https://confluence.atlassian.com/x/J4lKLg) levels for the project that the user has access to. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [global permission](https://confluence.atlassian.com/x/x4dKLg) for the project, however, issue security levels are only returned for authenticated user with *Set Issue Security* [global permission](https://confluence.atlassian.com/x/x4dKLg) for the project. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      projectKeyOrId - The project ID or project key (case sensitive). (required)

    • getSelectableIssueFieldOptions

      PageBeanIssueFieldOption getSelectableIssueFieldOptions(@NotNull @NotNull String fieldKey, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Long projectId)
      Get selectable issue field options

      Returns a [paginated](#pagination) 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](#api-group-Issue-custom-field-options) resource. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      fieldKey - The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the fieldKey value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the jiraIssueFields module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field" (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      projectId - Filters the results to options that are only available in the specified project. (optional)

    • getSelectedTimeTrackingImplementation

      TimeTrackingProvider getSelectedTimeTrackingImplementation()
      Get selected time tracking provider

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

    • getServerInfo

      ServerInformation getServerInfo()
      Get Jira instance info

      Returns information about the Jira instance. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None.

    • getSharePermission

      SharePermission getSharePermission(@NotNull @NotNull Long id, @NotNull @NotNull Long permissionId)
      Get share permission

      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](#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](https://confluence.atlassian.com/x/yodKLg) for. * filters shared with a public project. * filters shared with the public. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the filter. (required)
      permissionId - The ID of the share permission. (required)

    • getSharePermissions

      List<SharePermission> getSharePermissions(@NotNull @NotNull Long id)
      Get share permissions

      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](#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](https://confluence.atlassian.com/x/yodKLg) for. * filters shared with a public project. * filters shared with the public. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the filter. (required)

    • getSharedTimeTrackingConfiguration

      TimeTrackingConfiguration getSharedTimeTrackingConfiguration()
      Get time tracking settings

      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](https://confluence.atlassian.com/x/qoXKM). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

    • getStatus

      StatusDetails getStatus(@NotNull @NotNull String idOrName)
      Get status

      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](#permissions) required: None. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      idOrName - The ID or name of the status. (required)

    • getStatusCategories

      List<StatusCategory> getStatusCategories()
      Get all status categories

      Returns a list of all status categories. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

    • getStatusCategory

      StatusCategory getStatusCategory(@NotNull @NotNull String idOrKey)
      Get status category

      Returns a status category. Status categories provided a mechanism for categorizing [statuses](#api-rest-api-3-status-idOrName-get). **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      idOrKey - The ID or key of the status category. (required)

    • getStatuses

      List<StatusDetails> getStatuses()
      Get all statuses

      Returns a list of all statuses associated with active workflows. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

    • getStatusesById

      List<JiraStatus> getStatusesById(@NotNull @NotNull List<String> id, @Nullable @Nullable String expand)
      Bulk get statuses

      Returns a list of the statuses specified by one or more status IDs. **[Permissions](#permissions) required:** * *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg) * *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg) Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Min items 1, Max items 50 (required)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * usages Returns the project and issue types that use the status in their workflow. * workflowUsages Returns the workflows that use the status. (optional)

    • getTask

      TaskProgressBeanObject getTask(@NotNull @NotNull String taskId)
      Get task

      Returns the status of a [long-running asynchronous task](#async). 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. **Deprecation notice:** The required OAuth 2.0 scopes will be updated on June 15, 2024. * read:jira-work **[Permissions](#permissions) required:** either of: * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Creator of the task.

      Parameters:
      taskId - The ID of the task. (required)

    • getTransitions

      Transitions getTransitions(@NotNull @NotNull String issueIdOrKey, @Nullable @Nullable String expand, @Nullable @Nullable String transitionId, @Nullable @Nullable Boolean skipRemoteOnlyCondition, @Nullable @Nullable Boolean includeUnavailableTransitions, @Nullable @Nullable Boolean sortByOpsBarAndStatus)
      Get transitions

      Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status. Note, if a request is made for a transition that does not exist or cannot be performed on the issue, given its status, the response will return any empty transitions list. This operation can be accessed anonymously. **[Permissions](#permissions) required: A list or transition is returned only when the user has:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. However, if the user does not have the *Transition issues* [ project permission](https://confluence.atlassian.com/x/yodKLg) the response will not list any transitions. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      expand - Use [expand](#expansion) to include additional information about transitions in the response. This parameter accepts transitions.fields, which returns information about the fields in the transition screen for each transition. Fields hidden from the screen are not returned. Use this information to populate the fields and update fields in [Transition issue](#api-rest-api-3-issue-issueIdOrKey-transitions-post). (optional)
      transitionId - The ID of the transition. (optional)
      skipRemoteOnlyCondition - Whether transitions with the condition *Hide From User Condition* are included in the response. (optional, defaults to false)
      includeUnavailableTransitions - Whether details of transitions that fail a condition are included in the response (optional, defaults to false)
      sortByOpsBarAndStatus - Whether the transitions are sorted by ops-bar sequence value first then category order (Todo, In Progress, Done) or only by ops-bar sequence value. (optional, defaults to false)

    • getTrashedFieldsPaginated

      PageBeanField getTrashedFieldsPaginated(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Set<String> id, @Nullable @Nullable String query, @Nullable @Nullable String expand, @Nullable @Nullable String orderBy)
      Get fields in trash paginated

      Returns a [paginated](#pagination) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [read:jira-work]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      id - (optional)
      query - String used to perform a case-insensitive partial match with field names or descriptions. (optional)
      expand - (optional)
      orderBy - [Order](#ordering) the results by a field: * name sorts by the field name * trashDate sorts by the date the field was moved to the trash * plannedDeletionDate sorts by the planned deletion date (optional)

    • getUiModifications

      PageBeanUiModificationDetails getUiModifications(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable String expand)
      Get UI modifications

      Gets UI modifications. UI modifications can only be retrieved by Forge apps. **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      expand - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * data Returns UI modification data. * contexts Returns UI modification contexts. (optional)

    • getUser

      User getUser(@Nullable @Nullable String accountId, @Nullable @Nullable String username, @Nullable @Nullable String key, @Nullable @Nullable String expand)
      Get user

      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](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/) for more details. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [read:jira-user]

      Parameters:
      accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required. (optional)
      username - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide) for details. (optional)
      key - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide) for details. (optional)
      expand - Use [expand](#expansion) to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include: * groups includes all groups and nested groups to which the user belongs. * applicationRoles includes details of all the applications to which the user has access. (optional)

    • getUserDefaultColumns

      List<ColumnItem> getUserDefaultColumns(@Nullable @Nullable String accountId, @Nullable @Nullable String username)
      Get user default columns

      Returns the default [issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If accountId is not passed in the request, the calling user's details are returned. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLgl), to get the column details for any user. * Permission to access Jira, to get the calling user's column details. Authentication - Required Scopes: [read:jira-user]

      Parameters:
      accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. (optional)
      username - This parameter is no longer available See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)

    • getUserEmail

      UnrestrictedUserEmail getUserEmail(@NotNull @NotNull String accountId)
      Get user email

      Returns a user's email address. This API is only available to apps approved by Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).

      Parameters:
      accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. (required)

    • getUserEmailBulk

      UnrestrictedUserEmail getUserEmailBulk(@NotNull @NotNull List<String> accountId)
      Get user email bulk

      Returns a user's email address. This API is only available to apps approved by Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).

      Parameters:
      accountId - The account IDs of the users for which emails are required. An accountId is an identifier that uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Note, this should be treated as an opaque identifier (that is, do not assume any structure in the value). (required)

    • getUserGroups

      List<GroupName> getUserGroups(@NotNull @NotNull String accountId, @Nullable @Nullable String username, @Nullable @Nullable String key)
      Get user groups

      Returns the groups to which a user belongs. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [read:jira-user]

      Parameters:
      accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. (required)
      username - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      key - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)

    • getUserProperty

      EntityProperty getUserProperty(@NotNull @NotNull String propertyKey, @Nullable @Nullable String accountId, @Nullable @Nullable String userKey, @Nullable @Nullable String username)
      Get user property

      Returns the value of a user's property. If no property key is provided [Get user property keys](#api-rest-api-3-user-properties-get) is called. Note: This operation does not access the [user properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to get a property from any user. * Access to Jira, to get a property from the calling user's record. Authentication - Required Scopes: [read:jira-user]

      Parameters:
      propertyKey - The key of the user's property. (required)
      accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. (optional)
      userKey - This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)

    • getUserPropertyKeys

      PropertyKeys getUserPropertyKeys(@Nullable @Nullable String accountId, @Nullable @Nullable String userKey, @Nullable @Nullable String username)
      Get user property keys

      Returns the keys of all properties for a user. Note: This operation does not access the [user properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to access the property keys on any user. * Access to Jira, to access the calling user's property keys. Authentication - Required Scopes: [read:jira-user]

      Parameters:
      accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. (optional)
      userKey - This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)

    • getUsersFromGroup

      PageBeanUserDetails getUsersFromGroup(@Nullable @Nullable String groupname, @Nullable @Nullable String groupId, @Nullable @Nullable Boolean includeInactiveUsers, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults)
      Get users from group

      Returns a [paginated](#pagination) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      groupname - As a group's name can change, use of groupId is recommended to identify a group. The name of the group. This parameter cannot be used with the groupId parameter. (optional)
      groupId - The ID of the group. This parameter cannot be used with the groupName parameter. (optional)
      includeInactiveUsers - Include inactive users. (optional, defaults to false)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)

    • getValidProjectKey

      String getValidProjectKey(@Nullable @Nullable String key)
      Get valid project key

      Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key. **[Permissions](#permissions) required:** None.

      Parameters:
      key - The project key. (optional)

    • getValidProjectName

      String getValidProjectName(@NotNull @NotNull String name)
      Get valid project name

      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](#permissions) required:** None.

      Parameters:
      name - The project name. (required)

    • getVersion

      Version getVersion(@NotNull @NotNull String id, @Nullable @Nullable String expand)
      Get version

      Returns a project version. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the version. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the version. (required)
      expand - Use [expand](#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include: * operations Returns the list of operations available for this version. * issuesstatus Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property represents the number of issues with a status other than *to do*, *in progress*, and *done*. * driver Returns the Atlassian account ID of the version driver. * approvers Returns a list containing the Atlassian account IDs of approvers for this version. (optional)

    • getVersionRelatedIssues

      VersionIssueCounts getVersionRelatedIssues(@NotNull @NotNull String id)
      Get version's related issues count

      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](#permissions) required:** *Browse projects* project permission for the project that contains the version. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the version. (required)

    • getVersionUnresolvedIssues

      VersionUnresolvedIssuesCount getVersionUnresolvedIssues(@NotNull @NotNull String id)
      Get version's unresolved issues count

      Returns counts of the issues and unresolved issues for the project version. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* project permission for the project that contains the version. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      id - The ID of the version. (required)

    • getVisibleIssueFieldOptions

      PageBeanIssueFieldOption getVisibleIssueFieldOptions(@NotNull @NotNull String fieldKey, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Long projectId)
      Get visible issue field options

      Returns a [paginated](#pagination) 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](#api-group-Issue-custom-field-options) resource. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      fieldKey - The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the fieldKey value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the jiraIssueFields module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field" (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      projectId - Filters the results to options that are only available in the specified project. (optional)

    • getVotes

      Votes getVotes(@NotNull @NotNull String issueIdOrKey)
      Get votes

      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](https://confluence.atlassian.com/x/uYXKM) for details. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is ini * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)

    • getWorkflow

      IssueTypesWorkflowMapping getWorkflow(@NotNull @NotNull Long id, @Nullable @Nullable String workflowName, @Nullable @Nullable Boolean returnDraftIfExists)
      Get issue types for workflows in workflow scheme

      Returns the workflow-issue type mappings for a workflow scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme. (required)
      workflowName - The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow. (optional)
      returnDraftIfExists - Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned. (optional, defaults to false)

    • getWorkflowScheme

      WorkflowScheme getWorkflowScheme(@NotNull @NotNull Long id, @Nullable @Nullable Boolean returnDraftIfExists)
      Get workflow scheme

      Returns a workflow scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, *schemeId=10301*. (required)
      returnDraftIfExists - Returns the workflow scheme's draft rather than scheme itself, if set to true. If the workflow scheme does not have a draft, then the workflow scheme is returned. (optional, defaults to false)

    • getWorkflowSchemeDraft

      WorkflowScheme getWorkflowSchemeDraft(@NotNull @NotNull Long id)
      Get draft workflow scheme

      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](https://confluence.atlassian.com/x/tohKLg) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the active workflow scheme that the draft was created from. (required)

    • getWorkflowSchemeDraftIssueType

      IssueTypeWorkflowMapping getWorkflowSchemeDraftIssueType(@NotNull @NotNull Long id, @NotNull @NotNull String issueType)
      Get workflow for issue type in draft workflow scheme

      Returns the issue type-workflow mapping for an issue type in a workflow scheme's draft. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme that the draft belongs to. (required)
      issueType - The ID of the issue type. (required)

    • getWorkflowSchemeIssueType

      IssueTypeWorkflowMapping getWorkflowSchemeIssueType(@NotNull @NotNull Long id, @NotNull @NotNull String issueType, @Nullable @Nullable Boolean returnDraftIfExists)
      Get workflow for issue type in workflow scheme

      Returns the issue type-workflow mapping for an issue type in a workflow scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme. (required)
      issueType - The ID of the issue type. (required)
      returnDraftIfExists - Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned. (optional, defaults to false)

    • getWorkflowSchemeProjectAssociations

      ContainerOfWorkflowSchemeAssociations getWorkflowSchemeProjectAssociations(@NotNull @NotNull Set<Long> projectId)
      Get workflow scheme project associations

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      projectId - The ID of a project to return the workflow schemes for. To include multiple projects, provide an ampersand-Jim: oneseparated list. For example, projectId=10000&amp;projectId=10001. (required)

    • getWorkflowTransitionProperties

      WorkflowTransitionProperty getWorkflowTransitionProperties(@NotNull @NotNull Long transitionId, @NotNull @NotNull String workflowName, @Nullable @Nullable Boolean includeReservedKeys, @Nullable @Nullable String key, @Nullable @Nullable String workflowMode)
      Get workflow transition properties

      Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      transitionId - The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition. (required)
      workflowName - The name of the workflow that the transition belongs to. (required)
      includeReservedKeys - Some properties with keys that have the *jira.* prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to *true*. (optional, defaults to false)
      key - The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned. (optional)
      workflowMode - The workflow status. Set to *live* for active and inactive workflows, or *draft* for draft workflows. (optional, defaults to live)

    • getWorkflowTransitionRuleConfigurations

      PageBeanWorkflowTransitionRules getWorkflowTransitionRuleConfigurations(@NotNull @NotNull Set<String> types, @NotNull @NotNull GetWorkflowTransitionRuleConfigurationsRequest getWorkflowTransitionRuleConfigurationsRequest, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Set<String> keys, @Nullable @Nullable Set<String> workflowNames, @Nullable @Nullable Set<String> withTags, @Nullable @Nullable Boolean draft, @Nullable @Nullable String expand)
      Get workflow transition rule configurations

      Returns a [paginated](#pagination) 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](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/). * matching one or more transition rule keys. Only workflows containing transition rules created by the calling [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) or [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps) app are returned. Due to server-side optimizations, workflows with an empty list of rules may be returned; these workflows can be ignored. **[Permissions](#permissions) required:** Only [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) or [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps) apps can use this operation. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      types - The types of the transition rules to return. (required)
      getWorkflowTransitionRuleConfigurationsRequest - (required)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 10)
      keys - The transition rule class keys, as defined in the Connect or the Forge app descriptor, of the transition rules to return. (optional)
      workflowNames - The list of workflow names to filter by. (optional)
      withTags - The list of tags to filter by. (optional)
      draft - Whether draft or published workflows are returned. If not provided, both workflow types are returned. (optional)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts transition, which, for each rule, returns information about the transition the rule is assigned to. (optional)

    • getWorkflowsPaginated

      PageBeanWorkflow getWorkflowsPaginated(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable Set<String> workflowName, @Nullable @Nullable String expand, @Nullable @Nullable String queryString, @Nullable @Nullable String orderBy, @Nullable @Nullable Boolean isActive)
      Get workflows paginated

      Returns a [paginated](#pagination) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      workflowName - The name of a workflow to return. To include multiple workflows, provide an ampersand-separated list. For example, workflowName=name1&amp;workflowName=name2. (optional)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * transitions For each workflow, returns information about the transitions inside the workflow. * transitions.rules For each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested. * transitions.properties For each workflow transition, returns information about its properties. Transitions are included automatically if this expand is requested. * statuses For each workflow, returns information about the statuses inside the workflow. * statuses.properties For each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested. * default For each workflow, returns information about whether this is the default workflow. * schemes For each workflow, returns information about the workflow schemes the workflow is assigned to. * projects For each workflow, returns information about the projects the workflow is assigned to, through workflow schemes. * hasDraftWorkflow For each workflow, returns information about whether the workflow has a draft version. * operations For each workflow, returns information about the actions that can be undertaken on the workflow. (optional)
      queryString - String used to perform a case-insensitive partial match with workflow name. (optional)
      orderBy - [Order](#ordering) the results by a field: * name Sorts by workflow name. * created Sorts by create time. * updated Sorts by update time. (optional)
      isActive - Filters active and inactive workflows. (optional)

    • getWorklog

      Worklog getWorklog(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String id, @Nullable @Nullable String expand)
      Get worklog

      Returns a worklog. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM). This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      id - The ID of the worklog. (required)
      expand - Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts properties, which returns worklog properties. (optional)

    • getWorklogProperty

      EntityProperty getWorklogProperty(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String worklogId, @NotNull @NotNull String propertyKey)
      Get worklog property

      Returns the value of a worklog property. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      worklogId - The ID of the worklog. (required)
      propertyKey - The key of the property. (required)

    • getWorklogPropertyKeys

      PropertyKeys getWorklogPropertyKeys(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String worklogId)
      Get worklog property keys

      Returns the keys of all properties for a worklog. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      worklogId - The ID of the worklog. (required)

    • getWorklogsForIds

      List<Worklog> getWorklogsForIds(@NotNull @NotNull WorklogIdsRequestBean worklogIdsRequestBean, @Nullable @Nullable String expand)
      Get worklogs

      Returns worklog details for a list of worklog IDs. The returned list of worklogs is limited to 1000 items. **[Permissions](#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. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      worklogIdsRequestBean - A JSON object containing a list of worklog IDs. (required)
      expand - Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts properties that returns the properties of each worklog. (optional)

    • linkIssues

      Object linkIssues(@NotNull @NotNull LinkIssueRequestJsonBean linkIssueRequestJsonBean)
      Create issue link

      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](https://confluence.atlassian.com/x/yoXKM) 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](#permissions) required:** * *Browse project* [project permission](https://confluence.atlassian.com/x/yodKLg) for all the projects containing the issues to be linked, * *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) on the project containing the from (outward) issue, * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      linkIssueRequestJsonBean - The issue link request. (required)

    • matchIssues

      IssueMatches matchIssues(@NotNull @NotNull IssuesAndJQLQueries issuesAndJQLQueries)
      Check issues against JQL

      Checks whether one or more issues would be returned by one or more JQL queries. **[Permissions](#permissions) required:** None, however, issues are only matched against JQL queries where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      issuesAndJQLQueries - (required)

    • mergeVersions

      Object mergeVersions(@NotNull @NotNull String id, @NotNull @NotNull String moveIssuesTo)
      Merge versions

      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](#api-rest-api-3-version-id-removeAndSwap-post) instead. This resource supports swapping version values in fixVersion, affectedVersion, and custom fields. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version. Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      id - The ID of the version to delete. (required)
      moveIssuesTo - The ID of the version to merge into. (required)

    • migrateQueries

      ConvertedJQLQueries migrateQueries(@NotNull @NotNull JQLPersonalDataMigrationRequest jqLPersonalDataMigrationRequest)
      Convert user identifiers to account IDs in JQL queries

      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](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/). **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-user]

      Parameters:
      jqLPersonalDataMigrationRequest - (required)

    • migrationResourceUpdateEntityPropertiesValuePut

      void migrationResourceUpdateEntityPropertiesValuePut(@NotNull @NotNull UUID atlassianTransferId, @NotNull @NotNull String entityType, @NotNull @NotNull List<EntityPropertyDetails> entityPropertyDetails)
      Bulk update entity properties

      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.

      Parameters:
      atlassianTransferId - The app migration transfer ID. (required)
      entityType - The type indicating the object that contains the entity properties. (required)
      entityPropertyDetails - (required)

    • migrationResourceWorkflowRuleSearchPost

      WorkflowRulesSearchDetails migrationResourceWorkflowRuleSearchPost(@NotNull @NotNull UUID atlassianTransferId, @NotNull @NotNull WorkflowRulesSearch workflowRulesSearch)
      Get workflow transition rule configurations

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

      Parameters:
      atlassianTransferId - The app migration transfer ID. (required)
      workflowRulesSearch - (required)

    • movePriorities

      Object movePriorities(@NotNull @NotNull ReorderIssuePriorities reorderIssuePriorities)
      Move priorities

      Changes the order of issue priorities. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      reorderIssuePriorities - (required)

    • moveResolutions

      Object moveResolutions(@NotNull @NotNull ReorderIssueResolutionsRequest reorderIssueResolutionsRequest)
      Move resolutions

      Changes the order of issue resolutions. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      reorderIssueResolutionsRequest - (required)

    • moveScreenTab

      Object moveScreenTab(@NotNull @NotNull Long screenId, @NotNull @NotNull Long tabId, @NotNull @NotNull Integer pos)
      Move screen tab

      Moves a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      screenId - The ID of the screen. (required)
      tabId - The ID of the screen tab. (required)
      pos - The position of tab. The base index is 0. (required)

    • moveScreenTabField

      Object moveScreenTabField(@NotNull @NotNull Long screenId, @NotNull @NotNull Long tabId, @NotNull @NotNull String id, @NotNull @NotNull MoveFieldBean moveFieldBean)
      Move screen tab field

      Moves a screen tab field. If after and position are provided in the request, position is ignored. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      screenId - The ID of the screen. (required)
      tabId - The ID of the screen tab. (required)
      id - The ID of the field. (required)
      moveFieldBean - (required)

    • moveVersion

      Version moveVersion(@NotNull @NotNull String id, @NotNull @NotNull VersionMoveBean versionMoveBean)
      Move version

      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](#permissions) required:** *Browse projects* project permission for the project that contains the version. Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      id - The ID of the version to be moved. (required)
      versionMoveBean - (required)

    • notify

      Object notify(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull Notification notification)
      Send notification for issue

      Creates an email notification for an issue and adds it to the mail queue. **[Permissions](#permissions) required:** * *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - ID or key of the issue that the notification is sent for. (required)
      notification - The request object for the notification and recipients. (required)

    • parseJqlQueries

      ParsedJqlQueries parseJqlQueries(@NotNull @NotNull JqlQueriesToParse jqlQueriesToParse, @Nullable @Nullable String validation)
      Parse JQL query

      Parses and validates JQL queries. Validation is performed in context of the current user. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      jqlQueriesToParse - (required)
      validation - How to validate the JQL query and treat the validation results. Validation options include: * strict Returns all errors. If validation fails, the query structure is not returned. * warn Returns all errors. If validation fails but the JQL query is correctly formed, the query structure is returned. * none No validation is performed. If JQL query is correctly formed, the query structure is returned. (optional, defaults to strict)

    • partialUpdateProjectRole

      ProjectRole partialUpdateProjectRole(@NotNull @NotNull Long id, @NotNull @NotNull CreateUpdateRoleRequestBean createUpdateRoleRequestBean)
      Partial update project role

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
      createUpdateRoleRequestBean - (required)

    • publishDraftWorkflowScheme

      void publishDraftWorkflowScheme(@NotNull @NotNull Long id, @NotNull @NotNull PublishDraftWorkflowScheme publishDraftWorkflowScheme, @Nullable @Nullable Boolean validateOnly)
      Publish draft workflow scheme

      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](#async). Follow the location link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain updates. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme that the draft belongs to. (required)
      publishDraftWorkflowScheme - Details of the status mappings. (required)
      validateOnly - Whether the request only performs a validation. (optional, defaults to false)

    • readWorkflowSchemes

      List<WorkflowSchemeReadResponse> readWorkflowSchemes(@NotNull @NotNull WorkflowSchemeReadRequest workflowSchemeReadRequest, @Nullable @Nullable String expand)
      Bulk get workflow schemes

      Returns a list of workflow schemes by providing workflow scheme IDs or project IDs. **[Permissions](#permissions) required:** * *Administer Jira* global permission to access all, including project-scoped, workflow schemes * *Administer projects* project permissions to access project-scoped workflow schemes Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      workflowSchemeReadRequest - (required)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * workflows.usages Returns the project and issue types that each workflow in the workflow scheme is associated with. (optional)

    • readWorkflows

      WorkflowReadResponse readWorkflows(@NotNull @NotNull WorkflowReadRequest workflowReadRequest, @Nullable @Nullable String expand)
      Bulk get workflows

      Returns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue types. **[Permissions](#permissions) required:** * *Administer Jira* global permission to access all, including project-scoped, workflows * At least one of the *Administer projects* and *View (read-only) workflow* project permissions to access project-scoped workflows Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      workflowReadRequest - (required)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * workflows.usages Returns the project and issue types that each workflow is associated with. * statuses.usages Returns the project and issue types that each status is associated with. (optional)

    • refreshWebhooks

      WebhooksExpirationDate refreshWebhooks(@NotNull @NotNull ContainerForWebhookIDs containerForWebhookIDs)
      Extend webhook life

      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](#permissions) required:** Only [Connect](https://developer.atlassian.com/cloud/jira/platform/#connect-apps) and [OAuth 2.0](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps) apps can use this operation. Authentication - Required Scopes: [read:jira-work, manage:jira-webhook]

      Parameters:
      containerForWebhookIDs - (required)

    • registerDynamicWebhooks

      ContainerForRegisteredWebhooks registerDynamicWebhooks(@NotNull @NotNull WebhookRegistrationDetails webhookRegistrationDetails)
      Register dynamic webhooks

      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](#permissions) required:** Only [Connect](https://developer.atlassian.com/cloud/jira/platform/#connect-apps) and [OAuth 2.0](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps) apps can use this operation. Authentication - Required Scopes: [read:jira-work, manage:jira-webhook]

      Parameters:
      webhookRegistrationDetails - (required)

    • removeAttachment

      void removeAttachment(@NotNull @NotNull String id)
      Delete attachment

      Deletes an attachment from an issue. This operation can be accessed anonymously. **[Permissions](#permissions) required:** For the project holding the issue containing the attachment: * *Delete own attachments* [project permission](https://confluence.atlassian.com/x/yodKLg) to delete an attachment created by the calling user. * *Delete all attachments* [project permission](https://confluence.atlassian.com/x/yodKLg) to delete an attachment created by any user. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      id - The ID of the attachment. (required)

    • removeCustomFieldContextFromProjects

      Object removeCustomFieldContextFromProjects(@NotNull @NotNull String fieldId, @NotNull @NotNull Long contextId, @NotNull @NotNull ProjectIds projectIds)
      Remove custom field context from projects

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field. (required)
      contextId - The ID of the context. (required)
      projectIds - (required)

    • removeGadget

      Object removeGadget(@NotNull @NotNull Long dashboardId, @NotNull @NotNull Long gadgetId)
      Remove gadget from dashboard

      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](#permissions) required:** None. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      dashboardId - The ID of the dashboard. (required)
      gadgetId - The ID of the gadget. (required)

    • removeGroup

      void removeGroup(@Nullable @Nullable String groupname, @Nullable @Nullable String groupId, @Nullable @Nullable String swapGroup, @Nullable @Nullable String swapGroupId)
      Remove group

      Deletes a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* strategic [group](https://confluence.atlassian.com/x/24xjL)). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      groupname - (optional)
      groupId - The ID of the group. This parameter cannot be used with the groupname parameter. (optional)
      swapGroup - As a group's name can change, use of swapGroupId is recommended to identify a group. The group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions are not transferred, comments and worklogs are inaccessible after the deletion. This parameter cannot be used with the swapGroupId parameter. (optional)
      swapGroupId - The ID of the group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions are not transferred, comments and worklogs are inaccessible after the deletion. This parameter cannot be used with the swapGroup parameter. (optional)

    • removeIssueTypeFromIssueTypeScheme

      Object removeIssueTypeFromIssueTypeScheme(@NotNull @NotNull Long issueTypeSchemeId, @NotNull @NotNull Long issueTypeId)
      Remove issue type from issue type scheme

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeSchemeId - The ID of the issue type scheme. (required)
      issueTypeId - The ID of the issue type. (required)

    • removeIssueTypesFromContext

      Object removeIssueTypesFromContext(@NotNull @NotNull String fieldId, @NotNull @NotNull Long contextId, @NotNull @NotNull IssueTypeIds issueTypeIds)
      Remove issue types from context

      Removes issue types from a custom field context. A custom field context without any issue types applies to all issue types. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field. (required)
      contextId - The ID of the context. (required)
      issueTypeIds - (required)

    • removeIssueTypesFromGlobalFieldConfigurationScheme

      Object removeIssueTypesFromGlobalFieldConfigurationScheme(@NotNull @NotNull Long id, @NotNull @NotNull IssueTypeIdsToRemove issueTypeIdsToRemove)
      Remove issue types from field configuration scheme

      Removes issue types from the field configuration scheme. This operation can only modify field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the field configuration scheme. (required)
      issueTypeIdsToRemove - The issue type IDs to remove. (required)

    • removeLevel

      void removeLevel(@NotNull @NotNull String schemeId, @NotNull @NotNull String levelId, @Nullable @Nullable String replaceWith)
      Remove issue security level

      Deletes an issue security level. This operation is [asynchronous](#async). Follow the location link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      schemeId - The ID of the issue security scheme. (required)
      levelId - The ID of the issue security level to remove. (required)
      replaceWith - The ID of the issue security level that will replace the currently selected level. (optional)

    • removeMappingsFromIssueTypeScreenScheme

      Object removeMappingsFromIssueTypeScreenScheme(@NotNull @NotNull String issueTypeScreenSchemeId, @NotNull @NotNull IssueTypeIds issueTypeIds)
      Remove mappings from issue type screen scheme

      Removes issue type to screen scheme mappings from an issue type screen scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeScreenSchemeId - The ID of the issue type screen scheme. (required)
      issueTypeIds - (required)

    • removeMemberFromSecurityLevel

      Object removeMemberFromSecurityLevel(@NotNull @NotNull String schemeId, @NotNull @NotNull String levelId, @NotNull @NotNull String memberId)
      Remove member from issue security level

      Removes an issue security level member from an issue security scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      schemeId - The ID of the issue security scheme. (required)
      levelId - The ID of the issue security level. (required)
      memberId - The ID of the issue security level member to be removed. (required)

    • removeNotificationFromNotificationScheme

      Object removeNotificationFromNotificationScheme(@NotNull @NotNull String notificationSchemeId, @NotNull @NotNull String notificationId)
      Remove notification from notification scheme

      Removes a notification from a notification scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      notificationSchemeId - The ID of the notification scheme. (required)
      notificationId - The ID of the notification. (required)

    • removePreference

      void removePreference(@NotNull @NotNull String key)
      Delete preference

      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](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) from the user management REST API to manage timezone and locale instead. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      key - The key of the preference. (required)

    • removeProjectCategory

      void removeProjectCategory(@NotNull @NotNull Long id)
      Delete project category

      Deletes a project category. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      id - ID of the project category to delete. (required)

    • removeScreenTabField

      void removeScreenTabField(@NotNull @NotNull Long screenId, @NotNull @NotNull Long tabId, @NotNull @NotNull String id)
      Remove screen tab field

      Removes a field from a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      screenId - The ID of the screen. (required)
      tabId - The ID of the screen tab. (required)
      id - The ID of the field. (required)

    • removeUser

      void removeUser(@NotNull @NotNull String accountId, @Nullable @Nullable String username, @Nullable @Nullable String key)
      Delete user

      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](#permissions) required:** Site administration (that is, membership of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)).

      Parameters:
      accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. (required)
      username - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      key - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)

    • removeUserFromGroup

      void removeUserFromGroup(@NotNull @NotNull String accountId, @Nullable @Nullable String groupname, @Nullable @Nullable String groupId, @Nullable @Nullable String username)
      Remove user from group

      Removes a user from a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. (required)
      groupname - As a group's name can change, use of groupId is recommended to identify a group. The name of the group. This parameter cannot be used with the groupId parameter. (optional)
      groupId - The ID of the group. This parameter cannot be used with the groupName parameter. (optional)
      username - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)

    • removeVote

      void removeVote(@NotNull @NotNull String issueIdOrKey)
      Delete vote

      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](https://confluence.atlassian.com/x/uYXKM) for details. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)

    • removeWatcher

      void removeWatcher(@NotNull @NotNull String issueIdOrKey, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      Delete watcher

      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](https://confluence.atlassian.com/x/uYXKM) for details. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * To remove users other than themselves from the watchlist, *Manage watcher list* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      username - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required. (optional)

    • renameScreenTab

      ScreenableTab renameScreenTab(@NotNull @NotNull Long screenId, @NotNull @NotNull Long tabId, @NotNull @NotNull ScreenableTab screenableTab)
      Update screen tab

      Updates the name of a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      screenId - The ID of the screen. (required)
      tabId - The ID of the screen tab. (required)
      screenableTab - (required)

    • reorderCustomFieldOptions

      Object reorderCustomFieldOptions(@NotNull @NotNull String fieldId, @NotNull @NotNull Long contextId, @NotNull @NotNull OrderOfCustomFieldOptions orderOfCustomFieldOptions)
      Reorder custom field options (context)

      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)](#api-group-issue-custom-field-options--apps-) operations.** **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field. (required)
      contextId - The ID of the context. (required)
      orderOfCustomFieldOptions - (required)

    • reorderIssueTypesInIssueTypeScheme

      Object reorderIssueTypesInIssueTypeScheme(@NotNull @NotNull Long issueTypeSchemeId, @NotNull @NotNull OrderOfIssueTypes orderOfIssueTypes)
      Change order of issue types

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeSchemeId - The ID of the issue type scheme. (required)
      orderOfIssueTypes - (required)

    • replaceIssueFieldOption

      void replaceIssueFieldOption(@NotNull @NotNull String fieldKey, @NotNull @NotNull Long optionId, @Nullable @Nullable Long replaceWith, @Nullable @Nullable String jql, @Nullable @Nullable Boolean overrideScreenSecurity, @Nullable @Nullable Boolean overrideEditableFlag)
      Replace issue field option

      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](https://confluence.atlassian.com/x/x4dKLg) can override the screen security configuration using overrideScreenSecurity and overrideEditableFlag. This is an [asynchronous operation](#async). 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](#api-group-Issue-custom-field-options) resource. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldKey - The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the fieldKey value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the jiraIssueFields module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field" (required)
      optionId - The ID of the option to be deselected. (required)
      replaceWith - The ID of the option that will replace the currently selected option. (optional)
      jql - A JQL query that specifies the issues to be updated. For example, *project=10000*. (optional)
      overrideScreenSecurity - Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with admin permission. (optional, defaults to false)
      overrideEditableFlag - Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, defaults to false)

    • resetColumns

      void resetColumns(@NotNull @NotNull Long id)
      Reset columns

      Reset the user's column configuration for the filter to the default. **[Permissions](#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](https://confluence.atlassian.com/x/yodKLg) for. * filters shared with a public project. * filters shared with the public. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      id - The ID of the filter. (required)

    • resetUserColumns

      void resetUserColumns(@Nullable @Nullable String accountId, @Nullable @Nullable String username)
      Reset user default columns

      Resets the default [ issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user to the system default. If accountId is not passed, the calling user's default columns are reset. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on any user. * Permission to access Jira, to set the calling user's columns.

      Parameters:
      accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. (optional)
      username - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)

    • restore

      Project restore(@NotNull @NotNull String projectIdOrKey)
      Restore deleted or archived project

      Restores a project that has been archived or placed in the Jira recycle bin. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)for Company managed projects. * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project for Team managed projects. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)

    • restoreCustomField

      Object restoreCustomField(@NotNull @NotNull String id)
      Restore custom field from trash

      Restores a custom field from trash. See [Edit or delete a custom field](https://confluence.atlassian.com/x/Z44fOw) for more information on trashing and deleting custom fields. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of a custom field. (required)

    • sanitiseJqlQueries

      SanitizedJqlQueries sanitiseJqlQueries(@NotNull @NotNull JqlQueriesToSanitize jqlQueriesToSanitize)
      Sanitize JQL queries

      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](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql/#api-rest-api-3-jql-sanitize-post). Before sanitization each JQL query is parsed. The queries are returned in the same order that they were passed. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      jqlQueriesToSanitize - (required)

    • search

      PageOfStatuses search(@Nullable @Nullable String expand, @Nullable @Nullable String projectId, @Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable String searchString, @Nullable @Nullable String statusCategory)
      Search statuses paginated

      Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of statuses that match a search on name or project. **[Permissions](#permissions) required:** * *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg) * *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg) Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * usages Returns the project and issue types that use the status in their workflow. * workflowUsages Returns the workflows that use the status. (optional)
      projectId - The project the status is part of or null for global statuses. (optional)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 200)
      searchString - Term to match status names against or null to search for all statuses in the search scope. (optional)
      statusCategory - Category of the status to filter by. The supported values are: TODO, IN_PROGRESS, and DONE. (optional)

    • searchForIssuesUsingJql

      SearchResults searchForIssuesUsingJql(@Nullable @Nullable String jql, @Nullable @Nullable Integer startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable String validateQuery, @Nullable @Nullable List<String> fields, @Nullable @Nullable String expand, @Nullable @Nullable List<String> properties, @Nullable @Nullable Boolean fieldsByKeys)
      Search for issues using JQL (GET)

      Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). If the JQL query expression is too large to be encoded as a query parameter, use the [POST](#api-rest-api-3-search-post) version of this resource. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Issues are included in the response where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      jql - The [JQL](https://confluence.atlassian.com/x/egORLQ) that defines the search. Note: * If no JQL expression is provided, all issues are returned. * username and userkey cannot be used as search terms due to privacy reasons. Use accountId instead. * 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. (optional)
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. To manage page size, Jira may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting id or key only. (optional, defaults to 50)
      validateQuery - Determines how to validate the JQL query and treat the validation results. Supported values are: * strict Returns a 400 response code if any errors are found, along with a list of all errors (and warnings). * warn Returns all errors as warnings. * none No validation is performed. * true *Deprecated* A legacy synonym for strict. * false *Deprecated* A legacy synonym for warn. Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the validateQuery value. (optional, defaults to strict)
      fields - A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: * *all Returns all fields. * *navigable Returns navigable fields. * Any issue field, prefixed with a minus to exclude. Examples: * summary,comment Returns only the summary and comments fields. * -description Returns all navigable (default) fields except description. * *all,-comment Returns all fields except comments. This parameter may be specified multiple times. For example, fields=field1,field2&amp;fields=field3. Note: All navigable fields are returned by default. This differs from [GET issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields. (optional)
      expand - Use [expand](#expansion) to include additional information about issues in the response. This parameter accepts a comma-separated list. Expand options include: * renderedFields Returns field values rendered in HTML format. * names Returns the display name of each field. * schema Returns the schema describing a field type. * transitions Returns all possible transitions for the issue. * operations Returns all possible operations for the issue. * editmeta Returns information about how each field can be edited. * changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * versionedRepresentations Instead of fields, returns versionedRepresentations a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version. (optional)
      properties - A list of issue property keys for issue properties to include in the results. This parameter accepts a comma-separated list. Multiple properties can also be provided using an ampersand separated list. For example, properties=prop1,prop2&amp;properties=prop3. A maximum of 5 issue property keys can be specified. (optional)
      fieldsByKeys - Reference fields by their key (rather than ID). (optional, defaults to false)

    • searchForIssuesUsingJqlPost

      SearchResults searchForIssuesUsingJqlPost(@NotNull @NotNull SearchRequestBean searchRequestBean)
      Search for issues using JQL (POST)

      Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). There is a [GET](#api-rest-api-3-search-get) version of this resource that can be used for smaller JQL query expressions. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Issues are included in the response where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      searchRequestBean - A JSON object containing the search request. (required)

    • searchPriorities

      PageBeanPriority searchPriorities(@Nullable @Nullable String startAt, @Nullable @Nullable String maxResults, @Nullable @Nullable List<String> id, @Nullable @Nullable List<String> projectId, @Nullable @Nullable String priorityName, @Nullable @Nullable Boolean onlyDefault)
      Search priorities

      Returns a [paginated](#pagination) 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. * a list of project IDs. Only priorities that are available in these projects will be returned. Any invalid project 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](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      id - The list of priority IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=2&amp;id=3. (optional)
      projectId - The list of projects IDs. To include multiple IDs, provide an ampersand-separated list. For example, projectId=10010&amp;projectId=10111. (optional)
      priorityName - The name of priority to search for. (optional)
      onlyDefault - Whether only the default priority is returned. (optional, defaults to false)

    • searchProjects

      PageBeanProject searchProjects(@Nullable @Nullable Long startAt, @Nullable @Nullable Integer maxResults, @Nullable @Nullable String orderBy, @Nullable @Nullable Set<Long> id, @Nullable @Nullable Set<String> keys, @Nullable @Nullable String query, @Nullable @Nullable String typeKey, @Nullable @Nullable Long categoryId, @Nullable @Nullable String action, @Nullable @Nullable String expand, @Nullable @Nullable List<String> status, @Nullable @Nullable List<Object> properties, @Nullable @Nullable String propertyQuery)
      Get projects paginated

      Returns a [paginated](#pagination) list of projects visible to the user. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Projects are returned only where the user has one of: * *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [read:jira-work]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      orderBy - [Order](#ordering) the results by a field. * category Sorts by project category. A complete list of category IDs is found using [Get all project categories](#api-rest-api-3-projectCategory-get). * issueCount Sorts by the total number of issues in each project. * key Sorts by project key. * lastIssueUpdatedTime Sorts by the last issue update time. * name Sorts by project name. * owner Sorts by project lead. * archivedDate EXPERIMENTAL. Sorts by project archived date. * deletedDate EXPERIMENTAL. Sorts by project deleted date. (optional, defaults to key)
      id - The project IDs to filter the results by. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&amp;id=10001. Up to 50 project IDs can be provided. (optional)
      keys - The project keys to filter the results by. To include multiple keys, provide an ampersand-separated list. For example, keys=PA&amp;keys=PB. Up to 50 project keys can be provided. (optional)
      query - Filter the results using a literal string. Projects with a matching key or name are returned (case insensitive). (optional)
      typeKey - Orders results by the [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes). This parameter accepts a comma-separated list. Valid values are business, service_desk, and software. (optional)
      categoryId - The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-3-projectCategory-get) operation. (optional)
      action - Filter results by projects for which the user can: * view the project, meaning that they have one of the following permissions: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * browse the project, meaning that they have the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * edit the project, meaning that they have one of the following permissions: * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * create the project, meaning that they have the *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the issue is created. (optional, defaults to view)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: * description Returns the project description. * projectKeys Returns all project keys associated with a project. * lead Returns information about the project lead. * issueTypes Returns all issue types associated with the project. * url Returns the URL associated with the project. * insight EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project. (optional)
      status - EXPERIMENTAL. Filter results by project status: * live Search live projects. * archived Search archived projects. * deleted Search deleted projects, those in the recycle bin. (optional)
      properties - EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list. (optional)
      propertyQuery - EXPERIMENTAL. A query string used to search properties. The query string cannot be specified using a JSON object. For example, to search for the value of nested from {"something":{"nested":1,"other":2}} use [thepropertykey].something.nested=1. Note that the propertyQuery key is enclosed in square brackets to enable searching where the propertyQuery key includes dot (.) or equals (=) characters. Note that thepropertykey is only returned when included in properties. (optional)

    • searchProjectsUsingSecuritySchemes

      PageBeanIssueSecuritySchemeToProjectMapping searchProjectsUsingSecuritySchemes(@Nullable @Nullable String startAt, @Nullable @Nullable String maxResults, @Nullable @Nullable Set<String> issueSecuritySchemeId, @Nullable @Nullable Set<String> projectId)
      Get projects using issue security schemes

      Returns a [paginated](#pagination) mapping of projects that are using security schemes. You can provide either one or multiple security scheme IDs or project IDs to filter by. If you don't provide any, this will return a list of all mappings. Only issue security schemes in the context of classic projects are supported. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      issueSecuritySchemeId - The list of security scheme IDs to be filtered out. (optional)
      projectId - The list of project IDs to be filtered out. (optional)

    • searchResolutions

      PageBeanResolutionJsonBean searchResolutions(@Nullable @Nullable String startAt, @Nullable @Nullable String maxResults, @Nullable @Nullable List<String> id, @Nullable @Nullable Boolean onlyDefault)
      Search resolutions

      Returns a [paginated](#pagination) 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](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      id - The list of resolutions IDs to be filtered out (optional)
      onlyDefault - When set to true, return default only, when IDs provided, if none of them is default, return empty page. Default value is false (optional, defaults to false)

    • searchSecuritySchemes

      PageBeanSecuritySchemeWithProjects searchSecuritySchemes(@Nullable @Nullable String startAt, @Nullable @Nullable String maxResults, @Nullable @Nullable Set<String> id, @Nullable @Nullable Set<String> projectId)
      Search issue security schemes

      Returns a paginated list of issue security schemes. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset). (optional, defaults to 0)
      maxResults - The maximum number of items to return per page. (optional, defaults to 50)
      id - The list of issue security scheme IDs. To include multiple issue security scheme IDs, separate IDs with an ampersand: id=10000&amp;id=10001. (optional)
      projectId - The list of project IDs. To include multiple project IDs, separate IDs with an ampersand: projectId=10000&amp;projectId=10001. (optional)

    • selectTimeTrackingImplementation

      Object selectTimeTrackingImplementation(@NotNull @NotNull TimeTrackingProvider timeTrackingProvider)
      Select time tracking provider

      Selects a time tracking provider. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      timeTrackingProvider - (required)

    • serviceRegistryResourceServicesGet

      List<ServiceRegistry> serviceRegistryResourceServicesGet(@NotNull @NotNull List<String> serviceIds)
      Retrieve the attributes of service registries

      Retrieve the attributes of given service registries. **[Permissions](#permissions) required:** Only Connect apps can make this request and the servicesIds belong to the tenant you are requesting

      Parameters:
      serviceIds - The ID of the services (the strings starting with "b:" need to be decoded in Base64). (required)

    • setActors

      ProjectRole setActors(@NotNull @NotNull String projectIdOrKey, @NotNull @NotNull Long id, @NotNull @NotNull ProjectRoleActorsUpdateBean projectRoleActorsUpdateBean)
      Set actors for project role

      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](#api-rest-api-3-project-projectIdOrKey-role-id-post). **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)
      id - The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. (required)
      projectRoleActorsUpdateBean - The groups or users to associate with the project role for this project. Provide the user account ID, group name, or group ID. As a group's name can change, use of group ID is recommended. (required)

    • setApplicationProperty

      ApplicationProperty setApplicationProperty(@NotNull @NotNull String id, @NotNull @NotNull SimpleApplicationPropertyBean simpleApplicationPropertyBean)
      Set application property

      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](https://confluence.atlassian.com/x/vYXKM). | 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.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](https://confluence.atlassian.com/x/VwCLLg). | Key | Description | Default value | | -- | -- | -- | | jira.lf.date.time | The [ time format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html). | h:mm a | | jira.lf.date.day | The [ day format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html). | EEEE h:mm a | | jira.lf.date.complete | The [ date and time format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html). | dd/MMM/yy h:mm a | | jira.lf.date.dmy | The [ date format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html). | 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](https://confluence.atlassian.com/x/vYXKM).* **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The key of the application property to update. (required)
      simpleApplicationPropertyBean - (required)

    • setBanner

      Object setBanner(@NotNull @NotNull AnnouncementBannerConfigurationUpdate announcementBannerConfigurationUpdate)
      Update announcement banner configuration

      Updates the announcement banner configuration. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      announcementBannerConfigurationUpdate - (required)

    • setColumns

      Object setColumns(@NotNull @NotNull Long id, @Nullable @Nullable List<String> requestBody)
      Set columns

      Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](#api-rest-api-3-field-get) 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](#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](https://confluence.atlassian.com/x/yodKLg) for. * filters shared with a public project. * filters shared with the public. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      id - The ID of the filter. (required)
      requestBody - The IDs of the fields to set as columns. In the form data, specify each field as columns=id, where id is the *id* of a field (as seen in the response for [Get fields](#api-rest-api-&lt;ver&gt;-field-get)). For example, columns=summary. (optional)

    • setCommentProperty

      Object setCommentProperty(@NotNull @NotNull String commentId, @NotNull @NotNull String propertyKey, @NotNull @NotNull Object body)
      Set comment property

      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](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters. **[Permissions](#permissions) required:** either of: * *Edit All Comments* [project permission](https://confluence.atlassian.com/x/yodKLg) to create or update the value of a property on any comment. * *Edit Own Comments* [project permission](https://confluence.atlassian.com/x/yodKLg) 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. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      commentId - The ID of the comment. (required)
      propertyKey - The key of the property. The maximum length is 255 characters. (required)
      body - (required)

    • setDashboardItemProperty

      Object setDashboardItemProperty(@NotNull @NotNull String dashboardId, @NotNull @NotNull String itemId, @NotNull @NotNull String propertyKey, @NotNull @NotNull Object body)
      Set dashboard item property

      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](https://confluence.atlassian.com/x/7AeiLQ). 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](https://developer.atlassian.com/server/jira/platform/guide-building-a-dashboard-item-for-a-jira-connect-add-on-33746254/) and the [Dashboard Item](https://developer.atlassian.com/cloud/jira/platform/modules/dashboard-item/) documentation. There is no resource to set or get dashboard items. The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously. **[Permissions](#permissions) required:** The user must be the owner of the dashboard. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      dashboardId - The ID of the dashboard. (required)
      itemId - The ID of the dashboard item. (required)
      propertyKey - The key of the dashboard item property. The maximum length is 255 characters. For dashboard items with a spec URI and no complete module key, if the provided propertyKey is equal to "config", the request body's JSON must be an object with all keys and values as strings. (required)
      body - The request containing the value of the dashboard item's property. (required)

    • setDefaultLevels

      Object setDefaultLevels(@NotNull @NotNull SetDefaultLevelsRequest setDefaultLevelsRequest)
      Set default issue security levels

      Sets default issue security levels for schemes. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      setDefaultLevelsRequest - (required)

    • setDefaultPriority

      Object setDefaultPriority(@NotNull @NotNull SetDefaultPriorityRequest setDefaultPriorityRequest)
      Set default priority

      Sets default issue priority. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      setDefaultPriorityRequest - (required)

    • setDefaultResolution

      Object setDefaultResolution(@NotNull @NotNull SetDefaultResolutionRequest setDefaultResolutionRequest)
      Set default resolution

      Sets default issue resolution. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      setDefaultResolutionRequest - (required)

    • setDefaultShareScope

      DefaultShareScope setDefaultShareScope(@NotNull @NotNull DefaultShareScope defaultShareScope)
      Set default share scope

      Sets the default sharing for new filters and dashboards for a user. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      defaultShareScope - (required)

    • setDefaultValues

      Object setDefaultValues(@NotNull @NotNull String fieldId, @NotNull @NotNull CustomFieldContextDefaultValueUpdate customFieldContextDefaultValueUpdate)
      Set custom field contexts default values

      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](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/#data-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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field. (required)
      customFieldContextDefaultValueUpdate - (required)

    • setFavouriteForFilter

      Filter setFavouriteForFilter(@NotNull @NotNull Long id, @Nullable @Nullable String expand)
      Add filter as favorite

      Add a filter as a favorite for the user. **[Permissions](#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](https://confluence.atlassian.com/x/yodKLg) for. * filters shared with a public project. * filters shared with the public. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      id - The ID of the filter. (required)
      expand - Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. * subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000]. (optional)

    • setFieldConfigurationSchemeMapping

      Object setFieldConfigurationSchemeMapping(@NotNull @NotNull Long id, @NotNull @NotNull AssociateFieldConfigurationsWithIssueTypesRequest associateFieldConfigurationsWithIssueTypesRequest)
      Assign issue types to field configurations

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the field configuration scheme. (required)
      associateFieldConfigurationsWithIssueTypesRequest - (required)

    • setIssueNavigatorDefaultColumns

      void setIssueNavigatorDefaultColumns(@NotNull @NotNull ColumnRequestBody columnRequestBody)
      Set issue navigator default columns

      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](#api-rest-api-3-field-get). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

      Parameters:
      columnRequestBody - A navigable field value. (required)

    • setIssueProperty

      Object setIssueProperty(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String propertyKey, @NotNull @NotNull Object body)
      Set issue property

      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](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      propertyKey - The key of the issue property. The maximum length is 255 characters. (required)
      body - (required)

    • setIssueTypeProperty

      Object setIssueTypeProperty(@NotNull @NotNull String issueTypeId, @NotNull @NotNull String propertyKey, @NotNull @NotNull Object body)
      Set issue type property

      Creates or updates the value of the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties). Use this resource to store and update data against an issue type. The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeId - The ID of the issue type. (required)
      propertyKey - The key of the issue type property. The maximum length is 255 characters. (required)
      body - (required)

    • setLocale

      @Deprecated Object setLocale(@NotNull @NotNull Locale locale)
      Deprecated.
      Set locale

      Deprecated, use [ Update a user profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) 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](#permissions) required:** Permission to access Jira.

      Parameters:
      locale - The locale defined in a LocaleBean. (required)

    • setPreference

      Object setPreference(@NotNull @NotNull String key, @NotNull @NotNull String body)
      Set preference

      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.default.share.private* Whether new [ filters](https://confluence.atlassian.com/x/eQiiLQ) 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. These system preferences keys will be deprecated by 15/07/2024. You can still use these keys to create arbitrary preferences, but it will not have any impact on Notification behaviour. * *user.notifiy.own.changes* Whether the user gets notified of their own changes. * *user.notifications.watcher* Whether the user gets notified when they are watcher. * *user.notifications.assignee* Whether the user gets notified when they are assignee. * *user.notifications.reporter* Whether the user gets notified when they are reporter. * *user.notifications.mentions* Whether the user gets notified when they are mentions. Use [ Update a user profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) from the user management REST API to manage timezone and locale instead. **[Permissions](#permissions) required:** Permission to access Jira. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      key - The key of the preference. The maximum length is 255 characters. (required)
      body - The value of the preference as a plain text string. The maximum length is 255 characters. (required)

    • setProjectProperty

      Object setProjectProperty(@NotNull @NotNull String projectIdOrKey, @NotNull @NotNull String propertyKey, @NotNull @NotNull Object body)
      Set project property

      Sets the value of the [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties). You can use project properties to store custom data against the project. The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the property is created. Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)
      propertyKey - The key of the project property. The maximum length is 255 characters. (required)
      body - (required)

    • setSharedTimeTrackingConfiguration

      TimeTrackingConfiguration setSharedTimeTrackingConfiguration(@NotNull @NotNull TimeTrackingConfiguration timeTrackingConfiguration)
      Set time tracking settings

      Sets the time tracking settings. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      timeTrackingConfiguration - (required)

    • setUserColumns

      Object setUserColumns(@NotNull @NotNull UserColumnRequestBody userColumnRequestBody, @Nullable @Nullable String accountId)
      Set user default columns

      Sets the default [ issue table columns](https://confluence.atlassian.com/x/XYdKLg) 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](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on any user. * Permission to access Jira, to set the calling user's columns.

      Parameters:
      userColumnRequestBody - The ID of a column to set. To set multiple columns, send multiple columns parameters. (required)
      accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. (optional)

    • setUserProperty

      Object setUserProperty(@NotNull @NotNull String propertyKey, @NotNull @NotNull Object body, @Nullable @Nullable String accountId, @Nullable @Nullable String userKey, @Nullable @Nullable String username)
      Set user property

      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](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set a property on any user. * Access to Jira, to set a property on the calling user's record. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      propertyKey - The key of the user's property. The maximum length is 255 characters. (required)
      body - The request containing the value of the property. The value has to a valid, non-empty JSON array. The maximum length is 32768 characters. (required)
      accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. (optional)
      userKey - This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)
      username - This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. (optional)

    • setWorkflowSchemeDraftIssueType

      WorkflowScheme setWorkflowSchemeDraftIssueType(@NotNull @NotNull Long id, @NotNull @NotNull String issueType, @NotNull @NotNull IssueTypeWorkflowMapping issueTypeWorkflowMapping)
      Set workflow for issue type in draft workflow scheme

      Sets the workflow for an issue type in a workflow scheme's draft. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme that the draft belongs to. (required)
      issueType - The ID of the issue type. (required)
      issueTypeWorkflowMapping - The issue type-project mapping. (required)

    • setWorkflowSchemeIssueType

      WorkflowScheme setWorkflowSchemeIssueType(@NotNull @NotNull Long id, @NotNull @NotNull String issueType, @NotNull @NotNull IssueTypeWorkflowMapping issueTypeWorkflowMapping)
      Set workflow for issue type in workflow scheme

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme. (required)
      issueType - The ID of the issue type. (required)
      issueTypeWorkflowMapping - The issue type-project mapping. (required)

    • setWorklogProperty

      Object setWorklogProperty(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String worklogId, @NotNull @NotNull String propertyKey, @NotNull @NotNull Object body)
      Set worklog property

      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](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * *Edit all worklogs*[ project permission](https://confluence.atlassian.com/x/yodKLg) 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. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      worklogId - The ID of the worklog. (required)
      propertyKey - The key of the issue property. The maximum length is 255 characters. (required)
      body - (required)

    • storeAvatar

      Avatar storeAvatar(@NotNull @NotNull String type, @NotNull @NotNull String entityId, @NotNull @NotNull Integer size, @NotNull @NotNull Object body, @Nullable @Nullable Integer x, @Nullable @Nullable Integer y)
      Load avatar

      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](#special-request-headers). * Content-Type: image/image type Valid image types are JPEG, GIF, or PNG. For example: curl --request POST --user [email protected]:&amp;lt;api_token&amp;gt; --header 'X-Atlassian-Token: no-check' --header 'Content-Type: image/&amp;lt; image_type&amp;gt;' --data-binary "&amp;lt;@/path/to/file/with/your/avatar&amp;gt;" --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](#api-rest-api-3-issuetype-id-put) to set it as the issue type's displayed avatar. * [Set project avatar](#api-rest-api-3-project-projectIdOrKey-avatar-put) to set it as the project's displayed avatar. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      type - The avatar type. (required)
      entityId - The ID of the item the avatar is associated with. (required)
      size - The length of each side of the crop region. (required)
      body - (required)
      x - The X coordinate of the top-left corner of the crop region. (optional, defaults to 0)
      y - The Y coordinate of the top-left corner of the crop region. (optional, defaults to 0)

    • toggleFeatureForProject

      ContainerForProjectFeatures toggleFeatureForProject(@NotNull @NotNull String projectIdOrKey, @NotNull @NotNull String featureKey, @NotNull @NotNull ProjectFeatureState projectFeatureState)
      Set project feature state

      Sets the state of a project feature. Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      projectIdOrKey - The ID or (case-sensitive) key of the project. (required)
      featureKey - The key of the feature. (required)
      projectFeatureState - Details of the feature state change. (required)

    • trashCustomField

      Object trashCustomField(@NotNull @NotNull String id)
      Move custom field to trash

      Moves a custom field to trash. See [Edit or delete a custom field](https://confluence.atlassian.com/x/Z44fOw) for more information on trashing and deleting custom fields. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of a custom field. (required)

    • unarchiveIssues

      IssueArchivalSyncResponse unarchiveIssues(@NotNull @NotNull IssueArchivalSyncRequest issueArchivalSyncRequest)
      Unarchive issue(s) by issue keys/ID

      Enables admins to unarchive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) unarchived in the process and the errors encountered, if any. **Note that:** * you can't unarchive subtasks directly, only through their parent issues * you can only unarchive issues from software, service management, and business projects **[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg) **License required:** Premium or Enterprise **Signed-in users only:** This API can't be accessed anonymously. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueArchivalSyncRequest - Contains a list of issue keys or IDs to be unarchived. (required)

    • updateComment

      Comment updateComment(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String id, @NotNull @NotNull Comment comment, @Nullable @Nullable Boolean notifyUsers, @Nullable @Nullable Boolean overrideEditableFlag, @Nullable @Nullable String expand)
      Update comment

      Updates a comment. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * *Edit all comments*[ project permission](https://confluence.atlassian.com/x/yodKLg) 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. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      id - The ID of the comment. (required)
      comment - (required)
      notifyUsers - Whether users are notified when a comment is updated. (optional, defaults to true)
      overrideEditableFlag - Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, defaults to false)
      expand - Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML. (optional)

    • updateComponent

      ProjectComponent updateComponent(@NotNull @NotNull String id, @NotNull @NotNull ProjectComponent projectComponent)
      Update component

      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](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the component or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      id - The ID of the component. (required)
      projectComponent - (required)

    • updateCustomField

      Object updateCustomField(@NotNull @NotNull String fieldId, @NotNull @NotNull UpdateCustomFieldDetails updateCustomFieldDetails)
      Update custom field

      Updates a custom field. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field. (required)
      updateCustomFieldDetails - The custom field update details. (required)

    • updateCustomFieldConfiguration

      Object updateCustomFieldConfiguration(@NotNull @NotNull String fieldIdOrKey, @NotNull @NotNull CustomFieldConfigurations customFieldConfigurations)
      Update custom field configurations

      Update the configuration for contexts of a custom field of a [type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/) created by a [Forge app](https://developer.atlassian.com/platform/forge/). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the Forge app that created the custom field type. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldIdOrKey - The ID or key of the custom field, for example customfield_10000. (required)
      customFieldConfigurations - (required)

    • updateCustomFieldContext

      Object updateCustomFieldContext(@NotNull @NotNull String fieldId, @NotNull @NotNull Long contextId, @NotNull @NotNull CustomFieldContextUpdateDetails customFieldContextUpdateDetails)
      Update custom field context

      Updates a [ custom field context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field. (required)
      contextId - The ID of the context. (required)
      customFieldContextUpdateDetails - (required)

    • updateCustomFieldOption

      CustomFieldUpdatedContextOptionsList updateCustomFieldOption(@NotNull @NotNull String fieldId, @NotNull @NotNull Long contextId, @NotNull @NotNull BulkCustomFieldOptionUpdateRequest bulkCustomFieldOptionUpdateRequest)
      Update custom field options (context)

      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](#api-group-Issue-custom-field-options) resource**, it cannot be used with issue field select list options created by Connect apps. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldId - The ID of the custom field. (required)
      contextId - The ID of the context. (required)
      bulkCustomFieldOptionUpdateRequest - (required)

    • updateCustomFieldValue

      Object updateCustomFieldValue(@NotNull @NotNull String fieldIdOrKey, @NotNull @NotNull CustomFieldValueUpdateDetails customFieldValueUpdateDetails, @Nullable @Nullable Boolean generateChangelog)
      Update custom field value

      Updates the value of a custom field on one or more issues. Apps can only perform this operation on [custom fields](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/) and [custom field types](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/) declared in their own manifests. **[Permissions](#permissions) required:** Only the app that owns the custom field or custom field type can update its values with this operation.

      Parameters:
      fieldIdOrKey - The ID or key of the custom field. For example, customfield_10010. (required)
      customFieldValueUpdateDetails - (required)
      generateChangelog - Whether to generate a changelog for this update. (optional, defaults to true)

    • updateDashboard

      Dashboard updateDashboard(@NotNull @NotNull String id, @NotNull @NotNull DashboardDetails dashboardDetails)
      Update dashboard

      Updates a dashboard, replacing all the dashboard details with those provided. **[Permissions](#permissions) required:** None The dashboard to be updated must be owned by the user. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      id - The ID of the dashboard to update. (required)
      dashboardDetails - Replacement dashboard details. (required)

    • updateDefaultScreenScheme

      Object updateDefaultScreenScheme(@NotNull @NotNull String issueTypeScreenSchemeId, @NotNull @NotNull UpdateDefaultScreenScheme updateDefaultScreenScheme)
      Update issue type screen scheme default screen scheme

      Updates the default screen scheme of an issue type screen scheme. The default screen scheme is used for all unmapped issue types. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeScreenSchemeId - The ID of the issue type screen scheme. (required)
      updateDefaultScreenScheme - (required)

    • updateDefaultWorkflow

      WorkflowScheme updateDefaultWorkflow(@NotNull @NotNull Long id, @NotNull @NotNull DefaultWorkflow defaultWorkflow)
      Update default workflow

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme. (required)
      defaultWorkflow - The new default workflow. (required)

    • updateDraftDefaultWorkflow

      WorkflowScheme updateDraftDefaultWorkflow(@NotNull @NotNull Long id, @NotNull @NotNull DefaultWorkflow defaultWorkflow)
      Update draft default workflow

      Sets the default workflow for a workflow scheme's draft. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme that the draft belongs to. (required)
      defaultWorkflow - The object for the new default workflow. (required)

    • updateDraftWorkflowMapping

      WorkflowScheme updateDraftWorkflowMapping(@NotNull @NotNull Long id, @NotNull @NotNull String workflowName, @NotNull @NotNull IssueTypesWorkflowMapping issueTypesWorkflowMapping)
      Set issue types for workflow in workflow scheme

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme that the draft belongs to. (required)
      workflowName - The name of the workflow. (required)
      issueTypesWorkflowMapping - (required)

    • updateFieldConfiguration

      Object updateFieldConfiguration(@NotNull @NotNull Long id, @NotNull @NotNull FieldConfigurationDetails fieldConfigurationDetails)
      Update field configuration

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the field configuration. (required)
      fieldConfigurationDetails - (required)

    • updateFieldConfigurationItems

      Object updateFieldConfigurationItems(@NotNull @NotNull Long id, @NotNull @NotNull FieldConfigurationItemsDetails fieldConfigurationItemsDetails)
      Update field configuration items

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the field configuration. (required)
      fieldConfigurationItemsDetails - (required)

    • updateFieldConfigurationScheme

      Object updateFieldConfigurationScheme(@NotNull @NotNull Long id, @NotNull @NotNull UpdateFieldConfigurationSchemeDetails updateFieldConfigurationSchemeDetails)
      Update field configuration scheme

      Updates a field configuration scheme. This operation can only update field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the field configuration scheme. (required)
      updateFieldConfigurationSchemeDetails - The details of the field configuration scheme. (required)

    • updateFilter

      Filter updateFilter(@NotNull @NotNull Long id, @NotNull @NotNull Filter filter, @Nullable @Nullable String expand, @Nullable @Nullable Boolean overrideSharePermissions)
      Update filter

      Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing. **[Permissions](#permissions) required:** Permission to access Jira, however the user must own the filter. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      id - The ID of the filter to update. (required)
      filter - The filter to update. (required)
      expand - Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000]. * subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000]. (optional)
      overrideSharePermissions - EXPERIMENTAL: Whether share permissions are overridden to enable the addition of any share permissions to filters. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). (optional, defaults to false)

    • updateGadget

      Object updateGadget(@NotNull @NotNull Long dashboardId, @NotNull @NotNull Long gadgetId, @NotNull @NotNull DashboardGadgetUpdateRequest dashboardGadgetUpdateRequest)
      Update gadget on dashboard

      Changes the title, position, and color of the gadget on a dashboard. **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      dashboardId - The ID of the dashboard. (required)
      gadgetId - The ID of the gadget. (required)
      dashboardGadgetUpdateRequest - (required)

    • updateIssueFieldOption

      IssueFieldOption updateIssueFieldOption(@NotNull @NotNull String fieldKey, @NotNull @NotNull Long optionId, @NotNull @NotNull IssueFieldOption issueFieldOption)
      Update issue field option

      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](#api-group-Issue-custom-field-options) resource. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      fieldKey - The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the fieldKey value, do one of the following: * open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the jiraIssueFields module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager. * run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field" (required)
      optionId - The ID of the option to be updated. (required)
      issueFieldOption - (required)

    • updateIssueLinkType

      IssueLinkType updateIssueLinkType(@NotNull @NotNull String issueLinkTypeId, @NotNull @NotNull IssueLinkType issueLinkType)
      Update issue link type

      Updates an issue link type. To use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueLinkTypeId - The ID of the issue link type. (required)
      issueLinkType - (required)

    • updateIssueSecurityScheme

      Object updateIssueSecurityScheme(@NotNull @NotNull String id, @NotNull @NotNull UpdateIssueSecuritySchemeRequestBean updateIssueSecuritySchemeRequestBean)
      Update issue security scheme

      Updates the issue security scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the issue security scheme. (required)
      updateIssueSecuritySchemeRequestBean - (required)

    • updateIssueType

      IssueTypeDetails updateIssueType(@NotNull @NotNull String id, @NotNull @NotNull IssueTypeUpdateBean issueTypeUpdateBean)
      Update issue type

      Updates the issue type. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the issue type. (required)
      issueTypeUpdateBean - (required)

    • updateIssueTypeScheme

      Object updateIssueTypeScheme(@NotNull @NotNull Long issueTypeSchemeId, @NotNull @NotNull IssueTypeSchemeUpdateDetails issueTypeSchemeUpdateDetails)
      Update issue type scheme

      Updates an issue type scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeSchemeId - The ID of the issue type scheme. (required)
      issueTypeSchemeUpdateDetails - (required)

    • updateIssueTypeScreenScheme

      Object updateIssueTypeScreenScheme(@NotNull @NotNull String issueTypeScreenSchemeId, @NotNull @NotNull IssueTypeScreenSchemeUpdateDetails issueTypeScreenSchemeUpdateDetails)
      Update issue type screen scheme

      Updates an issue type screen scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      issueTypeScreenSchemeId - The ID of the issue type screen scheme. (required)
      issueTypeScreenSchemeUpdateDetails - The issue type screen scheme update details. (required)

    • updateMultipleCustomFieldValues

      Object updateMultipleCustomFieldValues(@NotNull @NotNull MultipleCustomFieldValuesUpdateDetails multipleCustomFieldValuesUpdateDetails, @Nullable @Nullable Boolean generateChangelog)
      Update custom fields

      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. Apps can only perform this operation on [custom fields](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/) and [custom field types](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/) declared in their own manifests. **[Permissions](#permissions) required:** Only the app that owns the custom field or custom field type can update its values with this operation.

      Parameters:
      multipleCustomFieldValuesUpdateDetails - (required)
      generateChangelog - Whether to generate a changelog for this update. (optional, defaults to true)

    • updateNotificationScheme

      Object updateNotificationScheme(@NotNull @NotNull String id, @NotNull @NotNull UpdateNotificationSchemeDetails updateNotificationSchemeDetails)
      Update notification scheme

      Updates a notification scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the notification scheme. (required)
      updateNotificationSchemeDetails - (required)

    • updatePermissionScheme

      PermissionScheme updatePermissionScheme(@NotNull @NotNull Long schemeId, @NotNull @NotNull PermissionScheme permissionScheme, @Nullable @Nullable String expand)
      Update permission scheme

      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](#api-rest-api-3-permissionscheme-schemeId-permission-post) or [Delete permission scheme entity](#api-rest-api-3-permissionscheme-schemeId-permission-permissionId-delete). See [About permission schemes and grants](../api-group-permission-schemes/#about-permission-schemes-and-grants) for more details. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      schemeId - The ID of the permission scheme to update. (required)
      permissionScheme - (required)
      expand - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: * all Returns all expandable information. * field Returns information about the custom field granted the permission. * group Returns information about the group that is granted the permission. * permissions Returns all permission grants for each permission scheme. * projectRole Returns information about the project role granted the permission. * user Returns information about the user who is granted the permission. (optional)

    • updatePrecomputations

      Object updatePrecomputations(@NotNull @NotNull JqlFunctionPrecomputationUpdateRequestBean jqlFunctionPrecomputationUpdateRequestBean)
      Update precomputations (apps)

      Update the precomputation value of a function created by a Forge/Connect app. **[Permissions](#permissions) required:** An API for apps to update their own precomputations.

      Parameters:
      jqlFunctionPrecomputationUpdateRequestBean - (required)

    • updatePriority

      Object updatePriority(@NotNull @NotNull String id, @NotNull @NotNull UpdatePriorityDetails updatePriorityDetails)
      Update priority

      Updates an issue priority. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the issue priority. (required)
      updatePriorityDetails - (required)

    • updateProject

      Project updateProject(@NotNull @NotNull String projectIdOrKey, @NotNull @NotNull UpdateProjectDetails updateProjectDetails, @Nullable @Nullable String expand)
      Update project

      Updates the [project details](https://confluence.atlassian.com/x/ahLpNw) of a project. All parameters are optional in the body of the request. Schemes will only be updated if they are included in the request, any omitted schemes will be left unchanged. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). is only needed when changing the schemes or project key. Otherwise you will only need *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive). (required)
      updateProjectDetails - The project details to be updated. (required)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include: * description The project description. * issueTypes The issue types associated with the project. * lead The project lead. * projectKeys All project keys associated with the project. (optional)

    • updateProjectAvatar

      Object updateProjectAvatar(@NotNull @NotNull String projectIdOrKey, @NotNull @NotNull Avatar avatar)
      Set project avatar

      Sets the avatar displayed for a project. Use [Load project avatar](#api-rest-api-3-project-projectIdOrKey-avatar2-post) to store avatars against the project, before using this operation to set the displayed avatar. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      projectIdOrKey - The ID or (case-sensitive) key of the project. (required)
      avatar - (required)

    • updateProjectCategory

      UpdatedProjectCategory updateProjectCategory(@NotNull @NotNull Long id, @NotNull @NotNull ProjectCategory projectCategory)
      Update project category

      Updates a project category. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      id - (required)
      projectCategory - (required)

    • updateProjectEmail

      Object updateProjectEmail(@NotNull @NotNull Long projectId, @NotNull @NotNull ProjectEmailAddress projectEmailAddress)
      Set project's sender email

      Sets the [project's sender email address](https://confluence.atlassian.com/x/dolKLg). If emailAddress is an empty string, the default email address is restored. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission.](https://confluence.atlassian.com/x/yodKLg) Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      projectId - The project ID. (required)
      projectEmailAddress - The project's sender email address to be set. (required)

    • updateRelatedWork

      VersionRelatedWork updateRelatedWork(@NotNull @NotNull String id, @NotNull @NotNull VersionRelatedWork versionRelatedWork)
      Update related work

      Updates the given related work. You can only update generic link related works via Rest APIs. Any archived version related works can't be edited. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Resolve issues:* and *Edit issues* [Managing project permissions](https://confluence.atlassian.com/adminjiraserver/managing-project-permissions-938847145.html) for the project that contains the version. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      id - The ID of the version to update the related work on. For the related work id, pass it to the input JSON. (required)
      versionRelatedWork - (required)

    • updateRemoteIssueLink

      Object updateRemoteIssueLink(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String linkId, @NotNull @NotNull RemoteIssueLinkRequest remoteIssueLinkRequest)
      Update remote issue link by ID

      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](https://confluence.atlassian.com/x/yoXKM). This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key of the issue. (required)
      linkId - The ID of the remote issue link. (required)
      remoteIssueLinkRequest - (required)

    • updateResolution

      Object updateResolution(@NotNull @NotNull String id, @NotNull @NotNull UpdateResolutionDetails updateResolutionDetails)
      Update resolution

      Updates an issue resolution. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the issue resolution. (required)
      updateResolutionDetails - (required)

    • updateSchemes

      Object updateSchemes(@NotNull @NotNull WorkflowSchemeUpdateRequest workflowSchemeUpdateRequest)
      Update workflow scheme

      Updates company-managed and team-managed project workflow schemes. This API doesn't have a concept of draft, so any changes made to a workflow scheme are immediately available. When changing the available statuses for issue types, an [asynchronous task](#async) migrates the issues as defined in the provided mappings. **[Permissions](#permissions) required:** * *Administer Jira* project permission to update all, including global-scoped, workflow schemes. * *Administer projects* project permission to update project-scoped workflow schemes. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      workflowSchemeUpdateRequest - (required)

    • updateScreen

      Screen updateScreen(@NotNull @NotNull Long screenId, @NotNull @NotNull UpdateScreenDetails updateScreenDetails)
      Update screen

      Updates a screen. Only screens used in classic projects can be updated. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      screenId - The ID of the screen. (required)
      updateScreenDetails - (required)

    • updateScreenScheme

      Object updateScreenScheme(@NotNull @NotNull String screenSchemeId, @NotNull @NotNull UpdateScreenSchemeDetails updateScreenSchemeDetails)
      Update screen scheme

      Updates a screen scheme. Only screen schemes used in classic projects can be updated. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      screenSchemeId - The ID of the screen scheme. (required)
      updateScreenSchemeDetails - The screen scheme update details. (required)

    • updateSecurityLevel

      Object updateSecurityLevel(@NotNull @NotNull String schemeId, @NotNull @NotNull String levelId, @NotNull @NotNull UpdateIssueSecurityLevelDetails updateIssueSecurityLevelDetails)
      Update issue security level

      Updates the issue security level. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      schemeId - The ID of the issue security scheme level belongs to. (required)
      levelId - The ID of the issue security level to update. (required)
      updateIssueSecurityLevelDetails - (required)

    • updateStatuses

      Object updateStatuses(@NotNull @NotNull StatusUpdateRequest statusUpdateRequest)
      Bulk update statuses

      Updates statuses by ID. **[Permissions](#permissions) required:** * *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg) * *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg) Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      statusUpdateRequest - The list of statuses that will be updated. (required)

    • updateUiModification

      Object updateUiModification(@NotNull @NotNull String uiModificationId, @NotNull @NotNull UpdateUiModificationDetails updateUiModificationDetails)
      Update UI modification

      Updates a UI modification. UI modification can only be updated by Forge apps. Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications. **[Permissions](#permissions) required:** * *None* if the UI modification is created without contexts. * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the UI modification is created with contexts. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      uiModificationId - The ID of the UI modification. (required)
      updateUiModificationDetails - Details of the UI modification. (required)

    • updateVersion

      Version updateVersion(@NotNull @NotNull String id, @NotNull @NotNull Version version)
      Update version

      Updates a project version. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version. Authentication - Required Scopes: [manage:jira-project]

      Parameters:
      id - The ID of the version. (required)
      version - (required)

    • updateWorkflowMapping

      WorkflowScheme updateWorkflowMapping(@NotNull @NotNull Long id, @NotNull @NotNull String workflowName, @NotNull @NotNull IssueTypesWorkflowMapping issueTypesWorkflowMapping)
      Set issue types for workflow in workflow scheme

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme. (required)
      workflowName - The name of the workflow. (required)
      issueTypesWorkflowMapping - (required)

    • updateWorkflowScheme

      WorkflowScheme updateWorkflowScheme(@NotNull @NotNull Long id, @NotNull @NotNull WorkflowScheme workflowScheme)
      Classic update workflow scheme

      Updates a company-manged project 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, *schemeId=10301*. (required)
      workflowScheme - (required)

    • updateWorkflowSchemeDraft

      WorkflowScheme updateWorkflowSchemeDraft(@NotNull @NotNull Long id, @NotNull @NotNull WorkflowScheme workflowScheme)
      Update draft workflow scheme

      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      id - The ID of the active workflow scheme that the draft was created from. (required)
      workflowScheme - (required)

    • updateWorkflowSchemeMappings

      WorkflowSchemeUpdateRequiredMappingsResponse updateWorkflowSchemeMappings(@NotNull @NotNull WorkflowSchemeUpdateRequiredMappingsRequest workflowSchemeUpdateRequiredMappingsRequest)
      Get required status mappings for workflow scheme update

      Gets the required status mappings for the desired changes to a workflow scheme. The results are provided per issue type and workflow. When updating a workflow scheme, status mappings can be provided per issue type, per workflow, or both. **[Permissions](#permissions) required:** * *Administer Jira* permission to update all, including global-scoped, workflow schemes. * *Administer projects* project permission to update project-scoped workflow schemes. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      workflowSchemeUpdateRequiredMappingsRequest - (required)

    • updateWorkflowTransitionProperty

      WorkflowTransitionProperty updateWorkflowTransitionProperty(@NotNull @NotNull Long transitionId, @NotNull @NotNull String key, @NotNull @NotNull String workflowName, @NotNull @NotNull WorkflowTransitionProperty workflowTransitionProperty, @Nullable @Nullable String workflowMode)
      Update workflow transition property

      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](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      transitionId - The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition. (required)
      key - The key of the property being updated, also known as the name of the property. Set this to the same value as the key defined in the request body. (required)
      workflowName - The name of the workflow that the transition belongs to. (required)
      workflowTransitionProperty - (required)
      workflowMode - The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited. (optional)

    • updateWorkflowTransitionRuleConfigurations

      WorkflowTransitionRulesUpdateErrors updateWorkflowTransitionRuleConfigurations(@NotNull @NotNull WorkflowTransitionRulesUpdate workflowTransitionRulesUpdate)
      Update workflow transition rule configurations

      Updates configuration of workflow transition rules. The following rule types are supported: * [post functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/) * [conditions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-condition/) * [validators](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-validator/) Only rules created by the calling [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) or [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps) 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](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules/#api-rest-api-3-workflow-rule-config-get). Rules are enabled if the disabled parameter is not provided. **[Permissions](#permissions) required:** Only [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) or [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps) apps can use this operation. Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      workflowTransitionRulesUpdate - (required)

    • updateWorkflows

      WorkflowUpdateResponse updateWorkflows(@NotNull @NotNull WorkflowUpdateRequest workflowUpdateRequest, @Nullable @Nullable String expand)
      Bulk update workflows

      Update workflows and related statuses. **[Permissions](#permissions) required:** * *Administer Jira* project permission to create all, including global-scoped, workflows * *Administer projects* project permissions to create project-scoped workflows Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      workflowUpdateRequest - (required)
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * workflows.usages Returns the project and issue types that each workflow is associated with. * statuses.usages Returns the project and issue types that each status is associated with. (optional)

    • updateWorklog

      Worklog updateWorklog(@NotNull @NotNull String issueIdOrKey, @NotNull @NotNull String id, @NotNull @NotNull Worklog worklog, @Nullable @Nullable Boolean notifyUsers, @Nullable @Nullable String adjustEstimate, @Nullable @Nullable String newEstimate, @Nullable @Nullable String expand, @Nullable @Nullable Boolean overrideEditableFlag)
      Update worklog

      Updates a worklog. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM). This operation can be accessed anonymously. **[Permissions](#permissions) required:** * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * *Edit all worklogs*[ project permission](https://confluence.atlassian.com/x/yodKLg) 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. Authentication - Required Scopes: [write:jira-work]

      Parameters:
      issueIdOrKey - The ID or key the issue. (required)
      id - The ID of the worklog. (required)
      worklog - (required)
      notifyUsers - Whether users watching the issue are notified by email. (optional, defaults to true)
      adjustEstimate - Defines how to update the issue's time estimate, the options are: * new Sets the estimate to a specific value, defined in newEstimate. * leave Leaves the estimate unchanged. * auto Updates the estimate by the difference between the original and updated value of timeSpent or timeSpentSeconds. (optional, defaults to auto)
      newEstimate - The value to set as the issue's remaining time estimate, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when adjustEstimate is new. (optional)
      expand - Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts properties, which returns worklog properties. (optional)
      overrideEditableFlag - Whether the worklog should be added to the issue even if the issue is not editable. For example, because the issue is closed. Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) can use this flag. (optional, defaults to false)

    • validateCreateWorkflows

      WorkflowValidationErrorList validateCreateWorkflows(@NotNull @NotNull WorkflowCreateValidateRequest workflowCreateValidateRequest)
      Validate create workflows

      Validate the payload for bulk create workflows. **[Permissions](#permissions) required:** * *Administer Jira* project permission to create all, including global-scoped, workflows * *Administer projects* project permissions to create project-scoped workflows Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      workflowCreateValidateRequest - (required)

    • validateProjectKey

      ErrorCollection validateProjectKey(@Nullable @Nullable String key)
      Validate project key

      Validates a project key by confirming the key is a valid string and not in use. **[Permissions](#permissions) required:** None. Authentication - Required Scopes: [read:jira-work]

      Parameters:
      key - The project key. (optional)

    • validateUpdateWorkflows

      WorkflowValidationErrorList validateUpdateWorkflows(@NotNull @NotNull WorkflowUpdateValidateRequestBean workflowUpdateValidateRequestBean)
      Validate update workflows

      Validate the payload for bulk update workflows. **[Permissions](#permissions) required:** * *Administer Jira* project permission to create all, including global-scoped, workflows * *Administer projects* project permissions to create project-scoped workflows Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      workflowUpdateValidateRequestBean - (required)

    • workflowCapabilities

      WorkflowCapabilities workflowCapabilities(@Nullable @Nullable String workflowId, @Nullable @Nullable String projectId, @Nullable @Nullable String issueTypeId)
      Get available workflow capabilities

      Get the list of workflow capabilities for a specific workflow using either the workflow ID, or the project and issue type ID pair. The response includes the scope of the workflow, defined as global/project-based, and a list of project types that the workflow is scoped to. It also includes all rules organised into their broad categories (conditions, validators, actions, triggers, screens) as well as the source location (Atlassian-provided, Connect, Forge). **[Permissions](#permissions) required:** * *Administer Jira* project permission to access all, including global-scoped, workflows * *Administer projects* project permissions to access project-scoped workflows The current list of Atlassian-provided rules: #### Validators #### A validator rule that checks if a user has the required permissions to execute the transition in the workflow. ##### Permission validator ##### A validator rule that checks if a user has the required permissions to execute the transition in the workflow. { "ruleKey": "system:check-permission-validator", "parameters": { "permissionKey": "ADMINISTER_PROJECTS" } } Parameters: * permissionKey The permission required to perform the transition. Allowed values: [built-in Jira permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions). ##### Parent or child blocking validator ##### A validator to block the child issue\\\\u2019s transition depending on the parent issue\\\\u2019s status. { "ruleKey" : "system:parent-or-child-blocking-validator" "parameters" : { "blocker" : "PARENT" "statusIds" : "1,2,3" } } Parameters: * blocker currently only supports PARENT. * statusIds a comma-separated list of status IDs. ##### Previous status validator ##### A validator that checks if an issue has transitioned through specified previous status(es) before allowing the current transition to occur. { "ruleKey": "system:previous-status-validator", "parameters": { "previousStatusIds": "10014", "mostRecentStatusOnly": "true" } } Parameters: * previousStatusIds a comma-separated list of status IDs, currently only support one ID. * mostRecentStatusOnly when true only considers the most recent status for the condition evaluation. Allowed values: true, false. ##### Validate a field value ##### A validation that ensures a specific field's value meets the defined criteria before allowing an issue to transition in the workflow. Depending on the rule type, the result will vary: ###### Field required ###### { "ruleKey": "system:validate-field-value", "parameters": { "ruleType": "fieldRequired", "fieldsRequired": "assignee", "ignoreContext": "true", "errorMessage": "An assignee must be set!" } } Parameters: * fieldsRequired the ID of the field that is required. For a custom field, it would look like customfield_123. * ignoreContext controls the impact of context settings on field validation. When set to true, the validator doesn't check a required field if its context isn't configured for the current issue. When set to false, the validator requires a field even if its context is invalid. Allowed values: true, false. * errorMessage is the error message to display if the user does not provide a value during the transition. A default error message will be shown if you don't provide one (Optional). ###### Field changed ###### { "ruleKey": "system:validate-field-value", "parameters": { "ruleType": "fieldChanged", "groupsExemptFromValidation": "6862ac20-8672-4f68-896d-4854f5efb79e", "fieldKey": "versions", "errorMessage": "Affect versions must be modified before transition" } } Parameters: * groupsExemptFromValidation a comma-separated list of group IDs to be exempt from the validation. * fieldKey the ID of the field that has changed. For a custom field, it would look like customfield_123. * errorMessage the error message to display if the user does not provide a value during the transition. A default error message will be shown if you don't provide one (Optional). ###### Field has a single value ###### { "ruleKey": "system:validate-field-value", "parameters": { "ruleType": "fieldHasSingleValue", "fieldKey": "created", "excludeSubtasks": "true" } } Parameters: * fieldKey the ID of the field to validate. For a custom field, it would look like customfield_123. * excludeSubtasks Option to exclude values copied from sub-tasks. Allowed values: true, false. ###### Field matches regular expression ###### { "ruleKey": "system:validate-field-value", "parameters": { "ruleType": "fieldMatchesRegularExpression", "regexp": "[0-9]{4}", "fieldKey": "description" } } Parameters: * regexp the regular expression used to validate the field\\\\u2019s content. * fieldKey the ID of the field to validate. For a custom field, it would look like customfield_123. ###### Date field comparison ###### { "ruleKey": "system:validate-field-value", "parameters": { "ruleType": "dateFieldComparison", "date1FieldKey": "duedate", "date2FieldKey": "customfield_10054", "includeTime": "true", "conditionSelected": "&gt;=" } } Parameters: * date1FieldKey the ID of the first field to compare. For a custom field, it would look like customfield_123. * date2FieldKey the ID of the second field to compare. For a custom field, it would look like customfield_123. * includeTime if true, compares both date and time. Allowed values: true, false. * conditionSelected the condition to compare with. Allowed values: &amp;gt;, &amp;gt;=, =, &amp;lt;=, &amp;lt;, !=. ###### Date range comparison ###### { "ruleKey": "system:validate-field-value", "parameters": { "ruleType": "windowDateComparison", "date1FieldKey": "customfield_10009", "date2FieldKey": "customfield_10054", "numberOfDays": "3" } } Parameters: * date1FieldKey the ID of the first field to compare. For a custom field, it would look like customfield_123. * date2FieldKey the ID of the second field to compare. For a custom field, it would look like customfield_123. * numberOfDays maximum number of days past the reference date (date2FieldKey) to pass validation. This rule is composed by aggregating the following legacy rules: * FieldRequiredValidator * FieldChangedValidator * FieldHasSingleValueValidator * RegexpFieldValidator * DateFieldValidator * WindowsDateValidator ##### Proforma: Forms attached validator ##### Validates that one or more forms are attached to the issue. { "ruleKey" : "system:proforma-forms-attached" "parameters" : {} } ##### Proforma: Forms submitted validator ##### Validates that all forms attached to the issue have been submitted. { "ruleKey" : "system:proforma-forms-submitted" "parameters" : {} } #### Conditions #### Conditions enable workflow rules that govern whether a transition can execute. ##### Check field value ##### A condition rule evaluates as true if a specific field's value meets the defined criteria. This rule ensures that an issue can only transition to the next step in the workflow if the field's value matches the desired condition. { "ruleKey": "system:check-field-value", "parameters": { "fieldId": "description", "fieldValue": "[\\"Done\\"]", "comparator": "=", "comparisonType": "STRING" } } Parameters: * fieldId The ID of the field to check the value of. For non-system fields, it will look like customfield_123. Note: fieldId is used interchangeably with the idea of fieldKey here, they refer to the same field. * fieldValue the list of values to check against the field\\\\u2019s value. * comparator The comparison logic. Allowed values: &amp;gt;, &amp;gt;=, =, &amp;lt;=, &amp;lt;, !=. * comparisonType The type of data being compared. Allowed values: STRING, NUMBER, DATE, DATE_WITHOUT_TIME, OPTIONID. ##### Restrict issue transition ##### This rule ensures that issue transitions are restricted based on user accounts, roles, group memberships, and permissions, maintaining control over who can transition an issue. This condition evaluates as true if any of the following criteria is met. { "ruleKey": "system:restrict-issue-transition", "parameters": { "accountIds": "allow-reporter,5e68ac137d64450d01a77fa0", "roleIds": "10002,10004", "groupIds": "703ff44a-7dc8-4f4b-9aa6-a65bf3574fa4", "permissionKeys": "ADMINISTER_PROJECTS", "groupCustomFields": "customfield_10028", "allowUserCustomFields": "customfield_10072,customfield_10144,customfield_10007", "denyUserCustomFields": "customfield_10107" } } Parameters: * accountIds a comma-separated list of the user account IDs. It also allows generic values like: allow-assignee, allow-reporter, and accountIds Note: This is only supported in team-managed projects * roleIds a comma-separated list of role IDs. * groupIds a comma-separated list of group IDs. * permissionKeys a comma-separated list of permission keys. Allowed values: [built-in Jira permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions). * groupCustomFields a comma-separated list of group custom field IDs. * allowUserCustomFields a comma-separated list of user custom field IDs to allow for issue transition. * denyUserCustomFields a comma-separated list of user custom field IDs to deny for issue transition. This rule is composed by aggregating the following legacy rules: * AllowOnlyAssignee * AllowOnlyReporter * InAnyProjectRoleCondition * InProjectRoleCondition * UserInAnyGroupCondition * UserInGroupCondition * PermissionCondtion * InGroupCFCondition * UserIsInCustomFieldCondition ##### Previous status condition ##### A condition that evaluates based on an issue's previous status(es) and specific criteria. { "ruleKey" : "system:previous-status-condition" "parameters" : { "previousStatusIds" : "10004", "not": "true", "mostRecentStatusOnly" : "true", "includeCurrentStatus": "true", "ignoreLoopTransitions": "true" } } Parameters: * previousStatusIds a comma-separated list of status IDs, current only support one ID. * not indicates if the condition should be reversed. When true it checks that the issue has not been in the selected statuses. Allowed values: true, false. * mostRecentStatusOnly when true only considers the most recent status for the condition evaluation. Allowed values: true, false. * includeCurrentStatus includes the current status when evaluating if the issue has been through the selected statuses. Allowed values: true, false. * ignoreLoopTransitions ignore loop transitions. Allowed values: true, false. ##### Parent or child blocking condition ##### A condition to block the parent\\\\u2019s issue transition depending on the child\\\\u2019s issue status. { "ruleKey" : "system:parent-or-child-blocking-condition" "parameters" : { "blocker" : "CHILD", "statusIds" : "1,2,3" } } Parameters: * blocker currently only supports CHILD. * statusIds a comma-separated list of status IDs. ##### Separation of duties ##### A condition preventing the user from performing, if the user has already performed a transition on the issue. { "ruleKey": "system:separation-of-duties", "parameters": { "fromStatusId": "10161", "toStatusId": "10160" } } Parameters: * fromStatusId represents the status ID from which the issue is transitioning. It ensures that the user performing the current transition has not performed any actions when the issue was in the specified status. * toStatusId represents the status ID to which the issue is transitioning. It ensures that the user performing the current transition is not the same user who has previously transitioned the issue. ##### Restrict transitions ##### A condition preventing all users from transitioning the issue can also optionally include APIs as well. { "ruleKey": "system:restrict-from-all-users", "parameters": { "restrictMode": "users" } } Parameters: * restrictMode restricts the issue transition including/excluding APIs. Allowed values: "users", "usersAndAPI". ##### Jira Service Management block until approved ##### Block an issue transition until approval. Note: This is only supported in team-managed projects. { "ruleKey": "system:jsd-approvals-block-until-approved", "parameters": { "approvalConfigurationJson": "{"statusExternalUuid...}" } } Parameters: * approvalConfigurationJson a stringified JSON holding the Jira Service Management approval configuration. ##### Jira Service Management block until rejected ##### Block an issue transition until rejected. Note: This is only supported in team-managed projects. { "ruleKey": "system:jsd-approvals-block-until-rejected", "parameters": { "approvalConfigurationJson": "{"statusExternalUuid...}" } } Parameters: * approvalConfigurationJson a stringified JSON holding the Jira Service Management approval configuration. ##### Block in progress approval ##### Condition to block issue transition if there is pending approval. Note: This is only supported in company-managed projects. { "ruleKey": "system:block-in-progress-approval", "parameters": {} } #### Post functions #### Post functions carry out any additional processing required after a workflow transition is executed. ##### Change assignee ##### A post function rule that changes the assignee of an issue after a transition. { "ruleKey": "system:change-assignee", "parameters": { "type": "to-selected-user", "accountId": "example-account-id" } } Parameters: * type the parameter used to determine the new assignee. Allowed values: to-selected-user, to-unassigned, to-current-user, to-current-user, to-default-user, to-default-user * accountId the account ID of the user to assign the issue to. This parameter is required only when the type is "to-selected-user". ##### Copy field value ##### A post function that automates the process of copying values between fields during a specific transition, ensuring data consistency and reducing manual effort. { "ruleKey": "system:copy-value-from-other-field", "parameters": { "sourceFieldKey": "description", "targetFieldKey": "components", "issueSource": "SAME" } } Parameters: * sourceFieldKey the field key to copy from. For a custom field, it would look like customfield_123 * targetFieldKey the field key to copy to. For a custom field, it would look like customfield_123 * issueSource SAME or PARENT. Defaults to SAME if no value is provided. ##### Update field ##### A post function that updates or appends a specific field with the given value. { "ruleKey": "system:update-field", "parameters": { "field": "customfield_10056", "value": "asdf", "mode": "append" } } Parameters: * field the ID of the field to update. For a custom field, it would look like customfield_123 * value the value to update the field with. * mode append or replace. Determines if a value will be appended to the current value, or if the current value will be replaced. ##### Trigger webhook ##### A post function that automatically triggers a predefined webhook when a transition occurs in the workflow. { "ruleKey": "system:trigger-webhook", "parameters": { "webhookId": "1" } } Parameters: * webhookId the ID of the webhook. #### Screen #### ##### Remind people to update fields ##### A screen rule that prompts users to update a specific field when they interact with an issue screen during a transition. This rule is useful for ensuring that users provide or modify necessary information before moving an issue to the next step in the workflow. { "ruleKey": "system:remind-people-to-update-fields", "params": { "remindingFieldIds": "assignee,customfield_10025", "remindingMessage": "The message", "remindingAlwaysAsk": "true" } } Parameters: * remindingFieldIds a comma-separated list of field IDs. Note: fieldId is used interchangeably with the idea of fieldKey here, they refer to the same field. * remindingMessage the message to display when prompting the users to update the fields. * remindingAlwaysAsk always remind to update fields. Allowed values: true, false. ##### Shared transition screen ##### A common screen that is shared between transitions in a workflow. { "ruleKey": "system:transition-screen", "params": { "screenId": "3" } } Parameters: * screenId the ID of the screen. #### Connect & Forge #### ##### Connect rules ##### Validator/Condition/Post function for Connect app. { "ruleKey": "connect:expression-validator", "parameters": { "appKey": "com.atlassian.app", "config": "", "id": "90ce590f-e90c-4cd3-8281-165ce41f2ac3", "disabled": "false", "tag": "" } } Parameters: * ruleKey Validator: connect:expression-validator, Condition: connect:expression-condition, and Post function: connect:remote-workflow-function * appKey the reference to the Connect app * config a JSON payload string describing the configuration * id the ID of the rule * disabled determine if the Connect app is disabled. Allowed values: true, false. * tag additional tags for the Connect app ##### Forge rules ##### Validator/Condition/Post function for Forge app. { "ruleKey": "forge:expression-validator", "parameters": { "key": "ari:cloud:ecosystem::extension/{appId}/{environmentId}/static/{moduleKey}", "config": "{"searchString":"workflow validator"}", "id": "a865ddf6-bb3f-4a7b-9540-c2f8b3f9f6c2" } } Parameters: * ruleKey Validator: forge:expression-validator, Condition: forge:expression-condition, and Post function: forge:workflow-post-function * key the identifier for the Forge app * config the persistent stringified JSON configuration for the Forge rule * id the ID of the Forge rule Authentication - Required Scopes: [manage:jira-configuration]

      Parameters:
      workflowId - (optional)
      projectId - (optional)
      issueTypeId - (optional)