{"openapi":"3.0.1","info":{"title":"The Jira Cloud platform REST API","description":"Jira Cloud platform REST API documentation","termsOfService":"http://atlassian.com/terms/","contact":{"email":"ecosystem@atlassian.com"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"version":"1001.0.0-SNAPSHOT-c6e6f311284817e9c01aab8af214be6da7c8ce07"},"externalDocs":{"description":"Find out more about Atlassian products and services.","url":"http://www.atlassian.com"},"servers":[{"url":"https://your-domain.atlassian.net"}],"tags":[{"name":"Announcement banner","description":"This resource represents an announcement banner. Use it to retrieve and update banner configuration."},{"name":"App data policies","description":"This resource represents app access rule data policies."},{"name":"Application roles","description":"This resource represents application roles. Use it to get details of an application role or all application roles."},{"name":"Audit records","description":"This resource represents audits that record activities undertaken in Jira. Use it to get a list of audit records."},{"name":"Avatars","description":"This resource represents system and custom avatars. Use it to obtain the details of system or custom avatars, add and remove avatars from a project or issue type, and obtain avatar images."},{"name":"Dashboards","description":"This resource represents dashboards. Use it to obtain the details of dashboards as well as get, create, update, or remove item properties and gadgets from dashboards."},{"name":"Filters","description":"This resource represents [filters](https://confluence.atlassian.com/x/eQiiLQ). Use it to get, create, update, or delete filters. Also use it to configure the columns for a filter and set favorite filters."},{"name":"Filter sharing","description":"This resource represents options for sharing [filters](#api-group-Filters). Use it to get share scopes as well as add and remove share scopes from filters."},{"name":"Group and user picker","description":"This resource represents a list of users and a list of groups. Use it to obtain the details to populate user and group picker suggestions list."},{"name":"Groups","description":"This resource represents groups of users. Use it to get, create, find, and delete groups as well as add and remove users from groups. (\\[WARNING\\] The standard Atlassian group names are default names only and can be edited or deleted. For example, an admin or Atlassian support could delete the default group jira-software-users or rename it to jsw-users at any point. See https://support.atlassian.com/user-management/docs/create-and-update-groups/ for details.)"},{"name":"Issues","description":"This resource represents Jira issues. Use it to:\n\n *  create or edit issues, individually or in bulk.\n *  retrieve metadata about the options for creating or editing issues.\n *  delete an issue.\n *  assign a user to an issue.\n *  get issue changelogs.\n *  send notifications about an issue.\n *  get details of the transitions available for an issue.\n *  transition an issue.\n *  Archive issues.\n *  Unarchive issues.\n *  Export archived issues."},{"name":"UI modifications (apps)","description":"UI modifications is a feature available for **Forge apps only**. It enables Forge apps to control how selected Jira fields behave on the following views: global issue create, issue view. For example: hide specific fields, set them as required, etc."},{"name":"Issue attachments","description":"This resource represents issue attachments and the attachment settings for Jira. Use it to get the metadata for an attachment, delete an attachment, and view the metadata for the contents of an attachment. Also, use it to get the attachment settings for Jira."},{"name":"Issue comments","description":"This resource represents issue comments. Use it to:\n\n *  get, create, update, and delete a comment from an issue.\n *  get all comments from issue.\n *  get a list of comments by comment ID."},{"name":"Issue comment properties","description":"This resource represents [issue comment](#api-group-Issue-comments) properties, which provides for storing custom data against an issue comment. Use is to get, set, and delete issue comment properties as well as obtain the keys of all properties on a comment. Comment properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)."},{"name":"Issue fields","description":"This resource represents issue fields, both system and custom fields. Use it to get fields, field configurations, and create custom fields."},{"name":"Issue field configurations","description":"This resource represents issue field configurations. Use it to get, set, and delete field configurations and field configuration schemes."},{"name":"Issue custom field contexts","description":"This resource represents issue custom field contexts. Use it to:\n\n *  get, create, update, and delete custom field contexts.\n *  get context to issue types and projects mappings.\n *  get custom field contexts for projects and issue types.\n *  assign custom field contexts to projects.\n *  remove custom field contexts from projects.\n *  add issue types to custom field contexts."},{"name":"Issue custom field options","description":"This resource represents custom issue field select list options created in Jira or using the REST API. This resource supports the following field types:\n\n *  Checkboxes.\n *  Radio Buttons.\n *  Select List (single choice).\n *  Select List (multiple choices).\n *  Select List (cascading).\n\nSee [Issue custom field options (apps)](#api-group-Issue-custom-field-options--apps-) to manipulate custom issue field select list options created by a Connect app.\n\nUse it to retrieve, create, update, order, and delete custom field options."},{"name":"Issue custom field options (apps)","description":"This resource represents custom issue field select list options created by a Connect app. See [Issue custom field options](#api-group-Issue-custom-field-options) to manipulate options created in Jira or using the REST API.\n\nA 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 an option from a list. Use it to add, remove, and update the options of a select list issue field."},{"name":"Issue custom field values (apps)","description":"This resource represents the values of custom fields added by [Forge apps](https://developer.atlassian.com/platform/forge/). Use it to update the value of a custom field on issues."},{"name":"Issue custom field configuration (apps)","description":"This resource represents configurations stored against a custom field context by a [Forge app](https://developer.atlassian.com/platform/forge/). Configurations are information used by the Forge app at runtime to determine how to handle or process the data in a custom field in a given context. Use this resource to set and read configurations."},{"name":"Issue links","description":"This resource represents links between issues. Use it to get, create, and delete links between issues.\n\nTo use it, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled."},{"name":"Issue link types","description":"This resource represents [issue link](#api-group-Issue-links) types. Use it to get, create, update, and delete link issue types as well as get lists of all link issue types.\n\nTo use it, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled."},{"name":"Issue navigator settings","description":"This resource represents issue navigator settings. Use it to get and set issue navigator default columns."},{"name":"Issue notification schemes","description":"This resource represents notification schemes, lists of events and the recipients who will receive notifications for those events. Use it to get details of a notification scheme and a list of notification schemes.\n\n### About notification schemes ###\n\nA notification scheme is a list of events and recipients who will receive notifications for those events. The list is contained within the `notificationSchemeEvents` object and contains pairs of `events` and `notifications`:\n\n *  `event` Identifies the type of event. The events can be [Jira system events](https://support.atlassian.com/jira-cloud-administration/docs/configure-notification-schemes/) (see the *Events* section) or [custom events](https://support.atlassian.com/jira-cloud-administration/docs/add-a-custom-event/).\n *  `notifications` Identifies the [recipients](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-recipientsRecipients) of notifications for each event. Recipients can be any of the following types:\n    \n     *  `CurrentAssignee`\n     *  `Reporter`\n     *  `CurrentUser`\n     *  `ProjectLead`\n     *  `ComponentLead`\n     *  `User` (the `parameter` is the user key)\n     *  `Group` (the `parameter` is the group name)\n     *  `ProjectRole` (the `parameter` is the project role ID)\n     *  `EmailAddress` *(deprecated)*\n     *  `AllWatchers`\n     *  `UserCustomField` (the `parameter` is the ID of the custom field)\n     *  `GroupCustomField`(the `parameter` is the ID of the custom field)"},{"name":"Issue priorities","description":"This resource represents issue priorities. Use it to get, create and update issue priorities and details for individual issue priorities."},{"name":"Issue properties","description":"This resource represents [issue](#api-group-Issues) properties, which provides for storing custom data against an issue. Use it to get, set, and delete issue properties as well as obtain details of all properties on an issue. Operations to bulk update and delete issue properties are also provided. Issue properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)."},{"name":"Issue remote links","description":"This resource represents remote issue links, a way of linking Jira to information in other systems. Use it to get, create, update, and delete remote issue links either by ID or global ID. The global ID provides a way of accessing remote issue links using information about the item's remote system host and remote system identifier."},{"name":"Issue resolutions","description":"This resource represents issue resolution values. Use it to obtain a list of all issue resolution values and the details of individual resolution values."},{"name":"Issue search","description":"This resource represents various ways to search for issues. Use it to search for issues with a JQL query and find issues to populate an issue picker."},{"name":"Issue security level","description":"This resource represents issue security levels. Use it to obtain the details of any issue security level. For more information about issue security levels, see [Configuring issue-level security](https://confluence.atlassian.com/x/J4lKLg)."},{"name":"Issue security schemes","description":"This resource represents issue security schemes. Use it to get an issue security scheme or a list of issue security schemes.\n\nIssue security schemes control which users or groups of users can view an issue. When an issue security scheme is associated with a project, its security levels can be applied to issues in that project. Sub-tasks also inherit the security level of their parent issue."},{"name":"Issue security scheme","description":"This resource represents issue security schemes, issue security levels, and issue security level members. Use it to get, create, update, and delete issue security schemes or issue security scheme details. Note that only company-managed (classic) projects are supported.\n\n### About issue security schemes ###\n\nIssue security schemes control which users or groups of users can view an issue. An issue security scheme is made up of multiple security levels. Each level can have users or groups of users assigned to it. The following are valid security level members:\n\n *  Individual users\n *  Groups of users\n *  Project roles\n *  Issue roles\n *  \"Anyone\", for example to allow anonymous access\n *  A (multi-)user or (multi-)group picker custom field"},{"name":"Issue types","description":"This resource represents issues types. Use it to:\n\n *  get, create, update, and delete issue types.\n *  get all issue types for a user.\n *  get alternative issue types.\n *  set an avatar for an issue type."},{"name":"Issue type schemes","description":"This resource represents issue type schemes in classic projects. Use it to:\n\n *  get issue type schemes and a list of the projects that use them.\n *  associate issue type schemes with projects.\n *  add issue types to issue type schemes.\n *  delete issue types from issue type schemes.\n *  create, update, and delete issue type schemes.\n *  change the order of issue types in issue type schemes."},{"name":"Issue type screen schemes","description":"This resource represents issue type screen schemes. Use it to:\n\n *  get issue type screen schemes and a list of the projects that use them.\n *  create issue type screen schemes.\n *  update issue type screen schemes.\n *  delete issue type screen schemes.\n *  associate issue type screen schemes with projects.\n *  append issue type to screen scheme mappings to issue type screen schemes.\n *  remove issue type to screen scheme mappings from issue type screen schemes.\n *  update default screen scheme of issue type screen scheme."},{"name":"Issue type properties","description":"This resource represents [issue type](#api-group-Issue-types) properties, which provides for storing custom data against an issue type. Use it to get, create, and delete issue type properties as well as obtain the keys of all properties on a issues type. Issue type properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)."},{"name":"Issue votes","description":"This resource represents votes cast by users on an issue. Use it to get details of votes on an issue as well as cast and withdrawal votes."},{"name":"Issue watchers","description":"This resource represents users watching an issue. Use it to get details of users watching an issue as well as start and stop a user watching an issue."},{"name":"Issue worklogs","description":"This resource represents issue worklogs. Use it to:\n\n *  get, create, update, and delete worklogs.\n *  obtain lists of updated or deleted worklogs."},{"name":"Issue worklog properties","description":"This resource represents [issue worklog](#api-group-Issue-worklogs) properties, which provides for storing custom data against an issue worklog. Use it to get, create, and delete issue worklog properties as well as obtain the keys of all properties on a issue worklog. Issue worklog properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)."},{"name":"Jira expressions","description":"This resource is a collection of operations for [Jira expressions](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/)."},{"name":"Jira settings","description":"This resource represents various settings in Jira. Use it to get and update Jira settings and properties."},{"name":"JQL","description":"This resource represents JQL search auto-complete details. Use it to obtain JQL search auto-complete data and suggestions for use in programmatic construction of queries or custom query builders. It also provides operations to:\n\n *  convert one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.\n *  convert readable details in one or more JQL queries to IDs where a user doesn't have permission to view the entity whose details are readable."},{"name":"JQL functions (apps)","description":"This resource represents JQL function's precomputations. Precomputation is a mapping between custom function call and JQL fragment returned by this function. Use it to get and update precomputations."},{"name":"Labels","description":"This resource represents available labels. Use it to get available labels for the global label field."},{"name":"License metrics","description":"This resource represents license metrics. Use it to get available metrics for Jira licences."},{"name":"Myself","description":"This resource represents information about the current user, such as basic details, group membership, application roles, preferences, and locale. Use it to get, create, update, and delete (restore default) values of the user's preferences and locale."},{"name":"Permissions","description":"This resource represents permissions. Use it to obtain details of all permissions and determine whether the user has certain permissions."},{"name":"Permission schemes","description":"This resource represents permission schemes. Use it to get, create, update, and delete permission schemes as well as get, create, update, and delete details of the permissions granted in those schemes."},{"name":"Projects","description":"This resource represents projects. Use it to get, create, update, and delete projects. Also get statuses available to a project, a project's notification schemes, and update a project's type."},{"name":"Project avatars","description":"This resource represents avatars associated with a project. Use it to get, load, set, and remove project avatars."},{"name":"Project categories","description":"This resource represents project categories. Use it to create, update, and delete project categories as well as obtain a list of all project categories and details of individual categories. For more information on managing project categories, see [Adding, assigning, and deleting project categories](https://confluence.atlassian.com/x/-A5WMg)."},{"name":"Project components","description":"This resource represents project components. Use it to get, create, update, and delete project components. Also get components for project and get a count of issues by component."},{"name":"Project email","description":"This resource represents the email address used to send a project's notifications. Use it to get and set the [project's sender email address](https://confluence.atlassian.com/x/dolKLg)."},{"name":"Project features","description":"This resource represents project features. Use it to get the list of features for a project and modify the state of a feature. The project feature endpoint is available only for Jira Software, both for team- and company-managed projects."},{"name":"Project key and name validation","description":"This resource provides validation for project keys and names."},{"name":"Project permission schemes","description":"This resource represents permission schemes for a project. Use this resource to:\n\n *  get details of a project's issue security levels available to the calling user.\n *  get the permission scheme associated with the project or assign different permission scheme to the project.\n *  get details of a project's issue security scheme.\n\nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for more information about permission schemes."},{"name":"Project properties","description":"This resource represents [project](#api-group-Projects) properties, which provides for storing custom data against a project. Use it to get, create, and delete project properties as well as get a list of property keys for a project. Project properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)."},{"name":"Project roles","description":"This resource represents the roles that users can play in projects. Use this resource to get, create, update, and delete project roles."},{"name":"Project role actors","description":"This resource represents the users assigned to [project roles](#api-group-Issue-comments). Use it to get, add, and remove default users from project roles. Also use it to add and remove users from a project role associated with a project."},{"name":"Project types","description":"This resource represents project types. Use it to obtain a list of all project types, a list of project types accessible to the calling user, and details of a project type."},{"name":"Project versions","description":"This resource represents project versions. Use it to get, get lists of, create, update, move, merge, and delete project versions. This resource also provides counts of issues by version."},{"name":"Screens","description":"This resource represents the screens used to record issue details. Use it to:\n\n *  get details of all screens.\n *  get details of all the fields available for use on screens.\n *  create screens.\n *  delete screens.\n *  update screens.\n *  add a field to the default screen."},{"name":"Screen tabs","description":"This resource represents the screen tabs used to record issue details. Use it to get, create, update, move, and delete screen tabs."},{"name":"Screen tab fields","description":"This resource represents the screen tab fields used to record issue details. Use it to get, add, move, and remove fields from screen tabs."},{"name":"Screen schemes","description":"This resource represents screen schemes in classic projects. Use it to get, create, update, and delete screen schemes."},{"name":"Server info","description":"This resource provides information about the Jira instance."},{"name":"Status","description":"This resource represents statuses. Use it to search, get, create, delete, and change statuses."},{"name":"Tasks","description":"This resource represents a [long-running asynchronous tasks](#async-operations). Use it to obtain details about the progress of a long-running task or cancel a long-running task."},{"name":"Time tracking","description":"This resource represents time tracking and time tracking providers. Use it to get and set the time tracking provider, get and set the time tracking options, and disable time tracking."},{"name":"Users","description":"This resource represent users. Use it to:\n\n *  get, get a list of, create, and delete users.\n *  get, set, and reset a user's default issue table columns.\n *  get a list of the groups the user belongs to.\n *  get a list of user account IDs for a list of usernames or user keys."},{"name":"User properties","description":"This resource represents [user](#api-group-Users) properties and provides for storing custom data against a user. Use it to get, create, and delete user properties as well as get a list of property keys for a user. This resourse is designed for integrations and apps to store per-user data and settings. This enables data used to customized the user experience to be kept in the Jira Cloud instance's database. User properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).\n\nThis resource does not access the [user properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira."},{"name":"User search","description":"This resource represents various ways to search for and find users. Use it to obtain list of users including users assignable to projects and issues, users with permissions, user lists for pickup fields, and user lists generated using structured queries. Note that the operations in this resource only return users found within the first 1000 users."},{"name":"Webhooks","description":"This resource represents webhooks. Webhooks are calls sent to a URL when an event occurs in Jira for issues specified by a JQL query. Only Connect and OAuth 2.0 apps can register and manage webhooks. For more information, see [Webhooks](https://developer.atlassian.com/cloud/jira/platform/webhooks/#registering-a-webhook-via-the-jira-rest-api-for-connect-apps)."},{"name":"Workflows","description":"This resource represents workflows. Use it to:\n\n *  Get workflows\n *  Create workflows\n *  Update workflows\n *  Delete inactive workflows\n *  Get workflow capabilities"},{"name":"Workflow transition rules","description":"This resource represents workflow transition rules. Workflow transition rules define a Connect or a Forge app routine, such as a [workflow post functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/) that is executed in association with the workflow. Use it to read and modify configuration of workflow transition rules."},{"name":"Workflow schemes","description":"This resource represents workflow schemes. Use it to manage workflow schemes and the workflow scheme's workflows and issue types.\n\nA workflow scheme maps issue types to workflows. A workflow scheme can be associated with one or more projects, which enables the projects to use the workflow-issue type mappings.\n\nActive workflow schemes (workflow schemes that are used by projects) cannot be edited. When an active workflow scheme is edited, a draft copy of the scheme is created. The draft workflow scheme is then be edited and published (replacing the active scheme).\n\nSee [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg) for more information."},{"name":"Workflow scheme project associations","description":"This resource represents the associations between workflow schemes and projects.\n\nFor more information, see [Managing your workflows](https://confluence.atlassian.com/x/q4hKLg)."},{"name":"Workflow scheme drafts","description":"This resource represents draft workflow schemes. Use it to manage drafts of workflow schemes.\n\nA workflow scheme maps issue types to workflows. A workflow scheme can be associated with one or more projects, which enables the projects to use the workflow-issue type mappings.\n\nActive workflow schemes (workflow schemes that are used by projects) cannot be edited. Editing an active workflow scheme creates a draft copy of the scheme. The draft workflow scheme can then be edited and published (replacing the active scheme).\n\nSee [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg) for more information."},{"name":"Workflow statuses","description":"This resource represents issue workflow statuses. Use it to obtain a list of all statuses associated with workflows and the details of a status."},{"name":"Workflow status categories","description":"This resource represents status categories. Use it to obtain a list of all status categories and the details of a category. Status categories provided a mechanism for categorizing [statuses](#api-group-Workflow-statuses)."},{"name":"Workflow transition properties","description":"This resource represents workflow transition properties, which provides for storing custom data against a workflow transition. Use it to get, create, and delete workflow transition properties as well as get a list of property keys for a workflow transition. Workflow transition properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)."},{"name":"Data classifications","description":"This resource represents data classifications. Use it to view and manage classification objects."},{"name":"Project data classifications","description":"This resource represents data classifications used in a project. Use it to view and manage classification tags in your projects."},{"name":"App properties","description":"This resource represents app properties. Use it to store arbitrary data for your\n[Connect app](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps)."},{"name":"Dynamic modules","description":"This resource represents [modules registered dynamically](https://developer.atlassian.com/cloud/jira/platform/dynamic-modules/)\nby [Connect apps](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps)."},{"name":"App migration","description":"This resource supports [app migrations](https://developer.atlassian.com/platform/app-migration/). Use it to:\n- [to request migrated workflow rules details](https://developer.atlassian.com/platform/app-migration/tutorials/migration-app-workflow-rules/).\n- [perform bulk updates of entity properties](https://developer.atlassian.com/platform/app-migration/tutorials/entity-properties-bulk-api/).\n- [perform bulk updates of issue custom field values](https://developer.atlassian.com/platform/app-migration/tutorials/migrating-app-custom-fields/)."}],"paths":{"/rest/api/3/announcementBanner":{"get":{"tags":["Announcement banner"],"summary":"Get announcement banner configuration","description":"Returns the current announcement banner configuration.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getBanner","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementBannerConfiguration"},"example":"{\"message\":\"This is a public, enabled, non-dismissible banner, set using the API\",\"isDismissible\":false,\"isEnabled\":true,\"hashId\":\"9HN2FJK9DM8BHRWERVW3RRTGDJ4G4D5C\",\"visibility\":\"public\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"\"Only admins can read banner configuration.\""}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"},"put":{"tags":["Announcement banner"],"summary":"Update announcement banner configuration","description":"Updates the announcement banner configuration.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"setBanner","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementBannerConfigurationUpdate"},"example":{"isDismissible":false,"isEnabled":true,"message":"This is a public, enabled, non-dismissible banner, set using the API","visibility":"public"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if an invalid parameter is passed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"\"Banner message cannot be null.\""}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"\"Only admins can update banner configuration.\""}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/app/field/value":{"post":{"tags":["Issue custom field values (apps)"],"summary":"Update custom fields","description":"Updates the value of one or more custom fields on one or more issues. Combinations of custom field and issue should be unique within the request. Custom fields can only be updated by the Forge app that created them.\n\n**[Permissions](#permissions) required:** Only the app that created the custom field can update its values with this operation.","operationId":"updateMultipleCustomFieldValues","parameters":[{"name":"generateChangelog","in":"query","description":"Whether to generate a changelog for this update.","schema":{"type":"boolean","default":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultipleCustomFieldValuesUpdateDetails"},"example":{"updates":[{"customField":"customfield_10010","issueIds":[10010,10011],"value":"new value"},{"customField":"customfield_10011","issueIds":[10010],"value":1000}]}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid."},"403":{"description":"Returned if the request is not authenticated as the app that provided all the fields."},"404":{"description":"Returned if any field is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":[]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":[]},{"state":"Beta","scheme":"OAuth2","scopes":[]}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/app/field/{fieldIdOrKey}/context/configuration":{"get":{"tags":["Issue custom field configuration (apps)"],"summary":"Get custom field configurations","description":"Returns a [paginated](#pagination) list of configurations for a custom field created by a [Forge app](https://developer.atlassian.com/platform/forge/).\n\nThe result can be filtered by one of these criteria:\n\n *  `id`.\n *  `fieldContextId`.\n *  `issueId`.\n *  `projectKeyOrId` and `issueTypeId`.\n\nOtherwise, all configurations are returned.\n\n**[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.","operationId":"getCustomFieldConfiguration","parameters":[{"name":"fieldIdOrKey","in":"path","description":"The ID or key of the custom field, for example `customfield_10000`.","required":true,"schema":{"type":"string"}},{"name":"id","in":"query","description":"The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: `id=10000&id=10001`. Can't be provided with `fieldContextId`, `issueId`, `projectKeyOrId`, or `issueTypeId`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"fieldContextId","in":"query","description":"The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: `fieldContextId=10000&fieldContextId=10001`. Can't be provided with `id`, `issueId`, `projectKeyOrId`, or `issueTypeId`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"issueId","in":"query","description":"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`.","schema":{"type":"integer","format":"int64"}},{"name":"projectKeyOrId","in":"query","description":"The ID or key of the project to filter results by. Must be provided with `issueTypeId`. Can't be provided with `issueId`.","schema":{"type":"string"}},{"name":"issueTypeId","in":"query","description":"The ID of the issue type to filter results by. Must be provided with `projectKeyOrId`. Can't be provided with `issueId`.","schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanContextualConfiguration"},"example":"{\"maxResults\":1000,\"startAt\":0,\"total\":2,\"isLast\":true,\"values\":[{\"id\":\"10000\",\"fieldContextId\":\"10010\"},{\"id\":\"10001\",\"fieldContextId\":\"10011\",\"configuration\":{\"minValue\":0,\"maxValue\":10000},\"schema\":{\"properties\":{\"amount\":{\"type\":\"number\"},\"currency\":{\"type\":\"string\"}},\"required\":[\"amount\",\"currency\"]}}]}"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user is not a Jira admin or the request is not authenticated as from the app that provided the field."},"404":{"description":"Returned if the custom field is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:custom-field-contextual-configuration:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"put":{"tags":["Issue custom field configuration (apps)"],"summary":"Update custom field configurations","description":"Update the configuration for contexts of a custom field created by a [Forge app](https://developer.atlassian.com/platform/forge/).\n\n**[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.","operationId":"updateCustomFieldConfiguration","parameters":[{"name":"fieldIdOrKey","in":"path","description":"The ID or key of the custom field, for example `customfield_10000`.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldConfigurations"},"example":{"configurations":[{"id":"10000"},{"configuration":{"maxValue":10000,"minValue":0},"id":"10001","schema":{"properties":{"amount":{"type":"number"},"currency":{"type":"string"}},"required":["amount","currency"]}}]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user is not a Jira admin or the request is not authenticated as from the app that provided the field."},"404":{"description":"Returned if the custom field is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:custom-field-contextual-configuration:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/app/field/{fieldIdOrKey}/value":{"put":{"tags":["Issue custom field values (apps)"],"summary":"Update custom field value","description":"Updates the value of a custom field on one or more issues. Custom fields can only be updated by the Forge app that created them.\n\n**[Permissions](#permissions) required:** Only the app that created the custom field can update its values with this operation.","operationId":"updateCustomFieldValue","parameters":[{"name":"fieldIdOrKey","in":"path","description":"The ID or key of the custom field. For example, `customfield_10010`.","required":true,"schema":{"type":"string"}},{"name":"generateChangelog","in":"query","description":"Whether to generate a changelog for this update.","schema":{"type":"boolean","default":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldValueUpdateDetails"},"example":{"updates":[{"issueIds":[10010],"value":"new value"}]}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid."},"403":{"description":"Returned if the request is not authenticated as the app that provided the field."},"404":{"description":"Returned if the field is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":[]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":[]},{"state":"Beta","scheme":"OAuth2","scopes":[]}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/application-properties":{"get":{"tags":["Jira settings"],"summary":"Get application property","description":"Returns all application properties or an application property.\n\nIf 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getApplicationProperty","parameters":[{"name":"key","in":"query","description":"The key of the application property.","schema":{"type":"string"}},{"name":"permissionLevel","in":"query","description":"The permission level of all items being returned in the list.","schema":{"type":"string"}},{"name":"keyFilter","in":"query","description":"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.*.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationProperty"}},"example":"[{\"id\":\"jira.home\",\"key\":\"jira.home\",\"value\":\"/var/jira/jira-home\",\"name\":\"jira.home\",\"desc\":\"Jira home directory\",\"type\":\"string\",\"defaultValue\":\"\"},{\"id\":\"jira.clone.prefix\",\"key\":\"jira.clone.prefix\",\"value\":\"CLONE -\",\"name\":\"The prefix added to the Summary field of cloned issues\",\"type\":\"string\",\"defaultValue\":\"CLONE -\"}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the application property is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:instance-configuration:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/application-properties/advanced-settings":{"get":{"tags":["Jira settings"],"summary":"Get advanced settings","description":"Returns the application properties that are accessible on the *Advanced Settings* page. To navigate to the *Advanced Settings* page in Jira, choose the Jira icon > **Jira settings** > **System**, **General Configuration** and then click **Advanced Settings** (in the upper right).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getAdvancedSettings","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationProperty"}},"example":"[{\"id\":\"jira.home\",\"key\":\"jira.home\",\"value\":\"/var/jira/jira-home\",\"name\":\"jira.home\",\"desc\":\"Jira home directory\",\"type\":\"string\",\"defaultValue\":\"\"},{\"id\":\"jira.clone.prefix\",\"key\":\"jira.clone.prefix\",\"value\":\"CLONE -\",\"name\":\"The prefix added to the Summary field of cloned issues\",\"type\":\"string\",\"defaultValue\":\"CLONE -\"}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user is not an administrator."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:instance-configuration:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/application-properties/{id}":{"put":{"tags":["Jira settings"],"summary":"Set application property","description":"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.\n\n#### Advanced settings ####\n\nThe advanced settings below are also accessible in [Jira](https://confluence.atlassian.com/x/vYXKM).\n\n| Key | Description | Default value |  \n| -- | -- | -- |  \n| `jira.clone.prefix` | The string of text prefixed to the title of a cloned issue. | `CLONE -` |  \n| `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` |  \n| `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` |  \n| `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` |  \n| `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` |  \n| `jira.issue.actions.order` | The default order of actions (such as *Comments* or *Change history*) displayed on the issue view. | `asc` |  \n| `jira.view.issue.links.sort.order` | The sort order of the list of issue links on the issue view. | `type, status, priority` |  \n| `jira.comment.collapsing.minimum.hidden` | The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing. | `4` |  \n| `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` |  \n\n\n#### Look and feel ####\n\nThe settings listed below adjust the [look and feel](https://confluence.atlassian.com/x/VwCLLg).\n\n| Key | Description | Default value |  \n| -- | -- | -- |  \n| `jira.lf.date.time` | The [ time format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html). | `h:mm a` |  \n| `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` |  \n| `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` |  \n| `jira.lf.date.dmy` | The [ date format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html). | `dd/MMM/yy` |  \n| `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` |  \n| `jira.lf.logo.url` | The URL of the logo image file. | `/images/icon-jira-logo.png` |  \n| `jira.lf.logo.show.application.title` | Controls the visibility of the application title on the sidebar. | `false` |  \n| `jira.lf.favicon.url` | The URL of the favicon. | `/favicon.ico` |  \n| `jira.lf.favicon.hires.url` | The URL of the high-resolution favicon. | `/images/64jira.png` |  \n| `jira.lf.navigation.bgcolour` | The background color of the sidebar. | `#0747A6` |  \n| `jira.lf.navigation.highlightcolour` | The color of the text and logo of the sidebar. | `#DEEBFF` |  \n| `jira.lf.hero.button.base.bg.colour` | The background color of the hero button. | `#3b7fc4` |  \n| `jira.title` | The text for the application title. The application title can also be set in *General settings*. | `Jira` |  \n| `jira.option.globalsharing` | Whether filters and dashboards can be shared with anyone signed into Jira. | `true` |  \n| `xflow.product.suggestions.enabled` | Whether to expose product suggestions for other Atlassian products within Jira. | `true` |  \n\n\n#### Other settings ####\n\n| Key | Description | Default value |  \n| -- | -- | -- |  \n| `jira.issuenav.criteria.autoupdate` | Whether instant updates to search criteria is active. | `true` |  \n\n\n*Note: Be careful when changing [application properties and advanced settings](https://confluence.atlassian.com/x/vYXKM).*\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"setApplicationProperty","parameters":[{"name":"id","in":"path","description":"The key of the application property to update.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleApplicationPropertyBean"},"example":{"id":"jira.home","value":"/var/jira/jira-home"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationProperty"}}}},"400":{"description":"Returned if the data type of the `value` does not match the application property's data type. For example, a string is provided instead of an integer."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to edit the property."},"404":{"description":"Returned if the property is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:instance-configuration:jira","read:instance-configuration:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/applicationrole":{"get":{"tags":["Application roles"],"summary":"Get all application roles","description":"Returns all application roles. In Jira, application roles are managed using the [Application access configuration](https://confluence.atlassian.com/x/3YxjL) page.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getAllApplicationRoles","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationRole"}},"example":"[{\"key\":\"jira-software\",\"groups\":[\"jira-software-users\",\"jira-testers\"],\"groupDetails\":[{\"name\":\"jira-testers\",\"groupId\":\"42c8955c-63d7-42c8-9520-63d7aca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=42c8955c-63d7-42c8-9520-63d7aca0625\"},{\"name\":\"jira-software-users\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"}],\"name\":\"Jira Software\",\"defaultGroups\":[\"jira-software-users\"],\"defaultGroupsDetails\":[{\"name\":\"jira-software-users\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"}],\"selectedByDefault\":false,\"defined\":false,\"numberOfSeats\":10,\"remainingSeats\":5,\"userCount\":5,\"userCountDescription\":\"5 developers\",\"hasUnlimitedSeats\":false,\"platform\":false},{\"key\":\"jira-core\",\"groups\":[\"jira-core-users\"],\"groupDetails\":[{\"name\":\"jira-core-users\",\"groupId\":\"92d01dca0625-42c8-42c8-9520-276f955c\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=92d01dca0625-42c8-42c8-9520-276f955c\"}],\"name\":\"Jira Core\",\"defaultGroups\":[\"jira-core-users\"],\"defaultGroupsDetails\":[{\"name\":\"jira-core-users\",\"groupId\":\"92d01dca0625-42c8-42c8-9520-276f955c\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=92d01dca0625-42c8-42c8-9520-276f955c\"}],\"selectedByDefault\":false,\"defined\":false,\"numberOfSeats\":1,\"remainingSeats\":1,\"userCount\":0,\"userCountDescription\":\"0 users\",\"hasUnlimitedSeats\":false,\"platform\":true}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user is not an administrator."}},"deprecated":false,"security":[{"basicAuth":[]}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/applicationrole/{key}":{"get":{"tags":["Application roles"],"summary":"Get application role","description":"Returns an application role.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getApplicationRole","parameters":[{"name":"key","in":"path","description":"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":true,"schema":{"type":"string","example":"jira-software"},"x-showInExample":"true"}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationRole"},"example":"{\"key\":\"jira-software\",\"groups\":[\"jira-software-users\",\"jira-testers\"],\"groupDetails\":[{\"name\":\"jira-testers\",\"groupId\":\"42c8955c-63d7-42c8-9520-63d7aca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=42c8955c-63d7-42c8-9520-63d7aca0625\"},{\"name\":\"jira-software-users\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"}],\"name\":\"Jira Software\",\"defaultGroups\":[\"jira-software-users\"],\"defaultGroupsDetails\":[{\"name\":\"jira-software-users\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"}],\"selectedByDefault\":false,\"defined\":false,\"numberOfSeats\":10,\"remainingSeats\":5,\"userCount\":5,\"userCountDescription\":\"5 developers\",\"hasUnlimitedSeats\":false,\"platform\":false}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user is not an administrator."},"404":{"description":"Returned if the role is not found."}},"deprecated":false,"security":[{"basicAuth":[]}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/attachment/content/{id}":{"get":{"tags":["Issue attachments"],"summary":"Get attachment content","description":"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.\n\nTo return a thumbnail of the attachment, use [Get attachment thumbnail](#api-rest-api-3-attachment-thumbnail-id-get).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** For the issue containing the attachment:\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getAttachmentContent","parameters":[{"name":"id","in":"path","description":"The ID of the attachment.","required":true,"schema":{"type":"string"}},{"name":"redirect","in":"query","description":"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.","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Returned if the request is successful when `redirect` is set to `false`.","content":{"application/json":{"schema":{"type":"object"}}}},"206":{"description":"Returned if the request is successful when a `Range` header is provided and `redirect` is set to `false`."},"303":{"description":"Returned if the request is successful. See the `Location` header for the download URL."},"400":{"description":"Returned if the range supplied in the `Range` header is malformed."},"401":{"description":"Returned if the authentication credentials are incorrect."},"403":{"description":"The user does not have the necessary permission."},"404":{"description":"Returned if:\n\n *  the attachment is not found.\n *  attachments are disabled in the Jira settings."},"416":{"description":"Returned if the server is unable to satisfy the range of bytes provided."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:attachment:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/attachment/meta":{"get":{"tags":["Issue attachments"],"summary":"Get Jira attachment settings","description":"Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed.\n\nNote that there are also [project permissions](https://confluence.atlassian.com/x/yodKLg) that restrict whether users can create and delete attachments.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.","operationId":"getAttachmentMeta","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentSettings"},"example":"{\"enabled\":true,\"uploadLimit\":1000000}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:instance-configuration:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/attachment/thumbnail/{id}":{"get":{"tags":["Issue attachments"],"summary":"Get attachment thumbnail","description":"Returns the thumbnail of an attachment.\n\nTo return the attachment contents, use [Get attachment content](#api-rest-api-3-attachment-content-id-get).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** For the issue containing the attachment:\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getAttachmentThumbnail","parameters":[{"name":"id","in":"path","description":"The ID of the attachment.","required":true,"schema":{"type":"string"}},{"name":"redirect","in":"query","description":"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.","schema":{"type":"boolean","default":true}},{"name":"fallbackToDefault","in":"query","description":"Whether a default thumbnail is returned when the requested thumbnail is not found.","schema":{"type":"boolean","default":true}},{"name":"width","in":"query","description":"The maximum width to scale the thumbnail to.","schema":{"type":"integer","format":"int32"}},{"name":"height","in":"query","description":"The maximum height to scale the thumbnail to.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if the request is successful when `redirect` is set to `false`.","content":{"application/json":{"schema":{"type":"object"}}}},"303":{"description":"Returned if the request is successful. See the `Location` header for the download URL."},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect."},"403":{"description":"The user does not have the necessary permission."},"404":{"description":"Returned if:\n\n *  the attachment is not found.\n *  attachments are disabled in the Jira settings.\n *  `fallbackToDefault` is `false` and the request thumbnail cannot be downloaded."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:attachment:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/attachment/{id}":{"get":{"tags":["Issue attachments"],"summary":"Get attachment metadata","description":"Returns the metadata for an attachment. Note that the attachment itself is not returned.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getAttachment","parameters":[{"name":"id","in":"path","description":"The ID of the attachment.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentMetadata"},"example":"{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/attachments/10000\",\"filename\":\"picture.jpg\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2023-11-30T00:42:06.866+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10000\",\"thumbnail\":\"https://your-domain.atlassian.net/jira/rest/api/3/attachment/thumbnail/10000\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if:\n\n *  the attachment is not found.\n *  attachments are disabled in the Jira settings."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:attachment:jira","read:user:jira","read:application-role:jira","read:avatar:jira","read:group:jira"]}],"x-atlassian-connect-scope":"READ"},"delete":{"tags":["Issue attachments"],"summary":"Delete attachment","description":"Deletes an attachment from an issue.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** For the project holding the issue containing the attachment:\n\n *  *Delete own attachments* [project permission](https://confluence.atlassian.com/x/yodKLg) to delete an attachment created by the calling user.\n *  *Delete all attachments* [project permission](https://confluence.atlassian.com/x/yodKLg) to delete an attachment created by any user.","operationId":"removeAttachment","parameters":[{"name":"id","in":"path","description":"The ID of the attachment.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if:\n\n *  the attachment is not found.\n *  attachments are disabled in the Jira settings."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:attachment:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/attachment/{id}/expand/human":{"get":{"tags":["Issue attachments"],"summary":"Get all metadata for an expanded attachment","description":"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.\n\nUse 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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** For the issue containing the attachment:\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"expandAttachmentForHumans","parameters":[{"name":"id","in":"path","description":"The ID of the attachment.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful. If an empty list is returned in the response, the attachment is empty, corrupt, or not an archive.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentArchiveMetadataReadable"},"example":"{\"id\":7237823,\"name\":\"images.zip\",\"entries\":[{\"path\":\"MG00N067.JPG\",\"index\":0,\"size\":\"119 kB\",\"mediaType\":\"image/jpeg\",\"label\":\"MG00N067.JPG\"},{\"path\":\"Allegro from Duet in C Major.mp3\",\"index\":1,\"size\":\"1.36 MB\",\"mediaType\":\"audio/mpeg\",\"label\":\"Allegro from Duet in C Major.mp3\"},{\"path\":\"long/path/thanks/to/lots/of/subdirectories/inside/making/it/quite/hard/to/reach/the/leaf.txt\",\"index\":2,\"size\":\"0.0 k\",\"mediaType\":\"text/plain\",\"label\":\"long/path/thanks/to/.../reach/the/leaf.txt\"}],\"totalEntryCount\":39,\"mediaType\":\"application/zip\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"The user does not have the necessary permission."},"404":{"description":"Returned if:\n\n *  the attachment is not found.\n *  attachments are disabled in the Jira settings."},"409":{"description":"Returned if the attachment is an archive, but not a supported archive format."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:attachment:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/attachment/{id}/expand/raw":{"get":{"tags":["Issue attachments"],"summary":"Get contents metadata for an expanded attachment","description":"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.\n\nUse 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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** For the issue containing the attachment:\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"expandAttachmentForMachines","parameters":[{"name":"id","in":"path","description":"The ID of the attachment.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful. If an empty list is returned in the response, the attachment is empty, corrupt, or not an archive.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentArchiveImpl"},"example":"{\"entries\":[{\"entryIndex\":0,\"name\":\"Allegro from Duet in C Major.mp3\",\"size\":1430174,\"mediaType\":\"audio/mpeg\"},{\"entryIndex\":1,\"name\":\"lrm.rtf\",\"size\":331,\"mediaType\":\"text/rtf\"}],\"totalEntryCount\":24}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"The user does not have the necessary permission."},"404":{"description":"Returned if:\n\n *  the attachment is not found.\n *  attachments are disabled in the Jira settings."},"409":{"description":"Returned if the attachment is an archive, but not a supported archive format."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:attachment:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/auditing/record":{"get":{"tags":["Audit records"],"summary":"Get audit records","description":"Returns a list of audit records. The list can be filtered to include items:\n\n *  where each item in `filter` has at least one match in any of these fields:\n    \n     *  `summary`\n     *  `category`\n     *  `eventSource`\n     *  `objectItem.name` If the object is a user, account ID is available to filter.\n     *  `objectItem.parentName`\n     *  `objectItem.typeName`\n     *  `changedValues.changedFrom`\n     *  `changedValues.changedTo`\n     *  `remoteAddress`\n    \n    For example, if `filter` contains *man ed*, an audit record containing `summary\": \"User added to group\"` and `\"category\": \"group management\"` is returned.\n *  created on or after a date and time.\n *  created or or before a date and time.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getAuditRecords","parameters":[{"name":"offset","in":"query","description":"The number of records to skip before returning the first result.","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of results to return.","schema":{"type":"integer","format":"int32","default":1000}},{"name":"filter","in":"query","description":"The strings to match with audit field content, space separated.","schema":{"type":"string"}},{"name":"from","in":"query","description":"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.","schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","description":"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.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditRecords"},"example":"{\"offset\":0,\"limit\":1000,\"total\":1,\"records\":[{\"id\":1,\"summary\":\"User created\",\"remoteAddress\":\"192.168.1.1\",\"authorKey\":\"administrator\",\"authorAccountId\":\"5ab8f18d741e9c2c7e9d4538\",\"created\":\"2014-03-19T18:45:42.967+0000\",\"category\":\"user management\",\"eventSource\":\"Jira Connect Plugin\",\"description\":\"Optional description\",\"objectItem\":{\"id\":\"user\",\"name\":\"user\",\"typeName\":\"USER\",\"parentId\":\"1\",\"parentName\":\"Jira Internal Directory\"},\"changedValues\":[{\"fieldName\":\"email\",\"changedFrom\":\"user@atlassian.com\",\"changedTo\":\"newuser@atlassian.com\"}],\"associatedItems\":[{\"id\":\"jira-software-users\",\"name\":\"jira-software-users\",\"typeName\":\"GROUP\",\"parentId\":\"1\",\"parentName\":\"Jira Internal Directory\"}]}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if:\n\n *  the user does not have the required permissions.\n *  all Jira products are on free plans. Audit logs are available when at least one Jira product is on a paid plan."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:audit-log:jira","read:user:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/avatar/{type}/system":{"get":{"tags":["Avatars"],"summary":"Get system avatars by type","description":"Returns a list of system avatar details by owner type, where the owner types are issue type, project, or user.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.","operationId":"getAllSystemAvatars","parameters":[{"name":"type","in":"path","description":"The avatar type.","required":true,"schema":{"type":"string","example":"project","enum":["issuetype","project","user"]},"x-showInExample":"true"}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemAvatars"},"example":"{\"system\":[{\"id\":\"1000\",\"isSystemAvatar\":true,\"isSelected\":false,\"isDeletable\":false,\"urls\":{\"16x16\":\"/secure/useravatar?size=xsmall&avatarId=10040&avatarType=project\",\"24x24\":\"/secure/useravatar?size=small&avatarId=10040&avatarType=project\",\"32x32\":\"/secure/useravatar?size=medium&avatarId=10040&avatarType=project\",\"48x48\":\"/secure/useravatar?avatarId=10040&avatarType=project\"}}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"500":{"description":"Returned if an error occurs while retrieving the list of avatars."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:avatar:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/comment/list":{"post":{"tags":["Issue comments"],"summary":"Get comments by IDs","description":"Returns a [paginated](#pagination) list of comments specified by a list of comment IDs.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Comments are returned where the user:\n\n *  has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.","operationId":"getCommentsByIds","parameters":[{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `renderedBody` Returns the comment body rendered in HTML.\n *  `properties` Returns the comment's properties.","schema":{"type":"string"}}],"requestBody":{"description":"The list of comment IDs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueCommentListRequestBean"},"example":{"ids":[1,2,5,10]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanComment"},"example":"{\"maxResults\":1048576,\"startAt\":0,\"total\":1,\"isLast\":true,\"values\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"updateAuthor\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2021-01-17T12:34:00.000+0000\",\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\",\"identifier\":\"Administrators\"}}]}"}}},"400":{"description":"Returned if the request contains more than 1000 IDs or is empty."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:comment.property:jira","read:avatar:jira","read:comment:jira","read:group:jira","read:project-role:jira","read:user:jira","read:comment.property:jira","read:project:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/comment/{commentId}/properties":{"get":{"tags":["Issue comment properties"],"summary":"Get comment property keys","description":"Returns the keys of all the properties of a comment.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.","operationId":"getCommentPropertyKeys","parameters":[{"name":"commentId","in":"path","description":"The ID of the comment.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyKeys"},"example":"{\"keys\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"}}},"400":{"description":"Returned if the comment ID is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the comment is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:comment.property:jira","read:dashboard.property:jira","read:issue-type.property:jira","read:issue-worklog.property:jira","read:issue.property:jira","read:project.property:jira","read:user.property:jira","read:workflow.property:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/comment/{commentId}/properties/{propertyKey}":{"get":{"tags":["Issue comment properties"],"summary":"Get comment property","description":"Returns the value of a comment property.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.","operationId":"getCommentProperty","parameters":[{"name":"commentId","in":"path","description":"The ID of the comment.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityProperty"},"example":"{\"key\":\"issue.support\",\"value\":{\"system.conversation.id\":\"b1bf38be-5e94-4b40-a3b8-9278735ee1e6\",\"system.support.time\":\"1m\"}}"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the comment or the property is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:comment.property:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Issue comment properties"],"summary":"Set comment property","description":"Creates or updates the value of a property for a comment. Use this resource to store custom data against a comment.\n\nThe 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.\n\n**[Permissions](#permissions) required:** either of:\n\n *  *Edit All Comments* [project permission](https://confluence.atlassian.com/x/yodKLg) to create or update the value of a property on any comment.\n *  *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.\n\nAlso, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.","operationId":"setCommentProperty","parameters":[{"name":"commentId","in":"path","description":"The ID of the comment.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property. The maximum length is 255 characters.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{}}},"required":true},"responses":{"200":{"description":"Returned if the comment property is updated.","content":{"application/json":{"schema":{}}}},"201":{"description":"Returned if the comment property is created.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the comment is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:comment.property:jira"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Issue comment properties"],"summary":"Delete comment property","description":"Deletes a comment property.\n\n**[Permissions](#permissions) required:** either of:\n\n *  *Edit All Comments* [project permission](https://confluence.atlassian.com/x/yodKLg) to delete a property from any comment.\n *  *Edit Own Comments* [project permission](https://confluence.atlassian.com/x/yodKLg) to delete a property from a comment created by the user.\n\nAlso, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.","operationId":"deleteCommentProperty","parameters":[{"name":"commentId","in":"path","description":"The ID of the comment.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the comment or the property is not found or the user has the necessary project permissions but isn't a member of the role or group visibility of the comment is restricted to."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:comment.property:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/component":{"post":{"tags":["Project components"],"summary":"Create component","description":"Creates a component. Use components to provide containers for issues within a project. Use components to provide containers for issues within a project.\n\nThis operation can be accessed anonymously.\n\n**[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).","operationId":"createComponent","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectComponent"},"example":{"assigneeType":"PROJECT_LEAD","description":"This is a Jira component","isAssigneeTypeValid":false,"leadAccountId":"5b10a2844c20165700ede21g","name":"Component 1","project":"HSP"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectComponent"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000,\"ari\":\"ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002\",\"metadata\":{\"icon\":\"https://www.example.com/icon.png\"}}"}}},"400":{"description":"Returned if:\n\n *  the user is not found.\n *  `name` is not provided.\n *  `name` is over 255 characters in length.\n *  `projectId` is not provided.\n *  `assigneeType` is an invalid value."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to manage the project containing the component or does not have permission to administer Jira."},"404":{"description":"Returned if the project is not found or the user does not have permission to browse the project containing the component."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project:jira","read:user:jira","write:project.component:jira","read:application-role:jira","read:avatar:jira","read:group:jira","read:project.component:jira"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/component/{id}":{"get":{"tags":["Project components"],"summary":"Get component","description":"Returns a component.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for project containing the component.","operationId":"getComponent","parameters":[{"name":"id","in":"path","description":"The ID of the component.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectComponent"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000,\"ari\":\"ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002\",\"metadata\":{\"icon\":\"https://www.example.com/icon.png\"}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the component is not found or the user does not have permission to browse the project containing the component."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project:jira","read:project.component:jira","read:user:jira","read:application-role:jira","read:avatar:jira","read:group:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Project components"],"summary":"Update component","description":"Updates a component. Any fields included in the request are overwritten. If `leadAccountId` is an empty string (\"\") the component lead is removed.\n\nThis operation can be accessed anonymously.\n\n**[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).","operationId":"updateComponent","parameters":[{"name":"id","in":"path","description":"The ID of the component.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectComponent"},"example":{"assigneeType":"PROJECT_LEAD","description":"This is a Jira component","isAssigneeTypeValid":false,"leadAccountId":"5b10a2844c20165700ede21g","name":"Component 1"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectComponent"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000,\"ari\":\"ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002\",\"metadata\":{\"icon\":\"https://www.example.com/icon.png\"}}"}}},"400":{"description":"Returned if:\n\n *  the user is not found.\n *  `assigneeType` is an invalid value.\n *  `name` is over 255 characters in length."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to manage the project containing the component or does not have permission to administer Jira."},"404":{"description":"Returned if the component is not found or the user does not have permission to browse the project containing the component."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project:jira","read:user:jira","write:project.component:jira","read:application-role:jira","read:avatar:jira","read:group:jira","read:project.component:jira"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"},"delete":{"tags":["Project components"],"summary":"Delete component","description":"Deletes a component.\n\nThis operation can be accessed anonymously.\n\n**[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).","operationId":"deleteComponent","parameters":[{"name":"id","in":"path","description":"The ID of the component.","required":true,"schema":{"type":"string"}},{"name":"moveIssuesTo","in":"query","description":"The ID of the component to replace the deleted component. If this value is null no replacement is made.","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to manage the project containing the component or does not have permission to administer Jira."},"404":{"description":"Returned if:\n\n *  the component is not found.\n *  the replacement component is not found.\n *  the user does not have permission to browse the project containing the component."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:project.component:jira"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/component/{id}/relatedIssueCounts":{"get":{"tags":["Project components"],"summary":"Get component issues count","description":"Returns the counts of issues assigned to the component.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.","operationId":"getComponentRelatedIssues","parameters":[{"name":"id","in":"path","description":"The ID of the component.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComponentIssuesCount"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/component/10000\",\"issueCount\":23}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the component is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":[]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/configuration":{"get":{"tags":["Jira settings"],"summary":"Get global settings","description":"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.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getConfiguration","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Configuration"},"example":"{\"votingEnabled\":true,\"watchingEnabled\":true,\"unassignedIssuesAllowed\":false,\"subTasksEnabled\":false,\"issueLinkingEnabled\":true,\"timeTrackingEnabled\":true,\"attachmentsEnabled\":true,\"timeTrackingConfiguration\":{\"workingHoursPerDay\":8.0,\"workingDaysPerWeek\":5.0,\"timeFormat\":\"pretty\",\"defaultUnit\":\"day\"}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-user"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-user"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:instance-configuration:jira","read:issue.time-tracking:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/configuration/timetracking":{"get":{"tags":["Time tracking"],"summary":"Get selected time tracking provider","description":"Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a successful but empty response is returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getSelectedTimeTrackingImplementation","parameters":[],"responses":{"200":{"description":"Returned if the request is successful and time tracking is enabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeTrackingProvider"},"example":"{\"key\":\"Jira\",\"name\":\"JIRA provided time tracking\",\"url\":\"/example/config/url\"}"}}},"204":{"description":"Returned if the request is successful but time tracking is disabled.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue.time-tracking:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Time tracking"],"summary":"Select time tracking provider","description":"Selects a time tracking provider.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"selectTimeTrackingImplementation","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeTrackingProvider"},"example":{"key":"Jira"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the time tracking provider is not found."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue.time-tracking:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/configuration/timetracking/list":{"get":{"tags":["Time tracking"],"summary":"Get all time tracking providers","description":"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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getAvailableTimeTrackingImplementations","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingProvider"}},"example":"[{\"key\":\"Jira\",\"name\":\"JIRA provided time tracking\",\"url\":\"/example/config/url\"}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue.time-tracking:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/configuration/timetracking/options":{"get":{"tags":["Time tracking"],"summary":"Get time tracking settings","description":"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).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getSharedTimeTrackingConfiguration","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeTrackingConfiguration"},"example":"{\"workingHoursPerDay\":7.6,\"workingDaysPerWeek\":5.5,\"timeFormat\":\"pretty\",\"defaultUnit\":\"hour\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue.time-tracking:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Time tracking"],"summary":"Set time tracking settings","description":"Sets the time tracking settings.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"setSharedTimeTrackingConfiguration","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeTrackingConfiguration"},"example":{"defaultUnit":"hour","timeFormat":"pretty","workingDaysPerWeek":5.5,"workingHoursPerDay":7.6}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeTrackingConfiguration"},"example":"{\"workingHoursPerDay\":7.6,\"workingDaysPerWeek\":5.5,\"timeFormat\":\"pretty\",\"defaultUnit\":\"hour\"}"}}},"400":{"description":"Returned if the request object is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue.time-tracking:jira","read:issue.time-tracking:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/customFieldOption/{id}":{"get":{"tags":["Issue custom field options"],"summary":"Get custom field option","description":"Returns a custom field option. For example, an option in a select list.\n\nNote 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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** The custom field option is returned as follows:\n\n *  if the user has the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).\n *  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.","operationId":"getCustomFieldOption","parameters":[{"name":"id","in":"path","description":"The ID of the custom field option.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldOption"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/customFieldOption/10000\",\"value\":\"To Do\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  the custom field option is not found.\n *  the user does not have permission to view the custom field."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira","read:field.option:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/dashboard":{"get":{"tags":["Dashboards"],"summary":"Get all dashboards","description":"Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.","operationId":"getAllDashboards","parameters":[{"name":"filter","in":"query","description":"The filter applied to the list of dashboards. Valid values are:\n\n *  `favourite` Returns dashboards the user has marked as favorite.\n *  `my` Returns dashboards owned by the user.","schema":{"type":"string","enum":["my","favourite"]}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int32","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfDashboards"},"example":"{\"startAt\":10,\"maxResults\":10,\"total\":143,\"prev\":\"https://your-domain.atlassian.net/rest/api/3/dashboard?startAt=0\",\"next\":\"https://your-domain.atlassian.net/rest/api/3/dashboard?startAt=10\",\"dashboards\":[{\"id\":\"10000\",\"isFavourite\":false,\"name\":\"System Dashboard\",\"popularity\":1,\"self\":\"https://your-domain.atlassian.net/rest/api/3/dashboard/10000\",\"sharePermissions\":[{\"type\":\"global\"}],\"view\":\"https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000\"},{\"id\":\"20000\",\"isFavourite\":true,\"name\":\"Build Engineering\",\"owner\":{\"key\":\"Mia\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"name\":\"mia\",\"displayName\":\"Mia Krystof\",\"avatarUrls\":{\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\",\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\"}},\"popularity\":1,\"self\":\"https://your-domain.atlassian.net/rest/api/3/dashboard/20000\",\"sharePermissions\":[{\"id\":10105,\"type\":\"group\",\"group\":{\"name\":\"administrators\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupname=administrators\"}}],\"view\":\"https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=20000\"}]}"}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:dashboard:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","read:application-role:jira","read:avatar:jira","read:issue-type-hierarchy:jira","read:issue-type:jira","read:project-category:jira","read:project-version:jira","read:project.component:jira"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Dashboards"],"summary":"Create dashboard","description":"Creates a dashboard.\n\n**[Permissions](#permissions) required:** None.","operationId":"createDashboard","parameters":[],"requestBody":{"description":"Dashboard details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardDetails"},"example":{"description":"A dashboard to help auditors identify sample of issues to check.","editPermissions":[],"name":"Auditors dashboard","sharePermissions":[{"type":"global"}]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"},"example":"{\"id\":\"10000\",\"isFavourite\":false,\"name\":\"System Dashboard\",\"popularity\":1,\"self\":\"https://your-domain.atlassian.net/rest/api/3/dashboard/10000\",\"sharePermissions\":[{\"type\":\"global\"}],\"view\":\"https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000\"}"}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:dashboard:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","write:dashboard:jira","read:application-role:jira","read:avatar:jira","read:issue-type-hierarchy:jira","read:issue-type:jira","read:project-category:jira","read:project-version:jira","read:project.component:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/dashboard/bulk/edit":{"put":{"tags":["Dashboards"],"summary":"Bulk edit dashboards","description":"Bulk edit dashboards. Maximum number of dashboards to be edited at the same time is 100.\n\n**[Permissions](#permissions) required:** None\n\nThe dashboards to be updated must be owned by the user, or the user must be an administrator.","operationId":"bulkEditDashboards","parameters":[],"requestBody":{"description":"The details of dashboards being updated in bulk.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkEditShareableEntityRequest"},"example":{"action":"changePermission","entityIds":[10002,10001],"extendAdminPermissions":true,"permissionDetails":{"editPermissions":[{"group":{"groupId":"276f955c-63d7-42c8-9520-92d01dca0625","name":"jira-administrators","self":"https://your-domain.atlassian.net/rest/api/~ver~/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"},"id":10010,"type":"group"}],"sharePermissions":[{"id":10000,"type":"global"}]}}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkEditShareableEntityResponse"},"example":"{\"action\":\"changePermission\",\"entityErrors\":{\"10002\":{\"errorMessages\":[\"Only owner or editors of the dashboard can change permissions.\"],\"errors\":{}}}}"}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:dashboard:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","write:dashboard:jira","read:application-role:jira","read:avatar:jira","read:issue-type-hierarchy:jira","read:issue-type:jira","read:project-category:jira","read:project-version:jira","read:project.component:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/dashboard/gadgets":{"get":{"tags":["Dashboards"],"summary":"Get available gadgets","description":"Gets a list of all available gadgets that can be added to all dashboards.\n\n**[Permissions](#permissions) required:** None.","operationId":"getAllAvailableDashboardGadgets","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableDashboardGadgetsResponse"},"example":"{\"gadgets\":[{\"moduleKey\":\"com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item\",\"title\":\"Issue statistics\"},{\"uri\":\"rest/gadgets/1.0/g/com.atlassian.streams.streams-jira-plugin:activitystream-gadget/gadgets/activitystream-gadget.xml\",\"title\":\"Activity Stream\"}]}"}}},"400":{"description":"400 response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:dashboard:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/dashboard/search":{"get":{"tags":["Dashboards"],"summary":"Search for dashboards","description":"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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** The following dashboards that match the query parameters are returned:\n\n *  Dashboards owned by the user. Not returned for anonymous users.\n *  Dashboards shared with a group that the user is a member of. Not returned for anonymous users.\n *  Dashboards shared with a private project that the user can browse. Not returned for anonymous users.\n *  Dashboards shared with a public project.\n *  Dashboards shared with the public.","operationId":"getDashboardsPaginated","parameters":[{"name":"dashboardName","in":"query","description":"String used to perform a case-insensitive partial match with `name`.","schema":{"type":"string"}},{"name":"accountId","in":"query","description":"User account ID used to return dashboards with the matching `owner.accountId`. This parameter cannot be used with the `owner` parameter.","schema":{"maxLength":128,"type":"string"}},{"name":"owner","in":"query","description":"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.","schema":{"type":"string"}},{"name":"groupname","in":"query","description":"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.","schema":{"type":"string"}},{"name":"groupId","in":"query","description":"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.","schema":{"type":"string"}},{"name":"projectId","in":"query","description":"Project ID used to returns dashboards that are shared with a project that matches `sharePermissions.project.id`.","schema":{"type":"integer","format":"int64"}},{"name":"orderBy","in":"query","description":"[Order](#ordering) the results by a field:\n\n *  `description` Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use.\n *  `favourite_count` Sorts by dashboard popularity.\n *  `id` Sorts by dashboard ID.\n *  `is_favourite` Sorts by whether the dashboard is marked as a favorite.\n *  `name` Sorts by dashboard name.\n *  `owner` Sorts by dashboard owner name.","schema":{"type":"string","default":"name","enum":["description","-description","+description","favorite_count","-favorite_count","+favorite_count","id","-id","+id","is_favorite","-is_favorite","+is_favorite","name","-name","+name","owner","-owner","+owner"]}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"status","in":"query","description":"The status to filter by. It may be active, archived or deleted.","schema":{"type":"string","default":"active","enum":["active","archived","deleted"]}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `description` Returns the description of the dashboard.\n *  `owner` Returns the owner of the dashboard.\n *  `viewUrl` Returns the URL that is used to view the dashboard.\n *  `favourite` Returns `isFavourite`, an indicator of whether the user has set the dashboard as a favorite.\n *  `favouritedCount` Returns `popularity`, a count of how many users have set this dashboard as a favorite.\n *  `sharePermissions` Returns details of the share permissions defined for the dashboard.\n *  `editPermissions` Returns details of the edit permissions defined for the dashboard.\n *  `isWritable` Returns whether the current user has permission to edit the dashboard.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanDashboard"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/dashboard/search?expand=owner&maxResults=50&startAt=0\",\"maxResults\":100,\"startAt\":0,\"total\":2,\"isLast\":true,\"values\":[{\"description\":\"Testing program\",\"id\":\"1\",\"isFavourite\":true,\"name\":\"Testing\",\"owner\":{\"self\":\"https://your-domain.atlassian.net/user?accountId=5b10a2844c20165700ede21g\",\"displayName\":\"Mia\",\"active\":true,\"accountId\":\"5b10a2844c20165700ede21g\",\"avatarUrls\":{\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\",\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\"}},\"popularity\":1,\"self\":\"https://your-domain.atlassian.net/rest/api/3/dashboard/1\",\"sharePermissions\":[{\"type\":\"global\"}],\"view\":\"https://your-domain.atlassian.net/Dashboard.jspa?selectPageId=1\"},{\"description\":\"Quantum initiative\",\"id\":\"2\",\"isFavourite\":false,\"name\":\"Quantum \",\"owner\":{\"self\":\"https://your-domain.atlassian.net/user?accountId=5b10a2844c20165700ede21g\",\"displayName\":\"Mia\",\"active\":true,\"accountId\":\"5b10a2844c20165700ede21g\",\"avatarUrls\":{\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\",\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\"}},\"popularity\":0,\"self\":\"https://your-domain.atlassian.net/rest/api/3/dashboard/2\",\"sharePermissions\":[{\"type\":\"loggedin\"}],\"view\":\"https://your-domain.atlassian.net/Dashboard.jspa?selectPageId=2\"}]}"}}},"400":{"description":"Returned if:\n\n *  `orderBy` is invalid.\n *  `expand` includes an invalid value.\n *  `accountId` and `owner` are provided.\n *  `groupname` and `groupId` are provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"401 response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:dashboard:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","read:application-role:jira","read:avatar:jira","read:issue-type-hierarchy:jira","read:issue-type:jira","read:project-category:jira","read:project-version:jira","read:project.component:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/dashboard/{dashboardId}/gadget":{"get":{"tags":["Dashboards"],"summary":"Get gadgets","description":"Returns a list of dashboard gadgets on a dashboard.\n\nThis operation returns:\n\n *  Gadgets from a list of IDs, when `id` is set.\n *  Gadgets with a module key, when `moduleKey` is set.\n *  Gadgets from a list of URIs, when `uri` is set.\n *  All gadgets, when no other parameters are set.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.","operationId":"getAllGadgets","parameters":[{"name":"dashboardId","in":"path","description":"The ID of the dashboard.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"moduleKey","in":"query","description":"The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: `moduleKey=key:one&moduleKey=key:two`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"uri","in":"query","description":"The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: `uri=/rest/example/uri/1&uri=/rest/example/uri/2`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"gadgetId","in":"query","description":"The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: `gadgetId=10000&gadgetId=10001`.","schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardGadgetResponse"},"example":"{\"gadgets\":[{\"id\":10001,\"moduleKey\":\"com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item\",\"color\":\"blue\",\"position\":{\"row\":0,\"column\":0},\"title\":\"Issue statistics\"},{\"id\":10002,\"moduleKey\":\"com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-graph\",\"color\":\"red\",\"position\":{\"row\":1,\"column\":0},\"title\":\"Activity stream\"},{\"id\":10003,\"moduleKey\":\"com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item\",\"color\":\"yellow\",\"position\":{\"row\":0,\"column\":1},\"title\":\"Bubble chart\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the dashboard is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The dashboard you requested either does not exist or you don't have the required permissions to perform this action.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:dashboard:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"},"post":{"tags":["Dashboards"],"summary":"Add gadget to dashboard","description":"Adds a gadget to a dashboard.\n\n**[Permissions](#permissions) required:** None.","operationId":"addGadget","parameters":[{"name":"dashboardId","in":"path","description":"The ID of the dashboard.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardGadgetSettings"},"example":{"color":"blue","ignoreUriAndModuleKeyValidation":false,"moduleKey":"com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item","position":{"column":1,"row":0},"title":"Issue statistics"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardGadget"},"example":"{\"id\":10001,\"moduleKey\":\"com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item\",\"color\":\"blue\",\"position\":{\"row\":0,\"column\":1},\"title\":\"Issue statistics\"}"}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Cannot add another gadget. The maximum number of gadgets the dashboard can hold has been reached.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the dashboard is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The dashboard you requested either does not exist or you don't have the required permissions to perform this action.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work","read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work","read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:dashboard:jira","read:dashboard:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}":{"put":{"tags":["Dashboards"],"summary":"Update gadget on dashboard","description":"Changes the title, position, and color of the gadget on a dashboard.\n\n**[Permissions](#permissions) required:** None.","operationId":"updateGadget","parameters":[{"name":"dashboardId","in":"path","description":"The ID of the dashboard.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"gadgetId","in":"path","description":"The ID of the gadget.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardGadgetUpdateRequest"},"example":{"color":"red","position":{"column":1,"row":1},"title":"My new gadget title"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The gadget cannot be placed in the selected row. The selected row does not exist on the dashboard.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the gadget or the dashboard is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The dashboard you requested either does not exist or you don't have the required permissions to perform this action.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:dashboard:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Dashboards"],"summary":"Remove gadget from dashboard","description":"Removes a dashboard gadget from a dashboard.\n\nWhen a gadget is removed from a dashboard, other gadgets in the same column are moved up to fill the emptied position.\n\n**[Permissions](#permissions) required:** None.","operationId":"removeGadget","parameters":[{"name":"dashboardId","in":"path","description":"The ID of the dashboard.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"gadgetId","in":"path","description":"The ID of the gadget.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the gadget or the dashboard is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The dashboard gadget was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:dashboard:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties":{"get":{"tags":["Dashboards"],"summary":"Get dashboard item property keys","description":"Returns the keys of all properties for a dashboard item.\n\nThis operation can be accessed anonymously.\n\n**[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’s anonymous access is permitted.","operationId":"getDashboardItemPropertyKeys","parameters":[{"name":"dashboardId","in":"path","description":"The ID of the dashboard.","required":true,"schema":{"type":"string"}},{"name":"itemId","in":"path","description":"The ID of the dashboard item.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyKeys"},"example":"{\"keys\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the dashboard or dashboard item is not found, or the dashboard is not owned by or shared with the user."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:dashboard.property:jira","read:comment.property:jira","read:issue-type.property:jira","read:issue-worklog.property:jira","read:issue.property:jira","read:project.property:jira","read:user.property:jira","read:workflow.property:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}":{"get":{"tags":["Dashboards"],"summary":"Get dashboard item property","description":"Returns the key and value of a dashboard item property.\n\nA 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).\n\nWhen 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.\n\nThere is no resource to set or get dashboard items.\n\nThis operation can be accessed anonymously.\n\n**[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’s anonymous access is permitted.","operationId":"getDashboardItemProperty","parameters":[{"name":"dashboardId","in":"path","description":"The ID of the dashboard.","required":true,"schema":{"type":"string"}},{"name":"itemId","in":"path","description":"The ID of the dashboard item.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the dashboard item property.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityProperty"},"example":"{\"key\":\"issue.support\",\"value\":{\"system.conversation.id\":\"b1bf38be-5e94-4b40-a3b8-9278735ee1e6\",\"system.support.time\":\"1m\"}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the dashboard, the dashboard item, or dashboard item property is not found, or the dashboard is not owned by or shared with the user."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:dashboard.property:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Dashboards"],"summary":"Set dashboard item property","description":"Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.\n\nA 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).\n\nWhen 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.\n\nThere is no resource to set or get dashboard items.\n\nThe 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.\n\nThis operation can be accessed anonymously.\n\n**[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.","operationId":"setDashboardItemProperty","parameters":[{"name":"dashboardId","in":"path","description":"The ID of the dashboard.","required":true,"schema":{"type":"string"}},{"name":"itemId","in":"path","description":"The ID of the dashboard item.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"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":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{},"example":{"number":5,"string":"string-value"}}},"required":true},"responses":{"200":{"description":"Returned if the dashboard item property is updated.","content":{"application/json":{"schema":{}}}},"201":{"description":"Returned if the dashboard item property is created.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if:\n\n *  Request is invalid\n *  Or if all of these conditions are met in the request:\n    \n     *  The dashboard item has a spec URI and no complete module key\n     *  The value of propertyKey is equal to \"config\"\n     *  The request body contains a JSON object whose keys and values are not strings.","content":{"application/json":{"example":"{\"errorMessages\":[\"The JSON data provided for the property has too many levels. It must be an object with all keys and values as strings.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user is not the owner of the dashboard."},"404":{"description":"Returned if the dashboard item is not found or the dashboard is not shared with the user."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:dashboard.property:jira"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Dashboards"],"summary":"Delete dashboard item property","description":"Deletes a dashboard item property.\n\nThis operation can be accessed anonymously.\n\n**[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.","operationId":"deleteDashboardItemProperty","parameters":[{"name":"dashboardId","in":"path","description":"The ID of the dashboard.","required":true,"schema":{"type":"string"}},{"name":"itemId","in":"path","description":"The ID of the dashboard item.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the dashboard item property.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the dashboard item property is deleted."},"400":{"description":"Returned if the dashboard or dashboard item ID is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user is not the owner of the dashboard."},"404":{"description":"Returned if the dashboard item is not found or the dashboard is not shared with the user."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:dashboard.property:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/dashboard/{id}":{"get":{"tags":["Dashboards"],"summary":"Get dashboard","description":"Returns a dashboard.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.\n\nHowever, 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.","operationId":"getDashboard","parameters":[{"name":"id","in":"path","description":"The ID of the dashboard.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"},"example":"{\"id\":\"10000\",\"isFavourite\":false,\"name\":\"System Dashboard\",\"popularity\":1,\"self\":\"https://your-domain.atlassian.net/rest/api/3/dashboard/10000\",\"sharePermissions\":[{\"type\":\"global\"}],\"view\":\"https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000\"}"}}},"400":{"description":"400 response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"404":{"description":"Returned if the dashboard is not found or the dashboard is not owned by or shared with the user."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:dashboard:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","read:application-role:jira","read:avatar:jira","read:issue-type-hierarchy:jira","read:issue-type:jira","read:project-category:jira","read:project-version:jira","read:project.component:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Dashboards"],"summary":"Update dashboard","description":"Updates a dashboard, replacing all the dashboard details with those provided.\n\n**[Permissions](#permissions) required:** None\n\nThe dashboard to be updated must be owned by the user.","operationId":"updateDashboard","parameters":[{"name":"id","in":"path","description":"The ID of the dashboard to update.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Replacement dashboard details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardDetails"},"example":{"description":"A dashboard to help auditors identify sample of issues to check.","editPermissions":[],"name":"Auditors dashboard","sharePermissions":[{"type":"global"}]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"},"example":"{\"id\":\"10000\",\"isFavourite\":false,\"name\":\"System Dashboard\",\"popularity\":1,\"self\":\"https://your-domain.atlassian.net/rest/api/3/dashboard/10000\",\"sharePermissions\":[{\"type\":\"global\"}],\"view\":\"https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000\"}"}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"404":{"description":"Returned if the dashboard is not found or the dashboard is not owned by the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:dashboard:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","write:dashboard:jira","read:application-role:jira","read:avatar:jira","read:issue-type-hierarchy:jira","read:issue-type:jira","read:project-category:jira","read:project-version:jira","read:project.component:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Dashboards"],"summary":"Delete dashboard","description":"Deletes a dashboard.\n\n**[Permissions](#permissions) required:** None\n\nThe dashboard to be deleted must be owned by the user.","operationId":"deleteDashboard","parameters":[{"name":"id","in":"path","description":"The ID of the dashboard.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the dashboard is deleted."},"400":{"description":"400 response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:dashboard:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/dashboard/{id}/copy":{"post":{"tags":["Dashboards"],"summary":"Copy dashboard","description":"Copies a dashboard. Any values provided in the `dashboard` parameter replace those in the copied dashboard.\n\n**[Permissions](#permissions) required:** None\n\nThe dashboard to be copied must be owned by or shared with the user.","operationId":"copyDashboard","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dashboard details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardDetails"},"example":{"description":"A dashboard to help auditors identify sample of issues to check.","editPermissions":[],"name":"Auditors dashboard","sharePermissions":[{"type":"global"}]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"},"example":"{\"id\":\"10000\",\"isFavourite\":false,\"name\":\"System Dashboard\",\"popularity\":1,\"self\":\"https://your-domain.atlassian.net/rest/api/3/dashboard/10000\",\"sharePermissions\":[{\"type\":\"global\"}],\"view\":\"https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000\"}"}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"404":{"description":"Returned if the dashboard is not found or the dashboard is not owned by or shared with the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:dashboard:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","write:dashboard:jira","read:application-role:jira","read:avatar:jira","read:issue-type-hierarchy:jira","read:issue-type:jira","read:project-category:jira","read:project-version:jira","read:project.component:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/events":{"get":{"tags":["Issues"],"summary":"Get events","description":"Returns all issue events.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getEvents","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IssueEvent"}},"example":"[{\"id\":1,\"name\":\"Issue Created\"},{\"id\":2,\"name\":\"Issue Updated\"}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to complete this request."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-event:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/expression/analyse":{"post":{"tags":["Jira expressions"],"summary":"Analyse Jira expression","description":"Analyses and validates Jira expressions.\n\nAs an experimental feature, this operation can also attempt to type-check the expressions.\n\nLearn more about Jira expressions in the [documentation](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/).\n\n**[Permissions](#permissions) required**: None.","operationId":"analyseExpression","parameters":[{"name":"check","in":"query","description":"The check to perform:\n\n *  `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.\n *  `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.\n *  `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.","schema":{"type":"string","default":"syntax","enum":["syntax","type","complexity"]}}],"requestBody":{"description":"The Jira expressions to analyse.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JiraExpressionForAnalysis"},"example":{"contextVariables":{"listOfStrings":"List<String>","record":"{ a: Number, b: String }","value":"User"},"expressions":["issues.map(issue => issue.properties['property_key'])"]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JiraExpressionsAnalysis"},"example":"{\"results\":[{\"expression\":\"analysed expression\",\"errors\":[{\"line\":1,\"column\":4,\"message\":\"!, -, typeof, (, IDENTIFIER, null, true, false, NUMBER, STRING, TEMPLATE_LITERAL, new, [ or { expected, > encountered.\",\"type\":\"syntax\"},{\"message\":\"Jira expression is too long (1040), limit: 1000 characters\",\"type\":\"other\"},{\"message\":\"Jira expression has too many nodes (150), limit: 100 leaves\",\"type\":\"other\"}],\"valid\":false},{\"expression\":\"issues.map(i => {idAndKey: [i.id, i.key], summary: i.summary, comments: i.comments})\",\"valid\":true,\"type\":\"List<{idAndKey: [Number, String], summary: String, comments: List<Comment>}>\",\"complexity\":{\"expensiveOperations\":\"N\",\"variables\":{\"N\":\"issues\"}}},{\"expression\":\"issues.map(i => i.id > '0')\",\"errors\":[{\"expression\":\"i.id > 0\",\"message\":\"Can't compare Number to String.\",\"type\":\"type\"}],\"valid\":false,\"type\":\"TypeError\"}]}"}}},"400":{"description":"400 response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"404 response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work","read:jira-user"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work","read:jira-user"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira","read:jira-expressions:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/expression/eval":{"post":{"tags":["Jira expressions"],"summary":"Evaluate Jira expression","description":"Evaluates a Jira expression and returns its value.\n\nThis 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.\n\n#### Context variables ####\n\nThe 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.\n\n *  `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.\n *  `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/)).\n *  `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.\n *  `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.\n *  `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.\n *  `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.\n *  `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.\n *  `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.\n *  `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.\n\nAlso, 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:\n\n *  `user`: A [user](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user) specified as an Atlassian account ID.\n *  `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.\n *  `json`: A JSON object containing custom content.\n *  `list`: A JSON list of `user`, `issue`, or `json` variable types.\n\nThis operation can be accessed anonymously.\n\n**[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.  \nPermission to access Jira Software is required to access Jira Software context variables (`board` and `sprint`) or fields (for example, `issue.sprint`).","operationId":"evaluateJiraExpression","parameters":[{"name":"expand","in":"query","description":"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.","schema":{"type":"string"}}],"requestBody":{"description":"The Jira expression and the evaluation context.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JiraExpressionEvalRequestBean"},"example":{"context":{"board":10100,"custom":{"config":{"type":"json","value":{"userId":"10002"}},"issuesList":[{"key":"ACJIRA-1471","type":"issue"},{"id":100001,"type":"issue"}],"myUser":{"accountId":"100001","type":"user"},"nullField":{"type":"json"}},"customerRequest":1450,"issue":{"key":"ACJIRA-1470"},"issues":{"jql":{"maxResults":100,"query":"project = HSP","startAt":0,"validation":"strict"}},"project":{"key":"ACJIRA"},"serviceDesk":10023,"sprint":10001},"expression":"{ key: issue.key, type: issue.issueType.name, links: issue.links.map(link => link.linkedIssue.id), listCustomVariable: issuesList.includes(issue), customVariables: myUser.accountId == config.userId}"}}},"required":true},"responses":{"200":{"description":"Returned if the evaluation results in a value. The result is a JSON primitive value, list, or object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JiraExpressionResult"},"example":"{\"value\":\"The expression's result. This value can be any JSON, not necessarily a String\",\"meta\":{\"complexity\":{\"steps\":{\"value\":1,\"limit\":10000},\"expensiveOperations\":{\"value\":3,\"limit\":10},\"beans\":{\"value\":0,\"limit\":1000},\"primitiveValues\":{\"value\":1,\"limit\":10000}},\"issues\":{\"jql\":{\"startAt\":0,\"maxResults\":1000,\"count\":140,\"totalCount\":140,\"validationWarnings\":[\"There is a problem with the JQL query.\"]}}}}"}}},"400":{"description":"Returned if:\n\n *  the request is invalid, that is:\n    \n     *  invalid data is provided, such as a request including issue ID and key.\n     *  the expression is invalid and can not be parsed.\n *  evaluation fails at runtime. This may happen for various reasons. For example, accessing a property on a null object (such as the expression `issue.id` where `issue` is `null`). In this case an error message is provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Evaluation failed: \\\"issue['a' + 'b']\\\" - Unrecognized property of `issue`: \\\"ab\\\" ('a' + 'b'). Available properties of type 'Issue' are: 'assignee', 'comments', 'description', 'id', 'issueType', 'key', 'priority', 'project', 'properties', 'reporter', 'status', 'summary'\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if any object provided in the request context is not found or the user does not have permission to view it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Issue does not exist or you do not have permission to see it.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work","read:jira-user"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work","read:jira-user"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:jira-expressions:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/field":{"get":{"tags":["Issue fields"],"summary":"Get fields","description":"Returns system and custom issue fields according to the following rules:\n\n *  Fields that cannot be added to the issue navigator are always returned.\n *  Fields that cannot be placed on an issue screen are always returned.\n *  Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches.\n *  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.)\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.","operationId":"getFields","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FieldDetails"}},"example":"[{\"id\":\"description\",\"name\":\"Description\",\"custom\":false,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"description\"],\"schema\":{\"type\":\"string\",\"system\":\"description\"}},{\"id\":\"summary\",\"key\":\"summary\",\"name\":\"Summary\",\"custom\":false,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"summary\"],\"schema\":{\"type\":\"string\",\"system\":\"summary\"}}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira","read:avatar:jira","read:project-category:jira","read:project:jira","read:field-configuration:jira"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Issue fields"],"summary":"Create custom field","description":"Creates a custom field.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createCustomField","parameters":[],"requestBody":{"description":"Definition of the custom field to be created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldDefinitionJsonBean"},"example":{"description":"Custom field for picking groups","name":"New custom field","searcherKey":"com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher","type":"com.atlassian.jira.plugin.system.customfieldtypes:grouppicker"}}},"required":true},"responses":{"201":{"description":"Returned if the custom field is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldDetails"},"example":"{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"New custom field\",\"untranslatedName\":\"New custom field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New custom field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}}"}}},"400":{"description":"Returned if:\n\n *  the user does not have permission to create custom fields.\n *  any of the request object properties have invalid or missing values."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field:jira","read:avatar:jira","read:field:jira","read:project-category:jira","read:project:jira","read:field-configuration:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/field/search":{"get":{"tags":["Issue fields"],"summary":"Get fields paginated","description":"Returns a [paginated](#pagination) list of fields for Classic Jira projects. The list can include:\n\n *  all fields\n *  specific fields, by defining `id`\n *  fields that contain a string in the field name or description, by defining `query`\n *  specific fields that contain a string in the field name or description, by defining `id` and `query`\n\nOnly custom fields can be queried, `type` must be set to `custom`.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getFieldsPaginated","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"type","in":"query","description":"The type of fields to search.","schema":{"type":"array","items":{"type":"string","enum":["custom","system"]}}},{"name":"id","in":"query","description":"The IDs of the custom fields to return or, where `query` is specified, filter.","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"query","in":"query","description":"String used to perform a case-insensitive partial match with field names or descriptions.","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"[Order](#ordering) the results by a field:\n\n *  `contextsCount` sorts by the number of contexts related to a field\n *  `lastUsed` sorts by the date when the value of the field last changed\n *  `name` sorts by the field name\n *  `screensCount` sorts by the number of screens related to a field","schema":{"type":"string","enum":["contextsCount","-contextsCount","+contextsCount","lastUsed","-lastUsed","+lastUsed","name","-name","+name","screensCount","-screensCount","+screensCount","projectsCount","-projectsCount","+projectsCount"]}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `key` returns the key for each field\n *  `lastUsed` returns the date when the value of the field last changed\n *  `screensCount` returns the number of screens related to a field\n *  `contextsCount` returns the number of contexts related to a field\n *  `isLocked` returns information about whether the field is [locked](https://confluence.atlassian.com/x/ZSN7Og)\n *  `searcherKey` returns the searcher key for each custom field","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanField"},"example":"{\"maxResults\":50,\"startAt\":0,\"total\":2,\"isLast\":false,\"values\":[{\"id\":\"customfield_10000\",\"name\":\"Approvers\",\"schema\":{\"type\":\"array\",\"items\":\"user\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker\",\"customId\":10000},\"description\":\"Contains users needed for approval. This custom field was created by Jira Service Desk.\",\"key\":\"customfield_10000\",\"isLocked\":true,\"searcherKey\":\"com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher\",\"screensCount\":2,\"contextsCount\":2,\"lastUsed\":{\"type\":\"TRACKED\",\"value\":\"2019-09-12T10:10:00.954+0000\"}},{\"id\":\"customfield_10001\",\"name\":\"Change reason\",\"schema\":{\"type\":\"option\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:select\",\"customId\":10001},\"description\":\"Choose the reason for the change request\",\"key\":\"customfield_10001\",\"isLocked\":false,\"searcherKey\":\"com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher\",\"screensCount\":2,\"contextsCount\":2,\"projectsCount\":2,\"lastUsed\":{\"type\":\"NOT_TRACKED\"}}]}"}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Only custom fields can be queried.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Only Jira administrators can access fields.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira","read:field-configuration:jira"]}],"x-atlassian-connect-scope":"NONE"}},"/rest/api/3/field/search/trashed":{"get":{"tags":["Issue fields"],"summary":"Get fields in trash paginated","description":"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.\n\nOnly custom fields can be queried, `type` must be set to `custom`.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getTrashedFieldsPaginated","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"id","in":"query","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"query","in":"query","description":"String used to perform a case-insensitive partial match with field names or descriptions.","schema":{"type":"string"}},{"name":"expand","in":"query","schema":{"type":"string","enum":["name","-name","+name","trashDate","-trashDate","+trashDate","plannedDeletionDate","-plannedDeletionDate","+plannedDeletionDate","projectsCount","-projectsCount","+projectsCount"]}},{"name":"orderBy","in":"query","description":"[Order](#ordering) the results by a field:\n\n *  `name` sorts by the field name\n *  `trashDate` sorts by the date the field was moved to the trash\n *  `plannedDeletionDate` sorts by the planned deletion date","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanField"},"example":"{\"maxResults\":50,\"startAt\":0,\"total\":1,\"isLast\":false,\"values\":[{\"id\":\"customfield_10000\",\"name\":\"Approvers\",\"schema\":{\"type\":\"array\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker\",\"customId\":10003},\"description\":\"Contains users needed for approval. This custom field was created by Jira Service Desk.\",\"key\":\"customfield_10003\",\"trashedDate\":\"2019-09-12T10:10:00.955+0000\",\"trashedBy\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"plannedDeletionDate\":\"2019-09-30T10:10:00.955+0000\"}]}"}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Only custom fields can be queried.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Only Jira administrators can access fields.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira","read:field-configuration:jira","read:user:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/field/{fieldId}":{"put":{"tags":["Issue fields"],"summary":"Update custom field","description":"Updates a custom field.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updateCustomField","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The custom field update details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomFieldDetails"},"example":{"description":"Select the manager and the corresponding employee.","name":"Managers and employees list","searcherKey":"com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"searcherKey is invalid for the field type.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can edit custom fields.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the custom field is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The custom field was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/field/{fieldId}/context":{"get":{"tags":["Issue custom field contexts"],"summary":"Get custom field contexts","description":"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:\n\n *  With no other parameters set, all contexts.\n *  By defining `id` only, all contexts from the list of IDs.\n *  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)\n *  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).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getContextsForField","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}},{"name":"isAnyIssueType","in":"query","description":"Whether to return contexts that apply to all issue types.","schema":{"type":"boolean"}},{"name":"isGlobalContext","in":"query","description":"Whether to return contexts that apply to all projects.","schema":{"type":"boolean"}},{"name":"contextId","in":"query","description":"The list of context IDs. To include multiple contexts, separate IDs with ampersand: `contextId=10000&contextId=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanCustomFieldContext"},"example":"{\"maxResults\":100,\"startAt\":0,\"total\":2,\"isLast\":true,\"values\":[{\"id\":\"10025\",\"name\":\"Bug fields context\",\"description\":\"A context used to define the custom field options for bugs.\",\"isGlobalContext\":true,\"isAnyIssueType\":false},{\"id\":\"10026\",\"name\":\"Task fields context\",\"description\":\"A context used to define the custom field options for tasks.\",\"isGlobalContext\":false,\"isAnyIssueType\":false}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access custom field contexts.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the custom field was not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The custom field was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira","read:custom-field-contextual-configuration:jira"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Issue custom field contexts"],"summary":"Create custom field context","description":"Creates a custom field context.\n\nIf `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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createCustomFieldContext","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomFieldContext"},"example":{"description":"A context used to define the custom field options for bugs.","issueTypeIds":["10010"],"name":"Bug fields context","projectIds":[]}}},"required":true},"responses":{"201":{"description":"Returned if the custom field context is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomFieldContext"},"example":"{\"id\":\"10025\",\"name\":\"Bug fields context\",\"description\":\"A context used to define the custom field options for bugs.\",\"projectIds\":[],\"issueTypeIds\":[\"10010\"]}"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the field, project, or issue type is not found."},"409":{"description":"Returned if the issue type is a sub-task, but sub-tasks are disabled in Jira settings.","content":{"application/json":{"example":"{\"errorMessages\":[\"Sub-tasks are disabled in Jira. At least one of the issue types is a sub-task.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira","write:field:jira","read:custom-field-contextual-configuration:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/field/{fieldId}/context/defaultValue":{"get":{"tags":["Issue custom field contexts"],"summary":"Get custom field contexts default values","description":"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.  \nThe returned object depends on type of the custom field:\n\n *  `CustomFieldContextDefaultValueDate` (type `datepicker`) for date fields.\n *  `CustomFieldContextDefaultValueDateTime` (type `datetimepicker`) for date-time fields.\n *  `CustomFieldContextDefaultValueSingleOption` (type `option.single`) for single choice select lists and radio buttons.\n *  `CustomFieldContextDefaultValueMultipleOption` (type `option.multiple`) for multiple choice select lists and checkboxes.\n *  `CustomFieldContextDefaultValueCascadingOption` (type `option.cascading`) for cascading select lists.\n *  `CustomFieldContextSingleUserPickerDefaults` (type `single.user.select`) for single users.\n *  `CustomFieldContextDefaultValueMultiUserPicker` (type `multi.user.select`) for user lists.\n *  `CustomFieldContextDefaultValueSingleGroupPicker` (type `grouppicker.single`) for single choice group pickers.\n *  `CustomFieldContextDefaultValueMultipleGroupPicker` (type `grouppicker.multiple`) for multiple choice group pickers.\n *  `CustomFieldContextDefaultValueURL` (type `url`) for URLs.\n *  `CustomFieldContextDefaultValueProject` (type `project`) for project pickers.\n *  `CustomFieldContextDefaultValueFloat` (type `float`) for floats (floating-point numbers).\n *  `CustomFieldContextDefaultValueLabels` (type `labels`) for labels.\n *  `CustomFieldContextDefaultValueTextField` (type `textfield`) for text fields.\n *  `CustomFieldContextDefaultValueTextArea` (type `textarea`) for text area fields.\n *  `CustomFieldContextDefaultValueReadOnly` (type `readonly`) for read only (text) fields.\n *  `CustomFieldContextDefaultValueMultipleVersion` (type `version.multiple`) for single choice version pickers.\n *  `CustomFieldContextDefaultValueSingleVersion` (type `version.single`) for multiple choice version pickers.\n\nForge custom fields [types](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/#data-types) are also supported, returning:\n\n *  `CustomFieldContextDefaultValueForgeStringFieldBean` (type `forge.string`) for Forge string fields.\n *  `CustomFieldContextDefaultValueForgeMultiStringFieldBean` (type `forge.string.list`) for Forge string collection fields.\n *  `CustomFieldContextDefaultValueForgeObjectFieldBean` (type `forge.object`) for Forge object fields.\n *  `CustomFieldContextDefaultValueForgeDateTimeFieldBean` (type `forge.datetime`) for Forge date-time fields.\n *  `CustomFieldContextDefaultValueForgeGroupFieldBean` (type `forge.group`) for Forge group fields.\n *  `CustomFieldContextDefaultValueForgeMultiGroupFieldBean` (type `forge.group.list`) for Forge group collection fields.\n *  `CustomFieldContextDefaultValueForgeNumberFieldBean` (type `forge.number`) for Forge number fields.\n *  `CustomFieldContextDefaultValueForgeUserFieldBean` (type `forge.user`) for Forge user fields.\n *  `CustomFieldContextDefaultValueForgeMultiUserFieldBean` (type `forge.user.list`) for Forge user collection fields.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getDefaultValues","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field, for example `customfield\\_10000`.","required":true,"schema":{"type":"string"}},{"name":"contextId","in":"query","description":"The IDs of the contexts.","schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanCustomFieldContextDefaultValue"},"example":"{\"maxResults\":50,\"startAt\":0,\"total\":3,\"isLast\":true,\"values\":[{\"type\":\"option.single\",\"contextId\":\"10100\",\"optionId\":\"10001\"},{\"type\":\"option.single\",\"contextId\":\"10101\",\"optionId\":\"10003\"},{\"type\":\"option.single\",\"contextId\":\"10103\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access custom field contexts.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the custom field is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The custom field was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field.default-value:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Issue custom field contexts"],"summary":"Set custom field contexts default values","description":"Sets default for contexts of a custom field. Default are defined using these objects:\n\n *  `CustomFieldContextDefaultValueDate` (type `datepicker`) for date fields.\n *  `CustomFieldContextDefaultValueDateTime` (type `datetimepicker`) for date-time fields.\n *  `CustomFieldContextDefaultValueSingleOption` (type `option.single`) for single choice select lists and radio buttons.\n *  `CustomFieldContextDefaultValueMultipleOption` (type `option.multiple`) for multiple choice select lists and checkboxes.\n *  `CustomFieldContextDefaultValueCascadingOption` (type `option.cascading`) for cascading select lists.\n *  `CustomFieldContextSingleUserPickerDefaults` (type `single.user.select`) for single users.\n *  `CustomFieldContextDefaultValueMultiUserPicker` (type `multi.user.select`) for user lists.\n *  `CustomFieldContextDefaultValueSingleGroupPicker` (type `grouppicker.single`) for single choice group pickers.\n *  `CustomFieldContextDefaultValueMultipleGroupPicker` (type `grouppicker.multiple`) for multiple choice group pickers.\n *  `CustomFieldContextDefaultValueURL` (type `url`) for URLs.\n *  `CustomFieldContextDefaultValueProject` (type `project`) for project pickers.\n *  `CustomFieldContextDefaultValueFloat` (type `float`) for floats (floating-point numbers).\n *  `CustomFieldContextDefaultValueLabels` (type `labels`) for labels.\n *  `CustomFieldContextDefaultValueTextField` (type `textfield`) for text fields.\n *  `CustomFieldContextDefaultValueTextArea` (type `textarea`) for text area fields.\n *  `CustomFieldContextDefaultValueReadOnly` (type `readonly`) for read only (text) fields.\n *  `CustomFieldContextDefaultValueMultipleVersion` (type `version.multiple`) for single choice version pickers.\n *  `CustomFieldContextDefaultValueSingleVersion` (type `version.single`) for multiple choice version pickers.\n\nForge custom fields [types](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/#data-types) are also supported, returning:\n\n *  `CustomFieldContextDefaultValueForgeStringFieldBean` (type `forge.string`) for Forge string fields.\n *  `CustomFieldContextDefaultValueForgeMultiStringFieldBean` (type `forge.string.list`) for Forge string collection fields.\n *  `CustomFieldContextDefaultValueForgeObjectFieldBean` (type `forge.object`) for Forge object fields.\n *  `CustomFieldContextDefaultValueForgeDateTimeFieldBean` (type `forge.datetime`) for Forge date-time fields.\n *  `CustomFieldContextDefaultValueForgeGroupFieldBean` (type `forge.group`) for Forge group fields.\n *  `CustomFieldContextDefaultValueForgeMultiGroupFieldBean` (type `forge.group.list`) for Forge group collection fields.\n *  `CustomFieldContextDefaultValueForgeNumberFieldBean` (type `forge.number`) for Forge number fields.\n *  `CustomFieldContextDefaultValueForgeUserFieldBean` (type `forge.user`) for Forge user fields.\n *  `CustomFieldContextDefaultValueForgeMultiUserFieldBean` (type `forge.user.list`) for Forge user collection fields.\n\nOnly one type of default object can be included in a request. To remove a default for a context, set the default parameter to `null`.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"setDefaultValues","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldContextDefaultValueUpdate"},"example":{"defaultValues":[{"contextId":"10100","optionId":"10001","type":"option.single"},{"contextId":"10101","optionId":"10003","type":"option.single"},{"contextId":"10103","optionId":"10005","type":"option.single"}]}}},"required":true},"responses":{"204":{"description":"Returned if operation is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"All default values in the request must have the same type.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access custom field contexts.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the custom field, a context, an option, or a cascading option is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field.default-value:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/field/{fieldId}/context/issuetypemapping":{"get":{"tags":["Issue custom field contexts"],"summary":"Get issue types for custom field context","description":"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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getIssueTypeMappingsForContexts","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}},{"name":"contextId","in":"query","description":"The ID of the context. To include multiple contexts, provide an ampersand-separated list. For example, `contextId=10001&contextId=10002`.","schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"Returned if operation is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanIssueTypeToContextMapping"},"example":"{\"maxResults\":100,\"startAt\":0,\"total\":3,\"isLast\":true,\"values\":[{\"contextId\":\"10001\",\"issueTypeId\":\"10010\"},{\"contextId\":\"10001\",\"issueTypeId\":\"10011\"},{\"contextId\":\"10002\",\"isAnyIssueType\":true}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access custom field contexts.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/field/{fieldId}/context/mapping":{"post":{"tags":["Issue custom field contexts"],"summary":"Get custom field contexts for projects and issue types","description":"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.\n\nIf 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`.\n\nDuplicate project and issue type mappings cannot be provided in the request.\n\nThe order of the returned values is the same as provided in the request.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getCustomFieldContextsForProjectsAndIssueTypes","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}}],"requestBody":{"description":"The list of project and issue type mappings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectIssueTypeMappings"},"example":{"mappings":[{"issueTypeId":"10000","projectId":"10000"},{"issueTypeId":"10001","projectId":"10000"},{"issueTypeId":"10002","projectId":"10001"}]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanContextForProjectAndIssueType"},"example":"{\"maxResults\":50,\"startAt\":0,\"total\":3,\"isLast\":true,\"values\":[{\"projectId\":\"10000\",\"issueTypeId\":\"10000\",\"contextId\":\"10000\"},{\"projectId\":\"10000\",\"issueTypeId\":\"10001\",\"contextId\":null},{\"projectId\":\"10001\",\"issueTypeId\":\"10002\",\"contextId\":\"10003\"}]}"}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"Duplicate project and issue type mappings cannot be provided.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access custom field contexts.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the custom field, project, or issue type is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"These projects were not found: 10005.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/field/{fieldId}/context/projectmapping":{"get":{"tags":["Issue custom field contexts"],"summary":"Get project mappings for custom field context","description":"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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getProjectContextMapping","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field, for example `customfield\\_10000`.","required":true,"schema":{"type":"string"}},{"name":"contextId","in":"query","description":"The list of context IDs. To include multiple context, separate IDs with ampersand: `contextId=10000&contextId=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanCustomFieldContextProjectMapping"},"example":"{\"maxResults\":100,\"startAt\":0,\"total\":2,\"isLast\":true,\"values\":[{\"contextId\":\"10025\",\"projectId\":\"10001\"},{\"contextId\":\"10026\",\"isGlobalContext\":true}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access custom field contexts.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the custom field is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The custom field was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/field/{fieldId}/context/{contextId}":{"put":{"tags":["Issue custom field contexts"],"summary":"Update custom field context","description":"Updates a [ custom field context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updateCustomFieldContext","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}},{"name":"contextId","in":"path","description":"The ID of the context.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldContextUpdateDetails"},"example":{"description":"A context used to define the custom field options for bugs.","name":"Bug fields context"}}},"required":true},"responses":{"204":{"description":"Returned if the context is updated.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The contextId has to be provided.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access custom field contexts.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the custom field or the context is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Issue custom field contexts"],"summary":"Delete custom field context","description":"Deletes a [ custom field context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deleteCustomFieldContext","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}},{"name":"contextId","in":"path","description":"The ID of the context.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the context is deleted.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The contextId has to be provided.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access custom field contexts.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the custom field or the context is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:field:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/field/{fieldId}/context/{contextId}/issuetype":{"put":{"tags":["Issue custom field contexts"],"summary":"Add issue types to context","description":"Adds issue types to a custom field context, appending the issue types to the issue types list.\n\nA 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.\n\nIf any of the issue types exists in the custom field context, the operation fails and no issue types are added.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"addIssueTypesToContext","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}},{"name":"contextId","in":"path","description":"The ID of the context.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeIds"},"example":{"issueTypeIds":["10001","10005","10006"]}}},"required":true},"responses":{"204":{"description":"Returned if operation is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"These issue types are already associated with the context: 10001.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access custom field contexts.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the custom field, context, or one or more issue types are not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}"}}},"409":{"description":"Returned if the issue type is a sub-task, but sub-tasks are disabled in Jira settings.","content":{"application/json":{"example":"{\"errorMessages\":[\"Sub-tasks are disabled in Jira. At least one of the issue types is a sub-task.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove":{"post":{"tags":["Issue custom field contexts"],"summary":"Remove issue types from context","description":"Removes issue types from a custom field context.\n\nA custom field context without any issue types applies to all issue types.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"removeIssueTypesFromContext","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}},{"name":"contextId","in":"path","description":"The ID of the context.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeIds"},"example":{"issueTypeIds":["10001","10005","10006"]}}},"required":true},"responses":{"204":{"description":"Returned if operation is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"These issue types are not associated with the context: 10002.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access custom field contexts.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the custom field, context, or one or more issue types are not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/field/{fieldId}/context/{contextId}/option":{"get":{"tags":["Issue custom field options"],"summary":"Get custom field options (context)","description":"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.\n\nThis 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.**\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getOptionsForContext","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}},{"name":"contextId","in":"path","description":"The ID of the context.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"optionId","in":"query","description":"The ID of the option.","schema":{"type":"integer","format":"int64"}},{"name":"onlyOptions","in":"query","description":"Whether only options are returned.","schema":{"type":"boolean","default":false}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanCustomFieldContextOption"},"example":"{\"maxResults\":100,\"startAt\":0,\"total\":4,\"isLast\":true,\"values\":[{\"id\":\"10001\",\"value\":\"New York\"},{\"id\":\"10002\",\"value\":\"Boston\",\"disabled\":true},{\"id\":\"10004\",\"value\":\"Denver\"},{\"id\":\"10003\",\"value\":\"Brooklyn\",\"optionId\":\"10001\"}]}"}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The custom field doesn't support options.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can manage custom field options.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the custom field is not found or the context doesn't match the custom field.","content":{"application/json":{"example":"{\"errorMessages\":[\"The custom field was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field.option:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Issue custom field options"],"summary":"Update custom field options (context)","description":"Updates the options of a custom field.\n\nIf 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.\n\nNote 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updateCustomFieldOption","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}},{"name":"contextId","in":"path","description":"The ID of the context.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCustomFieldOptionUpdateRequest"},"example":{"options":[{"disabled":false,"id":"10001","value":"Scranton"},{"disabled":true,"id":"10002","value":"Manhattan"},{"disabled":false,"id":"10003","value":"The Electric City"}]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldUpdatedContextOptionsList"},"example":"{\"options\":[{\"id\":\"10001\",\"value\":\"Scranton\",\"disabled\":false},{\"id\":\"10002\",\"value\":\"Manhattan\",\"disabled\":true},{\"id\":\"10003\",\"value\":\"The Electric City\",\"disabled\":false}]}"}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The custom field doesn't support options.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can manage custom field options.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the field, context, or one or more options is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The custom field was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field.option:jira","write:field.option:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Issue custom field options"],"summary":"Create custom field options (context)","description":"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.\n\nThe maximum number of options that can be created per request is 1000 and each field can have a maximum of 10000 options.\n\nThis 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.**\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createCustomFieldOption","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}},{"name":"contextId","in":"path","description":"The ID of the context.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCustomFieldOptionCreateRequest"},"example":{"options":[{"disabled":false,"value":"Scranton"},{"disabled":true,"optionId":"10000","value":"Manhattan"},{"disabled":false,"value":"The Electric City"}]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldCreatedContextOptionsList"},"example":"{\"options\":[{\"id\":\"10001\",\"value\":\"Scranton\",\"disabled\":false},{\"id\":\"10002\",\"value\":\"Manhattan\",\"optionId\":\"10000\",\"disabled\":true},{\"id\":\"10003\",\"value\":\"The Electric City\",\"disabled\":false}]}"}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The custom field doesn't support options.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can manage custom field options.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the custom field is not found or the context doesn't match the custom field.","content":{"application/json":{"example":"{\"errorMessages\":[\"The custom field was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field.option:jira","write:field.option:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/field/{fieldId}/context/{contextId}/option/move":{"put":{"tags":["Issue custom field options"],"summary":"Reorder custom field options (context)","description":"Changes the order of custom field options or cascading options in a context.\n\nThis 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.**\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"reorderCustomFieldOptions","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}},{"name":"contextId","in":"path","description":"The ID of the context.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderOfCustomFieldOptions"},"example":{"customFieldOptionIds":["10001","10002"],"position":"First"}}},"required":true},"responses":{"204":{"description":"Returned if options are reordered.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"'after' and 'position' were provided. Only 'after' or 'position' can be specified.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can manage custom field options.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the field, the context, or one or more of the options is not found..","content":{"application/json":{"example":"{\"errorMessages\":[\"The custom field was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field.option:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}":{"delete":{"tags":["Issue custom field options"],"summary":"Delete custom field options (context)","description":"Deletes a custom field option.\n\nOptions with cascading options cannot be deleted without deleting the cascading options first.\n\nThis 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.**\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deleteCustomFieldOption","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}},{"name":"contextId","in":"path","description":"The ID of the context from which an option should be deleted.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"optionId","in":"path","description":"The ID of the option to delete.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the option is deleted."},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The custom field doesn't support options.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can manage custom field options.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the field, the context, or the option is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The custom field was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:field.option:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/field/{fieldId}/context/{contextId}/project":{"put":{"tags":["Issue custom field contexts"],"summary":"Assign custom field context to projects","description":"Assigns a custom field context to projects.\n\nIf any project in the request is assigned to any context of the custom field, the operation fails.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"assignProjectsToCustomFieldContext","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}},{"name":"contextId","in":"path","description":"The ID of the context.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectIds"},"example":{"projectIds":["10001","10005","10006"]}}},"required":true},"responses":{"204":{"description":"Returned if operation is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The projectIds must not contain duplicates.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access custom field contexts.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the custom field, context, or project is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/field/{fieldId}/context/{contextId}/project/remove":{"post":{"tags":["Issue custom field contexts"],"summary":"Remove custom field context from projects","description":"Removes a custom field context from projects.\n\nA 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.\n\nIf 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"removeCustomFieldContextFromProjects","parameters":[{"name":"fieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}},{"name":"contextId","in":"path","description":"The ID of the context.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectIds"},"example":{"projectIds":["10001","10005","10006"]}}},"required":true},"responses":{"204":{"description":"Returned if the custom field context is removed from the projects.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The projectIds must not contain duplicates.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access custom field contexts.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the custom field, context, or one or more projects are not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/field/{fieldId}/contexts":{"get":{"tags":["Issue fields"],"summary":"Get contexts for a field","description":"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).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getContextsForFieldDeprecated","parameters":[{"name":"fieldId","in":"path","description":"The ID of the field to return contexts for.","required":true,"schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanContext"},"example":"{\"maxResults\":1,\"startAt\":0,\"total\":5,\"isLast\":false,\"values\":[{\"id\":10001,\"name\":\"Default Context\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."}},"deprecated":true,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira","read:avatar:jira","read:project-category:jira","read:project:jira"]}],"x-atlassian-connect-scope":"NONE"}},"/rest/api/3/field/{fieldId}/screens":{"get":{"tags":["Screens"],"summary":"Get screens for a field","description":"Returns a [paginated](#pagination) list of the screens a field is used in.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getScreensForField","parameters":[{"name":"fieldId","in":"path","description":"The ID of the field to return screens for.","required":true,"schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":100}},{"name":"expand","in":"query","description":"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.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanScreenWithTab"},"example":"{\"maxResults\":1,\"startAt\":0,\"total\":5,\"isLast\":false,\"values\":[{\"id\":10001,\"name\":\"Default Screen\",\"description\":\"Provides for the update of all system fields.\",\"tab\":{\"id\":10000,\"name\":\"Fields Tab\"}}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:screen:jira","read:avatar:jira","read:project-category:jira","read:project:jira","read:screen-tab:jira"]}],"x-atlassian-connect-scope":"NONE"}},"/rest/api/3/field/{fieldKey}/option":{"get":{"tags":["Issue custom field options (apps)"],"summary":"Get all issue field options","description":"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.\n\nNote 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.","operationId":"getAllIssueFieldOptions","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"fieldKey","in":"path","description":"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:\n\n *  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.\n *  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":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanIssueFieldOption"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option?startAt=0&maxResults=1\",\"nextPage\":\"https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option?startAt=1&maxResults=1\",\"maxResults\":1,\"startAt\":0,\"total\":10,\"isLast\":false,\"values\":[{\"id\":1,\"value\":\"Team 1\",\"properties\":{\"leader\":{\"name\":\"Leader Name\",\"email\":\"lname@example.com\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"},\"config\":{\"scope\":{\"projects\":[],\"projects2\":[{\"id\":1002,\"attributes\":[\"notSelectable\"]},{\"id\":1001,\"attributes\":[\"notSelectable\"]}],\"global\":{}},\"attributes\":[]}}]}"}}},"400":{"description":"Returned if the field is not found or does not support options."},"403":{"description":"Returned if the request is not authenticated as a Jira administrator or the app that provided the field."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field.option:jira"]}],"x-atlassian-connect-scope":"NONE"},"post":{"tags":["Issue custom field options (apps)"],"summary":"Create issue field option","description":"Creates an option for a select list issue field.\n\nNote 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.","operationId":"createIssueFieldOption","parameters":[{"name":"fieldKey","in":"path","description":"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:\n\n *  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.\n *  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":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueFieldOptionCreateBean"},"example":{"config":{"attributes":[],"scope":{"global":{},"projects":[],"projects2":[{"attributes":["notSelectable"],"id":1002},{"attributes":["notSelectable"],"id":1001}]}},"properties":{"description":"The team's description","founded":"2016-06-06","leader":{"email":"lname@example.com","name":"Leader Name"},"members":42},"value":"Team 1"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueFieldOption"},"example":"{\"id\":1,\"value\":\"Team 1\",\"properties\":{\"leader\":{\"name\":\"Leader Name\",\"email\":\"lname@example.com\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"},\"config\":{\"scope\":{\"projects\":[],\"projects2\":[{\"id\":1002,\"attributes\":[\"notSelectable\"]},{\"id\":1001,\"attributes\":[\"notSelectable\"]}],\"global\":{}},\"attributes\":[]}}"}}},"400":{"description":"Returned if the option is invalid."},"403":{"description":"Returned if the request is not authenticated as a Jira administrator or the app that provided the field."},"404":{"description":"Returned if the field is not found or does not support options."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field.option:jira"]}],"x-atlassian-connect-scope":"NONE"}},"/rest/api/3/field/{fieldKey}/option/suggestions/edit":{"get":{"tags":["Issue custom field options (apps)"],"summary":"Get selectable issue field options","description":"Returns a [paginated](#pagination) list of options for a select list issue field that can be viewed and selected by the user.\n\nNote 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.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getSelectableIssueFieldOptions","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"projectId","in":"query","description":"Filters the results to options that are only available in the specified project.","schema":{"type":"integer","format":"int64"}},{"name":"fieldKey","in":"path","description":"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:\n\n *  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.\n *  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":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanIssueFieldOption"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=0&maxResults=1\",\"nextPage\":\"https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=1&maxResults=1\",\"maxResults\":1,\"startAt\":0,\"total\":10,\"isLast\":false,\"values\":[{\"id\":1,\"value\":\"Team 1\",\"properties\":{\"leader\":{\"name\":\"Leader Name\",\"email\":\"lname@example.com\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"}}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the field is not found or does not support options."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field.option:jira"]}],"x-atlassian-connect-scope":"NONE"}},"/rest/api/3/field/{fieldKey}/option/suggestions/search":{"get":{"tags":["Issue custom field options (apps)"],"summary":"Get visible issue field options","description":"Returns a [paginated](#pagination) list of options for a select list issue field that can be viewed by the user.\n\nNote 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.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getVisibleIssueFieldOptions","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32"}},{"name":"projectId","in":"query","description":"Filters the results to options that are only available in the specified project.","schema":{"type":"integer","format":"int64"}},{"name":"fieldKey","in":"path","description":"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:\n\n *  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.\n *  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":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanIssueFieldOption"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=0&maxResults=1\",\"nextPage\":\"https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=1&maxResults=1\",\"maxResults\":1,\"startAt\":0,\"total\":10,\"isLast\":false,\"values\":[{\"id\":1,\"value\":\"Team 1\",\"properties\":{\"leader\":{\"name\":\"Leader Name\",\"email\":\"lname@example.com\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"}}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the field is not found or does not support options."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field.option:jira"]}],"x-atlassian-connect-scope":"NONE"}},"/rest/api/3/field/{fieldKey}/option/{optionId}":{"get":{"tags":["Issue custom field options (apps)"],"summary":"Get issue field option","description":"Returns an option from a select list issue field.\n\nNote 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.","operationId":"getIssueFieldOption","parameters":[{"name":"fieldKey","in":"path","description":"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:\n\n *  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.\n *  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":true,"schema":{"type":"string"}},{"name":"optionId","in":"path","description":"The ID of the option to be returned.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the requested option is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueFieldOption"},"example":"{\"id\":1,\"value\":\"Team 1\",\"properties\":{\"leader\":{\"name\":\"Leader Name\",\"email\":\"lname@example.com\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"},\"config\":{\"scope\":{\"projects\":[],\"projects2\":[{\"id\":1002,\"attributes\":[\"notSelectable\"]},{\"id\":1001,\"attributes\":[\"notSelectable\"]}],\"global\":{}},\"attributes\":[]}}"}}},"400":{"description":"Returned if the field is not found or does not support options."},"403":{"description":"Returned if the request is not authenticated as a Jira administrator or the app that provided the field."},"404":{"description":"Returned if the option is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field.option:jira"]}],"x-atlassian-connect-scope":"NONE"},"put":{"tags":["Issue custom field options (apps)"],"summary":"Update issue field option","description":"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.\n\nNote 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.","operationId":"updateIssueFieldOption","parameters":[{"name":"fieldKey","in":"path","description":"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:\n\n *  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.\n *  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":true,"schema":{"type":"string"}},{"name":"optionId","in":"path","description":"The ID of the option to be updated.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueFieldOption"},"example":{"config":{"attributes":[],"scope":{"global":{},"projects":[],"projects2":[{"attributes":["notSelectable"],"id":1002},{"attributes":["notSelectable"],"id":1001}]}},"id":1,"properties":{"description":"The team's description","founded":"2016-06-06","leader":{"email":"lname@example.com","name":"Leader Name"},"members":42},"value":"Team 1"}}},"required":true},"responses":{"200":{"description":"Returned if the option is updated or created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueFieldOption"},"example":"{\"id\":1,\"value\":\"Team 1\",\"properties\":{\"leader\":{\"name\":\"Leader Name\",\"email\":\"lname@example.com\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"},\"config\":{\"scope\":{\"projects\":[],\"projects2\":[{\"id\":1002,\"attributes\":[\"notSelectable\"]},{\"id\":1001,\"attributes\":[\"notSelectable\"]}],\"global\":{}},\"attributes\":[]}}"}}},"400":{"description":"Returned if the option is invalid, or the *ID* in the request object does not match the *optionId* parameter."},"403":{"description":"Returned if the request is not authenticated as a Jira administrator or the app that provided the field."},"404":{"description":"Returned if field is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field.option:jira"]}],"x-atlassian-connect-scope":"NONE"},"delete":{"tags":["Issue custom field options (apps)"],"summary":"Delete issue field option","description":"Deletes an option from a select list issue field.\n\nNote 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.","operationId":"deleteIssueFieldOption","parameters":[{"name":"fieldKey","in":"path","description":"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:\n\n *  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.\n *  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":true,"schema":{"type":"string"}},{"name":"optionId","in":"path","description":"The ID of the option to be deleted.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the field option is deleted.","content":{"application/json":{"schema":{}}}},"403":{"description":"Returned if the request is not authenticated as a Jira administrator or the app that provided the field."},"404":{"description":"Returned if the field or option is not found."},"409":{"description":"Returned if the option is selected for the field in any issue."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:field.option:jira"]}],"x-atlassian-connect-scope":"NONE"}},"/rest/api/3/field/{fieldKey}/option/{optionId}/issue":{"delete":{"tags":["Issue custom field options (apps)"],"summary":"Replace issue field option","description":"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.\n\nConnect 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`.\n\nThis is an [asynchronous operation](#async). The response object contains a link to the long-running task.\n\nNote 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.","operationId":"replaceIssueFieldOption","parameters":[{"name":"replaceWith","in":"query","description":"The ID of the option that will replace the currently selected option.","schema":{"type":"integer","format":"int64"}},{"name":"jql","in":"query","description":"A JQL query that specifies the issues to be updated. For example, *project=10000*.","schema":{"type":"string"}},{"name":"overrideScreenSecurity","in":"query","description":"Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with admin permission.","schema":{"type":"boolean","default":false}},{"name":"overrideEditableFlag","in":"query","description":"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).","schema":{"type":"boolean","default":false}},{"name":"fieldKey","in":"path","description":"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:\n\n *  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.\n *  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":true,"schema":{"type":"string"}},{"name":"optionId","in":"path","description":"The ID of the option to be deselected.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"303":{"description":"Returned if the long-running task to deselect the option is started.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskProgressBeanRemoveOptionFromIssuesResult"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/task/1\",\"id\":\"1\",\"description\":\"Remove option 1 from issues matched by '*', and replace with option 3\",\"status\":\"COMPLETE\",\"result\":{\"modifiedIssues\":[10001,10010],\"unmodifiedIssues\":[10005],\"errors\":{\"errors\":{},\"errorMessages\":[\"Option 2 cannot be set on issue MKY-5 as it is not in the correct scope\"],\"httpStatusCode\":{\"empty\":false,\"present\":true}}},\"elapsedRuntime\":42}"}}},"400":{"description":"Returned if the request is not valid."},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"example":"{\"errorMessages\":[\"Connect and Forge app users with Administer Jira global permission can override screen security.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the field is not found or does not support options, or the options to be replaced are not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field.option:jira","delete:field.option:jira"]}],"x-atlassian-connect-scope":"NONE"}},"/rest/api/3/field/{id}":{"delete":{"tags":["Issue fields"],"summary":"Delete custom field","description":"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.\n\nThis 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deleteCustomField","parameters":[{"name":"id","in":"path","description":"The ID of a custom field.","required":true,"schema":{"type":"string"}}],"responses":{"303":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskProgressBeanObject"}}}},"400":{"description":"Returned if any of these are true:\n\n *  The custom field is locked.\n *  The custom field is used in a issue security scheme or a permission scheme.\n *  The custom field ID format is incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"404":{"description":"Returned if the custom field is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"409":{"description":"Returned if a task to delete the custom field is running.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:field:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/field/{id}/restore":{"post":{"tags":["Issue fields"],"summary":"Restore custom field from trash","description":"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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"restoreCustomField","parameters":[{"name":"id","in":"path","description":"The ID of a custom field.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"404":{"description":"Returned if the custom field is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/field/{id}/trash":{"post":{"tags":["Issue fields"],"summary":"Move custom field to trash","description":"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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"trashCustomField","parameters":[{"name":"id","in":"path","description":"The ID of a custom field.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"404":{"description":"Returned if the custom field is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:field:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/fieldconfiguration":{"get":{"tags":["Issue field configurations"],"summary":"Get all field configurations","description":"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:\n\n *  a list of field configuration item IDs.\n *  whether the field configuration is a default.\n *  whether the field configuration name or description contains a query string.\n\nOnly field configurations used in company-managed (classic) projects are returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getAllFieldConfigurations","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"id","in":"query","description":"The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"isDefault","in":"query","description":"If *true* returns default field configurations only.","schema":{"type":"boolean","default":false}},{"name":"query","in":"query","description":"The query string used to match against field configuration names and descriptions.","schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanFieldConfigurationDetails"},"example":"{\"maxResults\":50,\"startAt\":0,\"total\":2,\"isLast\":true,\"values\":[{\"id\":10000,\"name\":\"Default Field Configuration\",\"description\":\"The default field configuration description\",\"isDefault\":true},{\"id\":10001,\"name\":\"My Field Configuration\",\"description\":\"My field configuration description\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field-configuration:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Issue field configurations"],"summary":"Create field configuration","description":"Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional.\n\nThis operation can only create configurations for use in company-managed (classic) projects.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createFieldConfiguration","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldConfigurationDetails"},"example":{"description":"My field configuration description","name":"My Field Configuration"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldConfiguration"},"example":"{\"id\":10001,\"name\":\"My Field Configuration\",\"description\":\"My field configuration description\"}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field-configuration:jira","write:field-configuration:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/fieldconfiguration/{id}":{"put":{"tags":["Issue field configurations"],"summary":"Update field configuration","description":"Updates a field configuration. The name and the description provided in the request override the existing values.\n\nThis operation can only update configurations used in company-managed (classic) projects.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updateFieldConfiguration","parameters":[{"name":"id","in":"path","description":"The ID of the field configuration.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldConfigurationDetails"},"example":{"description":"A brand new description","name":"My Modified Field Configuration"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the field configuration is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field-configuration:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Issue field configurations"],"summary":"Delete field configuration","description":"Deletes a field configuration.\n\nThis operation can only delete configurations used in company-managed (classic) projects.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deleteFieldConfiguration","parameters":[{"name":"id","in":"path","description":"The ID of the field configuration.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the field configuration is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:field-configuration:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/fieldconfiguration/{id}/fields":{"get":{"tags":["Issue field configurations"],"summary":"Get field configuration items","description":"Returns a [paginated](#pagination) list of all fields for a configuration.\n\nOnly the fields from configurations used in company-managed (classic) projects are returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getFieldConfigurationItems","parameters":[{"name":"id","in":"path","description":"The ID of the field configuration.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanFieldConfigurationItem"},"example":"{\"maxResults\":50,\"startAt\":0,\"total\":2,\"isLast\":true,\"values\":[{\"id\":\"environment\",\"description\":\"For example operating system, software platform and/or hardware specifications (include as appropriate for the issue).\",\"isHidden\":false,\"isRequired\":false},{\"id\":\"description\",\"isHidden\":false,\"isRequired\":false}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the field configuration is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field-configuration:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"put":{"tags":["Issue field configurations"],"summary":"Update field configuration items","description":"Updates fields in a field configuration. The properties of the field configuration fields provided override the existing values.\n\nThis operation can only update field configurations used in company-managed (classic) projects.\n\nThe 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`).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updateFieldConfigurationItems","parameters":[{"name":"id","in":"path","description":"The ID of the field configuration.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldConfigurationItemsDetails"},"example":{"fieldConfigurationItems":[{"description":"The new description of this item.","id":"customfield_10012","isHidden":false},{"id":"customfield_10011","isRequired":true},{"description":"Another new description.","id":"customfield_10010","isHidden":false,"isRequired":false,"renderer":"wiki-renderer"}]}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the field configuration is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field-configuration:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/fieldconfigurationscheme":{"get":{"tags":["Issue field configurations"],"summary":"Get all field configuration schemes","description":"Returns a [paginated](#pagination) list of field configuration schemes.\n\nOnly field configuration schemes used in classic projects are returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getAllFieldConfigurationSchemes","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"id","in":"query","description":"The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanFieldConfigurationScheme"},"example":"{\"maxResults\":10,\"startAt\":0,\"total\":3,\"isLast\":true,\"values\":[{\"id\":\"10000\",\"name\":\"Field Configuration Scheme for Bugs\",\"description\":\"This field configuration scheme is for bugs only.\"},{\"id\":\"10001\",\"name\":\"Field Configuration Scheme for software related projects\",\"description\":\"We can use this one for software projects.\"},{\"id\":\"10002\",\"name\":\"Field Configuration Scheme for Epics\",\"description\":\"Use this one for Epic issue type.\"}]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field-configuration-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Issue field configurations"],"summary":"Create field configuration scheme","description":"Creates a field configuration scheme.\n\nThis operation can only create field configuration schemes used in company-managed (classic) projects.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createFieldConfigurationScheme","parameters":[],"requestBody":{"description":"The details of the field configuration scheme.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFieldConfigurationSchemeDetails"},"example":{"description":"We can use this one for software projects.","name":"Field Configuration Scheme for software related projects"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldConfigurationScheme"},"example":"{\"id\":\"10002\",\"name\":\"Field Configuration Scheme for software related projects\",\"description\":\"We can use this one for software projects.\"}"}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"A field configuration scheme is using this name.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access field configurations.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field-configuration-scheme:jira","read:field-configuration-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/fieldconfigurationscheme/mapping":{"get":{"tags":["Issue field configurations"],"summary":"Get field configuration issue type items","description":"Returns a [paginated](#pagination) list of field configuration issue type items.\n\nOnly items used in classic projects are returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getFieldConfigurationSchemeMappings","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"fieldConfigurationSchemeId","in":"query","description":"The list of field configuration scheme IDs. To include multiple field configuration schemes separate IDs with ampersand: `fieldConfigurationSchemeId=10000&fieldConfigurationSchemeId=10001`.","schema":{"maxItems":50,"minItems":1,"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64","example":10020}}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanFieldConfigurationIssueTypeItem"},"example":"{\"maxResults\":100,\"startAt\":0,\"total\":5,\"isLast\":true,\"values\":[{\"fieldConfigurationSchemeId\":\"10020\",\"issueTypeId\":\"10000\",\"fieldConfigurationId\":\"10010\"},{\"fieldConfigurationSchemeId\":\"10020\",\"issueTypeId\":\"10001\",\"fieldConfigurationId\":\"10010\"},{\"fieldConfigurationSchemeId\":\"10021\",\"issueTypeId\":\"10002\",\"fieldConfigurationId\":\"10000\"},{\"fieldConfigurationSchemeId\":\"10022\",\"issueTypeId\":\"default\",\"fieldConfigurationId\":\"10011\"},{\"fieldConfigurationSchemeId\":\"10023\",\"issueTypeId\":\"default\",\"fieldConfigurationId\":\"10000\"}]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if no field configuration schemes are found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field-configuration-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/fieldconfigurationscheme/project":{"get":{"tags":["Issue field configurations"],"summary":"Get field configuration schemes for projects","description":"Returns a [paginated](#pagination) list of field configuration schemes and, for each scheme, a list of the projects that use it.\n\nThe list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme.\n\nOnly field configuration schemes used in classic projects are returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getFieldConfigurationSchemeProjectMapping","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"projectId","in":"query","description":"The list of project IDs. To include multiple projects, separate IDs with ampersand: `projectId=10000&projectId=10001`.","required":true,"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanFieldConfigurationSchemeProjects"},"example":"{\"maxResults\":50,\"startAt\":0,\"total\":5,\"isLast\":true,\"values\":[{\"projectIds\":[\"10\",\"11\"]},{\"fieldConfigurationScheme\":{\"id\":\"10002\",\"name\":\"Field Configuration Scheme for software related projects\",\"description\":\"We can use this one for software projects.\"},\"projectIds\":[\"12\",\"13\",\"14\"]}]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field-configuration-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"put":{"tags":["Issue field configurations"],"summary":"Assign field configuration scheme to project","description":"Assigns a field configuration scheme to a project. If the field configuration scheme ID is `null`, the operation assigns the default field configuration scheme.\n\nField configuration schemes can only be assigned to classic projects.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"assignFieldConfigurationSchemeToProject","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldConfigurationSchemeProjectAssociation"},"example":{"fieldConfigurationSchemeId":"10000","projectId":"10000"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the project is not a classic project.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only classic projects can have field configuration schemes assigned.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access field configurations.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the project is missing.","content":{"application/json":{"example":"{\"errorMessages\":[\"The project was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field-configuration-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/fieldconfigurationscheme/{id}":{"put":{"tags":["Issue field configurations"],"summary":"Update field configuration scheme","description":"Updates a field configuration scheme.\n\nThis operation can only update field configuration schemes used in company-managed (classic) projects.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updateFieldConfigurationScheme","parameters":[{"name":"id","in":"path","description":"The ID of the field configuration scheme.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The details of the field configuration scheme.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFieldConfigurationSchemeDetails"},"example":{"description":"We can use this one for software projects.","name":"Field Configuration Scheme for software related projects"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"A field configuration scheme is using this name.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access field configurations.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the field configuration scheme is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The field configuration scheme was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field-configuration-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Issue field configurations"],"summary":"Delete field configuration scheme","description":"Deletes a field configuration scheme.\n\nThis operation can only delete field configuration schemes used in company-managed (classic) projects.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deleteFieldConfigurationScheme","parameters":[{"name":"id","in":"path","description":"The ID of the field configuration scheme.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the field configuration scheme is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:field-configuration-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/fieldconfigurationscheme/{id}/mapping":{"put":{"tags":["Issue field configurations"],"summary":"Assign issue types to field configurations","description":"Assigns issue types to field configurations on field configuration scheme.\n\nThis operation can only modify field configuration schemes used in company-managed (classic) projects.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"setFieldConfigurationSchemeMapping","parameters":[{"name":"id","in":"path","description":"The ID of the field configuration scheme.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssociateFieldConfigurationsWithIssueTypesRequest"},"example":{"mappings":[{"fieldConfigurationId":"10000","issueTypeId":"default"},{"fieldConfigurationId":"10002","issueTypeId":"10001"},{"fieldConfigurationId":"10001","issueTypeId":"10002"}]}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the field configuration scheme, the field configuration, or the issue type is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field-configuration-scheme:jira","read:field-configuration-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/fieldconfigurationscheme/{id}/mapping/delete":{"post":{"tags":["Issue field configurations"],"summary":"Remove issue types from field configuration scheme","description":"Removes issue types from the field configuration scheme.\n\nThis operation can only modify field configuration schemes used in company-managed (classic) projects.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"removeIssueTypesFromGlobalFieldConfigurationScheme","parameters":[{"name":"id","in":"path","description":"The ID of the field configuration scheme.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The issue type IDs to remove.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeIdsToRemove"},"example":{"issueTypeIds":["10000","10001","10002"]}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The issueTypeIds must not contain duplicates.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Only Jira administrators can access field configurations.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the field configuration scheme or the issue types are not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The field configuration scheme was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:field-configuration-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/filter":{"post":{"tags":["Filters"],"summary":"Create filter","description":"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.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"createFilter","parameters":[{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `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]`.\n *  `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]`.","schema":{"type":"string"}},{"name":"overrideSharePermissions","in":"query","description":"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).","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The filter to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Filter"},"example":{"description":"Lists all open bugs","jql":"type = Bug and resolution is empty","name":"All Open Bugs"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Filter"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"https://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"editPermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}"}}},"400":{"description":"Returned if the request object is invalid. For example, the `name` is not unique or the project ID is not specified for a project role share permission."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:filter:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","write:filter:jira","read:application-role:jira","read:avatar:jira","read:issue-type-hierarchy:jira","read:issue-type:jira","read:project-category:jira","read:project-version:jira","read:project.component:jira"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/filter/defaultShareScope":{"get":{"tags":["Filter sharing"],"summary":"Get default share scope","description":"Returns the default sharing settings for new filters and dashboards for a user.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getDefaultShareScope","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultShareScope"},"example":"{\"scope\":\"GLOBAL\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:filter.default-share-scope:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Filter sharing"],"summary":"Set default share scope","description":"Sets the default sharing for new filters and dashboards for a user.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"setDefaultShareScope","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultShareScope"},"example":{"scope":"GLOBAL"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultShareScope"},"example":"{\"scope\":\"GLOBAL\"}"}}},"400":{"description":"Returned if an invalid scope is set."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:filter.default-share-scope:jira","read:filter.default-share-scope:jira"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/filter/favourite":{"get":{"tags":["Filters"],"summary":"Get favorite filters","description":"Returns the visible favorite filters of the user.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** A favorite filter is only visible to the user where the filter is:\n\n *  owned by the user.\n *  shared with a group that the user is a member of.\n *  shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n *  shared with a public project.\n *  shared with the public.\n\nFor example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.","operationId":"getFavouriteFilters","parameters":[{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `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]`.\n *  `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]`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Filter"}},"example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"https://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"editPermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/filter/10010\",\"id\":\"10010\",\"name\":\"My issues\",\"description\":\"Issues assigned to me\",\"owner\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"assignee = currentUser() and resolution is empty\",\"viewUrl\":\"https://your-domain.atlassian.net/issues/?filter=10010\",\"searchUrl\":\"https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[{\"id\":10000,\"type\":\"global\"},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"}}}],\"editPermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:filter:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","read:jql:jira","read:application-role:jira","read:avatar:jira","read:issue-type-hierarchy:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/filter/my":{"get":{"tags":["Filters"],"summary":"Get my filters","description":"Returns the filters owned by the user. If `includeFavourites` is `true`, the user's visible favorite filters are also returned.\n\n**[Permissions](#permissions) required:** Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:\n\n *  owned by the user.\n *  shared with a group that the user is a member of.\n *  shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n *  shared with a public project.\n *  shared with the public.\n\nFor example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.","operationId":"getMyFilters","parameters":[{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `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]`.\n *  `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]`.","schema":{"type":"string"}},{"name":"includeFavourites","in":"query","description":"Include the user's favorite filters in the response.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Filter"}},"example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"https://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"editPermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/filter/10010\",\"id\":\"10010\",\"name\":\"My issues\",\"description\":\"Issues assigned to me\",\"owner\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"assignee = currentUser() and resolution is empty\",\"viewUrl\":\"https://your-domain.atlassian.net/issues/?filter=10010\",\"searchUrl\":\"https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[{\"id\":10000,\"type\":\"global\"},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"}}}],\"editPermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:filter:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","read:jql:jira","read:application-role:jira","read:avatar:jira","read:issue-type-hierarchy:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/filter/search":{"get":{"tags":["Filters"],"summary":"Search for filters","description":"Returns a [paginated](#pagination) list of filters. Use this operation to get:\n\n *  specific filters, by defining `id` only.\n *  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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None, however, only the following filters that match the query parameters are returned:\n\n *  filters owned by the user.\n *  filters shared with a group that the user is a member of.\n *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n *  filters shared with a public project.\n *  filters shared with the public.","operationId":"getFiltersPaginated","parameters":[{"name":"filterName","in":"query","description":"String used to perform a case-insensitive partial match with `name`.","schema":{"type":"string"}},{"name":"accountId","in":"query","description":"User account ID used to return filters with the matching `owner.accountId`. This parameter cannot be used with `owner`.","schema":{"maxLength":128,"type":"string"}},{"name":"owner","in":"query","description":"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`.","schema":{"type":"string"}},{"name":"groupname","in":"query","description":"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.","schema":{"type":"string"}},{"name":"groupId","in":"query","description":"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.","schema":{"type":"string"}},{"name":"projectId","in":"query","description":"Project ID used to returns filters that are shared with a project that matches `sharePermissions.project.id`.","schema":{"type":"integer","format":"int64"}},{"name":"id","in":"query","description":"The list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. Do not exceed 200 filter IDs.","schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"orderBy","in":"query","description":"[Order](#ordering) the results by a field:\n\n *  `description` Sorts by filter description. Note that this sorting works independently of whether the expand to display the description field is in use.\n *  `favourite_count` Sorts by the count of how many users have this filter as a favorite.\n *  `is_favourite` Sorts by whether the filter is marked as a favorite.\n *  `id` Sorts by filter ID.\n *  `name` Sorts by filter name.\n *  `owner` Sorts by the ID of the filter owner.\n *  `is_shared` Sorts by whether the filter is shared.","schema":{"type":"string","default":"name","enum":["description","-description","+description","favourite_count","-favourite_count","+favourite_count","id","-id","+id","is_favourite","-is_favourite","+is_favourite","name","-name","+name","owner","-owner","+owner","is_shared","-is_shared","+is_shared"]}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `description` Returns the description of the filter.\n *  `favourite` Returns an indicator of whether the user has set the filter as a favorite.\n *  `favouritedCount` Returns a count of how many users have set this filter as a favorite.\n *  `jql` Returns the JQL query that the filter uses.\n *  `owner` Returns the owner of the filter.\n *  `searchUrl` Returns a URL to perform the filter's JQL query.\n *  `sharePermissions` Returns the share permissions defined for the filter.\n *  `editPermissions` Returns the edit permissions defined for the filter.\n *  `isWritable` Returns whether the current user has permission to edit the filter.\n *  `subscriptions` Returns the users that are subscribed to the filter.\n *  `viewUrl` Returns a URL to view the filter.","schema":{"type":"string"}},{"name":"overrideSharePermissions","in":"query","description":"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).","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanFilterDetails"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/filter/search?accountId=&maxResults=50&filterName=&orderBy=name&startAt=0&expand=description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,subscriptions\",\"maxResults\":100,\"startAt\":0,\"total\":2,\"isLast\":true,\"values\":[{\"expand\":\"description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,subscriptions\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"https://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":false,\"favouritedCount\":0,\"sharePermissions\":[],\"editPermissions\":[],\"subscriptions\":[]},{\"expand\":\"description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,subscriptions\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/filter/10010\",\"id\":\"10010\",\"name\":\"My issues\",\"description\":\"Issues assigned to me\",\"owner\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"assignee = currentUser() and resolution is empty\",\"viewUrl\":\"https://your-domain.atlassian.net/issues/?filter=10010\",\"searchUrl\":\"https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty\",\"favourite\":true,\"favouritedCount\":123,\"sharePermissions\":[{\"id\":10000,\"type\":\"global\"},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"}}}],\"editPermissions\":[{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY\",\"id\":\"10002\",\"key\":\"MKY\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"},\"deleted\":true,\"retentionTillDate\":\"2024-01-29T00:41:58.259+0000\",\"deletedDate\":\"2023-11-30T00:41:58.259+0000\",\"deletedBy\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false}},\"role\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}},{\"id\":10010,\"type\":\"group\",\"group\":{\"name\":\"jira-administrators\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"}}],\"subscriptions\":[{\"id\":1,\"user\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}}}]}]}"}}},"400":{"description":"Returned if:\n\n *  `owner` and `accountId` are provided.\n *  `expand` includes an invalid value.\n *  `orderBy` is invalid.\n *  `id` identifies more than 200 filter IDs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:filter:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","read:jql:jira","read:application-role:jira","read:avatar:jira","read:issue-type-hierarchy:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/filter/{id}":{"get":{"tags":["Filters"],"summary":"Get filter","description":"Returns a filter.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None, however, the filter is only returned where it is:\n\n *  owned by the user.\n *  shared with a group that the user is a member of.\n *  shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n *  shared with a public project.\n *  shared with the public.","operationId":"getFilter","parameters":[{"name":"id","in":"path","description":"The ID of the filter to return.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `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]`.\n *  `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]`.","schema":{"type":"string"}},{"name":"overrideSharePermissions","in":"query","description":"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).","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Filter"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"https://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"editPermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}"}}},"400":{"description":"Returned if the filter is not found or the user does not have permission to view it."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:filter:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","read:jql:jira","read:application-role:jira","read:avatar:jira","read:issue-type-hierarchy:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Filters"],"summary":"Update filter","description":"Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.\n\n**[Permissions](#permissions) required:** Permission to access Jira, however the user must own the filter.","operationId":"updateFilter","parameters":[{"name":"id","in":"path","description":"The ID of the filter to update.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `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]`.\n *  `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]`.","schema":{"type":"string"}},{"name":"overrideSharePermissions","in":"query","description":"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).","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"The filter to update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Filter"},"example":{"description":"Lists all open bugs","jql":"type = Bug and resolution is empty","name":"All Open Bugs"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Filter"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"https://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"editPermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}"}}},"400":{"description":"Returned if the request object is invalid. For example, the `name` is not unique or the project ID is not specified for a project role share permission."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:filter:jira","read:filter:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","read:jql:jira","read:application-role:jira","read:avatar:jira","read:issue-type-hierarchy:jira"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Filters"],"summary":"Delete filter","description":"Delete a filter.\n\n**[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).","operationId":"deleteFilter","parameters":[{"name":"id","in":"path","description":"The ID of the filter to delete.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the filter is not found."},"401":{"description":"Returned if the user does not have permission to delete the filter."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:filter:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/filter/{id}/columns":{"get":{"tags":["Filters"],"summary":"Get columns","description":"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*.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None, however, column details are only returned for:\n\n *  filters owned by the user.\n *  filters shared with a group that the user is a member of.\n *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n *  filters shared with a public project.\n *  filters shared with the public.","operationId":"getColumns","parameters":[{"name":"id","in":"path","description":"The ID of the filter.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ColumnItem"}},"example":"[{\"label\":\"Key\",\"value\":\"issuekey\"},{\"label\":\"Summary\",\"value\":\"summary\"}]"}}},"400":{"description":"Returned if the user does not have permission to view the filter."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if a column configuration is not set for the filter."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:filter.column:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Filters"],"summary":"Set columns","description":"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`.\n\nThe parameters for this resource are expressed as HTML form data. For example, in curl:\n\n`curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/filter/10000/columns`\n\n**[Permissions](#permissions) required:** Permission to access Jira, however, columns are only set for:\n\n *  filters owned by the user.\n *  filters shared with a group that the user is a member of.\n *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n *  filters shared with a public project.\n *  filters shared with the public.","operationId":"setColumns","parameters":[{"name":"id","in":"path","description":"The ID of the filter.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"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-<ver>-field-get)). For example, `columns=summary`.","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}},"multipart/form-data":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if:\n\n *  a non-navigable field is set as a column.\n *  the user does not have permission to view the filter."},"403":{"description":"Returned if the requesting user is not an owner of the filter."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:filter.column:jira"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Filters"],"summary":"Reset columns","description":"Reset the user's column configuration for the filter to the default.\n\n**[Permissions](#permissions) required:** Permission to access Jira, however, columns are only reset for:\n\n *  filters owned by the user.\n *  filters shared with a group that the user is a member of.\n *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n *  filters shared with a public project.\n *  filters shared with the public.","operationId":"resetColumns","parameters":[{"name":"id","in":"path","description":"The ID of the filter.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if:\n\n *  the filter is not found.\n *  the user does not have permission to view the filter."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Beta","scheme":"OAuth2","scopes":["delete:filter.column:jira"]},{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/filter/{id}/favourite":{"put":{"tags":["Filters"],"summary":"Add filter as favorite","description":"Add a filter as a favorite for the user.\n\n**[Permissions](#permissions) required:** Permission to access Jira, however, the user can only favorite:\n\n *  filters owned by the user.\n *  filters shared with a group that the user is a member of.\n *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n *  filters shared with a public project.\n *  filters shared with the public.","operationId":"setFavouriteForFilter","parameters":[{"name":"id","in":"path","description":"The ID of the filter.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `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]`.\n *  `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]`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Filter"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"https://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"editPermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}"}}},"400":{"description":"Returned if:\n\n *  the filter is not found.\n *  the user does not have permission to favorite the filter."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:filter:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","write:filter:jira","read:jql:jira","read:application-role:jira","read:avatar:jira","read:issue-type-hierarchy:jira"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Filters"],"summary":"Remove filter as favorite","description":"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.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"deleteFavouriteForFilter","parameters":[{"name":"id","in":"path","description":"The ID of the filter.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `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]`.\n *  `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]`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Filter"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"https://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"editPermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}"}}},"400":{"description":"Returned if:\n\n *  the filter is not found.\n *  the user does not have permission to view the filter."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:filter:jira","read:application-role:jira","read:avatar:jira","read:filter:jira","read:group:jira","read:issue-type-hierarchy:jira","read:issue-type:jira","read:project-category:jira","read:project-role:jira","read:project-version:jira","read:project.component:jira","read:project:jira","read:user:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/filter/{id}/owner":{"put":{"tags":["Filters"],"summary":"Change filter owner","description":"Changes the owner of the filter.\n\n**[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).","operationId":"changeFilterOwner","parameters":[{"name":"id","in":"path","description":"The ID of the filter to update.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The account ID of the new owner of the filter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeFilterOwner"},"example":{"accountId":"0000-0000-0000-0000"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned when:\n\n *  The new owner of the filter owns a filter with the same name.\n *  An attempt is made to change owner of the default filter."},"403":{"description":"Returned if the requesting user is not an owner of the filter or does not have *Administer Jira* global permission."},"404":{"description":"Returned if the filter or the new owner of the filter is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Beta","scheme":"OAuth2","scopes":["read:filter:jira","write:filter:jira"]},{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]}],"x-experimental":true,"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/filter/{id}/permission":{"get":{"tags":["Filter sharing"],"summary":"Get share permissions","description":"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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None, however, share permissions are only returned for:\n\n *  filters owned by the user.\n *  filters shared with a group that the user is a member of.\n *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n *  filters shared with a public project.\n *  filters shared with the public.","operationId":"getSharePermissions","parameters":[{"name":"id","in":"path","description":"The ID of the filter.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SharePermission"}},"example":"[{\"id\":10000,\"type\":\"global\"},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"}}},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY\",\"id\":\"10002\",\"key\":\"MKY\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"},\"deleted\":true,\"retentionTillDate\":\"2024-01-29T00:41:58.259+0000\",\"deletedDate\":\"2023-11-30T00:41:58.259+0000\",\"deletedBy\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false}},\"role\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}},{\"id\":10010,\"type\":\"group\",\"group\":{\"name\":\"jira-administrators\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"}}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  the filter is not found.\n *  the user does not have permission to view the filter."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:filter:jira","read:group:jira","read:project:jira","read:user:jira","read:application-role:jira","read:avatar:jira","read:issue-type-hierarchy:jira","read:issue-type:jira","read:project-category:jira","read:project-role:jira","read:project-version:jira","read:project.component:jira"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Filter sharing"],"summary":"Add share permission","description":"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.\n\nBe aware that this operation uses different objects for updating share permissions compared to [Update filter](#api-rest-api-3-filter-id-put).\n\n**[Permissions](#permissions) required:** *Share dashboards and filters* [global permission](https://confluence.atlassian.com/x/x4dKLg) and the user must own the filter.","operationId":"addSharePermission","parameters":[{"name":"id","in":"path","description":"The ID of the filter.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharePermissionInputBean"},"example":{"groupname":"jira-administrators","rights":1,"type":"group"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SharePermission"}},"example":"[{\"id\":10000,\"type\":\"global\"},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"}}},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY\",\"id\":\"10002\",\"key\":\"MKY\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"},\"deleted\":true,\"retentionTillDate\":\"2024-01-29T00:41:58.259+0000\",\"deletedDate\":\"2023-11-30T00:41:58.259+0000\",\"deletedBy\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false}},\"role\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}},{\"id\":10010,\"type\":\"group\",\"group\":{\"name\":\"jira-administrators\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"}}]"}}},"400":{"description":"Returned if:\n\n *  the request object is invalid. For example, it contains an invalid type, the ID does not match the type, or the project or group is not found.\n *  the user does not own the filter.\n *  the user does not have the required permissions."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  the filter is not found.\n *  the user does not have permission to view the filter."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:filter:jira","read:filter:jira","read:group:jira","read:project:jira","read:user:jira","read:application-role:jira","read:avatar:jira","read:issue-type-hierarchy:jira","read:issue-type:jira","read:project-category:jira","read:project-role:jira","read:project-version:jira","read:project.component:jira"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/filter/{id}/permission/{permissionId}":{"get":{"tags":["Filter sharing"],"summary":"Get share permission","description":"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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None, however, a share permission is only returned for:\n\n *  filters owned by the user.\n *  filters shared with a group that the user is a member of.\n *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n *  filters shared with a public project.\n *  filters shared with the public.","operationId":"getSharePermission","parameters":[{"name":"id","in":"path","description":"The ID of the filter.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"permissionId","in":"path","description":"The ID of the share permission.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharePermission"},"example":"{\"id\":10000,\"type\":\"global\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  the filter is not found.\n *  the permission is not found.\n *  the user does not have permission to view the filter."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:filter:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","read:application-role:jira","read:avatar:jira","read:issue-type-hierarchy:jira","read:issue-type:jira","read:project-category:jira","read:project-version:jira","read:project.component:jira"]}],"x-atlassian-connect-scope":"READ"},"delete":{"tags":["Filter sharing"],"summary":"Delete share permission","description":"Deletes a share permission from a filter.\n\n**[Permissions](#permissions) required:** Permission to access Jira and the user must own the filter.","operationId":"deleteSharePermission","parameters":[{"name":"id","in":"path","description":"The ID of the filter.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"permissionId","in":"path","description":"The ID of the share permission.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  the filter is not found.\n *  the user does not own the filter."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:filter:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/group":{"get":{"tags":["Groups"],"summary":"Get group","description":"This operation is deprecated, use [`group/member`](#api-rest-api-3-group-member-get).\n\nReturns all users in a group.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getGroup","parameters":[{"name":"groupname","in":"query","description":"As a group's name can change, use of `groupId` is recommended to identify a group.  \nThe name of the group. This parameter cannot be used with the `groupId` parameter.","schema":{"type":"string"}},{"name":"groupId","in":"query","description":"The ID of the group. This parameter cannot be used with the `groupName` parameter.","schema":{"type":"string"},"x-showInExample":"true"},{"name":"expand","in":"query","description":"List of fields to expand.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"description":"Returned if the group name is not specified."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the calling user does not have the Administer Jira global permission."},"404":{"description":"Returned if the group is not found."}},"deprecated":true,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-user"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-user"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:group:jira","read:user:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Groups"],"summary":"Create group","description":"Creates a group.\n\n**[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)).","operationId":"createGroup","parameters":[],"requestBody":{"description":"The name of the group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddGroupBean"},"example":{"name":"power-users"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"},"example":"{\"name\":\"power-users\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\",\"users\":{\"size\":1,\"items\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false}],\"max-results\":50,\"start-index\":0,\"end-index\":0},\"expand\":\"users\"}"}}},"400":{"description":"Returned if group name is not specified or the group name is in use."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:group:jira","read:user:jira","write:group:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["Groups"],"summary":"Remove group","description":"Deletes a group.\n\n**[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* strategic [group](https://confluence.atlassian.com/x/24xjL)).","operationId":"removeGroup","parameters":[{"name":"groupname","in":"query","schema":{"type":"string"}},{"name":"groupId","in":"query","description":"The ID of the group. This parameter cannot be used with the `groupname` parameter.","schema":{"type":"string"},"x-showInExample":"true"},{"name":"swapGroup","in":"query","description":"As a group's name can change, use of `swapGroupId` is recommended to identify a group.  \nThe 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.","schema":{"type":"string"}},{"name":"swapGroupId","in":"query","description":"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.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the group name is not specified."},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the group is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:group:jira"]}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/group/bulk":{"get":{"tags":["Groups"],"summary":"Bulk get groups","description":"Returns a [paginated](#pagination) list of groups.\n\n**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"bulkGetGroups","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"groupId","in":"query","description":"The ID of a group. To specify multiple IDs, pass multiple `groupId` parameters. For example, `groupId=5b10a2844c20165700ede21g&groupId=5b10ac8d82e05b22cc7d4ef5`.","schema":{"uniqueItems":true,"type":"array","example":"3571b9a7-348f-414a-9087-8e1ea03a7df8","items":{"type":"string","example":"3571b9a7-348f-414a-9087-8e1ea03a7df8"}},"x-showInExample":"true"},{"name":"groupName","in":"query","description":"The name of a group. To specify multiple names, pass multiple `groupName` parameters. For example, `groupName=administrators&groupName=jira-software-users`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"accessType","in":"query","description":"The access level of a group. Valid values: 'site-admin', 'admin', 'user'.","schema":{"type":"string"}},{"name":"applicationKey","in":"query","description":"The application key of the product user groups to search for. Valid values: 'jira-servicedesk', 'jira-software', 'jira-product-discovery', 'jira-core'.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanGroupDetails"},"example":"{\"maxResults\":10,\"startAt\":0,\"total\":2,\"isLast\":true,\"values\":[{\"name\":\"jdog-developers\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\"},{\"name\":\"juvenal-bot\",\"groupId\":\"6e87dc72-4f1f-421f-9382-2fee8b652487\"}]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"example":"{\"errorMessages\":[\"Browse users and groups permission is required to view groups.\"],\"errors\":{}}"}}},"500":{"description":"Returned if the group with the given access level can't be retrieved.","content":{"application/json":{"example":"{\"errorMessages\":[\"Couldn't retrieve groups with the site-admin accessType.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-user"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-user"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:group:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/group/member":{"get":{"tags":["Groups"],"summary":"Get users from group","description":"Returns a [paginated](#pagination) list of all users in a group.\n\nNote that users are ordered by username, however the username is not returned in the results due to privacy reasons.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getUsersFromGroup","parameters":[{"name":"groupname","in":"query","description":"As a group's name can change, use of `groupId` is recommended to identify a group.  \nThe name of the group. This parameter cannot be used with the `groupId` parameter.","schema":{"type":"string"}},{"name":"groupId","in":"query","description":"The ID of the group. This parameter cannot be used with the `groupName` parameter.","schema":{"type":"string"},"x-showInExample":"true"},{"name":"includeInactiveUsers","in":"query","description":"Include inactive users.","schema":{"type":"boolean","default":false}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanUserDetails"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/group/member?groupname=jira-administrators&includeInactiveUsers=false&startAt=2&maxResults=2\",\"nextPage\":\"https://your-domain.atlassian.net/rest/api/3/group/member?groupname=jira-administrators&includeInactiveUsers=false&startAt=4&maxResults=2\",\"maxResults\":2,\"startAt\":3,\"total\":5,\"isLast\":false,\"values\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"name\":\"\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{},\"displayName\":\"Mia\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"accountType\":\"atlassian\"},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a0effa615349cb016cd8\",\"name\":\"\",\"key\":\"\",\"accountId\":\"5b10a0effa615349cb016cd8\",\"emailAddress\":\"will@example.com\",\"avatarUrls\":{},\"displayName\":\"Will\",\"active\":false,\"timeZone\":\"Australia/Sydney\",\"accountType\":\"atlassian\"}]}"}}},"400":{"description":"Returned if the group name is not specified."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the calling user does not have the Administer Jira global permission."},"404":{"description":"Returned if the group is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:group:jira","read:user:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/group/user":{"post":{"tags":["Groups"],"summary":"Add user to group","description":"Adds a user to a group.\n\n**[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)).","operationId":"addUserToGroup","parameters":[{"name":"groupname","in":"query","description":"As a group's name can change, use of `groupId` is recommended to identify a group.  \nThe name of the group. This parameter cannot be used with the `groupId` parameter.","schema":{"type":"string"}},{"name":"groupId","in":"query","description":"The ID of the group. This parameter cannot be used with the `groupName` parameter.","schema":{"type":"string"},"x-showInExample":"true"}],"requestBody":{"description":"The user to add to the group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserToGroupBean"},"example":{"accountId":"5b10ac8d82e05b22cc7d4ef5"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"description":"Returned if:\n\n *  `groupname` is not provided.\n *  `accountId` is missing."},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request."},"403":{"description":"Returned if the calling user does not have the necessary permission."},"404":{"description":"Returned if the group or user are not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:group:jira","read:avatar:jira","read:group:jira","read:user:jira"]}],"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["Groups"],"summary":"Remove user from group","description":"Removes a user from a group.\n\n**[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)).","operationId":"removeUserFromGroup","parameters":[{"name":"groupname","in":"query","description":"As a group's name can change, use of `groupId` is recommended to identify a group.  \nThe name of the group. This parameter cannot be used with the `groupId` parameter.","schema":{"type":"string"}},{"name":"groupId","in":"query","description":"The ID of the group. This parameter cannot be used with the `groupName` parameter.","schema":{"type":"string"},"x-showInExample":"true"},{"name":"username","in":"query","description":"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.","schema":{"type":"string"}},{"name":"accountId","in":"query","description":"The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.","required":true,"schema":{"maxLength":128,"type":"string","example":"5b10ac8d82e05b22cc7d4ef5"},"x-showInExample":"true"}],"responses":{"200":{"description":"Returned if the request is successful."},"400":{"description":"Returned if:\n\n *  `groupName` is missing.\n *  `accountId` is missing."},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the group or user are not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:group:jira"]}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/groups/picker":{"get":{"tags":["Groups"],"summary":"Find groups","description":"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.\n\nThe 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*.\n\nThe list returns with the groups sorted. If no groups match the list criteria, an empty list is returned.\n\nThis operation can be accessed anonymously.\n\n**[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.\n\n*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.","operationId":"findGroups","parameters":[{"name":"accountId","in":"query","description":"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).","schema":{"type":"string"}},{"name":"query","in":"query","description":"The string to find in group names.","schema":{"type":"string","example":"query"}},{"name":"exclude","in":"query","description":"As a group's name can change, use of `excludeGroupIds` is recommended to identify a group.  \nA group to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, `exclude=group1&exclude=group2`. This parameter cannot be used with the `excludeGroupIds` parameter.","schema":{"type":"array","items":{"type":"string"}}},{"name":"excludeId","in":"query","description":"A group ID to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, `excludeId=group1-id&excludeId=group2-id`. This parameter cannot be used with the `excludeGroups` parameter.","schema":{"type":"array","items":{"type":"string"}}},{"name":"maxResults","in":"query","description":"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`.","schema":{"type":"integer","format":"int32"}},{"name":"caseInsensitive","in":"query","description":"Whether the search for groups should be case insensitive.","schema":{"type":"boolean","default":false}},{"name":"userName","in":"query","description":"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.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FoundGroups"},"example":"{\"header\":\"Showing 20 of 25 matching groups\",\"total\":25,\"groups\":[{\"name\":\"jdog-developers\",\"html\":\"<b>j</b>dog-developers\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\"},{\"name\":\"juvenal-bot\",\"html\":\"<b>j</b>uvenal-bot\",\"groupId\":\"6e87dc72-4f1f-421f-9382-2fee8b652487\"}]}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-user"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-user"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:group:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/groupuserpicker":{"get":{"tags":["Group and user picker"],"summary":"Find users and groups","description":"Returns a list of users and groups matching a string. The string is used:\n\n *  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.\n *  for groups, to find a case-sensitive match with group name.\n\nFor example, if the string *tin* is used, records with the display name *Tina*, email address *sarah@tinplatetraining.com*, and the group *accounting* would be returned.\n\nOptionally, the search can be refined to:\n\n *  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:\n    \n     *  projects.\n     *  issue types.\n    \n    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.\n *  not return Connect app users and groups.\n *  return groups that have a case-insensitive match with the query.\n\nThe 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*.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/yodKLg).","operationId":"findUsersAndGroups","parameters":[{"name":"query","in":"query","description":"The search string.","required":true,"schema":{"type":"string"}},{"name":"maxResults","in":"query","description":"The maximum number of items to return in each list.","schema":{"type":"integer","format":"int32","default":50}},{"name":"showAvatar","in":"query","description":"Whether the user avatar should be returned. If an invalid value is provided, the default value is used.","schema":{"type":"boolean","default":false}},{"name":"fieldId","in":"query","description":"The custom field ID of the field this request is for.","schema":{"type":"string"}},{"name":"projectId","in":"query","description":"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&projectId=10001`. This parameter is only used when `fieldId` is present.","schema":{"type":"array","items":{"type":"string"}}},{"name":"issueTypeId","in":"query","description":"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&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.","schema":{"type":"array","items":{"type":"string"}}},{"name":"avatarSize","in":"query","description":"The size of the avatar to return. If an invalid value is provided, the default value is used.","schema":{"type":"string","default":"xsmall","enum":["xsmall","xsmall@2x","xsmall@3x","small","small@2x","small@3x","medium","medium@2x","medium@3x","large","large@2x","large@3x","xlarge","xlarge@2x","xlarge@3x","xxlarge","xxlarge@2x","xxlarge@3x","xxxlarge","xxxlarge@2x","xxxlarge@3x"]}},{"name":"caseInsensitive","in":"query","description":"Whether the search for groups should be case insensitive.","schema":{"type":"boolean","default":false}},{"name":"excludeConnectAddons","in":"query","description":"Whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FoundUsersAndGroups"},"example":"{\"users\":{\"users\":[{\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"mia\",\"key\":\"mia\",\"html\":\"<strong>Mi</strong>a Krystof - <strong>mi</strong>a@example.com (<strong>mi</strong>a)\",\"displayName\":\"Mia Krystof\",\"avatarUrl\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\"}],\"total\":25,\"header\":\"Showing 20 of 25 matching groups\"},\"groups\":{\"header\":\"Showing 20 of 25 matching groups\",\"total\":25,\"groups\":[{\"name\":\"jdog-developers\",\"html\":\"<b>j</b>dog-developers\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\"},{\"name\":\"juvenal-bot\",\"html\":\"<b>j</b>uvenal-bot\",\"groupId\":\"6e87dc72-4f1f-421f-9382-2fee8b652487\"}]}}"}}},"400":{"description":"Returned if the query parameter is not provided."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"429":{"description":"Returned if the rate limit is exceeded. User search endpoints share a collective rate limit for the tenant, in addition to Jira's normal rate limiting you may receive a rate limit for user search. Please respect the Retry-After header."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:group:jira","read:user:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/instance/license":{"get":{"tags":["License metrics"],"summary":"Get license","description":"Returns licensing information about the Jira instance.\n\n**[Permissions](#permissions) required:** None.","operationId":"getLicense","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/License"},"example":"{\"applications\":[{\"id\":\"jira-core\",\"plan\":\"PAID\"},{\"id\":\"jira-servicedesk\",\"plan\":\"FREE\"},{\"id\":\"jira-software\",\"plan\":\"PAID\"},{\"id\":\"jira-product-discovery\",\"plan\":\"FREE\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:license:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issue":{"post":{"tags":["Issues"],"summary":"Create issue","description":"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.\n\nThe 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.\n\nCreating a subtask differs from creating an issue as follows:\n\n *  `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).\n *  `parent` must contain the ID or key of the parent issue.\n\nIn a next-gen project any issue may be made a child providing that the parent and child are members of the same project.\n\n**[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.","operationId":"createIssue","parameters":[{"name":"updateHistory","in":"query","description":"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.","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueUpdateDetails"},"example":{"fields":{"assignee":{"id":"5b109f2e9729b51b54dc274d"},"components":[{"id":"10000"}],"customfield_10000":"09/Jun/19","customfield_20000":"06/Jul/19 3:25 PM","customfield_30000":["10000","10002"],"customfield_40000":{"content":[{"content":[{"text":"Occurs on all orders","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"customfield_50000":{"content":[{"content":[{"text":"Could impact day-to-day work.","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"customfield_60000":"jira-software-users","customfield_70000":["jira-administrators","jira-software-users"],"customfield_80000":{"value":"red"},"description":{"content":[{"content":[{"text":"Order entry fails when selecting supplier.","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"duedate":"2019-05-11","environment":{"content":[{"content":[{"text":"UAT","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"fixVersions":[{"id":"10001"}],"issuetype":{"id":"10000"},"labels":["bugfix","blitz_test"],"parent":{"key":"PROJ-123"},"priority":{"id":"20000"},"project":{"id":"10000"},"reporter":{"id":"5b10a2844c20165700ede21g"},"security":{"id":"10000"},"summary":"Main order flow broken","timetracking":{"originalEstimate":"10","remainingEstimate":"5"},"versions":[{"id":"10000"}]},"update":{}}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedIssue"},"example":"{\"id\":\"10000\",\"key\":\"ED-24\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10000\",\"transition\":{\"status\":200,\"errorCollection\":{\"errorMessages\":[],\"errors\":{}}}}"}}},"400":{"description":"Returned if the request:\n\n *  is missing required fields.\n *  contains invalid field values.\n *  contains fields that cannot be set for the issue type.\n *  is by a user who does not have the necessary permission.\n *  is to create a subtype in a project different that of the parent issue.\n *  is for a subtask when the option to create subtasks is disabled.\n *  is invalid for any other reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Field 'priority' is required\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue:jira","write:comment:jira","write:comment.property:jira","write:attachment:jira","read:issue:jira"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/archive":{"put":{"tags":["Issues"],"summary":"Archive issue(s) by issue ID/key","description":"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.\n\n**Note that:**\n\n *  you can't archive subtasks directly, only through their parent issues\n *  you can only archive issues from software, service management, and business projects\n\n**[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg)\n\n**License required:** Premium or Enterprise\n\n**Signed-in users only:** This API can't be accessed anonymously.\n\n  \n","operationId":"archiveIssues","parameters":[],"requestBody":{"description":"Contains a list of issue keys or IDs to be archived.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueArchivalSyncRequest"},"example":{"issueIdsOrKeys":["PR-1","1001","PROJECT-2"]}}},"required":true},"responses":{"200":{"description":"Returned if there is at least one valid issue to archive in the request. The return message will include the count of archived issues and subtasks, as well as error details for issues which failed to get archived.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueArchivalSyncResponse"},"example":"{\"numberOfIssuesUpdated\":10,\"errors\":{\"issuesNotFound\":{\"count\":3,\"issueIdsOrKeys\":[\"PR-2\",\"PR-3\",\"PR-1\"],\"message\":\"Issue not found.\"},\"issuesInUnlicensedProjects\":{\"count\":3,\"issueIdsOrKeys\":[\"UL-3\",\"UL-1\",\"UL-2\"],\"message\":\"Issues with these IDs are in unlicensed projects.\"},\"issuesInArchivedProjects\":{\"count\":2,\"issueIdsOrKeys\":[\"AR-2\",\"AR-1\"],\"message\":\"Issue exists in archived project.\"},\"issueIsSubtask\":{\"count\":3,\"issueIdsOrKeys\":[\"ST-3\",\"ST-1\",\"ST-2\"],\"message\":\"Issue is subtask.\"}}}"}}},"400":{"description":"Returned if none of the issues in the request can be archived. Possible reasons:\n\n *  the issues weren't found\n *  the issues are subtasks\n *  the issues belong to unlicensed projects\n *  the issues belong to archived projects","content":{"application/json":{"example":"{\"errorMessages\":[\"No valid issue to archive or unarchive. Bad request.\"],\"errors\":{}}"}}},"401":{"description":"Returned if no issues were archived because the provided authentication credentials are either missing or invalid.","content":{"application/json":{"example":"{\"errorMessages\":[\"User is not logged in.\"],\"errors\":{}}"}}},"403":{"description":"Returned if no issues were archived because the user lacks the required Jira admin or site admin permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only admins can archive or unarchive issues. Access denied.\"],\"errors\":{}}"}}},"412":{"description":"Returned if one or more issues were successfully archived, but the operation was incomplete because the number of issue IDs or keys provided exceeds 1000.","content":{"application/json":{"example":"{\"errorMessages\":[\"The number of issues to archive or unarchive exceeds the hard limit of 1000. Precondition failed.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"WRITE"},"post":{"tags":["Issues"],"summary":"Archive issue(s) by JQL","description":"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.\n\nYou 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.\n\n**Note that:**\n\n *  you can't archive subtasks directly, only through their parent issues\n *  you can only archive issues from software, service management, and business projects\n\n**[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg)\n\n**License required:** Premium or Enterprise\n\n**Signed-in users only:** This API can't be accessed anonymously.\n\n**Rate limiting:** Only a single request per user can be active at any given time.\n\n  \n","operationId":"archiveIssuesAsync","parameters":[],"requestBody":{"description":"A JQL query specifying the issues to archive. Note that subtasks can only be archived through their parent issues.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchiveIssueAsyncRequest"},"example":{"jql":"project = FOO AND updated < -2y"}}},"required":true},"responses":{"202":{"description":"Returns the URL to check the status of the submitted request.","content":{"application/json":{"schema":{"type":"string"},"example":"\"https://your-domain.atlassian.net/rest/api/3/task/1010\""}}},"400":{"description":"Returned if no issues were archived due to a bad request, for example an invalid JQL query.","content":{"application/json":{"example":"{\"errorMessages\":[\"Invalid JQL. Bad request.\"],\"errors\":{}}"}}},"401":{"description":"Returned if no issues were archived because the provided authentication credentials are either missing or invalid.","content":{"application/json":{"example":"{\"errorMessages\":[\"User is not logged in.\"],\"errors\":{}}"}}},"403":{"description":"Returned if no issues were archived because the user lacks the required Jira admin or site admin permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Archiving issues is only available for premium editions of Jira.\"],\"errors\":{}}"}}},"412":{"description":"Returned if a request to archive issue(s) is already running.","content":{"application/json":{"example":"{\"errorMessages\":[\"An issue archival task is already running with ID 1010. To start a new one, cancel the task or wait for it to finish.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/bulk":{"post":{"tags":["Issues"],"summary":"Bulk create issue","description":"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.\n\nThe 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.\n\nCreating a subtask differs from creating an issue as follows:\n\n *  `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).\n *  `parent` the must contain the ID or key of the parent issue.\n\n**[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.","operationId":"createIssues","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuesUpdateBean"},"example":{"issueUpdates":[{"fields":{"assignee":{"id":"5b109f2e9729b51b54dc274d"},"components":[{"id":"10000"}],"customfield_10000":"09/Jun/19","customfield_20000":"06/Jul/19 3:25 PM","customfield_30000":["10000","10002"],"customfield_40000":{"content":[{"content":[{"text":"Occurs on all orders","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"customfield_50000":{"content":[{"content":[{"text":"Could impact day-to-day work.","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"customfield_60000":"jira-software-users","customfield_70000":["jira-administrators","jira-software-users"],"customfield_80000":{"value":"red"},"description":{"content":[{"content":[{"text":"Order entry fails when selecting supplier.","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"duedate":"2011-03-11","environment":{"content":[{"content":[{"text":"UAT","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"fixVersions":[{"id":"10001"}],"issuetype":{"id":"10000"},"labels":["bugfix","blitz_test"],"priority":{"id":"20000"},"project":{"id":"10000"},"reporter":{"id":"5b10a2844c20165700ede21g"},"security":{"id":"10000"},"summary":"Main order flow broken","timetracking":{"originalEstimate":"10","remainingEstimate":"5"},"versions":[{"id":"10000"}]},"update":{"worklog":[{"add":{"started":"2019-07-05T11:05:00.000+0000","timeSpent":"60m"}}]}},{"fields":{"assignee":{"id":"5b109f2e9729b51b54dc274d"},"components":[{"id":"10000"}],"customfield_10000":"09/Jun/19","customfield_20000":"06/Jul/19 3:25 PM","customfield_30000":["10000","10002"],"customfield_40000":{"content":[{"content":[{"text":"Occurs on all orders","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"customfield_50000":{"content":[{"content":[{"text":"Could impact day-to-day work.","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"customfield_60000":"jira-software-users","customfield_70000":["jira-administrators","jira-software-users"],"customfield_80000":{"value":"red"},"description":{"content":[{"content":[{"text":"Order remains pending after approved.","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"duedate":"2019-04-16","environment":{"content":[{"content":[{"text":"UAT","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"fixVersions":[{"id":"10001"}],"issuetype":{"id":"10000"},"labels":["new_release"],"priority":{"id":"20000"},"project":{"id":"1000"},"reporter":{"id":"5b10a2844c20165700ede21g"},"security":{"id":"10000"},"summary":"Order stuck in pending","timetracking":{"originalEstimate":"15","remainingEstimate":"5"},"versions":[{"id":"10000"}]},"update":{}}]}}},"required":true},"responses":{"201":{"description":"Returned if any of the issue or subtask creation requests were successful. A request may be unsuccessful when it:\n\n *  is missing required fields.\n *  contains invalid field values.\n *  contains fields that cannot be set for the issue type.\n *  is by a user who does not have the necessary permission.\n *  is to create a subtype in a project different that of the parent issue.\n *  is for a subtask when the option to create subtasks is disabled.\n *  is invalid for any other reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedIssues"},"example":"{\"issues\":[{\"id\":\"10000\",\"key\":\"ED-24\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10000\",\"transition\":{\"status\":200,\"errorCollection\":{\"errorMessages\":[],\"errors\":{}}}},{\"id\":\"10001\",\"key\":\"ED-25\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10001\"}],\"errors\":[]}"}}},"400":{"description":"Returned if all requests are invalid. Requests may be unsuccessful when they:\n\n *  are missing required fields.\n *  contain invalid field values.\n *  contain fields that cannot be set for the issue type.\n *  are by a user who does not have the necessary permission.\n *  are to create a subtype in a project different that of the parent issue.\n *  is for a subtask when the option to create subtasks is disabled.\n *  are invalid for any other reason.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedIssues"},"example":"{\"issues\":[],\"errors\":[{\"status\":400,\"elementErrors\":{\"errorMessages\":[],\"errors\":{\"issuetype\":\"The issue type selected is invalid.\",\"project\":\"Sub-tasks must be created in the same project as the parent.\"}},\"failedElementNumber\":0},{\"status\":400,\"elementErrors\":{\"errorMessages\":[],\"errors\":{\"issuetype\":\"The issue type selected is invalid.\",\"project\":\"Sub-tasks must be created in the same project as the parent.\"}},\"failedElementNumber\":1}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue:jira","write:comment:jira","write:comment.property:jira","write:attachment:jira","read:issue:jira"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/createmeta":{"get":{"tags":["Issues"],"summary":"Get create issue metadata","description":"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).\n\nThe 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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) in the requested projects.","operationId":"getCreateIssueMeta","parameters":[{"name":"projectIds","in":"query","description":"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&projectIds=10020,10021`. This parameter may be provided with `projectKeys`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"projectKeys","in":"query","description":"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&projectKeys=proj3`. This parameter may be provided with `projectIds`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"issuetypeIds","in":"query","description":"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&issuetypeIds=10020,10021`. This parameter may be provided with `issuetypeNames`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"issuetypeNames","in":"query","description":"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&issuetypeNames=name3`. This parameter may be provided with `issuetypeIds`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"expand","in":"query","description":"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).","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueCreateMetadata"},"example":"{\"projects\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/ED\",\"id\":\"10000\",\"key\":\"ED\",\"name\":\"Edison Project\",\"avatarUrls\":{\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011\",\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011\"},\"issuetypes\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"An error in the code\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/issuetypes/bug.png\",\"name\":\"Bug\",\"subtask\":false,\"fields\":{\"issuetype\":{\"required\":true,\"name\":\"Issue Type\",\"key\":\"issuetype\",\"autoCompleteUrl\":\"issuetype\",\"hasDefaultValue\":false,\"allowedValues\":[\"set\"]}}}]}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-meta:jira","read:avatar:jira","read:field-configuration:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes":{"get":{"tags":["Issues"],"summary":"Get create metadata issue types for a project","description":"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).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) in the requested projects.","operationId":"getCreateIssueMetaIssueTypes","parameters":[{"name":"projectIdOrKey","in":"path","description":"The ID or key of the project.","required":true,"schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int32","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"maximum":200,"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfCreateMetaIssueTypes"},"example":"{\"startAt\":0,\"maxResults\":1,\"total\":1,\"issueTypes\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"An error in the code\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/issuetypes/bug.png\",\"name\":\"Bug\",\"subtask\":false}]}"}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"example":"{\"errors\":{},\"errorMessages\":[\"Parameter 'maxResults' must not exceed the limit '200'\"],\"httpStatusCode\":{\"empty\":false,\"present\":true}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-meta:jira","read:avatar:jira","read:field-configuration:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes/{issueTypeId}":{"get":{"tags":["Issues"],"summary":"Get create field metadata for a project and issue type id","description":"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).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) in the requested projects.","operationId":"getCreateIssueMetaIssueTypeId","parameters":[{"name":"projectIdOrKey","in":"path","description":"The ID or key of the project.","required":true,"schema":{"type":"string"}},{"name":"issueTypeId","in":"path","description":"The issuetype ID.","required":true,"schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int32","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"maximum":200,"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfCreateMetaIssueTypeWithField"},"example":"{\"startAt\":0,\"maxResults\":1,\"total\":1,\"fields\":[{\"required\":true,\"name\":\"Assignee\",\"key\":\"assignee\",\"hasDefaultValue\":false,\"operations\":[\"set\"],\"fieldId\":\"assignee\"}]}"}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"example":"{\"errors\":{},\"errorMessages\":[\"Parameter 'maxResults' must not exceed the limit '200'\"],\"httpStatusCode\":{\"empty\":false,\"present\":true}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-meta:jira","read:avatar:jira","read:field-configuration:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issue/picker":{"get":{"tags":["Issue search"],"summary":"Get issue picker suggestions","description":"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.\n\nThis operation returns two lists:\n\n *  `History Search` which includes issues from the user's history of created, edited, or viewed issues that contain the string in the `query` parameter.\n *  `Current Search` which includes issues that match the JQL expression in `currentJQL` and contain the string in the `query` parameter.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.","operationId":"getIssuePickerResource","parameters":[{"name":"query","in":"query","description":"A string to match against text fields in the issue such as title, description, or comments.","schema":{"type":"string","example":"query"},"x-showInExample":"true"},{"name":"currentJQL","in":"query","description":"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.","schema":{"type":"string"}},{"name":"currentIssueKey","in":"query","description":"The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query.","schema":{"type":"string"}},{"name":"currentProjectId","in":"query","description":"The ID of a project that suggested issues must belong to.","schema":{"type":"string"}},{"name":"showSubTasks","in":"query","description":"Indicate whether to include subtasks in the suggestions list.","schema":{"type":"boolean"}},{"name":"showSubTaskParent","in":"query","description":"When `currentIssueKey` is a subtask, whether to include the parent issue in the suggestions if it matches the query.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuePickerSuggestions"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-details:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issue/properties":{"post":{"tags":["Issue properties"],"summary":"Bulk set issues properties by list","description":"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.\n\nThe 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.\n\nThis operation is:\n\n *  transactional, either all properties are updated in all eligible issues or, when errors occur, no properties are updated.\n *  [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.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"bulkSetIssuesPropertiesList","parameters":[],"requestBody":{"description":"Issue properties to be set or updated with values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueEntityProperties"}}},"required":true},"responses":{"303":{"description":"Returned if the operation is successful."},"400":{"description":"Return if the request is invalid or the user does not have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue.property:jira"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/properties/multi":{"post":{"tags":["Issue properties"],"summary":"Bulk set issue properties by issue","description":"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.\n\nThe value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON.\n\nThis operation is:\n\n *  [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.\n *  non-transactional. Updating some entities may fail. Such information will available in the task result.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"bulkSetIssuePropertiesByIssue","parameters":[],"requestBody":{"description":"Details of the issue properties to be set or updated. Note that if an issue is not found, it is ignored.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiIssueEntityProperties"},"example":{"issues":[{"issueID":1000,"properties":{"myProperty":{"owner":"admin","weight":100}}},{"issueID":1001,"properties":{"myOtherProperty":{"cost":150,"transportation":"car"}}}]}}},"required":true},"responses":{"303":{"description":"Returned if the operation is successful."},"400":{"description":"Return if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Return if the user does not have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue.property:jira"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/properties/{propertyKey}":{"put":{"tags":["Issue properties"],"summary":"Bulk set issue property","description":"Sets a property value on multiple issues.\n\nThe 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.\n\nThe issues to be updated can be specified by a filter.\n\nThe filter identifies issues eligible for update using these criteria:\n\n *  `entityIds` Only issues from this list are eligible.\n *  `currentValue` Only issues with the property set to this value are eligible.\n *  `hasProperty`:\n    \n     *  If *true*, only issues with the property are eligible.\n     *  If *false*, only issues without the property are eligible.\n\nIf more than one criteria is specified, they are joined with the logical *AND*: only issues that satisfy all criteria are eligible.\n\nIf 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).\n\nThe 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.\n\nThis operation is:\n\n *  transactional, either all eligible issues are updated or, when errors occur, none are updated.\n *  [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.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for each project containing issues.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for each issue.","operationId":"bulkSetIssueProperty","parameters":[{"name":"propertyKey","in":"path","description":"The key of the property. The maximum length is 255 characters.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkIssuePropertyUpdateRequest"},"example":{"filter":{"currentValue":{"owner":"admin","weight":50},"entityIds":[10100,100010],"hasProperty":true},"value":{"owner":"admin","weight":100}}}},"required":true},"responses":{"303":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:jira-expressions:jira","write:issue.property:jira"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Issue properties"],"summary":"Bulk delete issue property","description":"Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.\n\nThe criteria the filter used to identify eligible issues are:\n\n *  `entityIds` Only issues from this list are eligible.\n *  `currentValue` Only issues with the property set to this value are eligible.\n\nIf both criteria is specified, they are joined with the logical *AND*: only issues that satisfy both criteria are considered eligible.\n\nIf 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.\n\nThis operation is:\n\n *  transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.\n *  [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.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [ project permission](https://confluence.atlassian.com/x/yodKLg) for each project containing issues.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for each issue.","operationId":"bulkDeleteIssueProperty","parameters":[{"name":"propertyKey","in":"path","description":"The key of the property.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueFilterForBulkPropertyDelete"},"example":{"currentValue":"deprecated value","entityIds":[10100,100010]}}},"required":true},"responses":{"303":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:issue.property:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/unarchive":{"put":{"tags":["Issues"],"summary":"Unarchive issue(s) by issue keys/ID","description":"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.\n\n**Note that:**\n\n *  you can't unarchive subtasks directly, only through their parent issues\n *  you can only unarchive issues from software, service management, and business projects\n\n**[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg)\n\n**License required:** Premium or Enterprise\n\n**Signed-in users only:** This API can't be accessed anonymously.\n\n  \n","operationId":"unarchiveIssues","parameters":[],"requestBody":{"description":"Contains a list of issue keys or IDs to be unarchived.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueArchivalSyncRequest"},"example":{"issueIdsOrKeys":["PR-1","1001","PROJECT-2"]}}},"required":true},"responses":{"200":{"description":"Returned if there is at least one valid issue to unarchive in the request. It will return the count of unarchived issues, which also includes the count of the subtasks unarchived, and it will show the detailed errors for those issues which are not unarchived.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueArchivalSyncResponse"},"example":"{\"numberOfIssuesUpdated\":10,\"errors\":{\"issuesNotFound\":{\"count\":3,\"issueIdsOrKeys\":[\"PR-2\",\"PR-3\",\"PR-1\"],\"message\":\"Issue not found.\"},\"issuesInArchivedProjects\":{\"count\":2,\"issueIdsOrKeys\":[\"AR-2\",\"AR-1\"],\"message\":\"Issue exists in archived project.\"},\"issueIsSubtask\":{\"count\":3,\"issueIdsOrKeys\":[\"ST-3\",\"ST-1\",\"ST-2\"],\"message\":\"Issue is subtask.\"}}}"}}},"400":{"description":"Returned if none of the issues in the request are eligible to be unarchived. Possible reasons:\n\n *  the issues weren't found\n *  the issues are subtasks\n *  the issues belong to archived projects","content":{"application/json":{"example":"{\"errorMessages\":[\"No valid issue to archive or unarchive. Bad request.\"],\"errors\":{}}"}}},"401":{"description":"Returned if no issues were unarchived because the provided authentication credentials are either missing or invalid.","content":{"application/json":{"example":"{\"errorMessages\":[\"User is not logged in.\"],\"errors\":{}}"}}},"403":{"description":"Returned if no issues were unarchived because the user lacks the required Jira admin or site admin permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only admins can archive or unarchive issues. Access denied.\"],\"errors\":{}}"}}},"412":{"description":"Returned if one or more issues were successfully unarchived, but the operation was incomplete because the number of issue IDs or keys provided exceeds 1000.","content":{"application/json":{"example":"{\"errorMessages\":[\"The number of issues to archive or unarchive exceeds the hard limit of 1000. Precondition failed.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/watching":{"post":{"tags":["Issue watchers"],"summary":"Get is watching issue bulk","description":"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`.\n\nThis 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.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getIsWatchingIssueBulk","parameters":[],"requestBody":{"description":"A list of issue IDs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueList"},"example":{"issueIds":["10001","10002","10005"]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkIssueIsWatching"},"example":"{\"issuesIsWatching\":{\"10001\":true,\"10002\":false,\"10005\":true}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue.watcher:jira","read:user:jira"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/{issueIdOrKey}":{"get":{"tags":["Issues"],"summary":"Get issue","description":"Returns the details for an issue.\n\nThe 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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getIssue","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"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:\n\n *  `*all` Returns all fields.\n *  `*navigable` Returns navigable fields.\n *  Any issue field, prefixed with a minus to exclude.\n\nExamples:\n\n *  `summary,comment` Returns only the summary and comments fields.\n *  `-description` Returns all (default) fields except description.\n *  `*navigable,-comment` Returns all navigable fields except comment.\n\nThis parameter may be specified multiple times. For example, `fields=field1,field2& fields=field3`.\n\nNote: 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.","schema":{"type":"array","items":{"type":"string","default":"*all"}}},{"name":"fieldsByKeys","in":"query","description":"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.","schema":{"type":"boolean","default":false}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `renderedFields` Returns field values rendered in HTML format.\n *  `names` Returns the display name of each field.\n *  `schema` Returns the schema describing a field type.\n *  `transitions` Returns all possible transitions for the issue.\n *  `editmeta` Returns information about how each field can be edited.\n *  `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent.\n *  `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.","schema":{"type":"string"}},{"name":"properties","in":"query","description":"A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values:\n\n *  `*all` Returns all issue properties.\n *  Any issue property key, prefixed with a minus to exclude.\n\nExamples:\n\n *  `*all` Returns all properties.\n *  `*all,-prop1` Returns all properties except `prop1`.\n *  `prop1,prop2` Returns `prop1` and `prop2` properties.\n\nThis parameter may be specified multiple times. For example, `properties=prop1,prop2& properties=prop3`.","schema":{"type":"array","items":{"type":"string","default":"null"}}},{"name":"updateHistory","in":"query","description":"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.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueBean"},"example":"{\"id\":\"10002\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10002\",\"key\":\"ED-1\",\"fields\":{\"watcher\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers\",\"isWatching\":false,\"watchCount\":1,\"watchers\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false}]},\"attachment\":[{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/attachments/10000\",\"filename\":\"picture.jpg\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2023-11-30T00:42:06.866+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10000\",\"thumbnail\":\"https://your-domain.atlassian.net/jira/rest/api/3/attachment/thumbnail/10000\"}],\"sub-tasks\":[{\"id\":\"10000\",\"type\":{\"id\":\"10000\",\"name\":\"\",\"inward\":\"Parent\",\"outward\":\"Sub-task\"},\"outwardIssue\":{\"id\":\"10003\",\"key\":\"ED-2\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/ED-2\",\"fields\":{\"status\":{\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"description\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Main order flow broken\"}]}]},\"project\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"}},\"comment\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"updateAuthor\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2021-01-17T12:34:00.000+0000\",\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\",\"identifier\":\"Administrators\"}}],\"issuelinks\":[{\"id\":\"10001\",\"type\":{\"id\":\"10000\",\"name\":\"Dependent\",\"inward\":\"depends on\",\"outward\":\"is depended by\"},\"outwardIssue\":{\"id\":\"10004L\",\"key\":\"PR-2\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/PR-2\",\"fields\":{\"status\":{\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}},{\"id\":\"10002\",\"type\":{\"id\":\"10000\",\"name\":\"Dependent\",\"inward\":\"depends on\",\"outward\":\"is depended by\"},\"inwardIssue\":{\"id\":\"10004\",\"key\":\"PR-3\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/PR-3\",\"fields\":{\"status\":{\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"worklog\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\",\"identifier\":\"276f955c-63d7-42c8-9520-92d01dca0625\"},\"started\":\"2021-01-17T12:34:00.000+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}],\"updated\":1,\"timetracking\":{\"originalEstimate\":\"10m\",\"remainingEstimate\":\"3m\",\"timeSpent\":\"6m\",\"originalEstimateSeconds\":600,\"remainingEstimateSeconds\":200,\"timeSpentSeconds\":400}}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-meta:jira","read:issue-security-level:jira","read:issue.vote:jira","read:issue.changelog:jira","read:avatar:jira","read:issue:jira","read:status:jira","read:user:jira","read:field-configuration:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Issues"],"summary":"Edit issue","description":"Edits an issue. A transition may be applied and issue properties updated as part of the edit.\n\nThe 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).\n\nThe 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.\n\nConnect 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`.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* and *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"editIssue","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"notifyUsers","in":"query","description":"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.","schema":{"type":"boolean","default":true}},{"name":"overrideScreenSecurity","in":"query","description":"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).","schema":{"type":"boolean","default":false}},{"name":"overrideEditableFlag","in":"query","description":"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).","schema":{"type":"boolean","default":false}},{"name":"returnIssue","in":"query","description":"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).","schema":{"type":"boolean","default":false}},{"name":"expand","in":"query","description":"The Get issue API expand parameter to use in the response if the `returnIssue` parameter is `true`.","schema":{"type":"string","default":""}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueUpdateDetails"},"example":{"fields":{"customfield_10000":{"content":[{"content":[{"text":"Investigation underway","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"customfield_10010":1,"summary":"Completed orders still displaying in pending"},"historyMetadata":{"activityDescription":"Complete order processing","actor":{"avatarUrl":"http://mysystem/avatar/tony.jpg","displayName":"Tony","id":"tony","type":"mysystem-user","url":"http://mysystem/users/tony"},"cause":{"id":"myevent","type":"mysystem-event"},"description":"From the order testing process","extraData":{"Iteration":"10a","Step":"4"},"generator":{"id":"mysystem-1","type":"mysystem-application"},"type":"myplugin:type"},"properties":[{"key":"key1","value":"Order number 10784"},{"key":"key2","value":"Order number 10923"}],"update":{"components":[{"set":""}],"labels":[{"add":"triaged"},{"remove":"blocker"}],"summary":[{"set":"Bug in business logic"}],"timetracking":[{"edit":{"originalEstimate":"1w 1d","remainingEstimate":"4d"}}]}}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful and the `returnIssue` parameter is `true`","content":{"application/json":{"schema":{}}}},"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if:\n\n *  the request body is missing.\n *  the user does not have the necessary permission to edit one or more fields.\n *  the request includes one or more fields that are not found or are not associated with the issue's edit screen.\n *  the request includes an invalid transition."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user uses `overrideScreenSecurity` or `overrideEditableFlag` but doesn't have the necessary permission."},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue:jira"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Issues"],"summary":"Delete issue","description":"Deletes an issue.\n\nAn 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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* and *Delete issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"deleteIssue","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"deleteSubtasks","in":"query","description":"Whether the issue's subtasks are deleted when the issue is deleted.","schema":{"type":"string","default":"false","enum":["true","false"]}}],"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the issue has subtasks and `deleteSubtasks` is not set to *true*."},"401":{"description":"Returned if the authentication credentials are incorrect."},"403":{"description":"Returned if the user does not have permission to delete the issue."},"404":{"description":"Returned if the issue is not found or the user does not have permission to view the issue."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:issue:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/{issueIdOrKey}/assignee":{"put":{"tags":["Issues"],"summary":"Assign issue","description":"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.\n\nIf `name` or `accountId` is set to:\n\n *  `\"-1\"`, the issue is assigned to the default assignee for the project.\n *  `null`, the issue is set to unassigned.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse Projects* and *Assign Issues* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"assignIssue","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue to be assigned.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The request object with the user that the issue is assigned to.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":{"accountId":"5b10ac8d82e05b22cc7d4ef5"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if:\n\n *  the user is not found.\n *  `name`, `key`, or `accountId` is missing.\n *  more than one of `name`, `key`, and `accountId` are provided."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the issue is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue:jira"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/{issueIdOrKey}/attachments":{"post":{"tags":["Issue attachments"],"summary":"Add attachment","description":"Adds one or more attachments to an issue. Attachments are posted as multipart/form-data ([RFC 1867](https://www.ietf.org/rfc/rfc1867.txt)).\n\nNote that:\n\n *  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.\n *  The name of the multipart/form-data parameter that contains the attachments must be `file`.\n\nThe following examples upload a file called *myfile.txt* to the issue *TEST-123*:\n\n#### curl ####\n\n    curl --location --request POST 'https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachments'\n     -u 'email@example.com:<api_token>'\n     -H 'X-Atlassian-Token: no-check'\n     --form 'file=@\"myfile.txt\"'\n\n#### Node.js ####\n\n    // This code sample uses the 'node-fetch' and 'form-data' libraries:\n     // https://www.npmjs.com/package/node-fetch\n     // https://www.npmjs.com/package/form-data\n     const fetch = require('node-fetch');\n     const FormData = require('form-data');\n     const fs = require('fs');\n    \n     const filePath = 'myfile.txt';\n     const form = new FormData();\n     const stats = fs.statSync(filePath);\n     const fileSizeInBytes = stats.size;\n     const fileStream = fs.createReadStream(filePath);\n    \n     form.append('file', fileStream, {knownLength: fileSizeInBytes});\n    \n     fetch('https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachments', {\n         method: 'POST',\n         body: form,\n         headers: {\n             'Authorization': `Basic ${Buffer.from(\n                 'email@example.com:'\n             ).toString('base64')}`,\n             'Accept': 'application/json',\n             'X-Atlassian-Token': 'no-check'\n         }\n     })\n         .then(response => {\n             console.log(\n                 `Response: ${response.status} ${response.statusText}`\n             );\n             return response.text();\n         })\n         .then(text => console.log(text))\n         .catch(err => console.error(err));\n\n#### Java ####\n\n    // This code sample uses the  'Unirest' library:\n     // http://unirest.io/java.html\n     HttpResponse response = Unirest.post(\"https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments\")\n             .basicAuth(\"email@example.com\", \"\")\n             .header(\"Accept\", \"application/json\")\n             .header(\"X-Atlassian-Token\", \"no-check\")\n             .field(\"file\", new File(\"myfile.txt\"))\n             .asJson();\n    \n             System.out.println(response.getBody());\n\n#### Python ####\n\n    # This code sample uses the 'requests' library:\n     # http://docs.python-requests.org\n     import requests\n     from requests.auth import HTTPBasicAuth\n     import json\n    \n     url = \"https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments\"\n    \n     auth = HTTPBasicAuth(\"email@example.com\", \"\")\n    \n     headers = {\n        \"Accept\": \"application/json\",\n        \"X-Atlassian-Token\": \"no-check\"\n     }\n    \n     response = requests.request(\n        \"POST\",\n        url,\n        headers = headers,\n        auth = auth,\n        files = {\n             \"file\": (\"myfile.txt\", open(\"myfile.txt\",\"rb\"), \"application-type\")\n        }\n     )\n    \n     print(json.dumps(json.loads(response.text), sort_keys=True, indent=4, separators=(\",\", \": \")))\n\n#### PHP ####\n\n    // This code sample uses the 'Unirest' library:\n     // http://unirest.io/php.html\n     Unirest\\Request::auth('email@example.com', '');\n    \n     $headers = array(\n       'Accept' => 'application/json',\n       'X-Atlassian-Token' => 'no-check'\n     );\n    \n     $parameters = array(\n       'file' => File::add('myfile.txt')\n     );\n    \n     $response = Unirest\\Request::post(\n       'https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments',\n       $headers,\n       $parameters\n     );\n    \n     var_dump($response)\n\n#### Forge ####\n\n    // This sample uses Atlassian Forge and the `form-data` library.\n     // https://developer.atlassian.com/platform/forge/\n     // https://www.npmjs.com/package/form-data\n     import api from \"@forge/api\";\n     import FormData from \"form-data\";\n    \n     const form = new FormData();\n     form.append('file', fileStream, {knownLength: fileSizeInBytes});\n    \n     const response = await api.asApp().requestJira('/rest/api/2/issue/{issueIdOrKey}/attachments', {\n         method: 'POST',\n         body: form,\n         headers: {\n             'Accept': 'application/json',\n             'X-Atlassian-Token': 'no-check'\n         }\n     });\n    \n     console.log(`Response: ${response.status} ${response.statusText}`);\n     console.log(await response.json());\n\nTip: 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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** \n\n *  *Browse Projects* and *Create attachments* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"addAttachment","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue that attachments are added to.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}},"example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/attachments/10000\",\"id\":\"10001\",\"filename\":\"picture.jpg\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"2023-11-30T00:42:01.748+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"https://your-domain.atlassian.net/rest/api/3/attachment/content/10000\",\"thumbnail\":\"https://your-domain.atlassian.net/rest/api/3/attachment/thumbnail/10000\"},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/attachments/10001\",\"filename\":\"dbeuglog.txt\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"2023-11-30T00:42:01.748+0000\",\"size\":2460,\"mimeType\":\"text/plain\",\"content\":\"https://your-domain.atlassian.net/rest/api/3/attachment/content/10001\"}]"}}},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if any of the following is true:\n\n *  the issue is not found.\n *  the user does not have permission to view the issue."},"413":{"description":"The attachments exceed the maximum attachment size for issues, or more than 60 files are requested to be uploaded. See [Configuring file attachments](https://confluence.atlassian.com/x/wIXKM) for details."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:user:jira","write:attachment:jira","read:attachment:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/{issueIdOrKey}/changelog":{"get":{"tags":["Issues"],"summary":"Get changelogs","description":"Returns a [paginated](#pagination) list of all changelogs for an issue sorted by date, starting from the oldest.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getChangeLogs","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int32","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanChangelog"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/TT-1/changelog?startAt=2&maxResults=2\",\"nextPage\":\"https://your-domain.atlassian.net/rest/api/3/issue/TT-1/changelog?&startAt=4&maxResults=2\",\"maxResults\":2,\"startAt\":2,\"total\":5,\"isLast\":false,\"values\":[{\"id\":\"10001\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"1970-01-18T06:27:50.429+0000\",\"items\":[{\"field\":\"fields\",\"fieldtype\":\"jira\",\"fieldId\":\"fieldId\",\"from\":null,\"fromString\":\"\",\"to\":null,\"toString\":\"label-1\"}]},{\"id\":\"10002\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"1970-01-18T06:27:51.429+0000\",\"items\":[{\"field\":\"fields\",\"fieldtype\":\"jira\",\"fieldId\":\"fieldId\",\"from\":null,\"fromString\":\"label-1\",\"to\":null,\"toString\":\"label-1 label-2\"}]}]}"}}},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-meta:jira","read:avatar:jira","read:issue.changelog:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issue/{issueIdOrKey}/changelog/list":{"post":{"tags":["Issues"],"summary":"Get changelogs by IDs","description":"Returns changelogs for an issue specified by a list of changelog IDs.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getChangeLogsByIds","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueChangelogIds"},"example":{"changelogIds":[10001,10002]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfChangelogs"},"example":"{\"startAt\":0,\"maxResults\":2,\"total\":2,\"histories\":[{\"id\":\"10001\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"1970-01-18T06:27:50.429+0000\",\"items\":[{\"field\":\"fields\",\"fieldtype\":\"jira\",\"fieldId\":\"fieldId\",\"from\":null,\"fromString\":\"\",\"to\":null,\"toString\":\"label-1\"}]},{\"id\":\"10002\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"1970-01-18T06:27:51.429+0000\",\"items\":[{\"field\":\"fields\",\"fieldtype\":\"jira\",\"fieldId\":\"fieldId\",\"from\":null,\"fromString\":\"label-1\",\"to\":null,\"toString\":\"label-1 label-2\"}]}]}"}}},"400":{"description":"Returned if the request is not valid."},"404":{"description":"Returned if the issue is not found or the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-meta:jira","read:avatar:jira","read:issue.changelog:jira"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/{issueIdOrKey}/comment":{"get":{"tags":["Issue comments"],"summary":"Get comments","description":"Returns all comments for an issue.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Comments are included in the response where the user has:\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  If the comment has visibility restrictions, belongs to the group or has the role visibility is role visibility is restricted to.","operationId":"getComments","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":5000}},{"name":"orderBy","in":"query","description":"[Order](#ordering) the results by a field. Accepts *created* to sort comments by their created date.","schema":{"type":"string","enum":["created","-created","+created"]}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfComments"},"example":"{\"startAt\":0,\"maxResults\":1,\"total\":1,\"comments\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"updateAuthor\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2021-01-17T12:34:00.000+0000\",\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\",\"identifier\":\"Administrators\"}}]}"}}},"400":{"description":"Returned if `orderBy` is set to a value other than *created*."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:comment:jira","read:comment.property:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Issue comments"],"summary":"Add comment","description":"Adds a comment to an issue.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* and *Add comments* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"addComment","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Comment"},"example":{"body":{"content":[{"content":[{"text":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"visibility":{"identifier":"Administrators","type":"role","value":"Administrators"}}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Comment"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"updateAuthor\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2021-01-17T12:34:00.000+0000\",\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\",\"identifier\":\"Administrators\"}}"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:comment:jira","read:comment.property:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","write:comment:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/{issueIdOrKey}/comment/{id}":{"get":{"tags":["Issue comments"],"summary":"Get comment","description":"Returns a comment.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.","operationId":"getComment","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the comment.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Comment"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"updateAuthor\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2021-01-17T12:34:00.000+0000\",\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\",\"identifier\":\"Administrators\"}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the issue or comment is not found or the user does not have permission to view the issue or comment."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:comment:jira","read:comment.property:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Issue comments"],"summary":"Update comment","description":"Updates a comment.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  *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.\n *  If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.","operationId":"updateComment","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the comment.","required":true,"schema":{"type":"string"}},{"name":"notifyUsers","in":"query","description":"Whether users are notified when a comment is updated.","schema":{"type":"boolean","default":true}},{"name":"overrideEditableFlag","in":"query","description":"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).","schema":{"type":"boolean","default":false}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Comment"},"example":{"body":{"content":[{"content":[{"text":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"visibility":{"identifier":"Administrators","type":"role","value":"Administrators"}}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Comment"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"updateAuthor\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2021-01-17T12:34:00.000+0000\",\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\",\"identifier\":\"Administrators\"}}"}}},"400":{"description":"Returned if the user does not have permission to edit the comment or the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the issue or comment is not found or the user does not have permission to view the issue or comment."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:comment:jira","read:comment.property:jira","read:group:jira","read:project:jira","read:project-role:jira","read:user:jira","write:comment:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Issue comments"],"summary":"Delete comment","description":"Deletes a comment.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  *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,\n *  If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.","operationId":"deleteComment","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the comment.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the user does not have permission to delete the comment."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the issue or comment is not found or the user does not have permission to view the issue or comment."},"405":{"description":"Returned if an anonymous call is made to the operation."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:comment:jira","delete:comment.property:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/{issueIdOrKey}/editmeta":{"get":{"tags":["Issues"],"summary":"Get edit issue metadata","description":"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).\n\nThis endpoint will check for these conditions:\n\n1.  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.\n2.  Field is visible in the [field configuration](https://support.atlassian.com/jira-cloud-administration/docs/change-a-field-configuration/). `overrideScreenSecurity=true` skips this condition.\n3.  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.\n4.  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.\n5.  Issue has a project, issue type, and status defined.\n6.  Issue is assigned to a valid workflow, and the current status has assigned a workflow step. `overrideEditableFlag=true` skips this condition.\n7.  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.\n8.  User has [Edit issues permission](https://support.atlassian.com/jira-cloud-administration/docs/permissions-for-company-managed-projects/).\n9.  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.\n\nFields hidden using [Issue layout settings page](https://support.atlassian.com/jira-software-cloud/docs/configure-field-layout-in-the-issue-view/) remain editable.\n\nConnect 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:\n\n *  `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).\n *  `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).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n\nNote: For any fields to be editable the user must have the *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the issue.","operationId":"getEditIssueMeta","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"overrideScreenSecurity","in":"query","description":"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).","schema":{"type":"boolean","default":false}},{"name":"overrideEditableFlag","in":"query","description":"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).","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueUpdateMetadata"},"example":"{\"fields\":{\"summary\":{\"required\":false,\"schema\":{\"type\":\"array\",\"items\":\"option\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:multiselect\",\"customId\":10001},\"name\":\"My Multi Select\",\"key\":\"field_key\",\"hasDefaultValue\":false,\"operations\":[\"set\",\"add\"],\"allowedValues\":[\"red\",\"blue\"],\"defaultValue\":\"red\"}}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user uses an override parameter but doesn't have permission to do so."},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-meta:jira","read:field-configuration:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issue/{issueIdOrKey}/notify":{"post":{"tags":["Issues"],"summary":"Send notification for issue","description":"Creates an email notification for an issue and adds it to the mail queue.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"notify","parameters":[{"name":"issueIdOrKey","in":"path","description":"ID or key of the issue that the notification is sent for.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The request object for the notification and recipients.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notification"},"example":{"htmlBody":"The <strong>latest</strong> test results for this ticket are now available.","restrict":{"groupIds":[],"groups":[{"name":"notification-group"}],"permissions":[{"key":"BROWSE"}]},"subject":"Latest test results","textBody":"The latest test results for this ticket are now available.","to":{"assignee":false,"groupIds":[],"groups":[{"name":"notification-group"}],"reporter":false,"users":[{"accountId":"5b10a2844c20165700ede21g","active":false}],"voters":true,"watchers":true}}}},"required":true},"responses":{"204":{"description":"Returned if the email is queued for sending.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if:\n\n *  the recipient is the same as the calling user.\n *  the recipient is invalid. For example, the recipient is set to the assignee, but the issue is unassigned.\n *  the request is invalid. For example, required fields are missing or have invalid values."},"403":{"description":"Returned if:\n\n *  outgoing emails are disabled.\n *  no SMTP server is configured."},"404":{"description":"Returned if the issue is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["send:notification:jira"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/{issueIdOrKey}/properties":{"get":{"tags":["Issue properties"],"summary":"Get issue property keys","description":"Returns the URLs and keys of an issue's properties.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Property details are only returned where the user has:\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getIssuePropertyKeys","parameters":[{"name":"issueIdOrKey","in":"path","description":"The key or ID of the issue.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyKeys"},"example":"{\"keys\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"}}},"404":{"description":"Returned if the issue is not found or the user does not have permissions to view the issue."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue.property:jira","read:comment.property:jira","read:dashboard.property:jira","read:issue-type.property:jira","read:issue-worklog.property:jira","read:project.property:jira","read:user.property:jira","read:workflow.property:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}":{"get":{"tags":["Issue properties"],"summary":"Get issue property","description":"Returns the key and value of an issue's property.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getIssueProperty","parameters":[{"name":"issueIdOrKey","in":"path","description":"The key or ID of the issue.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityProperty"},"example":"{\"key\":\"issue.support\",\"value\":{\"system.conversation.id\":\"b1bf38be-5e94-4b40-a3b8-9278735ee1e6\",\"system.support.time\":\"1m\"}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the issue or property is not found or the user does not have permission to see the issue."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue.property:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Issue properties"],"summary":"Set issue property","description":"Sets the value of an issue's property. Use this resource to store custom data against an issue.\n\nThe 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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"setIssueProperty","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the issue property. The maximum length is 255 characters.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{}}},"required":true},"responses":{"200":{"description":"Returned if the issue property is updated.","content":{"application/json":{"schema":{}}}},"201":{"description":"Returned if the issue property is created.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to edit the issue."},"404":{"description":"Returned if the issue is not found or the user does not have permission to view the issue."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue.property:jira"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Issue properties"],"summary":"Delete issue property","description":"Deletes an issue's property.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"deleteIssueProperty","parameters":[{"name":"issueIdOrKey","in":"path","description":"The key or ID of the issue.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the issue or property is not found, or the user does not have permission to edit the issue."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:issue.property:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/{issueIdOrKey}/remotelink":{"get":{"tags":["Issue remote links"],"summary":"Get remote issue links","description":"Returns the remote issue links for an issue. When a remote issue link global ID is provided the record with that global ID is returned, otherwise all remote issue links are returned. Where a global ID includes reserved URL characters these must be escaped in the request. For example, pass `system=http://www.mycompany.com/support&id=1` as `system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1`.\n\nThis operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getRemoteIssueLinks","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string","example":"10000"},"x-showInExample":"true"},{"name":"globalId","in":"query","description":"The global ID of the remote issue link.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteIssueLink"},"example":"[{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10000\",\"globalId\":\"system=http://www.mycompany.com/support&id=1\",\"application\":{\"type\":\"com.acme.tracker\",\"name\":\"My Acme Tracker\"},\"relationship\":\"causes\",\"object\":{\"url\":\"http://www.mycompany.com/support?id=1\",\"title\":\"TSTSUP-111\",\"summary\":\"Customer support issue\",\"icon\":{\"url16x16\":\"http://www.mycompany.com/support/ticket.png\",\"title\":\"Support Ticket\"},\"status\":{\"resolved\":true,\"icon\":{\"url16x16\":\"http://www.mycompany.com/support/resolved.png\",\"title\":\"Case Closed\",\"link\":\"http://www.mycompany.com/support?id=1&details=closed\"}}}},{\"id\":10001,\"self\":\"https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10001\",\"globalId\":\"system=http://www.anothercompany.com/tester&id=1234\",\"application\":{\"type\":\"com.acme.tester\",\"name\":\"My Acme Tester\"},\"relationship\":\"is tested by\",\"object\":{\"url\":\"http://www.anothercompany.com/tester/testcase/1234\",\"title\":\"Test Case #1234\",\"summary\":\"Test that the submit button saves the item\",\"icon\":{\"url16x16\":\"http://www.anothercompany.com/tester/images/testcase.gif\",\"title\":\"Test Case\"},\"status\":{\"resolved\":false,\"icon\":{\"url16x16\":\"http://www.anothercompany.com/tester/images/person/mia.gif\",\"title\":\"Tested by Mia Krystof\",\"link\":\"http://www.anothercompany.com/tester/person?accountId=5b10a2844c20165700ede21g\"}}}}]"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if issue linking is disabled."},"404":{"description":"Returned if the issue or remote issue link is not found or the user does not have permission to view the issue."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue.remote-link:jira","read:status:jira"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Issue remote links"],"summary":"Create or update remote issue link","description":"Creates or updates a remote issue link for an issue.\n\nIf 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.\n\nThis operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"createOrUpdateRemoteIssueLink","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteIssueLinkRequest"},"example":{"application":{"name":"My Acme Tracker","type":"com.acme.tracker"},"globalId":"system=http://www.mycompany.com/support&id=1","object":{"icon":{"title":"Support Ticket","url16x16":"http://www.mycompany.com/support/ticket.png"},"status":{"icon":{"link":"http://www.mycompany.com/support?id=1&details=closed","title":"Case Closed","url16x16":"http://www.mycompany.com/support/resolved.png"},"resolved":true},"summary":"Customer support issue","title":"TSTSUP-111","url":"http://www.mycompany.com/support?id=1"},"relationship":"causes"}}},"required":true},"responses":{"200":{"description":"Returned if the remote issue link is updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteIssueLinkIdentifies"},"example":"{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10000\"}"}}},"201":{"description":"Returned if the remote issue link is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteIssueLinkIdentifies"},"example":"{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10000\"}"}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"example":"{\"errorMessages\":[],\"errors\":{\"title\":\"'title' is required.\"}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to link issues."},"404":{"description":"Returned if the issue is not found or the user does not have permission to view the issue."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue:jira","write:issue.remote-link:jira","read:issue.remote-link:jira"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Issue remote links"],"summary":"Delete remote issue link by global ID","description":"Deletes the remote issue link from the issue using the link's global ID. Where the global ID includes reserved URL characters these must be escaped in the request. For example, pass `system=http://www.mycompany.com/support&id=1` as `system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1`.\n\nThis operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is implemented, issue-level security permission to view the issue.","operationId":"deleteRemoteIssueLinkByGlobalId","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string","example":"10000"},"x-showInExample":"true"},{"name":"globalId","in":"query","description":"The global ID of a remote issue link.","required":true,"schema":{"type":"string","example":"system=http://www.mycompany.com/support&id=1"},"x-showInExample":"true"}],"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if a global ID isn't provided."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to link issues."},"404":{"description":"Returned if the issue or remote issue link is not found or the user does not have permission to view the issue."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:issue.remote-link:jira","write:issue:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}":{"get":{"tags":["Issue remote links"],"summary":"Get remote issue link by ID","description":"Returns a remote issue link for an issue.\n\nThis operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"getRemoteIssueLinkById","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"linkId","in":"path","description":"The ID of the remote issue link.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteIssueLink"},"example":"{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10000\",\"globalId\":\"system=http://www.mycompany.com/support&id=1\",\"application\":{\"type\":\"com.acme.tracker\",\"name\":\"My Acme Tracker\"},\"relationship\":\"causes\",\"object\":{\"url\":\"http://www.mycompany.com/support?id=1\",\"title\":\"TSTSUP-111\",\"summary\":\"Customer support issue\",\"icon\":{\"url16x16\":\"http://www.mycompany.com/support/ticket.png\",\"title\":\"Support Ticket\"},\"status\":{\"resolved\":true,\"icon\":{\"url16x16\":\"http://www.mycompany.com/support/resolved.png\",\"title\":\"Case Closed\",\"link\":\"http://www.mycompany.com/support?id=1&details=closed\"}}}}"}}},"400":{"description":"Returned if the link ID is invalid or the remote issue link does not belong to the issue."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if issue linking is disabled."},"404":{"description":"Returned if the issue or remote issue link is not found or the user does not have permission to view the issue."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue.remote-link:jira","read:status:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Issue remote links"],"summary":"Update remote issue link by ID","description":"Updates a remote issue link for an issue.\n\nNote: Fields without values in the request are set to null.\n\nThis operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"updateRemoteIssueLink","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string","example":"10000"},"x-showInExample":"true"},{"name":"linkId","in":"path","description":"The ID of the remote issue link.","required":true,"schema":{"type":"string","example":"10000"},"x-showInExample":"true"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteIssueLinkRequest"},"example":{"application":{"name":"My Acme Tracker","type":"com.acme.tracker"},"globalId":"system=http://www.mycompany.com/support&id=1","object":{"icon":{"title":"Support Ticket","url16x16":"http://www.mycompany.com/support/ticket.png"},"status":{"icon":{"link":"http://www.mycompany.com/support?id=1&details=closed","title":"Case Closed","url16x16":"http://www.mycompany.com/support/resolved.png"},"resolved":true},"summary":"Customer support issue","title":"TSTSUP-111","url":"http://www.mycompany.com/support?id=1"},"relationship":"causes"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if:\n\n *  the link ID is invalid.\n *  the remote issue link does not belong to the issue.\n *  the request body is invalid.","content":{"application/json":{"example":"{\"errorMessages\":[],\"errors\":{\"title\":\"'title' is required.\"}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to link issues."},"404":{"description":"Returned if the issue or remote issue link is not found or the user does not have permission to view the issue."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue:jira","write:issue.remote-link:jira"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Issue remote links"],"summary":"Delete remote issue link by ID","description":"Deletes a remote issue link from an issue.\n\nThis operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects*, *Edit issues*, and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"deleteRemoteIssueLinkById","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string","example":"10000"},"x-showInExample":"true"},{"name":"linkId","in":"path","description":"The ID of a remote issue link.","required":true,"schema":{"type":"string","example":"10000"},"x-showInExample":"true"}],"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the link ID is invalid or the remote issue link does not belong to the issue."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to link issues."},"404":{"description":"Returned if the issue or remote issue link is not found or the user does not have permission to view the issue."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:issue.remote-link:jira","write:issue:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/{issueIdOrKey}/transitions":{"get":{"tags":["Issues"],"summary":"Get transitions","description":"Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status.\n\nNote, 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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required: A list or transition is returned only when the user has:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n\nHowever, if the user does not have the *Transition issues* [ project permission](https://confluence.atlassian.com/x/yodKLg) the response will not list any transitions.","operationId":"getTransitions","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"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).","schema":{"type":"string"}},{"name":"transitionId","in":"query","description":"The ID of the transition.","schema":{"type":"string"}},{"name":"skipRemoteOnlyCondition","in":"query","description":"Whether transitions with the condition *Hide From User Condition* are included in the response.","schema":{"type":"boolean","default":false}},{"name":"includeUnavailableTransitions","in":"query","description":"Whether details of transitions that fail a condition are included in the response","schema":{"type":"boolean","default":false}},{"name":"sortByOpsBarAndStatus","in":"query","description":"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.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transitions"},"example":"{\"transitions\":[{\"id\":\"2\",\"name\":\"Close Issue\",\"to\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/status/10000\",\"description\":\"The issue is currently being worked on.\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/progress.gif\",\"name\":\"In Progress\",\"id\":\"10000\",\"statusCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In Progress\"}},\"hasScreen\":false,\"isGlobal\":false,\"isInitial\":false,\"isAvailable\":true,\"isConditional\":false,\"fields\":{\"summary\":{\"required\":false,\"schema\":{\"type\":\"array\",\"items\":\"option\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:multiselect\",\"customId\":10001},\"name\":\"My Multi Select\",\"key\":\"field_key\",\"hasDefaultValue\":false,\"operations\":[\"set\",\"add\"],\"allowedValues\":[\"red\",\"blue\"],\"defaultValue\":\"red\"}}},{\"id\":\"711\",\"name\":\"QA Review\",\"to\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/status/5\",\"description\":\"The issue is closed.\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/closed.gif\",\"name\":\"Closed\",\"id\":\"5\",\"statusCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/statuscategory/9\",\"id\":9,\"key\":\"completed\",\"colorName\":\"green\"}},\"hasScreen\":true,\"fields\":{\"summary\":{\"required\":false,\"schema\":{\"type\":\"array\",\"items\":\"option\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:multiselect\",\"customId\":10001},\"name\":\"My Multi Select\",\"key\":\"field_key\",\"hasDefaultValue\":false,\"operations\":[\"set\",\"add\"],\"allowedValues\":[\"red\",\"blue\"],\"defaultValue\":\"red\"},\"colour\":{\"required\":false,\"schema\":{\"type\":\"array\",\"items\":\"option\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:multiselect\",\"customId\":10001},\"name\":\"My Multi Select\",\"key\":\"field_key\",\"hasDefaultValue\":false,\"operations\":[\"set\",\"add\"],\"allowedValues\":[\"red\",\"blue\"],\"defaultValue\":\"red\"}}}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue.transition:jira","read:status:jira","read:field-configuration:jira"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Issues"],"summary":"Transition issue","description":"Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.\n\nsortByCategory 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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* and *Transition issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"doTransition","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueUpdateDetails"},"example":{"fields":{"assignee":{"name":"bob"},"resolution":{"name":"Fixed"}},"historyMetadata":{"activityDescription":"Complete order processing","actor":{"avatarUrl":"http://mysystem/avatar/tony.jpg","displayName":"Tony","id":"tony","type":"mysystem-user","url":"http://mysystem/users/tony"},"cause":{"id":"myevent","type":"mysystem-event"},"description":"From the order testing process","extraData":{"Iteration":"10a","Step":"4"},"generator":{"id":"mysystem-1","type":"mysystem-application"},"type":"myplugin:type"},"transition":{"id":"5"},"update":{"comment":[{"add":{"body":{"content":[{"content":[{"text":"Bug has been fixed","type":"text"}],"type":"paragraph"}],"type":"doc","version":1}}}]}}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if:\n\n *  no transition is specified.\n *  the user does not have permission to transition the issue.\n *  a field that isn't included on the transition screen is defined in `fields` or `update`.\n *  a field is specified in both `fields` and `update`.\n *  the request is invalid for any other reason."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue:jira","write:issue.property:jira"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/{issueIdOrKey}/votes":{"get":{"tags":["Issue votes"],"summary":"Get votes","description":"Returns details about the votes on an issue.\n\nThis 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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is ini\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n\nNote 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.","operationId":"getVotes","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Votes"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/issue/MKY-1/votes\",\"votes\":24,\"hasVoted\":true,\"voters\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  voting is disabled.\n *  the user does not have permission to view the issue.\n *  the issue is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue.vote:jira","read:user:jira","read:application-role:jira","read:avatar:jira","read:group:jira"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Issue votes"],"summary":"Add vote","description":"Adds the user's vote to an issue. This is the equivalent of the user clicking *Vote* on an issue in Jira.\n\nThis 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.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"addVote","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  voting is disabled.\n *  the issue is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue.vote:jira"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Issue votes"],"summary":"Delete vote","description":"Deletes a user's vote from an issue. This is the equivalent of the user clicking *Unvote* on an issue in Jira.\n\nThis 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.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"removeVote","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  voting is disabled.\n *  the user has not voted on the issue.\n *  the issue is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue.vote:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/{issueIdOrKey}/watchers":{"get":{"tags":["Issue watchers"],"summary":"Get issue watchers","description":"Returns the watchers for an issue.\n\nThis 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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is ini\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  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.","operationId":"getIssueWatchers","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Watchers"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers\",\"isWatching\":false,\"watchCount\":1,\"watchers\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue.watcher:jira","read:user:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Issue watchers"],"summary":"Add watcher","description":"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.\n\nThis 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.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  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.","operationId":"addWatcher","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The account ID of the user. Note that username cannot be used due to privacy changes.","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the permission to manage the watcher list."},"404":{"description":"Returned if the issue or the user is not found or the user does not have permission to view the issue."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue.watcher:jira"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Issue watchers"],"summary":"Delete watcher","description":"Deletes a user as a watcher of an issue.\n\nThis 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.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  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.","operationId":"removeWatcher","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"username","in":"query","description":"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.","schema":{"type":"string"}},{"name":"accountId","in":"query","description":"The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required.","schema":{"maxLength":128,"type":"string","example":"5b10ac8d82e05b22cc7d4ef5"},"x-showInExample":"true"}],"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if `accountId` is not supplied."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the permission to manage the watcher list."},"404":{"description":"Returned if the issue or the user is not found or the user does not have permission to view the issue."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue.watcher:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/{issueIdOrKey}/worklog":{"get":{"tags":["Issue worklogs"],"summary":"Get issue worklogs","description":"Returns worklogs for an issue, starting from the oldest worklog or from the worklog started on or after a date and time.\n\nTime 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).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Workloads are only returned where the user has:\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.","operationId":"getIssueWorklog","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":5000}},{"name":"startedAfter","in":"query","description":"The worklog start date and time, as a UNIX timestamp in milliseconds, after which worklogs are returned.","schema":{"type":"integer","format":"int64"}},{"name":"startedBefore","in":"query","description":"The worklog start date and time, as a UNIX timestamp in milliseconds, before which worklogs are returned.","schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts`properties`, which returns worklog properties.","schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfWorklogs"},"example":"{\"startAt\":0,\"maxResults\":1,\"total\":1,\"worklogs\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\",\"identifier\":\"276f955c-63d7-42c8-9520-92d01dca0625\"},\"started\":\"2021-01-17T12:34:00.000+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  the issue is not found or the user does not have permission to view the issue.\n *  `startAt` or `maxResults` has non-numeric values.\n *  time tracking is disabled."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:group:jira","read:issue-worklog:jira","read:issue-worklog.property:jira","read:project-role:jira","read:user:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Issue worklogs"],"summary":"Add worklog","description":"Adds a worklog to an issue.\n\nTime 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).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* and *Work on issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"addWorklog","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key the issue.","required":true,"schema":{"type":"string"}},{"name":"notifyUsers","in":"query","description":"Whether users watching the issue are notified by email.","schema":{"type":"boolean","default":true}},{"name":"adjustEstimate","in":"query","description":"Defines how to update the issue's time estimate, the options are:\n\n *  `new` Sets the estimate to a specific value, defined in `newEstimate`.\n *  `leave` Leaves the estimate unchanged.\n *  `manual` Reduces the estimate by amount specified in `reduceBy`.\n *  `auto` Reduces the estimate by the value of `timeSpent` in the worklog.","schema":{"type":"string","default":"auto","enum":["new","leave","manual","auto"]}},{"name":"newEstimate","in":"query","description":"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`.","schema":{"type":"string"}},{"name":"reduceBy","in":"query","description":"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`.","schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts `properties`, which returns worklog properties.","schema":{"type":"string","default":""}},{"name":"overrideEditableFlag","in":"query","description":"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.","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Worklog"},"example":{"comment":{"content":[{"content":[{"text":"I did some work here.","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"started":"2021-01-17T12:34:00.000+0000","timeSpentSeconds":12000,"visibility":{"identifier":"276f955c-63d7-42c8-9520-92d01dca0625","type":"group"}}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Worklog"}}}},"400":{"description":"Returned if:\n\n *  `adjustEstimate` is set to `new` but `newEstimate` is not provided or is invalid.\n *  `adjustEstimate` is set to `manual` but `reduceBy` is not provided or is invalid.\n *  the user does not have permission to add the worklog.\n *  the request JSON is malformed."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-worklog:jira","write:issue-worklog.property:jira","read:avatar:jira","read:group:jira","read:issue-worklog:jira","read:project-role:jira","read:user:jira","read:issue-worklog.property:jira"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/{issueIdOrKey}/worklog/{id}":{"get":{"tags":["Issue worklogs"],"summary":"Get worklog","description":"Returns a worklog.\n\nTime 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).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.","operationId":"getWorklog","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the worklog.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts\n\n`properties`, which returns worklog properties.","schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Worklog"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\",\"identifier\":\"276f955c-63d7-42c8-9520-92d01dca0625\"},\"started\":\"2021-01-17T12:34:00.000+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if:\n\n *  the issue is not found or the user does not have permission to view it.\n *  the worklog is not found or the user does not have permission to view it.\n *  time tracking is disabled.\n\n."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:comment:jira","read:group:jira","read:issue-worklog:jira","read:issue-worklog.property:jira","read:project-role:jira","read:user:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Issue worklogs"],"summary":"Update worklog","description":"Updates a worklog.\n\nTime 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).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  *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.\n *  If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.","operationId":"updateWorklog","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key the issue.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the worklog.","required":true,"schema":{"type":"string"}},{"name":"notifyUsers","in":"query","description":"Whether users watching the issue are notified by email.","schema":{"type":"boolean","default":true}},{"name":"adjustEstimate","in":"query","description":"Defines how to update the issue's time estimate, the options are:\n\n *  `new` Sets the estimate to a specific value, defined in `newEstimate`.\n *  `leave` Leaves the estimate unchanged.\n *  `auto` Updates the estimate by the difference between the original and updated value of `timeSpent` or `timeSpentSeconds`.","schema":{"type":"string","default":"auto","enum":["new","leave","manual","auto"]}},{"name":"newEstimate","in":"query","description":"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`.","schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts `properties`, which returns worklog properties.","schema":{"type":"string","default":""}},{"name":"overrideEditableFlag","in":"query","description":"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.","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Worklog"},"example":{"comment":{"content":[{"content":[{"text":"I did some work here.","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"started":"2021-01-17T12:34:00.000+0000","timeSpentSeconds":12000,"visibility":{"identifier":"276f955c-63d7-42c8-9520-92d01dca0625","type":"group"}}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Worklog"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\",\"identifier\":\"276f955c-63d7-42c8-9520-92d01dca0625\"},\"started\":\"2021-01-17T12:34:00.000+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}"}}},"400":{"description":"Returned if:\n\n *  `adjustEstimate` is set to `new` but `newEstimate` is not provided or is invalid.\n *  the user does not have permission to update the worklog.\n *  the request JSON is malformed."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if:\n\n *  the issue is not found or user does not have permission to view the issue.\n *  the worklog is not found or the user does not have permission to view it.\n *  time tracking is disabled."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:comment:jira","read:group:jira","read:issue-worklog:jira","read:issue-worklog.property:jira","read:project-role:jira","read:user:jira","write:comment:jira","write:issue-worklog:jira","write:issue-worklog.property:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Issue worklogs"],"summary":"Delete worklog","description":"Deletes a worklog from an issue.\n\nTime 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).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  *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,\n *  If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.","operationId":"deleteWorklog","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the worklog.","required":true,"schema":{"type":"string"}},{"name":"notifyUsers","in":"query","description":"Whether users watching the issue are notified by email.","schema":{"type":"boolean","default":true}},{"name":"adjustEstimate","in":"query","description":"Defines how to update the issue's time estimate, the options are:\n\n *  `new` Sets the estimate to a specific value, defined in `newEstimate`.\n *  `leave` Leaves the estimate unchanged.\n *  `manual` Increases the estimate by amount specified in `increaseBy`.\n *  `auto` Reduces the estimate by the value of `timeSpent` in the worklog.","schema":{"type":"string","default":"auto","enum":["new","leave","manual","auto"]}},{"name":"newEstimate","in":"query","description":"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`.","schema":{"type":"string"}},{"name":"increaseBy","in":"query","description":"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`.","schema":{"type":"string"}},{"name":"overrideEditableFlag","in":"query","description":"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.","schema":{"type":"boolean","default":false}}],"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if:\n\n *  `adjustEstimate` is set to `new` but `newEstimate` is not provided or is invalid.\n *  `adjustEstimate` is set to `manual` but `reduceBy` is not provided or is invalid.\n *  the user does not have permission to delete the worklog."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if:\n\n *  the issue is not found or user does not have permission to view the issue.\n *  the worklog is not found or the user does not have permission to view it.\n *  time tracking is disabled."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:issue-worklog:jira","delete:issue-worklog.property:jira","write:issue.time-tracking:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties":{"get":{"tags":["Issue worklog properties"],"summary":"Get worklog property keys","description":"Returns the keys of all properties for a worklog.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.","operationId":"getWorklogPropertyKeys","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"worklogId","in":"path","description":"The ID of the worklog.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyKeys"},"example":"{\"keys\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"}}},"400":{"description":"Returned if the worklog ID is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  the issue or worklog is not found.\n *  the user does not have permission to view the issue or worklog."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-worklog.property:jira","read:comment.property:jira","read:dashboard.property:jira","read:issue-type.property:jira","read:issue.property:jira","read:project.property:jira","read:user.property:jira","read:workflow.property:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}":{"get":{"tags":["Issue worklog properties"],"summary":"Get worklog property","description":"Returns the value of a worklog property.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.","operationId":"getWorklogProperty","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"worklogId","in":"path","description":"The ID of the worklog.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityProperty"},"example":"{\"key\":\"issue.support\",\"value\":{\"system.conversation.id\":\"b1bf38be-5e94-4b40-a3b8-9278735ee1e6\",\"system.support.time\":\"1m\"}}"}}},"400":{"description":"Returned if the worklog ID is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  the issue, worklog, or property is not found.\n *  the user does not have permission to view the issue or worklog."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-worklog.property:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Issue worklog properties"],"summary":"Set worklog property","description":"Sets the value of a worklog property. Use this operation to store custom data against the worklog.\n\nThe 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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  *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.\n *  If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.","operationId":"setWorklogProperty","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"worklogId","in":"path","description":"The ID of the worklog.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the issue property. The maximum length is 255 characters.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{}}},"required":true},"responses":{"200":{"description":"Returned if the worklog property is updated.","content":{"application/json":{"schema":{}}}},"201":{"description":"Returned if the worklog property is created.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the worklog ID is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to edit the worklog."},"404":{"description":"Returned if:\n\n *  the issue or worklog is not found.\n *  the user does not have permission to view the issue or worklog."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-worklog.property:jira"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Issue worklog properties"],"summary":"Delete worklog property","description":"Deletes a worklog property.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.","operationId":"deleteWorklogProperty","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.","required":true,"schema":{"type":"string"}},{"name":"worklogId","in":"path","description":"The ID of the worklog.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the worklog property is removed."},"400":{"description":"Returned if the worklog key or id is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to edit the worklog."},"404":{"description":"Returned if:\n\n *  the issue, worklog, or property is not found.\n *  the user does not have permission to view the issue or worklog."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:issue-worklog.property:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issueLink":{"post":{"tags":["Issue links"],"summary":"Create issue link","description":"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.\n\nThis 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`.\n\nIf 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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse project* [project permission](https://confluence.atlassian.com/x/yodKLg) for all the projects containing the issues to be linked,\n *  *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) on the project containing the from (outward) issue,\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n *  If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.","operationId":"linkIssues","parameters":[],"requestBody":{"description":"The issue link request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkIssueRequestJsonBean"},"example":{"comment":{"body":{"content":[{"content":[{"text":"Linked related issue!","type":"text"}],"type":"paragraph"}],"type":"doc","version":1},"visibility":{"identifier":"276f955c-63d7-42c8-9520-92d01dca0625","type":"group","value":"jira-software-users"}},"inwardIssue":{"key":"HSP-1"},"outwardIssue":{"key":"MKY-1"},"type":{"name":"Duplicate"}}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the comment is not created. The response contains an error message indicating why the comment wasn't created. The issue link is also not created."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  issue linking is disabled.\n *  the user cannot view one or both of the issues. For example, the user doesn't have *Browse project* project permission for a project containing one of the issues.\n *  the user does not have *link issues* project permission.\n *  either of the link issues are not found.\n *  the issue link type is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:comment:jira","write:issue:jira","write:issue-link:jira"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issueLink/{linkId}":{"get":{"tags":["Issue links"],"summary":"Get issue link","description":"Returns an issue link.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Browse project* [project permission](https://confluence.atlassian.com/x/yodKLg) for all the projects containing the linked issues.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, permission to view both of the issues.","operationId":"getIssueLink","parameters":[{"name":"linkId","in":"path","description":"The ID of the issue link.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueLink"},"example":"{\"id\":\"10001\",\"type\":{\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated by\",\"outward\":\"Duplicates\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000\"},\"inwardIssue\":{\"id\":\"10004\",\"key\":\"PR-3\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/PR-3\",\"fields\":{\"status\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/status/5\",\"description\":\"The issue is closed.\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/closed.gif\",\"name\":\"Closed\",\"id\":\"5\",\"statusCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/statuscategory/9\",\"id\":9,\"key\":\"completed\",\"colorName\":\"green\"}},\"priority\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/priority/5\",\"statusColor\":\"#cfcfcf\",\"description\":\"Very little impact.\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/priorities/trivial.png\",\"name\":\"Trivial\",\"id\":\"2\"},\"issuetype\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"hierarchyLevel\":0,\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\"}}}}},\"outwardIssue\":{\"id\":\"10004L\",\"key\":\"PR-2\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/PR-2\",\"fields\":{\"status\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/status/10000\",\"description\":\"The issue is currently being worked on.\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/progress.gif\",\"name\":\"In Progress\",\"id\":\"10000\",\"statusCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In Progress\"}},\"priority\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/priority/3\",\"statusColor\":\"#009900\",\"description\":\"Major loss of function.\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/priorities/major.png\",\"name\":\"Major\",\"id\":\"1\"},\"issuetype\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1,\"hierarchyLevel\":0}}}}"}}},"400":{"description":"Returned if the issue link ID is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  issue linking is disabled.\n *  the issue link is not found.\n *  the user doesn't have the required permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira","read:issue-link-type:jira","read:issue:jira","read:issue-type:jira","read:priority:jira","read:status:jira","read:avatar:jira","read:issue.time-tracking:jira","read:project-category:jira","read:project:jira","read:user:jira"]}],"x-atlassian-connect-scope":"READ"},"delete":{"tags":["Issue links"],"summary":"Delete issue link","description":"Deletes an issue link.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  Browse project [project permission](https://confluence.atlassian.com/x/yodKLg) for all the projects containing the issues in the link.\n *  *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for at least one of the projects containing issues in the link.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, permission to view both of the issues.","operationId":"deleteIssueLink","parameters":[{"name":"linkId","in":"path","description":"The ID of the issue link.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200 response"},"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the issue link ID is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  issue linking is disabled.\n *  the issue link is not found.\n *  the user doesn't have the required permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["write:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["write:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:issue-link:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issueLinkType":{"get":{"tags":["Issue link types"],"summary":"Get issue link types","description":"Returns a list of all issue link types.\n\nTo use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project in the site.","operationId":"getIssueLinkTypes","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueLinkTypes"},"example":"{\"issueLinkTypes\":[{\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated by\",\"outward\":\"Duplicates\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000\"},{\"id\":\"1010\",\"name\":\"Blocks\",\"inward\":\"Blocked by\",\"outward\":\"Blocks\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueLinkType/1010\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if issue linking is disabled."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-link-type:jira"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Issue link types"],"summary":"Create issue link type","description":"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.\n\nTo use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createIssueLinkType","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueLinkType"},"example":{"inward":"Duplicated by","name":"Duplicate","outward":"Duplicates"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueLinkType"},"example":"{\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated by\",\"outward\":\"Duplicates\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000\"}"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  issue linking is disabled.\n *  the issue link type name is in use.\n *  the user does not have the required permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-link-type:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issueLinkType/{issueLinkTypeId}":{"get":{"tags":["Issue link types"],"summary":"Get issue link type","description":"Returns an issue link type.\n\nTo use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project in the site.","operationId":"getIssueLinkType","parameters":[{"name":"issueLinkTypeId","in":"path","description":"The ID of the issue link type.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueLinkType"},"example":"{\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated by\",\"outward\":\"Duplicates\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000\"}"}}},"400":{"description":"Returned if the issue link type ID is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  issue linking is disabled.\n *  the issue link type is not found.\n *  the user does not have the required permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-link-type:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Issue link types"],"summary":"Update issue link type","description":"Updates an issue link type.\n\nTo use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updateIssueLinkType","parameters":[{"name":"issueLinkTypeId","in":"path","description":"The ID of the issue link type.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueLinkType"},"example":{"inward":"Duplicated by","name":"Duplicate","outward":"Duplicates"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueLinkType"},"example":"{\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated by\",\"outward\":\"Duplicates\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000\"}"}}},"400":{"description":"Returned if the issue link type ID or the request body are invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  issue linking is disabled.\n *  the issue link type is not found.\n *  the user does not have the required permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-link-type:jira","write:issue-link-type:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Issue link types"],"summary":"Delete issue link type","description":"Deletes an issue link type.\n\nTo use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deleteIssueLinkType","parameters":[{"name":"issueLinkTypeId","in":"path","description":"The ID of the issue link type.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the issue link type ID is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  issue linking is disabled.\n *  the issue link type is not found.\n *  the user does not have the required permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:issue-link-type:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issues/archive/export":{"put":{"tags":["Issues"],"summary":"Export archived issue(s)","description":"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.\n\nNote that this API only exports the values of system fields and archival-specific fields (`ArchivedBy` and `ArchivedDate`). Custom fields aren't supported.\n\n**[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg)\n\n**License required:** Premium or Enterprise\n\n**Signed-in users only:** This API can't be accessed anonymously.\n\n**Rate limiting:** Only a single request can be active at any given time.\n\n  \n","operationId":"exportArchivedIssues","parameters":[],"requestBody":{"description":"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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchivedIssuesFilterRequest"},"example":{"archivedBy":["uuid-rep-001","uuid-rep-002"],"archivedDate":{"dateAfter":"2023-01-01","dateBefore":"2023-01-12"},"archivedDateRange":{"dateAfter":"2023-01-01","dateBefore":"2023-01-12"},"issueTypes":["10001","10002"],"projects":["FOO","BAR"],"reporters":["uuid-rep-001","uuid-rep-002"]}}},"required":true},"responses":{"202":{"description":"Returns the details of your export task. 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) API to view the progress of your request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportArchivedIssuesTaskProgressResponse"},"example":"{\"taskId\":\"10990\",\"payload\":\"{projects=[FOO, BAR], reporters=[uuid-rep-001, uuid-rep-002], issueTypes=[10001, 10002], archivedDate={dateAfterInstant=2023-01-01, dateBeforeInstant=2023-01-12}, archivedBy=[uuid-rep-001, uuid-rep-002]}\",\"progress\":0,\"submittedTime\":1701304931857,\"status\":\"ENQUEUED\"}"}}},"400":{"description":"Returned when:\n\n *  The request is invalid, or the filters provided are incorrect\n *  You requested too many issues for export. The limit is one million issues per request","content":{"application/json":{"example":"[\"Your filter contains invalid values {errorMessage}\"]"}}},"401":{"description":"Returned if no issues were unarchived because the provided authentication credentials are either missing or invalid.","content":{"application/json":{"example":"{\"errorMessages\":[\"User is not logged in.\"],\"errors\":{}}"}}},"403":{"description":"Returned if no issues were unarchived because the user lacks the required Jira admin or site admin permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"User is not an admin.\"],\"errors\":{}}"}}},"412":{"description":"Returned if a request to export archived issues is already running.","content":{"application/json":{"example":"{\"errorMessages\":[\"An issue archival task is already running with ID 1010. To start a new one, cancel the task or wait for it to finish.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issuesecurityschemes":{"get":{"tags":["Issue security schemes"],"summary":"Get issue security schemes","description":"Returns all [issue security schemes](https://confluence.atlassian.com/x/J4lKLg).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getIssueSecuritySchemes","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecuritySchemes"},"example":"{\"issueSecuritySchemes\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issuesecurityschemes/10000\",\"id\":10000,\"name\":\"Default Issue Security Scheme\",\"description\":\"Description for the default issue security scheme\",\"defaultSecurityLevelId\":10021}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect."},"403":{"description":"Returned if the user does not have permission to administer issue security schemes."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-security-level:jira","read:issue-security-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Issue security schemes"],"summary":"Create issue security scheme","description":"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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createIssueSecurityScheme","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIssueSecuritySchemeDetails"},"example":{"description":"Newly created issue security scheme","levels":[{"description":"Newly created level","isDefault":true,"members":[{"parameter":"administrators","type":"group"}],"name":"New level"}],"name":"New security scheme"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecuritySchemeId"},"example":"{\"id\":\"10001\"}"}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The length of the description must not exceed 4,000 characters.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuesecurityschemes/level":{"get":{"tags":["Issue security schemes"],"summary":"Get issue security levels","description":"Returns a [paginated](#pagination) list of issue security levels.\n\nOnly issue security levels in the context of classic projects are returned.\n\nFiltering 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getSecurityLevels","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"string","default":"0"}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"string","default":"50"}},{"name":"id","in":"query","description":"The list of issue security scheme level IDs. To include multiple issue security levels, separate IDs with an ampersand: `id=10000&id=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"schemeId","in":"query","description":"The list of issue security scheme IDs. To include multiple issue security schemes, separate IDs with an ampersand: `schemeId=10000&schemeId=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"onlyDefault","in":"query","description":"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.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanSecurityLevel"},"example":"{\"maxResults\":50,\"startAt\":0,\"total\":1,\"isLast\":true,\"values\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issuesecurityscheme/level?id=10021\",\"id\":\"10021\",\"description\":\"Only the reporter and internal staff can see this issue.\",\"name\":\"Reporter Only\",\"isDefault\":true,\"issueSecuritySchemeId\":\"10001\"}]}"}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"-1000 is not a valid value. id must be zero or a positive integer.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-security-level:jira","read:issue-security-scheme:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuesecurityschemes/level/default":{"put":{"tags":["Issue security schemes"],"summary":"Set default issue security levels","description":"Sets default issue security levels for schemes.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"setDefaultLevels","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetDefaultLevelsRequest"},"example":{"defaultValues":[{"defaultLevelId":"20000","issueSecuritySchemeId":"10000"},{"defaultLevelId":"30000","issueSecuritySchemeId":"12000"}]}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"some-wrong-string is not a valid value. The issue security scheme ID must be a positive integer.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue resolution isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Issue security scheme with ID 4364564 not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuesecurityschemes/level/member":{"get":{"tags":["Issue security schemes"],"summary":"Get issue security level members","description":"Returns a [paginated](#pagination) list of issue security level members.\n\nOnly issue security level members in the context of classic projects are returned.\n\nFiltering 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getSecurityLevelMembers","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"string","default":"0"}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"string","default":"50"}},{"name":"id","in":"query","description":"The list of issue security level member IDs. To include multiple issue security level members separate IDs with an ampersand: `id=10000&id=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"schemeId","in":"query","description":"The list of issue security scheme IDs. To include multiple issue security schemes separate IDs with an ampersand: `schemeId=10000&schemeId=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"levelId","in":"query","description":"The list of issue security level IDs. To include multiple issue security levels separate IDs with an ampersand: `levelId=10000&levelId=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `all` Returns all expandable information\n *  `field` Returns information about the custom field granted the permission\n *  `group` Returns information about the group that is granted the permission\n *  `projectRole` Returns information about the project role granted the permission\n *  `user` Returns information about the user who is granted the permission","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanSecurityLevelMember"},"example":"{\"maxResults\":100,\"startAt\":0,\"total\":3,\"isLast\":true,\"values\":[{\"id\":\"10000\",\"issueSecurityLevelId\":\"20010\",\"issueSecuritySchemeId\":\"10010\",\"holder\":{\"type\":\"group\",\"expand\":\"group\"}}]}"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-security-level:jira","read:issue-security-scheme:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuesecurityschemes/project":{"get":{"tags":["Issue security schemes"],"summary":"Get projects using issue security schemes","description":"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).","operationId":"searchProjectsUsingSecuritySchemes","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"string","default":"0"}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"string","default":"50"}},{"name":"issueSecuritySchemeId","in":"query","description":"The list of security scheme IDs to be filtered out.","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"projectId","in":"query","description":"The list of project IDs to be filtered out.","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanIssueSecuritySchemeToProjectMapping"},"example":"{\"issueSecuritySchemeId\":\"10000\",\"projectId\":\"10000\"}"}}},"400":{"description":"Returned if the search criteria is invalid.If you specify the project ID parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"},"put":{"tags":["Issue security schemes"],"summary":"Associate security scheme to project","description":"Associates an issue security scheme with a project and remaps security levels of issues to the new levels, if provided.\n\nThis 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"associateSchemesToProjects","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssociateSecuritySchemeWithProjectDetails"},"example":{"oldToNewSecurityLevelMappings":[{"newLevelId":"30001","oldLevelId":"30000"}],"projectId":"10000","schemeId":"20000"}}},"required":true},"responses":{"303":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskProgressBeanObject"}}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"some-wrong-string is not a valid value. The issue security scheme ID must be a positive integer.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the security scheme isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errors\":{},\"errorMessages\":[\"Issue security scheme with ID 10000 not found.\"],\"httpStatusCode\":{\"empty\":false,\"present\":true}}"}}},"409":{"description":"Returned if a task to remove the issue security level is already running.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuesecurityschemes/search":{"get":{"tags":["Issue security schemes"],"summary":"Search issue security schemes","description":"Returns a [paginated](#pagination) list of issue security schemes.  \nIf you specify the project ID parameter, the result will contain issue security schemes and related project IDs you filter by. Use \\{@link IssueSecuritySchemeResource\\#searchProjectsUsingSecuritySchemes(String, String, Set, Set)\\} to obtain all projects related to scheme.\n\nOnly issue security schemes in the context of classic projects are returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"searchSecuritySchemes","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"string","default":"0"}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"string","default":"50"}},{"name":"id","in":"query","description":"The list of issue security scheme IDs. To include multiple issue security scheme IDs, separate IDs with an ampersand: `id=10000&id=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"projectId","in":"query","description":"The list of project IDs. To include multiple project IDs, separate IDs with an ampersand: `projectId=10000&projectId=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanSecuritySchemeWithProjects"},"example":"{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/issuesecurityscheme/10000\",\"name\":\"Default scheme\",\"description\":\"Default scheme description\",\"defaultLevel\":10001,\"projectIds\":[10002]}"}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"example":"{\"errorMessages\":[\"-1000 is not a valid value. id must be zero or a positive integer.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-security-level:jira","read:issue-security-scheme:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuesecurityschemes/{id}":{"get":{"tags":["Issue security schemes"],"summary":"Get issue security scheme","description":"Returns an issue security scheme along with its security levels.\n\n**[Permissions](#permissions) required:**\n\n *  *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).\n *  *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project that uses the requested issue security scheme.","operationId":"getIssueSecurityScheme","parameters":[{"name":"id","in":"path","description":"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":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issuesecurityschemes/10000\",\"id\":10000,\"name\":\"Default Issue Security Scheme\",\"description\":\"Description for the default issue security scheme\",\"defaultSecurityLevelId\":10021,\"levels\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/securitylevel/10021\",\"id\":\"10021\",\"description\":\"Only the reporter and internal staff can see this issue.\",\"name\":\"Reporter Only\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the administrator permission and the scheme is not used in any project where the user has administrative permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-security-level:jira","read:issue-security-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"put":{"tags":["Issue security schemes"],"summary":"Update issue security scheme","description":"Updates the issue security scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updateIssueSecurityScheme","parameters":[{"name":"id","in":"path","description":"The ID of the issue security scheme.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIssueSecuritySchemeRequestBean"},"example":{"description":"My issue security scheme description","name":"My issue security scheme name"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The length of the description must not exceed 4,000 characters.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue security scheme isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Issue security scheme with ID 10000 not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuesecurityschemes/{issueSecuritySchemeId}/members":{"get":{"tags":["Issue security level"],"summary":"Get issue security level members","description":"Returns issue security level members.\n\nOnly issue security level members in context of classic projects are returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getIssueSecurityLevelMembers","parameters":[{"name":"issueSecuritySchemeId","in":"path","description":"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":true,"schema":{"type":"integer","format":"int64"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"issueSecurityLevelId","in":"query","description":"The list of issue security level IDs. To include multiple issue security levels separate IDs with ampersand: `issueSecurityLevelId=10000&issueSecurityLevelId=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `all` Returns all expandable information.\n *  `field` Returns information about the custom field granted the permission.\n *  `group` Returns information about the group that is granted the permission.\n *  `projectRole` Returns information about the project role granted the permission.\n *  `user` Returns information about the user who is granted the permission.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanIssueSecurityLevelMember"},"example":"{\"maxResults\":100,\"startAt\":0,\"total\":3,\"isLast\":true,\"values\":[{\"id\":10000,\"issueSecurityLevelId\":10020,\"holder\":{\"type\":\"user\",\"user\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"expand\":\"user\"}},{\"id\":10001,\"issueSecurityLevelId\":10020,\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"value\":\"9c559b11-6c5d-4f96-992c-a746cabab28b\",\"expand\":\"group\"}},{\"id\":10002,\"issueSecurityLevelId\":10021,\"holder\":{\"type\":\"assignee\"}}]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if no issue security level members are found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira","read:issue-security-level:jira","read:project-role:jira","read:user:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuesecurityschemes/{schemeId}":{"delete":{"tags":["Issue security schemes"],"summary":"Delete issue security scheme","description":"Deletes an issue security scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deleteSecurityScheme","parameters":[{"name":"schemeId","in":"path","description":"The ID of the issue security scheme.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"\"You can't delete an issue security scheme if any projects are associated with it.\""}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errors\":{},\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"httpStatusCode\":{\"empty\":false,\"present\":true}}"}}},"404":{"description":"Returned if the issue security scheme isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errors\":{},\"errorMessages\":[\"Issue security scheme with ID 10000 not found.\"],\"httpStatusCode\":{\"empty\":false,\"present\":true}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuesecurityschemes/{schemeId}/level":{"put":{"tags":["Issue security schemes"],"summary":"Add issue security levels","description":"Adds levels and levels' members to the issue security scheme. You can add up to 100 levels per request.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"addSecurityLevel","parameters":[{"name":"schemeId","in":"path","description":"The ID of the issue security scheme.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddSecuritySchemeLevelsRequestBean"},"example":{"levels":[{"description":"First Level Description","isDefault":true,"members":[{"type":"reporter"},{"parameter":"jira-administrators","type":"group"}],"name":"First Level"}]}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"some-wrong-string is not a valid value. The issue security scheme ID must be a positive integer.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errors\":{},\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"httpStatusCode\":{\"empty\":false,\"present\":true}}"}}},"404":{"description":"Returned if the security scheme isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errors\":{},\"errorMessages\":[\"Issue security scheme with ID 10000 not found.\"],\"httpStatusCode\":{\"empty\":false,\"present\":true}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}":{"put":{"tags":["Issue security schemes"],"summary":"Update issue security level","description":"Updates the issue security level.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updateSecurityLevel","parameters":[{"name":"schemeId","in":"path","description":"The ID of the issue security scheme level belongs to.","required":true,"schema":{"type":"string"}},{"name":"levelId","in":"path","description":"The ID of the issue security level to update.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIssueSecurityLevelDetails"},"example":{"description":"New level description","name":"New level name"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The length of the description must not exceed 4,000 characters.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue security level isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Issue security scheme with ID 10000 not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Issue security schemes"],"summary":"Remove issue security level","description":"Deletes an issue security level.\n\nThis 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"removeLevel","parameters":[{"name":"schemeId","in":"path","description":"The ID of the issue security scheme.","required":true,"schema":{"type":"string"}},{"name":"levelId","in":"path","description":"The ID of the issue security level to remove.","required":true,"schema":{"type":"string"}},{"name":"replaceWith","in":"query","description":"The ID of the issue security level that will replace the currently selected level.","schema":{"type":"string"}}],"responses":{"303":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskProgressBeanObject"}}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"\"You can't delete an issue security scheme if any projects are associated with it.\""}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errors\":{},\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"httpStatusCode\":{\"empty\":false,\"present\":true}}"}}},"404":{"description":"Returned if the issue security level isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errors\":{},\"errorMessages\":[\"Issue security scheme with ID 10000 not found.\"],\"httpStatusCode\":{\"empty\":false,\"present\":true}}"}}},"409":{"description":"Returned if a task to remove the issue security level is already running.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member":{"put":{"tags":["Issue security schemes"],"summary":"Add issue security level members","description":"Adds members to the issue security level. You can add up to 100 members per request.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"addSecurityLevelMembers","parameters":[{"name":"schemeId","in":"path","description":"The ID of the issue security scheme.","required":true,"schema":{"type":"string"}},{"name":"levelId","in":"path","description":"The ID of the issue security level.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecuritySchemeMembersRequest"},"example":{"members":[{"type":"reporter"},{"parameter":"jira-administrators","type":"group"}]}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"some-wrong-string is not a valid value. The issue security scheme ID must be a positive integer.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errors\":{},\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"httpStatusCode\":{\"empty\":false,\"present\":true}}"}}},"404":{"description":"Returned if the security scheme isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errors\":{},\"errorMessages\":[\"Issue security scheme with ID 10000 not found.\"],\"httpStatusCode\":{\"empty\":false,\"present\":true}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member/{memberId}":{"delete":{"tags":["Issue security schemes"],"summary":"Remove member from issue security level","description":"Removes an issue security level member from an issue security scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"removeMemberFromSecurityLevel","parameters":[{"name":"schemeId","in":"path","description":"The ID of the issue security scheme.","required":true,"schema":{"type":"string"}},{"name":"levelId","in":"path","description":"The ID of the issue security level.","required":true,"schema":{"type":"string"}},{"name":"memberId","in":"path","description":"The ID of the issue security level member to be removed.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errors\":{},\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"httpStatusCode\":{\"empty\":false,\"present\":true}}"}}},"404":{"description":"Returned if the security scheme isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errors\":{},\"errorMessages\":[\"Issue security scheme with ID 10000 not found.\"],\"httpStatusCode\":{\"empty\":false,\"present\":true}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetype":{"get":{"tags":["Issue types"],"summary":"Get all issue types for user","description":"Returns all issue types.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Issue types are only returned as follows:\n\n *  if the user has the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), all issue types are returned.\n *  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.","operationId":"getIssueAllTypes","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IssueTypeDetails"}},"example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1,\"hierarchyLevel\":0},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"hierarchyLevel\":0,\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\"}}}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type:jira","read:avatar:jira","read:project-category:jira","read:project:jira"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Issue types"],"summary":"Create issue type","description":"Creates an issue type and adds it to the default issue type scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createIssueType","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeCreateBean"},"example":{"description":"description","name":"name","type":"standard"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeDetails"}}}},"400":{"description":"Returned if the request is invalid because:\n\n *  no content is sent.\n *  the issue type name exceeds 60 characters.\n *  a subtask issue type is requested on an instance where subtasks are disabled."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"409":{"description":"Returned if the issue type name is in use."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-type:jira","read:avatar:jira","read:issue-type:jira","read:project-category:jira","read:project:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetype/project":{"get":{"tags":["Issue types"],"summary":"Get issue types for project","description":"Returns issue types for a project.\n\nThis operation can be accessed anonymously.\n\n**[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).","operationId":"getIssueTypesForProject","parameters":[{"name":"projectId","in":"query","description":"The ID of the project.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"level","in":"query","description":"The level of the issue type to filter by. Use:\n\n *  `-1` for Subtask.\n *  `0` for Base.\n *  `1` for Epic.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IssueTypeDetails"}},"example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"hierarchyLevel\":0,\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\"}}},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1,\"hierarchyLevel\":0,\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\"}}}]"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  the project is not found.\n *  the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type:jira","read:avatar:jira","read:project-category:jira","read:project:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issuetype/{id}":{"get":{"tags":["Issue types"],"summary":"Get issue type","description":"Returns an issue type.\n\nThis operation can be accessed anonymously.\n\n**[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).","operationId":"getIssueType","parameters":[{"name":"id","in":"path","description":"The ID of the issue type.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeDetails"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1,\"hierarchyLevel\":0}"}}},"400":{"description":"Returned if the issue type ID is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  the issue type is not found.\n *  the user does not have the required permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type:jira","read:avatar:jira","read:project-category:jira","read:project:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Issue types"],"summary":"Update issue type","description":"Updates the issue type.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updateIssueType","parameters":[{"name":"id","in":"path","description":"The ID of the issue type.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeUpdateBean"},"example":{"avatarId":1,"description":"description","name":"name"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeDetails"}}}},"400":{"description":"Returned if the request is invalid because:\n\n *  no content is sent.\n *  the issue type name exceeds 60 characters.\n *  the avatar is not associated with this issue type."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the issue type is not found."},"409":{"description":"Returned if the issue type name is in use."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-type:jira","read:avatar:jira","read:issue-type:jira","read:project-category:jira","read:project:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Issue types"],"summary":"Delete issue type","description":"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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deleteIssueType","parameters":[{"name":"id","in":"path","description":"The ID of the issue type.","required":true,"schema":{"type":"string"}},{"name":"alternativeIssueTypeId","in":"query","description":"The ID of the replacement issue type.","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if any issues cannot be updated with the alternative issue type."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if:\n\n *  the issue type is in use and an alternative issue type is not specified.\n *  the issue type or alternative issue type is not found."},"409":{"description":"Returned if the issue type is in use and:\n\n *  also specified as the alternative issue type.\n *  is a *standard* issue type and the alternative issue type is a *subtask*."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:issue-type:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetype/{id}/alternatives":{"get":{"tags":["Issue types"],"summary":"Get alternative issue types","description":"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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.","operationId":"getAlternativeIssueTypes","parameters":[{"name":"id","in":"path","description":"The ID of the issue type.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IssueTypeDetails"}},"example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1,\"hierarchyLevel\":0},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"hierarchyLevel\":0,\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\"}}}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  the issue type is not found.\n *  the user does not have the required permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type:jira","read:project-category:jira","read:project:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issuetype/{id}/avatar2":{"post":{"tags":["Issue types"],"summary":"Load issue type avatar","description":"Loads an avatar for the issue type.\n\nSpecify the avatar's local file location in the body of the request. Also, include the following headers:\n\n *  `X-Atlassian-Token: no-check` To prevent XSRF protection blocking the request, for more information see [Special Headers](#special-request-headers).\n *  `Content-Type: image/image type` Valid image types are JPEG, GIF, or PNG.\n\nFor example:  \n`curl --request POST \\ --user email@example.com:<api_token> \\ --header 'X-Atlassian-Token: no-check' \\ --header 'Content-Type: image/< image_type>' \\ --data-binary \"<@/path/to/file/with/your/avatar>\" \\ --url 'https://your-domain.atlassian.net/rest/api/3/issuetype/{issueTypeId}'This`\n\nThe 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.\n\nThe cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.\n\nAfter creating the avatar, use [ Update issue type](#api-rest-api-3-issuetype-id-put) to set it as the issue type's displayed avatar.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createIssueTypeAvatar","parameters":[{"name":"id","in":"path","description":"The ID of the issue type.","required":true,"schema":{"type":"string"}},{"name":"x","in":"query","description":"The X coordinate of the top-left corner of the crop region.","schema":{"type":"integer","format":"int32","default":0}},{"name":"y","in":"query","description":"The Y coordinate of the top-left corner of the crop region.","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"The length of each side of the crop region.","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"*/*":{"schema":{}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Avatar"},"example":"{\"id\":\"1000\",\"isSystemAvatar\":true,\"isSelected\":false,\"isDeletable\":false,\"urls\":{\"16x16\":\"/secure/useravatar?size=xsmall&avatarId=10040&avatarType=project\",\"24x24\":\"/secure/useravatar?size=small&avatarId=10040&avatarType=project\",\"32x32\":\"/secure/useravatar?size=medium&avatarId=10040&avatarType=project\",\"48x48\":\"/secure/useravatar?avatarId=10040&avatarType=project\"}}"}}},"400":{"description":"Returned if:\n\n *  an image isn't included in the request.\n *  the image type is unsupported.\n *  the crop parameters extend the crop area beyond the edge of the image.\n *  `cropSize` is missing.\n *  the issue type ID is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the issue type is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:avatar:jira","write:issue-type:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetype/{issueTypeId}/properties":{"get":{"tags":["Issue type properties"],"summary":"Get issue type property keys","description":"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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) to get the property keys of any issue type.\n *  *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.","operationId":"getIssueTypePropertyKeys","parameters":[{"name":"issueTypeId","in":"path","description":"The ID of the issue type.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyKeys"},"example":"{\"keys\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"}}},"400":{"description":"Returned if the issue type ID is invalid."},"404":{"description":"Returned if:\n\n *  the issue type is not found.\n *  the user does not have the required permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type.property:jira","read:comment.property:jira","read:dashboard.property:jira","read:issue-worklog.property:jira","read:issue.property:jira","read:project.property:jira","read:user.property:jira","read:workflow.property:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}":{"get":{"tags":["Issue type properties"],"summary":"Get issue type property","description":"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).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n *  *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) to get the details of any issue type.\n *  *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.","operationId":"getIssueTypeProperty","parameters":[{"name":"issueTypeId","in":"path","description":"The ID of the issue type.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"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":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityProperty"},"example":"{\"key\":\"issue.support\",\"value\":{\"system.conversation.id\":\"b1bf38be-5e94-4b40-a3b8-9278735ee1e6\",\"system.support.time\":\"1m\"}}"}}},"400":{"description":"Returned if the issue type ID is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the issue type or property is not found or the user does not have the required permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type.property:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Issue type properties"],"summary":"Set issue type property","description":"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.\n\nThe 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"setIssueTypeProperty","parameters":[{"name":"issueTypeId","in":"path","description":"The ID of the issue type.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the issue type property. The maximum length is 255 characters.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{},"example":{"number":5,"string":"string-value"}}},"required":true},"responses":{"200":{"description":"Returned if the issue type property is updated.","content":{"application/json":{"schema":{}}}},"201":{"description":"Returned if the issue type property is created.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if:\n\n *  the issue type ID is invalid.\n *  a property value is not provided.\n *  the property value JSON content is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to modify the issue type."},"404":{"description":"Returned if:\n\n *  the issue type is not found.\n *  the user does not have the permission view the issue type."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-type.property:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Issue type properties"],"summary":"Delete issue type property","description":"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).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deleteIssueTypeProperty","parameters":[{"name":"issueTypeId","in":"path","description":"The ID of the issue type.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"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":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the issue type property is deleted."},"400":{"description":"Returned if the issue type ID is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the issue type or property is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:issue-type.property:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetypescheme":{"get":{"tags":["Issue type schemes"],"summary":"Get all issue type schemes","description":"Returns a [paginated](#pagination) list of issue type schemes.\n\nOnly issue type schemes used in classic projects are returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getAllIssueTypeSchemes","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"id","in":"query","description":"The list of issue type schemes IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"orderBy","in":"query","description":"[Order](#ordering) the results by a field:\n\n *  `name` Sorts by issue type scheme name.\n *  `id` Sorts by issue type scheme ID.","schema":{"type":"string","default":"id","enum":["name","-name","+name","id","-id","+id"]}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `projects` For each issue type schemes, returns information about the projects the issue type scheme is assigned to.\n *  `issueTypes` For each issue type schemes, returns information about the issueTypes the issue type scheme have.","schema":{"type":"string","default":""}},{"name":"queryString","in":"query","description":"String used to perform a case-insensitive partial match with issue type scheme name.","schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanIssueTypeScheme"},"example":"{\"maxResults\":100,\"startAt\":0,\"total\":3,\"isLast\":true,\"values\":[{\"id\":\"10000\",\"name\":\"Default Issue Type Scheme\",\"description\":\"Default issue type scheme is the list of global issue types. All newly created issue types will automatically be added to this scheme.\",\"defaultIssueTypeId\":\"10003\",\"isDefault\":true},{\"id\":\"10001\",\"name\":\"SUP: Kanban Issue Type Scheme\",\"description\":\"A collection of issue types suited to use in a kanban style project.\",\"projects\":{\"maxResults\":100,\"startAt\":0,\"total\":1,\"isLast\":true,\"values\":[{\"self\":\"project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"projectTypeKey\":\"ProjectTypeKey{key='software'}\",\"simplified\":false,\"avatarUrls\":{\"48x48\":\"secure/projectavatar?size=large&pid=10000\",\"24x24\":\"secure/projectavatar?size=small&pid=10000\",\"16x16\":\"secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"id\":\"10000\",\"description\":\"Project category description\",\"name\":\"A project category\"}}]}},{\"id\":\"10002\",\"name\":\"HR: Scrum issue type scheme\",\"description\":\"\",\"defaultIssueTypeId\":\"10004\",\"issueTypes\":{\"maxResults\":100,\"startAt\":0,\"total\":1,\"isLast\":true,\"values\":[{\"id\":\"1000L\",\"description\":\"Improvement Issue Type\",\"iconUrl\":\"www.example.com\",\"name\":\"Improvements\",\"subtask\":true,\"hierarchyLevel\":-1}]}}]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Issue type schemes"],"summary":"Create issue type scheme","description":"Creates an issue type scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createIssueTypeScheme","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeSchemeDetails"},"example":{"defaultIssueTypeId":"10002","description":"A collection of issue types suited to use in a kanban style project.","issueTypeIds":["10001","10002","10003"],"name":"Kanban Issue Type Scheme"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeSchemeID"},"example":"{\"issueTypeSchemeId\":\"10010\"}"}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The default issue type ID has to be present in issue type IDs list.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access issue type schemes.\"],\"errors\":{}}"}}},"409":{"description":"Returned if the scheme name is used by another scheme.","content":{"application/json":{"example":"{\"errorMessages\":[\"The name is used by another scheme.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-type-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetypescheme/mapping":{"get":{"tags":["Issue type schemes"],"summary":"Get issue type scheme items","description":"Returns a [paginated](#pagination) list of issue type scheme items.\n\nOnly issue type scheme items used in classic projects are returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getIssueTypeSchemesMapping","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"issueTypeSchemeId","in":"query","description":"The list of issue type scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `issueTypeSchemeId=10000&issueTypeSchemeId=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanIssueTypeSchemeMapping"},"example":"{\"maxResults\":100,\"startAt\":0,\"total\":4,\"isLast\":true,\"values\":[{\"issueTypeSchemeId\":\"10000\",\"issueTypeId\":\"10000\"},{\"issueTypeSchemeId\":\"10000\",\"issueTypeId\":\"10001\"},{\"issueTypeSchemeId\":\"10000\",\"issueTypeId\":\"10002\"},{\"issueTypeSchemeId\":\"10001\",\"issueTypeId\":\"10000\"}]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetypescheme/project":{"get":{"tags":["Issue type schemes"],"summary":"Get issue type schemes for projects","description":"Returns a [paginated](#pagination) list of issue type schemes and, for each issue type scheme, a list of the projects that use it.\n\nOnly issue type schemes used in classic projects are returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getIssueTypeSchemeForProjects","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"projectId","in":"query","description":"The list of project IDs. To include multiple project IDs, provide an ampersand-separated list. For example, `projectId=10000&projectId=10001`.","required":true,"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanIssueTypeSchemeProjects"},"example":"{\"maxResults\":100,\"startAt\":0,\"total\":3,\"isLast\":true,\"values\":[{\"issueTypeScheme\":{\"id\":\"10000\",\"name\":\"Default Issue Type Scheme\",\"description\":\"Default issue type scheme is the list of global issue types. All newly created issue types will automatically be added to this scheme.\",\"defaultIssueTypeId\":\"10003\",\"isDefault\":true},\"projectIds\":[\"10000\",\"10001\"]},{\"issueTypeScheme\":{\"id\":\"10001\",\"name\":\"SUP: Kanban Issue Type Scheme\",\"description\":\"A collection of issue types suited to use in a kanban style project.\"},\"projectIds\":[\"10002\"]},{\"issueTypeScheme\":{\"id\":\"10002\",\"name\":\"HR: Scrum issue type scheme\",\"description\":\"\",\"defaultIssueTypeId\":\"10004\",\"issueTypes\":{\"maxResults\":100,\"startAt\":0,\"total\":1,\"isLast\":true,\"values\":[{\"id\":\"1000L\",\"description\":\"Improvement Issue Type\",\"iconUrl\":\"www.example.com\",\"name\":\"Improvements\",\"subtask\":true,\"hierarchyLevel\":-1}]}},\"projectIds\":[\"10003\",\"10004\",\"10005\"]}]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"put":{"tags":["Issue type schemes"],"summary":"Assign issue type scheme to project","description":"Assigns an issue type scheme to a project.\n\nIf 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.\n\nIssue type schemes can only be assigned to classic projects.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"assignIssueTypeSchemeToProject","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeSchemeProjectAssociation"},"example":{"issueTypeSchemeId":"10000","projectId":"10000"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"This issue type scheme can't be assigned to the project. This is because some issues in this project use issue types not present in the scheme. Before assigning the scheme to the project, update the issue types on these issues: 7\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access issue type schemes.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue type scheme or the project is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The issue type scheme was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-type-scheme:jira","write:project:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetypescheme/{issueTypeSchemeId}":{"put":{"tags":["Issue type schemes"],"summary":"Update issue type scheme","description":"Updates an issue type scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updateIssueTypeScheme","parameters":[{"name":"issueTypeSchemeId","in":"path","description":"The ID of the issue type scheme.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeSchemeUpdateDetails"},"example":{"defaultIssueTypeId":"10002","description":"A collection of issue types suited to use in a kanban style project.","name":"Kanban Issue Type Scheme"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The default issue type has to be one of the issue types of the scheme.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access issue type schemes.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue type scheme is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The issue type scheme was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-type-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Issue type schemes"],"summary":"Delete issue type scheme","description":"Deletes an issue type scheme.\n\nOnly issue type schemes used in classic projects can be deleted.\n\nAny projects assigned to the scheme are reassigned to the default issue type scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deleteIssueTypeScheme","parameters":[{"name":"issueTypeSchemeId","in":"path","description":"The ID of the issue type scheme.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the issue type scheme is deleted.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is to delete the default issue type scheme.","content":{"application/json":{"example":"{\"errorMessages\":[\"The default issue type scheme can't be removed.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access issue type schemes.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue type scheme is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The issue type scheme was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:issue-type-scheme:jira","write:project:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype":{"put":{"tags":["Issue type schemes"],"summary":"Add issue types to issue type scheme","description":"Adds issue types to an issue type scheme.\n\nThe added issue types are appended to the issue types list.\n\nIf any of the issue types exist in the issue type scheme, the operation fails and no issue types are added.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"addIssueTypesToIssueTypeScheme","parameters":[{"name":"issueTypeSchemeId","in":"path","description":"The ID of the issue type scheme.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeIds"},"example":{"issueTypeIds":["10000","10002","10003"]}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"These issue types were not added because they are already present in the issue type scheme: 10002, 10003\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access issue type schemes.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue type or the issue type scheme is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"These issue types were not found: 10000, 10002\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-type-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/move":{"put":{"tags":["Issue type schemes"],"summary":"Change order of issue types","description":"Changes the order of issue types in an issue type scheme.\n\nThe request body parameters must meet the following requirements:\n\n *  all of the issue types must belong to the issue type scheme.\n *  either `after` or `position` must be provided.\n *  the issue type in `after` must not be in the issue type list.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"reorderIssueTypesInIssueTypeScheme","parameters":[{"name":"issueTypeSchemeId","in":"path","description":"The ID of the issue type scheme.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderOfIssueTypes"},"example":{"after":"10008","issueTypeIds":["10001","10004","10002"]}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The issue type scheme does not include some of the specified issue types. Issue type IDs missing from the scheme are:  10007, 10008\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access issue type schemes.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue type scheme is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The issue type scheme was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-type-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/{issueTypeId}":{"delete":{"tags":["Issue type schemes"],"summary":"Remove issue type from issue type scheme","description":"Removes an issue type from an issue type scheme.\n\nThis operation cannot remove:\n\n *  any issue type used by issues.\n *  any issue types from the default issue type scheme.\n *  the last standard issue type from an issue type scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"removeIssueTypeFromIssueTypeScheme","parameters":[{"name":"issueTypeSchemeId","in":"path","description":"The ID of the issue type scheme.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"issueTypeId","in":"path","description":"The ID of the issue type.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"Can't remove the last standard issue type from the issue type scheme.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access issue type schemes.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue type scheme is missing or the issue type is not found in the issue type scheme.","content":{"application/json":{"example":"{\"errorMessages\":[\"The issue type was not found in the issue type scheme.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-type-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetypescreenscheme":{"get":{"tags":["Issue type screen schemes"],"summary":"Get issue type screen schemes","description":"Returns a [paginated](#pagination) list of issue type screen schemes.\n\nOnly issue type screen schemes used in classic projects are returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getIssueTypeScreenSchemes","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"id","in":"query","description":"The list of issue type screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"queryString","in":"query","description":"String used to perform a case-insensitive partial match with issue type screen scheme name.","schema":{"type":"string","default":""}},{"name":"orderBy","in":"query","description":"[Order](#ordering) the results by a field:\n\n *  `name` Sorts by issue type screen scheme name.\n *  `id` Sorts by issue type screen scheme ID.","schema":{"type":"string","default":"id","enum":["name","-name","+name","id","-id","+id"]}},{"name":"expand","in":"query","description":"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.","schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanIssueTypeScreenScheme"},"example":"{\"maxResults\":100,\"startAt\":0,\"total\":2,\"isLast\":true,\"values\":[{\"id\":\"1\",\"name\":\"Default Issue Type Screen Scheme\",\"description\":\"The default issue type screen scheme\"},{\"id\":\"10000\",\"name\":\"Office issue type screen scheme\",\"description\":\"Managing office projects\",\"projects\":{\"maxResults\":100,\"startAt\":0,\"total\":1,\"isLast\":true,\"values\":[{\"self\":\"project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"projectTypeKey\":\"ProjectTypeKey{key='software'}\",\"simplified\":false,\"avatarUrls\":{\"48x48\":\"secure/projectavatar?size=large&pid=10000\",\"24x24\":\"secure/projectavatar?size=small&pid=10000\",\"16x16\":\"secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"id\":\"10000\",\"description\":\"Project category description\",\"name\":\"A project category\"}}]}}]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type-screen-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Issue type screen schemes"],"summary":"Create issue type screen scheme","description":"Creates an issue type screen scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createIssueTypeScreenScheme","parameters":[],"requestBody":{"description":"An issue type screen scheme bean.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeScreenSchemeDetails"},"example":{"issueTypeMappings":[{"issueTypeId":"default","screenSchemeId":"10001"},{"issueTypeId":"10001","screenSchemeId":"10002"},{"issueTypeId":"10002","screenSchemeId":"10002"}],"name":"Scrum issue type screen scheme"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeScreenSchemeId"},"example":"{\"id\":\"10001\"}"}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"One or more issue type IDs are repeated, an issue type ID can only be specified once.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access issue type screen schemes.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue type or screen scheme is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"One or more issue type IDs were not found.\"],\"errors\":{}}"}}},"409":{"description":"Returned if the issue type is a sub-task, but sub-tasks are disabled in Jira settings.","content":{"application/json":{"example":"{\"errorMessages\":[\"Sub-tasks are disabled in Jira. At least one of the issue types is a sub-task.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-type-screen-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetypescreenscheme/mapping":{"get":{"tags":["Issue type screen schemes"],"summary":"Get issue type screen scheme items","description":"Returns a [paginated](#pagination) list of issue type screen scheme items.\n\nOnly issue type screen schemes used in classic projects are returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getIssueTypeScreenSchemeMappings","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"issueTypeScreenSchemeId","in":"query","description":"The list of issue type screen scheme IDs. To include multiple issue type screen schemes, separate IDs with ampersand: `issueTypeScreenSchemeId=10000&issueTypeScreenSchemeId=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanIssueTypeScreenSchemeItem"},"example":"{\"maxResults\":100,\"startAt\":0,\"total\":4,\"isLast\":true,\"values\":[{\"issueTypeScreenSchemeId\":\"10020\",\"issueTypeId\":\"10000\",\"screenSchemeId\":\"10010\"},{\"issueTypeScreenSchemeId\":\"10021\",\"issueTypeId\":\"10001\",\"screenSchemeId\":\"10010\"},{\"issueTypeScreenSchemeId\":\"10022\",\"issueTypeId\":\"10002\",\"screenSchemeId\":\"10010\"},{\"issueTypeScreenSchemeId\":\"10023\",\"issueTypeId\":\"default\",\"screenSchemeId\":\"10011\"}]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type-screen-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetypescreenscheme/project":{"get":{"tags":["Issue type screen schemes"],"summary":"Get issue type screen schemes for projects","description":"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.\n\nOnly issue type screen schemes used in classic projects are returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getIssueTypeScreenSchemeProjectAssociations","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"projectId","in":"query","description":"The list of project IDs. To include multiple projects, separate IDs with ampersand: `projectId=10000&projectId=10001`.","required":true,"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanIssueTypeScreenSchemesProjects"},"example":"{\"maxResults\":100,\"startAt\":0,\"total\":1,\"isLast\":true,\"values\":[{\"issueTypeScreenScheme\":{\"id\":\"1\",\"name\":\"Default Issue Type Screen Scheme\",\"description\":\"The default issue type screen scheme\"},\"projectIds\":[\"10000\",\"10001\"]}]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type-screen-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"put":{"tags":["Issue type screen schemes"],"summary":"Assign issue type screen scheme to project","description":"Assigns an issue type screen scheme to a project.\n\nIssue type screen schemes can only be assigned to classic projects.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"assignIssueTypeScreenSchemeToProject","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeScreenSchemeProjectAssociation"},"example":{"issueTypeScreenSchemeId":"10001","projectId":"10002"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if:\n\n *  project is not found.\n *  issue type screen scheme is not found.\n *  the project is not a classic project.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only classic projects can have issue type screen schemes assigned.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access issue type screen schemes.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue type screen scheme or the project are missing.","content":{"application/json":{"example":"{\"errorMessages\":[\"The issue type screen scheme was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-type-screen-scheme:jira","write:project:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}":{"put":{"tags":["Issue type screen schemes"],"summary":"Update issue type screen scheme","description":"Updates an issue type screen scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updateIssueTypeScreenScheme","parameters":[{"name":"issueTypeScreenSchemeId","in":"path","description":"The ID of the issue type screen scheme.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The issue type screen scheme update details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeScreenSchemeUpdateDetails"},"example":{"description":"Screens for scrum issue types.","name":"Scrum scheme"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The issue type screen scheme name is in use.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access issue type screen schemes.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue type screen scheme is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The issue type screen scheme was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-type-screen-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Issue type screen schemes"],"summary":"Delete issue type screen scheme","description":"Deletes an issue type screen scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deleteIssueTypeScreenScheme","parameters":[{"name":"issueTypeScreenSchemeId","in":"path","description":"The ID of the issue type screen scheme.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the issue type screen scheme is deleted.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The issue type screen scheme cannot be deleted because it is assigned to one or more projects.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions."},"404":{"description":"Returned if the issue type screen scheme is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The issue type screen scheme was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:issue-type-screen-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping":{"put":{"tags":["Issue type screen schemes"],"summary":"Append mappings to issue type screen scheme","description":"Appends issue type to screen scheme mappings to an issue type screen scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"appendMappingsForIssueTypeScreenScheme","parameters":[{"name":"issueTypeScreenSchemeId","in":"path","description":"The ID of the issue type screen scheme.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeScreenSchemeMappingDetails"},"example":{"issueTypeMappings":[{"issueTypeId":"10000","screenSchemeId":"10001"},{"issueTypeId":"10001","screenSchemeId":"10002"},{"issueTypeId":"10002","screenSchemeId":"10002"}]}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"A default mapping cannot be added.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions."},"404":{"description":"Returned if the issue type screen scheme, issue type, or screen scheme is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The issue type screen scheme was not found.\"],\"errors\":{}}"}}},"409":{"description":"Returned if the issue type is a sub-task, but sub-tasks are disabled in Jira settings.","content":{"application/json":{"example":"{\"errorMessages\":[\"Sub-tasks are disabled in Jira. At least one of the issue types is a sub-task.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-type-screen-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/default":{"put":{"tags":["Issue type screen schemes"],"summary":"Update issue type screen scheme default screen scheme","description":"Updates the default screen scheme of an issue type screen scheme. The default screen scheme is used for all unmapped issue types.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updateDefaultScreenScheme","parameters":[{"name":"issueTypeScreenSchemeId","in":"path","description":"The ID of the issue type screen scheme.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDefaultScreenScheme"},"example":{"screenSchemeId":"10010"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The screenSchemeId has to be provided.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access issue type screen schemes.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue type screen scheme or the screen screen is not found, or the screen scheme isn't used in classic projects.","content":{"application/json":{"example":"{\"errorMessages\":[\"The issue type screen scheme was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-type-screen-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/remove":{"post":{"tags":["Issue type screen schemes"],"summary":"Remove mappings from issue type screen scheme","description":"Removes issue type to screen scheme mappings from an issue type screen scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"removeMappingsFromIssueTypeScreenScheme","parameters":[{"name":"issueTypeScreenSchemeId","in":"path","description":"The ID of the issue type screen scheme.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeIds"},"example":{"issueTypeIds":["10000","10001","10004"]}}},"required":true},"responses":{"204":{"description":"Returned if the screen scheme mappings are removed from the issue type screen scheme.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The issueTypeIds must not contain duplicates.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access issue type screen schemes.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue type screen scheme or one or more issue type mappings are not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The issue type screen scheme was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:issue-type-screen-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/project":{"get":{"tags":["Issue type screen schemes"],"summary":"Get issue type screen scheme projects","description":"Returns a [paginated](#pagination) list of projects associated with an issue type screen scheme.\n\nOnly company-managed projects associated with an issue type screen scheme are returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getProjectsForIssueTypeScreenScheme","parameters":[{"name":"issueTypeScreenSchemeId","in":"path","description":"The ID of the issue type screen scheme.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"query","in":"query","schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanProjectDetails"},"example":"{\"maxResults\":100,\"startAt\":0,\"total\":1,\"isLast\":true,\"values\":[{\"self\":\"project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"projectTypeKey\":\"ProjectTypeKey{key='software'}\",\"simplified\":false,\"avatarUrls\":{\"48x48\":\"secure/projectavatar?size=large&pid=10000\",\"24x24\":\"secure/projectavatar?size=small&pid=10000\",\"16x16\":\"secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"id\":\"10000\",\"description\":\"Project category description\",\"name\":\"A project category\"}}]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project:jira","read:avatar:jira","read:project-category:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/jql/autocompletedata":{"get":{"tags":["JQL"],"summary":"Get field reference data (GET)","description":"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.\n\nTo 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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.","operationId":"getAutoComplete","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JQLReferenceData"},"example":"{\"visibleFieldNames\":[{\"value\":\"summary\",\"displayName\":\"summary\",\"orderable\":\"true\",\"searchable\":\"true\",\"operators\":[\"~\",\"!~\",\"is\",\"is not\"],\"types\":[\"java.lang.String\"]},{\"value\":\"Sprint\",\"displayName\":\"Sprint - cf[10880]\",\"orderable\":\"true\",\"searchable\":\"true\",\"auto\":\"true\",\"cfid\":\"cf[10880]\",\"operators\":[\"=\",\"!=\",\"in\",\"not in\",\"is\",\"is not\"],\"types\":[\"com.atlassian.greenhopper.service.sprint.Sprint\"]}],\"visibleFunctionNames\":[{\"value\":\"standardIssueTypes()\",\"displayName\":\"standardIssueTypes()\",\"isList\":\"true\",\"types\":[\"com.atlassian.jira.issue.issuetype.IssueType\"]},{\"value\":\"issuesWithText()\",\"displayName\":\"issuesWithText()\",\"supportsListAndSingleValueOperators\":\"true\",\"types\":[\"com.atlassian.jira.issue.issuetype.IssueType\"]}],\"jqlReservedWords\":[\"empty\",\"and\",\"or\",\"in\",\"distinct\"]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["JQL"],"summary":"Get field reference data (POST)","description":"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.\n\nThis operation can filter the custom fields returned by project. Invalid project IDs in `projectIds` are ignored. System fields are always returned.\n\nIt 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.\n\n**[Permissions](#permissions) required:** None.","operationId":"getAutoCompletePost","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchAutoCompleteFilter"},"example":{"includeCollapsedFields":true,"projectIds":[10000,10001,10002]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JQLReferenceData"},"example":"{\"visibleFieldNames\":[{\"value\":\"summary\",\"displayName\":\"summary\",\"orderable\":\"true\",\"searchable\":\"true\",\"operators\":[\"~\",\"!~\",\"is\",\"is not\"],\"types\":[\"java.lang.String\"]},{\"value\":\"cf[10061]\",\"displayName\":\"Component - cf[10061]\",\"orderable\":\"true\",\"auto\":\"true\",\"cfid\":\"cf[10061]\",\"operators\":[\"=\",\"!=\",\"in\",\"not in\",\"is\",\"is not\"],\"types\":[\"com.atlassian.jira.issue.customfields.option.Option\"]},{\"value\":\"cf[10062]\",\"displayName\":\"Component - cf[10062]\",\"orderable\":\"true\",\"auto\":\"true\",\"cfid\":\"cf[10062]\",\"operators\":[\"=\",\"!=\",\"in\",\"not in\",\"is\",\"is not\"],\"types\":[\"com.atlassian.jira.issue.customfields.option.Option\"]},{\"value\":\"\\\"Component[Dropdown]\\\"\",\"displayName\":\"Component - Component[Dropdown]\",\"searchable\":\"true\",\"auto\":\"true\",\"operators\":[\"=\",\"!=\",\"in\",\"not in\",\"is\",\"is not\"],\"types\":[\"com.atlassian.jira.issue.customfields.option.Option\"]}],\"visibleFunctionNames\":[{\"value\":\"standardIssueTypes()\",\"displayName\":\"standardIssueTypes()\",\"isList\":\"true\",\"types\":[\"com.atlassian.jira.issue.issuetype.IssueType\"]}],\"jqlReservedWords\":[\"empty\",\"and\",\"or\",\"in\",\"distinct\"]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/jql/autocompletedata/suggestions":{"get":{"tags":["JQL"],"summary":"Get field auto complete suggestions","description":"Returns the JQL search auto complete suggestions for a field.\n\nSuggestions can be obtained by providing:\n\n *  `fieldName` to get a list of all values for the field.\n *  `fieldName` and `fieldValue` to get a list of values containing the text in `fieldValue`.\n *  `fieldName` and `predicateName` to get a list of all predicate values for the field.\n *  `fieldName`, `predicateName`, and `predicateValue` to get a list of predicate values containing the text in `predicateValue`.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.","operationId":"getFieldAutoCompleteForQueryString","parameters":[{"name":"fieldName","in":"query","description":"The name of the field.","schema":{"type":"string","example":"reporter"},"x-showInExample":"true"},{"name":"fieldValue","in":"query","description":"The partial field item name entered by the user.","schema":{"type":"string"}},{"name":"predicateName","in":"query","description":"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*.","schema":{"type":"string"}},{"name":"predicateValue","in":"query","description":"The partial predicate item name entered by the user.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoCompleteSuggestions"},"example":"{\"results\":[{\"value\":\"ActiveObjects\",\"displayName\":\"<b>Ac</b>tiveObjects (AO)\"},{\"value\":\"Atlassian Connect\",\"displayName\":\"Atlassian Connect (<b>AC</b>)\"},{\"value\":\"Atlassian Connect in Jira\",\"displayName\":\"Atlassian Connect in Jira (<b>AC</b>JIRA)\"}]}"}}},"400":{"description":"Returned if an invalid combination of parameters is passed."},"401":{"description":"Returned if the authentication credentials are incorrect."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-details:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/jql/function/computation":{"get":{"tags":["JQL functions (apps)"],"summary":"Get precomputations (apps)","description":"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.\n\n**[Permissions](#permissions) required:** This API is only accessible to apps and apps can only inspect their own functions.","operationId":"getPrecomputations","parameters":[{"name":"functionKey","in":"query","description":"The function key in format:\n\n *  Forge: `ari:cloud:ecosystem::extension/[App ID]/[Environment ID]/static/[Function key from manifest]`\n *  Connect: `[App key]__[Module key]`","schema":{"type":"array","items":{"type":"string"}}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":100}},{"name":"orderBy","in":"query","description":"[Order](#ordering) the results by a field:\n\n *  `functionKey` Sorts by the functionKey.\n *  `used` Sorts by the used timestamp.\n *  `created` Sorts by the created timestamp.\n *  `updated` Sorts by the updated timestamp.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanJqlFunctionPrecomputationBean"},"example":"{\"maxResults\":100,\"startAt\":0,\"total\":1,\"isLast\":true,\"values\":[{\"id\":\"cf75a1b0-4ac6-4bd8-8a50-29a465a96520\",\"value\":\"issue in (TEST-1, TEST-2, TEST-3)\",\"functionKey\":\"ari:cloud:ecosystem::extension/00000000-1111-2222-3333-4444444/111111-2222-3333-4444-55555/static/issuesWithText\",\"field\":\"issue\",\"operator\":\"in\",\"functionName\":\"issuesWithText\",\"arguments\":[\"Test\"],\"created\":\"2023-11-30T00:42:17.416+0000\",\"updated\":\"2023-11-30T00:42:17.416+0000\",\"used\":\"2023-11-30T00:42:17.416+0000\"},{\"id\":\"2a854f11-d0e1-4260-aea8-64a562a7062a\",\"error\":\"Error message to be displayed to the user\",\"functionKey\":\"ari:cloud:ecosystem::extension/00000000-1111-2222-3333-4444444/111111-2222-3333-4444-55555/static/issuesWithText\",\"field\":\"issue\",\"operator\":\"=\",\"functionName\":\"issuesWithText\",\"arguments\":[\"10001\"],\"created\":\"2023-11-30T00:42:17.416+0000\",\"updated\":\"2023-11-30T00:42:17.416+0000\",\"used\":\"2023-11-30T00:42:17.416+0000\"}]}"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the request is not authenticated as the app that provided the function."},"404":{"description":"Returned if the function is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":[]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":[]},{"state":"Beta","scheme":"OAuth2","scopes":[]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"},"post":{"tags":["JQL functions (apps)"],"summary":"Update precomputations (apps)","description":"Update the precomputation value of a function created by a Forge/Connect app.\n\n**[Permissions](#permissions) required:** An API for apps to update their own precomputations.","operationId":"updatePrecomputations","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JqlFunctionPrecomputationUpdateRequestBean"},"example":{"values":[{"id":"f2ef228b-367f-4c6b-bd9d-0d0e96b5bd7b","value":"issue in (TEST-1, TEST-2, TEST-3)"},{"error":"Error message to be displayed to the user","id":"2a854f11-d0e1-4260-aea8-64a562a7062a"}]}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid."},"403":{"description":"Returned if the request is not authenticated as the app that provided the function."},"404":{"description":"Returned if the function is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":[]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":[]},{"state":"Beta","scheme":"OAuth2","scopes":[]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/jql/match":{"post":{"tags":["Issue search"],"summary":"Check issues against JQL","description":"Checks whether one or more issues would be returned by one or more JQL queries.\n\n**[Permissions](#permissions) required:** None, however, issues are only matched against JQL queries where the user has:\n\n *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.","operationId":"matchIssues","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuesAndJQLQueries"},"example":{"issueIds":[10001,1000,10042],"jqls":["project = FOO","issuetype = Bug","summary ~ \"some text\" AND project in (FOO, BAR)"]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueMatches"},"example":"{\"matches\":[{\"matchedIssues\":[10000,10004],\"errors\":[]},{\"matchedIssues\":[100134,10025,10236],\"errors\":[]},{\"matchedIssues\":[],\"errors\":[]},{\"matchedIssues\":[],\"errors\":[\"Invalid JQL: broken = value\"]}]}"}}},"400":{"description":"Returned if `jqls` exceeds the maximum number of JQL queries or `issueIds` exceeds the maximum number of issue IDs."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-details:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/jql/parse":{"post":{"tags":["JQL"],"summary":"Parse JQL query","description":"Parses and validates JQL queries.\n\nValidation is performed in context of the current user.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.","operationId":"parseJqlQueries","parameters":[{"name":"validation","in":"query","description":"How to validate the JQL query and treat the validation results. Validation options include:\n\n *  `strict` Returns all errors. If validation fails, the query structure is not returned.\n *  `warn` Returns all errors. If validation fails but the JQL query is correctly formed, the query structure is returned.\n *  `none` No validation is performed. If JQL query is correctly formed, the query structure is returned.","schema":{"type":"string","default":"strict","enum":["strict","warn","none"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JqlQueriesToParse"},"example":{"queries":["summary ~ test AND (labels in (urgent, blocker) OR lastCommentedBy = currentUser()) AND status CHANGED AFTER startOfMonth(-1M) ORDER BY updated DESC","issue.property[\"spaces here\"].value in (\"Service requests\", Incidents)","invalid query","summary = test","summary in test","project = INVALID","universe = 42"]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParsedJqlQueries"},"example":"{\"queries\":[{\"query\":\"summary ~ test AND (labels in (urgent, blocker) OR lastCommentedBy = currentUser()) AND status CHANGED AFTER -5d ORDER BY updated DESC\",\"structure\":{\"where\":{\"clauses\":[{\"field\":{\"name\":\"summary\",\"encodedName\":\"summary\"},\"operator\":\"~\",\"operand\":{\"value\":\"test\",\"encodedValue\":\"test\"}},{\"clauses\":[{\"field\":{\"name\":\"labels\",\"encodedName\":\"labels\"},\"operator\":\"in\",\"operand\":{\"values\":[{\"value\":\"urgent\",\"encodedValue\":\"urgent\"},{\"value\":\"blocker\",\"encodedValue\":\"blocker\"}],\"encodedOperand\":\"urgent, blocker)\"}},{\"field\":{\"name\":\"lastCommentedBy\",\"encodedName\":\"lastCommentedBy\",\"property\":[{\"entity\":\"issue\",\"key\":\"propertyKey\",\"path\":\"path.in.property\",\"type\":\"user\"}]},\"operator\":\"=\",\"operand\":{\"function\":\"currentUser\",\"arguments\":[],\"encodedOperand\":\"currentUser()\"}}],\"operator\":\"or\"},{\"field\":{\"name\":\"status\",\"encodedName\":\"status\"},\"operator\":\"changed\",\"predicates\":[{\"operator\":\"after\",\"operand\":{\"function\":\"startOfMonth\",\"arguments\":[\"-1M\"],\"encodedOperand\":\"startOfMonth(-1M)\"}}]}],\"operator\":\"and\"},\"orderBy\":{\"fields\":[{\"field\":{\"name\":\"updated\",\"encodedName\":\"updated\"},\"direction\":\"desc\"}]}}},{\"query\":\"issue.property[\\\"spaces here\\\"].value in (\\\"Service requests\\\", Incidents)\",\"structure\":{\"where\":{\"field\":{\"name\":\"issue.property[spaces here].value\",\"encodedName\":\"issue.property[\\\"spaces here\\\"].value\",\"property\":[{\"entity\":\"issue\",\"key\":\"spaces here\",\"path\":\"value\"}]},\"operator\":\"in\",\"operand\":{\"values\":[{\"value\":\"Service requests\",\"encodedValue\":\"\\\"Service requests\\\"\"},{\"value\":\"Incidents\",\"encodedValue\":\"Incidents\"}],\"encodedOperand\":\"(\\\"Service requests\\\", Incidents)\"}}}},{\"query\":\"invalid query\",\"errors\":[\"Error in the JQL Query: Expecting operator but got 'query'. The valid operators are '=', '!=', '<', '>', '<=', '>=', '~', '!~', 'IN', 'NOT IN', 'IS' and 'IS NOT'. (line 1, character 9)\"]},{\"query\":\"summary = test\",\"errors\":[\"The operator '=' is not supported by the 'summary' field.\"]},{\"query\":\"summary in test\",\"errors\":[\"Operator 'in' does not support the non-list value '\\\"test\\\"' for field 'summary'.\"]},{\"query\":\"project = INVALID\",\"errors\":[\"The value 'INVALID' does not exist for the field 'project'.\"]},{\"query\":\"universe = 42\",\"errors\":[\"Field 'universe' does not exist or you do not have permission to view it.\"]}]}"}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira","validate:jql:jira","read:jql:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/jql/pdcleaner":{"post":{"tags":["JQL"],"summary":"Convert user identifiers to account IDs in JQL queries","description":"Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.\n\nYou 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/).\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"migrateQueries","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JQLPersonalDataMigrationRequest"},"example":{"queryStrings":["assignee = mia","issuetype = Bug AND assignee in (mia) AND reporter in (alana) order by lastViewed DESC"]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful. Note that the JQL queries are returned in the same order that they were passed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertedJQLQueries"},"example":"{\"queryStrings\":[\"issuetype = Bug AND assignee in (abcde-12345) AND reporter in (abc551-c4e99) order by lastViewed DESC\"],\"queriesWithUnknownUsers\":[{\"originalQuery\":\"assignee = mia\",\"convertedQuery\":\"assignee = unknown\"}]}"}}},"400":{"description":"Returned if at least one of the queries cannot be converted. For example, the JQL has invalid operators or invalid keywords, or the users in the query cannot be found."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-user"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-user"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:user:jira","read:jql:jira","validate:jql:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/jql/sanitize":{"post":{"tags":["JQL"],"summary":"Sanitize JQL queries","description":"Sanitizes one or more JQL queries by converting readable details into IDs where a user doesn't have permission to view the entity.\n\nFor 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.\n\nNote 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).\n\nBefore sanitization each JQL query is parsed. The queries are returned in the same order that they were passed.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"sanitiseJqlQueries","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JqlQueriesToSanitize"},"example":{"queries":[{"query":"project = 'Sample project'"},{"accountId":"5b10ac8d82e05b22cc7d4ef5","query":"project = 'Sample project'"},{"accountId":"cda2aa1395ac195d951b3387","query":"project = 'Sample project'"},{"accountId":"5b10ac8d82e05b22cc7d4ef5","query":"invalid query"}]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SanitizedJqlQueries"},"example":"{\"queries\":[{\"initialQuery\":\"project = 'Sample project'\",\"sanitizedQuery\":\"project = 12345\"},{\"initialQuery\":\"project = 'Sample project'\",\"sanitizedQuery\":\"project = 'Sample project'\",\"accountId\":\"5b10ac8d82e05b22cc7d4ef5\"},{\"initialQuery\":\"project = 'Sample project'\",\"sanitizedQuery\":\"project = 12345\",\"accountId\":\"cda2aa1395ac195d951b3387\"},{\"initialQuery\":\"non-parsable query\",\"errors\":{\"errorMessages\":[\"Error in the JQL Query: Expecting operator but got 'query'. The valid operators are '=', '!=', '<', '>', '<=', '>=', '~', '!~', 'IN', 'NOT IN', 'IS' and 'IS NOT'. (line 1, character 9)\"],\"errors\":{}},\"accountId\":\"5b10ac8d82e05b22cc7d4ef5\"}]}"}}},"400":{"description":"Returned if the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The queries has to be provided.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:jql:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/label":{"get":{"tags":["Labels"],"summary":"Get all labels","description":"Returns a [paginated](#pagination) list of labels.","operationId":"getAllLabels","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":1000}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanString"},"example":"{\"maxResults\":2,\"startAt\":0,\"total\":100,\"isLast\":false,\"values\":[\"performance\",\"security\"]}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:label:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/license/approximateLicenseCount":{"get":{"tags":["License metrics"],"summary":"Get approximate license count","description":"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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getApproximateLicenseCount","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseMetric"},"example":"{\"key\":\"license.totalApproximateUserCount\",\"value\":\"1000\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to complete this request.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access license details.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:license:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/license/approximateLicenseCount/product/{applicationKey}":{"get":{"tags":["License metrics"],"summary":"Get approximate application license count","description":"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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getApproximateApplicationLicenseCount","parameters":[{"name":"applicationKey","in":"path","description":"The ID of the application, represents a specific version of Jira.","required":true,"schema":{"type":"string","enum":["jira-core","jira-product-discovery","jira-software","jira-servicedesk"]}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseMetric"},"example":"{\"key\":\"license.jira-software.approximateUserCount\",\"value\":\"115\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to complete this request.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access license details.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:license:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/mypermissions":{"get":{"tags":["Permissions"],"summary":"Get my permissions","description":"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.\n\nThe user is reported as having a project permission:\n\n *  in the global context, if the user has the project permission in any project.\n *  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.\n *  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.\n *  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.\n\nThis 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.\n\nGlobal permissions are unaffected by context.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.","operationId":"getMyPermissions","parameters":[{"name":"projectKey","in":"query","description":"The key of project. Ignored if `projectId` is provided.","schema":{"type":"string"}},{"name":"projectId","in":"query","description":"The ID of project.","schema":{"type":"string"}},{"name":"issueKey","in":"query","description":"The key of the issue. Ignored if `issueId` is provided.","schema":{"type":"string"}},{"name":"issueId","in":"query","description":"The ID of the issue.","schema":{"type":"string"}},{"name":"permissions","in":"query","description":"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).","schema":{"type":"string","example":"BROWSE_PROJECTS,EDIT_ISSUES"},"x-changes":[{"announced":"2018-08-01","details":"https://developer.atlassian.com/cloud/jira/platform/change-notice-get-my-permissions-requires-permissions-query-parameter/","effective":"2019-02-01","type":"required"}],"x-showInExample":"true"},{"name":"projectUuid","in":"query","schema":{"type":"string"}},{"name":"projectConfigurationUuid","in":"query","schema":{"type":"string"}},{"name":"commentId","in":"query","description":"The ID of the comment.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permissions"},"example":"{\"permissions\":{\"EDIT_ISSUES\":{\"id\":\"12\",\"key\":\"EDIT_ISSUES\",\"name\":\"Edit Issues\",\"type\":\"PROJECT\",\"description\":\"Ability to edit issues.\",\"havePermission\":true}}}"}}},"400":{"description":"Returned if `permissions` is empty, contains an invalid key, or does not equal BROWSE\\_PROJECTS when commentId is provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"404":{"description":"Returned if the project or issue is not found or the user does not have permission to view the project or issue.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":[]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":[]},{"state":"Beta","scheme":"OAuth2","scopes":["read:permission:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/mypreferences":{"get":{"tags":["Myself"],"summary":"Get preference","description":"Returns the value of a preference of the current user.\n\nNote that these keys are deprecated:\n\n *  *jira.user.locale* The locale of the user. By default this is not set and the user takes the locale of the instance.\n *  *jira.user.timezone* The time zone of the user. By default this is not set and the user takes the timezone of the instance.\n\nUse [ 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.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getPreference","parameters":[{"name":"key","in":"query","description":"The key of the preference.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the key is not provided or not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:user-configuration:jira"]}],"x-atlassian-connect-scope":"ACT_AS_USER"},"put":{"tags":["Myself"],"summary":"Set preference","description":"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:\n\n *  *user.notifications.mimetype* The mime type used in notifications sent to the user. Defaults to `html`.\n *  *user.notify.own.changes* Whether the user gets notified of their own changes. Defaults to `false`.\n *  *user.default.share.private* Whether new [ filters](https://confluence.atlassian.com/x/eQiiLQ) are set to private. Defaults to `true`.\n *  *user.keyboard.shortcuts.disabled* Whether keyboard shortcuts are disabled. Defaults to `false`.\n *  *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.\n\nNote that these keys are deprecated:\n\n *  *jira.user.locale* The locale of the user. By default, not set. The user takes the instance locale.\n *  *jira.user.timezone* The time zone of the user. By default, not set. The user takes the instance timezone.\n\nUse [ 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.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"setPreference","parameters":[{"name":"key","in":"query","description":"The key of the preference. The maximum length is 255 characters.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The value of the preference as a plain text string. The maximum length is 255 characters.","content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the key or value is not provided or invalid."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:user-configuration:jira"]}],"x-atlassian-connect-scope":"ACT_AS_USER"},"delete":{"tags":["Myself"],"summary":"Delete preference","description":"Deletes a preference of the user, which restores the default value of system defined settings.\n\nNote that these keys are deprecated:\n\n *  *jira.user.locale* The locale of the user. By default, not set. The user takes the instance locale.\n *  *jira.user.timezone* The time zone of the user. By default, not set. The user takes the instance timezone.\n\nUse [ 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.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"removePreference","parameters":[{"name":"key","in":"query","description":"The key of the preference.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the key is not provided or not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:user-configuration:jira"]}],"x-atlassian-connect-scope":"ACT_AS_USER"}},"/rest/api/3/mypreferences/locale":{"get":{"tags":["Myself"],"summary":"Get locale","description":"Returns the locale for the user.\n\nIf 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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.","operationId":"getLocale","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Locale"},"example":"{\"locale\":\"en_US\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:user-configuration:jira"]}],"x-atlassian-connect-scope":"ACT_AS_USER"},"put":{"tags":["Myself"],"summary":"Set locale","description":"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.\n\nSets the locale of the user. The locale must be one supported by the instance of Jira.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"setLocale","parameters":[],"requestBody":{"description":"The locale defined in a LocaleBean.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Locale"},"example":{"locale":"en_US"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":true,"security":[{"basicAuth":[]}],"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["Myself"],"summary":"Delete locale","description":"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.\n\nDeletes the locale of the user, which restores the default setting.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"deleteLocale","parameters":[],"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":true,"security":[{"basicAuth":[]}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/myself":{"get":{"tags":["Myself"],"summary":"Get current user","description":"Returns details for the current user.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getCurrentUser","parameters":[{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information about user in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `groups` Returns all groups, including nested groups, the user belongs to.\n *  `applicationRoles` Returns the application roles the user is assigned to.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-user"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-user"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:application-role:jira","read:group:jira","read:user:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/notificationscheme":{"get":{"tags":["Issue notification schemes"],"summary":"Get notification schemes paginated","description":"Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) ordered by the display name.\n\n*Note that you should allow for events without recipients to appear in responses.*\n\n**[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.","operationId":"getNotificationSchemes","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"string","default":"0"}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"string","default":"50"}},{"name":"id","in":"query","description":"The list of notification schemes IDs to be filtered by","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"projectId","in":"query","description":"The list of projects IDs to be filtered by","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"onlyDefault","in":"query","description":"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.","schema":{"type":"boolean","default":false}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `all` Returns all expandable information\n *  `field` Returns information about any custom fields assigned to receive an event\n *  `group` Returns information about any groups assigned to receive an event\n *  `notificationSchemeEvents` Returns a list of event associations. This list is returned for all expandable information\n *  `projectRole` Returns information about any project roles assigned to receive an event\n *  `user` Returns information about any users assigned to receive an event","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful. Only returns notification schemes that the user has permission to access. An empty list is returned if the user lacks permission to access all notification schemes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanNotificationScheme"},"example":"{\"maxResults\":6,\"startAt\":1,\"total\":5,\"isLast\":false,\"values\":[{\"expand\":\"notificationSchemeEvents,user,group,projectRole,field,all\",\"id\":10100,\"self\":\"https://your-domain.atlassian.net/rest/api/3/notificationscheme\",\"name\":\"notification scheme name\",\"description\":\"description\",\"notificationSchemeEvents\":[{\"event\":{\"id\":1,\"name\":\"Issue created\",\"description\":\"Event published when an issue is created\"},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"recipient\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"group\":{\"name\":\"jira-administrators\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"recipient\":\"10360\",\"projectRole\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"rest-developer@atlassian.com\",\"recipient\":\"rest-developer@atlassian.com\",\"emailAddress\":\"rest-developer@atlassian.com\"},{\"id\":5,\"notificationType\":\"User\",\"parameter\":\"5b10a2844c20165700ede21g\",\"recipient\":\"5b10a2844c20165700ede21g\",\"user\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"recipient\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"New custom field\",\"untranslatedName\":\"New custom field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New custom field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]},{\"event\":{\"id\":20,\"name\":\"Custom event\",\"description\":\"Custom event that is published together with an issue created event\",\"templateEvent\":{\"id\":1,\"name\":\"Issue created\",\"description\":\"Event published when an issue is created\"}},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"recipient\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"group\":{\"name\":\"jira-administrators\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"recipient\":\"10360\",\"projectRole\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"rest-developer@atlassian.com\",\"recipient\":\"rest-developer@atlassian.com\",\"emailAddress\":\"rest-developer@atlassian.com\"},{\"id\":5,\"notificationType\":\"User\",\"parameter\":\"5b10a2844c20165700ede21g\",\"recipient\":\"5b10a2844c20165700ede21g\",\"user\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"recipient\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"New custom field\",\"untranslatedName\":\"New custom field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New custom field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]}],\"projects\":[10001,10002]}]}"}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"%20. is not a valid value. id must be zero or a positive integer.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira","read:notification-scheme:jira","read:project:jira","read:project-role:jira","read:user:jira","read:avatar:jira","read:group:jira","read:project-category:jira","read:field-configuration:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Issue notification schemes"],"summary":"Create notification scheme","description":"Creates a notification scheme with notifications. You can create up to 1000 notifications per request.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createNotificationScheme","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNotificationSchemeDetails"},"example":{"description":"My new scheme description","name":"My new notification scheme","notificationSchemeEvents":[{"event":{"id":"1"},"notifications":[{"notificationType":"Group","parameter":"jira-administrators"}]}]}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationSchemeId"},"example":"{\"id\":\"10001\"}"}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The length of the description must not exceed 4000 characters.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/notificationscheme/project":{"get":{"tags":["Issue notification schemes"],"summary":"Get projects using notification schemes paginated","description":"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.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getNotificationSchemeToProjectMappings","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"string","default":"0"}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"string","default":"50"}},{"name":"notificationSchemeId","in":"query","description":"The list of notifications scheme IDs to be filtered out","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"projectId","in":"query","description":"The list of project IDs to be filtered out","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanNotificationSchemeAndProjectMappingJsonBean"},"example":"{\"maxResults\":50,\"startAt\":0,\"total\":4,\"isLast\":true,\"values\":[{\"notificationSchemeId\":\"10001\",\"projectId\":\"100001\"}]}"}}},"400":{"description":"Returned if search criteria are invalid, strings vs numbers for projectId, notificationSchemeId, startAt and maxResult","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:notification-scheme:jira","read:project:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/notificationscheme/{id}":{"get":{"tags":["Issue notification schemes"],"summary":"Get notification scheme","description":"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.\n\n**[Permissions](#permissions) required:** Permission to access Jira, however, the user must have permission to administer at least one project associated with the notification scheme.","operationId":"getNotificationScheme","parameters":[{"name":"id","in":"path","description":"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":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `all` Returns all expandable information\n *  `field` Returns information about any custom fields assigned to receive an event\n *  `group` Returns information about any groups assigned to receive an event\n *  `notificationSchemeEvents` Returns a list of event associations. This list is returned for all expandable information\n *  `projectRole` Returns information about any project roles assigned to receive an event\n *  `user` Returns information about any users assigned to receive an event","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationScheme"},"example":"{\"expand\":\"notificationSchemeEvents,user,group,projectRole,field,all\",\"id\":10100,\"self\":\"https://your-domain.atlassian.net/rest/api/3/notificationscheme\",\"name\":\"notification scheme name\",\"description\":\"description\",\"notificationSchemeEvents\":[{\"event\":{\"id\":1,\"name\":\"Issue created\",\"description\":\"Event published when an issue is created\"},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"recipient\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"group\":{\"name\":\"jira-administrators\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"recipient\":\"10360\",\"projectRole\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"rest-developer@atlassian.com\",\"recipient\":\"rest-developer@atlassian.com\",\"emailAddress\":\"rest-developer@atlassian.com\"},{\"id\":5,\"notificationType\":\"User\",\"parameter\":\"5b10a2844c20165700ede21g\",\"recipient\":\"5b10a2844c20165700ede21g\",\"user\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"recipient\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"New custom field\",\"untranslatedName\":\"New custom field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New custom field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]},{\"event\":{\"id\":20,\"name\":\"Custom event\",\"description\":\"Custom event that is published together with an issue created event\",\"templateEvent\":{\"id\":1,\"name\":\"Issue created\",\"description\":\"Event published when an issue is created\"}},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"recipient\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"group\":{\"name\":\"jira-administrators\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"recipient\":\"10360\",\"projectRole\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"rest-developer@atlassian.com\",\"recipient\":\"rest-developer@atlassian.com\",\"emailAddress\":\"rest-developer@atlassian.com\"},{\"id\":5,\"notificationType\":\"User\",\"parameter\":\"5b10a2844c20165700ede21g\",\"recipient\":\"5b10a2844c20165700ede21g\",\"user\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"recipient\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"New custom field\",\"untranslatedName\":\"New custom field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New custom field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]}],\"projects\":[10001,10002]}"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the notification scheme is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:field:jira","read:notification-scheme:jira","read:project:jira","read:project-role:jira","read:user:jira","read:avatar:jira","read:field-configuration:jira","read:group:jira","read:project-category:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"put":{"tags":["Issue notification schemes"],"summary":"Update notification scheme","description":"Updates a notification scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updateNotificationScheme","parameters":[{"name":"id","in":"path","description":"The ID of the notification scheme.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNotificationSchemeDetails"},"example":{"description":"My updated notification scheme description","name":"My updated notification scheme"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The length of the description must not exceed 4000 characters.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the notification scheme isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Notification scheme with ID 10000 not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/notificationscheme/{id}/notification":{"put":{"tags":["Issue notification schemes"],"summary":"Add notifications to notification scheme","description":"Adds notifications to a notification scheme. You can add up to 1000 notifications per request.\n\n*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.*\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"addNotifications","parameters":[{"name":"id","in":"path","description":"The ID of the notification scheme.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddNotificationsDetails"},"example":{"notificationSchemeEvents":[{"event":{"id":"1"},"notifications":[{"notificationType":"Group","parameter":"jira-administrators"}]}]}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Event type with ID 2 not found.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the notification scheme isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Notification scheme with ID 10001 not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/notificationscheme/{notificationSchemeId}":{"delete":{"tags":["Issue notification schemes"],"summary":"Delete notification scheme","description":"Deletes a notification scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deleteNotificationScheme","parameters":[{"name":"notificationSchemeId","in":"path","description":"The ID of the notification scheme.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You can’t delete the default notification scheme.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the notification scheme isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Notification scheme with ID 10000 not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/notificationscheme/{notificationSchemeId}/notification/{notificationId}":{"delete":{"tags":["Issue notification schemes"],"summary":"Remove notification from notification scheme","description":"Removes a notification from a notification scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"removeNotificationFromNotificationScheme","parameters":[{"name":"notificationSchemeId","in":"path","description":"The ID of the notification scheme.","required":true,"schema":{"type":"string"}},{"name":"notificationId","in":"path","description":"The ID of the notification.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}},"404":{"description":"Returned if either the notification scheme or notification isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Notification scheme with ID 10000 not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/permissions":{"get":{"tags":["Permissions"],"summary":"Get all permissions","description":"Returns all permissions, including:\n\n *  global permissions.\n *  project permissions.\n *  global permissions added by plugins.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getAllPermissions","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permissions"},"example":"{\"permissions\":{\"BULK_CHANGE\":{\"key\":\"BULK_CHANGE\",\"name\":\"Bulk Change\",\"type\":\"GLOBAL\",\"description\":\"Ability to modify a collection of issues at once. For example, resolve multiple issues in one step.\"}}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:permission:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/permissions/check":{"post":{"tags":["Permissions"],"summary":"Get bulk permissions","description":"Returns:\n\n *  for a list of global permissions, the global permissions granted to a user.\n *  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.\n\nIf no account ID is provided, the operation returns details for the logged in user.\n\nNote that:\n\n *  Invalid project and issue IDs are ignored.\n *  A maximum of 1000 projects and 1000 issues can be checked.\n *  Null values in `globalPermissions`, `projectPermissions`, `projectPermissions.projects`, and `projectPermissions.issues` are ignored.\n *  Empty strings in `projectPermissions.permissions` are ignored.\n\nThis operation can be accessed anonymously.\n\n**[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.","operationId":"getBulkPermissions","parameters":[],"requestBody":{"description":"Details of the permissions to check.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkPermissionsRequestBean"},"example":{"accountId":"5b10a2844c20165700ede21g","globalPermissions":["ADMINISTER"],"projectPermissions":[{"issues":[10010,10011,10012,10013,10014],"permissions":["EDIT_ISSUES"],"projects":[10001]}]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkPermissionGrants"},"example":"{\"projectPermissions\":[{\"permission\":\"EDIT_ISSUES\",\"issues\":[10010,10013,10014],\"projects\":[10001]}],\"globalPermissions\":[\"ADMINISTER\"]}"}}},"400":{"description":"Returned if:\n\n *  `projectPermissions` is provided without at least one project permission being provided.\n *  an invalid global permission is provided in the global permissions list.\n *  an invalid project permission is provided in the project permissions list.\n *  more than 1000 valid project IDs or more than 1000 valid issue IDs are provided.\n *  an invalid account ID is provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[],\"errors\":{\"PERMISSION_123\":\"Unrecognized permission\"}}"}}},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Only Jira administrators can perform this operation.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":[]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":[]},{"state":"Beta","scheme":"OAuth2","scopes":["read:permission:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/permissions/project":{"post":{"tags":["Permissions"],"summary":"Get permitted projects","description":"Returns all the projects where the user is granted a list of project permissions.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.","operationId":"getPermittedProjects","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionsKeysBean"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermittedProjects"}}}},"400":{"description":"Returned if a project permission is not found.","content":{"application/json":{}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":[]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":[]},{"state":"Beta","scheme":"OAuth2","scopes":["read:permission:jira","read:project:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/permissionscheme":{"get":{"tags":["Permission schemes"],"summary":"Get all permission schemes","description":"Returns all permission schemes.\n\n### About permission schemes and grants ###\n\nA permission scheme is a collection of permission grants. A permission grant consists of a `holder` and a `permission`.\n\n#### Holder object ####\n\nThe `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\"`.\n\nThe `holder` object is defined by the following properties:\n\n *  `type` Identifies the user or group (see the list of types below).\n *  `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.\n *  `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`\n\nThe following `types` are available. The expected values for `parameter` and `value` are given in parentheses (some types may not have a `parameter` or `value`):\n\n *  `anyone` Grant for anonymous users.\n *  `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.\n *  `assignee` Grant for the user currently assigned to an issue.\n *  `group` Grant for the specified group (`parameter` : group name, `value` : group ID).\n *  `groupCustomField` Grant for a user in the group selected in the specified custom field (`parameter` : custom field ID, `value` : custom field ID).\n *  `projectLead` Grant for a project lead.\n *  `projectRole` Grant for the specified project role (`parameter` :project role ID, `value` : project role ID).\n *  `reporter` Grant for the user who reported the issue.\n *  `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.\n *  `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).\n *  `userCustomField` Grant for a user selected in the specified custom field (`parameter` : custom field ID, `value` : custom field ID).\n\n#### Built-in permissions ####\n\nThe [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.\n\n**Project permissions**\n\n *  `ADMINISTER_PROJECTS`\n *  `BROWSE_PROJECTS`\n *  `MANAGE_SPRINTS_PERMISSION` (Jira Software only)\n *  `SERVICEDESK_AGENT` (Jira Service Desk only)\n *  `VIEW_DEV_TOOLS` (Jira Software only)\n *  `VIEW_READONLY_WORKFLOW`\n\n**Issue permissions**\n\n *  `ASSIGNABLE_USER`\n *  `ASSIGN_ISSUES`\n *  `CLOSE_ISSUES`\n *  `CREATE_ISSUES`\n *  `DELETE_ISSUES`\n *  `EDIT_ISSUES`\n *  `LINK_ISSUES`\n *  `MODIFY_REPORTER`\n *  `MOVE_ISSUES`\n *  `RESOLVE_ISSUES`\n *  `SCHEDULE_ISSUES`\n *  `SET_ISSUE_SECURITY`\n *  `TRANSITION_ISSUES`\n\n**Voters and watchers permissions**\n\n *  `MANAGE_WATCHERS`\n *  `VIEW_VOTERS_AND_WATCHERS`\n\n**Comments permissions**\n\n *  `ADD_COMMENTS`\n *  `DELETE_ALL_COMMENTS`\n *  `DELETE_OWN_COMMENTS`\n *  `EDIT_ALL_COMMENTS`\n *  `EDIT_OWN_COMMENTS`\n\n**Attachments permissions**\n\n *  `CREATE_ATTACHMENTS`\n *  `DELETE_ALL_ATTACHMENTS`\n *  `DELETE_OWN_ATTACHMENTS`\n\n**Time tracking permissions**\n\n *  `DELETE_ALL_WORKLOGS`\n *  `DELETE_OWN_WORKLOGS`\n *  `EDIT_ALL_WORKLOGS`\n *  `EDIT_OWN_WORKLOGS`\n *  `WORK_ON_ISSUES`\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getAllPermissionSchemes","parameters":[{"name":"expand","in":"query","description":"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:\n\n *  `all` Returns all expandable information.\n *  `field` Returns information about the custom field granted the permission.\n *  `group` Returns information about the group that is granted the permission.\n *  `permissions` Returns all permission grants for each permission scheme.\n *  `projectRole` Returns information about the project role granted the permission.\n *  `user` Returns information about the user who is granted the permission.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionSchemes"},"example":"{\"permissionSchemes\":[{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/permissionscheme/10000\",\"name\":\"Example permission scheme\",\"description\":\"description\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:application-role:jira","read:field:jira","read:group:jira","read:permission-scheme:jira","read:permission:jira","read:project-role:jira","read:user:jira","read:avatar:jira","read:project-category:jira","read:project:jira"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Permission schemes"],"summary":"Create permission scheme","description":"Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createPermissionScheme","parameters":[{"name":"expand","in":"query","description":"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:\n\n *  `all` Returns all expandable information.\n *  `field` Returns information about the custom field granted the permission.\n *  `group` Returns information about the group that is granted the permission.\n *  `permissions` Returns all permission grants for each permission scheme.\n *  `projectRole` Returns information about the project role granted the permission.\n *  `user` Returns information about the user who is granted the permission.","schema":{"type":"string"}}],"requestBody":{"description":"The permission scheme to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionScheme"},"example":{"description":"description","name":"Example permission scheme","permissions":[{"holder":{"parameter":"jira-core-users","type":"group","value":"ca85fac0-d974-40ca-a615-7af99c48d24f"},"permission":"ADMINISTER_PROJECTS"}]}}},"required":true},"responses":{"201":{"description":"Returned if the permission scheme is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionScheme"},"example":"{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/permissionscheme/10000\",\"name\":\"Example permission scheme\",\"description\":\"description\",\"permissions\":[{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"value\":\"ca85fac0-d974-40ca-a615-7af99c48d24f\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}]}"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission or the feature is not available in the Jira plan."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:permission-scheme:jira","read:application-role:jira","read:field:jira","read:group:jira","read:permission-scheme:jira","read:permission:jira","read:project-role:jira","read:user:jira","read:avatar:jira","read:project-category:jira","read:project:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/permissionscheme/{schemeId}":{"get":{"tags":["Permission schemes"],"summary":"Get permission scheme","description":"Returns a permission scheme.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getPermissionScheme","parameters":[{"name":"schemeId","in":"path","description":"The ID of the permission scheme to return.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"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:\n\n *  `all` Returns all expandable information.\n *  `field` Returns information about the custom field granted the permission.\n *  `group` Returns information about the group that is granted the permission.\n *  `permissions` Returns all permission grants for each permission scheme.\n *  `projectRole` Returns information about the project role granted the permission.\n *  `user` Returns information about the user who is granted the permission.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionScheme"},"example":"{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/permissionscheme/10000\",\"name\":\"Example permission scheme\",\"description\":\"description\",\"permissions\":[{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"value\":\"ca85fac0-d974-40ca-a615-7af99c48d24f\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the permission scheme is not found or the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:application-role:jira","read:field:jira","read:group:jira","read:permission-scheme:jira","read:permission:jira","read:project-role:jira","read:user:jira","read:avatar:jira","read:project-category:jira","read:project:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Permission schemes"],"summary":"Update permission scheme","description":"Updates a permission scheme. Below are some important things to note when using this resource:\n\n *  If a permissions list is present in the request, then it is set in the permission scheme, overwriting *all existing* grants.\n *  If you want to update only the name and description, then do not send a permissions list in the request.\n *  Sending an empty list will remove all permission grants from the permission scheme.\n\nIf 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).\n\nSee [About permission schemes and grants](../api-group-permission-schemes/#about-permission-schemes-and-grants) for more details.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updatePermissionScheme","parameters":[{"name":"schemeId","in":"path","description":"The ID of the permission scheme to update.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"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:\n\n *  `all` Returns all expandable information.\n *  `field` Returns information about the custom field granted the permission.\n *  `group` Returns information about the group that is granted the permission.\n *  `permissions` Returns all permission grants for each permission scheme.\n *  `projectRole` Returns information about the project role granted the permission.\n *  `user` Returns information about the user who is granted the permission.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionScheme"},"example":{"description":"description","name":"Example permission scheme","permissions":[{"holder":{"parameter":"jira-core-users","type":"group","value":"ca85fac0-d974-40ca-a615-7af99c48d24f"},"permission":"ADMINISTER_PROJECTS"}]}}},"required":true},"responses":{"200":{"description":"Returned if the scheme is updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionScheme"},"example":"{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/permissionscheme/10000\",\"name\":\"Example permission scheme\",\"description\":\"description\",\"permissions\":[{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"value\":\"ca85fac0-d974-40ca-a615-7af99c48d24f\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if:\n\n *  the user does not have the necessary permission to update permission schemes.\n *  the Jira instance is Jira Core Free or Jira Software Free. Permission schemes cannot be updated on free plans."},"404":{"description":"Returned if the permission scheme is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:permission-scheme:jira","read:application-role:jira","read:field:jira","read:group:jira","read:permission-scheme:jira","read:permission:jira","read:project-role:jira","read:user:jira","read:avatar:jira","read:project-category:jira","read:project:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Permission schemes"],"summary":"Delete permission scheme","description":"Deletes a permission scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deletePermissionScheme","parameters":[{"name":"schemeId","in":"path","description":"The ID of the permission scheme being deleted.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the permission scheme is deleted."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the permission scheme is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:permission-scheme:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/permissionscheme/{schemeId}/permission":{"get":{"tags":["Permission schemes"],"summary":"Get permission scheme grants","description":"Returns all permission grants for a permission scheme.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getPermissionSchemeGrants","parameters":[{"name":"schemeId","in":"path","description":"The ID of the permission scheme.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"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:\n\n *  `permissions` Returns all permission grants for each permission scheme.\n *  `user` Returns information about the user who is granted the permission.\n *  `group` Returns information about the group that is granted the permission.\n *  `projectRole` Returns information about the project role granted the permission.\n *  `field` Returns information about the custom field granted the permission.\n *  `all` Returns all expandable information.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionGrants"},"example":"{\"permissions\":[{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"value\":\"ca85fac0-d974-40ca-a615-7af99c48d24f\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}],\"expand\":\"user,group,projectRole,field,all\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the permission schemes is not found or the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:application-role:jira","read:field:jira","read:group:jira","read:permission:jira","read:project-role:jira","read:user:jira"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Permission schemes"],"summary":"Create permission grant","description":"Creates a permission grant in a permission scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createPermissionGrant","parameters":[{"name":"schemeId","in":"path","description":"The ID of the permission scheme in which to create a new permission grant.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"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:\n\n *  `permissions` Returns all permission grants for each permission scheme.\n *  `user` Returns information about the user who is granted the permission.\n *  `group` Returns information about the group that is granted the permission.\n *  `projectRole` Returns information about the project role granted the permission.\n *  `field` Returns information about the custom field granted the permission.\n *  `all` Returns all expandable information.","schema":{"type":"string"}}],"requestBody":{"description":"The permission grant to create.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionGrant"},"example":{"holder":{"parameter":"jira-core-users","type":"group","value":"ca85fac0-d974-40ca-a615-7af99c48d24f"},"permission":"ADMINISTER_PROJECTS"}}},"required":true},"responses":{"201":{"description":"Returned if the scheme permission is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionGrant"},"example":"{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"value\":\"ca85fac0-d974-40ca-a615-7af99c48d24f\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}"}}},"400":{"description":"Returned if the value for expand is invalid or the same permission grant is present."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:application-role:jira","read:field:jira","read:group:jira","read:permission:jira","read:project-role:jira","read:user:jira","write:permission:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/permissionscheme/{schemeId}/permission/{permissionId}":{"get":{"tags":["Permission schemes"],"summary":"Get permission scheme grant","description":"Returns a permission grant.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getPermissionSchemeGrant","parameters":[{"name":"schemeId","in":"path","description":"The ID of the permission scheme.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"permissionId","in":"path","description":"The ID of the permission grant.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"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:\n\n *  `all` Returns all expandable information.\n *  `field` Returns information about the custom field granted the permission.\n *  `group` Returns information about the group that is granted the permission.\n *  `permissions` Returns all permission grants for each permission scheme.\n *  `projectRole` Returns information about the project role granted the permission.\n *  `user` Returns information about the user who is granted the permission.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionGrant"},"example":"{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"value\":\"ca85fac0-d974-40ca-a615-7af99c48d24f\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the permission scheme or permission grant is not found or the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:application-role:jira","read:field:jira","read:group:jira","read:permission:jira","read:project-role:jira","read:user:jira"]}],"x-atlassian-connect-scope":"READ"},"delete":{"tags":["Permission schemes"],"summary":"Delete permission scheme grant","description":"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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deletePermissionSchemeEntity","parameters":[{"name":"schemeId","in":"path","description":"The ID of the permission scheme to delete the permission grant from.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"permissionId","in":"path","description":"The ID of the permission grant to delete.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the permission grant is deleted."},"400":{"description":"Returned if permission grant with the provided ID is not found."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:permission:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/priority":{"get":{"tags":["Issue priorities"],"summary":"Get priorities","description":"Returns the list of all issue priorities.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getPriorities","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Priority"}},"example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/priority/3\",\"statusColor\":\"#009900\",\"description\":\"Major loss of function.\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/priorities/major.png\",\"name\":\"Major\",\"id\":\"1\"},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/priority/5\",\"statusColor\":\"#cfcfcf\",\"description\":\"Very little impact.\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/priorities/trivial.png\",\"name\":\"Trivial\",\"id\":\"2\"}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect."}},"deprecated":true,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:priority:jira"]}],"x-changes":[{"announced":"2022-10-11","details":"https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-762","effective":"2023-04-11","type":"removed"}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Issue priorities"],"summary":"Create priority","description":"Creates an issue priority.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createPriority","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePriorityDetails"},"example":{"description":"My priority description","iconUrl":"images/icons/priorities/major.png","name":"My new priority","statusColor":"#ABCDEF"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriorityId"},"example":"{\"id\":\"10001\"}"}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The length of the description must not exceed 255 characters.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Only Jira administrators can access issue type screen schemes.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/priority/default":{"put":{"tags":["Issue priorities"],"summary":"Set default priority","description":"Sets default issue priority.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"setDefaultPriority","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetDefaultPriorityRequest"},"example":{"id":"3"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The id has to be provided.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue priority isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Priority with ID 10000 not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/priority/move":{"put":{"tags":["Issue priorities"],"summary":"Move priorities","description":"Changes the order of issue priorities.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"movePriorities","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReorderIssuePriorities"},"example":{"after":"10003","ids":["10004","10005"]}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The ids must contain no more than 1,000 items.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue priority isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Priority with ID 10000 not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/priority/search":{"get":{"tags":["Issue priorities"],"summary":"Search priorities","description":"Returns a [paginated](#pagination) list of priorities. The list can contain all priorities or a subset determined by any combination of these criteria:\n\n *  a list of priority IDs. Any invalid priority IDs are ignored.\n *  a list of project IDs. Only priorities that are available in these projects will be returned. Any invalid project IDs are ignored.\n *  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.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"searchPriorities","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"string","default":"0"}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"string","default":"50"}},{"name":"id","in":"query","description":"The list of priority IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=2&id=3`.","schema":{"type":"array","items":{"type":"string","default":""}}},{"name":"projectId","in":"query","description":"The list of projects IDs. To include multiple IDs, provide an ampersand-separated list. For example, `projectId=10010&projectId=10111`.","schema":{"type":"array","items":{"type":"string","default":""}}},{"name":"priorityName","in":"query","description":"The name of priority to search for.","schema":{"type":"string","default":""}},{"name":"onlyDefault","in":"query","description":"Whether only the default priority is returned.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanPriority"},"example":"{\"maxResults\":50,\"startAt\":0,\"total\":2,\"isLast\":true,\"values\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/priority/3\",\"statusColor\":\"#009900\",\"description\":\"Major loss of function.\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/priorities/major.png\",\"name\":\"Major\",\"id\":\"1\",\"isDefault\":true},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/priority/5\",\"statusColor\":\"#cfcfcf\",\"description\":\"Very little impact.\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/priorities/trivial.png\",\"name\":\"Trivial\",\"id\":\"2\",\"isDefault\":false}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/priority/{id}":{"get":{"tags":["Issue priorities"],"summary":"Get priority","description":"Returns an issue priority.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getPriority","parameters":[{"name":"id","in":"path","description":"The ID of the issue priority.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Priority"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/priority/3\",\"statusColor\":\"#009900\",\"description\":\"Major loss of function.\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/priorities/major.png\",\"name\":\"Major\",\"id\":\"1\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the issue priority isn't found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:priority:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Issue priorities"],"summary":"Update priority","description":"Updates an issue priority.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updatePriority","parameters":[{"name":"id","in":"path","description":"The ID of the issue priority.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePriorityDetails"},"example":{"description":"My updated priority description","iconUrl":"images/icons/priorities/minor.png","name":"My updated priority","statusColor":"#123456"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The length of the description must not exceed 255 characters.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue priority isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Priority with ID 10000 not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Issue priorities"],"summary":"Delete priority","description":"*Deprecated: please refer to the* [changelog](https://developer.atlassian.com/changelog/#CHANGE-1066) *for more details.*\n\nDeletes an issue priority.\n\nThis 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deletePriority","parameters":[{"name":"id","in":"path","description":"The ID of the issue priority.","required":true,"schema":{"type":"string"}},{"name":"replaceWith","in":"query","description":"The ID of the issue priority that will replace the currently selected resolution.","required":true,"schema":{"type":"string"}}],"responses":{"303":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskProgressBeanObject"}}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The newPriority has to be provided.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue priority isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Priority with ID 10000 not found.\"],\"errors\":{}}"}}},"409":{"description":"Returned if a task to delete the issue priority is already running.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":true,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-changes":[{"announced":"2023-07-18","details":"https://developer.atlassian.com/changelog/#CHANGE-1066","effective":"2023-12-01","type":"removed"}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/project":{"get":{"tags":["Projects"],"summary":"Get all projects","description":"Returns all projects visible to the user. Deprecated, use [ Get projects paginated](#api-rest-api-3-project-search-get) that supports search and pagination.\n\nThis operation can be accessed anonymously.\n\n**[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.","operationId":"getAllProjects","parameters":[{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:\n\n *  `description` Returns the project description.\n *  `issueTypes` Returns all issue types associated with the project.\n *  `lead` Returns information about the project lead.\n *  `projectKeys` Returns all project keys associated with the project.","schema":{"type":"string"}},{"name":"recent","in":"query","description":"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.","schema":{"type":"integer","format":"int32"}},{"name":"properties","in":"query","description":"A list of project properties to return for the project. This parameter accepts a comma-separated list.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Project"}},"example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"}},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/ABC\",\"id\":\"10001\",\"key\":\"ABC\",\"name\":\"Alphabetical\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"}}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":true,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type:jira","read:project:jira","read:project.property:jira","read:user:jira","read:application-role:jira","read:avatar:jira","read:group:jira","read:issue-type-hierarchy:jira","read:project-category:jira","read:project-version:jira","read:project.component:jira"]}],"x-changes":[{"announced":"2018-10-19","details":"https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-removal-of-get-filters-and-get-all-projects/","effective":"2019-04-19","type":"removed"}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Projects"],"summary":"Create project","description":"Creates a project based on a project type template, as shown in the following table:\n\n| Project Type Key | Project Template Key |  \n|--|--|  \n| `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` |  \n| `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` |  \n| `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` |  \nThe project types are available according to the installed Jira features as follows:\n\n *  Jira Core, the default, enables `business` projects.\n *  Jira Service Management enables `service_desk` projects.\n *  Jira Software enables `software` projects.\n\nTo determine which features are installed, go to **Jira settings** > **Apps** > **Manage apps** and review the System Apps list. To add Jira Software or Jira Service Management into a JIRA instance, use **Jira settings** > **Apps** > **Finding new apps**. For more information, see [ Managing add-ons](https://confluence.atlassian.com/x/S31NLg).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createProject","parameters":[],"requestBody":{"description":"The JSON representation of the project being created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProjectDetails"},"example":{"assigneeType":"PROJECT_LEAD","avatarId":10200,"categoryId":10120,"description":"Cloud migration initiative","issueSecurityScheme":10001,"key":"EX","leadAccountId":"5b10a0effa615349cb016cd8","name":"Example","notificationScheme":10021,"permissionScheme":10011,"projectTemplateKey":"com.atlassian.jira-core-project-templates:jira-core-simplified-process-control","projectTypeKey":"business","url":"http://atlassian.com"}}},"required":true},"responses":{"201":{"description":"Returned if the project is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectIdentifiers"},"example":"{\"self\":\"https://your-domain.atlassian.net/jira/rest/api/3/project/10042\",\"id\":10010,\"key\":\"EX\"}"}}},"400":{"description":"Returned if the request is not valid and the project could not be created."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to create projects."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:project:jira","read:project:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/project/recent":{"get":{"tags":["Projects"],"summary":"Get recent projects","description":"Returns a list of up to 20 projects recently viewed by the user that are still visible to the user.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Projects are returned only where the user has one of:\n\n *  *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n *  *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n *  *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getRecent","parameters":[{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:\n\n *  `description` Returns the project description.\n *  `projectKeys` Returns all project keys associated with a project.\n *  `lead` Returns information about the project lead.\n *  `issueTypes` Returns all issue types associated with the project.\n *  `url` Returns the URL associated with the project.\n *  `permissions` Returns the permissions associated with the project.\n *  `insight` EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project.\n *  `*` Returns the project with all available expand options.","schema":{"type":"string"}},{"name":"properties","in":"query","description":"EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list. Invalid property names are ignored.","schema":{"type":"array","items":{"$ref":"#/components/schemas/StringList"}}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Project"}},"example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"}},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/ABC\",\"id\":\"10001\",\"key\":\"ABC\",\"name\":\"Alphabetical\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"}}]"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type:jira","read:project:jira","read:project.property:jira","read:user:jira","read:application-role:jira","read:avatar:jira","read:group:jira","read:issue-type-hierarchy:jira","read:project-category:jira","read:project-version:jira","read:project.component:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/search":{"get":{"tags":["Projects"],"summary":"Get projects paginated","description":"Returns a [paginated](#pagination) list of projects visible to the user.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Projects are returned only where the user has one of:\n\n *  *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n *  *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n *  *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"searchProjects","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"orderBy","in":"query","description":"[Order](#ordering) the results by a field.\n\n *  `category` Sorts by project category. A complete list of category IDs is found using [Get all project categories](#api-rest-api-3-projectCategory-get).\n *  `issueCount` Sorts by the total number of issues in each project.\n *  `key` Sorts by project key.\n *  `lastIssueUpdatedTime` Sorts by the last issue update time.\n *  `name` Sorts by project name.\n *  `owner` Sorts by project lead.\n *  `archivedDate` EXPERIMENTAL. Sorts by project archived date.\n *  `deletedDate` EXPERIMENTAL. Sorts by project deleted date.","schema":{"type":"string","default":"key","enum":["category","-category","+category","key","-key","+key","name","-name","+name","owner","-owner","+owner","issueCount","-issueCount","+issueCount","lastIssueUpdatedDate","-lastIssueUpdatedDate","+lastIssueUpdatedDate","archivedDate","+archivedDate","-archivedDate","deletedDate","+deletedDate","-deletedDate"]}},{"name":"id","in":"query","description":"The project IDs to filter the results by. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. Up to 50 project IDs can be provided.","schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"keys","in":"query","description":"The project keys to filter the results by. To include multiple keys, provide an ampersand-separated list. For example, `keys=PA&keys=PB`. Up to 50 project keys can be provided.","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"query","in":"query","description":"Filter the results using a literal string. Projects with a matching `key` or `name` are returned (case insensitive).","schema":{"type":"string"}},{"name":"typeKey","in":"query","description":"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`.","schema":{"type":"string"}},{"name":"categoryId","in":"query","description":"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.","schema":{"type":"integer","format":"int64"}},{"name":"action","in":"query","description":"Filter results by projects for which the user can:\n\n *  `view` the project, meaning that they have one of the following permissions:\n    \n     *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n     *  *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n     *  *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).\n *  `browse` the project, meaning that they have the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n *  `edit` the project, meaning that they have one of the following permissions:\n    \n     *  *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n     *  *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).\n *  `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.","schema":{"type":"string","default":"view","enum":["view","browse","edit","create"]}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:\n\n *  `description` Returns the project description.\n *  `projectKeys` Returns all project keys associated with a project.\n *  `lead` Returns information about the project lead.\n *  `issueTypes` Returns all issue types associated with the project.\n *  `url` Returns the URL associated with the project.\n *  `insight` EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project.","schema":{"type":"string"}},{"name":"status","in":"query","description":"EXPERIMENTAL. Filter results by project status:\n\n *  `live` Search live projects.\n *  `archived` Search archived projects.\n *  `deleted` Search deleted projects, those in the recycle bin.","schema":{"type":"array","items":{"type":"string","default":"live","enum":["live","archived","deleted"]}}},{"name":"properties","in":"query","description":"EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list.","schema":{"type":"array","items":{"$ref":"#/components/schemas/StringList"}}},{"name":"propertyQuery","in":"query","description":"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`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanProject"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/search?startAt=0&maxResults=2\",\"nextPage\":\"https://your-domain.atlassian.net/rest/api/3/project/search?startAt=2&maxResults=2\",\"maxResults\":2,\"startAt\":0,\"total\":7,\"isLast\":false,\"values\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"}},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/ABC\",\"id\":\"10001\",\"key\":\"ABC\",\"name\":\"Alphabetical\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"}}]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if no projects matching the search criteria are found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type:jira","read:project:jira","read:project.property:jira","read:user:jira","read:application-role:jira","read:avatar:jira","read:group:jira","read:issue-type-hierarchy:jira","read:project-category:jira","read:project-version:jira","read:project.component:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/type":{"get":{"tags":["Project types"],"summary":"Get all project types","description":"Returns all [project types](https://confluence.atlassian.com/x/Var1Nw), whether or not the instance has a valid license for each type.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.","operationId":"getAllProjectTypes","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectType"}},"example":"[{\"key\":\"business\",\"formattedKey\":\"Business\",\"descriptionI18nKey\":\"jira.project.type.business.description\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#FFFFFF\"},{\"key\":\"software\",\"formattedKey\":\"Software\",\"descriptionI18nKey\":\"jira.project.type.software.description\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#AAAAAA\"}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project-type:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/type/accessible":{"get":{"tags":["Project types"],"summary":"Get licensed project types","description":"Returns all [project types](https://confluence.atlassian.com/x/Var1Nw) with a valid license.","operationId":"getAllAccessibleProjectTypes","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectType"}},"example":"[{\"key\":\"business\",\"formattedKey\":\"Business\",\"descriptionI18nKey\":\"jira.project.type.business.description\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#FFFFFF\"},{\"key\":\"software\",\"formattedKey\":\"Software\",\"descriptionI18nKey\":\"jira.project.type.software.description\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#AAAAAA\"}]"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project-type:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/type/{projectTypeKey}":{"get":{"tags":["Project types"],"summary":"Get project type by key","description":"Returns a [project type](https://confluence.atlassian.com/x/Var1Nw).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.","operationId":"getProjectTypeByKey","parameters":[{"name":"projectTypeKey","in":"path","description":"The key of the project type.","required":true,"schema":{"type":"string","enum":["software","service_desk","business","product_discovery"]}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectType"},"example":"{\"key\":\"business\",\"formattedKey\":\"Business\",\"descriptionI18nKey\":\"jira.project.type.business.description\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#FFFFFF\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the project type is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project-type:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/type/{projectTypeKey}/accessible":{"get":{"tags":["Project types"],"summary":"Get accessible project type by key","description":"Returns a [project type](https://confluence.atlassian.com/x/Var1Nw) if it is accessible to the user.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getAccessibleProjectTypeByKey","parameters":[{"name":"projectTypeKey","in":"path","description":"The key of the project type.","required":true,"schema":{"type":"string","enum":["software","service_desk","business","product_discovery"]}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectType"},"example":"{\"key\":\"business\",\"formattedKey\":\"Business\",\"descriptionI18nKey\":\"jira.project.type.business.description\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#FFFFFF\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the project type is not accessible to the user."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project-type:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}":{"get":{"tags":["Projects"],"summary":"Get project","description":"Returns the [project details](https://confluence.atlassian.com/x/ahLpNw) for a project.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.","operationId":"getProject","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"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:\n\n *  `description` The project description.\n *  `issueTypes` The issue types associated with the project.\n *  `lead` The project lead.\n *  `projectKeys` All project keys associated with the project.\n *  `issueTypeHierarchy` The project issue type hierarchy.","schema":{"type":"string"}},{"name":"properties","in":"query","description":"A list of project properties to return for the project. This parameter accepts a comma-separated list.","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returned if successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"description\":\"This project was created as an example for REST.\",\"lead\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"components\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000,\"ari\":\"ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002\",\"metadata\":{\"icon\":\"https://www.example.com/icon.png\"}}],\"issueTypes\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1,\"hierarchyLevel\":0},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"hierarchyLevel\":0,\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\"}}}],\"url\":\"https://www.example.com\",\"email\":\"from-jira@example.com\",\"assigneeType\":\"PROJECT_LEAD\",\"versions\":[],\"name\":\"Example\",\"roles\":{\"Developers\":\"https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000\"},\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"properties\":{\"propertyKey\":\"propertyValue\"},\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the project is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type:jira","read:project:jira","read:project.property:jira","read:user:jira","read:application-role:jira","read:avatar:jira","read:group:jira","read:issue-type-hierarchy:jira","read:project-category:jira","read:project-version:jira","read:project.component:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Projects"],"summary":"Update project","description":"Updates the [project details](https://confluence.atlassian.com/x/ahLpNw) of a project.\n\nAll 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.\n\n**[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)","operationId":"updateProject","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string","example":"10001"}},{"name":"expand","in":"query","description":"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:\n\n *  `description` The project description.\n *  `issueTypes` The issue types associated with the project.\n *  `lead` The project lead.\n *  `projectKeys` All project keys associated with the project.","schema":{"type":"string"}}],"requestBody":{"description":"The project details to be updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProjectDetails"},"example":{"assigneeType":"PROJECT_LEAD","avatarId":10200,"categoryId":10120,"description":"Cloud migration initiative","issueSecurityScheme":10001,"key":"EX","leadAccountId":"5b10a0effa615349cb016cd8","name":"Example","notificationScheme":10021,"permissionScheme":10011,"url":"http://atlassian.com"}}},"required":true},"responses":{"200":{"description":"Returned if the project is updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"description\":\"This project was created as an example for REST.\",\"lead\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"components\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000,\"ari\":\"ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002\",\"metadata\":{\"icon\":\"https://www.example.com/icon.png\"}}],\"issueTypes\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1,\"hierarchyLevel\":0},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"hierarchyLevel\":0,\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\"}}}],\"url\":\"https://www.example.com\",\"email\":\"from-jira@example.com\",\"assigneeType\":\"PROJECT_LEAD\",\"versions\":[],\"name\":\"Example\",\"roles\":{\"Developers\":\"https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000\"},\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"properties\":{\"propertyKey\":\"propertyValue\"},\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"}}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if:\n\n *  the user does not have the necessary permission to update project details.\n *  the permission scheme is being changed and the Jira instance is Jira Core Free or Jira Software Free. Permission schemes cannot be changed on free plans."},"404":{"description":"Returned if the project is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type:jira","read:project:jira","read:project.property:jira","read:user:jira","write:project:jira","write:project.avatar:jira","read:application-role:jira","read:avatar:jira","read:group:jira","read:issue-type-hierarchy:jira","read:project-category:jira","read:project-version:jira","read:project.component:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Projects"],"summary":"Delete project","description":"Deletes a project.\n\nYou 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deleteProject","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string","example":"10001"}},{"name":"enableUndo","in":"query","description":"Whether this project is placed in the Jira recycle bin where it will be available for restoration.","schema":{"type":"boolean","default":true}}],"responses":{"204":{"description":"Returned if the project is deleted."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the project is not found or the user does not have permission to delete it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:project:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/project/{projectIdOrKey}/archive":{"post":{"tags":["Projects"],"summary":"Archive project","description":"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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"archiveProject","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permissions."},"404":{"description":"Returned if the project is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:project:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/project/{projectIdOrKey}/avatar":{"put":{"tags":["Project avatars"],"summary":"Set project avatar","description":"Sets the avatar displayed for a project.\n\nUse [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.\n\n**[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg).","operationId":"updateProjectAvatar","parameters":[{"name":"projectIdOrKey","in":"path","description":"The ID or (case-sensitive) key of the project.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Avatar"},"example":{"id":"10010"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to administer the project."},"404":{"description":"Returned if the project or avatar is not found or the user does not have permission to view the project."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:project.avatar:jira"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/project/{projectIdOrKey}/avatar/{id}":{"delete":{"tags":["Project avatars"],"summary":"Delete project avatar","description":"Deletes a custom avatar from a project. Note that system avatars cannot be deleted.\n\n**[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg).","operationId":"deleteProjectAvatar","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or (case-sensitive) key.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the avatar.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the avatar is a system avatar or the user does not have permission to administer the project."},"404":{"description":"Returned if the project or avatar is not found or the user does not have permission to view the project."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:project.avatar:jira"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/project/{projectIdOrKey}/avatar2":{"post":{"tags":["Project avatars"],"summary":"Load project avatar","description":"Loads an avatar for a project.\n\nSpecify the avatar's local file location in the body of the request. Also, include the following headers:\n\n *  `X-Atlassian-Token: no-check` To prevent XSRF protection blocking the request, for more information see [Special Headers](#special-request-headers).\n *  `Content-Type: image/image type` Valid image types are JPEG, GIF, or PNG.\n\nFor example:  \n`curl --request POST `\n\n`--user email@example.com:<api_token> `\n\n`--header 'X-Atlassian-Token: no-check' `\n\n`--header 'Content-Type: image/< image_type>' `\n\n`--data-binary \"<@/path/to/file/with/your/avatar>\" `\n\n`--url 'https://your-domain.atlassian.net/rest/api/3/project/{projectIdOrKey}/avatar2'`\n\nThe 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.\n\nThe cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.\n\nAfter creating the avatar use [Set project avatar](#api-rest-api-3-project-projectIdOrKey-avatar-put) to set it as the project's displayed avatar.\n\n**[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg).","operationId":"createProjectAvatar","parameters":[{"name":"projectIdOrKey","in":"path","description":"The ID or (case-sensitive) key of the project.","required":true,"schema":{"type":"string"}},{"name":"x","in":"query","description":"The X coordinate of the top-left corner of the crop region.","schema":{"type":"integer","format":"int32","default":0}},{"name":"y","in":"query","description":"The Y coordinate of the top-left corner of the crop region.","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"The length of each side of the crop region.","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"*/*":{"schema":{}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Avatar"},"example":"{\"id\":\"1010\",\"isSystemAvatar\":false,\"isSelected\":false,\"isDeletable\":true}"}}},"400":{"description":"Returned if:\n\n *  an image isn't included in the request.\n *  the image type is unsupported.\n *  the crop parameters extend the crop area beyond the edge of the image."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to administer the project or an anonymous call is made to the operation."},"404":{"description":"Returned if the project is not found or the user does not have permission to view the project."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:project.avatar:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/project/{projectIdOrKey}/avatars":{"get":{"tags":["Project avatars"],"summary":"Get all project avatars","description":"Returns all project avatars, grouped by system and custom avatars.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.","operationId":"getAllProjectAvatars","parameters":[{"name":"projectIdOrKey","in":"path","description":"The ID or (case-sensitive) key of the project.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectAvatars"},"example":"{\"system\":[{\"id\":\"1000\",\"isSystemAvatar\":true,\"isSelected\":false,\"isDeletable\":false,\"urls\":{\"16x16\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10040&avatarType=project\",\"24x24\":\"https://your-domain.atlassian.net/secure/viewavatar?size=small&avatarId=10040&avatarType=project\",\"32x32\":\"https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10040&avatarType=project\",\"48x48\":\"https://your-domain.atlassian.net/secure/viewavatar?avatarId=10040&avatarType=project\"}}],\"custom\":[{\"id\":\"1010\",\"isSystemAvatar\":false,\"isSelected\":false,\"isDeletable\":true,\"urls\":{\"16x16\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10080&avatarType=project\",\"24x24\":\"https://your-domain.atlassian.net/secure/viewavatar?size=small&avatarId=10080&avatarType=project\",\"32x32\":\"https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10080&avatarType=project\",\"48x48\":\"https://your-domain.atlassian.net/secure/viewavatar?avatarId=10080&avatarType=project\"}}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the project is not found or the user does not have permission to view the project."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project.avatar:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}/component":{"get":{"tags":["Project components"],"summary":"Get project components paginated","description":"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.\n\nIf your project uses Compass components, this API will return a list of Compass components that are linked to issues in that project.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.","operationId":"getProjectComponentsPaginated","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"orderBy","in":"query","description":"[Order](#ordering) the results by a field:\n\n *  `description` Sorts by the component description.\n *  `issueCount` Sorts by the count of issues associated with the component.\n *  `lead` Sorts by the user key of the component's project lead.\n *  `name` Sorts by component name.","schema":{"type":"string","enum":["description","-description","+description","issueCount","-issueCount","+issueCount","lead","-lead","+lead","name","-name","+name"]}},{"name":"query","in":"query","description":"Filter the results using a literal string. Components with a matching `name` or `description` are returned (case insensitive).","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanComponentWithIssueCount"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/PR/component?startAt=0&maxResults=2\",\"nextPage\":\"https://your-domain.atlassian.net/rest/api/3/project/PR/component?startAt=2&maxResults=2\",\"maxResults\":2,\"startAt\":0,\"total\":7,\"isLast\":false,\"values\":[{\"componentBean\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000,\"ari\":\"ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002\",\"metadata\":{\"icon\":\"https://www.example.com/icon.png\"}},\"issueCount\":1,\"name\":\"Component 1\",\"id\":\"10000\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"project\":\"HSP\",\"projectId\":10000,\"assignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"self\":\"https://your-domain.atlassian.net/rest/api/3/component/10000\"},{\"componentBean\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10050\",\"name\":\"PXA\",\"description\":\"This is a another Jira component\",\"lead\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"PROJECTKEY\",\"projectId\":10000,\"ari\":\"ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-11ee-4e70-be56-0242ac120002/fdb3fdec-4e70-11ee-be56-0242ac120002\",\"metadata\":{\"icon\":\"https://www.example.com/icon.png\"}},\"issueCount\":5,\"name\":\"PXA\",\"id\":\"10050\",\"description\":\"This is a another Jira component\",\"lead\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"project\":\"PROJECTKEY\",\"projectId\":10000,\"assignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"self\":\"https://your-domain.atlassian.net/rest/api/3/component/10000\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the project is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project:jira","read:project.component:jira","read:user:jira","read:application-role:jira","read:avatar:jira","read:group:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}/components":{"get":{"tags":["Project components"],"summary":"Get project components","description":"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.\n\nIf your project uses Compass components, this API will return a paginated list of Compass components that are linked to issues in that project.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.","operationId":"getProjectComponents","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectComponent"}},"example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000,\"ari\":\"ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002\",\"metadata\":{\"icon\":\"https://www.example.com/icon.png\"}},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10050\",\"name\":\"PXA\",\"description\":\"This is a another Jira component\",\"lead\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"PROJECTKEY\",\"projectId\":10000,\"ari\":\"ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-11ee-4e70-be56-0242ac120002/fdb3fdec-4e70-11ee-be56-0242ac120002\",\"metadata\":{\"icon\":\"https://www.example.com/icon.png\"}}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the project is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project:jira","read:project.component:jira","read:user:jira","read:application-role:jira","read:avatar:jira","read:group:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}/delete":{"post":{"tags":["Projects"],"summary":"Delete project asynchronously","description":"Deletes a project asynchronously.\n\nThis operation is:\n\n *  transactional, that is, if part of the delete fails the project is not deleted.\n *  [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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deleteProjectAsynchronously","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}}],"responses":{"303":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskProgressBeanObject"}}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the project is not found or the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:project:jira","write:project.property:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/project/{projectIdOrKey}/features":{"get":{"tags":["Project features"],"summary":"Get project features","description":"Returns the list of features for a project.","operationId":"getFeaturesForProject","parameters":[{"name":"projectIdOrKey","in":"path","description":"The ID or (case-sensitive) key of the project.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContainerForProjectFeatures"},"example":"{\"features\":[{\"projectId\":10001,\"state\":\"ENABLED\",\"toggleLocked\":true,\"feature\":\"jsw.classic.roadmap\",\"prerequisites\":[],\"localisedName\":\"Roadmap\",\"localisedDescription\":\"Your roadmap is an optimized location to create and manage your epics.\",\"imageUri\":\"https://jira.atlassian.com/s/sb53l8/b/3/ab8a7691e4738b4f147e293f0864adfd5b8d3c85/_/download/resources/com.atlassian.jira.rest:classic-project-features/simple-roadmap-feature.svg\"},{\"projectId\":10001,\"state\":\"ENABLED\",\"toggleLocked\":true,\"feature\":\"jsw.classic.backlog\",\"prerequisites\":[],\"localisedName\":\"Backlog\",\"localisedDescription\":\"Plan and prioritize work in a dedicated space. To enable and configure the backlog for each board, go to board settings.\",\"imageUri\":\"https://jira.atlassian.com/s/sb53l8/b/3/ab8a7691e4738b4f147e293f0864adfd5b8d3c85/_/download/resources/com.atlassian.jira.rest:classic-project-features/simple-backlog-feature.svg\"}]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions."},"404":{"description":"Returned if the project is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project.feature:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}/features/{featureKey}":{"put":{"tags":["Project features"],"summary":"Set project feature state","description":"Sets the state of a project feature.","operationId":"toggleFeatureForProject","parameters":[{"name":"projectIdOrKey","in":"path","description":"The ID or (case-sensitive) key of the project.","required":true,"schema":{"type":"string"}},{"name":"featureKey","in":"path","description":"The key of the feature.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Details of the feature state change.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectFeatureState"},"example":{"state":"ENABLED"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContainerForProjectFeatures"},"example":"{\"features\":[{\"projectId\":10001,\"state\":\"ENABLED\",\"toggleLocked\":true,\"feature\":\"jsw.classic.roadmap\",\"prerequisites\":[],\"localisedName\":\"Roadmap\",\"localisedDescription\":\"Your roadmap is an optimized location to create and manage your epics.\",\"imageUri\":\"https://jira.atlassian.com/s/sb53l8/b/3/ab8a7691e4738b4f147e293f0864adfd5b8d3c85/_/download/resources/com.atlassian.jira.rest:classic-project-features/simple-roadmap-feature.svg\"},{\"projectId\":10001,\"state\":\"ENABLED\",\"toggleLocked\":true,\"feature\":\"jsw.classic.backlog\",\"prerequisites\":[],\"localisedName\":\"Backlog\",\"localisedDescription\":\"Plan and prioritize work in a dedicated space. To enable and configure the backlog for each board, go to board settings.\",\"imageUri\":\"https://jira.atlassian.com/s/sb53l8/b/3/ab8a7691e4738b4f147e293f0864adfd5b8d3c85/_/download/resources/com.atlassian.jira.rest:classic-project-features/simple-backlog-feature.svg\"}]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions."},"404":{"description":"Returned if the project or project feature is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:project.feature:jira","read:project.feature:jira"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/project/{projectIdOrKey}/properties":{"get":{"tags":["Project properties"],"summary":"Get project property keys","description":"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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.","operationId":"getProjectPropertyKeys","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyKeys"},"example":"{\"keys\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect."},"403":{"description":"Returned if the user does not have permission to view the project."},"404":{"description":"Returned if the project is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project.property:jira","read:comment.property:jira","read:dashboard.property:jira","read:issue-type.property:jira","read:issue-worklog.property:jira","read:issue.property:jira","read:user.property:jira","read:workflow.property:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}":{"get":{"tags":["Project properties"],"summary":"Get project property","description":"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).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the property.","operationId":"getProjectProperty","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"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":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityProperty"},"example":"{\"key\":\"issue.support\",\"value\":{\"system.conversation.id\":\"b1bf38be-5e94-4b40-a3b8-9278735ee1e6\",\"system.support.time\":\"1m\"}}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect."},"403":{"description":"Returned if the user does not have permission to view the project."},"404":{"description":"Returned if the project or property is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project.property:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Project properties"],"summary":"Set project property","description":"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.\n\nThe 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.\n\nThis operation can be accessed anonymously.\n\n**[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.","operationId":"setProjectProperty","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the project property. The maximum length is 255 characters.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{},"example":{"number":5,"string":"string-value"}}},"required":true},"responses":{"200":{"description":"Returned if the project property is updated.","content":{"application/json":{"schema":{}}}},"201":{"description":"Returned if the project property is created.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the project key or id is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect."},"403":{"description":"Returned if the user does not have permission to administer the project."},"404":{"description":"Returned if the project is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:project.property:jira"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Project properties"],"summary":"Delete project property","description":"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.\n\nThis operation can be accessed anonymously.\n\n**[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.","operationId":"deleteProjectProperty","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"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":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the project property is deleted."},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect."},"403":{"description":"Returned if the user does not have permission to administer the project."},"404":{"description":"Returned if the project or property is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:project.property:jira"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/project/{projectIdOrKey}/restore":{"post":{"tags":["Projects"],"summary":"Restore deleted or archived project","description":"Restores a project that has been archived or placed in the Jira recycle bin.\n\n**[Permissions](#permissions) required:**\n\n *  *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)for Company managed projects.\n *  *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.","operationId":"restore","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"description\":\"This project was created as an example for REST.\",\"lead\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"components\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000,\"ari\":\"ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002\",\"metadata\":{\"icon\":\"https://www.example.com/icon.png\"}}],\"issueTypes\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1,\"hierarchyLevel\":0},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"hierarchyLevel\":0,\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\"}}}],\"url\":\"https://www.example.com\",\"email\":\"from-jira@example.com\",\"assigneeType\":\"PROJECT_LEAD\",\"versions\":[],\"name\":\"Example\",\"roles\":{\"Developers\":\"https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000\"},\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"properties\":{\"propertyKey\":\"propertyValue\"},\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2023-11-30T00:41:58.257+0000\"}}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the project is not found or the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type:jira","read:project:jira","read:project.property:jira","read:user:jira","write:project:jira","read:application-role:jira","read:avatar:jira","read:group:jira","read:issue-type-hierarchy:jira","read:project-category:jira","read:project-version:jira","read:project.component:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/project/{projectIdOrKey}/role":{"get":{"tags":["Project roles"],"summary":"Get project roles for project","description":"Returns a list of [project roles](https://confluence.atlassian.com/x/3odKLg) for the project returning the name and self URL for each role.\n\nNote 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.\n\nThis operation can be accessed anonymously.\n\n**[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).","operationId":"getProjectRoles","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"example":"{\"Administrators\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10002\",\"Users\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10001\",\"Developers\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10000\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing or if the user lacks administrative permissions for the project."},"404":{"description":"Returned if the project is not found or or if the user does not have administrative permissions for the project."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project-role:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}/role/{id}":{"get":{"tags":["Project roles"],"summary":"Get project role for project","description":"Returns a project role's details and actors associated with the project. The list of actors is sorted by display name.\n\nTo 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.\n\nThis operation can be accessed anonymously.\n\n**[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).","operationId":"getProjectRole","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"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":true,"schema":{"type":"integer","format":"int64"}},{"name":"excludeInactiveUsers","in":"query","description":"Exclude inactive users.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRole"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if:\n\n *  the project or project role is not found.\n *  the user does not have administrative permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:user:jira","read:group:jira","read:project-role:jira","read:project:jira","read:avatar:jira","read:project-category:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Project role actors"],"summary":"Set actors for project role","description":"Sets the actors for a project role for a project, replacing all existing actors.\n\nTo 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).\n\n**[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).","operationId":"setActors","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"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":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRoleActorsUpdateBean"},"example":{"categorisedActors":{"atlassian-group-role-actor-id":["952d12c3-5b5b-4d04-bb32-44d383afc4b2"],"atlassian-user-role-actor":["12345678-9abc-def1-2345-6789abcdef12"]}}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful. The complete list of actors for the project is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRole"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing or if the calling user lacks administrative permissions for the project."},"404":{"description":"Returned if:\n\n *  the project is not found.\n *  a user or group is not found.\n *  a group or user is not active."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:user:jira","read:group:jira","read:project-role:jira","read:project:jira","write:project-role:jira","read:avatar:jira","read:project-category:jira"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"},"post":{"tags":["Project role actors"],"summary":"Add actors to project role","description":"Adds actors to a project role for the project.\n\nTo replace all actors for the project, use [Set actors for project role](#api-rest-api-3-project-projectIdOrKey-role-id-put).\n\nThis operation can be accessed anonymously.\n\n**[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).","operationId":"addActorUsers","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"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":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActorsMap"},"example":{"groupId":["952d12c3-5b5b-4d04-bb32-44d383afc4b2"]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful. The complete list of actors for the project is returned.\n\nFor example, the cURL request above adds a group, *jira-developers*. For the response below to be returned as a result of that request, the user *Mia Krystof* would have previously been added as a `user` actor for this project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRole"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing or if the calling user lacks administrative permissions for the project."},"404":{"description":"Returned if:\n\n *  the project is not found.\n *  the user or group is not found.\n *  the group or user is not active."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:user:jira","read:group:jira","read:project-role:jira","read:project:jira","write:project-role:jira","read:avatar:jira","read:project-category:jira"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"},"delete":{"tags":["Project role actors"],"summary":"Delete actors from project role","description":"Deletes actors from a project role for the project.\n\nTo remove default actors from the project role, use [Delete default actors from project role](#api-rest-api-3-role-id-actors-delete).\n\nThis operation can be accessed anonymously.\n\n**[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).","operationId":"deleteActor","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"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":true,"schema":{"type":"integer","format":"int64"}},{"name":"user","in":"query","description":"The user account ID of the user to remove from the project role.","schema":{"type":"string","example":"5b10ac8d82e05b22cc7d4ef5"},"x-showInExample":"true"},{"name":"group","in":"query","description":"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.","schema":{"type":"string"}},{"name":"groupId","in":"query","description":"The ID of the group to remove from the project role. This parameter cannot be used with the `group` parameter.","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the request is not valid."},"404":{"description":"Returned if:\n\n *  the project or project role is not found.\n *  the calling user does not have administrative permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:project-role:jira"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/project/{projectIdOrKey}/roledetails":{"get":{"tags":["Project roles"],"summary":"Get project role details","description":"Returns all [project roles](https://confluence.atlassian.com/x/3odKLg) and the details for each role. Note that the list of project roles is common to all projects.\n\nThis operation can be accessed anonymously.\n\n**[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.","operationId":"getProjectRoleDetails","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}},{"name":"currentMember","in":"query","description":"Whether the roles should be filtered to include only those the user is assigned to.","schema":{"type":"boolean","default":false}},{"name":"excludeConnectAddons","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectRoleDetails"}},"example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"admin\":false,\"default\":true,\"roleConfigurable\":true,\"translatedName\":\"Developers\"}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the project is not found or if the user does not have the necessary permissions for the project."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project-category:jira","read:project-role:jira","read:project:jira","read:avatar:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}/statuses":{"get":{"tags":["Projects"],"summary":"Get all statuses for project","description":"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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.","operationId":"getAllStatuses","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IssueTypeWithStatus"}},"example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"name\":\"Task\",\"subtask\":false,\"statuses\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/status/10000\",\"description\":\"The issue is currently being worked on.\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/progress.gif\",\"name\":\"In Progress\",\"id\":\"10000\"},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/status/5\",\"description\":\"The issue is closed.\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/closed.gif\",\"name\":\"Closed\",\"id\":\"5\"}]}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the project is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-status:jira","read:issue-type:jira","read:status:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}/version":{"get":{"tags":["Project versions"],"summary":"Get project versions paginated","description":"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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.","operationId":"getProjectVersionsPaginated","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":50}},{"name":"orderBy","in":"query","description":"[Order](#ordering) the results by a field:\n\n *  `description` Sorts by version description.\n *  `name` Sorts by version name.\n *  `releaseDate` Sorts by release date, starting with the oldest date. Versions with no release date are listed last.\n *  `sequence` Sorts by the order of appearance in the user interface.\n *  `startDate` Sorts by start date, starting with the oldest date. Versions with no start date are listed last.","schema":{"type":"string","enum":["description","-description","+description","name","-name","+name","releaseDate","-releaseDate","+releaseDate","sequence","-sequence","+sequence","startDate","-startDate","+startDate"]}},{"name":"query","in":"query","description":"Filter the results using a literal string. Versions with matching `name` or `description` are returned (case insensitive).","schema":{"type":"string"}},{"name":"status","in":"query","description":"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`.","schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `issuesstatus` Returns the number of issues in each status category for each version.\n *  `operations` Returns actions that can be performed on the specified version.\n *  `driver` Returns the Atlassian account ID of the version driver.\n *  `approvers` Returns a list containing the approvers for this version.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanVersion"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=0&maxResults=2\",\"nextPage\":\"https://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=2&maxResults=2\",\"maxResults\":2,\"startAt\":0,\"total\":7,\"isLast\":false,\"values\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/version/10000\",\"id\":\"10000\",\"description\":\"An excellent version\",\"name\":\"New Version 1\",\"archived\":false,\"released\":true,\"releaseDate\":\"2010-07-06\",\"overdue\":true,\"userReleaseDate\":\"6/Jul/2010\",\"projectId\":10000},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/version/10010\",\"id\":\"10010\",\"description\":\"Minor Bugfix version\",\"name\":\"Next Version\",\"archived\":false,\"released\":false,\"overdue\":false,\"projectId\":10000,\"issuesStatusForFixVersion\":{\"unmapped\":0,\"toDo\":10,\"inProgress\":20,\"done\":100}}]}"}}},"404":{"description":"Returned if the project is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project-version:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}/versions":{"get":{"tags":["Project versions"],"summary":"Get project versions","description":"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.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.","operationId":"getProjectVersions","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information in the response. This parameter accepts `operations`, which returns actions that can be performed on the version.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Version"}},"example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/version/10000\",\"id\":\"10000\",\"description\":\"An excellent version\",\"name\":\"New Version 1\",\"archived\":false,\"released\":true,\"releaseDate\":\"2010-07-06\",\"overdue\":true,\"userReleaseDate\":\"6/Jul/2010\",\"projectId\":10000},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/version/10010\",\"id\":\"10010\",\"description\":\"Minor Bugfix version\",\"name\":\"Next Version\",\"archived\":false,\"released\":false,\"overdue\":false,\"projectId\":10000,\"issuesStatusForFixVersion\":{\"unmapped\":0,\"toDo\":10,\"inProgress\":20,\"done\":100}}]"}}},"404":{"description":"Returned if the project is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project-version:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectId}/email":{"get":{"tags":["Project email"],"summary":"Get project's sender email","description":"Returns the [project's sender email address](https://confluence.atlassian.com/x/dolKLg).\n\n**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.","operationId":"getProjectEmail","parameters":[{"name":"projectId","in":"path","description":"The project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectEmailAddress"},"example":"{\"emailAddress\":\"jira@example.customdomain.com\",\"emailAddressStatus\":[\"Email address or domain not verified.\"]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to read project."},"404":{"description":"Returned if the project or project's sender email address is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project.email:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Project email"],"summary":"Set project's sender email","description":"Sets the [project's sender email address](https://confluence.atlassian.com/x/dolKLg).\n\nIf `emailAddress` is an empty string, the default email address is restored.\n\n**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.","operationId":"updateProjectEmail","parameters":[{"name":"projectId","in":"path","description":"The project ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The project's sender email address to be set.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectEmailAddress"},"example":{"emailAddress":"jira@example.atlassian.net"}}},"required":true},"responses":{"204":{"description":"Returned if the project's sender email address is successfully set.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is not valid, if the email address is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to read project."},"404":{"description":"Returned if the project is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:project.email:jira"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/project/{projectId}/hierarchy":{"get":{"tags":["Projects"],"summary":"Get project issue type hierarchy","description":"Get the issue type hierarchy for a next-gen project.\n\nThe issue type hierarchy for a project consists of:\n\n *  *Epic* at level 1 (optional).\n *  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.\n *  *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.\n\n**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.","operationId":"getHierarchy","parameters":[{"name":"projectId","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectIssueTypeHierarchy"},"example":"{\"projectId\":10030,\"hierarchy\":[{\"entityId\":\"c4be66b3-f25b-444b-8145-78c695ea6cbd\",\"level\":0,\"name\":\"Base\",\"issueTypes\":[{\"id\":10008,\"entityId\":\"61b4742a-ade2-4089-a013-460dc479a41b\",\"name\":\"Story\",\"avatarId\":10324},{\"id\":10001,\"entityId\":\"589dc9be-86b3-4ed8-9880-09c91244c41b\",\"name\":\"Bug\",\"avatarId\":10324}]},{\"entityId\":\"9b684db1-f0a7-4d53-9979-3295746f328b\",\"level\":1,\"name\":\"Epic\",\"issueTypes\":[{\"id\":10007,\"entityId\":\"d5fa864b-e40e-4051-b7e4-70dd4d1b039e\",\"name\":\"Epic\",\"avatarId\":10179}]},{\"entityId\":\"cccc06d8-23db-4480-ad1e-0c91fc9967c8\",\"level\":-1,\"name\":\"Subtask\",\"issueTypes\":[{\"id\":10009,\"entityId\":\"fd4e41ec-1ff7-4bbd-adef-8a1651219508\",\"name\":\"Subtask\",\"avatarId\":10573}]}]}"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the project is not found or the user does not have the necessary permission."}},"deprecated":true,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-type:jira","read:issue-type-hierarchy:jira"]}],"x-changes":[{"announced":"2021-03-01","details":"https://community.developer.atlassian.com/t/45083","effective":"2021-09-01","type":"removed"}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectKeyOrId}/issuesecuritylevelscheme":{"get":{"tags":["Project permission schemes"],"summary":"Get project issue security scheme","description":"Returns the [issue security scheme](https://confluence.atlassian.com/x/J4lKLg) associated with the project.\n\n**[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).","operationId":"getProjectIssueSecurityScheme","parameters":[{"name":"projectKeyOrId","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issuesecurityschemes/10000\",\"id\":10000,\"name\":\"Default Issue Security Scheme\",\"description\":\"Description for the default issue security scheme\",\"defaultSecurityLevelId\":10021,\"levels\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/securitylevel/10021\",\"id\":\"10021\",\"description\":\"Only the reporter and internal staff can see this issue.\",\"name\":\"Reporter Only\"}]}"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the project is visible to the user but the user doesn't have administrative permissions."},"404":{"description":"Returned if the project is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-security-level:jira","read:issue-security-scheme:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectKeyOrId}/notificationscheme":{"get":{"tags":["Projects"],"summary":"Get project notification scheme","description":"Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg) associated with the project.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg).","operationId":"getNotificationSchemeForProject","parameters":[{"name":"projectKeyOrId","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `all` Returns all expandable information\n *  `field` Returns information about any custom fields assigned to receive an event\n *  `group` Returns information about any groups assigned to receive an event\n *  `notificationSchemeEvents` Returns a list of event associations. This list is returned for all expandable information\n *  `projectRole` Returns information about any project roles assigned to receive an event\n *  `user` Returns information about any users assigned to receive an event","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationScheme"},"example":"{\"expand\":\"notificationSchemeEvents,user,group,projectRole,field,all\",\"id\":10100,\"self\":\"https://your-domain.atlassian.net/rest/api/3/notificationscheme\",\"name\":\"notification scheme name\",\"description\":\"description\",\"notificationSchemeEvents\":[{\"event\":{\"id\":1,\"name\":\"Issue created\",\"description\":\"Event published when an issue is created\"},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"recipient\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"group\":{\"name\":\"jira-administrators\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"recipient\":\"10360\",\"projectRole\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"rest-developer@atlassian.com\",\"recipient\":\"rest-developer@atlassian.com\",\"emailAddress\":\"rest-developer@atlassian.com\"},{\"id\":5,\"notificationType\":\"User\",\"parameter\":\"5b10a2844c20165700ede21g\",\"recipient\":\"5b10a2844c20165700ede21g\",\"user\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"recipient\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"New custom field\",\"untranslatedName\":\"New custom field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New custom field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]},{\"event\":{\"id\":20,\"name\":\"Custom event\",\"description\":\"Custom event that is published together with an issue created event\",\"templateEvent\":{\"id\":1,\"name\":\"Issue created\",\"description\":\"Event published when an issue is created\"}},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"recipient\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"group\":{\"name\":\"jira-administrators\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"recipient\":\"10360\",\"projectRole\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"rest-developer@atlassian.com\",\"recipient\":\"rest-developer@atlassian.com\",\"emailAddress\":\"rest-developer@atlassian.com\"},{\"id\":5,\"notificationType\":\"User\",\"parameter\":\"5b10a2844c20165700ede21g\",\"recipient\":\"5b10a2844c20165700ede21g\",\"user\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"recipient\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"New custom field\",\"untranslatedName\":\"New custom field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New custom field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]}],\"projects\":[10001,10002]}"}}},"400":{"description":"Returned if the request is not valid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the project is not found or the user is not an administrator."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project-category:jira","read:project-role:jira","read:project:jira","read:user:jira","read:group:jira","read:field:jira","read:avatar:jira","read:field-configuration:jira","read:notification-scheme:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectKeyOrId}/permissionscheme":{"get":{"tags":["Project permission schemes"],"summary":"Get assigned permission scheme","description":"Gets the [permission scheme](https://confluence.atlassian.com/x/yodKLg) associated with the project.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg).","operationId":"getAssignedPermissionScheme","parameters":[{"name":"projectKeyOrId","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"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:\n\n *  `all` Returns all expandable information.\n *  `field` Returns information about the custom field granted the permission.\n *  `group` Returns information about the group that is granted the permission.\n *  `permissions` Returns all permission grants for each permission scheme.\n *  `projectRole` Returns information about the project role granted the permission.\n *  `user` Returns information about the user who is granted the permission.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionScheme"},"example":"{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/permissionscheme/10000\",\"name\":\"Example permission scheme\",\"description\":\"description\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have permission to view the project's configuration."},"404":{"description":"Returned if the project is not found or the user does not have permission to view the project."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:application-role:jira","read:field:jira","read:group:jira","read:permission-scheme:jira","read:permission:jira","read:project-role:jira","read:user:jira","read:avatar:jira","read:project-category:jira","read:project:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Project permission schemes"],"summary":"Assign permission scheme","description":"Assigns a permission scheme with a project. See [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for more information about permission schemes.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)","operationId":"assignPermissionScheme","parameters":[{"name":"projectKeyOrId","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"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:\n\n *  `all` Returns all expandable information.\n *  `field` Returns information about the custom field granted the permission.\n *  `group` Returns information about the group that is granted the permission.\n *  `permissions` Returns all permission grants for each permission scheme.\n *  `projectRole` Returns information about the project role granted the permission.\n *  `user` Returns information about the user who is granted the permission.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdBean"},"example":{"id":10000}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionScheme"},"example":"{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/permissionscheme/10000\",\"name\":\"Example permission scheme\",\"description\":\"description\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if:\n\n *  the user does not have the necessary permission to edit the project's configuration.\n *  the Jira instance is Jira Core Free or Jira Software Free. Permission schemes cannot be assigned to projects on free plans."},"404":{"description":"Returned if the project or permission scheme is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:application-role:jira","read:field:jira","read:group:jira","read:permission-scheme:jira","read:permission:jira","read:project-role:jira","read:user:jira","write:project:jira","read:avatar:jira","read:project-category:jira","read:project:jira"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/project/{projectKeyOrId}/securitylevel":{"get":{"tags":["Project permission schemes"],"summary":"Get project issue security levels","description":"Returns all [issue security](https://confluence.atlassian.com/x/J4lKLg) levels for the project that the user has access to.\n\nThis operation can be accessed anonymously.\n\n**[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.","operationId":"getSecurityLevelsForProject","parameters":[{"name":"projectKeyOrId","in":"path","description":"The project ID or project key (case sensitive).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectIssueSecurityLevels"},"example":"{\"levels\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/securitylevel/100000\",\"id\":\"100000\",\"description\":\"Only the reporter and internal staff can see this issue.\",\"name\":\"Reporter Only\"},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/securitylevel/100001\",\"id\":\"100001\",\"description\":\"Only internal staff can see this issue.\",\"name\":\"Staff Only\"}]}"}}},"404":{"description":"Returned if the project is not found or the user does not have permission to view it."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:issue-security-level:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/projectCategory":{"get":{"tags":["Project categories"],"summary":"Get all project categories","description":"Returns all project categories.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getAllProjectCategories","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectCategory"}},"example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10001\",\"id\":\"10001\",\"name\":\"SECOND\",\"description\":\"Second Project Category\"}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project-category:jira"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Project categories"],"summary":"Create project category","description":"Creates a project category.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createProjectCategory","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectCategory"},"example":{"description":"Created Project Category","name":"CREATED"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectCategory"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10100\",\"id\":\"10100\",\"name\":\"CREATED\",\"description\":\"Created Project Category\"}"}}},"400":{"description":"Returned if:\n\n *  `name` is not provided or exceeds 255 characters.\n *  `description` exceeds 1000 characters."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"409":{"description":"Returned if the project category name is in use."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:project-category:jira","read:project-category:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/projectCategory/{id}":{"get":{"tags":["Project categories"],"summary":"Get project category by ID","description":"Returns a project category.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getProjectCategoryById","parameters":[{"name":"id","in":"path","description":"The ID of the project category.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectCategory"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the project category is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project-category:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Project categories"],"summary":"Update project category","description":"Updates a project category.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updateProjectCategory","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectCategory"},"example":{"description":"Updated Project Category","name":"UPDATED"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatedProjectCategory"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10100\",\"id\":\"10100\",\"name\":\"UPDATED\",\"description\":\"Updated Project Category\"}"}}},"400":{"description":"Returned if:\n\n *  `name` has been modified and exceeds 255 characters.\n *  `description` has been modified and exceeds 1000 characters."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the project category is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project-category:jira","write:project-category:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Project categories"],"summary":"Delete project category","description":"Deletes a project category.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"removeProjectCategory","parameters":[{"name":"id","in":"path","description":"ID of the project category to delete.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the project category is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:project-category:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/projectvalidate/key":{"get":{"tags":["Project key and name validation"],"summary":"Validate project key","description":"Validates a project key by confirming the key is a valid string and not in use.\n\n**[Permissions](#permissions) required:** None.","operationId":"validateProjectKey","parameters":[{"name":"key","in":"query","description":"The project key.","schema":{"type":"string","example":"HSP"},"x-showInExample":"true"}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[],\"errors\":{\"projectKey\":\"A project with that project key already exists.\"}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project:jira"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/projectvalidate/validProjectKey":{"get":{"tags":["Project key and name validation"],"summary":"Get valid project key","description":"Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key.\n\n**[Permissions](#permissions) required:** None.","operationId":"getValidProjectKey","parameters":[{"name":"key","in":"query","description":"The project key.","schema":{"type":"string","example":"HSP"},"x-showInExample":"true"}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"string"},"example":"\"VPNE\""}}},"401":{"description":"Returned if the authentication credentials are incorrect."}},"deprecated":false,"security":[{"basicAuth":[]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/projectvalidate/validProjectName":{"get":{"tags":["Project key and name validation"],"summary":"Get valid project name","description":"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.\n\n**[Permissions](#permissions) required:** None.","operationId":"getValidProjectName","parameters":[{"name":"name","in":"query","description":"The project name.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"string"},"example":"\"Valid Project Name Example\""}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if a valid project name cannot be generated."}},"deprecated":false,"security":[{"basicAuth":[]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/resolution":{"get":{"tags":["Issue resolutions"],"summary":"Get resolutions","description":"Returns a list of all issue resolution values.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getResolutions","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Resolution"}},"example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/resolution/1\",\"id\":\"10000\",\"description\":\"A fix for this issue is checked into the tree and tested.\",\"name\":\"Fixed\"},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/resolution/3\",\"id\":\"10001\",\"description\":\"This is what it is supposed to do.\",\"name\":\"Works as designed\"}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."}},"deprecated":true,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:resolution:jira"]}],"x-changes":[{"announced":"2022-10-20","details":"https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-767","effective":"2023-04-20","type":"removed"}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Issue resolutions"],"summary":"Create resolution","description":"Creates an issue resolution.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createResolution","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResolutionDetails"},"example":{"description":"My resolution description","name":"My new resolution"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolutionId"},"example":"{\"id\":\"10001\"}"}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The length of the description must not exceed 255 characters.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/resolution/default":{"put":{"tags":["Issue resolutions"],"summary":"Set default resolution","description":"Sets default issue resolution.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"setDefaultResolution","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetDefaultResolutionRequest"},"example":{"id":"3"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The id has to be provided.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue resolution isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Priority with ID 10000 not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/resolution/move":{"put":{"tags":["Issue resolutions"],"summary":"Move resolutions","description":"Changes the order of issue resolutions.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"moveResolutions","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReorderIssueResolutionsRequest"},"example":{"after":"10002","ids":["10000","10001"]}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The IDs must contain no more than 1,000 items.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue resolution isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Resolution with ID 10000 not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/resolution/search":{"get":{"tags":["Issue resolutions"],"summary":"Search resolutions","description":"Returns a [paginated](#pagination) list of resolutions. The list can contain all resolutions or a subset determined by any combination of these criteria:\n\n *  a list of resolutions IDs.\n *  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.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"searchResolutions","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"string","default":"0"}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"string","default":"50"}},{"name":"id","in":"query","description":"The list of resolutions IDs to be filtered out","schema":{"type":"array","items":{"type":"string"}}},{"name":"onlyDefault","in":"query","description":"When set to true, return default only, when IDs provided, if none of them is default, return empty page. Default value is false","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanResolutionJsonBean"},"example":"{\"maxResults\":50,\"startAt\":0,\"total\":1,\"isLast\":true,\"values\":[{\"id\":\"10001\",\"description\":\"This is what it is supposed to do.\",\"name\":\"Works as designed\",\"isDefault\":true}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:resolution:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/resolution/{id}":{"get":{"tags":["Issue resolutions"],"summary":"Get resolution","description":"Returns an issue resolution value.\n\n**[Permissions](#permissions) required:** Permission to access Jira.","operationId":"getResolution","parameters":[{"name":"id","in":"path","description":"The ID of the issue resolution value.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resolution"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/resolution/1\",\"id\":\"10000\",\"description\":\"A fix for this issue is checked into the tree and tested.\",\"name\":\"Fixed\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"404":{"description":"Returned if the issue resolution value is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["read:jira-work"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["read:jira-work"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:resolution:jira"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Issue resolutions"],"summary":"Update resolution","description":"Updates an issue resolution.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updateResolution","parameters":[{"name":"id","in":"path","description":"The ID of the issue resolution.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateResolutionDetails"},"example":{"description":"My updated resolution description","name":"My updated resolution"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The length of the description must not exceed 255 characters.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue resolution isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Resolution with ID 10000 not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Issue resolutions"],"summary":"Delete resolution","description":"Deletes an issue resolution.\n\nThis 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deleteResolution","parameters":[{"name":"id","in":"path","description":"The ID of the issue resolution.","required":true,"schema":{"type":"string"}},{"name":"replaceWith","in":"query","description":"The ID of the issue resolution that will replace the currently selected resolution.","required":true,"schema":{"type":"string"}}],"responses":{"303":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskProgressBeanObject"}}}},"400":{"description":"Returned if the request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"The id has to be provided.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user doesn't have the necessary permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the issue resolution isn't found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Priority with ID 10000 not found.\"],\"errors\":{}}"}}},"409":{"description":"Returned if a task to delete the issue resolution is already running.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/role":{"get":{"tags":["Project roles"],"summary":"Get all project roles","description":"Gets a list of all project roles, complete with project role details and default actors.\n\n### About project roles ###\n\n[Project roles](https://confluence.atlassian.com/x/3odKLg) 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).\n\nProject 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.\n\n#### Members and actors ####\n\nIn 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.\n\nActors may be set as [default members](https://confluence.atlassian.com/x/3odKLg#Managingprojectroles-Specifying'defaultmembers'foraprojectrole) of the project role or set at the project level:\n\n *  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.\n *  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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getAllProjectRoles","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectRole"}},"example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have administrative permissions."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:user:jira","read:group:jira","read:project-role:jira","read:project:jira","read:avatar:jira","read:project-category:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Project roles"],"summary":"Create project role","description":"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.\n\n*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.*<\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createProjectRole","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateRoleRequestBean"},"example":{"description":"A project role that represents developers in a project","name":"Developers"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRole"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\"}"}}},"400":{"description":"Returned if the request is not valid. The `name` cannot be empty or start or end with whitespace."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have administrative permissions."},"409":{"description":"Returned if a project role with the provided name already exists."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:user:jira","read:group:jira","read:project:jira","write:project-role:jira","read:avatar:jira","read:project-category:jira","read:project-role:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/role/{id}":{"get":{"tags":["Project roles"],"summary":"Get project role by ID","description":"Gets the project role details and the default actors associated with the role. The list of default actors is sorted by display name.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getProjectRoleById","parameters":[{"name":"id","in":"path","description":"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":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRole"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have administrative permissions."},"404":{"description":"Returned if the project role is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:user:jira","read:group:jira","read:project-role:jira","read:project:jira","read:avatar:jira","read:project-category:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"put":{"tags":["Project roles"],"summary":"Fully update project role","description":"Updates the project role's name and description. You must include both a name and a description in the request.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"fullyUpdateProjectRole","parameters":[{"name":"id","in":"path","description":"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":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateRoleRequestBean"},"example":{"description":"A project role that represents developers in a project","name":"Developers"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRole"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}"}}},"400":{"description":"Returned if the request is not valid. The `name` cannot be empty or start or end with whitespace."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have administrative permissions."},"404":{"description":"Returned if the project role is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:user:jira","read:group:jira","read:project:jira","write:project-role:jira","read:avatar:jira","read:project-category:jira","read:project-role:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Project roles"],"summary":"Partial update project role","description":"Updates either the project role's name or its description.\n\nYou 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.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"partialUpdateProjectRole","parameters":[{"name":"id","in":"path","description":"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":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateRoleRequestBean"},"example":{"description":"A project role that represents developers in a project","name":"Developers"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRole"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have administrative permissions."},"404":{"description":"Returned if the project role is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:user:jira","read:group:jira","read:project:jira","write:project-role:jira","read:avatar:jira","read:project-category:jira","read:project-role:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Project roles"],"summary":"Delete project role","description":"Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deleteProjectRole","parameters":[{"name":"id","in":"path","description":"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":true,"schema":{"type":"integer","format":"int64"}},{"name":"swap","in":"query","description":"The ID of the project role that will replace the one being deleted.","schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the request is invalid or if the replacement project role is not found."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have administrative permissions."},"404":{"description":"Returned if the project role being deleted is not found."},"409":{"description":"Returned if the project role being deleted is in use and a replacement project role is not specified in the request."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:project-role:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/role/{id}/actors":{"get":{"tags":["Project role actors"],"summary":"Get default actors for project role","description":"Returns the [default actors](#api-rest-api-3-resolution-get) for the project role.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getProjectRoleActorsForRole","parameters":[{"name":"id","in":"path","description":"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":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRole"},"example":"{\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}}]}"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have administrative permissions."},"404":{"description":"Returned if the project role is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:user:jira","read:group:jira","read:project-role:jira","read:project:jira","read:avatar:jira","read:project-category:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Project role actors"],"summary":"Add default actors to project role","description":"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.\n\nChanging a project role's default actors does not affect project role members for projects already created.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"addProjectRoleActorsToRole","parameters":[{"name":"id","in":"path","description":"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":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActorInputBean"},"example":{"user":["admin"]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRole"},"example":"{\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}}]}"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have administrative permissions."},"404":{"description":"Returned if the project role is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:user:jira","read:group:jira","read:project-role:jira","read:project:jira","write:project-role:jira","read:avatar:jira","read:project-category:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Project role actors"],"summary":"Delete default actors from project role","description":"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.\n\nChanging a project role's default actors does not affect project role members for projects already created.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"deleteProjectRoleActorsFromRole","parameters":[{"name":"id","in":"path","description":"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":true,"schema":{"type":"integer","format":"int64"}},{"name":"user","in":"query","description":"The user account ID of the user to remove as a default actor.","schema":{"type":"string","example":"5b10ac8d82e05b22cc7d4ef5"},"x-showInExample":"true"},{"name":"groupId","in":"query","description":"The group ID of the group to be removed as a default actor. This parameter cannot be used with the `group` parameter.","schema":{"type":"string"}},{"name":"group","in":"query","description":"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.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRole"},"example":"{\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}}]}"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have administrative permissions."},"404":{"description":"Returned if the project role is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-configuration"]},{"state":"Beta","scheme":"OAuth2","scopes":["write:project-role:jira","read:user:jira","read:group:jira","read:project-role:jira","read:project:jira","read:avatar:jira","read:project-category:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/screens":{"get":{"tags":["Screens"],"summary":"Get screens","description":"Returns a [paginated](#pagination) list of all screens or those specified by one or more screen IDs.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getScreens","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.","schema":{"type":"integer","format":"int32","default":100}},{"name":"id","in":"query","description":"The list of screen IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"queryString","in":"query","description":"String used to perform a case-insensitive partial match with screen name.","schema":{"type":"string","default":""}},{"name":"scope","in":"query","description":"The scope filter string. To filter by multiple scope, provide an ampersand-separated list. For example, `scope=GLOBAL&scope=PROJECT`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["GLOBAL","TEMPLATE","PROJECT"]}}},{"name":"orderBy","in":"query","description":"[Order](#ordering) the results by a field:\n\n *  `id` Sorts by screen ID.\n *  `name` Sorts by screen name.","schema":{"type":"string","enum":["name","-name","+name","id","-id","+id"]}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanScreen"},"example":"{\"self\":\"https://your-domain.atlassian.net/rest/api/3/screens\",\"maxResults\":100,\"startAt\":0,\"total\":3,\"isLast\":true,\"values\":[{\"id\":1,\"name\":\"Default Screen\",\"description\":\"Provides for the update all system fields.\"},{\"id\":2,\"name\":\"Workflow Screen\",\"description\":\"This screen is used in the workflow and enables you to assign issues.\"},{\"id\":3,\"name\":\"Resolve Issue Screen\",\"description\":\"Offers the ability to set resolution, change fix versions, and assign an issue.\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project:jira","read:screen:jira","read:avatar:jira","read:project-category:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Screens"],"summary":"Create screen","description":"Creates a screen with a default field tab.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"createScreen","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenDetails"},"example":{"description":"Enables changes to resolution and linked issues.","name":"Resolve Security Issue Screen"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Screen"},"example":"{\"id\":10005,\"name\":\"Resolve Security Issue Screen\",\"description\":\"Enables changes to resolution and linked issues.\"}"}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The name is used by another screen.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the required permissions.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can manage screens.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project:jira","read:screen:jira","write:screen:jira","read:avatar:jira","read:project-category:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/screens/addToDefault/{fieldId}":{"post":{"tags":["Screens"],"summary":"Add field to default screen","description":"Adds a field to the default tab of the default screen.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"addFieldToDefaultScreen","parameters":[{"name":"fieldId","in":"path","description":"The ID of the field.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{}}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the field it not found or the field is already present."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project:jira","read:screen:jira","write:screen:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/screens/tabs":{"get":{"tags":["Screen tabs"],"summary":"Get bulk screen tabs","description":"Returns the list of tabs for a bulk of screens.\n\n**[Permissions](#permissions) required:**\n\n *  *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getBulkScreenTabs","parameters":[{"name":"screenId","in":"query","description":"The list of screen IDs. To include multiple screen IDs, provide an ampersand-separated list. For example, `screenId=10000&screenId=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"tabId","in":"query","description":"The list of tab IDs. To include multiple tab IDs, provide an ampersand-separated list. For example, `tabId=10000&tabId=10001`.","schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResult","in":"query","description":"The maximum number of items to return per page. The maximum number is 100,","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"example":"{\"maxResults\":100,\"startAt\":0,\"total\":2,\"isLast\":true,\"values\":[{\"screenId\":10000,\"tabId\":10001,\"tabName\":\"My Custom Tab 1\"},{\"screenId\":10001,\"tabId\":10002,\"tabName\":\"My Custom Tab 2\"}]}"}}},"400":{"description":"Returned if the screen ID or the tab ID is empty."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:screen-tab:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/screens/{screenId}":{"put":{"tags":["Screens"],"summary":"Update screen","description":"Updates a screen. Only screens used in classic projects can be updated.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"updateScreen","parameters":[{"name":"screenId","in":"path","description":"The ID of the screen.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateScreenDetails"},"example":{"description":"Enables changes to resolution and linked issues for accessibility related issues.","name":"Resolve Accessibility Issue Screen"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Screen"},"example":"{\"id\":10005,\"name\":\"Resolve Security Issue Screen\",\"description\":\"Enables changes to resolution and linked issues.\"}"}}},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The name is used by another screen.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can manage screens.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the screen is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The screen was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:project:jira","read:screen:jira","write:screen:jira","read:avatar:jira","read:project-category:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Screens"],"summary":"Delete screen","description":"Deletes a screen. A screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft.\n\nOnly screens used in classic projects can be deleted.","operationId":"deleteScreen","parameters":[{"name":"screenId","in":"path","description":"The ID of the screen.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the request is not valid.","content":{"application/json":{"example":"{\"errorMessages\":[\"The screen is used in a screen scheme.\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission.","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can manage screens.\"],\"errors\":{}}"}}},"404":{"description":"Returned if the screen is not found.","content":{"application/json":{"example":"{\"errorMessages\":[\"The screen was not found.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["delete:screen:jira"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/screens/{screenId}/availableFields":{"get":{"tags":["Screens"],"summary":"Get available screen fields","description":"Returns the fields that can be added to a tab on a screen.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"getAvailableScreenFields","parameters":[{"name":"screenId","in":"path","description":"The ID of the screen.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScreenableField"}}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the screen is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:screen-field:jira","read:screenable-field:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/screens/{screenId}/tabs":{"get":{"tags":["Screen tabs"],"summary":"Get all screen tabs","description":"Returns the list of tabs for a screen.\n\n**[Permissions](#permissions) required:**\n\n *  *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).\n *  *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.","operationId":"getAllScreenTabs","parameters":[{"name":"screenId","in":"path","description":"The ID of the screen.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"projectKey","in":"query","description":"The key of the project.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScreenableTab"}}}}},"400":{"description":"Returned if the screen ID is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the screen is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:screen-tab:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Screen tabs"],"summary":"Create screen tab","description":"Creates a tab for a screen.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"addScreenTab","parameters":[{"name":"screenId","in":"path","description":"The ID of the screen.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenableTab"},"example":{"name":"Fields Tab"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenableTab"},"example":"{\"id\":10000,\"name\":\"Fields Tab\"}"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the screen is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:screen-tab:jira","write:screen-tab:jira"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/screens/{screenId}/tabs/{tabId}":{"put":{"tags":["Screen tabs"],"summary":"Update screen tab","description":"Updates the name of a screen tab.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).","operationId":"renameScreenTab","parameters":[{"name":"screenId","in":"path","description":"The ID of the screen.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tabId","in":"path","description":"The ID of the screen tab.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenableTab"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenableTab"},"example":"{\"id\":10000,\"name\":\"Fields Tab\"}"}}},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing."},"403":{"description":"Returned if the user does not have the necessary permission."},"404":{"description":"Returned if the screen or screen tab is not found."}},"deprecated":false,"security":[{"basicAuth":[]},{"OAuth2":["manage:jira-project"]},{}],"x-atlassian-oauth2-scopes":[{"state":"Current","scheme":"OAuth2","scopes":["manage:jira-project"]},{"state":"Beta","scheme":"OAuth2","scopes":["read:screen-tab:jira","write:screen-tab:jira"]}],"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Screen tabs"],"summary":"Delete screen tab","description":"Deletes a screen tab.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission