META-INF.jira-cloud-v3.openapi.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.everit.atlassian.restclient.jiracloud Show documentation
Jira Cloud REST Client generated with OpenAPITools that uses RXJava for asynchornous processing. Version in JSON: 1001.0.0
There is a newer version: 5.0.0-202311131527
Show newest version
{"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":"[email protected]"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"version":"1001.0.0-SNAPSHOT"},"externalDocs":{"description":"Find out more about Atlassian products and services.","url":"http://www.atlassian.com"},"servers":[{"url":""}],"tags":[{"name":"ApplicationRole","description":"This resource represents application roles. Use it to get details of an application role or all application roles.
\n"},{"name":"Auditing","description":"This resource represents audits that record activities undertaken in Jira. Use it to get a list of audit records.
\n"},{"name":"UniversalAvatar","description":"This resource represents system and custom avatars. Use it to obtain the details of system or custom avatars as well as add and remove avatars from a project or issue type.
\n"},{"name":"Dashboard","description":"This resource represents dashboards. Use it to obtain the details of dashboards as well as add and remove item properties from dashboards.
\n"},{"name":"Filter","description":"This resource represents filters. Use it to get, create, update, or delete filters. Also use it to configure the columns for a filter and set favorite filters.
\n"},{"name":"Filter","description":"This resource represents options for sharing filters. Use it to get share scopes as well as add and remove share scopes from filters.
\n"},{"name":"GroupAndUserPicker","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.
\n"},{"name":"GroupPicker","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.
\n"},{"name":"Issue","description":"This resource represents Jira issues. Use it to:
\n\ncreate or edit issues, individually or in bulk.
\nretrieve metadata about the options for creating or editing issues.
\ndelete an issue.
\nassign a user to an issue.
\nget issue changelogs.
\nsend notifications about an issue.
\nget details of the transitions available for an issue.
\ntransition an issue.
\n
\n"},{"name":"IssueAttachments","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.
\n"},{"name":"IssueComment","description":"This resource represents issue comments. Used it to:
\n\nget, create, update, and delete a comment from an issue.
\nget all comments from issue.
\nget a list of comments by comment ID.
\n
\n"},{"name":"CommentProperty","description":"This resource represents issue comment 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.
\n"},{"name":"FieldSearch","description":"This resource represents issue fields, both system and custom fields, including options on custom fields. Use it to get fields, create and update fields (custom fields only), and get an option from a custom field.
\n"},{"name":"IssueFieldOption","description":"This resource represents the options for a select list issue field.
\nA select list issue field is a type of issue field that enables a user to select an option from a list. Use this resource to add, remove, and update the options of a select list issue field.
\nNote that this resource cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps.
\n"},{"name":"LinkIssue","description":"This resource represents links between issues. Use it to get, create, and delete links between issues.
\nTo use this resource, the site must have issue linking enabled.
\n"},{"name":"IssueLinkType","description":"This resource represents issue link types. Use it to get, create, update, and delete link issue types as well as get lists of all link issue types.
\nTo use this resource, the site must have issue linking enabled.
\n"},{"name":"Settings","description":"This resource represents issue navigator settings. Use it to get and set issue navigator default columns.
\n"},{"name":"NotificationScheme","description":"This resource represents notification schemes, lists of events and the recipients who will receive notifications for those events. Use this resource to get details of a notification scheme and a list of notification schemes.
\n"},{"name":"Priority","description":"This resource represents issue priorities. Use it to obtain a list of issue priorities and details for individual issue priorities.
\n"},{"name":"IssueProperty","description":"This resource represents issue 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.
\n"},{"name":"Issue","description":"This resource represents remote issue links, a way of linking Jira to information in other systems. Use this resource 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.
\n"},{"name":"Resolution","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.
\n"},{"name":"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.
\n"},{"name":"IssueSecurityLevel","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.
\n"},{"name":"IssueSecurityScheme","description":"This resource represents issue security schemes. Use it to get an issue security scheme or list of issues security schemes.
\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.
\n"},{"name":"IssueType","description":"This resource represents issues types. Use it to:
\n\nget, create, update, and delete issue types.
\nget all issue types for a user.
\nget alternative issue types.
\nset an avatar for an issue type.
\n
\n"},{"name":"Hierarchy","description":"This resource represents issues type hierarchies. Use it to:
\n\nget the hierarchy.
\n
\n"},{"name":"IssueTypeProperty","description":"This resource represents issue type 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.
\n"},{"name":"Issue","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.
\n"},{"name":"Issue","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.
\n"},{"name":"Worklog","description":"This resource represents issue worklogs. Use it to:
\n\nget, create, update, and delete worklogs.
\nobtain lists of updated or deleted worklogs.
\n
\n"},{"name":"WorklogProperty","description":"This resource represents issue worklog 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.
\n"},{"name":"JiraExpressions","description":"This resource is a collection of operations for Jira expressions.
\n"},{"name":"Configuration","description":"This resource represents various settings in Jira. Use it to get and update Jira settings and properties.
\n"},{"name":"JQLPersonalDataMigration","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 an operation to convert one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.
\n"},{"name":"Label","description":"This resource represents available labels. Use it to get available labels for the global label field.
\n"},{"name":"CurrentUser","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.
\n"},{"name":"Permissions","description":"This resource represents permissions. Use it to obtain details of all permissions and determine whether the user has certain permissions.
\n"},{"name":"PermissionScheme","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.
\n"},{"name":"ProjectNotificationScheme","description":"This resource represents projects. Use this resource 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.
\n"},{"name":"Project","description":"This resource represents avatars associated with a project. Use it to get, load, set, and remove project avatars.
\n"},{"name":"ProjectCategory","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.
\n"},{"name":"Project","description":"This resource represents project components. Uses to get, create, update, and delete project components. Also get components for project and get a count of issues by component.
\n"},{"name":"ProjectValidate","description":"This resource provides validation for project keys and names.
\n"},{"name":"ProjectSecurityLevel","description":"This resource represents permission schemes for a project. Use this resource to:
\n\nget details of a project's issue security levels available to the calling user.
\nget the permission scheme associated with the project or assign different permission scheme to the project.
\nget details of a project's issue security scheme.
\n
\nSee Managing project permissions for more information about permission schemes.
\n"},{"name":"ProjectProperty","description":"This resource represents project 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.
\n"},{"name":"Role","description":"This resource represents the roles that users can play in projects. Use this resource to get, create, update, and delete project roles.
\n"},{"name":"Role","description":"This resource represents the users assigned to project roles. Use this resource to get, add, and remove default users from project roles. Also use this resource to add and remove users from a project role associated with a project.
\n"},{"name":"ProjectType","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.
\n"},{"name":"Version","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.
\n"},{"name":"Screens","description":"This resource represents the screens used to record issue details. Use this resource to:
\n\nget details of all screens.
\nget details of all the fields available for use on screens.
\nadd a field to the default screen.
\nget, create, update, move, and delete screen tabs.
\nget, add, move, and remove fields from screen tabs.
\n
\n"},{"name":"ServerInfo","description":"This resource provides information about the Jira instance.
\n"},{"name":"Task","description":"This resource represents a long-running asynchronous tasks. Use it to obtain details about the progress of a long-running task or cancel a long-running task.
\n"},{"name":"TimeTracking","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.
\n"},{"name":"Users","description":"This resource represent users. Use this resource to:
\n\nget, get a list of, create, and delete users.
\nget, set, and reset a user's default issue table columns.
\nget a list of the groups the user belongs to.
\nget a list of user account IDs for a list of usernames or user keys.
\n
\n"},{"name":"UserProperty","description":"This resource represents user properties, which 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. User properties are a type of entity property.
\n"},{"name":"User","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. If you want to get a list of all users please use the https:///rest/api/3/users/search endpoint instead.
\n"},{"name":"DynamicWebhook","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 apps can register webhooks. For more information, see Webhooks.
\n"},{"name":"WorkflowSearch","description":"This resource represents workflows. Use it to get a list of workflows.
\n"},{"name":"WorkflowRuleConfig","description":"This resource represents workflow transition rules. Workflow transition rules define a Connect app routine, such as a workflow post functions that is executed in association with the workflow. Use this resource to read and modify configuration of workflow transition rules.
\n"},{"name":"WorkflowScheme","description":"This resource represents workflow schemes. Use this resource to manage workflow schemes and the workflow scheme's workflows and issue types.
\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.
\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).
\nSee Configuring workflow schemes for more information.
\n"},{"name":"WorkflowSchemeProject","description":"This resource represents the associations between workflow schemes and projects.
\nFor more information, see Managing your workflows.
\n"},{"name":"WorkflowScheme","description":"This resource represents draft workflow schemes. Use this resource to manage drafts of workflow schemes.
\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.
\nActive workflow schemes (workflow schemes that are used by projects) cannot be edited. Edting 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).
\nSee Configuring workflow schemes for more information.
\n"},{"name":"Status","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.
\n"},{"name":"StatusCategory","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.
\n"},{"name":"WorkflowTransition","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.
\n"},{"name":"AddonProperties","description":"This resource represents app properties. Use it to store arbitrary data for your\nConnect app.
\n"},{"name":"DynamicModules","description":"This resource represents modules registered dynamically\nby Connect apps.
\n"}],"paths":{"/rest/api/3/application-properties":{"get":{"tags":["ApplicationProperties"],"summary":"Get application property","description":"Returns all application properties or an application property.
\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 for descriptions of editable properties.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getApplicationProperty","parameters":[{"name":"key","in":"query","description":"The key of the application property.
\n","schema":{"type":"string"}},{"name":"permissionLevel","in":"query","description":"The permission level of all items being returned in the list.
\n","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..
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"404":{"description":"Returned if the application property is not found or the user does not have permission to view it.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/application-properties/advanced-settings":{"get":{"tags":["ApplicationProperties"],"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).
\nPermissions required: Administer Jira global permission.
\n","operationId":"getAdvancedSettings","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"403":{"description":"Returned if the user is not an administrator.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/application-properties/{id}":{"put":{"tags":["ApplicationProperties"],"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.
\nAdvanced settings
\nThe advanced settings below are also accessible in Jira.
\n \n  \n   \n    \n    \n    \n   \n  \n  \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n  \nKey Description Default value
jira.clone.prefix A string of text that automatically precedes the title of a cloned issue. CLONE -
jira.date.picker.java.format The date format for the Java (server-side) generated dates. This must be the same as the jira.date.picker.javascript.format format setting. d/MMM/yy
jira.date.picker.javascript.format This date format is for the JavaScript (client-side) generated dates. This must be the same as the jira.date.picker.java.format format setting. %e/%b/%y
jira.date.time.picker.java.format The date format for the Java (server-side) generated date times. This must be the same as the jira.date.time.picker.javascript.format format setting. dd/MMM/yy h:mm a
jira.date.time.picker.javascript.format This date format is for the JavaScript (client-side) generated date times. This must be the same as the jira.date.time.picker.java.format format setting. %e/%b/%y %I:%M %p
jira.issue.actions.order The default order of actions (such as Comments or Change history) displayed on the issue view. asc
jira.table.cols.subtasks The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue. issuetype, status, assignee, progress
jira.view.issue.links.sort.order The sort order of the list of issue links on the issue view. type, status, priority
jira.comment.collapsing.minimum.hidden The minimum number of comments required for comment collapsing to occur. A value of 0 disables comment collapsing. 4
jira.newsletter.tip.delay.days The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of -1 disables this functionality. 7
\nLook and feel
\nThe settings listed below adjust the look and feel.
\n \n  \n   \n    \n    \n    \n   \n  \n  \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n   \n    \n    \n    \n   \n  \nKey Description Default value
jira.lf.date.time Look and feel of the time format. h:mm a
jira.lf.date.day Look and feel of the day format. EEEE h:mm a
jira.lf.date.complete Look and feel of the date and time format. dd/MMM/yy h:mm a
jira.lf.date.dmy Look and feel of the date format. dd/MMM/yy
jira.date.time.picker.use.iso8061 When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard. false
jira.lf.logo.url The URL of the logo image file. /images/icon-jira-logo.png
jira.lf.logo.show.application.title Controls the visibility of the application title on the sidebar. false
jira.lf.favicon.url The URL of the favicon. /favicon.ico
jira.lf.favicon.hires.url The URL of the high resolution favicon. /images/64jira.png
jira.lf.top.adg3.bgcolour The background color of the sidebar. #0747A6
jira.lf.top.adg3.textcolour The color of the text and logo of the sidebar. #DEEBFF
jira.lf.hero.button.base.bg.colour #3b7fc4
jira.title The text for the application title. The application title can also be set in General settings. Jira
jira.option.globalsharing boolean true
xflow.product.suggestions.enabled Indicates whether to expose product suggestions for other Atlassian products within Jira. true
\nOther settings
\n \n  \n   \n    \n    \n    \n   \n  \n  \n   \n    \n    \n    \n   \n  \nKey Description Default value
jira.issuenav.criteria.autoupdate Supports instant updates to search criteria. true
\nNote: Be careful when changing application properties and advanced settings.
\nPermissions required: Administer Jira global permission.
\n","operationId":"setApplicationProperty","parameters":[{"name":"id","in":"path","description":"The key of the application property to update.
\n","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.
\n","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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have permission to edit the property.
\n"},"404":{"description":"Returned if the property is not found or the user does not have permission to view it.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/applicationrole":{"get":{"tags":["ApplicationRole"],"summary":"Get all application roles","description":"Returns all application roles. In Jira, application roles are managed using the Application access configuration page.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getAllApplicationRoles","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationRole"}},"example":"[{\"key\":\"jira-software\",\"groups\":[\"jira-software-users\",\"jira-testers\"],\"name\":\"Jira Software\",\"defaultGroups\":[\"jira-software-users\"],\"selectedByDefault\":false,\"defined\":false,\"numberOfSeats\":10,\"remainingSeats\":5,\"userCount\":5,\"userCountDescription\":\"5 developers\",\"hasUnlimitedSeats\":false,\"platform\":false},{\"key\":\"jira-core\",\"groups\":[\"jira-core-users\"],\"name\":\"Jira Core\",\"defaultGroups\":[\"jira-core-users\"],\"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.
\n"},"403":{"description":"Returned if the user is not an administrator.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/applicationrole/{key}":{"get":{"tags":["ApplicationRole"],"summary":"Get application role","description":"Returns an application role.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getApplicationRole","parameters":[{"name":"key","in":"path","description":"The key of the application role. Use the Get all application roles operation to get the key for each application role.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationRole"},"example":"{\"key\":\"jira-software\",\"groups\":[\"jira-software-users\",\"jira-testers\"],\"name\":\"Jira Software\",\"defaultGroups\":[\"jira-software-users\"],\"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.
\n"},"403":{"description":"Returned if the user is not an administrator.
\n"},"404":{"description":"Returned if the role is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/attachment/meta":{"get":{"tags":["Attachment"],"summary":"Get Jira attachment settings","description":"Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed.
\nNote that there are also project permissions that restrict whether users can create and delete attachments.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getAttachmentMeta","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentSettings"},"example":"{\"enabled\":true,\"uploadLimit\":1000000}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/attachment/{id}":{"get":{"tags":["Attachment"],"summary":"Get attachment metadata","description":"Returns the metadata for an attachment. Note that the attachment itself is not returned.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"getAttachment","parameters":[{"name":"id","in":"path","description":"The ID of the attachment.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-05T04:31:46.734+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"https://your-domain.atlassian.net/jira/attachments/10000\",\"thumbnail\":\"https://your-domain.atlassian.net/jira/secure/thumbnail/10000\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if:
\n\nthe attachment is not found.
\nattachments are disabled in the Jira settings.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"delete":{"tags":["Attachment"],"summary":"Delete attachment","description":"Deletes an attachment from an issue.
\nThis operation can be accessed anonymously.
\nPermissions required: For the project holding the issue containing the attachment:
\n\nDelete own attachments project permission to delete an attachment created by the calling user.
\nDelete all attachments project permission to delete an attachment created by any user.
\n
\n","operationId":"removeAttachment","parameters":[{"name":"id","in":"path","description":"The ID of the attachment.
\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if:
\n\nthe attachment is not found.
\nattachments are disabled in the Jira settings.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/attachment/{id}/expand/human":{"get":{"tags":["Attachment"],"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.
\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, which only returns the metadata for the attachment's contents.
\nThis operation can be accessed anonymously.
\nPermissions required: For the issue containing the attachment:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"expandAttachmentForHumans","parameters":[{"name":"id","in":"path","description":"The ID of the attachment.
\n","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.
\n","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.
\n"},"403":{"description":"The user does not have the required permissions.
\n"},"404":{"description":"Returned if:
\n\nthe attachment is not found.
\nattachments are disabled in the Jira settings.
\n
\n"},"409":{"description":"Returned if the attachment is an archive, but not a supported archive format.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/attachment/{id}/expand/raw":{"get":{"tags":["Attachment"],"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.
\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 which also returns the metadata for the attachment itself, such as the attachment's ID and name.
\nThis operation can be accessed anonymously.
\nPermissions required: For the issue containing the attachment:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"expandAttachmentForMachines","parameters":[{"name":"id","in":"path","description":"The ID of the attachment.
\n","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.
\n","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.
\n"},"403":{"description":"The user does not have the required permissions.
\n"},"404":{"description":"Returned if:
\n\nthe attachment is not found.
\nattachments are disabled in the Jira settings.
\n
\n"},"409":{"description":"Returned if the attachment is an archive, but not a supported archive format.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/auditing/record":{"get":{"tags":["Auditing"],"summary":"Get audit records","description":"Returns a list of audit records. The list can be filtered to include items:
\n\ncontaining a string in at least one field. For example, providing up will return all audit records where one or more fields contains words such as update.
\ncreated on or after a date and time.
\ncreated or or before a date and time.
\ncreated during a time period.
\n
\nPermissions required: Administer Jira global permission.
\n","operationId":"getAuditRecords","parameters":[{"name":"offset","in":"query","description":"The number of records to skip before returning the first result.
\n","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of results to return. The maximum is 1000.
\n","schema":{"type":"integer","format":"int32","default":1000}},{"name":"filter","in":"query","description":"The query string.
\n","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.
\n","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.
\n","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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\",\"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\":\"[email protected]\",\"changedTo\":\"[email protected]\"}],\"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.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/avatar/{type}/system":{"get":{"tags":["Avatar"],"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.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getAllSystemAvatars","parameters":[{"name":"type","in":"path","description":"The avatar type.
\n","required":true,"schema":{"type":"string","enum":["issuetype","project","user"]}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"500":{"description":"Returned if an error occurs while retrieving the list of avatars.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/comment/list":{"post":{"tags":["IssueCommentList"],"summary":"Get comments by IDs","description":"Returns the comments for a list of comment IDs.
\nThis operation can be accessed anonymously.
\nPermissions required: Comments are returned where the user:
\n\nhas Browse projects project permission for the project containing the comment.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nIf the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
\n
\n","operationId":"getCommentsByIds","parameters":[{"name":"expand","in":"query","description":"Use expand to include additional information about comments in the response. This parameter accepts multiple values separated by a comma:
\n\nrenderedBody Returns the comment body rendered in HTML.
\nproperties Returns the comment's properties.
\n
\n","schema":{"type":"string"}}],"requestBody":{"description":"The list of comment IDs.
\n","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.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanComment"},"example":"{\"maxResults\":1048576,\"startAt\":0,\"total\":1,\"isLast\":true,\"values\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"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\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-05T04:31:45.088+0000\",\"updated\":\"2019-09-05T04:31:45.089+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}]}"}}},"400":{"description":"Returned if the request contains more than 1000 IDs or is empty.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/comment/{commentId}/properties":{"get":{"tags":["CommentProperty"],"summary":"Get comment property keys","description":"Returns the keys of all the properties of a comment.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nIf the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
\n
\n","operationId":"getCommentPropertyKeys","parameters":[{"name":"commentId","in":"path","description":"The ID of the comment.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyKeys"},"example":"{\"keys\":[{\"self\":\"http://your-domain.atlassian.net/jira/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"}}},"400":{"description":"Returned if the comment ID is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the comment is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/comment/{commentId}/properties/{propertyKey}":{"get":{"tags":["CommentProperty"],"summary":"Get comment property","description":"Returns the value of a comment property.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nIf the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
\n
\n","operationId":"getCommentProperty","parameters":[{"name":"commentId","in":"path","description":"The ID of the comment.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the comment or the property is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["CommentProperty"],"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.
\nThe value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
\nPermissions required: either of:
\n\nEdit All Comments project permission to create or update the value of a property on any comment.
\nEdit Own Comments project permission 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.
\n","operationId":"setCommentProperty","parameters":[{"name":"commentId","in":"path","description":"The ID of the comment.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property. The maximum length is 255 characters.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{}}},"required":true},"responses":{"200":{"description":"Returned if the comment property is updated.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"Returned if the comment property is created.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the comment is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["CommentProperty"],"summary":"Delete comment property","description":"Deletes a comment property.
\nPermissions required: either of:
\n\nEdit All Comments project permission to delete a property from any comment.
\nEdit Own Comments project permission 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.
\n","operationId":"deleteCommentProperty","parameters":[{"name":"commentId","in":"path","description":"The ID of the comment.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property.
\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required project permissions.
\n"},"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.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/component":{"post":{"tags":["Component"],"summary":"Create component","description":"Creates a component. Use components to provide containers for issues within a project.
\nThis operation can be accessed anonymously.
\nPermissions required: Administer projects project permission for the project in which the component is created or Administer Jira global permission.
\n","operationId":"createComponent","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Component"},"example":{"isAssigneeTypeValid":false,"name":"Component 1","description":"This is a Jira component","project":"HSP","assigneeType":"PROJECT_LEAD","leadAccountId":"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Component"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000}"}}},"400":{"description":"Returned if:
\n\nThe user is not found.
\nname is not provided.
\nname is over 255 characters in length.
\nprojectId is not provided.
\nassigneeType is an invalid value.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"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.
\n"},"404":{"description":"Returned if the project is not found or the user does not have permission to browse the project containing the component.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/component/{id}":{"get":{"tags":["Component"],"summary":"Get component","description":"Returns a component.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse projects project permission for project containing the component.
\n","operationId":"getComponent","parameters":[{"name":"id","in":"path","description":"The ID of the component.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Component"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the component is not found or the user does not have permission to browse the project containing the component.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Component"],"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.
\nThis operation can be accessed anonymously.
\nPermissions required: Administer projects project permission for the project containing the component or Administer Jira global permission.
\n","operationId":"updateComponent","parameters":[{"name":"id","in":"path","description":"The ID of the component.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Component"},"example":{"isAssigneeTypeValid":false,"name":"Component 1","description":"This is a Jira component","assigneeType":"PROJECT_LEAD","leadAccountId":"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Component"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000}"}}},"400":{"description":"Returned if:
\n\nthe user is not found.
\nassigneeType is an invalid value.
\nname is over 255 characters in length.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"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.
\n"},"404":{"description":"Returned if the component is not found or the user does not have permission to browse the project containing the component.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"},"delete":{"tags":["Component"],"summary":"Delete component","description":"Deletes a component.
\nThis operation can be accessed anonymously.
\nPermissions required: Administer projects project permission for the project containing the component or Administer Jira global permission.
\n","operationId":"deleteComponent","parameters":[{"name":"id","in":"path","description":"The ID of the component.
\n","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.
\n","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"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.
\n"},"404":{"description":"Returned if:
\n\nthe component is not found.
\nthe replacement component is not found.
\nthe user does not have permission to browse the project containing the component.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/component/{id}/relatedIssueCounts":{"get":{"tags":["Component"],"summary":"Get component issues count","description":"Returns the counts of issues assigned to the component.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getComponentRelatedIssues","parameters":[{"name":"id","in":"path","description":"The ID of the component.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComponentIssuesCount"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"issueCount\":23}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the component is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/configuration":{"get":{"tags":["Configuration"],"summary":"Get global settings","description":"Returns the global settings in Jira. These settings determine whether optional features (for example, subtasks, time tracking, and others) are enabled. If time tracking is enabled, this operation also returns the time tracking configuration.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getConfiguration","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/configuration/timetracking":{"get":{"tags":["TimeTracking"],"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.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getSelectedTimeTrackingImplementation","parameters":[],"responses":{"200":{"description":"Returned if the request is successful and time tracking is enabled.
\n","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.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"READ"},"put":{"tags":["TimeTracking"],"summary":"Select time tracking provider","description":"Selects a time tracking provider.
\nPermissions required: Administer Jira global permission.
\n","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.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if the time tracking provider is not found.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["TimeTracking"],"summary":"Disable time tracking","description":"Disables time tracking.
\nPermissions required: Administer Jira global permission.
\n","operationId":"disableTimeTracking","parameters":[],"responses":{"204":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"}},"deprecated":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/configuration/timetracking/list":{"get":{"tags":["TimeTracking"],"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 module.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getAvailableTimeTrackingImplementations","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/configuration/timetracking/options":{"get":{"tags":["TimeTracking"],"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.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getSharedTimeTrackingConfiguration","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"READ"},"put":{"tags":["TimeTracking"],"summary":"Set time tracking settings","description":"Sets the time tracking settings.
\nPermissions required: Administer Jira global permission.
\n","operationId":"setSharedTimeTrackingConfiguration","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeTrackingConfiguration"},"example":{"defaultUnit":"hour","workingHoursPerDay":7.6,"workingDaysPerWeek":5.5,"timeFormat":"pretty"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/customFieldOption/{id}":{"get":{"tags":["CustomFieldOption"],"summary":"Get custom field option","description":"Returns a custom field option. For example, an option in a cascading select list.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getCustomFieldOption","parameters":[{"name":"id","in":"path","description":"The ID of the custom field option. To find this ID,  configure the custom field and edit its options in Jira. Click the option and its ID will show in the URL as the selectedParentOptionId parameter.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"404":{"description":"Returned if:
\n\nthe custom field option is not found.
\nthe user does not have permission to view the custom field.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/dashboard":{"get":{"tags":["Dashboard"],"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.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getAllDashboards","parameters":[{"name":"filter","in":"query","description":"The filter applied to the list of dashboards. Valid values are:
\n\nfavourite Returns dashboards the user has marked as favorite.
\nmy Returns dashboards owned by the user.
\n
\n","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).
\n","schema":{"type":"integer","format":"int32","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 1000.
\n","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfDashboards"},"example":"{\"startAt\":10,\"maxResults\":10,\"total\":143,\"prev\":\"http://your-domain.atlassian.net/rest/api/3/dashboard?startAt=0\",\"next\":\"http://your-domain.atlassian.net/rest/api/3/dashboard?startAt=10\",\"dashboards\":[{\"id\":\"10000\",\"isFavourite\":false,\"name\":\"System Dashboard\",\"popularity\":1,\"self\":\"http://your-domain.atlassian.net/rest/api/3/dashboard/10000\",\"sharePermissions\":[{\"type\":\"global\"}],\"view\":\"http://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000\"},{\"id\":\"20000\",\"isFavourite\":true,\"name\":\"Build Engineering\",\"owner\":{\"key\":\"fred\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=26912:8347-414d-ef131-ac0318367469\",\"name\":\"fred\",\"displayName\":\"Fred F. User\",\"avatarUrls\":{\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=fred\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=fred\",\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=fred\"}},\"popularity\":1,\"self\":\"http://your-domain.atlassian.net/rest/api/3/dashboard/20000\",\"sharePermissions\":[{\"id\":10105,\"type\":\"group\",\"group\":{\"name\":\"administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=administrators\"}}],\"view\":\"http://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=20000\"}]}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/dashboard/search":{"get":{"tags":["Dashboard"],"summary":"Search for dashboards","description":"Searches for dashboards. This operation is similar to Get dashboards except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned.
\nThis operation can be accessed anonymously.
\nPermissions required: The following dashboards that match the query parameters are returned:
\n\nDashboards owned by the user. Not returned for anonymous users.
\nDashboards shared with a group that the user is a member of. Not returned for anonymous users.
\nDashboards shared with a private project that the user can browse. Not returned for anonymous users.
\nDashboards shared with a public project.
\nDashboards shared with the public.
\n
\n","operationId":"getDashboardsPaginated","parameters":[{"name":"dashboardName","in":"query","description":"String used to perform a case-insensitive partial match with name.
\n","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.
\n","schema":{"type":"string"}},{"name":"owner","in":"query","description":"This parameter is deprecated because of privacy changes. Use accountId instead. See the migration guide for details. User name used to return dashboards with the matching owner.name. This parameter cannot be used with the accountId parameter.
\n","schema":{"type":"string"}},{"name":"groupname","in":"query","description":"Group name used to returns dashboards that are shared with a group that matches sharePermissions.group.name.
\n","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.
\n","schema":{"type":"integer","format":"int64"}},{"name":"orderBy","in":"query","description":"Orders the results using one of these dashboard properties:
\n\nid Orders by dashboard id.
\nname Orders by dashboard name.
\ndescription Orders by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use.
\nowner Orders by owner name.
\nfavourite_count Orders by popularity.
\nis_favourite Orders by isFavourite.
\n
\n","schema":{"type":"string","enum":["id","name","description","owner","favorite_count","is_favorite","-id","-name","-description","-owner","-favorite_count","-is_favorite"],"default":"name"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 100.
\n","schema":{"type":"integer","format":"int32","default":50}},{"name":"expand","in":"query","description":"Use expand to include additional information about dashboard in the response. This parameter accepts multiple values separated by a comma:
\n\ndescription Returns the description of the dashboard.
\nowner Returns the owner of the dashboard.
\nviewUrl Returns the URL that is used to view the dashboard.
\nfavourite Returns isFavourite, an indicator of whether the user has set the dashboard as a favorite.
\nfavouritedCount Returns popularity, a count of how many users have set this dashboard as a favorite.
\nsharePermissions Returns details of the share permissions defined for the dashboard.
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanDashboard"},"example":"{\"self\":\"b\",\"maxResults\":100,\"startAt\":0,\"total\":2,\"isLast\":true,\"values\":[{\"description\":\"Description for dashboard 1\",\"id\":\"1\",\"isFavourite\":true,\"name\":\"Dashboard 1\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/user?accountId=0000-0000-0000-0000\",\"displayName\":\"user1\",\"active\":true,\"accountId\":\"0000-0000-0000-0000\",\"avatarUrls\":{\"16x16\":\"https://id.atlassian.com/profile/rest/avatar/e93edd89f26b73932efa854d13d7dd61?s=16&d=http%3A%2F%2Fwww.gravatar.com%2Favatar%2Fe64c7d89f26bd1972efa854d13d7dd61%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue\",\"24x24\":\"https://id.atlassian.com/profile/rest/avatar/e93edd89f26b73932efa854d13d7dd61?s=24&d=http%3A%2F%2Fwww.gravatar.com%2Favatar%2Fe64c7d89f26bd1972efa854d13d7dd61%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue\",\"32x32\":\"https://id.atlassian.com/profile/rest/avatar/e93edd89f26b73932efa854d13d7dd61?s=32&d=http%3A%2F%2Fwww.gravatar.com%2Favatar%2Fe64c7d89f26bd1972efa854d13d7dd61%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue\",\"48x48\":\"https://id.atlassian.com/profile/rest/avatar/e93edd89f26b73932efa854d13d7dd61?s=48&d=http%3A%2F%2Fwww.gravatar.com%2Favatar%2Fe64c7d89f26bd1972efa854d13d7dd61%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue\"}},\"popularity\":1,\"self\":\"http://your-domain.atlassian.net/rest/api/3/dashboard/1\",\"sharePermissions\":[{\"type\":\"global\"}],\"view\":\"http://your-domain.atlassian.net/Dashboard.jspa?selectPageId=1\"},{\"description\":\"Description for dashboard 2\",\"id\":\"2\",\"isFavourite\":false,\"name\":\"Dashboard 2\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/user?accountId=0000-0000-0000-0000\",\"displayName\":\"user1\",\"active\":true,\"accountId\":\"0000-0000-0000-0000\",\"avatarUrls\":{\"16x16\":\"https://id.atlassian.com/profile/rest/avatar/e93edd89f26b73932efa854d13d7dd61?s=16&d=http%3A%2F%2Fwww.gravatar.com%2Favatar%2Fe64c7d89f26bd1972efa854d13d7dd61%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue\",\"24x24\":\"https://id.atlassian.com/profile/rest/avatar/e93edd89f26b73932efa854d13d7dd61?s=24&d=http%3A%2F%2Fwww.gravatar.com%2Favatar%2Fe64c7d89f26bd1972efa854d13d7dd61%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue\",\"32x32\":\"https://id.atlassian.com/profile/rest/avatar/e93edd89f26b73932efa854d13d7dd61?s=32&d=http%3A%2F%2Fwww.gravatar.com%2Favatar%2Fe64c7d89f26bd1972efa854d13d7dd61%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue\",\"48x48\":\"https://id.atlassian.com/profile/rest/avatar/e93edd89f26b73932efa854d13d7dd61?s=48&d=http%3A%2F%2Fwww.gravatar.com%2Favatar%2Fe64c7d89f26bd1972efa854d13d7dd61%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue\"}},\"popularity\":0,\"self\":\"http://your-domain.atlassian.net/rest/api/3/dashboard/2\",\"sharePermissions\":[{\"type\":\"loggedin\"}],\"view\":\"http://your-domain.atlassian.net/Dashboard.jspa?selectPageId=2\"}]}"}}},"400":{"description":"Returned if:
\n\norderBy is invalid.
\nexpand includes an invalid value.
\naccountId and owner are provided.
\n
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties":{"get":{"tags":["DashboardItemProperty"],"summary":"Get dashboard item property keys","description":"Returns the keys of all properties for a dashboard item.
\nThis operation can be accessed anonymously.
\nPermissions required: The user must be the owner of the dashboard or be shared the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.
\n","operationId":"getDashboardItemPropertyKeys","parameters":[{"name":"dashboardId","in":"path","description":"The ID of the dashboard.
\n","required":true,"schema":{"type":"string"}},{"name":"itemId","in":"path","description":"The ID of the dashboard item.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyKeys"},"example":"{\"keys\":[{\"self\":\"http://your-domain.atlassian.net/jira/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the dashboard or dashboard item is not found, or the dashboard is not owned by or shared with the user.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}":{"get":{"tags":["DashboardItemProperty"],"summary":"Get dashboard item property","description":"Returns the key and value of a dashboard item property.
\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.
\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 and the Dashboard Item documentation.
\nThere is no resource to set or get dashboard items.
\nThis operation can be accessed anonymously.
\nPermissions required: The user must be the owner of the dashboard or be shared the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.
\n","operationId":"getDashboardItemProperty","parameters":[{"name":"dashboardId","in":"path","description":"The ID of the dashboard.
\n","required":true,"schema":{"type":"string"}},{"name":"itemId","in":"path","description":"The ID of the dashboard item.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the dashboard item property.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"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.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["DashboardItemProperty"],"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.
\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.
\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 and the Dashboard Item documentation.
\nThere is no resource to set or get dashboard items.
\nThe value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
\nThis operation can be accessed anonymously.
\nPermissions required: The user must be the owner of the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard.
\n","operationId":"setDashboardItemProperty","parameters":[{"name":"dashboardId","in":"path","description":"The ID of the dashboard.
\n","required":true,"schema":{"type":"string"}},{"name":"itemId","in":"path","description":"The ID of the dashboard item.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the dashboard item property. The maximum length is 255 characters.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{}}},"required":true},"responses":{"200":{"description":"Returned if the dashboard item property is updated.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"Returned if the dashboard item property is created.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not the owner of the dashboard.
\n"},"404":{"description":"Returned if the dashboard item is not found or the dashboard is not shared with the user.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["DashboardItemProperty"],"summary":"Delete dashboard item property","description":"Deletes a dashboard item property.
\nThis operation can be accessed anonymously.
\nPermissions required: The user must be the owner of the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard.
\n","operationId":"deleteDashboardItemProperty","parameters":[{"name":"dashboardId","in":"path","description":"The ID of the dashboard.
\n","required":true,"schema":{"type":"string"}},{"name":"itemId","in":"path","description":"The ID of the dashboard item.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the dashboard item property.
\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the dashboard item property is deleted.
\n"},"400":{"description":"Returned if the dashboard or dashboard item ID is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not the owner of the dashboard.
\n"},"404":{"description":"Returned if the dashboard item is not found or the dashboard is not shared with the user.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/dashboard/{id}":{"get":{"tags":["Dashboard"],"summary":"Get dashboard","description":"Returns a dashboard.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\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 are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.
\n","operationId":"getDashboard","parameters":[{"name":"id","in":"path","description":"The ID of the dashboard.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"},"example":"{\"id\":\"10000\",\"isFavourite\":false,\"name\":\"System Dashboard\",\"popularity\":1,\"self\":\"http://your-domain.atlassian.net/rest/api/3/dashboard/10000\",\"sharePermissions\":[{\"type\":\"global\"}],\"view\":\"http://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the dashboard is not found or the dashboard is not owned by or shared with the user.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/expression/eval":{"post":{"tags":["JiraExpressions"],"summary":"Evaluate Jira expression","description":"Evaluates a Jira expression and returns its value.
\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 for more details.
\nContext variables
\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\nuser (User): The current user. Always available and equal to null if the request is anonymous.
\napp (App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).
\nissue (Issue): The current issue. Available only when the issue is provided in the request context object.
\nissues (List of Issues): A collection of issues matching a given JQL. Available only when the JQL is provided in the request context object (experimental).
\nproject (Project): The current project. Available only when the project is provided in the request context object.
\nsprint (Sprint): The current sprint. Available only when the sprint is provided in the request context object.
\nboard (Board): The current board. Available only when the board is provided in the request context object.
\nserviceDesk (ServiceDesk): The current service desk. Available only when the service desk is provided in the request context object.
\ncustomerRequest (CustomerRequest): The current customer request. Available only when the customer request is provided in the request context object.
\n
\nThis operation can be accessed anonymously.
\nPermissions 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).
\n","operationId":"evaluateJiraExpression","parameters":[{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
\n\nmeta.complexity 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. Useful when designing and debugging your expressions.
\n
\n","schema":{"type":"string"}}],"requestBody":{"description":"The Jira expression and the evaluation context.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JiraExpressionEvalRequestBean"},"example":{"expression":"{ key: issue.key, type: issue.issueType.name, links: issue.links.map(link => link.linkedIssue.id) }","context":{"issue":{"key":"ACJIRA-1470"},"sprint":10001,"project":{"key":"ACJIRA"},"serviceDesk":10023,"issues":{"jql":{"maxResults":100,"query":"project = HSP","startAt":0,"validation":"strict"}},"board":10100,"customerRequest":1450}}}},"required":true},"responses":{"200":{"description":"Returned if the evaluation results in a value. The result is a JSON primitive value, list, or object.
\n","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\nthe request is invalid, that is:
\n\ninvalid data is provided, such as a request including issue ID and key.
\nthe expression is invalid and can not be parsed.
\n
\n
\n\nevaluation 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.
\n
\n
\n","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.
\n"},"404":{"description":"Returned if any entity provided in the request context is not found or the user does not have permission to view it.
\n","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":[{"OAuth2":["read:jira-work","read:jira-user"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/field":{"get":{"tags":["Field"],"summary":"Get fields","description":"Returns system and custom issue fields according to the following rules:
\n\nFields that cannot be added to the issue navigator are always returned.
\nFields that cannot be placed on an issue screen are always returned.
\nFields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches.
\nFor all other fields, this operation only returns the fields that the user has permission to view (that is, the field is used in at least one project that the user has Browse Projects project permission for.)
\n
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getFields","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FieldDeprecated"}},"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.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Field"],"summary":"Create custom field","description":"Creates a custom field.
\nPermissions required: Administer Jira global permission.
\n","operationId":"createCustomField","parameters":[],"requestBody":{"description":"Definition of the custom field to be created
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldDefinitionJsonBean"},"example":{"searcherKey":"com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher","name":"New custom field","description":"Custom field for picking groups","type":"com.atlassian.jira.plugin.system.customfieldtypes:grouppicker"}}},"required":true},"responses":{"201":{"description":"Returned if the custom field is created.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldDeprecated"},"example":"{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"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\nthe user does not have permission to create custom fields.
\nany of the request object properties have invalid or missing values.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/field/search":{"get":{"tags":["FieldSearch"],"summary":"Get fields paginated","description":"Returns a paginated list of fields for Classic Jira projects. Only custom fields can be queried, isCustom must be set to true.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getFieldsPaginated","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.
\n","schema":{"type":"integer","format":"int32","default":50}},{"name":"isCustom","in":"query","description":"Should endpoint return Custom Fields (true), System Fields (false), or both (unset)
\n","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanField"},"example":"{\"maxResults\":50,\"startAt\":0,\"total\":2,\"isLast\":false,\"values\":[{\"id\":\"customfield_10000\",\"key\":\"customfield_10000\",\"name\":\"Approvers\",\"description\":\"Contains users needed for approval. This custom field was created by Jira Service Desk.\"},{\"id\":\"customfield_10001\",\"key\":\"customfield_10001\",\"name\":\"Change reason\",\"description\":\"Choose the reason for the change request\"}]}"}}},"400":{"description":"Returned if parameter isCustom is not set to true.
\n","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.
\n"},"403":{"description":"Returned if the user does not have the necessary permission.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Only Jira administrators can access fields.\"],\"errors\":{}}"}}}},"deprecated":false,"x-experimental":true,"x-atlassian-connect-scope":"NONE"}},"/rest/api/3/field/{fieldKey}/option":{"get":{"tags":["IssueFieldOption"],"summary":"Get all issue field options","description":"Returns all options defined for a select list issue field. A select list issue field is a type of issue field that allows a user to select n value from a list of options.
\nNote that this operation cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps, as described above.
\nPermissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.
\n","operationId":"getAllIssueFieldOptions","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 100.
\n","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.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanIssueFieldOption"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/field/fieldKey/option?startAt=0&maxResults=1\",\"nextPage\":\"http://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\":\"[email protected]\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"},\"config\":{\"scope\":{\"projects\":[],\"projects2\":[{\"id\":1001,\"attributes\":[\"notSelectable\"]},{\"id\":1002,\"attributes\":[\"notSelectable\"]}],\"global\":{}},\"attributes\":[]}}]}"}}},"400":{"description":"Returned if the field is not found or does not support options.
\n"},"403":{"description":"Returned if the request is not authenticated as a Jira administrator or the app that provided the field.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"NONE"},"post":{"tags":["IssueFieldOption"],"summary":"Create issue field option","description":"Creates an option for a select list issue field.
\nNote that this operation cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps, as described above.
\nPermissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.
\n","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.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueFieldOptionCreateBean"},"example":{"value":"Team 1","config":{"scope":{"projects2":[{"attributes":["notSelectable"],"id":1001},{"attributes":["notSelectable"],"id":1002}],"projects":[],"global":{}},"attributes":[]},"properties":{"leader":{"name":"Leader Name","email":"[email protected]"},"members":42,"founded":"2016-06-06T00:00:00.000Z","description":"The team's description"}}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueFieldOption"},"example":"{\"id\":1,\"value\":\"Team 1\",\"properties\":{\"leader\":{\"name\":\"Leader Name\",\"email\":\"[email protected]\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"},\"config\":{\"scope\":{\"projects\":[],\"projects2\":[{\"id\":1001,\"attributes\":[\"notSelectable\"]},{\"id\":1002,\"attributes\":[\"notSelectable\"]}],\"global\":{}},\"attributes\":[]}}"}}},"400":{"description":"Returned if the option is invalid.
\n"},"403":{"description":"Returned if the request is not authenticated as a Jira administrator or the app that provided the field.
\n"},"404":{"description":"Returned if the field is not found or does not support options.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"NONE"}},"/rest/api/3/field/{fieldKey}/option/suggestions/edit":{"get":{"tags":["IssueFieldOption"],"summary":"Get selectable issue field options","description":"Returns options defined for a select list issue field that can be viewed and selected by the user.
\nNote that this operation cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps, as described above.
\nPermissions required: Permission to access Jira.
\n","operationId":"getSelectableIssueFieldOptions","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 100.
\n","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.
\n","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.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanIssueFieldOption"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=0&maxResults=1\",\"nextPage\":\"http://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\":\"[email protected]\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"}}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the field is not found or does not support options.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"NONE"}},"/rest/api/3/field/{fieldKey}/option/suggestions/search":{"get":{"tags":["IssueFieldOption"],"summary":"Get visible issue field options","description":"Returns options defined for a select list issue field that can be viewed by the user.
\nNote that this operation cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps, as described above.
\nPermissions required: Permission to access Jira.
\n","operationId":"getVisibleIssueFieldOptions","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 100.
\n","schema":{"type":"integer","format":"int32"}},{"name":"projectId","in":"query","description":"Filters the results to options that are only available in the specified project.
\n","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.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanIssueFieldOption"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=0&maxResults=1\",\"nextPage\":\"http://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\":\"[email protected]\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"}}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the field is not found or does not support options.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"NONE"}},"/rest/api/3/field/{fieldKey}/option/{optionId}":{"get":{"tags":["IssueFieldOption"],"summary":"Get issue field option","description":"Returns an option from a select list issue field.
\nNote that this operation cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps, as described above.
\nPermissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.
\n","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.
\n","required":true,"schema":{"type":"string"}},{"name":"optionId","in":"path","description":"The ID of the option to be returned.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the requested option is returned.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueFieldOption"},"example":"{\"id\":1,\"value\":\"Team 1\",\"properties\":{\"leader\":{\"name\":\"Leader Name\",\"email\":\"[email protected]\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"},\"config\":{\"scope\":{\"projects\":[],\"projects2\":[{\"id\":1001,\"attributes\":[\"notSelectable\"]},{\"id\":1002,\"attributes\":[\"notSelectable\"]}],\"global\":{}},\"attributes\":[]}}"}}},"400":{"description":"Returned if the field is not found or does not support options.
\n"},"403":{"description":"Returned if the request is not authenticated as a Jira administrator or the app that provided the field.
\n"},"404":{"description":"Returned if the option is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"NONE"},"put":{"tags":["IssueFieldOption"],"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.
\nNote that this operation cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps, as described above.
\nPermissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.
\n","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.
\n","required":true,"schema":{"type":"string"}},{"name":"optionId","in":"path","description":"The ID of the option to be updated.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueFieldOption"},"example":{"id":1,"value":"Team 1","config":{"scope":{"projects2":[{"attributes":["notSelectable"],"id":1001},{"attributes":["notSelectable"],"id":1002}],"projects":[],"global":{}},"attributes":[]},"properties":{"leader":{"name":"Leader Name","email":"[email protected]"},"members":42,"founded":"2016-06-06T00:00:00.000Z","description":"The team's description"}}}},"required":true},"responses":{"200":{"description":"Returned if the option is updated or created.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueFieldOption"},"example":"{\"id\":1,\"value\":\"Team 1\",\"properties\":{\"leader\":{\"name\":\"Leader Name\",\"email\":\"[email protected]\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"},\"config\":{\"scope\":{\"projects\":[],\"projects2\":[{\"id\":1001,\"attributes\":[\"notSelectable\"]},{\"id\":1002,\"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.
\n"},"403":{"description":"Returned if the request is not authenticated as a Jira administrator or the app that provided the field.
\n"},"404":{"description":"Returned if field is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"NONE"},"delete":{"tags":["IssueFieldOption"],"summary":"Delete issue field option","description":"Deletes an option from a select list issue field.
\nNote that this operation cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps, as described above.
\nPermissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.
\n","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.
\n","required":true,"schema":{"type":"string"}},{"name":"optionId","in":"path","description":"The ID of the option to be deleted.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the field option is deleted.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Returned if the request is not authenticated as a Jira administrator or the app that provided the field.
\n"},"404":{"description":"Returned if the field or option is not found.
\n"},"409":{"description":"Returned if the option is selected for the field in any issue.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"NONE"}},"/rest/api/3/field/{fieldKey}/option/{optionId}/issue":{"delete":{"tags":["IssueFieldOption"],"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.
\nThis is an asynchronous operation. The response object contains a link to the long-running task.
\nNote that this operation cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps, as described above.
\nPermissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.
\n","operationId":"replaceIssueFieldOption","parameters":[{"name":"replaceWith","in":"query","description":"The ID of the option that will replace the currently selected option.
\n","schema":{"type":"integer","format":"int64"}},{"name":"jql","in":"query","description":"A JQL query that specifies the issues to be updated. For example, project=10000.
\n","schema":{"type":"string"}},{"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.
\n","required":true,"schema":{"type":"string"}},{"name":"optionId","in":"path","description":"The ID of the option to be deselected.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"303":{"description":"Returned if the long-running task to deselect the option is started.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskProgressBeanRemoveOptionFromIssuesResult"},"example":"{\"self\":\"http://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\":{\"present\":true}}},\"elapsedRuntime\":42}"}}},"400":{"description":"Returned if the JQL query is invalid.
\n"},"404":{"description":"Returned if the field is not found or does not support options, or the options to be replaced are not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"NONE"}},"/rest/api/3/filter":{"get":{"tags":["Filter"],"summary":"Get filters","description":"Returns all filters. Deprecated, use  Search for filters that supports search and pagination.
\nThis operation can be accessed anonymously.
\nPermissions required: None, however, only the following filters are returned:
\n\nfilters owned by the user.
\nfilters shared with a group that the user is a member of.
\nfilters shared with a private project that the user has Browse projects project permission for.
\nfilters shared with a public project.
\nfilters shared with the public.
\n
\n","operationId":"getFilters","parameters":[{"name":"expand","in":"query","description":"Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
\n\nsharedUsers 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].
\nsubscriptions 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].
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Filter"}},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":true,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Filter"],"summary":"Create filter","description":"Creates a filter. The filter is shared according to the default share scope. The filter is not selected as a favorite.
\nPermissions required: Permission to access Jira.
\n","operationId":"createFilter","parameters":[{"name":"expand","in":"query","description":"Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
\n\nsharedUsers 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].
\nsubscriptions 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].
\n
\n","schema":{"type":"string"}}],"requestBody":{"description":"The filter to create.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Filter"},"example":{"jql":"type = Bug and resolution is empty","name":"All Open Bugs","description":"Lists all open bugs"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Filter"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/filter/defaultShareScope":{"get":{"tags":["Filter"],"summary":"Get default share scope","description":"Returns the default sharing settings for new filters and dashboards for a user.
\nPermissions required: Permission to access Jira.
\n","operationId":"getDefaultShareScope","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultShareScope"},"example":"{\"scope\":\"GLOBAL\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Filter"],"summary":"Set default share scope","description":"Sets the default sharing for new filters and dashboards for a user.
\nPermissions required: Permission to access Jira.
\n","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.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultShareScope"},"example":"{\"scope\":\"GLOBAL\"}"}}},"400":{"description":"Returned if an invalid scope is set.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/filter/favourite":{"get":{"tags":["Filter"],"summary":"Get favorite filters","description":"Returns the visible favorite filters of the user.
\nThis operation can be accessed anonymously.
\nPermissions required: A favorite filter is only visible to the user where the filter is:
\n\nowned by the user.
\nshared with a group that the user is a member of.
\nshared with a private project that the user has Browse projects project permission for.
\nshared with a public project.
\nshared 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.
\n","operationId":"getFavouriteFilters","parameters":[{"name":"expand","in":"query","description":"Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
\n\nsharedUsers 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].
\nsubscriptions 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].
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Filter"}},"example":"[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10010\",\"id\":\"10010\",\"name\":\"My issues\",\"description\":\"Issues assigned to me\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"assignee = currentUser() and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10010\",\"searchUrl\":\"http://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\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"}}],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/filter/my":{"get":{"tags":["Filter"],"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.
\nPermissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:
\n\nowned by the user.
\nshared with a group that the user is a member of.
\nshared with a private project that the user has Browse projects project permission for.
\nshared with a public project.
\nshared 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.
\n","operationId":"getMyFilters","parameters":[{"name":"expand","in":"query","description":"Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
\n\nsharedUsers 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].
\nsubscriptions 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].
\n
\n","schema":{"type":"string"}},{"name":"includeFavourites","in":"query","description":"Include the user's favorite filters in the response.
\n","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Filter"}},"example":"[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10010\",\"id\":\"10010\",\"name\":\"My issues\",\"description\":\"Issues assigned to me\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"assignee = currentUser() and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10010\",\"searchUrl\":\"http://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\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"}}],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/filter/search":{"get":{"tags":["Filter"],"summary":"Search for filters","description":"Searches for filters. This operation is similar to Get filters except that the results can be refined to include filters that have specific attributes. For example, filters with a particular name. When multiple attributes are specified only filters matching all attributes are returned.
\nThis operation can be accessed anonymously.
\nPermissions required: None, however, only the following filters that match the query parameters are returned:
\n\nfilters owned by the user.
\nfilters shared with a group that the user is a member of.
\nfilters shared with a private project that the user has Browse projects project permission for.
\nfilters shared with a public project.
\nfilters shared with the public.
\n
\n","operationId":"getFiltersPaginated","parameters":[{"name":"filterName","in":"query","description":"String used to perform a case-insensitive partial match with name.
\n","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.
\n","schema":{"type":"string"}},{"name":"owner","in":"query","description":"This parameter is deprecated because of privacy changes. Use accountId instead. See the migration guide for details. User name used to return filters with the matching owner.name. This parameter cannot be used with accountId.
\n","schema":{"type":"string"}},{"name":"groupname","in":"query","description":"Group name used to returns filters that are shared with a group that matches sharePermissions.group.groupname.
\n","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.
\n","schema":{"type":"integer","format":"int64"}},{"name":"orderBy","in":"query","description":"Orders the results using one of these filter properties:
\n\ndescription Orders by filter description. Note that this ordering works independently of whether the expand to display the description field is in use.
\nfavourite_count Orders by favouritedCount.
\nis_favourite Orders by favourite.
\nid Orders by filter id.
\nname Orders by filter name.
\nowner Orders by owner.accountId.
\n
\n","schema":{"type":"string","enum":["id","name","description","owner","favorite_count","is_favorite","-id","-name","-description","-owner","-favorite_count","-is_favorite"],"default":"name"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 100.
\n","schema":{"type":"integer","format":"int32","default":50}},{"name":"expand","in":"query","description":"Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
\n\ndescription Returns the description of the filter.
\nfavourite Returns an indicator of whether the user has set the filter as a favorite.
\nfavouritedCount Returns a count of how many users have set this filter as a favorite.
\njql Returns the JQL query that the filter uses.
\nowner Returns the owner of the filter.
\nsearchUrl Returns a URL to perform the filter's JQL query.
\nsharePermissions Returns the share permissions defined for the filter.
\nsubscriptions Returns the users that are subscribed to the filter.
\nviewUrl Returns a URL to view the filter.
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanFoundFilter"},"example":"{\"self\":\"b\",\"maxResults\":100,\"startAt\":0,\"total\":2,\"isLast\":true,\"values\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"subscriptions\":[]},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10010\",\"id\":\"10010\",\"name\":\"My issues\",\"description\":\"Issues assigned to me\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"assignee = currentUser() and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10010\",\"searchUrl\":\"http://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\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"}}],\"subscriptions\":[{\"id\":1,\"user\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}}}]}]}"}}},"400":{"description":"Returned if:
\n\nowner and accountId are provided.
\nexpand includes an invalid value.
\norderBy is invalid.
\n
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/filter/{id}":{"get":{"tags":["Filter"],"summary":"Get filter","description":"Returns a filter.
\nThis operation can be accessed anonymously.
\nPermissions required: None, however, the filter is only returned where it is:
\n\nowned by the user.
\nshared with a group that the user is a member of.
\nshared with a private project that the user has Browse projects project permission for.
\nshared with a public project.
\nshared with the public.
\n
\n","operationId":"getFilter","parameters":[{"name":"id","in":"path","description":"The ID of the filter to return.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
\n\nsharedUsers 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].
\nsubscriptions 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].
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Filter"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Filter"],"summary":"Update filter","description":"Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.
\nPermissions required: Permission to access Jira, however the user must own the filter.
\n","operationId":"updateFilter","parameters":[{"name":"id","in":"path","description":"The ID of the filter to update.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
\n\nsharedUsers 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].
\nsubscriptions 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].
\n
\n","schema":{"type":"string"}}],"requestBody":{"description":"The filter to update.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Filter"},"example":{"jql":"type = Bug and resolution is empty","name":"All Open Bugs","description":"Lists all open bugs"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Filter"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Filter"],"summary":"Delete filter","description":"Delete a filter.
\nPermissions 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.
\n","operationId":"deleteFilter","parameters":[{"name":"id","in":"path","description":"The ID of the filter to delete.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the filter is not found.
\n"},"401":{"description":"Returned if the user does not have permission to delete the filter.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/filter/{id}/columns":{"get":{"tags":["Filter"],"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.
\nThis operation can be accessed anonymously.
\nPermissions required: None, however, column details are only returned for:
\n\nfilters owned by the user.
\nfilters shared with a group that the user is a member of.
\nfilters shared with a private project that the user has Browse projects project permission for.
\nfilters shared with a public project.
\nfilters shared with the public.
\n
\n","operationId":"getColumns","parameters":[{"name":"id","in":"path","description":"The ID of the filter.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if a column configuration is not set for the filter.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Filter"],"summary":"Set columns","description":"Sets the columns for a filter. Only navigable fields can be set as columns. Use Get fields to get the list fields in Jira. A navigable field has navigable set to true.
\nThe parameters for this resource are expressed as HTML form data. For example, in curl:
\ncurl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/filter/10000/columns
\nPermissions required: Permission to access Jira, however, columns are only set for:
\n\nfilters owned by the user.
\nfilters shared with a group that the user is a member of.
\nfilters shared with a private project that the user has Browse projects project permission for.
\nfilters shared with a public project.
\nfilters shared with the public.
\n
\n","operationId":"setColumns","parameters":[{"name":"id","in":"path","description":"The ID of the filter.
\n","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). For example, columns=summary.
\n","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.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if:
\n\na non-navigable field is set as a column.
\nthe user does not have permission to view the filter.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Filter"],"summary":"Reset columns","description":"Reset the user's column configuration for the filter to the default.
\nPermissions required: Permission to access Jira, however, columns are only reset for:
\n\nfilters owned by the user.
\nfilters shared with a group that the user is a member of.
\nfilters shared with a private project that the user has Browse projects project permission for.
\nfilters shared with a public project.
\nfilters shared with the public.
\n
\n","operationId":"resetColumns","parameters":[{"name":"id","in":"path","description":"The ID of the filter.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if:
\n\nthe filter is not found.
\nthe user does not have permission to view the filter.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/filter/{id}/favourite":{"put":{"tags":["Filter"],"summary":"Add filter as favorite","description":"Add a filter as a favorite for the user.
\nPermissions required: Permission to access Jira, however, the user can only favorite:
\n\nfilters owned by the user.
\nfilters shared with a group that the user is a member of.
\nfilters shared with a private project that the user has Browse projects project permission for.
\nfilters shared with a public project.
\nfilters shared with the public.
\n
\n","operationId":"setFavouriteForFilter","parameters":[{"name":"id","in":"path","description":"The ID of the filter.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
\n\nsharedUsers 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].
\nsubscriptions 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].
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Filter"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}"}}},"400":{"description":"Returned if:
\n\nthe filter is not found.
\nthe user does not have permission to favorite the filter.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Filter"],"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.
\nPermissions required: Permission to access Jira.
\n","operationId":"deleteFavouriteForFilter","parameters":[{"name":"id","in":"path","description":"The ID of the filter.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
\n\nsharedUsers 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].
\nsubscriptions 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].
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Filter"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}"}}},"400":{"description":"Returned if:
\n\nthe filter is not found.
\nthe user does not have permission to view the filter.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/filter/{id}/permission":{"get":{"tags":["Filter"],"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.
\nThis operation can be accessed anonymously.
\nPermissions required: None, however, share permissions are only returned for:
\n\nfilters owned by the user.
\nfilters shared with a group that the user is a member of.
\nfilters shared with a private project that the user has Browse projects project permission for.
\nfilters shared with a public project.
\nfilters shared with the public.
\n
\n","operationId":"getSharePermissions","parameters":[{"name":"id","in":"path","description":"The ID of the filter.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SharePermission"}},"example":"[{\"id\":10000,\"type\":\"global\"},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"}},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY\",\"id\":\"10002\",\"key\":\"MKY\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"},\"role\":{\"self\":\"http://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\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}},{\"id\":10010,\"type\":\"group\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"}}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nthe filter is not found.
\nthe user does not have permission to view the filter.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Filter"],"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.
\nBe aware that this operation uses different objects for updating share permissions compared to Update filter.
\nPermissions required: Share dashboards and filters global permission and the user must own the filter.
\n","operationId":"addSharePermission","parameters":[{"name":"id","in":"path","description":"The ID of the filter.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharePermissionInputBean"},"example":{"type":"group","groupname":"jira-administrators"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SharePermission"}},"example":"[{\"id\":10000,\"type\":\"global\"},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"}},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY\",\"id\":\"10002\",\"key\":\"MKY\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"},\"role\":{\"self\":\"http://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\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}},{\"id\":10010,\"type\":\"group\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"}}]"}}},"400":{"description":"Returned if:
\n\nthe 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.
\nthe user does not own the filter.
\nthe user does not have the required permissions.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nthe filter is not found.
\nthe user does not have permission to view the filter.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/filter/{id}/permission/{permissionId}":{"get":{"tags":["Filter"],"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.
\nThis operation can be accessed anonymously.
\nPermissions required: None, however, a share permission is only returned for:
\n\nfilters owned by the user.
\nfilters shared with a group that the user is a member of.
\nfilters shared with a private project that the user has Browse projects project permission for.
\nfilters shared with a public project.
\nfilters shared with the public.
\n
\n","operationId":"getSharePermission","parameters":[{"name":"id","in":"path","description":"The ID of the filter.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"permissionId","in":"path","description":"The ID of the share permission.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharePermission"},"example":"{\"id\":10000,\"type\":\"global\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nthe filter is not found.
\nthe permission is not found.
\nthe user does not have permission to view the filter.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"delete":{"tags":["Filter"],"summary":"Delete share permission","description":"Deletes a share permission from a filter.
\nPermissions required: Permission to access Jira and the user must own the filter.
\n","operationId":"deleteSharePermission","parameters":[{"name":"id","in":"path","description":"The ID of the filter.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"permissionId","in":"path","description":"The ID of the share permission.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nthe filter is not found.
\nthe user does not own the filter.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/group":{"get":{"tags":["Group"],"summary":"Get group","description":"This operation is deprecated, use group/member.
\nReturns all users in a group.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getGroup","parameters":[{"name":"groupname","in":"query","description":"The name of the group.
\n","schema":{"type":"string"}},{"name":"expand","in":"query","description":"List of fields to expand.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"description":"Returned if the group name is not specified.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the calling user does not have the Administer Jira global permission.
\n"},"404":{"description":"Returned if the group is not found.
\n"}},"deprecated":true,"security":[{"OAuth2":["read:jira-user"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Group"],"summary":"Create group","description":"Creates a group.
\nPermissions required: Site administration (that is, member of the site-admin group).
\n","operationId":"createGroup","parameters":[],"requestBody":{"description":"The name of the group.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddGroupBean"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"},"example":"{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\",\"users\":{\"size\":1,\"items\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the necessary permission.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["Group"],"summary":"Remove group","description":"Deletes a group.
\nPermissions required: Site administration (that is, member of the site-admin strategic group).
\n","operationId":"removeGroup","parameters":[{"name":"groupname","in":"query","description":"The name of the group.
\n","schema":{"type":"string"}},{"name":"swapGroup","in":"query","description":"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.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the group name is not specified.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request.
\n"},"403":{"description":"Returned if the user does not have the necessary permission.
\n"},"404":{"description":"Returned if the group is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/group/member":{"get":{"tags":["Group"],"summary":"Get users from group","description":"Returns all users in a group.
\nNote that users are ordered by username, however the username is not returned in the results due to privacy reasons.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getUsersFromGroup","parameters":[{"name":"groupname","in":"query","description":"The name of the group.
\n","schema":{"type":"string"}},{"name":"includeInactiveUsers","in":"query","description":"Include inactive users.
\n","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).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 50.
\n","schema":{"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanUserDetails"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/group/member?groupname=jira-administrators&includeInactiveUsers=false&startAt=2&maxResults=2\",\"nextPage\":\"http://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\":\"http://example/jira/rest/api/3/user?accountId=26912:8347-414d-ef131-ac0318367469\",\"name\":\"\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{},\"displayName\":\"Fred\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"accountType\":\"atlassian\"},{\"self\":\"http://example/jira/rest/api/3/user?accountId=26912:8347-325f-ef346-bd0342234324\",\"name\":\"\",\"key\":\"\",\"accountId\":\"26912:8347-325f-ef346-bd0342234324\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{},\"displayName\":\"Barney\",\"active\":false,\"timeZone\":\"Australia/Sydney\",\"accountType\":\"atlassian\"}]}"}}},"400":{"description":"Returned if the group name is not specified.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the calling user does not have the Administer Jira global permission.
\n"},"404":{"description":"Returned if the group is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/group/user":{"post":{"tags":["Group"],"summary":"Add user to group","description":"Adds a user to a group.
\nPermissions required: Site administration (that is, member of the site-admin group).
\n","operationId":"addUserToGroup","parameters":[{"name":"groupname","in":"query","description":"The name of the group (case sensitive).
\n","schema":{"type":"string"}}],"requestBody":{"description":"The user to add to the group.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserToGroupBean"},"example":{"accountId":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"description":"Returned if:
\n\ngroupname is not provided.
\naccountId is missing.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request.
\n"},"403":{"description":"Returned if the calling user does not have the necessary permission.
\n"},"404":{"description":"Returned if the group or user are not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["Group"],"summary":"Remove user from group","description":"Removes a user from a group.
\nPermissions required: Site administration (that is, member of the site-admin group).
\n","operationId":"removeUserFromGroup","parameters":[{"name":"groupname","in":"query","description":"The name of the group.
\n","schema":{"type":"string"}},{"name":"username","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}},{"name":"accountId","in":"query","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.
\n","schema":{"type":"string","example":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"},"x-showInExample":"true"}],"responses":{"200":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if:
\n\ngroupName is missing.
\naccountId is missing.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the group or user are not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/groups/picker":{"get":{"tags":["GroupPicker"],"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.
\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.
\nThe list returns with the groups sorted. If no groups match the list criteria, an empty list is returned.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse projects project permission. Anonymous calls and calls by users without the required permission return an empty list.
\n","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.
\n","schema":{"type":"string"}},{"name":"query","in":"query","description":"The string to find in group names.
\n","schema":{"type":"string","example":"query"}},{"name":"exclude","in":"query","description":"A group to exclude from the result. To exclude multiple groups, provide multiple copies of this parameter. For example, exclude=group1&exclude=group2.
\n","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.
\n","schema":{"type":"integer","format":"int32"}},{"name":"userName","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FoundGroups"},"example":"{\"header\":\"Showing 20 of 25 matching groups\",\"total\":25,\"groups\":[{\"name\":\"jdog-developers\",\"html\":\"jdog-developers\"},{\"name\":\"juvenal-bot\",\"html\":\"juvenal-bot\"}]}"}}}},"deprecated":false,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/groupuserpicker":{"get":{"tags":["GroupAndUserPicker"],"summary":"Find users and groups","description":"Returns a list of users and groups matching a string. The string is used:
\n\nfor 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.
\nfor 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 [email protected], and the group accounting would be returned.
\nOptionally, the search can be refined to:
\n\n\nthe 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\nprojects.
\nissue types.
\n
\nIf 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
\n\nnot return Connect app users and groups.
\n
\n\nreturn groups that have a case-insensitive match with the query.
\n
\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.
\nThis operation can be accessed anonymously if permissions allow open access.
\nPermissions required: Browse users and groups global permission.
\n","operationId":"findUsersAndGroups","parameters":[{"name":"query","in":"query","description":"The search string.
\n","schema":{"type":"string"}},{"name":"maxResults","in":"query","description":"The maximum number of items to return in each list. The maximum is 1000.
\n","schema":{"type":"integer","format":"int32","default":50}},{"name":"showAvatar","in":"query","description":"Indicates whether the user avatar should be returned. If an invalid value is provided, the default value is used.
\n","schema":{"type":"boolean","default":false}},{"name":"fieldId","in":"query","description":"The custom field ID of the field this request is for.
\n","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 multiple copies of this parameter. For example, projectId=10000&projectId=10001. This parameter is only used when fieldId is present.
\n","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 multiple copies of this parameter. 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.
\n","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.
\n","schema":{"type":"string","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"],"default":"xsmall"}},{"name":"caseInsensitive","in":"query","description":"Indicates whether the search for groups should be case insensitive.
\n","schema":{"type":"boolean","default":false}},{"name":"excludeConnectAddons","in":"query","description":"Indicates whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used.
\n","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FoundUsersAndGroups"},"example":"{\"users\":{\"users\":[{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountType\":\"atlassian\",\"name\":\"mia\",\"key\":\"mia\",\"html\":\"Mia Krystof - mi[email protected] (mia)\",\"displayName\":\"Mia Krystof\",\"avatarUrl\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=fred\"}],\"total\":25,\"header\":\"Showing 20 of 25 matching groups\"},\"groups\":{\"header\":\"Showing 20 of 25 matching groups\",\"total\":25,\"groups\":[{\"name\":\"jdog-developers\",\"html\":\"jdog-developers\"},{\"name\":\"juvenal-bot\",\"html\":\"juvenal-bot\"}]}}"}}},"400":{"description":"Returned if the query parameter is not provided.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have permission to view users and groups
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issue":{"post":{"tags":["Issue"],"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.
\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. 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.
\nCreating a subtask differs from creating an issue as follows:
\n\nissueType must be set to a subtask issue type (use  Get create issue metadata to find subtask issue types).
\nparent MUST contain the ID or key of the parent issue.
\n
\nA parent MAY be supplied for any issue provided both parent and child are members of the same next-gen project. In a classic project the parent field is only valid for subtasks.
\nPermissions required: Browse projects and Create issues project permissions for the project in which the issue or subtask is created.
\n","operationId":"createIssue","parameters":[{"name":"updateHistory","in":"query","description":"Indicates 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.
\n","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueUpdateDetails"},"example":{"update":{},"fields":{"summary":"something's wrong","issuetype":{"id":"10000"},"components":[{"id":"10000"}],"customfield_20000":"06/Jul/19 3:25 PM","customfield_40000":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"this is a text field","type":"text"}]}]},"customfield_70000":["jira-administrators","jira-software-users"],"project":{"id":"10000"},"description":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"description","type":"text"}]}]},"reporter":{"id":"99:e2a16dd9-2ffb-4a4b-a9bd-bd1145a020ee"},"fixVersions":[{"id":"10001"}],"customfield_10000":"09/Jun/19","priority":{"id":"20000"},"labels":["bugfix","blitz_test"],"timetracking":{"remainingEstimate":"5","originalEstimate":"10"},"customfield_30000":["10000","10002"],"customfield_80000":{"value":"red"},"security":{"id":"10000"},"environment":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"environment","type":"text"}]}]},"versions":[{"id":"10000"}],"duedate":"2019-05-11T00:00:00.000Z","customfield_60000":"jira-software-users","customfield_50000":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"this is a text area. big text.","type":"text"}]}]},"assignee":{"id":"e5:e1a16c14-1fe0-1c93-a2b1-ac4493ace0f1"}}}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedIssue"},"example":"{\"id\":\"10000\",\"key\":\"TST-24\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10000\",\"transition\":{\"status\":200,\"errorCollection\":{\"errorMessages\":[],\"errors\":{}}}}"}}},"400":{"description":"Returned if the request:
\n\nis missing required fields.
\ncontains invalid field values.
\ncontains fields that cannot be set for the issue type.
\nis by a user who does not have the necessary permissions.
\nis to create a subtype in a project different that of the the parent issue.
\nis for a subtask when the option to create subtasks is disabled.
\nis invalid for any other reason.
\n
\n","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.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the user is not permitted to access the application.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/bulk":{"post":{"tags":["Issue"],"summary":"Bulk create issue","description":"Creates 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.
\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. 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.
\nCreating a subtask differs from creating an issue as follows:
\n\nissueType must be set to a subtask issue type (use  Get create issue metadata to find subtask issue types).
\nparent the must contain the ID or key of the parent issue.
\n
\nPermissions required: Browse projects and Create issues project permissions for the project in which each issue or subtask is created.
\n","operationId":"createIssues","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuesUpdateBean"},"example":{"issueUpdates":[{"update":{"worklog":[{"add":{"timeSpent":"60m","started":"2019-07-05T11:05:00.000+0000"}}]},"fields":{"summary":"something's wrong","issuetype":{"id":"10000"},"components":[{"id":"10000"}],"customfield_20000":"06/Jul/19 3:25 PM","customfield_40000":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"this is a text field","type":"text"}]}]},"customfield_70000":["jira-administrators","jira-software-users"],"project":{"id":"10000"},"description":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"description","type":"text"}]}]},"reporter":{"id":"557058:d6b5955a-e193-41e1-b051-79cdb0755d68"},"fixVersions":[{"id":"10001"}],"customfield_10000":"09/Jun/19","priority":{"id":"20000"},"labels":["bugfix","blitz_test"],"timetracking":{"remainingEstimate":"5","originalEstimate":"10"},"customfield_30000":["10000","10002"],"customfield_80000":{"value":"red"},"security":{"id":"10000"},"environment":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"environment","type":"text"}]}]},"versions":[{"id":"10000"}],"duedate":"2011-03-11T00:00:00.000Z","customfield_60000":"jira-software-users","customfield_50000":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"this is a text area. big text.","type":"text"}]}]},"assignee":{"id":"5b10a2844c20165700ede21f"}}},{"update":{},"fields":{"summary":"something's very wrong","issuetype":{"id":"10000"},"components":[{"id":"10000"}],"customfield_20000":"06/Jul/19 3:25 PM","customfield_40000":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"this is a text field","type":"text"}]}]},"customfield_70000":["jira-administrators","jira-software-users"],"project":{"id":"1000"},"description":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"description","type":"text"}]}]},"reporter":{"id":"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e"},"fixVersions":[{"id":"10001"}],"customfield_10000":"09/Jun/19","priority":{"id":"20000"},"labels":["new_release"],"timetracking":{"remainingEstimate":"5","originalEstimate":"15"},"customfield_30000":["10000","10002"],"customfield_80000":{"value":"red"},"security":{"id":"10000"},"environment":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"environment","type":"text"}]}]},"versions":[{"id":"10000"}],"duedate":"2019-04-16T00:00:00.000Z","customfield_60000":"jira-software-users","customfield_50000":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"this is a text area. big text.","type":"text"}]}]},"assignee":{"id":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"}}}]}}},"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\nis missing required fields.
\ncontains invalid field values.
\ncontains fields that cannot be set for the issue type.
\nis by a user who does not have the necessary permissions.
\nis to create a subtype in a project different that of the the parent issue.
\nis for a subtask when the option to create subtasks is disabled.
\nis invalid for any other reason.
\n
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedIssues"},"example":"{\"issues\":[{\"id\":\"10000\",\"key\":\"TST-24\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10000\",\"transition\":{\"status\":200,\"errorCollection\":{\"errorMessages\":[],\"errors\":{}}}},{\"id\":\"10001\",\"key\":\"TST-25\",\"self\":\"http://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\nare missing required fields.
\ncontain invalid field values.
\ncontain fields that cannot be set for the issue type.
\nare by a user who does not have the necessary permissions.
\nare to create a subtype in a project different that of the the parent issue.
\nis for a subtask when the option to create subtasks is disabled.
\nare invalid for any other reason.
\n
\n","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.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/createmeta":{"get":{"tags":["Issue"],"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 and Create issues.
\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.
\nThis operation can be accessed anonymously.
\nPermissions required: Create issues project permission in the requested projects.
\n","operationId":"getCreateIssueMeta","parameters":[{"name":"projectIds","in":"query","description":"Comma-separated list of project IDs. This parameter may be specified multiple times. For example, projectIds=10000,10001&projectIds=10020,10021. This parameter may be provided with projectKeys.
\n","schema":{"type":"array","items":{"type":"string"}}},{"name":"projectKeys","in":"query","description":"Comma-separated list of project keys. This parameter may be specified multiple times. For example, projectKeys=proj1,proj2&projectKeys=proj3. This parameter may be provided with projectIds.
\n","schema":{"type":"array","items":{"type":"string"}}},{"name":"issuetypeIds","in":"query","description":"Comma-separated list of issue type IDs. This parameter may be specified multiple times. For example, issuetypeIds=10000,10001&issuetypeIds=10020,10021. This parameter may be provided with issuetypeNames.
\n","schema":{"type":"array","items":{"type":"string"}}},{"name":"issuetypeNames","in":"query","description":"Comma-separated list of issue type names. This parameter may be specified multiple times. For example, issuetypeNames=name1,name2&issuetypeNames=name3. This parameter may be provided with issuetypeIds.
\n","schema":{"type":"array","items":{"type":"string"}}},{"name":"expand","in":"query","description":"Use expand 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 and Create issues.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueCreateMetadata"},"example":"{\"projects\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example Project\",\"avatarUrls\":{\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011\",\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011\"},\"issuetypes\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"An error in the code\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/issuetypes/bug.png\",\"name\":\"Bug\",\"subtask\":false,\"fields\":{\"issuetype\":{\"required\":true,\"name\":\"Issue Type\",\"key\":\"issuetype\",\"hasDefaultValue\":false,\"operations\":[\"set\"]}}}]}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issue/picker":{"get":{"tags":["Issue"],"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.
\nThis operation returns two lists:
\n\nHistory Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.
\nCurrent 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.
\nPermissions required: None.
\n","operationId":"getIssuePickerResource","parameters":[{"name":"query","in":"query","description":"A string to match against text fields in the issue such as title, description, or comments.
\n","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.
\n","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.
\n","schema":{"type":"string"}},{"name":"currentProjectId","in":"query","description":"The ID of a project that suggested issues must belong to.
\n","schema":{"type":"string"}},{"name":"showSubTasks","in":"query","description":"Indicate whether to include subtasks in the suggestions list.
\n","schema":{"type":"boolean"}},{"name":"showSubTaskParent","in":"query","description":"When currentIssueKey is a subtask, indicates whether to include the parent issue in the suggestions if it matches the query.
\n","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuePickerSuggestions"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issue/properties/{propertyKey}":{"put":{"tags":["IssuePropertyBulkUpdate"],"summary":"Bulk set issue property","description":"Sets a property value on multiple issues. The issues to be updated can be specified by a filter.
\nThe filter identifies issues eligible for update using these criteria:
\n\n\nentityIds Only issues from this list are eligible.
\n
\n\ncurrentValue Only issues with the property set to this value are eligible.
\n
\n\nhasProperty:
\n\nIf true, only issues with the property are eligible.
\nIf false, only issues without the property are eligible.
\n
\n
\n
\nIf more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible.
\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).
\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.
\nThis operation is:
\n\ntransactional, either all eligible issues are updated or, when errors occur, none are updated.
\nasynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.
\n
\nPermissions required:
\n\nBrowse projects project permission for each project containing issues.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nEdit issues project permission for each issue.
\n
\n","operationId":"bulkSetIssueProperty","parameters":[{"name":"propertyKey","in":"path","description":"The key of the property. The maximum length is 255 characters.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkIssuePropertyUpdateRequest"},"example":{"filter":{"hasProperty":true,"entityIds":[10100,100010],"currentValue":{"owner":"admin","weight":50}},"value":{"owner":"admin","weight":100}}}},"required":true},"responses":{"303":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the request is invalid.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-experimental":true,"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["IssuePropertyBulkUpdate"],"summary":"Bulk delete issue property","description":"Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.
\nThe criteria the filter used to identify eligible issues are:
\n\nentityIds Only issues from this list are eligible.
\ncurrentValue 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.
\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.
\nThis operation is:
\n\ntransactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
\nasynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.
\n
\nPermissions required:
\n\nBrowse projects  project permission for each project containing issues.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nEdit issues project permission for each issue.
\n
\n","operationId":"bulkDeleteIssueProperty","parameters":[{"name":"propertyKey","in":"path","description":"The key of the property.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueFilterForBulkPropertyDelete"},"example":{"entityIds":[10100,100010],"currentValue":"deprecated value"}}},"required":true},"responses":{"303":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the request is invalid.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-experimental":true,"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/{issueIdOrKey}":{"get":{"tags":["Issue"],"summary":"Get issue","description":"Returns the details for an issue.
\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.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"getIssue","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return for the issue. Use it to retrieve a subset of fields. Allowed values:
\n\n*all Returns all fields.
\n*navigable Returns navigable fields.
\nAny issue field, prefixed with a minus to exclude.
\n
\nExamples:
\n\nsummary,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.
\nNote: All fields are returned by default. This differs from Search for issues using JQL (GET) and Search for issues using JQL (POST) where the default is all navigable fields.
\n","schema":{"type":"array","items":{"type":"string","default":"*all"}}},{"name":"fieldsByKeys","in":"query","description":"Indicates 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.
\n","schema":{"type":"boolean","default":false}},{"name":"expand","in":"query","description":"Use expand to include additional information about the issues in the response. This parameter accepts multiple values separated by a comma:
\n\nrenderedFields Returns field values rendered in HTML format.
\nnames Returns the display name of each field.
\nschema Returns the schema describing a field type.
\ntransitions Returns all possible transitions for the issue.
\neditmeta Returns information about how each field can be edited.
\nchangelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent.
\nversionedRepresentations 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.
\n
\n","schema":{"type":"string"}},{"name":"properties","in":"query","description":"A comma-separated list of issue properties to return for the issue. Allowed values:
\n\n*all Returns all issue properties.
\nAny 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.
\nprop1,prop2 Returns prop1 and prop2 properties.
\n
\nThis parameter may be specified multiple times. For example, properties=prop1,prop2& properties=prop3.
\n","schema":{"type":"array","items":{"type":"string","default":null}}},{"name":"updateHistory","in":"query","description":"Indicates 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 lastViewed field.
\n","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueBean"},"example":"{\"id\":\"10002\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10002\",\"key\":\"EX-1\",\"fields\":{\"watcher\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers\",\"isWatching\":false,\"watchCount\":1,\"watchers\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false}]},\"attachment\":[{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/attachments/10000\",\"filename\":\"picture.jpg\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-05T04:31:46.734+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"https://your-domain.atlassian.net/jira/attachments/10000\",\"thumbnail\":\"https://your-domain.atlassian.net/jira/secure/thumbnail/10000\"}],\"sub-tasks\":[{\"id\":\"10000\",\"type\":{\"id\":\"10000\",\"name\":\"\",\"inward\":\"Parent\",\"outward\":\"Sub-task\"},\"outwardIssue\":{\"id\":\"10003\",\"key\":\"EX-2\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/EX-2\",\"fields\":{\"status\":{\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"description\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"example bug report\"}]}]},\"project\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"},\"comment\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"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\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-05T04:31:45.088+0000\",\"updated\":\"2019-09-05T04:31:45.089+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}],\"issuelinks\":[{\"id\":\"10001\",\"type\":{\"id\":\"10000\",\"name\":\"Dependent\",\"inward\":\"depends on\",\"outward\":\"is depended by\"},\"outwardIssue\":{\"id\":\"10004L\",\"key\":\"PRJ-2\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/PRJ-2\",\"fields\":{\"status\":{\"iconUrl\":\"http://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\":\"PRJ-3\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/PRJ-3\",\"fields\":{\"status\":{\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"worklog\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2019-09-05T04:31:45.519+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2019-09-05T04:31:45.519+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.
\n"},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Issue"],"summary":"Edit issue","description":"Edits an issue. A transition may be applied and issue properties updated as part of the edit.
\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. 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.
\nConnect app users with admin permissions (from user permissions and app scopes) can override the screen security configuration using overrideScreenSecurity and overrideEditableFlag.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects and Edit issues project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"editIssue","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"notifyUsers","in":"query","description":"Indicates 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.
\n","schema":{"type":"boolean","default":true}},{"name":"overrideScreenSecurity","in":"query","description":"Indicates whether screen security should be overridden to enable hidden fields to be edited. Available to Connect app users with admin permissions.
\n","schema":{"type":"boolean","default":false}},{"name":"overrideEditableFlag","in":"query","description":"Indicates whether screen security should be overridden to enable uneditable fields to be edited. Available to Connect app users with admin permissions.
\n","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueUpdateDetails"},"example":{"historyMetadata":{"actor":{"avatarUrl":"http://mysystem/avatar/tony.jpg","displayName":"Tony","id":"tony","type":"mysystem-user","url":"http://mysystem/users/tony"},"extraData":{"goes":"here","keyvalue":"extra data"},"description":"text description","generator":{"id":"mysystem-1","type":"mysystem-application"},"cause":{"id":"myevent","type":"mysystem-event"},"activityDescription":"text description","type":"myplugin:type"},"update":{"summary":[{"set":"Bug in business logic"}],"components":[{"set":""}],"timetracking":[{"edit":{"remainingEstimate":"4d","originalEstimate":"1w 1d"}}],"labels":[{"add":"triaged"},{"remove":"blocker"}]},"fields":{"summary":"This is a shorthand for a set operation on the summary field","customfield_10010":1,"customfield_10000":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"This is a shorthand for a set operation on a text custom field","type":"text"}]}]}},"properties":[{"value":"can be set at issue create or update time","key":"key1"},{"value":"and there can be multiple properties","key":"key2"}]}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if:
\n\nthe request body is missing.
\nthe user does not have the necessary permissions to edit one or more fields.
\nthe request includes one or more fields that are not found or are not associated with the issue's edit screen.
\nthe request includes an invalid transition.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user uses overrideScreenSecurity or overrideEditableFlag but doesn't have the necessary permissions.
\n"},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Issue"],"summary":"Delete issue","description":"Deletes an issue.
\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.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects and Delete issues project permission for the project containing the issue.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"deleteIssue","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"deleteSubtasks","in":"query","description":"Indicates whether the issue's subtasks are deleted when the issue is deleted.
\n","schema":{"type":"string","enum":["true","false"],"default":"false"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the issue has subtasks and deleteSubtasks is not set to true.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"},"403":{"description":"Returned if the user does not have permission to delete the issue.
\n"},"404":{"description":"Returned if the issue is not found or the user does not have permission to view the issue.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/{issueIdOrKey}/assignee":{"put":{"tags":["Issue"],"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.
\nIf name or accountId is set to:
\n\n"-1", the issue is assigned to the default assignee for the project.
\nnull, the issue is set to unassigned.
\n
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse Projects and Assign Issues  project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"assignIssue","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue to be assigned.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The request object with the user that the issue is assigned to.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":{"accountId":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if:
\n\nthe user is not found.
\nname, key, or accountId is missing.
\nmore than one of name, key, and accountId are provided.
\n
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the issue is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/{issueIdOrKey}/attachments":{"post":{"tags":["IssueAttachments"],"summary":"Add attachment","description":"Adds one or more attachments to an issue. Attachments are posted as multipart/form-data (RFC 1867).
\nNote that:
\n\nThe request must have a X-Atlassian-Token: no-check header, if not it is blocked. See Special headers for more information.
\nThe name of the multipart/form-data parameter that contains the attachments must be file.
\n
\nThe following example uploads a file called myfile.txt to the issue TEST-123:
\ncurl -D- -u admin:admin -X POST -H "X-Atlassian-Token: no-check" -F "[email protected]" https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachments
\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 class for multipart POST operations.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse Projects and Create attachments  project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"addAttachment","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue that attachments are added to.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}},"example":"[{\"self\":\"http://www.example.com/jira/rest/api/3/attachments/10000\",\"id\":\"10001\",\"filename\":\"picture.jpg\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"https://avatar-cdn.atlassian.com/avatar-unique-id?s=48\",\"24x24\":\"https://avatar-cdn.atlassian.com/avatar-unique-id?s=24\",\"16x16\":\"https://avatar-cdn.atlassian.com/avatar-unique-id?s=16\",\"32x32\":\"https://avatar-cdn.atlassian.com/avatar-unique-id?s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"2019-09-05T04:31:48.807+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"http://www.example.com/jira/attachments/10000\",\"thumbnail\":\"http://www.example.com/jira/secure/thumbnail/10000\"},{\"self\":\"http://www.example.com/jira/rest/api/3/attachments/10001\",\"filename\":\"dbeuglog.txt\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"https://avatar-cdn.atlassian.com/avatar-unique-id?s=48\",\"24x24\":\"https://avatar-cdn.atlassian.com/avatar-unique-id?s=24\",\"16x16\":\"https://avatar-cdn.atlassian.com/avatar-unique-id?s=16\",\"32x32\":\"https://avatar-cdn.atlassian.com/avatar-unique-id?s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"2019-09-05T04:31:48.807+0000\",\"size\":2460,\"mimeType\":\"text/plain\",\"content\":\"http://www.example.com/jira/attachments/10001\",\"thumbnail\":\"http://www.example.com/jira/secure/thumbnail/10002\"}]"}}},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if any of the following is true:
\n\nthe issue is not found.
\nthe user does not have permission to view the issue.
\n
\n"},"413":{"description":"The attachments exceed the maximum attachment size for issues. See Configuring file attachments for details.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/{issueIdOrKey}/changelog":{"get":{"tags":["IssueChangelog"],"summary":"Get change logs","description":"Returns all changelogs for an issue sorted by date, starting from the oldest.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"getChangeLogs","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","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).
\n","schema":{"type":"integer","format":"int32","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 100.
\n","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanChangelog"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/TT-1/changelog?startAt=2&maxResults=2\",\"nextPage\":\"http://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\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"https://avatar-cdn.atlassian.com/avatar-unique-id?s=48\",\"24x24\":\"https://avatar-cdn.atlassian.com/avatar-unique-id?s=24\",\"16x16\":\"https://avatar-cdn.atlassian.com/avatar-unique-id?s=16\",\"32x32\":\"https://avatar-cdn.atlassian.com/avatar-unique-id?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\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"https://avatar-cdn.atlassian.com/avatar-unique-id?s=48\",\"24x24\":\"https://avatar-cdn.atlassian.com/avatar-unique-id?s=24\",\"16x16\":\"https://avatar-cdn.atlassian.com/avatar-unique-id?s=16\",\"32x32\":\"https://avatar-cdn.atlassian.com/avatar-unique-id?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.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issue/{issueIdOrKey}/comment":{"get":{"tags":["IssueComment"],"summary":"Get comments","description":"Returns all comments for an issue.
\nThis operation can be accessed anonymously.
\nPermissions required: Comments are included in the response where the user has:
\n\nBrowse projects project permission for the project containing the comment.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nIf the comment has visibility restrictions, belongs to the group or has the role visibility is role visibility is restricted to.
\n
\n","operationId":"getComments","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","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).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 100.
\n","schema":{"type":"integer","format":"int32","default":50}},{"name":"orderBy","in":"query","description":"The field to order returned comments by. Only accepts the value created, which orders comments by their created date.
\n","schema":{"type":"string","enum":["created","-created"]}},{"name":"expand","in":"query","description":"Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfComments"},"example":"{\"startAt\":0,\"maxResults\":1,\"total\":1,\"comments\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"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\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-05T04:31:45.088+0000\",\"updated\":\"2019-09-05T04:31:45.089+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}]}"}}},"400":{"description":"Returned if orderBy is set to a value other than created.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["IssueComment"],"summary":"Add comment","description":"Adds a comment to an issue.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects and Add comments  project permission for the project that the issue containing the comment is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"addComment","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.
\n","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Comment"},"example":{"visibility":{"type":"role","value":"Administrators"},"body":{"type":"doc","version":1,"content":[{"type":"paragraph","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"}]}]}}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Comment"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"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\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-05T04:31:45.088+0000\",\"updated\":\"2019-09-05T04:31:45.089+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/{issueIdOrKey}/comment/{id}":{"get":{"tags":["IssueComment"],"summary":"Get comment","description":"Returns a comment.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project containing the comment.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nIf the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
\n
\n","operationId":"getComment","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the comment.
\n","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Comment"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"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\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-05T04:31:45.088+0000\",\"updated\":\"2019-09-05T04:31:45.089+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the issue or comment is not found or the user does not have permission to view the issue or comment.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["IssueComment"],"summary":"Update comment","description":"Updates a comment.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue containing the comment is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nEdit all comments project permission to update any comment or Edit own comments to update comment created by the user.
\nIf the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
\n
\n","operationId":"updateComment","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the comment.
\n","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.
\n","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Comment"},"example":{"visibility":{"type":"role","value":"Administrators"},"body":{"type":"doc","version":1,"content":[{"type":"paragraph","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"}]}]}}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Comment"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"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\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-05T04:31:45.088+0000\",\"updated\":\"2019-09-05T04:31:45.089+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}"}}},"400":{"description":"Returned if the user does not have permission to edit the comment or the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the issue or comment is not found or the user does not have permission to view the issue or comment.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["IssueComment"],"summary":"Delete comment","description":"Deletes a comment.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue containing the comment is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nDelete all comments project permission to delete any comment or Delete own comments to delete comment created by the user,
\nIf the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
\n
\n","operationId":"deleteComment","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the comment.
\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the user does not have permission to delete the comment.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the issue or comment is not found or the user does not have permission to view the issue or comment.
\n"},"405":{"description":"Returned if an anonymous call is made to the operation.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/{issueIdOrKey}/editmeta":{"get":{"tags":["Issue"],"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.
\nConnect app users with admin permissions (from user permissions and app scopes) can return additional details using:
\n\noverrideScreenSecurity Returns hidden fields.
\noverrideEditableFlag Returns uneditable fields. For example, where an issue has a workflow status of closed none of its fields are editable.
\n
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security 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 for the issue.
\n","operationId":"getEditIssueMeta","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"overrideScreenSecurity","in":"query","description":"Indicates whether hidden fields should be returned. Available to connect app users with admin permissions.
\n","schema":{"type":"boolean","default":false}},{"name":"overrideEditableFlag","in":"query","description":"Indicates whether non-editable fields should be returned. Available to connect app users with admin permissions.
\n","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"403":{"description":"Returned if the user uses an override parameter but doesn't have permission to do so.
\n"},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issue/{issueIdOrKey}/notify":{"post":{"tags":["Issue"],"summary":"Send notification for issue","description":"Creates an email notification for an issue and adds it to the mail queue.
\nPermissions required:
\n\nBrowse Projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"notify","parameters":[{"name":"issueIdOrKey","in":"path","description":"ID or key of the issue that the notification is sent for.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The request object for the notification and recipients.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notification"},"example":{"htmlBody":"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.","subject":"Duis eu justo eget augue iaculis fermentum.","textBody":"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.","to":{"voters":true,"watchers":true,"groups":[{"name":"notification-group"}],"reporter":false,"assignee":false,"users":[{"accountId":"5b10a2844c20165700ede21g","active":false}]},"restrict":{"permissions":[{"key":"BROWSE"}],"groups":[{"name":"notification-group"}]}}}},"required":true},"responses":{"204":{"description":"Returned if the email is queued for sending.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if:
\n\nthe recipient is the same as the calling user.
\nthe recipient is invalid. For example, the recipient is set to the assignee, but the issue is unassigned.
\nthe request is invalid. For example, required fields are missing or have invalid values.
\n
\n"},"403":{"description":"Returned if:
\n\noutgoing emails are disabled.
\nno SMTP server is configured.
\n
\n"},"404":{"description":"Returned if the issue is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/{issueIdOrKey}/properties":{"get":{"tags":["IssueProperty"],"summary":"Get issue property keys","description":"Returns the URLs and keys of an issue's properties.
\nThis operation can be accessed anonymously.
\nPermissions required: Property details are only returned where the user has:
\n\nBrowse projects project permission for the project containing the issue.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"getIssuePropertyKeys","parameters":[{"name":"issueIdOrKey","in":"path","description":"The key or ID of the issue.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyKeys"},"example":"{\"keys\":[{\"self\":\"http://your-domain.atlassian.net/jira/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.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}":{"get":{"tags":["IssueProperty"],"summary":"Get issue property","description":"Returns the key and value of an issue's property.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project containing the issue.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"getIssueProperty","parameters":[{"name":"issueIdOrKey","in":"path","description":"The key or ID of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"404":{"description":"Returned if the issue or property is not found or the user does not have permission to see the issue.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["IssueProperty"],"summary":"Set issue property","description":"Sets the value of an issue's property. Use this resource to store custom data against an issue.
\nThe value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects and Edit issues project permissions for the project containing the issue.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"setIssueProperty","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the issue property. The maximum length is 255 characters.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{}}},"required":true},"responses":{"200":{"description":"Returned if the issue property is updated.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"Returned if the issue property is created.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have permission to edit the issue.
\n"},"404":{"description":"Returned if the issue is not found or the user does not have permission to view the issue.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["IssueProperty"],"summary":"Delete issue property","description":"Deletes an issue's property.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects and Edit issues project permissions for the project containing the issue.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"deleteIssueProperty","parameters":[{"name":"issueIdOrKey","in":"path","description":"The key or ID of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property.
\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the issue or property is not found, or the user does not have permission to edit the issue.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/{issueIdOrKey}/remotelink":{"get":{"tags":["Issue"],"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.
\nThis operation requires issue linking to be active.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"getRemoteIssueLinks","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"globalId","in":"query","description":"The global ID of the remote issue link.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteIssueLink"},"example":"[{\"id\":10000,\"self\":\"http://www.example.com/jira/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\":\"http://www.example.com/jira/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=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"}}}}]"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if issue linking is disabled.
\n"},"404":{"description":"Returned if the the issue or remote issue link is not found or the user does not have permission to view the issue.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Issue"],"summary":"Create or update remote issue link","description":"Creates or updates a remote issue link for an issue.
\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.
\nThis operation requires issue linking to be active.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects and Link issues project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"createOrUpdateRemoteIssueLink","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","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","relationship":"causes","object":{"summary":"Customer support issue","icon":{"url16x16":"http://www.mycompany.com/support/ticket.png","title":"Support Ticket"},"title":"TSTSUP-111","url":"http://www.mycompany.com/support?id=1","status":{"icon":{"url16x16":"http://www.mycompany.com/support/resolved.png","link":"http://www.mycompany.com/support?id=1&details=closed","title":"Case Closed"},"resolved":true}}}}},"required":true},"responses":{"200":{"description":"Returned if the remote issue link is updated.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteIssueLinkIdentifies"},"example":"{\"id\":10000,\"self\":\"http://www.example.com/jira/rest/api/issue/MKY-1/remotelink/10000\"}"}}},"201":{"description":"Returned if the remote issue link is created.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteIssueLinkIdentifies"},"example":"{\"id\":10000,\"self\":\"http://www.example.com/jira/rest/api/issue/MKY-1/remotelink/10000\"}"}}},"400":{"description":"Returned if the request is invalid.
\n","content":{"application/json":{"example":"{\"errorMessages\":[],\"errors\":{\"title\":\"'title' is required.\"}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have permission to link issues.
\n"},"404":{"description":"Returned if the issue is not found or the user does not have permission to view the issue.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Issue"],"summary":"Delete remote issue link by global id","description":"Deletes the remote issue link from the issue using the link's global ID.
\nThis operation requires issue linking to be active.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects and Link issues project permission for the project that the issue is in.
\nIf issue-level security is implemented, issue-level security permission to view the issue.
\n
\n","operationId":"deleteRemoteIssueLinkByGlobalId","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"globalId","in":"query","description":"The global ID of a remote issue link.
\n","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if a global ID isn't provided.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have permission to link issues.
\n"},"404":{"description":"Returned if the issue or remote issue link is not found or the user does not have permission to view the issue.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}":{"get":{"tags":["Issue"],"summary":"Get remote issue link by id","description":"Returns a remote issue link for an issue.
\nThis operation requires issue linking to be active.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"getRemoteIssueLinkById","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"linkId","in":"path","description":"The ID of the remote issue link.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteIssueLink"},"example":"{\"id\":10000,\"self\":\"http://www.example.com/jira/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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if issue linking is disabled.
\n"},"404":{"description":"Returned if the issue or remote issue link is not found or the user does not have permission to view the issue.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Issue"],"summary":"Update remote issue link","description":"Updates a remote issue link for an issue.
\nNote: Fields without values in the request are set to null.
\nThis operation requires issue linking to be active.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects and Link issues project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"updateRemoteIssueLink","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"linkId","in":"path","description":"The ID of the remote issue link.
\n","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","relationship":"causes","object":{"summary":"Customer support issue","icon":{"url16x16":"http://www.mycompany.com/support/ticket.png","title":"Support Ticket"},"title":"TSTSUP-111","url":"http://www.mycompany.com/support?id=1","status":{"icon":{"url16x16":"http://www.mycompany.com/support/resolved.png","link":"http://www.mycompany.com/support?id=1&details=closed","title":"Case Closed"},"resolved":true}}}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if:
\n\nthe link ID is invalid.
\nthe remote issue link does not belong to the issue.
\nthe request body is invalid.
\n
\n","content":{"application/json":{"example":"{\"errorMessages\":[],\"errors\":{\"title\":\"'title' is required.\"}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have permission to link issues.
\n"},"404":{"description":"Returned if the issue or remote issue link is not found or the user does not have permission to view the issue.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Issue"],"summary":"Delete remote issue link by id","description":"Deletes a remote issue link from an issue.
\nThis operation requires issue linking to be active.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects, Edit issues, and Link issues project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"deleteRemoteIssueLinkById","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"linkId","in":"path","description":"The ID of a remote issue link.
\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the link ID is invalid or the remote issue link does not belong to the issue.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have permission to link issues.
\n"},"404":{"description":"Returned if the issue or remote issue link is not found or the user does not have permission to view the issue.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/{issueIdOrKey}/transitions":{"get":{"tags":["Issue"],"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.
\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.
\nThis operation can be accessed anonymously.
\nPermissions required: A list or transition is returned only when the user has:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\nHowever, if the user does not have the Transition issues  project permission the response will not list any transitions.
\n","operationId":"getTransitions","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use expand 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.
\n","schema":{"type":"string"}},{"name":"transitionId","in":"query","description":"The ID of the transition.
\n","schema":{"type":"string"}},{"name":"skipRemoteOnlyCondition","in":"query","description":"Indicates whether transitions with the condition Hide From User Condition are included in the response.
\n","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transitions"},"example":"{\"transitions\":[{\"id\":\"2\",\"name\":\"Close Issue\",\"to\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/status/10000\",\"description\":\"The issue is currently being worked on.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/progress.gif\",\"name\":\"In Progress\",\"id\":\"10000\",\"statusCategory\":{\"self\":\"http://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,\"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\":\"http://your-domain.atlassian.net/rest/api/3/status/5\",\"description\":\"The issue is closed.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/closed.gif\",\"name\":\"Closed\",\"id\":\"5\",\"statusCategory\":{\"self\":\"http://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.
\n"},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Issue"],"summary":"Transition issue","description":"Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.
\nTo update the fields on the transition screen, specify the fields in the fields or update parameters in the request body. Get details about the fields using  Get transitions with the transitions.fields expand.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects and Transition issues project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"doTransition","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueUpdateDetails"},"example":{"historyMetadata":{"actor":{"avatarUrl":"http://mysystem/avatar/tony.jpg","displayName":"Tony","id":"tony","type":"mysystem-user","url":"http://mysystem/users/tony"},"extraData":{"goes":"here","keyvalue":"extra data"},"description":"text description","generator":{"id":"mysystem-1","type":"mysystem-application"},"cause":{"id":"myevent","type":"mysystem-event"},"activityDescription":"text description","type":"myplugin:type"},"update":{"comment":[{"add":{"body":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"Bug has been fixed","type":"text"}]}]}}}]},"fields":{"assignee":{"name":"bob"},"resolution":{"name":"Fixed"}},"transition":{"id":"5"}}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if:
\n\nno transition is specified.
\nthe user does not have permission to transition the issue.
\na field that isn't included on the transition screen is defined in fields or update.
\na field is specified in both fields and update.
\nthe request is invalid for any other reason.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/{issueIdOrKey}/votes":{"get":{"tags":["Issue"],"summary":"Get votes","description":"Returns details about the votes on an issue.
\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 for details.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is ini
\nIf issue-level security 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.
\n","operationId":"getVotes","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Votes"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/issue/MKY-1/votes\",\"votes\":24,\"hasVoted\":true,\"voters\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nvoting is disabled.
\nthe user does not have permission to view the issue.
\nthe issue is not found.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Issue"],"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.
\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 for details.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"addVote","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nvoting is disabled.
\nthe user is the issue reporter.
\nthe issue is not found.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Issue"],"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.
\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 for details.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"removeVote","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nvoting is disabled.
\nthe user has not voted on the issue.
\nthe user is the issue reporter.
\nthe issue is not found.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/{issueIdOrKey}/watchers":{"get":{"tags":["Issue"],"summary":"Get issue watchers","description":"Returns the watchers for an issue.
\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 for details.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is ini
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nTo see details of users on the watchlist other than themselves, View voters and watchers project permission for the project that the issue is in.
\n
\n","operationId":"getIssueWatchers","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Watchers"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers\",\"isWatching\":false,\"watchCount\":1,\"watchers\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Issue"],"summary":"Add watcher","description":"Adds a user as a watcher of an issue by passing the account ID of the user. For example, "384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192". If no user is specified the calling user is added.
\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 for details.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nTo add users other than themselves to the watchlist, Manage watcher list project permission for the project that the issue is in.
\n
\n","operationId":"addWatcher","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The account ID of the user. Note that username cannot be used due to privacy changes.
\n","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the permission to manage the watcher list.
\n"},"404":{"description":"Returned if the issue or the user is not found or the user does not have permission to view the issue.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Issue"],"summary":"Delete watcher","description":"Deletes a user as a watcher of an issue.
\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 for details.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nTo remove users other than themselves from the watchlist, Manage watcher list project permission for the project that the issue is in.
\n
\n","operationId":"removeWatcher","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"username","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}},{"name":"accountId","in":"query","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.
\n","schema":{"type":"string","example":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"},"x-showInExample":"true"}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if accountId is not supplied.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the permission to manage the watcher list.
\n"},"404":{"description":"Returned if the issue or the user is not found or the user does not have permission to view the issue.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/{issueIdOrKey}/worklog":{"get":{"tags":["IssueWorklogs"],"summary":"Get issue worklogs","description":"Returns all worklogs for an issue.
\nTime tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.
\nThis operation can be accessed anonymously.
\nPermissions required: Workloads are only returned where the user has:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nIf the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
\n
\n","operationId":"getIssueWorklog","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","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).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 1048576.
\n","schema":{"type":"integer","format":"int32","default":1048576}},{"name":"expand","in":"query","description":"Use expand to include additional information about worklogs in the response. This parameter accepts multiple values separated by a comma:
\n\nproperties Returns worklog properties.
\n
\n","schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Returned if the request is successful
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfWorklogs"},"example":"{\"startAt\":0,\"maxResults\":1,\"total\":1,\"worklogs\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2019-09-05T04:31:45.519+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2019-09-05T04:31:45.519+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nthe issue is not found or the user does not have permission to view the issue.
\nstartAt or maxResults has non-numeric values.
\ntime tracking is disabled.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["IssueWorklogs"],"summary":"Add worklog","description":"Adds a worklog to an issue.
\nTime tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects and Work on issues project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"addWorklog","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"notifyUsers","in":"query","description":"Indicates whether users watching the issue are notified by email.
\n","schema":{"type":"boolean","default":true}},{"name":"adjustEstimate","in":"query","description":"Defines how to update the issue's time estimate, the options are:
\n\nnew Sets the estimate to a specific value, defined in newEstimate.
\nleave Leaves the estimate unchanged.
\nmanual Reduces the estimate by amount specified in reduceBy.
\nauto Reduces the estimate by the value of timeSpent in the worklog.
\n
\n","schema":{"type":"string","enum":["new","leave","manual","auto"],"default":"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.
\n","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.
\n","schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use expand to include additional information about work logs in the response. This parameter accepts multiple values separated by a comma:
\n\nproperties Returns worklog properties.
\n
\n","schema":{"type":"string","default":""}},{"name":"overrideEditableFlag","in":"query","description":"Indicates 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. Only connect app users with admin scope permission can use this flag.
\n","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Worklog"},"example":{"timeSpentSeconds":12000,"visibility":{"type":"group","value":"jira-developers"},"comment":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"I did some work here.","type":"text"}]}]},"started":"2019-09-05T04:31:45.518+0000"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Worklog"}}}},"400":{"description":"Returned if:
\n\nadjustEstimate is set to new but newEstimate is not provided or is invalid.
\nadjustEstimate is set to manual but reduceBy is not provided or is invalid.
\nthe user does not have permission to add the worklog.
\nthe request JSON is malformed.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"},"404":{"description":"Returned if the issue is not found or the user does not have permission to view it.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issue/{issueIdOrKey}/worklog/{id}":{"get":{"tags":["IssueWorklogs"],"summary":"Get worklog","description":"Returns a worklog.
\nTime tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nIf the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
\n
\n","operationId":"getWorklog","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the worklog.
\n","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use expand to include additional information about work logs in the response. This parameter accepts multiple values separated by a comma:
\n\nproperties Returns worklog properties.
\n
\n","schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Worklog"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2019-09-05T04:31:45.519+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2019-09-05T04:31:45.519+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"},"404":{"description":"Returned if:
\n\nthe issue is not found or the user does not have permission to view it.
\nthe worklog is not found or the user does not have permission to view it.
\ntime tracking is disabled.
\n
\n.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["IssueWorklogs"],"summary":"Update worklog","description":"Updates a worklog.
\nTime tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nEdit all worklogs project permission to update any worklog or Edit own worklogs to update worklogs created by the user.
\nIf the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
\n
\n","operationId":"updateWorklog","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the worklog.
\n","required":true,"schema":{"type":"string"}},{"name":"notifyUsers","in":"query","description":"Indicates whether users watching the issue are notified by email.
\n","schema":{"type":"boolean","default":true}},{"name":"adjustEstimate","in":"query","description":"Defines how to update the issue's time estimate, the options are:
\n\nnew Sets the estimate to a specific value, defined in newEstimate.
\nleave Leaves the estimate unchanged.
\nauto Updates the estimate by the difference between the original and updated value of timeSpent or timeSpentSeconds.
\n
\n","schema":{"type":"string","enum":["new","leave","manual","auto"],"default":"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.
\n","schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use expand to include additional information about worklogs in the response. This parameter accepts multiple values separated by a comma:
\n\nproperties Returns worklog properties.
\n
\n","schema":{"type":"string","default":""}},{"name":"overrideEditableFlag","in":"query","description":"Indicates whether the worklog should be added to the issue even if the issue is not editable. For example, because the issue is closed. Only connect app users with admin permissions can use this flag.
\n","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Worklog"},"example":{"timeSpentSeconds":12000,"visibility":{"type":"group","value":"jira-developers"},"comment":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"I did some work here.","type":"text"}]}]},"started":"2019-09-05T04:31:45.518+0000"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Worklog"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2019-09-05T04:31:45.519+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2019-09-05T04:31:45.519+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}"}}},"400":{"description":"Returned if:
\n\nadjustEstimate is set to new but newEstimate is not provided or is invalid.
\nthe user does not have permission to update the worklog.
\nthe request JSON is malformed.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"},"404":{"description":"Returned if:
\n\nthe issue is not found or user does not have permission to view the issue.
\nthe worklog is not found or the user does not have permission to view it.
\ntime tracking is disabled.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["IssueWorklogs"],"summary":"Delete worklog","description":"Deletes a worklog from an issue.
\nTime tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nDelete all worklogs project permission to delete any worklog or Delete own worklogs to delete worklogs created by the user,
\nIf the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
\n
\n","operationId":"deleteWorklog","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the worklog.
\n","required":true,"schema":{"type":"string"}},{"name":"notifyUsers","in":"query","description":"Indicates whether users watching the issue are notified by email.
\n","schema":{"type":"boolean","default":true}},{"name":"adjustEstimate","in":"query","description":"Defines how to update the issue's time estimate, the options are:
\n\nnew Sets the estimate to a specific value, defined in newEstimate.
\nleave Leaves the estimate unchanged.
\nmanual Increases the estimate by amount specified in increaseBy.
\nauto Reduces the estimate by the value of timeSpent in the worklog.
\n
\n","schema":{"type":"string","enum":["new","leave","manual","auto"],"default":"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.
\n","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.
\n","schema":{"type":"string"}},{"name":"overrideEditableFlag","in":"query","description":"Indicates 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. Only connect app users with admin permissions can use this flag.
\n","schema":{"type":"boolean","default":false}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if:
\n\nadjustEstimate is set to new but newEstimate is not provided or is invalid.
\nadjustEstimate is set to manual but reduceBy is not provided or is invalid.
\nthe user does not have permission to delete the worklog.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"},"404":{"description":"Returned if:
\n\nthe issue is not found or user does not have permission to view the issue.
\nthe worklog is not found or the user does not have permission to view it.
\ntime tracking is disabled.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties":{"get":{"tags":["WorklogProperty"],"summary":"Get worklog property keys","description":"Returns the keys of all properties for a worklog.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nIf the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
\n
\n","operationId":"getWorklogPropertyKeys","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"worklogId","in":"path","description":"The ID of the worklog.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyKeys"},"example":"{\"keys\":[{\"self\":\"http://your-domain.atlassian.net/jira/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"}}},"400":{"description":"Returned if the worklog ID is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nthe issue or worklog is not found.
\nthe user does not have permission to view the issue or worklog.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}":{"get":{"tags":["WorklogProperty"],"summary":"Get worklog property","description":"Returns the value of a worklog property.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nIf the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
\n
\n","operationId":"getWorklogProperty","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"worklogId","in":"path","description":"The ID of the worklog.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nthe issue, worklog, or property is not found.
\nthe user does not have permission to view the issue or worklog.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["WorklogProperty"],"summary":"Set worklog property","description":"Sets the value of a worklog property. Use this operation to store custom data against the worklog.
\nThe value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nEdit all worklogs project permission to update any worklog or Edit own worklogs to update worklogs created by the user.
\nIf the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
\n
\n","operationId":"setWorklogProperty","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"worklogId","in":"path","description":"The ID of the worklog.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the issue property. The maximum length is 255 characters.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{}}},"required":true},"responses":{"200":{"description":"Returned if the worklog property is updated.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"Returned if the worklog property is created.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if the worklog ID is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have permission to edit the worklog.
\n"},"404":{"description":"Returned if:
\n\nthe issue or worklog is not found.
\nthe user does not have permission to view the issue or worklog.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["WorklogProperty"],"summary":"Delete worklog property","description":"Deletes a worklog property.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nIf the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
\n
\n","operationId":"deleteWorklogProperty","parameters":[{"name":"issueIdOrKey","in":"path","description":"The ID or key of the issue.
\n","required":true,"schema":{"type":"string"}},{"name":"worklogId","in":"path","description":"The ID of the worklog.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property.
\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the worklog property is removed.
\n"},"400":{"description":"Returned if the worklog key or id is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have permission to edit the worklog.
\n"},"404":{"description":"Returned if:
\n\nthe issue, worklog, or property is not found.
\nthe user does not have permission to view the issue or worklog.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issueLink":{"post":{"tags":["LinkIssue"],"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 enabled.
\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.
\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.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse project project permission for all the projects containing the issues to be linked,
\nLink issues project permission on the project containing the from (outward) issue,
\nIf issue-level security is configured, issue-level security permission to view the issue.
\nIf the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
\n
\n","operationId":"linkIssues","parameters":[],"requestBody":{"description":"The issue link request.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkIssueRequestJsonBean"},"example":{"outwardIssue":{"key":"MKY-1"},"comment":{"visibility":{"type":"group","value":"jira-software-users"},"body":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"Linked related issue!","type":"text"}]}]}},"inwardIssue":{"key":"HSP-1"},"type":{"name":"Duplicate"}}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nissue linking is disabled.
\nthe 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.
\nthe user does not have link issues project permission.
\neither of the link issues are not found.
\nthe issue link type is not found.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"}},"/rest/api/3/issueLink/{linkId}":{"get":{"tags":["LinkIssue"],"summary":"Get issue link","description":"Returns an issue link.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse project project permission for all the projects containing the linked issues.
\nIf issue-level security is configured, permission to view both of the issues.
\n
\n","operationId":"getIssueLink","parameters":[{"name":"linkId","in":"path","description":"The ID of the issue link.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueLink"},"example":"{\"id\":\"10001\",\"type\":{\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated by\",\"outward\":\"Duplicates\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueLinkType/1000\"},\"inwardIssue\":{\"id\":\"10004\",\"key\":\"PRJ-3\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/PRJ-3\",\"fields\":{\"status\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/status/5\",\"description\":\"The issue is closed.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/closed.gif\",\"name\":\"Closed\",\"id\":\"5\",\"statusCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/9\",\"id\":9,\"key\":\"completed\",\"colorName\":\"green\"}},\"priority\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/priority/5\",\"statusColor\":\"#cfcfcf\",\"description\":\"Very little impact.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/priorities/trivial.png\",\"name\":\"Trivial\",\"id\":\"2\"},\"issuetype\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"http://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}}},\"outwardIssue\":{\"id\":\"10004L\",\"key\":\"PRJ-2\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/PRJ-2\",\"fields\":{\"status\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/status/10000\",\"description\":\"The issue is currently being worked on.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/progress.gif\",\"name\":\"In Progress\",\"id\":\"10000\",\"statusCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In Progress\"}},\"priority\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/priority/3\",\"statusColor\":\"#009900\",\"description\":\"Major loss of function.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/priorities/major.png\",\"name\":\"Major\",\"id\":\"1\"},\"issuetype\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"http://your-domain.atlassian.net//secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1}}}}"}}},"400":{"description":"Returned if the issue link ID is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nissue linking is disabled.
\nthe issue link is not found.
\nthe user doesn't have the required permissions.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"delete":{"tags":["LinkIssue"],"summary":"Delete issue link","description":"Deletes an issue link.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nBrowse project project permission for all the projects containing the issues in the link.
\nLink issues project permission for at least one of the projects containing issues in the link.
\nIf issue-level security is configured, permission to view both of the issues.
\n
\n","operationId":"deleteIssueLink","parameters":[{"name":"linkId","in":"path","description":"The ID of the issue link.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200 response
\n"},"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the issue link ID is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nissue linking is disabled.
\nthe issue link is not found.
\nthe user doesn't have the required permissions.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/issueLinkType":{"get":{"tags":["IssueLinkType"],"summary":"Get issue link types","description":"Returns a list of all issue link types.
\nTo use this operation, the site must have issue linking enabled.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse projects project permission for a project in the site.
\n","operationId":"getIssueLinkTypes","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueLinkTypes"},"example":"{\"issueLinkTypes\":[{\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated by\",\"outward\":\"Duplicates\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueLinkType/1000\"},{\"id\":\"1010\",\"name\":\"Blocks\",\"inward\":\"Blocked by\",\"outward\":\"Blocks\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueLinkType/1010\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if issue linking is disabled.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["IssueLinkType"],"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.
\nTo use this operation, the site must have issue linking enabled.
\nPermissions required: Administer Jira global permission.
\n","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.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueLinkType"},"example":"{\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated by\",\"outward\":\"Duplicates\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueLinkType/1000\"}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nissue linking is disabled.
\nthe issue link type name is in use.
\nthe user does not have the required permissions.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issueLinkType/{issueLinkTypeId}":{"get":{"tags":["IssueLinkType"],"summary":"Get issue link type","description":"Returns an issue link type.
\nTo use this operation, the site must have issue linking enabled.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse projects project permission for a project in the site.
\n","operationId":"getIssueLinkType","parameters":[{"name":"issueLinkTypeId","in":"path","description":"The ID of the issue link type.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueLinkType"},"example":"{\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated by\",\"outward\":\"Duplicates\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueLinkType/1000\"}"}}},"400":{"description":"Returned if the issue link type ID is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nissue linking is disabled.
\nthe issue link type is not found.
\nthe user does not have the required permissions.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["IssueLinkType"],"summary":"Update issue link type","description":"Updates an issue link type.
\nTo use this operation, the site must have issue linking enabled.
\nPermissions required: Administer Jira global permission.
\n","operationId":"updateIssueLinkType","parameters":[{"name":"issueLinkTypeId","in":"path","description":"The ID of the issue link type.
\n","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.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueLinkType"},"example":"{\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated by\",\"outward\":\"Duplicates\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueLinkType/1000\"}"}}},"400":{"description":"Returned if the issue link type ID or the request body are invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nissue linking is disabled.
\nthe issue link type is not found.
\nthe user does not have the required permissions.
\n
\n"}},"deprecated":false,"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["IssueLinkType"],"summary":"Delete issue link type","description":"Deletes an issue link type.
\nTo use this operation, the site must have issue linking enabled.
\nPermissions required: Administer Jira global permission.
\n","operationId":"deleteIssueLinkType","parameters":[{"name":"issueLinkTypeId","in":"path","description":"The ID of the issue link type.
\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the issue link type ID is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nissue linking is disabled.
\nthe issue link type is not found.
\nthe user does not have the required permissions.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuesecurityschemes":{"get":{"tags":["IssueSecurityScheme"],"summary":"Get issue security schemes","description":"Returns all issue security schemes.
\nThis operation can be accessed anonymously.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getIssueSecuritySchemes","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecuritySchemes"},"example":"{\"issueSecuritySchemes\":[{\"self\":\"http://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.
\n"},"403":{"description":"Returned if the user does not have permission to administer issue security schemes.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/issuesecurityschemes/{id}":{"get":{"tags":["IssueSecurityScheme"],"summary":"Get issue security scheme","description":"Returns an issue security scheme along with its security levels.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nAdminister Jira global permission.
\nAdminister Projects project permission for a project that uses the requested issue security scheme.
\n
\n","operationId":"getIssueSecurityScheme","parameters":[{"name":"id","in":"path","description":"The ID of the issue security scheme. Use the Get issue security schemes operation to get a list of issue security scheme IDs.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"},"example":"{\"self\":\"http://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\":\"http://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.
\n"},"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.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/issuetype":{"get":{"tags":["IssueType"],"summary":"Get all issue types for user","description":"Returns all issue types.
\nThis operation can be accessed anonymously.
\nPermissions required: Issue types are only returned as follows:
\n\nif the user has the Administer Jira global permission, all issue types are returned.
\nif the user has the Browse projects project permission for one or more projects, the issue types associated with the projects the user has permission to browse are returned.
\n
\n","operationId":"getIssueAllTypes","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IssueTypeBean"}},"example":"[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"http://your-domain.atlassian.net//secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"http://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["IssueType"],"summary":"Create issue type","description":"Creates an issue type and adds it to the default issue type scheme.
\nPermissions required: Administer Jira global permission.
\n","operationId":"createIssueType","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeCreateBean"},"example":{"name":"name","description":"description","type":"standard"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeBean"}}}},"400":{"description":"Returned if the request is invalid because:
\n\nno content is sent.
\nthe issue type name exceeds 60 characters.
\na subtask issue type is requested on an instance where subtasks are disabled.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"409":{"description":"Returned if the issue type name is in use.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetype/{id}":{"get":{"tags":["IssueType"],"summary":"Get issue type","description":"Returns an issue type.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse projects project permission in a project the issue type is associated with or Administer Jira global permission.
\n","operationId":"getIssueType","parameters":[{"name":"id","in":"path","description":"The ID of the issue type.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeBean"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"http://your-domain.atlassian.net//secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1}"}}},"400":{"description":"Returned if the issue type ID is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nthe issue type is not found.
\nthe user does not have the required permissions.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["IssueType"],"summary":"Update issue type","description":"Updates the issue type.
\nPermissions required: Administer Jira global permission.
\n","operationId":"updateIssueType","parameters":[{"name":"id","in":"path","description":"The ID of the issue type.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeUpdateBean"},"example":{"avatarId":1,"name":"name","description":"description"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeBean"}}}},"400":{"description":"Returned if the request is invalid because:
\n\nno content is sent.
\nthe issue type name exceeds 60 characters.
\nthe avatar is not associated with this issue type.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the issue type is not found.
\n"},"409":{"description":"Returned if the issue type name is in use.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["IssueType"],"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 resource.
\nPermissions required: Administer Jira global permission.
\n","operationId":"deleteIssueType","parameters":[{"name":"id","in":"path","description":"The ID of the issue type.
\n","required":true,"schema":{"type":"string"}},{"name":"alternativeIssueTypeId","in":"query","description":"The ID of the replacement issue type.
\n","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if any issues cannot be updated with the alternative issue type.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if:
\n\nthe issue type is in use and an alternative issue type is not specified.
\nthe issue type or alternative issue type is not found.
\n
\n"},"409":{"description":"Returned if the issue type is in use and:
\n\nalso specified as the alternative issue type.
\nis a standard issue type and the alternative issue type is a subtask.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetype/{id}/alternatives":{"get":{"tags":["IssueType"],"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.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getAlternativeIssueTypes","parameters":[{"name":"id","in":"path","description":"The ID of the issue type.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IssueTypeBean"}},"example":"[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"http://your-domain.atlassian.net//secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"http://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nthe issue type is not found.
\nthe user does not have the required permissions.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issuetype/{id}/avatar2":{"post":{"tags":["IssueType"],"summary":"Load issue type avatar","description":"Loads an avatar for the issue type.
\nSpecify the avatar's local file location in the body of the request. Also, include the following headers:
\n\nX-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers.
\nContent-Type: image/image type Valid image types are JPEG, GIF, or PNG.
\n
\nFor example:
\ncurl --request POST \\ --user [email protected]:<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
\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.
\nThe cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.
\nAfter creating the avatar, use  Update issue type to set it as the issue type's displayed avatar.
\nPermissions required: Administer Jira global permission.
\n","operationId":"createIssueTypeAvatar","parameters":[{"name":"id","in":"path","description":"The ID of the issue type.
\n","required":true,"schema":{"type":"string"}},{"name":"x","in":"query","description":"The X coordinate of the top-left corner of the crop region.
\n","schema":{"type":"integer","format":"int32","default":0}},{"name":"y","in":"query","description":"The Y coordinate of the top-left corner of the crop region.
\n","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"The length of each side of the crop region.
\n","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"*/*":{"schema":{}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.
\n","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\nan image isn't included in the request.
\nthe image type is unsupported.
\nthe crop parameters extend the crop area beyond the edge of the image.
\ncropSize is missing.
\nthe issue type ID is invalid.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the issue type is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/issuetype/{issueTypeId}/properties":{"get":{"tags":["IssueTypeProperty"],"summary":"Get issue type property keys","description":"Returns all the issue type property keys of the issue type.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nAdminister Jira global permission to get the property keys of any issue type.
\nBrowse projects project permission to get the property keys of any issue types associated with the projects the user has permission to browse.
\n
\n","operationId":"getIssueTypePropertyKeys","parameters":[{"name":"issueTypeId","in":"path","description":"The ID of the issue type.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyKeys"},"example":"{\"keys\":[{\"self\":\"http://your-domain.atlassian.net/jira/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"}}},"400":{"description":"Returned if the issue type ID is invalid.
\n"},"404":{"description":"Returned if:
\n\nthe issue type is not found.
\nthe user does not have the required permissions.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}":{"get":{"tags":["IssueTypeProperty"],"summary":"Get issue type property","description":"Returns the key and value of the issue type property.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nAdminister Jira global permission to get the details of any issue type.
\nBrowse projects project permission to get the details of any issue types associated with the projects the user has permission to browse.
\n
\n","operationId":"getIssueTypeProperty","parameters":[{"name":"issueTypeId","in":"path","description":"The ID of the issue type.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property. Use Get issue type property keys to get a list of all issue type property keys.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the issue type or property is not found or the user does not have the required permissions.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["IssueTypeProperty"],"summary":"Set issue type property","description":"Creates or updates the value of the issue type property. Use this resource to store and update data against an issue type.
\nThe value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
\nPermissions required: Administer Jira global permission.
\n","operationId":"setIssueTypeProperty","parameters":[{"name":"issueTypeId","in":"path","description":"The ID of the issue type.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the issue type property. The maximum length is 255 characters.
\n","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.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"Returned if the issue type property is created.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if:
\n\nthe issue type ID is invalid.
\na property value is not provided.
\nthe property value JSON content is invalid.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have permission to modify the issue type.
\n"},"404":{"description":"Returned if:
\n\nthe issue type is not found.
\nthe user does not have the permission view the issue type.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["IssueTypeProperty"],"summary":"Delete issue type property","description":"Deletes the issue type property.
\nPermissions required: Administer Jira global permission.
\n","operationId":"deleteIssueTypeProperty","parameters":[{"name":"issueTypeId","in":"path","description":"The ID of the issue type.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property. Use Get issue type property keys to get a list of all issue type property keys.
\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the issue type property is deleted.
\n"},"400":{"description":"Returned if the issue type ID is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the issue type or property is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/jql/autocompletedata":{"get":{"tags":["SearchAutoComplete"],"summary":"Get field reference data","description":"Returns reference data for JQL searches. This is a downloadable version of the documentation provided in Advanced searching - fields reference and Advanced searching - functions reference, along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getAutoComplete","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","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\"]}],\"jqlReservedWords\":[\"empty\",\"and\",\"or\",\"in\",\"distinct\"]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/jql/autocompletedata/suggestions":{"get":{"tags":["SearchAutoComplete"],"summary":"Get field auto complete suggestions","description":"Returns the JQL search auto complete suggestions for a field.
\nSuggestions can be obtained by providing:
\n\nfieldName to get a list of all values for the field.
\nfieldName and fieldValue to get a list of values containing the text in fieldValue.
\nfieldName and predicateName to get a list of all predicate values for the field.
\nfieldName, predicateName, and predicateValue to get a list of predicate values containing the text in predicateValue.
\n
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getFieldAutoCompleteForQueryString","parameters":[{"name":"fieldName","in":"query","description":"The name of the field.
\n","schema":{"type":"string","example":"reporter"},"x-showInExample":"true"},{"name":"fieldValue","in":"query","description":"The partial field item name entered by the user.
\n","schema":{"type":"string"}},{"name":"predicateName","in":"query","description":"The name of the  CHANGED operator predicate for which the suggestions are generated. The valid predicate operators are by, from, and to.
\n","schema":{"type":"string"}},{"name":"predicateValue","in":"query","description":"The partial predicate item name entered by the user.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoCompleteSuggestions"},"example":"{\"results\":[{\"value\":\"ActiveObjects\",\"displayName\":\"ActiveObjects (AO)\"},{\"value\":\"Atlassian Connect\",\"displayName\":\"Atlassian Connect (AC)\"},{\"value\":\"Atlassian Connect in Jira\",\"displayName\":\"Atlassian Connect in Jira (ACJIRA)\"}]}"}}},"400":{"description":"Returned if an invalid combination of parameters is passed.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/jql/match":{"post":{"tags":["IssueMatch"],"summary":"Check issues against JQL","description":"Checks whether one or more issues would be returned by one or more JQL queries.
\nPermissions required: None, however, issues are only matched against JQL queries where the user has:
\n\nBrowse projects project permission for the project that the issue is in.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","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.
\n","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.
\n"}},"deprecated":false,"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/jql/parse":{"post":{"tags":["JqlParser"],"summary":"Parse JQL query","description":"Parses and validates JQL queries.
\nValidation is performed in context of the current user.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"parseJqlQueries","parameters":[],"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","invalid query","summary = test","summary in test","project = INVALID","universe = 42"]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","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\"},\"operator\":\"~\",\"operand\":{\"value\":\"test\"}},{\"clauses\":[{\"field\":{\"name\":\"labels\"},\"operator\":\"in\",\"operand\":{\"values\":[{\"value\":\"urgent\"},{\"value\":\"blocker\"}]}},{\"field\":{\"name\":\"lastCommentedBy\",\"property\":[{\"entity\":\"issue\",\"key\":\"propertyKey\",\"path\":\"path.in.property\",\"type\":\"user\"}]},\"operator\":\"=\",\"operand\":{\"function\":\"currentUser\",\"arguments\":[]}}],\"operator\":\"or\"},{\"field\":{\"name\":\"status\"},\"operator\":\"changed\",\"predicates\":[{\"operator\":\"after\",\"operand\":{\"function\":\"startOfMonth\",\"arguments\":[\"-1M\"]}}]}],\"operator\":\"and\"},\"orderBy\":{\"fields\":[{\"field\":{\"name\":\"updated\"},\"direction\":\"desc\"}]}}},{\"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.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/jql/pdcleaner":{"post":{"tags":["JQLPersonalDataMigration"],"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.
\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.
\nPermissions required: Permission to access Jira.
\n","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.
\n","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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/label":{"get":{"tags":["Label"],"summary":"Get all labels","description":"Returns a paginated list of available labels.
\n","operationId":"getAllLabels","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.
\n","schema":{"type":"integer","format":"int32","default":1000}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanString"},"example":"{\"maxResults\":2,\"startAt\":0,\"total\":100,\"isLast\":false,\"values\":[\"performance\",\"security\"]}"}}}},"deprecated":false,"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, or issue context.
\nThe user is reported as having a project permission:
\n\nin the global context, if the user has the project permission in any project.
\nfor 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.
\nfor 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
\nThis means that users may be shown as having an issue permission (such as EDIT_ISSUE) 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_ISSUE 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_ISSUE permission for that issue.
\nGlobal permissions are unaffected by context.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getMyPermissions","parameters":[{"name":"projectKey","in":"query","description":"The key of project. Ignored if projectId is provided.
\n","schema":{"type":"string"}},{"name":"projectId","in":"query","description":"The ID of project.
\n","schema":{"type":"string"}},{"name":"issueKey","in":"query","description":"The key of the issue. Ignored if issueId is provided.
\n","schema":{"type":"string"}},{"name":"issueId","in":"query","description":"The ID of the issue.
\n","schema":{"type":"string"}},{"name":"permissions","in":"query","description":"A comma-separated list of permission keys.  Omitting this parameter is deprecated. To get the list of available permissions, use Get all permissions. Note that deprecated keys cannot be used. Deprecated keys are not returned by Get all permissions but are returned by this operation if permissions is omitted.
\n","schema":{"type":"string","example":"BROWSE_PROJECTS,EDIT_ISSUES"},"x-showInExample":"true"},{"name":"projectUuid","in":"query","schema":{"type":"string"}},{"name":"projectConfigurationUuid","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Permissions"},"example":"{\"permissions\":{\"EDIT_ISSUE\":{\"id\":\"12\",\"key\":\"EDIT_ISSUES\",\"name\":\"Edit Issues\",\"type\":\"PROJECT\",\"description\":\"Ability to edit issues.\",\"havePermission\":true}}}"}}},"400":{"description":"Returned if permissions is empty or the permission key it contains is not found or deprecated.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n","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.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"OAuth2":[]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/mypreferences":{"get":{"tags":["CurrentUserPreferences"],"summary":"Get preference","description":"Returns the value of a preference of the current user.
\nPermissions required: Permission to access Jira.
\n","operationId":"getPreference","parameters":[{"name":"key","in":"query","description":"The key of the preference.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the key is not provided or not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"put":{"tags":["CurrentUserPreferences"],"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\nuser.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html.
\nuser.notify.own.changes Indicates whether the user gets notified of their own changes. Defaults to false.
\njira.user.locale The locale of the user. By default, not set: the user takes the instance locale. See also, Set locale.
\njira.user.timezone The time zone of the user. By default, not set, the user takes the instance time zone.
\nuser.default.share.private Indicates whether new  filters are set to private. Defaults to true.
\nuser.keyboard.shortcuts.disabled Indicates whether keyboard shortcuts are disabled. Defaults to false.
\nuser.autowatch.disabled Indicates 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
\nPermissions required: Permission to access Jira.
\n","operationId":"setPreference","parameters":[{"name":"key","in":"query","description":"The key of the preference. The maximum length is 255 characters.
\n","schema":{"type":"string"}}],"requestBody":{"description":"The value of the preference as a plain text string. The maximum length is 255 characters.
\n","content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the key or value is not provided or invalid.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["CurrentUserPreferences"],"summary":"Delete preference","description":"Deletes a preference of the user, which restores the default value of system defined settings.
\nPermissions required: Permission to access Jira.
\n","operationId":"removePreference","parameters":[{"name":"key","in":"query","description":"The key of the preference.
\n","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the key is not provided or not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/mypreferences/locale":{"get":{"tags":["CurrentUserPreferences"],"summary":"Get locale","description":"Returns the locale for the user.
\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.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getLocale","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Locale"},"example":"{\"locale\":\"en_US\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"put":{"tags":["CurrentUserPreferences"],"summary":"Set locale","description":"Sets the locale of the user. The locale must be one supported by the instance of Jira.
\nPermissions required: Permission to access Jira.
\n","operationId":"setLocale","parameters":[],"requestBody":{"description":"The locale defined in a LocaleBean.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Locale"},"example":{"locale":"en_US"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["CurrentUserPreferences"],"summary":"Delete locale","description":"Deletes the locale of the user, which restores the default setting.
\nPermissions required: Permission to access Jira.
\n","operationId":"deleteLocale","parameters":[],"responses":{"204":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/myself":{"get":{"tags":["CurrentUser"],"summary":"Get current user","description":"Returns details for the current user.
\nPermissions required: Permission to access Jira.
\n","operationId":"getCurrentUser","parameters":[{"name":"expand","in":"query","description":"Use expand to include additional information about user in the response. This parameter accepts multiple values separated by a comma:
\n\ngroups Returns all groups, including nested groups, the user belongs to.
\napplicationRoles Returns the application roles the user is assigned to.
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"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.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/notificationscheme":{"get":{"tags":["NotificationScheme"],"summary":"Get notification schemes paginated","description":"Returns a paginated list of notification schemes in order by display name.
\nAbout notification schemes
\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\nevent Identifies the type of event. The events can be Jira system events or custom events.
\n
\n\nnotifications Identifies the recipients of notifications for each event. Recipients can be any of the following types:
\n\nCurrentAssignee
\nReporter
\nCurrentUser
\nProjectLead
\nComponentLead
\nUser (the parameter is the user key)
\nGroup (the parameter is the group name)
\nProjectRole (the parameter is the project role ID)
\nEmailAddress
\nAllWatchers
\nUserCustomField (the parameter is the ID of the custom field)
\nGroupCustomField(the parameter is the ID of the custom field)
\n
\n
\n
\nNote that you should allow for events without recipients to appear in responses.
\nPermissions 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.
\n","operationId":"getNotificationSchemes","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 50.
\n","schema":{"type":"integer","format":"int32","default":50}},{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
\n\nall Returns all expandable information.
\nfield Returns information about any custom fields assigned to receive an event.
\ngroup Returns information about any groups assigned to receive an event.
\nnotificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information.
\nprojectRole Returns information about any project roles assigned to receive an event.
\nuser Returns information about any users assigned to receive an event.
\n
\n","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.
\n","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\":\"http://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\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://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\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"[email protected]\",\"emailAddress\":\"[email protected]\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"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\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://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\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"[email protected]\",\"emailAddress\":\"[email protected]\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"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\"}]}]}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/notificationscheme/{id}":{"get":{"tags":["NotificationScheme"],"summary":"Get notification scheme","description":"Returns a notification scheme, including the list of events and the recipients who will receive notifications for those events.
\nPermissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with the notification scheme.
\n","operationId":"getNotificationScheme","parameters":[{"name":"id","in":"path","description":"The ID of the notification scheme. Use Get notification schemes paginated to get a list of notification scheme IDs.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
\n\nall Returns all expandable information.
\nfield Returns information about any custom fields assigned to receive an event.
\ngroup Returns information about any groups assigned to receive an event.
\nnotificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information.
\nprojectRole Returns information about any project roles assigned to receive an event.
\nuser Returns information about any users assigned to receive an event.
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationScheme"},"example":"{\"expand\":\"notificationSchemeEvents,user,group,projectRole,field,all\",\"id\":10100,\"self\":\"http://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\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://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\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"[email protected]\",\"emailAddress\":\"[email protected]\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"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\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://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\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"[email protected]\",\"emailAddress\":\"[email protected]\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"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\"}]}]}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the notification scheme is not found or the user does not have permission to view it.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/permissions":{"get":{"tags":["Permissions"],"summary":"Get all permissions","description":"Returns all permissions, including:
\n\nglobal permissions.
\nproject permissions.
\nglobal permissions added by plugins.
\n
\nPermissions required: Administer Jira global permission.
\n","operationId":"getAllPermissions","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/permissions/check":{"post":{"tags":["Permissions"],"summary":"Get bulk permissions","description":"Returns:
\n\nfor a list of global permissions, the global permissions granted to the user.
\nfor a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues the user can access or manipulate.
\n
\nNote that:
\n\nInvalid project and issue IDs are ignored.
\nA maximum of 1000 projects and 1000 issues can be checked.
\n
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getBulkPermissions","parameters":[],"requestBody":{"description":"Details of the permissions to check.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkPermissionsRequestBean"},"example":{"globalPermissions":["SYSTEM_ADMIN"],"projectPermissions":[{"projects":[10001],"permissions":["EDIT_ISSUE"],"issues":[10010,10011,10012,10013,10014]}]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkPermissionGrants"},"example":"{\"projectPermissions\":[{\"permission\":\"EDIT_ISSUE\",\"issues\":[10010,10013,10014],\"projects\":[10001]}],\"globalPermissions\":[\"SYSTEM_ADMIN\"]}"}}},"400":{"description":"Returned if:
\n\nissue or project IDs are provided without at least one project permission being provided.
\nan invalid global permission is provided in the global permissions list.
\nan invalid project permission is provided in the project permissions list.
\nmore than 1000 valid project IDs or more than 1000 valid issue IDs are provided.
\n
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[],\"errors\":{\"PERMISSION_123\":\"Unrecognized permission\"}}"}}}},"deprecated":false,"security":[{"OAuth2":[]}],"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.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getPermittedProjects","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionsKeysBean"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermittedProjects"},"example":"{\"projects\":[{\"id\":10000,\"key\":\"DEMO\"},{\"id\":10101,\"key\":\"TEST\"}]}"}}},"400":{"description":"Returned if a project permission is not found.
\n","content":{"application/json":{"example":"{\"errorMessages\":[\"Could not find permission with key: NOT_EXISTING_PERMISSION_KEY\"],\"errors\":{}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":[]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/permissionscheme":{"get":{"tags":["PermissionScheme"],"summary":"Get all permission schemes","description":"Returns all permission schemes.
\nAbout permission schemes and grants
\nA permission scheme is a collection of permission grants. A permission grant consists of a holder and a permission.
\nHolder object
\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". The holder object is defined by the following properties:
\n\ntype Identifies the user or group (see the list of types below).
\nparameter 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
\nThe following types are available. The expected values for the parameter are given in parenthesis (some types may not have a parameter):
\n\nanyone Grant for anonymous users.
\napplicationRole Grant for users with access to the specified application (application name). See Update product access settings for more information.
\nassignee Grant for the user currently assigned to an issue.
\ngroup Grant for the specified group (group name).
\ngroupCustomField Grant for a user in the group selected in the specified custom field (custom field ID).
\nprojectLead Grant for a project lead.
\nprojectRole Grant for the specified project role (project role ID).
\nreporter Grant for the user who reported the issue.
\nsd.customer.portal.only Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See Customizing Jira Service Desk permissions for more information.
\nuser Grant for the specified user (user ID - historically this was the userkey but that is deprecated and the account ID should be used).
\nuserCustomField Grant for a user selected in the specified custom field (custom field ID).
\n
\nBuilt-in permissions
\nThe built-in Jira permissions are listed below. Apps can also define custom permissions. See the project permission and global permission module documentation for more information.
\nProject permissions
\n\nADMINISTER_PROJECTS
\nBROWSE_PROJECTS
\nMANAGE_SPRINTS_PERMISSION (Jira Software only)
\nSERVICEDESK_AGENT (Jira Service Desk only)
\nVIEW_DEV_TOOLS (Jira Software only)
\nVIEW_READONLY_WORKFLOW
\n
\nIssue permissions
\n\nASSIGNABLE_USER
\nASSIGN_ISSUES
\nCLOSE_ISSUES
\nCREATE_ISSUES
\nDELETE_ISSUES
\nEDIT_ISSUES
\nLINK_ISSUES
\nMODIFY_REPORTER
\nMOVE_ISSUES
\nRESOLVE_ISSUES
\nSCHEDULE_ISSUES
\nSET_ISSUE_SECURITY
\nTRANSITION_ISSUES
\n
\nVoters and watchers permissions
\n\nMANAGE_WATCHERS
\nVIEW_VOTERS_AND_WATCHERS
\n
\nComments permissions
\n\nADD_COMMENTS
\nDELETE_ALL_COMMENTS
\nDELETE_OWN_COMMENTS
\nEDIT_ALL_COMMENTS
\nEDIT_OWN_COMMENTS
\n
\nAttachments permissions
\n\nCREATE_ATTACHMENTS
\nDELETE_ALL_ATTACHMENTS
\nDELETE_OWN_ATTACHMENTS
\n
\nTime tracking permissions
\n\nDELETE_ALL_WORKLOGS
\nDELETE_OWN_WORKLOGS
\nEDIT_ALL_WORKLOGS
\nEDIT_OWN_WORKLOGS
\nWORK_ON_ISSUES
\n
\nPermissions required: Permission to access Jira.
\n","operationId":"getAllPermissionSchemes","parameters":[{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are included when you specify any value:
\n\nall Returns all expandable information.
\nfield Returns information about the custom field granted the permission.
\ngroup Returns information about the group that is granted the permission.
\npermissions Returns all permission grants for each permission scheme.
\nprojectRole Returns information about the project role granted the permission.
\nuser Returns information about the user who is granted the permission.
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionSchemes"},"example":"{\"permissionSchemes\":[{\"id\":10000,\"self\":\"http://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.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"post":{"tags":["PermissionScheme"],"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.
\nPermissions required: Administer Jira global permission.
\n","operationId":"createPermissionScheme","parameters":[{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:
\n\nall Returns all expandable information.
\nfield Returns information about the custom field granted the permission.
\ngroup Returns information about the group that is granted the permission.
\npermissions Returns all permission grants for each permission scheme.
\nprojectRole Returns information about the project role granted the permission.
\nuser Returns information about the user who is granted the permission.
\n
\n","schema":{"type":"string"}}],"requestBody":{"description":"The permission scheme to create.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionScheme"},"example":{"permissions":[{"holder":{"parameter":"jira-core-users","type":"group"},"permission":"ADMINISTER_PROJECTS"}],"name":"Example permission scheme","description":"description"}}},"required":true},"responses":{"201":{"description":"Returned if the permission scheme is created.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionScheme"},"example":"{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/10000\",\"name\":\"Example permission scheme\",\"description\":\"description\",\"permissions\":[{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}]}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to create permission schemes.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/permissionscheme/{schemeId}":{"get":{"tags":["PermissionScheme"],"summary":"Get permission scheme","description":"Returns a permission scheme.
\nPermissions required: Permission to access Jira.
\n","operationId":"getPermissionScheme","parameters":[{"name":"schemeId","in":"path","description":"The ID of the permission scheme to return.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are included when you specify any value:
\n\nall Returns all expandable information.
\nfield Returns information about the custom field granted the permission.
\ngroup Returns information about the group that is granted the permission.
\npermissions Returns all permission grants for each permission scheme.
\nprojectRole Returns information about the project role granted the permission.
\nuser Returns information about the user who is granted the permission.
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionScheme"},"example":"{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/10000\",\"name\":\"Example permission scheme\",\"description\":\"description\",\"permissions\":[{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the user is not permitted to view permission schemes or if the permission scheme is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"put":{"tags":["PermissionScheme"],"summary":"Update permission scheme","description":"Updates a permission scheme. Below are some important things to note when using this resource:
\n\nIf a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
\nIf you want to update only the name and description, then do not send a permissions list in the request.
\nSending 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 or Delete permission scheme entity.
\nSee About permission schemes and grants for more details.
\nPermissions required: Administer Jira global permission.
\n","operationId":"updatePermissionScheme","parameters":[{"name":"schemeId","in":"path","description":"The ID of the permission scheme to update.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:
\n\nall Returns all expandable information.
\nfield Returns information about the custom field granted the permission.
\ngroup Returns information about the group that is granted the permission.
\npermissions Returns all permission grants for each permission scheme.
\nprojectRole Returns information about the project role granted the permission.
\nuser Returns information about the user who is granted the permission.
\n
\n","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionScheme"},"example":{"permissions":[{"holder":{"parameter":"jira-core-users","type":"group"},"permission":"ADMINISTER_PROJECTS"}],"name":"Example permission scheme","description":"description"}}},"required":true},"responses":{"200":{"description":"Returned if the scheme is updated.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionScheme"},"example":"{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/10000\",\"name\":\"Example permission scheme\",\"description\":\"description\",\"permissions\":[{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to update permission schemes.
\n"},"404":{"description":"Returned if the permission scheme is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["PermissionScheme"],"summary":"Delete permission scheme","description":"Deletes a permission scheme.
\nPermissions required: Administer Jira global permission.
\n","operationId":"deletePermissionScheme","parameters":[{"name":"schemeId","in":"path","description":"The ID of the permission scheme being deleted.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the permission scheme is deleted.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to delete permission schemes.
\n"},"404":{"description":"Returned if the permission scheme is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/permissionscheme/{schemeId}/permission":{"get":{"tags":["PermissionScheme"],"summary":"Get permission scheme grants","description":"Returns all permission grants for a permission scheme.
\nPermissions required: Permission to access Jira.
\n","operationId":"getPermissionSchemeGrants","parameters":[{"name":"schemeId","in":"path","description":"The ID of the permission scheme.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:
\n\npermissions Returns all permission grants for each permission scheme.
\nuser Returns information about the user who is granted the permission.
\ngroup Returns information about the group that is granted the permission.
\nprojectRole Returns information about the project role granted the permission.
\nfield Returns information about the custom field granted the permission.
\nall Returns all expandable information.
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionGrants"},"example":"{\"permissions\":[{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}],\"expand\":\"user,group,projectRole,field,all\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the user is not permitted to view permission schemes or the permission scheme is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"post":{"tags":["PermissionScheme"],"summary":"Create permission grant","description":"Creates a permission grant in a permission scheme.
\nPermissions required: Administer Jira global permission.
\n","operationId":"createPermissionGrant","parameters":[{"name":"schemeId","in":"path","description":"The ID of the permission scheme in which to create a new permission grant.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:
\n\npermissions Returns all permission grants for each permission scheme.
\nuser Returns information about the user who is granted the permission.
\ngroup Returns information about the group that is granted the permission.
\nprojectRole Returns information about the project role granted the permission.
\nfield Returns information about the custom field granted the permission.
\nall Returns all expandable information.
\n
\n","schema":{"type":"string"}}],"requestBody":{"description":"The permission grant to create.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionGrant"},"example":{"holder":{"parameter":"jira-core-users","type":"group"},"permission":"ADMINISTER_PROJECTS"}}},"required":true},"responses":{"201":{"description":"Returned if the scheme permission is created.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionGrant"},"example":"{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}"}}},"400":{"description":"Returned if the value for expand is invalid or the same permission grant is present.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to edit permission schemes.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/permissionscheme/{schemeId}/permission/{permissionId}":{"get":{"tags":["PermissionScheme"],"summary":"Get permission scheme grant","description":"Returns a permission grant.
\nPermissions required: Permission to access Jira.
\n","operationId":"getPermissionSchemeGrant","parameters":[{"name":"schemeId","in":"path","description":"The ID of the permission scheme.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"permissionId","in":"path","description":"The ID of the permission grant.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:
\n\nall Returns all expandable information.
\nfield Returns information about the custom field granted the permission.
\ngroup Returns information about the group that is granted the permission.
\npermissions Returns all permission grants for each permission scheme.
\nprojectRole Returns information about the project role granted the permission.
\nuser Returns information about the user who is granted the permission.
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionGrant"},"example":"{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the user is not permitted to view permission schemes or if the permission scheme or permission grant is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["PermissionScheme"],"summary":"Delete permission scheme grant","description":"Deletes a permission grant from a permission scheme. See About permission schemes and grants for more details.
\nPermissions required: Administer Jira global permission.
\n","operationId":"deletePermissionSchemeEntity","parameters":[{"name":"schemeId","in":"path","description":"The ID of the permission scheme to delete the permission grant from.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"permissionId","in":"path","description":"The ID of the permission grant to delete.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the permission grant is deleted.
\n"},"400":{"description":"Returned if permission grant with the provided ID is not found.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to edit permission schemes.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/priority":{"get":{"tags":["Priority"],"summary":"Get priorities","description":"Returns the list of all issue priorities.
\nPermissions required: Permission to access Jira.
\n","operationId":"getPriorities","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Priority"}},"example":"[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/priority/3\",\"statusColor\":\"#009900\",\"description\":\"Major loss of function.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/priorities/major.png\",\"name\":\"Major\",\"id\":\"1\"},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/priority/5\",\"statusColor\":\"#cfcfcf\",\"description\":\"Very little impact.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/priorities/trivial.png\",\"name\":\"Trivial\",\"id\":\"2\"}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/priority/{id}":{"get":{"tags":["Priority"],"summary":"Get priority","description":"Returns an issue priority.
\nPermissions required: Permission to access Jira.
\n","operationId":"getPriority","parameters":[{"name":"id","in":"path","description":"The ID of the issue priority.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Priority"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/priority/3\",\"statusColor\":\"#009900\",\"description\":\"Major loss of function.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/priorities/major.png\",\"name\":\"Major\",\"id\":\"1\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"},"404":{"description":"Returned if the issue priority is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project":{"get":{"tags":["Project"],"summary":"Get all projects","description":"Returns all projects visible to the user. Deprecated, use  Get projects paginated that supports search and pagination.
\nThis operation can be accessed anonymously.
\nPermissions required: Projects are returned only where the user has Browse Projects or Administer projects project permission for the project.
\n","operationId":"getAllProjects","parameters":[{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
\n\ndescription Returns the project description.
\nissueTypes Returns all issue types associated with the project.
\nlead Returns information about the the project lead.
\nprojectKeys Returns all project keys associated with the project.
\n
\n","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.
\n","schema":{"type":"integer","format":"int32"}},{"name":"properties","in":"query","description":"A comma-separated list of project properties to return for the project.
\n","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Project"}},"example":"[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/ABC\",\"id\":\"10001\",\"key\":\"ABC\",\"name\":\"Alphabetical\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":true,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Project"],"summary":"Create project","description":"Creates a project based on a project type template, as shown in the following table:
\n \n  \n   \n    \n    \n   \n  \n  \n   \n    \n    \n   \n   \n    \n    \n   \n   \n    \n    \n   \n \n  \n \nProject Type Key Project Template Key
business com.atlassian.jira-core-project-templates:jira-core-simplified-content-management, com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval, com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking, com.atlassian.jira-core-project-templates:jira-core-simplified-process-control, com.atlassian.jira-core-project-templates:jira-core-simplified-procurement, com.atlassian.jira-core-project-templates:jira-core-simplified-project-management, com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment, com.atlassian.jira-core-project-templates:jira-core-simplified-task-tracking 
service_desk com.atlassian.servicedesk:simplified-it-service-desk, com.atlassian.servicedesk:simplified-internal-service-desk, com.atlassian.servicedesk:simplified-external-service-desk 
software com.pyxis.greenhopper.jira:gh-simplified-agility-kanban, com.pyxis.greenhopper.jira:gh-simplified-agility-scrum, com.pyxis.greenhopper.jira:gh-simplified-basic, com.pyxis.greenhopper.jira:gh-simplified-kanban-classic, com.pyxis.greenhopper.jira:gh-simplified-scrum-classic 
\nThe project types are available according to the installed Jira features as follows:
\n\nJira Core, the default, enables business projects.
\nJira Service Desk enables service_desk projects.
\nJira 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 Desk into a JIRA instance, use Jira settings > Apps > Finding new apps. For more information, see  Managing add-ons.
\nPermissions required: Administer Jira global permission.
\n","operationId":"createProject","parameters":[],"requestBody":{"description":"The JSON representation of the project being created.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectInputBean"},"example":{"notificationScheme":10021,"description":"Example Project description","lead":"Charlie","url":"http://atlassian.com","projectTemplateKey":"com.atlassian.jira-core-project-templates:jira-core-simplified-process-control","avatarId":10200,"issueSecurityScheme":10001,"name":"Example","permissionScheme":10011,"assigneeType":"PROJECT_LEAD","projectTypeKey":"business","key":"EX","categoryId":10120}}},"required":true},"responses":{"201":{"description":"Returned if the project is created.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectIdentifiers"},"example":"{\"self\":\"http://example/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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have permission to create projects.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/project/search":{"get":{"tags":["Project"],"summary":"Get projects paginated","description":"Returns projects visible to the user.
\nThis operation can be accessed anonymously.
\nPermissions required: Projects are returned only where the user has Browse Projects project permission for the project.
\n","operationId":"searchProjects","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 50.
\n","schema":{"type":"integer","format":"int32","default":50}},{"name":"orderBy","in":"query","description":"Order the results by a field. If the orderBy field is not set, then projects are listed in ascending order by project key:
\n\ncategory Sorts projects in order by project category. A complete list of category IDs is found using the Get all project categories operation.
\nkey Sorts projects in order by project key.
\nname Sorts projects in alphabetical order by project name.
\nowner Sorts projects in order by the project lead.
\n
\n","schema":{"type":"string","enum":["category","-category","+category","key","-key","+key","name","-name","+name","owner","-owner","+owner"],"default":"key"}},{"name":"query","in":"query","description":"Filter the results using a literal string. Projects with a matching key or name are returned (case insensitive).
\n","schema":{"type":"string"}},{"name":"typeKey","in":"query","description":"Orders results by the project type. This parameter accepts multiple values separated by a comma. Valid values are business, service_desk, and software.
\n","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 operation.
\n","schema":{"type":"integer","format":"int64"}},{"name":"searchBy","in":"query","schema":{"type":"string","default":"key, name"}},{"name":"action","in":"query","description":"Filter results by projects for which the user can:
\n\n\nview the project, meaning that they have one of the following permissions:
\n\nBrowse projects project permission for the project.
\nAdminister projects project permission for the project.
\nsite administration (that is, member of the site-admin group).
\n
\n
\n\nbrowse the project, meaning that they have the Browse projects project permission for the project.
\n
\n\nedit the project, meaning that they have one of the following permissions:
\n\nAdminister projects project permission for the project.
\nsite administration (that is, member of the site-admin group).
\n
\n
\n
\n","schema":{"type":"string","enum":["view","browse","edit"],"default":"view"}},{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
\n\ndescription Returns the project description.
\nprojectKeys Returns all project keys associated with a project.
\nlead Returns information about the the project lead.
\nissueTypes Returns all issue types associated with the project.
\nurl Returns the URL associated with the project.
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful. Returns a page of projects.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanProject"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/search?startAt=0&maxResults=2\",\"nextPage\":\"http://your-domain.atlassian.net/rest/api/3/project/search?startAt=2&maxResults=2\",\"maxResults\":2,\"startAt\":0,\"total\":7,\"isLast\":false,\"values\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/ABC\",\"id\":\"10001\",\"key\":\"ABC\",\"name\":\"Alphabetical\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"}]}"}}},"400":{"description":"Returned if the request is not valid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if no projects matching the search criteria are found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/type":{"get":{"tags":["ProjectType"],"summary":"Get all project types","description":"Returns all project types, whether or not the instance has a valid license for each type.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getAllProjectTypes","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/type/{projectTypeKey}":{"get":{"tags":["ProjectType"],"summary":"Get project type by key","description":"Returns a project type.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getProjectTypeByKey","parameters":[{"name":"projectTypeKey","in":"path","description":"The key of the project type.
\n","required":true,"schema":{"type":"string","enum":["software","service_desk","business"]}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"404":{"description":"Returned if the project type is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/type/{projectTypeKey}/accessible":{"get":{"tags":["ProjectType"],"summary":"Get accessible project type by key","description":"Returns a project type if it is accessible to the user.
\nPermissions required: Permission to access Jira.
\n","operationId":"getAccessibleProjectTypeByKey","parameters":[{"name":"projectTypeKey","in":"path","description":"The key of the project type.
\n","required":true,"schema":{"type":"string","enum":["software","service_desk","business"]}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"404":{"description":"Returned if the project type is not accessible to the user.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}":{"get":{"tags":["Project"],"summary":"Get project","description":"Returns the project details for a project.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse projects project permission for the project.
\n","operationId":"getProject","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that the project description, issue types, and project lead are included in all responses by default:
\n\ndescription The project description.
\nissueTypes The issue types associated with the project.
\nlead The project lead.
\nprojectKeys All project keys associated with the project.
\nissueTypeHierarchy The project issue type hierarchy.
\n
\n","schema":{"type":"string"}},{"name":"properties","in":"query","description":"A comma-separated list of project properties to return for the project.
\n","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returned if successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"},"example":"{\"self\":\"http://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\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"components\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000}],\"issueTypes\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"http://your-domain.atlassian.net//secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"http://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}],\"url\":\"http://your-domain.atlassian.net/browse/EX\",\"email\":\"[email protected]\",\"assigneeType\":\"PROJECT_LEAD\",\"versions\":[],\"name\":\"Example\",\"roles\":{\"Developers\":\"http://your-domain.atlassian.net/rest/api/3/project/EX/role/10000\"},\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"properties\":{\"propertyKey\":\"propertyValue\"}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the project is not found or the user does not have permission to view it.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Project"],"summary":"Update project","description":"Updates the project details of a project.
\nAll parameters are optional in the body of the request.
\nPermissions required: Administer Jira global permission.
\n","operationId":"updateProject","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that the project description, issue types, and project lead are included in all responses by default:
\n\ndescription The project description.
\nissueTypes The issue types associated with the project.
\nlead The project lead.
\nprojectKeys All project keys associated with the project.
\n
\n","schema":{"type":"string"}}],"requestBody":{"description":"The project details to be updated.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectInputBean"},"example":{"notificationScheme":10021,"description":"Example Project description","lead":"Charlie","url":"http://atlassian.com","projectTemplateKey":"com.atlassian.jira-core-project-templates:jira-core-simplified-process-control","avatarId":10200,"issueSecurityScheme":10001,"name":"Example","permissionScheme":10011,"assigneeType":"PROJECT_LEAD","projectTypeKey":"business","key":"EX","categoryId":10120}}},"required":true},"responses":{"200":{"description":"Returned if the project is updated.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"},"example":"{\"self\":\"http://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\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"components\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000}],\"issueTypes\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"http://your-domain.atlassian.net//secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"http://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}],\"url\":\"http://your-domain.atlassian.net/browse/EX\",\"email\":\"[email protected]\",\"assigneeType\":\"PROJECT_LEAD\",\"versions\":[],\"name\":\"Example\",\"roles\":{\"Developers\":\"http://your-domain.atlassian.net/rest/api/3/project/EX/role/10000\"},\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"properties\":{\"propertyKey\":\"propertyValue\"}}"}}},"400":{"description":"Returned if the request is not valid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have permission to update project details.
\n"},"404":{"description":"Returned if the project is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"},"delete":{"tags":["Project"],"summary":"Delete project","description":"Deletes a project.
\nPermissions required: Administer Jira global permission.
\n","operationId":"deleteProject","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the project is deleted.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the project is not found or the user does not have permission to delete it.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/project/{projectIdOrKey}/avatar":{"put":{"tags":["Project"],"summary":"Set project avatar","description":"Sets the avatar displayed for a project.
\nUse Load project avatar to store avatars against the project, before using this operation to set the displayed avatar.
\nPermissions required: Administer projects project permission.
\n","operationId":"updateProjectAvatar","parameters":[{"name":"projectIdOrKey","in":"path","description":"The ID or (case-sensitive) key of the project.
\n","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.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have permission to administer the project.
\n"},"404":{"description":"Returned if the project or avatar is not found or the user does not have permission to view the project.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/project/{projectIdOrKey}/avatar/{id}":{"delete":{"tags":["Project"],"summary":"Delete project avatar","description":"Deletes a custom avatar from a project. Note that system avatars cannot be deleted.
\nPermissions required: Administer projects project permission.
\n","operationId":"deleteProjectAvatar","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or (case-sensitive) key.
\n","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the avatar.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the avatar is a system avatar or the user does not have permission to administer the project.
\n"},"404":{"description":"Returned if the project or avatar is not found or the user does not have permission to view the project.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/project/{projectIdOrKey}/avatar2":{"post":{"tags":["Project"],"summary":"Load project avatar","description":"Loads an avatar for a project.
\nSpecify the avatar's local file location in the body of the request. Also, include the following headers:
\n\nX-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers.
\nContent-Type: image/image type Valid image types are JPEG, GIF, or PNG.
\n
\nFor example:
\ncurl --request POST 
\n--user [email protected]:<api_token> 
\n--header 'X-Atlassian-Token: no-check' 
\n--header 'Content-Type: image/< image_type>' 
\n--data-binary "<@/path/to/file/with/your/avatar>" 
\n--url 'https://your-domain.atlassian.net/rest/api/3/project/{projectIdOrKey}/avatar2'
\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.
\nThe cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.
\nAfter creating the avatar use Set project avatar to set it as the project's displayed avatar.
\nPermissions required: Administer projects project permission.
\n","operationId":"createProjectAvatar","parameters":[{"name":"projectIdOrKey","in":"path","description":"The ID or (case-sensitive) key of the project.
\n","required":true,"schema":{"type":"string"}},{"name":"x","in":"query","description":"The X coordinate of the top-left corner of the crop region.
\n","schema":{"type":"integer","format":"int32","default":0}},{"name":"y","in":"query","description":"The Y coordinate of the top-left corner of the crop region.
\n","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"The length of each side of the crop region.
\n","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"*/*":{"schema":{}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Avatar"},"example":"{\"id\":\"1010\",\"isSystemAvatar\":false,\"isSelected\":false,\"isDeletable\":true}"}}},"400":{"description":"Returned if:
\n\nan image isn't included in the request.
\nthe image type is unsupported.
\nthe crop parameters extend the crop area beyond the edge of the image.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have permission to administer the project or an anonymous call is made to the operation.
\n"},"404":{"description":"Returned if the project is not found or the user does not have permission to view the project.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/project/{projectIdOrKey}/avatars":{"get":{"tags":["Project"],"summary":"Get all project avatars","description":"Returns all project avatars, grouped by system and custom avatars.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse projects project permission for the project.
\n","operationId":"getAllProjectAvatars","parameters":[{"name":"projectIdOrKey","in":"path","description":"The ID or (case-sensitive) key of the project.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if request is successful.
\n","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.
\n"},"404":{"description":"Returned if the the project is not found or the user does not have permission to view the project.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}/component":{"get":{"tags":["Project"],"summary":"Get project components paginated","description":"Returns a paginated representation of all components in a project. See the Get project components resource if you want to get a full list of versions without pagination.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse Projects project permission for the project.
\n","operationId":"getProjectComponentsPaginated","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","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).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 50.
\n","schema":{"type":"integer","format":"int32","default":50}},{"name":"orderBy","in":"query","description":"Order the results by a field:
\n\ndescription Sorts components in alphabetical order by description.
\nissueCount Sorts components by the count of issues associated with the component in ascending order.
\nlead Sorts by the project lead's user key in alphabetical order.
\nname Sorts components in alphabetical order by component name.
\n
\n","schema":{"type":"string","enum":["description","-description","+descriptionissueCount","-issueCount","+issueCountlead","-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).
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanComponentWithIssueCount"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/PR/component?startAt=0&maxResults=2\",\"nextPage\":\"http://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\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000},\"issueCount\":1,\"description\":\"This is a Jira component\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"project\":\"HSP\",\"assigneeType\":\"PROJECT_LEAD\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"projectId\":10000,\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"name\":\"Component 1\",\"id\":\"10000\"},{\"componentBean\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10050\",\"name\":\"PXA\",\"description\":\"This is a another Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"PROJECTKEY\",\"projectId\":10000},\"issueCount\":5,\"description\":\"This is a another Jira component\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"project\":\"PROJECTKEY\",\"assigneeType\":\"PROJECT_LEAD\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"projectId\":10000,\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"name\":\"PXA\",\"id\":\"10050\"}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the project is not found or the user does not have permission to view it.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}/components":{"get":{"tags":["Project"],"summary":"Get project components","description":"Returns all components in a project. See the Get project components paginated resource if you want to get a full list of components with pagination.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse Projects project permission for the project.
\n","operationId":"getProjectComponents","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Component"}},"example":"[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10050\",\"name\":\"PXA\",\"description\":\"This is a another Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"PROJECTKEY\",\"projectId\":10000}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the project is not found or the user does not have permission to view it.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}/properties":{"get":{"tags":["ProjectProperty"],"summary":"Get project property keys","description":"Returns all project property keys for the project.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse Projects project permission for the project.
\n","operationId":"getProjectPropertyKeys","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyKeys"},"example":"{\"keys\":[{\"self\":\"http://your-domain.atlassian.net/jira/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"}}},"400":{"description":"Returned if the request is not valid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"},"403":{"description":"Returned if the user does not have permission to view the project.
\n"},"404":{"description":"Returned if the project is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}":{"get":{"tags":["ProjectProperty"],"summary":"Get project property","description":"Returns the value of a project property.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse Projects project permission for the project containing the property.
\n","operationId":"getProjectProperty","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The project property key. Use Get project property keys to get a list of all project property keys.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"},"403":{"description":"Returned if the user does not have permission to view the project.
\n"},"404":{"description":"Returned if the project or property is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["ProjectProperty"],"summary":"Set project property","description":"Sets the value of the project property. You can use project properties to store custom data against the project.
\nThe value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
\nThis operation can be accessed anonymously.
\nPermissions required: Administer Jira global permission or Administer Projects project permission for the project in which the property is created.
\n","operationId":"setProjectProperty","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the project property. The maximum length is 255 characters.
\n","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.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"Returned if the project property is created.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if the project key or id is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"},"403":{"description":"Returned if the user does not have permission to administer the project.
\n"},"404":{"description":"Returned if the project is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["ProjectProperty"],"summary":"Delete project property","description":"Deletes the property from a project.
\nThis operation can be accessed anonymously.
\nPermissions required: Administer Jira global permission or Administer Projects project permission for the project containing the property.
\n","operationId":"deleteProjectProperty","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The project property key. Use Get project property keys to get a list of all project property keys.
\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the project property is deleted.
\n"},"400":{"description":"Returned if the request is not valid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"},"403":{"description":"Returned if the user does not have permission to administer the project.
\n"},"404":{"description":"Returned if the project or property is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/project/{projectIdOrKey}/role":{"get":{"tags":["ProjectRole"],"summary":"Get project roles for project","description":"Returns a list of project roles for the project returning the name and self URL for each role.
\nNote that all project roles are shared with all projects in Jira Cloud. See Get all project roles for more information.
\nThis operation can be accessed anonymously.
\nPermissions required: Administer Projects project permission for any project on the siteAdminister Jira or global permission.
\n","operationId":"getProjectRoles","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"example":"{\"Administrators\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10002\",\"Users\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10001\",\"Developers\":\"http://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.
\n"},"404":{"description":"Returned if the project is not found or or if the user does not have administrative permissions for the project.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}/role/{id}":{"get":{"tags":["ProjectRole"],"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.
\nTo check whether a user belongs to a role based on their group memberships, use Get user with the groups expand parameter selected. Then check whether the user keys and groups match with the actors returned for the project.
\nThis operation can be accessed anonymously.
\nPermissions required: Administer Projects project permission for the project or Administer Jira global permission.
\n","operationId":"getProjectRole","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRole"},"example":"{\"self\":\"http://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\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}"}}},"400":{"description":"Returned if the request is not valid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nthe project or project role is not found.
\nthe user does not have administrative permission.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["ProjectRole"],"summary":"Set actors for project role","description":"Sets the actors for a project role for a project, replacing all existing actors.
\nTo add actors to the project without overwriting the existing list, use Add actors to project role.
\nPermissions required: Administer Projects project permission for the project or Administer Jira global permission.
\n","operationId":"setActors","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.
\n","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 or group name.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRoleActorsUpdateBean"},"example":{"categorisedActors":{"atlassian-user-role-actor":["12345678-9abc-def1-2345-6789abcdef12"],"atlassian-group-role-actor":["jira-developers"]}}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful. The complete list of actors for the project is returned.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRole"},"example":"{\"self\":\"http://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\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}"}}},"400":{"description":"Returned if the request is not valid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing or if the calling user lacks administrative permissions for the project.
\n"},"404":{"description":"Returned if:
\n\nthe project is not found.
\na user or group is not found.
\na group or user is not active.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"},"post":{"tags":["ProjectRole"],"summary":"Add actors to project role","description":"Adds actors to a project role for the project.
\nTo replace all actors for the project, use Set actors for project role.
\nThis operation can be accessed anonymously.
\nPermissions required: Administer Projects project permission for the project or Administer Jira global permission.
\n","operationId":"addActorUsers","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.
\n","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 or group name.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActorsMap"},"example":{"group":["jira-developers"]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful. The complete list of actors for the project is returned.
\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.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRole"},"example":"{\"self\":\"http://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\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}"}}},"400":{"description":"Returned if the request is not valid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing or if the calling user lacks administrative permissions for the project.
\n"},"404":{"description":"Returned if:
\n\nthe project is not found.
\nthe user or group is not found.
\nthe group or user is not active.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"},"delete":{"tags":["ProjectRole"],"summary":"Delete actors from project role","description":"Deletes actors from a project role for the project.
\nTo remove default actors from the project role, use Delete default actors from project role This operation can be accessed anonymously. 
\n Permissions required: Administer Projects project permission for the project or Administer Jira global permission.
\n","operationId":"deleteActor","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.
\n","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.
\n","schema":{"type":"string","example":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"},"x-showInExample":"true"},{"name":"group","in":"query","description":"The name of the group to remove from the project role.
\n","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the request is not valid.
\n"},"404":{"description":"Returned if:
\n\nthe project or project role is not found.
\nthe calling user does not have administrative permission.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/project/{projectIdOrKey}/roledetails":{"get":{"tags":["ProjectRoleDetails"],"summary":"Get project role details","description":"Returns all project roles and the details for each role. Note that the list of project roles is common to all projects.
\nThis operation can be accessed anonymously.
\nPermissions required: Administer Jira global permission or Administer projects project permission for the project.
\n","operationId":"getProjectRoleDetails","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","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.
\n","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectRole"}},"example":"[{\"self\":\"http://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\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the project is not found or if the user does not have the necessary permissions for the project.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}/statuses":{"get":{"tags":["Project"],"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.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse Projects project permission for the project.
\n","operationId":"getAllStatuses","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IssueTypeWithStatus"}},"example":"[{\"self\":\"http://localhost:8090/jira/rest/api/3/issueType/3\",\"id\":\"3\",\"name\":\"Task\",\"subtask\":false,\"statuses\":[{\"self\":\"http://localhost:8090/jira/rest/api/3/status/10000\",\"description\":\"The issue is currently being worked on.\",\"iconUrl\":\"http://localhost:8090/jira/images/icons/progress.gif\",\"name\":\"In Progress\",\"id\":\"10000\"},{\"self\":\"http://localhost:8090/jira/rest/api/3/status/5\",\"description\":\"The issue is closed.\",\"iconUrl\":\"http://localhost:8090/jira/images/icons/closed.gif\",\"name\":\"Closed\",\"id\":\"5\"}]}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the project is not found or the user does not have permission to view it.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}/type/{newProjectTypeKey}":{"put":{"tags":["Project"],"summary":"Update project type","description":"Deprecated, this feature is no longer supported and no alternatives are available, see Convert project to a different template or type. Updates a project type. The project type can be updated for classic projects only, project type cannot be updated for next-gen projects.
\nPermissions required: Administer Jira global permission.
\n","operationId":"updateProjectType","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}},{"name":"newProjectTypeKey","in":"path","description":"The key of the new project type.
\n","required":true,"schema":{"type":"string","enum":["software","service_desk","business"]}}],"responses":{"200":{"description":"Returned if the project type is updated.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"},"example":"{\"self\":\"http://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\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"components\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000}],\"issueTypes\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"http://your-domain.atlassian.net//secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"http://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}],\"url\":\"http://your-domain.atlassian.net/browse/EX\",\"email\":\"[email protected]\",\"assigneeType\":\"PROJECT_LEAD\",\"versions\":[],\"name\":\"Example\",\"roles\":{\"Developers\":\"http://your-domain.atlassian.net/rest/api/3/project/EX/role/10000\"},\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"properties\":{\"propertyKey\":\"propertyValue\"}}"}}},"400":{"description":"Returned if the request is not valid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the project is not found or the user does not have permission to view it.
\n"}},"deprecated":true,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/project/{projectIdOrKey}/version":{"get":{"tags":["Project"],"summary":"Get project versions paginated","description":"Returns a paginated representation of all versions in a project. See the Get project versions resource if you want to get a full list of versions without pagination.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse Projects project permission for the project.
\n","operationId":"getProjectVersionsPaginated","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","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).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 50.
\n","schema":{"type":"integer","format":"int32","default":50}},{"name":"orderBy","in":"query","description":"Order the results by a field:
\n\ndescription Sorts versions in alphabetical order by description.
\nname Sorts versions in alphabetical order by version name.
\nreleaseDate Sorts versions in order by release date, starting with the oldest date. Versions with no release date are listed last.
\nsequence Sorts versions by the order of appearance in the user interface.
\nstartDate Sorts versions in order by start date, starting with the oldest date. Versions with no start date are listed last.
\n
\n","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).
\n","schema":{"type":"string"}},{"name":"status","in":"query","description":"A comma-separated list of status values used to filter the results by version status. The status values are released, unreleased, and archived.
\n","schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
\n\nissuesstatus Returns the number of issues in each status category for each version.
\noperations Returns actions that can be performed on the specified version.
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanVersion"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=0&maxResults=2\",\"nextPage\":\"http://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=2&maxResults=2\",\"maxResults\":2,\"startAt\":0,\"total\":7,\"isLast\":false,\"values\":[{\"self\":\"http://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\":\"http://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.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectIdOrKey}/versions":{"get":{"tags":["Project"],"summary":"Get project versions","description":"Returns all versions in a project. The response is not paginated. Use Get project versions paginated if you want to get the versions in a project with pagination.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse Projects project permission for the project.
\n","operationId":"getProjectVersions","parameters":[{"name":"projectIdOrKey","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
\n\noperations Returns actions that can be performed on the specified version.
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Version"}},"example":"[{\"self\":\"http://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\":\"http://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.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectId}/hierarchy":{"get":{"tags":["Hierarchy"],"summary":"Get the hierarchy","description":"Get the project hierarchy.
\n","operationId":"getHierarchy","parameters":[{"name":"projectId","in":"path","description":"The ID of the project.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"The hierarchy
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HierarchyOutputFragment"},"example":"{\"projectId\":10030,\"hierarchy\":[{\"entityId\":\"9d8b9a3a-1145-42c6-8c42-a83c4567dd27\",\"level\":0,\"name\":\"Standard Issue Types\",\"issueTypes\":[{\"id\":7,\"name\":\"Story\",\"avatarId\":10324}]}]}"}}},"401":{"description":"Unauthorized request (eg: user may not create issues).
\n"},"500":{"description":"Unknown server error.
\n"},"503":{"description":"This feature is unavailable.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectKeyOrId}/issuesecuritylevelscheme":{"get":{"tags":["ProjectIssueSecurityLevelScheme"],"summary":"Get project issue security scheme","description":"Returns the issue security scheme associated with the project.
\nPermissions required: Administer Jira global permission or the Administer Projects project permission.
\n","operationId":"getIssueSecurityScheme","parameters":[{"name":"projectKeyOrId","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"},"example":"{\"self\":\"http://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\":\"http://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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the project is visible to the user but the user doesn't have administrative permissions.
\n"},"404":{"description":"Returned if the project is not found or the user does not have permission to view it.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectKeyOrId}/notificationscheme":{"get":{"tags":["ProjectNotificationScheme"],"summary":"Get project notification scheme","description":"Gets a notification scheme associated with the project. See the Get notification scheme resource for more information about notification schemes.
\nPermissions required: Administer Jira global permission or Administer Projects project permission.
\n","operationId":"getNotificationScheme","parameters":[{"name":"projectKeyOrId","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
\n\nall Returns all expandable information.
\nfield Returns information about any custom fields assigned to receive an event.
\ngroup Returns information about any groups assigned to receive an event.
\nnotificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information.
\nprojectRole Returns information about any project roles assigned to receive an event.
\nuser Returns information about any users assigned to receive an event.
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationScheme"},"example":"{\"expand\":\"notificationSchemeEvents,user,group,projectRole,field,all\",\"id\":10100,\"self\":\"http://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\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://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\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"[email protected]\",\"emailAddress\":\"[email protected]\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"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\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://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\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"[email protected]\",\"emailAddress\":\"[email protected]\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"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\"}]}]}"}}},"400":{"description":"Returned if the request is not valid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the project is not found or the user is not an administrator.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/project/{projectKeyOrId}/permissionscheme":{"get":{"tags":["ProjectPermissionScheme"],"summary":"Get assigned permission scheme","description":"Gets the permission scheme associated with the project.
\nPermissions required: Administer Jira global permission or Administer projects project permission.
\n","operationId":"getAssignedPermissionScheme","parameters":[{"name":"projectKeyOrId","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are included when you specify any value:
\n\nall Returns all expandable information.
\nfield Returns information about the custom field granted the permission.
\ngroup Returns information about the group that is granted the permission.
\npermissions Returns all permission grants for each permission scheme.
\nprojectRole Returns information about the project role granted the permission.
\nuser Returns information about the user who is granted the permission.
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionScheme"},"example":"{\"id\":10000,\"self\":\"http://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.
\n"},"403":{"description":"Returned if the user does not have permission to view the project's configuration.
\n"},"404":{"description":"Returned if the project is not found or the user does not have permission to view the project.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["ProjectPermissionScheme"],"summary":"Assign permission scheme","description":"Assigns a permission scheme with a project. See Managing project permissions for more information about permission schemes.
\nPermissions required: Administer Jira global permission
\n","operationId":"assignPermissionScheme","parameters":[{"name":"projectKeyOrId","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are included when you specify any value:
\n\nall Returns all expandable information.
\nfield Returns information about the custom field granted the permission.
\ngroup Returns information about the group that is granted the permission.
\npermissions Returns all permission grants for each permission scheme.
\nprojectRole Returns information about the project role granted the permission.
\nuser Returns information about the user who is granted the permission.
\n
\n","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.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionScheme"},"example":"{\"id\":10000,\"self\":\"http://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.
\n"},"403":{"description":"Returned if the user does not have permission to edit the project's configuration.
\n"},"404":{"description":"Returned if the project or permission scheme is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/project/{projectKeyOrId}/securitylevel":{"get":{"tags":["ProjectSecurityLevel"],"summary":"Get project issue security levels","description":"Returns all issue security levels for the project that the user has access to.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse projects global permission for the project, however, issue security levels are only returned for authenticated user with Set Issue Security global permission for the project.
\n","operationId":"getSecurityLevelsForProject","parameters":[{"name":"projectKeyOrId","in":"path","description":"The project ID or project key (case sensitive).
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectIssueSecurityLevels"},"example":"{\"levels\":[{\"self\":\"http://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\":\"http://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.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/projectCategory":{"get":{"tags":["ProjectCategory"],"summary":"Get all project categories","description":"Returns all project categories.
\nPermissions required: Permission to access Jira.
\n","operationId":"getAllProjectCategories","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectCategory"}},"example":"[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},{\"self\":\"http://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.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"INACCESSIBLE"},"post":{"tags":["ProjectCategory"],"summary":"Create project category","description":"Creates a project category.
\nPermissions required: Administer Jira global permission.
\n","operationId":"createProjectCategory","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectCategory"},"example":{"name":"CREATED","description":"Created Project Category"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectCategory"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10100\",\"id\":\"10100\",\"name\":\"CREATED\",\"description\":\"Created Project Category\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the necessary permissions.
\n"},"409":{"description":"Returned if the project category name is in use.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/projectCategory/{id}":{"get":{"tags":["ProjectCategory"],"summary":"Get project category by id","description":"Returns a project category.
\nPermissions required: Permission to access Jira.
\n","operationId":"getProjectCategoryById","parameters":[{"name":"id","in":"path","description":"The ID of the project category.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectCategory"},"example":"{\"self\":\"http://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.
\n"},"404":{"description":"Returned if the project category is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"INACCESSIBLE"},"put":{"tags":["ProjectCategory"],"summary":"Update project category","description":"Updates a project category.
\nPermissions required: Administer Jira global permission.
\n","operationId":"updateProjectCategory","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectCategory"},"example":{"name":"UPDATED","description":"Updated Project Category"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatedProjectCategory"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10100\",\"id\":\"10100\",\"name\":\"UPDATED\",\"description\":\"Updated Project Category\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the necessary permission.
\n"},"404":{"description":"Returned if the project category is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["ProjectCategory"],"summary":"Delete project category","description":"Deletes a project category.
\nPermissions required: Administer Jira global permission.
\n","operationId":"removeProjectCategory","parameters":[{"name":"id","in":"path","description":"ID of the project category to delete.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the necessary permission.
\n"},"404":{"description":"Returned if the project category is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/projectvalidate/key":{"get":{"tags":["ProjectValidate"],"summary":"Validate project key","description":"Validates a project key by confirming the key is a valid string and not in use.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"validateProjectKey","parameters":[{"name":"key","in":"query","description":"The project key.
\n","schema":{"type":"string","example":"HSP"},"x-showInExample":"true"}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/projectvalidate/validProjectKey":{"get":{"tags":["ProjectValidate"],"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.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getValidProjectKey","parameters":[{"name":"key","in":"query","description":"The project key.
\n","schema":{"type":"string","example":"HSP"},"x-showInExample":"true"}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"string"},"example":"\"VPNE\""}}},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/projectvalidate/validProjectName":{"get":{"tags":["ProjectValidate"],"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.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getValidProjectName","parameters":[{"name":"name","in":"query","description":"The project name.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"string"},"example":"\"Valid Project Name Example\""}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"},"404":{"description":"Returned if a valid project name cannot be generated.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/resolution":{"get":{"tags":["Resolution"],"summary":"Get resolutions","description":"Returns a list of all issue resolution values.
\nPermissions required: Permission to access Jira.
\n","operationId":"getResolutions","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Resolution"}},"example":"[{\"self\":\"http://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\":\"http://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.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/resolution/{id}":{"get":{"tags":["Resolution"],"summary":"Get resolution","description":"Returns an issue resolution value.
\nPermissions required: Permission to access Jira.
\n","operationId":"getResolution","parameters":[{"name":"id","in":"path","description":"The ID of the issue resolution value.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resolution"},"example":"{\"self\":\"http://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.
\n"},"404":{"description":"Returned if the issue resolution value is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/role":{"get":{"tags":["Role"],"summary":"Get all project roles","description":"Gets a list of all project roles, complete with project role details and default actors.
\nAbout project roles
\nProject roles are a flexible way to to associate users and groups with projects. In Jira Cloud, the list of project roles is shared globally with all projects, but each project can have a different set of actors associated with it (unlike groups, which have the same membership throughout all Jira applications).
\nProject roles are used in permission schemes, email notification schemes, issue security levels, comment visibility, and workflow conditions.
\nMembers and actors
\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.
\nActors may be set as default members of the project role or set at the project level:
\n\nDefault 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.
\nActors: 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
\nPermissions required: Administer Jira global permission.
\n","operationId":"getAllProjectRoles","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectRole"}},"example":"[{\"self\":\"http://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\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have administrative permissions.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Role"],"summary":"Create project role","description":"Creates a new project role with no default actors. You can use the Add default actors to project role operation to add default actors to the project role after creating it.
\nNote 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.<
\nPermissions required: Administer Jira global permission.
\n","operationId":"createProjectRole","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateRoleRequestBean"},"example":{"name":"Developers","description":"A project role that represents developers in a project"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRole"},"example":"{\"self\":\"http://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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have administrative permissions.
\n"},"409":{"description":"Returned if a project role with the provided name already exists.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/role/{id}":{"get":{"tags":["Role"],"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.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getProjectRoleById","parameters":[{"name":"id","in":"path","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRole"},"example":"{\"self\":\"http://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\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have administrative permissions.
\n"},"404":{"description":"Returned if the project role is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"},"put":{"tags":["Role"],"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.
\nPermissions required: Administer Jira global permission.
\n","operationId":"fullyUpdateProjectRole","parameters":[{"name":"id","in":"path","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateRoleRequestBean"},"example":{"name":"Developers","description":"A project role that represents developers in a project"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRole"},"example":"{\"self\":\"http://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\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"}}],\"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.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have administrative permissions.
\n"},"404":{"description":"Returned if the project role is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"post":{"tags":["Role"],"summary":"Partial update project role","description":"Updates either the project role's name or its description.
\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.
\nPermissions required: Administer Jira global permission.
\n","operationId":"partialUpdateProjectRole","parameters":[{"name":"id","in":"path","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateRoleRequestBean"},"example":{"name":"Developers","description":"A project role that represents developers in a project"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectRole"},"example":"{\"self\":\"http://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\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have administrative permissions.
\n"},"404":{"description":"Returned if the project role is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["Role"],"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.
\nPermissions required: Administer Jira global permission.
\n","operationId":"deleteProjectRole","parameters":[{"name":"id","in":"path","description":"The ID of the project role to delete. Use Get all project roles to get a list of project role IDs.
\n","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.
\n","schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the request is invalid or if the replacement project role is not found.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have administrative permissions.
\n"},"404":{"description":"Returned if the project role being deleted is not found.
\n"},"409":{"description":"Returned if the project role being deleted is in use and a replacement project role is not specified in the request.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/role/{id}/actors":{"get":{"tags":["Role"],"summary":"Get default actors for project role","description":"Returns the default actors for the project role.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getProjectRoleActorsForRole","parameters":[{"name":"id","in":"path","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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\"}}]}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have administrative permissions.
\n"},"404":{"description":"Returned if the project role is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Role"],"summary":"Add default actors to project role","description":"Adds default actors to a role. You may add groups or users, but you cannot add groups and users in the same request.
\nChanging a project role's default actors does not affect project role members for projects already created.
\nPermissions required: Administer Jira global permission.
\n","operationId":"addProjectRoleActorsToRole","parameters":[{"name":"id","in":"path","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.
\n","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.
\n","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\"}}]}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have administrative permissions.
\n"},"404":{"description":"Returned if the project role is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["Role"],"summary":"Delete default actors from project role","description":"Deletes the default actors from a project role. You may delete a group or user, but you cannot delete a group and a user in the same request.
\nChanging a project role's default actors does not affect project role members for projects already created.
\nPermissions required: Administer Jira global permission.
\n","operationId":"deleteProjectRoleActorsFromRole","parameters":[{"name":"id","in":"path","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.
\n","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.
\n","schema":{"type":"string","example":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"},"x-showInExample":"true"},{"name":"group","in":"query","description":"The group name of the group to be removed as a default actor.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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\"}}]}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have administrative permissions.
\n"},"404":{"description":"Returned if the project role is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/screens":{"get":{"tags":["Screens"],"summary":"Get all screens","description":"Returns all screens.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getAllScreens","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 100.
\n","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanScreen"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"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.
\nPermissions required: Administer Jira global permission.
\n","operationId":"addFieldToDefaultScreen","parameters":[{"name":"fieldId","in":"path","description":"The ID of the field.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the field it not found or the field is already present.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"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.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getAvailableScreenFields","parameters":[{"name":"screenId","in":"path","description":"The ID of the screen.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScreenableField"}}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the screen is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/screens/{screenId}/tabs":{"get":{"tags":["Screens"],"summary":"Get all screen tabs","description":"Returns the list of tabs for a screen.
\nPermissions required:
\n\nAdminister Jira global permission.
\nAdminister projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.
\n
\n","operationId":"getAllScreenTabs","parameters":[{"name":"screenId","in":"path","description":"The ID of the screen.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"projectKey","in":"query","description":"The key of the project.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScreenableTab"}}}}},"400":{"description":"Returned if the screen ID is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the screen is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Screens"],"summary":"Create screen tab","description":"Creates a tab for a screen.
\nPermissions required: Administer Jira global permission.
\n","operationId":"addScreenTab","parameters":[{"name":"screenId","in":"path","description":"The ID of the screen.
\n","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.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenableTab"},"example":"{\"id\":10000,\"name\":\"Fields Tab\"}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the screen is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/screens/{screenId}/tabs/{tabId}":{"put":{"tags":["Screens"],"summary":"Update screen tab","description":"Updates the name of a screen tab.
\nPermissions required: Administer Jira global permission.
\n","operationId":"renameScreenTab","parameters":[{"name":"screenId","in":"path","description":"The ID of the screen.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tabId","in":"path","description":"The ID of the screen tab.
\n","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.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenableTab"},"example":"{\"id\":10000,\"name\":\"Fields Tab\"}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the screen or screen tab is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["Screens"],"summary":"Delete screen tab","description":"Deletes a screen tab.
\nPermissions required: Administer Jira global permission.
\n","operationId":"deleteScreenTab","parameters":[{"name":"screenId","in":"path","description":"The ID of the screen.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tabId","in":"path","description":"The ID of the screen tab.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the screen or screen tab is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/screens/{screenId}/tabs/{tabId}/fields":{"get":{"tags":["Screens"],"summary":"Get all screen tab fields","description":"Returns all fields for a screen tab.
\nPermissions required:
\n\nAdminister Jira global permission.
\nAdminister projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.
\n
\n","operationId":"getAllScreenTabFields","parameters":[{"name":"screenId","in":"path","description":"The ID of the screen.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tabId","in":"path","description":"The ID of the screen tab.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"projectKey","in":"query","description":"The key of the project.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScreenableField"}}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the screen or screen tab is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"ADMIN"},"post":{"tags":["Screens"],"summary":"Add screen tab field","description":"Adds a field to a screen tab.
\nPermissions required: Administer Jira global permission.
\n","operationId":"addScreenTabField","parameters":[{"name":"screenId","in":"path","description":"The ID of the screen.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tabId","in":"path","description":"The ID of the screen tab.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddFieldBean"},"example":{"fieldId":"summary"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenableField"},"example":"{\"id\":\"summary\",\"name\":\"Summary\"}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the screen, screen tab, or field is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}":{"delete":{"tags":["Screens"],"summary":"Remove screen tab field","description":"Removes a field from a screen tab.
\nPermissions required: Administer Jira global permission.
\n","operationId":"removeScreenTabField","parameters":[{"name":"screenId","in":"path","description":"The ID of the screen.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tabId","in":"path","description":"The ID of the screen tab.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"The ID of the field.
\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the screen, screen tab, or field is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}/move":{"post":{"tags":["Screens"],"summary":"Move screen tab field","description":"Moves a screen tab field.
\nIf after and position are provided in the request, position is ignored.
\nPermissions required: Administer Jira global permission.
\n","operationId":"moveScreenTabField","parameters":[{"name":"screenId","in":"path","description":"The ID of the screen.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tabId","in":"path","description":"The ID of the screen tab.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"The ID of the field.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveFieldBean"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the screen, screen tab, or field is not found or the field can't be moved to the requested position.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/screens/{screenId}/tabs/{tabId}/move/{pos}":{"post":{"tags":["Screens"],"summary":"Move screen tab","description":"Moves a screen tab.
\nPermissions required: Administer Jira global permission.
\n","operationId":"moveScreenTab","parameters":[{"name":"screenId","in":"path","description":"The ID of the screen.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tabId","in":"path","description":"The ID of the screen tab.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"pos","in":"path","description":"The position of tab. The base index is 0.
\n","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the screen or screen tab is not found or the position is invalid.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/search":{"get":{"tags":["Search"],"summary":"Search for issues using JQL (GET)","description":"Searches for issues using JQL.
\nIf the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.
\nThis operation can be accessed anonymously.
\nPermissions required: Issues are included in the response where the user has:
\n\nBrowse projects project permission for the project containing the issue.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"searchForIssuesUsingJql","parameters":[{"name":"jql","in":"query","description":"The JQL that defines the search. Note:
\n\nIf no JQL expression is provided, all issues are returned.
\nusername and userkey cannot be used as search terms due to privacy reasons. Use accountId instead.
\nIf 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
\n","schema":{"type":"string","example":"project = HSP"},"x-showInExample":"true"},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int32","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. To manage page size, Jira may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting id or key only.
\n","schema":{"type":"integer","format":"int32","default":50}},{"name":"validateQuery","in":"query","description":"Determines how to validate the JQL query and treat the validation results. Supported values are:
\n\nstrict Returns a 400 response code if any errors are found, along with a list of all errors (and warnings).
\nwarn Returns all errors as warnings.
\nnone No validation is performed.
\ntrue Deprecated A legacy synonym for strict.
\nfalse Deprecated A legacy synonym for warn.
\n
\nNote: If the JQL is not correctly formed a 400 response code is returned, regardless of the validateQuery value.
\n","schema":{"type":"string","enum":["strict","warn","none","true","false"],"default":"strict"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return for each issue, use it to retrieve a subset of fields. Allowed values:
\n\n*all Returns all fields.
\n*navigable Returns navigable fields.
\nAny issue field, prefixed with a minus to exclude.
\n
\nExamples:
\n\nsummary,comment Returns only the summary and comments fields.
\n-description Returns all navigable (default) fields except description.
\n*all,-comment Returns all fields except comments.
\n
\nThis parameter may be specified multiple times. For example, fields=field1,field2&fields=field3.
\nNote: All navigable fields are returned by default. This differs from GET issue where the default is all fields.
\n","schema":{"type":"array","items":{"type":"string","default":"*navigable"}}},{"name":"expand","in":"query","description":"Use expand to include additional information about issues in the response. This parameter accepts multiple values separated by a comma:
\n\nrenderedFields Returns field values rendered in HTML format.
\nnames Returns the display name of each field.
\nschema Returns the schema describing a field type.
\ntransitions Returns all possible transitions for the issue.
\noperations Returns all possible operations for the issue.
\neditmeta Returns information about how each field can be edited.
\nchangelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent.
\nversionedRepresentations Instead of fields, returns versionedRepresentations a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.
\n
\n","schema":{"type":"string"}},{"name":"properties","in":"query","description":"A comma-separated list of issue property keys for issue properties to include in the results. This parameter may be specified multiple times. For example, properties=prop1,prop2&properties=prop3. A maximum of 5 issue property keys can be specified.
\n","schema":{"type":"array","items":{"type":"string"}}},{"name":"fieldsByKeys","in":"query","description":"Reference fields by their key (rather than ID).
\n","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResults"},"example":"{\"expand\":\"names,schema\",\"startAt\":0,\"maxResults\":50,\"total\":1,\"issues\":[{\"expand\":\"\",\"id\":\"10002\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10002\",\"key\":\"EX-1\",\"fields\":{\"watcher\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers\",\"isWatching\":false,\"watchCount\":1,\"watchers\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false}]},\"attachment\":[{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/attachments/10000\",\"filename\":\"picture.jpg\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-05T04:31:46.734+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"https://your-domain.atlassian.net/jira/attachments/10000\",\"thumbnail\":\"https://your-domain.atlassian.net/jira/secure/thumbnail/10000\"}],\"sub-tasks\":[{\"id\":\"10000\",\"type\":{\"id\":\"10000\",\"name\":\"\",\"inward\":\"Parent\",\"outward\":\"Sub-task\"},\"outwardIssue\":{\"id\":\"10003\",\"key\":\"EX-2\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/EX-2\",\"fields\":{\"status\":{\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"description\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"example bug report\"}]}]},\"project\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"},\"comment\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"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\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-05T04:31:45.088+0000\",\"updated\":\"2019-09-05T04:31:45.089+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}],\"issuelinks\":[{\"id\":\"10001\",\"type\":{\"id\":\"10000\",\"name\":\"Dependent\",\"inward\":\"depends on\",\"outward\":\"is depended by\"},\"outwardIssue\":{\"id\":\"10004L\",\"key\":\"PRJ-2\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/PRJ-2\",\"fields\":{\"status\":{\"iconUrl\":\"http://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\":\"PRJ-3\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/PRJ-3\",\"fields\":{\"status\":{\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"worklog\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2019-09-05T04:31:45.519+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2019-09-05T04:31:45.519+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}}}],\"warningMessages\":[\"The value 'bar' does not exist for the field 'foo'.\"]}"}}},"400":{"description":"Returned if the JQL query is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Search"],"summary":"Search for issues using JQL (POST)","description":"Searches for issues using JQL.
\nThere is a GET version of this resource that can be used for smaller JQL query expressions.
\nThis operation can be accessed anonymously.
\nPermissions required: Issues are included in the response where the user has:
\n\nBrowse projects project permission for the project containing the issue.
\nIf issue-level security is configured, issue-level security permission to view the issue.
\n
\n","operationId":"searchForIssuesUsingJql","parameters":[],"requestBody":{"description":"A JSON object containing the search request.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequestBean"},"example":{"expand":["names","schema","operations"],"jql":"project = HSP","maxResults":15,"fieldsByKeys":false,"fields":["summary","status","assignee"],"startAt":0}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResults"},"example":"{\"expand\":\"names,schema\",\"startAt\":0,\"maxResults\":50,\"total\":1,\"issues\":[{\"expand\":\"\",\"id\":\"10002\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10002\",\"key\":\"EX-1\",\"fields\":{\"watcher\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers\",\"isWatching\":false,\"watchCount\":1,\"watchers\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false}]},\"attachment\":[{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/attachments/10000\",\"filename\":\"picture.jpg\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-05T04:31:46.734+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"https://your-domain.atlassian.net/jira/attachments/10000\",\"thumbnail\":\"https://your-domain.atlassian.net/jira/secure/thumbnail/10000\"}],\"sub-tasks\":[{\"id\":\"10000\",\"type\":{\"id\":\"10000\",\"name\":\"\",\"inward\":\"Parent\",\"outward\":\"Sub-task\"},\"outwardIssue\":{\"id\":\"10003\",\"key\":\"EX-2\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/EX-2\",\"fields\":{\"status\":{\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"description\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"example bug report\"}]}]},\"project\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"},\"comment\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"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\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-05T04:31:45.088+0000\",\"updated\":\"2019-09-05T04:31:45.089+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}],\"issuelinks\":[{\"id\":\"10001\",\"type\":{\"id\":\"10000\",\"name\":\"Dependent\",\"inward\":\"depends on\",\"outward\":\"is depended by\"},\"outwardIssue\":{\"id\":\"10004L\",\"key\":\"PRJ-2\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/PRJ-2\",\"fields\":{\"status\":{\"iconUrl\":\"http://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\":\"PRJ-3\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/PRJ-3\",\"fields\":{\"status\":{\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"worklog\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2019-09-05T04:31:45.519+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2019-09-05T04:31:45.519+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}}}],\"warningMessages\":[\"The value 'bar' does not exist for the field 'foo'.\"]}"}}},"400":{"description":"Returned if the JQL query is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/securitylevel/{id}":{"get":{"tags":["IssueSecurityLevel"],"summary":"Get issue security level","description":"Returns details of an issue security level.
\nUse Get issue security scheme to obtain the IDs of issue security levels associated with the issue security scheme.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getIssueSecurityLevel","parameters":[{"name":"id","in":"path","description":"The ID of the issue security level.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityLevel"},"example":"{\"self\":\"http://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.
\n"},"404":{"description":"Returned if the issue security level is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/serverInfo":{"get":{"tags":["ServerInfo"],"summary":"Get Jira instance info","description":"Returns information about the Jira instance.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getServerInfo","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerInformation"},"example":"{\"baseUrl\":\"http://your-domain.atlassian.net/jira\",\"version\":\"1001.0.0-SNAPSHOT\",\"versionNumbers\":[5,0,0],\"buildNumber\":582,\"buildDate\":\"2019-09-05T04:31:42.092+0000\",\"serverTime\":\"2019-09-05T04:31:42.092+0000\",\"scmInfo\":\"1f51473f5c7b75c1a69a0090f4832cdc5053702a\",\"serverTitle\":\"My Jira instance\",\"defaultLocale\":{\"locale\":\"en_AU\"}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"}},"deprecated":false,"security":[{"OAuth2":[]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/settings/columns":{"get":{"tags":["Settings"],"summary":"Get issue navigator default columns","description":"Returns the default issue navigator columns.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getIssueNavigatorDefaultColumns","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ColumnItem"}},"example":"[{\"label\":\"Key\",\"value\":\"issuekey\"},{\"label\":\"Summary\",\"value\":\"summary\"}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"put":{"tags":["Settings"],"summary":"Set issue navigator default columns","description":"Sets the default issue navigator columns.
\nThe columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl:
\ncurl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/settings/columns
\nIf no column details are sent, then all default columns are removed.
\nA navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using Get fields.
\nPermissions required: Administer Jira global permission.
\n","operationId":"setIssueNavigatorDefaultColumns","parameters":[],"requestBody":{"description":"A navigable field value.
\n","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.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if invalid parameters are passed.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if a navigable field value is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/status":{"get":{"tags":["Status"],"summary":"Get all statuses","description":"Returns a list of all statuses associated with workflows.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getStatuses","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StatusDetails"}},"example":"[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/status/10000\",\"description\":\"The issue is currently being worked on.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/progress.gif\",\"name\":\"In Progress\",\"id\":\"10000\",\"statusCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In Progress\"}},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/status/5\",\"description\":\"The issue is closed.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/closed.gif\",\"name\":\"Closed\",\"id\":\"5\",\"statusCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/9\",\"id\":9,\"key\":\"completed\",\"colorName\":\"green\"}}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/status/{idOrName}":{"get":{"tags":["Status"],"summary":"Get status","description":"Returns a status. The status must be associated with a workflow to be returned.
\nIf a name is used on more than one status, only the status found first is returned. Therefore, identifying the status by its ID may be preferable.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getStatus","parameters":[{"name":"idOrName","in":"path","description":"The ID or name of the status.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusDetails"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/status/10000\",\"description\":\"The issue is currently being worked on.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/progress.gif\",\"name\":\"In Progress\",\"id\":\"10000\",\"statusCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In Progress\"}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nthe status is not found.
\nthe status is not associated with a workflow.
\nthe user does not have the required permissions.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/statuscategory":{"get":{"tags":["StatusCategory"],"summary":"Get all status categories","description":"Returns a list of all status categories.
\nPermissions required: Permission to access Jira.
\n","operationId":"getStatusCategories","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StatusCategory"}},"example":"[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In Progress\"},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/9\",\"id\":9,\"key\":\"completed\",\"colorName\":\"green\"}]"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/statuscategory/{idOrKey}":{"get":{"tags":["StatusCategory"],"summary":"Get status category","description":"Returns a status category. Status categories provided a mechanism for categorizing statuses.
\nPermissions required: Permission to access Jira.
\n","operationId":"getStatusCategory","parameters":[{"name":"idOrKey","in":"path","description":"The ID or key of the status category.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusCategory"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In Progress\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the status category is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/task/{taskId}":{"get":{"tags":["Task"],"summary":"Get task","description":"Returns the status of a long-running asynchronous task.
\nWhen a task has finished, this operation returns the JSON blob applicable to the task. See the documentation of the operation that created the task for details. Task details are not permanently retained. As of September 2019, details are retained for 14 days although this period may change without notice.
\nPermissions required: either of:
\n\nAdminister Jira global permission.
\nCreator of the task.
\n
\n","operationId":"getTask","parameters":[{"name":"taskId","in":"path","description":"The ID of the task.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskProgressBeanObject"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/task/1\",\"id\":\"1\",\"description\":\"Task description\",\"status\":\"COMPLETE\",\"result\":\"the task result, this may be any JSON\",\"submittedBy\":10000,\"progress\":100,\"elapsedRuntime\":156,\"submitted\":1567657902281,\"started\":1567657902402,\"finished\":1567657902502,\"lastUpdate\":1567657902502}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the task is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":[]}],"x-experimental":true,"x-atlassian-connect-scope":"NONE"}},"/rest/api/3/task/{taskId}/cancel":{"post":{"tags":["Task"],"summary":"Cancel task","description":"Cancels a task.
\nPermissions required: either of:
\n\nAdminister Jira global permission.
\nCreator of the task.
\n
\n","operationId":"cancelTask","parameters":[{"name":"taskId","in":"path","description":"The ID of the task.
\n","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if cancellation of the task is not possible.
\n","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"403":{"description":"Returned if the user does not have the required permissions.
\n","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"404":{"description":"Returned if the task is not found.
\n","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-experimental":true,"x-atlassian-connect-scope":"NONE"}},"/rest/api/3/universal_avatar/type/{type}/owner/{entityId}":{"get":{"tags":["UniversalAvatar"],"summary":"Get avatars","description":"Returns the system and custom avatars for a project or issue type.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"getAvatars","parameters":[{"name":"type","in":"path","description":"The type of the entity. Valid values are project and issuetype.
\n","required":true,"schema":{"type":"string"}},{"name":"entityId","in":"path","description":"The ID of the entity item.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Avatars"},"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.
\n"},"404":{"description":"Returned if the entity type is invalid, the item ID is missing, or the item is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"post":{"tags":["UniversalAvatar"],"summary":"Load avatar","description":"Loads a custom avatar for a project or issue type.
\nSpecify the avatar's local file location in the body of the request. Also, include the following headers:
\n\nX-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers.
\nContent-Type: image/image type Valid image types are JPEG, GIF, or PNG.
\n
\nFor example:
\ncurl --request POST 
\n--user [email protected]:<api_token> 
\n--header 'X-Atlassian-Token: no-check' 
\n--header 'Content-Type: image/< image_type>' 
\n--data-binary "<@/path/to/file/with/your/avatar>" 
\n--url 'https://your-domain.atlassian.net/rest/api/3/universal_avatar/type/{type}/owner/{entityId}'
\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.
\nThe cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.
\nAfter creating the avatar use:
\n\nUpdate issue type to set it as the issue type's displayed avatar.
\nSet project avatar to set it as the project's displayed avatar.
\n
\nPermissions required: Administer Jira global permission.
\n","operationId":"storeAvatar","parameters":[{"name":"type","in":"path","description":"The type of the entity. Valid values are project and issuetype.
\n","required":true,"schema":{"type":"string"}},{"name":"entityId","in":"path","description":"The ID of the entity item.
\n","required":true,"schema":{"type":"string"}},{"name":"x","in":"query","description":"The X coordinate of the top-left corner of the crop region.
\n","schema":{"type":"integer","format":"int32","default":0}},{"name":"y","in":"query","description":"The Y coordinate of the top-left corner of the crop region.
\n","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"The length of each side of the crop region.
\n","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"*/*":{"schema":{}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.
\n","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\nan image isn't included in the request.
\nthe image type is unsupported.
\nthe crop parameters extend the crop area beyond the edge of the image.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the entity type is invalid, the item ID is missing, or the item is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}":{"delete":{"tags":["UniversalAvatar"],"summary":"Delete avatar","description":"Deletes an avatar from a project or issue type.
\nPermissions required: Administer Jira global permission.
\n","operationId":"deleteAvatar","parameters":[{"name":"type","in":"path","description":"The type of the entity. Valid values are project and issuetype.
\n","required":true,"schema":{"type":"string"}},{"name":"owningObjectId","in":"path","description":"The ID of the entity item.
\n","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the avatar.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the request is invalid.
\n"},"403":{"description":"Returned if the user does not have permission to delete the avatar, the avatar is not deletedable.
\n"},"404":{"description":"Returned if the entity type, entity ID, or avatar ID is invalid.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/user":{"get":{"tags":["User"],"summary":"Get user","description":"Returns a user.
\nPermissions required: Permission to access Jira.
\n","operationId":"getUser","parameters":[{"name":"accountId","in":"query","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.
\n","schema":{"type":"string","example":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"},"x-showInExample":"true"},{"name":"username","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}},{"name":"key","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use expand to include additional information about users in the response. This parameter accepts multiple values separated by a comma:
\n\ngroups includes all groups and nested groups to which the user belongs.
\napplicationRoles includes details of all the applications to which the user has access.
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"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.
\n"},"404":{"description":"Returned if:
\n\naccountId is missing.
\nthe user is not found.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["User"],"summary":"Create user","description":"Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated.
\nThe option is provided to set or generate a password for the user. When using the option to generate a password, by omitting password from the request, include "notification": "true" to ensure the user is sent an email advising them that their account is created. This email includes a link for the user to set their password. If the notification isn't sent for a generated password, the user will need to be sent a reset password request from Jira.
\nPermissions required: Administer Jira global permission.
\n","operationId":"createUser","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWriteBean"},"example":{"password":"abracadabra","emailAddress":"[email protected]","displayName":"Mia Krystof","name":""}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}}"}}},"400":{"description":"Returned if the request is invalid or the number of licensed users is exceeded.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"}},"deprecated":false,"x-experimental":true,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["User"],"summary":"Delete user","description":"Deletes a user.
\nPermissions required: Site administration (that is, membership of the site-admin group).
\n","operationId":"removeUser","parameters":[{"name":"accountId","in":"query","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.
\n","schema":{"type":"string","example":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"},"x-showInExample":"true"},{"name":"username","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}},{"name":"key","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the user cannot be removed.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if:
\n\naccountId is missing.
\nthe user is not found.
\n
\n"}},"deprecated":false,"x-experimental":true,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/user/assignable/multiProjectSearch":{"get":{"tags":["User"],"summary":"Find users assignable to projects","description":"Returns a list of users who can be assigned issues in one or more projects. The list may be restricted to users whose attributes match a string.
\nThis operation can be accessed anonymously.
\nPermissions required: None.
\n","operationId":"findBulkAssignableUsers","parameters":[{"name":"query","in":"query","description":"A query string that is matched against user attributes, such as displayName and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of [email protected]. Required, unless accountId is specified.
\n","schema":{"type":"string","example":"query"},"x-showInExample":"true"},{"name":"username","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}},{"name":"accountId","in":"query","description":"A query string that is matched against user accountId. The string must match the accountId exactly. Required, unless query is specified.
\n","schema":{"type":"string"}},{"name":"projectKeys","in":"query","description":"A comma-separated list of project keys (case sensitive).
\n","schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int32","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 1000.
\n","schema":{"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"example":"[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:e2a16dd9-2ffb-4a4b-a9bd-bd1145a020ee\",\"key\":\"\",\"accountId\":\"99:e2a16dd9-2ffb-4a4b-a9bd-bd1145a020ee\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=andrew\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=andrew\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=andrew\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=andrew\"},\"displayName\":\"Andrew Anderson\",\"active\":false}]"}}},"400":{"description":"Returned if:
\n\nprojectKeys is missing.
\nneither of query or accountId are provided.
\nboth query and accountId are provided.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if one or more of the projects is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/user/assignable/search":{"get":{"tags":["User"],"summary":"Find users assignable to issues","description":"Returns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be assigned to:
\n\na new issue, by providing the projectKeyOrId.
\nan updated issue, by providing the issueKey.
\nto an issue during a transition (workflow action), by providing the issueKey and the transition id in actionDescriptorId. You can obtain the IDs of an issue's valid transitions using the transitions option in the expand parameter of  Get issue.
\n
\nIn all these cases, you can pass an accountId to determine if a user can be assigned to an issue. The user is returned in the response if they can be assigned to the issue or issue transition.
\nPermissions required: Permission to access Jira.
\n","operationId":"findAssignableUsers","parameters":[{"name":"query","in":"query","description":"A query string that is matched against user attributes, such as displayName, and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of [email protected]. Required, unless username or accountId is specified.
\n","schema":{"type":"string","example":"query"},"x-showInExample":"true"},{"name":"sessionId","in":"query","description":"The sessionId of this request. SessionId is the same until the assignee is set.
\n","schema":{"type":"string"}},{"name":"username","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}},{"name":"accountId","in":"query","description":"A query string that is matched against user accountId. The string must match the accountId exactly. Required, unless query is specified.
\n","schema":{"type":"string"}},{"name":"project","in":"query","description":"The project ID or project key (case sensitive). Required, unless issueKey is specified.
\n","schema":{"type":"string"}},{"name":"issueKey","in":"query","description":"The key of the issue. Required, unless project is specified.
\n","schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int32","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 1000.
\n","schema":{"type":"integer","format":"int32","default":50}},{"name":"actionDescriptorId","in":"query","description":"The ID of the transition.
\n","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}}"}}},"400":{"description":"Returned if:
\n\nissueKey or project is missing.
\nneither of query and accountId are provided.
\nboth query and accountId are provided.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the project, issue, or transition is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/user/bulk":{"get":{"tags":["UserBulk"],"summary":"Bulk get users","description":"Returns details of the users specified by one or more account IDs.
\nPermissions required: Permission to access Jira.
\n","operationId":"bulkGetUsers","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 200.
\n","schema":{"type":"integer","format":"int32","default":10}},{"name":"username","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"array","items":{"type":"string"}}},{"name":"key","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"array","items":{"type":"string"}}},{"name":"accountId","in":"query","description":"Account ID of a user. To specify multiple users, pass multiple accountId parameters. For example, accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e&accountId=26912:8347-325f-ef346-bd0342234324. Required.
\n","schema":{"type":"array","example":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192","items":{"type":"string","example":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"}},"x-showInExample":"true"}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanUser"},"example":"{\"maxResults\":100,\"startAt\":0,\"total\":1,\"isLast\":true,\"values\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}}]}"}}},"400":{"description":"Returned if accountID is missing.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/user/bulk/migration":{"get":{"tags":["UserBulk"],"summary":"Get account IDs for users","description":"Returns the account IDs for the users specified in the key or username parameters. Note that multiple key or username parameters can be specified.
\nPermissions required: Permission to access Jira.
\n","operationId":"bulkGetUsersMigration","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.
\n","schema":{"type":"integer","format":"int32","default":10}},{"name":"username","in":"query","description":"Username of a user. To specify multiple users, pass multiple copies of this parameter. For example, username=fred&username=barney. Required if key isn't provided. Cannot be provided if key is present.
\n","schema":{"type":"array","items":{"type":"string"}}},{"name":"key","in":"query","description":"Key of a user. To specify multiple users, pass multiple copies of this parameter. For example, key=fred&key=barney. Required if username isn't provided. Cannot be provided if username is present.
\n","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserMigrationBean"}},"example":"[{\"username\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\"},{\"username\":\"barney\",\"accountId\":\"26912:8347-325f-ef346-bd0342234324\"}]"}}},"400":{"description":"Returned if key or username
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/user/columns":{"get":{"tags":["User"],"summary":"Get user default columns","description":"Returns the default issue table columns for the user. If an accountId is not passed in the request, the calling user's details are returned.
\nPermissions required:
\n\nAdminister Jira global permission, to get the column details for any user.
\nPermission to access Jira, to get the calling user's column details.
\n
\n","operationId":"getUserDefaultColumns","parameters":[{"name":"accountId","in":"query","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
\n","schema":{"type":"string","example":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"},"x-showInExample":"true"},{"name":"username","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ColumnItem"}}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the calling user does not have the Administer Jira global permission or is not accessing their user record.
\n"},"404":{"description":"Returned if the requested user is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["User"],"summary":"Set user default columns","description":"Sets the default  issue table columns for the user. If an accountId is not passed, the calling user's default columns are set. If no column details are sent, then all default columns are removed.
\nThe parameters for this resource are expressed as HTML form data. For example, in curl:
\ncurl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/user/columns?accountId=384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192'
\nPermissions required:
\n\nAdminister Jira global permission, to set the columns on any user.
\nPermission to access Jira, to set the calling user's columns.
\n
\n","operationId":"setUserColumns","parameters":[{"name":"accountId","in":"query","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
\n","schema":{"type":"string","example":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"},"x-showInExample":"true"}],"requestBody":{"description":"The ID of a column to set. To set multiple columns, send multiple columns parameters.
\n","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.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the calling user does not have the Administer Jira global permission or is not accessing their user record.
\n"},"404":{"description":"Returned if the requested user is not found.
\n"},"500":{"description":"Returned if an invalid issue table column ID is sent.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["User"],"summary":"Reset user default columns","description":"Resets the default  issue table columns for the user to the system default. If an accountId is not passed, the calling user's default columns are reset.
\nPermissions required:
\n\nAdminister Jira global permission, to set the columns on any user.
\nPermission to access Jira, to set the calling user's columns.
\n
\n","operationId":"resetUserColumns","parameters":[{"name":"accountId","in":"query","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
\n","schema":{"type":"string","example":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"},"x-showInExample":"true"},{"name":"username","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the calling user does not have the Administer Jira global permission or is not accessing their user record.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/user/email":{"get":{"tags":["UnrestrictedUserEmail"],"summary":"Get user email","description":"Returns a user's email address. This API is only available to apps approved by Atlassian, according to these guidelines.
\n","operationId":"getUserEmail","parameters":[{"name":"accountId","in":"query","description":"The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Note, this should be treated as an opaque identifier (i.e. do not assume any structure in the value). Required.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnrestrictedUserEmail"},"example":"[email protected]"}}},"400":{"description":"Returned if the calling app is not approved to use this API.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request (for example if a user is trying to access this API).
\n"},"404":{"description":"Returned if a user with the given accountId doesn't exist
\n"},"503":{"description":"Indicates the API is not currently enabled
\n"}},"deprecated":false,"x-experimental":true,"x-atlassian-connect-scope":"ACCESS_EMAIL_ADDRESSES"}},"/rest/api/3/user/email/bulk":{"get":{"tags":["UnrestrictedUserEmail"],"summary":"Get user email bulk","description":"Returns a user's email address. This API is only available to apps approved by Atlassian, according to these guidelines.
\n","operationId":"getUserEmailBulk","parameters":[{"name":"accountId","in":"query","description":"the account IDs of the users for which emails are required. An accountId is an identifier that uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Note, this should be treated as an opaque identifier (i.e. do not assume any structure in the value).
\n","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnrestrictedUserEmail"}}}},"400":{"description":"Returned if the calling app is not approved to use this API.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect, or missing from the request (for example if a user is trying to access this API).
\n"},"503":{"description":"Indicates the API is not currently enabled.
\n"}},"deprecated":false,"x-experimental":true,"x-atlassian-connect-scope":"ACCESS_EMAIL_ADDRESSES"}},"/rest/api/3/user/groups":{"get":{"tags":["User"],"summary":"Get user groups","description":"Returns the groups to which a user belongs.
\nPermissions required: Browse users and groups global permission.
\n","operationId":"getUserGroups","parameters":[{"name":"accountId","in":"query","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.
\n","schema":{"type":"string","example":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"},"x-showInExample":"true"},{"name":"username","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}},{"name":"key","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupName"}},"example":"{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the calling user does not have the Browse users and groups global permission.
\n"},"404":{"description":"Returned if:
\n\naccountId is missing.
\nthe user is not found.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/user/permission/search":{"get":{"tags":["User"],"summary":"Find users with permissions","description":"Returns a list of users who fulfill these criteria:
\n\ntheir user attributes match a search string.
\nthey have a set of permissions for a project or issue.
\n
\nIf no search string is provided, a list of all users with the permissions is returned.
\nThis operation can be accessed anonymously.
\nPermissions required:
\n\nAdminister Jira global permission, to get users for any project.
\nAdminister Projects project permission for a project, to get users for that project.
\n
\n","operationId":"findUsersWithAllPermissions","parameters":[{"name":"query","in":"query","description":"A query string that is matched against user attributes, such as displayName and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of [email protected]. Required, unless accountId is specified.
\n","schema":{"type":"string","example":"query"},"x-showInExample":"true"},{"name":"username","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}},{"name":"accountId","in":"query","description":"A query string that is matched against user accountId. The string must match the accountId exactly. Required, unless query is specified.
\n","schema":{"type":"string"}},{"name":"permissions","in":"query","description":"A comma-separated list of permissions. The valid permissions are:
\n\nASSIGNABLE_USER
\nASSIGN_ISSUE
\nATTACHMENT_DELETE_ALL
\nATTACHMENT_DELETE_OWN
\nBROWSE
\nCLOSE_ISSUE
\nCOMMENT_DELETE_ALL
\nCOMMENT_DELETE_OWN
\nCOMMENT_EDIT_ALL
\nCOMMENT_EDIT_OWN
\nCOMMENT_ISSUE
\nCREATE_ATTACHMENT
\nCREATE_ISSUE
\nDELETE_ISSUE
\nEDIT_ISSUE
\nLINK_ISSUE
\nMANAGE_WATCHER_LIST
\nMODIFY_REPORTER
\nMOVE_ISSUE
\nPROJECT_ADMIN
\nRESOLVE_ISSUE
\nSCHEDULE_ISSUE
\nSET_ISSUE_SECURITY
\nTRANSITION_ISSUE
\nVIEW_VERSION_CONTROL
\nVIEW_VOTERS_AND_WATCHERS
\nVIEW_WORKFLOW_READONLY
\nWORKLOG_DELETE_ALL
\nWORKLOG_DELETE_OWN
\nWORKLOG_EDIT_ALL
\nWORKLOG_EDIT_OWN
\nWORK_ISSUE
\n
\n","schema":{"type":"string"}},{"name":"issueKey","in":"query","description":"The issue key for the issue.
\n","schema":{"type":"string"}},{"name":"projectKey","in":"query","description":"The project key for the project (case sensitive).
\n","schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int32","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 1000.
\n","schema":{"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"example":"[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:e2a16dd9-2ffb-4a4b-a9bd-bd1145a020ee\",\"key\":\"\",\"accountId\":\"99:e2a16dd9-2ffb-4a4b-a9bd-bd1145a020ee\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=andrew\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=andrew\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=andrew\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=andrew\"},\"displayName\":\"Andrew Anderson\",\"active\":false}]"}}},"400":{"description":"Returned if:
\n\nissueKey or projectKey is missing.
\nneither of query or accountId are provided.
\nboth query and accountId are provided.
\npermissions is empty or contains an invalid entry.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the issue or project is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/user/picker":{"get":{"tags":["User"],"summary":"Find users for picker","description":"Returns a list of users whose attributes match the query term. The returned object includes the html field where the matched query term is highlighted with the HTML strong tag. A list of account IDs can be provided to exclude users from the results.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse users and groups global permission. Anonymous calls and calls by users without the required permission return search results for an exact name match only.
\n","operationId":"findUsersForPicker","parameters":[{"name":"query","in":"query","description":"A query string that is matched against user attributes, such as displayName, and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of [email protected].
\n","schema":{"type":"string"}},{"name":"maxResults","in":"query","description":"The maximum number of items to return. The maximum is 1000. The total number of matched users is returned in total.
\n","schema":{"type":"integer","format":"int32","default":50}},{"name":"showAvatar","in":"query","description":"Include the URI to the user's avatar.
\n","schema":{"type":"boolean","default":false}},{"name":"exclude","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"array","items":{"type":"string"}}},{"name":"excludeAccountIds","in":"query","description":"A comma-separated list of account IDs to exclude from the search results. This parameter may be specified multiple times. For example, excludeAccountIds=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e,bd429c95-e27b-4423-a0bd-421cf3d69129&excludeAccountIds=384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Cannot be provided with exclude.
\n","schema":{"type":"array","items":{"type":"string"}}},{"name":"avatarSize","in":"query","schema":{"type":"string"}},{"name":"excludeConnectUsers","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FoundUsers"},"example":"{\"users\":[{\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountType\":\"atlassian\",\"name\":\"mia\",\"key\":\"mia\",\"html\":\"Mia Krystof - mi[email protected] (mia)\",\"displayName\":\"Mia Krystof\",\"avatarUrl\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=fred\"}],\"total\":25,\"header\":\"Showing 20 of 25 matching groups\"}"}}},"400":{"description":"Returned if exclude and excludeAccountIds are provided.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/user/properties":{"get":{"tags":["UserProperty"],"summary":"Get user property keys","description":"Returns the keys of all properties for a user.
\nPermissions required:
\n\nAdminister Jira global permission, to access the property keys on any user.
\nAccess to Jira, to access the calling user's property keys.
\n
\nNote: These user properties are unrelated to the user properties that are set in Jira.
\n","operationId":"getUserPropertyKeys","parameters":[{"name":"accountId","in":"query","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.
\n","schema":{"type":"string","example":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"},"x-showInExample":"true"},{"name":"userKey","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}},{"name":"username","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyKeys"},"example":"{\"keys\":[{\"self\":\"http://your-domain.atlassian.net/jira/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"}}},"400":{"description":"Returned if accountId is missing.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the calling user does not have the Administer Jira permission or is not accessing their user record.
\n"},"404":{"description":"Returned if the user is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/user/properties/{propertyKey}":{"get":{"tags":["UserProperty"],"summary":"Get user property","description":"Returns the value of a user's property. If no property key is provided Get user property keys is called.
\nPermissions required:
\n\nAdminister Jira global permission, to get a property from any user.
\nAccess to Jira, to get a property from the calling user's record.
\n
\nNote: These user properties are unrelated to the user properties that are set in Jira.
\n","operationId":"getUserProperty","parameters":[{"name":"accountId","in":"query","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.
\n","schema":{"type":"string","example":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"},"x-showInExample":"true"},{"name":"userKey","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}},{"name":"username","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the user's property.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","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 accountId is missing.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the calling user does not have the Administer Jira permission or is not accessing their user record.
\n"},"404":{"description":"Returned if the user is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["UserProperty"],"summary":"Set user property","description":"Sets the value of a user's property. Use this resource to store custom data against a user.
\nPermissions required:
\n\nAdminister Jira global permission, to set a property on any user.
\nAccess to Jira, to set a property on the calling user's record.
\n
\nNote: These user properties are unrelated to the user properties that are set in Jira.
\n","operationId":"setUserProperty","parameters":[{"name":"accountId","in":"query","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.
\n","schema":{"type":"string","example":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"},"x-showInExample":"true"},{"name":"userKey","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}},{"name":"username","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the user's property. The maximum length is 255 characters.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{}}},"required":true},"responses":{"200":{"description":"Returned if the user property is updated.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"Returned if the user property is created.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if accountId is missing.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the calling user does not have the Administer Jira permission or is not accessing their user record.
\n"},"404":{"description":"Returned if the user is not found.
\n"},"405":{"description":"Returned if the property key is not specified.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["UserProperty"],"summary":"Delete user property","description":"Deletes a property from a user.
\nPermissions required:
\n\nAdminister Jira global permission, to delete a property from any user.
\nAccess to Jira, to delete a property from the calling user's record.
\n
\nNote: These user properties are unrelated to the user properties that are set in Jira.
\n","operationId":"deleteUserProperty","parameters":[{"name":"accountId","in":"query","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.
\n","schema":{"type":"string","example":"384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"},"x-showInExample":"true"},{"name":"userKey","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}},{"name":"username","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the user's property.
\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the user property is deleted.
\n"},"400":{"description":"Returned if accountId is missing.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the Administer Jira permission or is not accessing their user record.
\n"},"404":{"description":"Returned if the user or the property is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["write:jira-work"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/api/3/user/search":{"get":{"tags":["User"],"summary":"Find users","description":"Returns a list of users that match the provided search string and property.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse users and groups global permission. Anonymous calls or calls by users without the required permission return empty search results.
\nNote: This API is designed to return a small number of users with a flexible search query. As such, the sum of startAt and maxResults must be less than 1000. If the sum is greater, only results up to the 1000th result will be returned. If you wish to get a larger number of users, please use the get-all-users API (/rest/api/3/users/search) instead.
\n","operationId":"findUsers","parameters":[{"name":"query","in":"query","description":"A query string that is matched against user attributes ( displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of [email protected]. Required, unless accountId or property is specified.
\n","schema":{"type":"string","example":"query"},"x-showInExample":"true"},{"name":"username","in":"query","schema":{"type":"string"}},{"name":"accountId","in":"query","description":"A query string that is matched against a user accountId. The string must match the accountId exactly. Required, unless query or property is specified.
\n","schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int32","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 1000.
\n","schema":{"type":"integer","format":"int32","default":50}},{"name":"property","in":"query","description":"A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of nested from {"something":{"nested":1,"other":2}} use thepropertykey.something.nested=1. Required, unless accountId or query are specified.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"example":"[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:e2a16dd9-2ffb-4a4b-a9bd-bd1145a020ee\",\"key\":\"\",\"accountId\":\"99:e2a16dd9-2ffb-4a4b-a9bd-bd1145a020ee\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=andrew\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=andrew\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=andrew\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=andrew\"},\"displayName\":\"Andrew Anderson\",\"active\":false}]"}}},"400":{"description":"Returned if:
\n\naccountId, query or property is missing.
\nquery and accountId are provided.
\nproperty parameter is not valid.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/user/search/query":{"get":{"tags":["UserSearch"],"summary":"Find users by query","description":"Finds users with a structured query and returns user details.
\nPermissions required: Browse users and groups global permission.
\nThe query statements are:
\n\nis assignee of PROJ Returns the users that are assignees of at least one issue in project PROJ.
\nis assignee of (PROJ-1, PROJ-2) Returns users that are assignees on the issues PROJ-1 or PROJ-2.
\nis reporter of (PROJ-1, PROJ-2) Returns users that are reporters on the issues PROJ-1 or PROJ-2.
\nis watcher of (PROJ-1, PROJ-2) Returns users that are watchers on the issues PROJ-1 or PROJ-2.
\nis voter of (PROJ-1, PROJ-2) Returns users that are voters on the issues PROJ-1 or PROJ-2.
\nis commenter of (PROJ-1, PROJ-2) Returns users that have posted a comment on the issues PROJ-1 or PROJ-2.
\nis transitioner of (PROJ-1, PROJ-2) Returns users that have performed a transition on issues PROJ-1 or PROJ-2.
\n[propertyKey].entity.property.path is "property value" Returns users with the entity property value.
\n
\nThe list of issues can be extended as needed, as in (PROJ-1, PROJ-2, ... PROJ-n). Statements can be combined using the AND and OR operators to form more complex queries. For example:
\nis assignee of PROJ AND [propertyKey].entity.property.path is "property value"
\n","operationId":"findUsersByQuery","parameters":[{"name":"query","in":"query","description":"The search query.
\n","schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 1000.
\n","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanUser"}}}},"400":{"description":"Returned if the query is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the calling user does not have Browse users and groups global permission.
\n"},"408":{"description":"Returned if the search is timed out.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/api/3/user/search/query/key":{"get":{"tags":["UserSearch"],"summary":"Find user keys by query","description":"Finds users with a structured query and returns a list of user keys.
\nPermissions required: Browse users and groups global permission.
\nThe query statements are:
\n\nis assignee of PROJ Returns the users that are assignees of at least one issue in project PROJ.
\nis assignee of (PROJ-1, PROJ-2) Returns users that are assignees on the issues PROJ-1 or PROJ-2.
\nis reporter of (PROJ-1, PROJ-2) Returns users that are reporters on the issues PROJ-1 or PROJ-2.
\nis watcher of (PROJ-1, PROJ-2) Returns users that are watchers on the issues PROJ-1 or PROJ-2.
\nis voter of (PROJ-1, PROJ-2) Returns users that are voters on the issues PROJ-1 or PROJ-2.
\nis commenter of (PROJ-1, PROJ-2) Returns users that have posted a comment on the issues PROJ-1 or PROJ-2.
\nis transitioner of (PROJ-1, PROJ-2) Returns users that have performed a transition on issues PROJ-1 or PROJ-2.
\n[propertyKey].entity.property.path is "property value" Returns users with the entity property value.
\n
\nThe list of issues can be extended as needed, as in (PROJ-1, PROJ-2, ... PROJ-n). Statements can be combined using the AND and OR operators to form more complex queries. For example:
\nis assignee of PROJ AND [propertyKey].entity.property.path is "property value"
\n","operationId":"findUserKeysByQuery","parameters":[{"name":"query","in":"query","description":"The search query.
\n","schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 1000.
\n","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanUserKey"}}}},"400":{"description":"Returned if the query is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the calling user does not have Browse users and groups global permission.
\n"},"408":{"description":"Returned if the search is timed out.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/user/viewissue/search":{"get":{"tags":["User"],"summary":"Find users with browse permission","description":"Returns a list of users who fulfill these criteria:
\n\ntheir user attributes match a search string.
\nthey have permission to browse issues.
\n
\nUse this resource to find users who can browse:
\n\nan issue, by providing the issueKey.
\nany issue in a project, by providing the projectKey.
\n
\nThis operation can be accessed anonymously.
\nPermissions required: Browse users and groups global permission. Anonymous calls and calls by users without the required permission return empty search results.
\n","operationId":"findUsersWithBrowsePermission","parameters":[{"name":"query","in":"query","description":"A query string that is matched against user attributes, such as displayName and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of [email protected]. Required, unless accountId is specified.
\n","schema":{"type":"string","example":"query"},"x-showInExample":"true"},{"name":"username","in":"query","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
\n","schema":{"type":"string"}},{"name":"accountId","in":"query","description":"A query string that is matched against user accountId. The string must match the accountId exactly. Required, unless query is specified.
\n","schema":{"type":"string"}},{"name":"issueKey","in":"query","description":"The issue key for the issue. Required, unless projectKey is specified.
\n","schema":{"type":"string"}},{"name":"projectKey","in":"query","description":"The project key for the project (case sensitive). Required, unless issueKey is specified.
\n","schema":{"type":"string"}},{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int32","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page. The maximum is 1000.
\n","schema":{"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"example":"[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:e2a16dd9-2ffb-4a4b-a9bd-bd1145a020ee\",\"key\":\"\",\"accountId\":\"99:e2a16dd9-2ffb-4a4b-a9bd-bd1145a020ee\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=andrew\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=andrew\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=andrew\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=andrew\"},\"displayName\":\"Andrew Anderson\",\"active\":false}]"}}},"400":{"description":"Returned if:
\n\nneither of issueKey or projectKey are provided.
\nneither of query or accountId are provided.
\nboth query and accountId are provided.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the issue or project is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/users/search":{"get":{"tags":["Users"],"summary":"Get all users","description":"Returns a list of all (active and inactive) users.
\nPermissions required: Browse users and groups global permission.
\n","operationId":"getAllUsers","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return.
\n","schema":{"type":"integer","format":"int32","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return.
\n","schema":{"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"example":"[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":false},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:e2a16dd9-2ffb-4a4b-a9bd-bd1145a020ee\",\"key\":\"\",\"accountId\":\"99:e2a16dd9-2ffb-4a4b-a9bd-bd1145a020ee\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=andrew\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=andrew\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=andrew\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=andrew\"},\"displayName\":\"Andrew Anderson\",\"active\":false}]"}}},"400":{"description":"Returned if the request is invalid.
\n"},"403":{"description":"Returned if the user doesn't have the required permission.
\n"},"409":{"description":"Returned if the request takes longer than 10 seconds or is interrupted.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-user"]}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/version":{"post":{"tags":["Version"],"summary":"Create version","description":"Creates a project version.
\nThis operation can be accessed anonymously.
\nPermissions required: Administer Jira global permission or Administer Projects project permission for the project the version is added to.
\n","operationId":"createVersion","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"},"example":{"archived":false,"releaseDate":"2010-07-06T00:00:00.000Z","name":"New Version 1","description":"An excellent version","projectId":10000,"released":true}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"},"example":"{\"self\":\"http://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\",\"userReleaseDate\":\"6/Jul/2010\",\"project\":\"PXA\",\"projectId\":10000}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nthe project is not found.
\nthe user does not have the required permissions.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/version/{id}":{"get":{"tags":["Version"],"summary":"Get version","description":"Returns a project version.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse projects project permission for the project containing the version.
\n","operationId":"getVersion","parameters":[{"name":"id","in":"path","description":"The ID of the version.
\n","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Use expand to include additional information about version in the response. This parameter accepts multiple values separated by a comma:
\n\noperations Returns the list of operations available for this version.
\nissuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property represents the number of issues with a status other than to do, in progress, and done.
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"},"example":"{\"self\":\"http://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}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if the version is not found or the user does not have the required permissions.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Version"],"summary":"Update version","description":"Updates a project version.
\nThis operation can be accessed anonymously.
\nPermissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.
\n","operationId":"updateVersion","parameters":[{"name":"id","in":"path","description":"The ID of the version.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"},"example":{"archived":false,"overdue":true,"releaseDate":"2010-07-06T00:00:00.000Z","name":"New Version 1","self":"http://your-domain.atlassian.net/rest/api/~ver~/version/10000","description":"An excellent version","userReleaseDate":"6/Jul/2010","id":"10000","projectId":10000,"released":true}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"},"example":"{\"self\":\"http://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\",\"userReleaseDate\":\"6/Jul/2010\",\"project\":\"PXA\",\"projectId\":10000}"}}},"400":{"description":"Returned if:
\n\nthe request is invalid.
\nthe user does not have the required permissions.
\n
\n"},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"},"404":{"description":"Returned if the version is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"},"delete":{"tags":["Version"],"summary":"Delete version","description":"Deletes a project version.
\nDeprecated, use  Delete and replace version that supports swapping version values in custom fields, in addition to the swapping for fixVersion and affectedVersion provided in this resource.
\nAlternative versions can be provided to update issues that use the deleted version in fixVersion or affectedVersion. If alternatives are not provided, occurrences of fixVersion and affectedVersion that contain the deleted version are cleared.
\nThis operation can be accessed anonymously.
\nPermissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.
\n","operationId":"deleteVersion","parameters":[{"name":"id","in":"path","description":"The ID of the version.
\n","required":true,"schema":{"type":"string"}},{"name":"moveFixIssuesTo","in":"query","description":"The ID of the version to update fixVersion to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted.
\n","schema":{"type":"string"}},{"name":"moveAffectedIssuesTo","in":"query","description":"The ID of the version to update affectedVersion to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted.
\n","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the version is deleted.
\n"},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if:
\n\nthe authentication credentials are incorrect.
\nthe user does not have the required permissions.
\n
\n"},"404":{"description":"Returned if the version is not found.
\n"}},"deprecated":true,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/version/{id}/mergeto/{moveIssuesTo}":{"put":{"tags":["Version"],"summary":"Merge versions","description":"Merges two project versions. The merge is completed by deleting the version specified in id and replacing any occurrences of its ID in fixVersion with the version ID specified in moveIssuesTo.
\nConsider using  Delete and replace version instead. This resource supports swapping version values in fixVersion, affectedVersion, and custom fields.
\nThis operation can be accessed anonymously.
\nPermissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.
\n","operationId":"mergeVersions","parameters":[{"name":"id","in":"path","description":"The ID of the version to delete.
\n","required":true,"schema":{"type":"string"}},{"name":"moveIssuesTo","in":"path","description":"The ID of the version to merge into.
\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the version is deleted.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if:
\n\nthe authentication credentials are incorrect or missing.
\nthe user does not have the required permissions.
\n
\n"},"404":{"description":"Returned if the version to be deleted or the version to merge to are not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/version/{id}/move":{"post":{"tags":["Version"],"summary":"Move version","description":"Modifies the version's sequence within the project, which affects the display order of the versions in Jira.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse projects project permission for the project that contains the version.
\n","operationId":"moveVersion","parameters":[{"name":"id","in":"path","description":"The ID of the version to be moved.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionMoveBean"},"example":{"after":"http://your-domain.atlassian.net/rest/api/~ver~/version/10000"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"},"example":"{\"self\":\"http://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}"}}},"400":{"description":"Returned if:
\n\nno body parameters are provided.
\nafter and position are provided.
\nposition is invalid.
\n
\n"},"401":{"description":"Returned if:
\n\nthe authentication credentials are incorrect or missing
\nthe user does not have the required commissions.
\n
\n"},"404":{"description":"Returned if the version or move after version are not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/version/{id}/relatedIssueCounts":{"get":{"tags":["Version"],"summary":"Get version's related issues count","description":"Returns the following counts for a version:
\n\nNumber of issues where the fixVersion is set to the version.
\nNumber of issues where the affectedVersion is set to the version.
\nNumber of issues where a version custom field is set to the version.
\n
\nThis operation can be accessed anonymously.
\nPermissions required: Browse projects project permission for the project that contains the version.
\n","operationId":"getVersionRelatedIssues","parameters":[{"name":"id","in":"path","description":"The ID of the version.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionIssueCounts"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/version/10000\",\"issuesFixedCount\":23,\"issuesAffectedCount\":101,\"issueCountWithCustomFieldsShowingVersion\":54,\"customFieldUsage\":[{\"fieldName\":\"Field1\",\"customFieldId\":10000,\"issueCountWithVersionInCustomField\":2},{\"fieldName\":\"Field2\",\"customFieldId\":10010,\"issueCountWithVersionInCustomField\":3}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect.
\n"},"404":{"description":"Returned if:
\n\nthe version is not found.
\nthe user does not have the required permissions.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/version/{id}/removeAndSwap":{"post":{"tags":["Version"],"summary":"Delete and replace version","description":"Deletes a project version.
\nAlternative versions can be provided to update issues that use the deleted version in fixVersion, affectedVersion, or any version picker custom fields. If alternatives are not provided, occurrences of fixVersion, affectedVersion, and any version picker custom field, that contain the deleted version, are cleared. Any replacement version must be in the same project as the version being deleted and cannot be the version being deleted.
\nThis operation can be accessed anonymously.
\nPermissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.
\n","operationId":"deleteAndReplaceVersion","parameters":[{"name":"id","in":"path","description":"The ID of the version.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAndReplaceVersionBean"}}},"required":true},"responses":{"204":{"description":"Returned if the version is deleted.
\n","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nthe version to delete is not found.
\nthe user does not have the required permissions.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-atlassian-connect-scope":"PROJECT_ADMIN"}},"/rest/api/3/version/{id}/unresolvedIssueCount":{"get":{"tags":["Version"],"summary":"Get version's unresolved issues count","description":"Returns counts of the issues and unresolved issues for the project version.
\nThis operation can be accessed anonymously.
\nPermissions required: Browse projects project permission for the project that contains the version.
\n","operationId":"getVersionUnresolvedIssues","parameters":[{"name":"id","in":"path","description":"The ID of the version.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionUnresolvedIssuesCount"},"example":"{\"self\":\"http://your-domain.atlassian.net/rest/api/3/version/10000\",\"issuesUnresolvedCount\":23,\"issuesCount\":30}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"404":{"description":"Returned if:
\n\nthe version is not found.
\nthe user does not have the required permissions.
\n
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/webhook":{"get":{"tags":["DynamicWebhook"],"summary":"Get dynamic webhooks for app","description":"Returns the webhooks registered by the calling app.
\nPermissions required: Only Connect apps can use this operation.
\n","operationId":"getDynamicWebhooksForApp","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.
\n","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanWebhook"},"example":"{\"maxResults\":2,\"startAt\":0,\"total\":100,\"isLast\":false,\"values\":[{\"id\":10000,\"jqlFilter\":\"project = PRJ\",\"events\":[\"jira:issue_updated\",\"jira:issue_created\"],\"expirationDate\":\"2019-06-01T12:42:30.000+0000\"},{\"id\":10001,\"jqlFilter\":\"issuetype = Bug\",\"events\":[\"jira:issue_created\"],\"expirationDate\":\"2019-06-01T12:42:30.000+0000\"}]}"}}},"400":{"description":"Returned if the request is invalid.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the caller is not a Connect app.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["DynamicWebhook"],"summary":"Register dynamic webhooks","description":"Registers webhooks.
\nPermissions required: Only Connect apps can use this operation.
\n","operationId":"registerDynamicWebhooks","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRegistrationDetails"},"example":{"webhooks":[{"jqlFilter":"project = PROJ","events":["jira:issue_created","jira:issue_updated"]},{"jqlFilter":"project IN (PROJ, EXP) AND status = done","events":["jira:issue_deleted"]}],"url":"https://your-app.example.com/webhook-received"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContainerForRegisteredWebhooks"},"example":"{\"webhookRegistrationResult\":[{\"createdWebhookId\":1000},{\"errors\":[\"The clause watchCount is unsupported\"]},{\"createdWebhookId\":1001}]}"}}},"400":{"description":"Returned if the request is invalid.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the caller is not a Connect app.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"},"delete":{"tags":["DynamicWebhook"],"summary":"Delete webhooks by ID","description":"Removes webhooks by ID. Only webhooks registered by the calling Connect app are removed. If webhooks created by other apps are specified, they are ignored.
\nPermissions required: Only Connect apps can use this operation.
\n","operationId":"deleteWebhookById","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContainerForWebhookIDs"},"example":{"webhookIds":[10000,10001,10042]}}},"required":true},"responses":{"202":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the list of webhook IDs is missing.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the caller is not a Connect app.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/webhook/refresh":{"put":{"tags":["DynamicWebhook"],"summary":"Extend webhook life","description":"Webhooks registered through the REST API expire after 30 days. Call this resource periodically to keep them alive.
\nUnrecognized webhook IDs (nonexistent or belonging to other apps) are ignored. Permissions required: Only Connect apps can use this operation.
\n","operationId":"refreshWebhooks","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContainerForWebhookIDs"},"example":{"webhookIds":[10000,10001,10042]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhooksExpirationDate"},"example":"{\"expirationDate\":\"2019-06-01T12:42:30.000+0000\"}"}}},"400":{"description":"Returned if the request is invalid.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the caller is not a Connect app.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/workflow":{"get":{"tags":["Workflows"],"summary":"Get all workflows","description":"Returns all workflows in Jira or a workflow. Deprecated, use Get workflows paginated.
\nIf the workflowName parameter is specified, the workflow is returned as an object (not in an array). Otherwise, an array of workflow objects is returned.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getAllWorkflows","parameters":[{"name":"workflowName","in":"query","description":"The name of the workflow to be returned. Only one workflow can be specified.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeprecatedWorkflow"}},"example":"[{\"name\":\"classic workflow\",\"description\":\"A classic Jira workflow\",\"lastModifiedDate\":\"01-01-2011\",\"lastModifiedUser\":\"admin\",\"lastModifiedUserAccountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"steps\":5,\"default\":true}]"}}},"401":{"description":"Returned if the user does not have the required permissions.
\n"}},"deprecated":true,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/workflow/rule/config":{"get":{"tags":["WorkflowRuleConfig"],"summary":"Get workflow transition rule configurations","description":"Returns a paginated list of workflows with transition rules. The workflows can be filtered to return only those containing workflow transition rules:
\n\nof one or more transition rule types, such as workflow post functions.
\nmatching one or more transition rule keys.
\n
\nOnly workflows containing transition rules created by the calling Connect app are returned. However, if a workflow is returned all transition rules that match the filters are returned for that workflow.
\nDue to server-side optimizations, workflows with an empty list of rules may be returned; these workflows can be ignored.
\nPermissions required: Only Connect apps can use this operation.
\n","operationId":"getWorkflowTransitionRuleConfigurations","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.
\n","schema":{"type":"integer","format":"int32","default":10}},{"name":"types","in":"query","description":"The types of the transition rules to return.
\n","schema":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["postfunction","condition","validator"]}}},{"name":"keys","in":"query","description":"The transition rule class keys, as defined in the Connect app descriptor, of the transition rules to return.
\n","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 multiple values separated by a comma:
\n\ntransition For each rule, returns information about the transition the rule is assigned to.
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanWorkflowTransitionRules"},"example":"{\"maxResults\":10,\"startAt\":0,\"total\":1,\"isLast\":true,\"values\":[{\"workflowId\":{\"name\":\"My Workflow name\",\"draft\":false},\"postFunctions\":[{\"id\":\"b4d6cbdc-59f5-11e9-8647-d663bd873d93\",\"key\":\"postfunction-key\",\"configuration\":{\"value\":\"{ \\\"color\\\": \\\"red\\\" }\"},\"transition\":{\"id\":1,\"name\":\"Open\"}}],\"conditions\":[{\"id\":\"d663bd873d93-59f5-11e9-8647-b4d6cbdc\",\"key\":\"condition-key\",\"configuration\":{\"value\":\"{ \\\"size\\\": \\\"medium\\\" }\"},\"transition\":{\"id\":1,\"name\":\"Open\"}}],\"validators\":[{\"id\":\"11e9-59f5-b4d6cbdc-8647-d663bd873d93\",\"key\":\"validator-key\",\"configuration\":{\"value\":\"\\\"{ \\\\\\\"shape\\\\\\\": \\\\\\\"square\\\\\\\" }\\\"\"},\"transition\":{\"id\":1,\"name\":\"Open\"}}]}]}"}}},"400":{"description":"Returned if the request is invalid.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the caller is not a Connect app.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"404":{"description":"Returned if the any transition rule type is not supported.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"READ"},"put":{"tags":["WorkflowRuleConfig"],"summary":"Update workflow transition rule configurations","description":"Updates configuration of workflow transition rules. The following rule types are supported:
\n\npost functions
\nconditions
\nvalidators
\n
\nOnly rules created by the calling Connect app can be updated.
\nPermissions required: Only Connect apps can use this operation.
\n","operationId":"updateWorkflowTransitionRuleConfigurations","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTransitionRulesUpdate"},"example":{"workflows":[{"postFunctions":[{"configuration":{"value":"{ \"color\": \"red\" }"},"id":"b4d6cbdc-59f5-11e9-8647-d663bd873d93"}],"validators":[{"configuration":{"value":"{ \"shape\": \"square\" }"},"id":"11e9-59f5-b4d6cbdc-8647-d663bd873d93"}],"conditions":[{"configuration":{"value":"{ \"size\": \"medium\" }"},"id":"d663bd873d93-59f5-11e9-8647-b4d6cbdc"}],"workflowId":{"draft":false,"name":"My Workflow name"}}]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTransitionRulesUpdateErrors"},"example":"{\"updateResults\":[{\"workflowId\":{\"name\":\"Workflow with one rule not updated\",\"draft\":false},\"ruleUpdateErrors\":{\"example-rule-id\":[\"The rule with this id does not exist: example-rule-id\"]},\"updateErrors\":[]},{\"workflowId\":{\"name\":\"Workflow with all rules successfully updated\",\"draft\":true},\"ruleUpdateErrors\":{},\"updateErrors\":[]},{\"workflowId\":{\"name\":\"Non-existing workflow\",\"draft\":false},\"ruleUpdateErrors\":{},\"updateErrors\":[\"Workflow not found: WorkflowIdBean{name=Non-existing workflow, draft=false}\"]}]}"}}},"400":{"description":"Returned if the request is invalid.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}},"403":{"description":"Returned if the caller is not a Connect app.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"}}}}},"deprecated":false,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/workflow/search":{"get":{"tags":["WorkflowSearch"],"summary":"Get workflows paginated","description":"Returns a paginated list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned.
\nThis operation does not return next-gen workflows.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getWorkflowsPaginated","parameters":[{"name":"startAt","in":"query","description":"The index of the first item to return in a page of results (page offset).
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"maxResults","in":"query","description":"The maximum number of items to return per page.
\n","schema":{"type":"integer","format":"int32","default":50}},{"name":"workflowName","in":"query","description":"The name of a workflow to return.
\n","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 multiple values separated by a comma:
\n\ntransitions For each workflow, returns information about the transitions inside the workflow.
\ntransitions.rules For each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested.
\nstatuses For each workflow, returns information about the statuses inside the workflow.
\nstatuses.properties For each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested.
\n
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageBeanWorkflow"},"example":"{\"maxResults\":1,\"startAt\":0,\"total\":5,\"isLast\":false,\"values\":[{\"id\":{\"name\":\"SCRUM Workflow\"},\"description\":\"A workflow used for Software projects in the SCRUM methodology\",\"transitions\":[{\"id\":\"5\",\"name\":\"In Progress\",\"description\":\"Start working on the issue.\",\"from\":[\"10\",\"13\"],\"to\":\"14\",\"type\":\"directed\",\"screen\":{\"id\":\"10000\"},\"rules\":{\"conditions\":[{\"type\":\"PermissionCondition\",\"configuration\":{\"permissionKey\":\"WORK_ON_ISSUES\"}}],\"validators\":[{\"type\":\"FieldRequiredValidator\",\"configuration\":{\"ignoreContext\":true,\"errorMessage\":\"A custom error message\",\"fields\":[\"description\",\"assignee\"]}}],\"postFunctions\":[{\"type\":\"UpdateIssueStatusFunction\"},{\"type\":\"GenerateChangeHistoryFunction\"},{\"type\":\"FireIssueEventFunction\"}]}}],\"statuses\":[{\"id\":\"3\",\"name\":\"In Progress\",\"properties\":{\"issueEditable\":false}}]}]}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the necessary permission.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorCollection"},"example":"{\"errorMessages\":[\"Only Jira administrators can access workflows.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"OAuth2":["manage:jira-project"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/workflow/transitions/{transitionId}/properties":{"get":{"tags":["WorkflowTransition"],"summary":"Get workflow transition properties","description":"Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getWorkflowTransitionProperties","parameters":[{"name":"transitionId","in":"path","description":"The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"includeReservedKeys","in":"query","description":"Some properties with keys that have the jira. prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to true.
\n","schema":{"type":"boolean","default":false}},{"name":"key","in":"query","description":"The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned.
\n","schema":{"type":"string"}},{"name":"workflowName","in":"query","description":"The name of the workflow that the transition belongs to.
\n","schema":{"type":"string"}},{"name":"workflowMode","in":"query","description":"The workflow status. Set to live for active and inactive workflows, or draft for draft workflows.
\n","schema":{"type":"string","enum":["live","draft"],"default":"live"}}],"responses":{"200":{"description":"200 response
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTransitionProperty"},"example":"[{\"key\":\"jira.i18n.title\",\"value\":\"some.title\",\"id\":\"jira.i18n.title\"},{\"key\":\"jira.permission\",\"value\":\"createissue\",\"id\":\"jira.permission\"}]"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have admin permission
\n"},"404":{"description":"Returned if the workflow transition or property is not found.
\n"}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-atlassian-connect-scope":"ADMIN"},"put":{"tags":["WorkflowTransition"],"summary":"Update workflow transition property","description":"Updates a workflow transition by changing the property value. Trying to update a property that does not exist results in a new property being added to the transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.
\nPermissions required: Administer Jira global permission.
\n","operationId":"updateWorkflowTransitionProperty","parameters":[{"name":"transitionId","in":"path","description":"The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"key","in":"query","description":"The key of the property being updated, also known as the name of the property. Set this to the same value as the key defined in the request body.
\n","schema":{"type":"string"}},{"name":"workflowName","in":"query","description":"The name of the workflow that the transition belongs to.
\n","schema":{"type":"string"}},{"name":"workflowMode","in":"query","description":"The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.
\n","schema":{"type":"string","enum":["live","draft"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTransitionProperty"},"example":{"value":"createissue"}}},"required":true},"responses":{"200":{"description":"200 response
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTransitionProperty"},"example":"{\"key\":\"jira.i18n.title\",\"value\":\"some.title\",\"id\":\"jira.i18n.title\"}"}}},"304":{"description":"Returned if no changes were made by the request. For example, attempting to update a property with its current value.
\n"},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the workflow transition is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"post":{"tags":["WorkflowTransition"],"summary":"Create workflow transition property","description":"Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.
\nPermissions required: Administer Jira global permission.
\n","operationId":"createWorkflowTransitionProperty","parameters":[{"name":"transitionId","in":"path","description":"The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"key","in":"query","description":"The key of the property being added, also known as the name of the property. Set this to the same value as the key defined in the request body.
\n","schema":{"type":"string"}},{"name":"workflowName","in":"query","description":"The name of the workflow that the transition belongs to.
\n","schema":{"type":"string"}},{"name":"workflowMode","in":"query","description":"The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.
\n","schema":{"type":"string","enum":["live","draft"],"default":"live"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTransitionProperty"},"example":{"value":"createissue"}}},"required":true},"responses":{"200":{"description":"200 response
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTransitionProperty"},"example":"{\"key\":\"jira.i18n.title\",\"value\":\"some.title\",\"id\":\"jira.i18n.title\"}"}}},"400":{"description":"Returned if a workflow property with the same key is present on the transition.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the workflow transition is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["WorkflowTransition"],"summary":"Delete workflow transition property","description":"Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.
\nPermissions required: Administer Jira global permission.
\n","operationId":"deleteWorkflowTransitionProperty","parameters":[{"name":"transitionId","in":"path","description":"The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"key","in":"query","description":"The name of the transition property to delete, also known as the name of the property.
\n","schema":{"type":"string"}},{"name":"workflowName","in":"query","description":"The name of the workflow that the transition belongs to.
\n","schema":{"type":"string"}},{"name":"workflowMode","in":"query","description":"The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.
\n","schema":{"type":"string","enum":["live","draft"]}}],"responses":{"200":{"description":"200 response
\n"},"304":{"description":"Returned if no changes were made by the request. For example, trying to delete a property that cannot be found.
\n"},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the required permissions.
\n"},"404":{"description":"Returned if the workflow transition is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/workflowscheme":{"post":{"tags":["WorkflowScheme"],"summary":"Create workflow scheme","description":"Creates a workflow scheme.
\nPermissions required: Administer Jira global permission.
\n","operationId":"createWorkflowScheme","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":{"defaultWorkflow":"jira","name":"Example workflow scheme","description":"The description of the example workflow scheme.","issueTypeMappings":{"10000":"scrum workflow","10001":"builds workflow"}}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":"{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to create workflow schemes.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/workflowscheme/project":{"get":{"tags":["WorkflowSchemeProject"],"summary":"Get workflow scheme project associations","description":"Returns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a list of the requested projects associated with it. Any next-gen or non-existent projects in the request are ignored and no errors are returned.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getWorkflowSchemeProjectAssociations","parameters":[{"name":"projectId","in":"query","description":"The ID of a project to return the workflow schemes for. To include multiple projects, provide multiple copies of this parameter. For example, projectId=10000&projectId=10001.
\n","schema":{"maxItems":100,"minItems":1,"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64","example":10010}}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContainerOfWorkflowSchemeAssociations"},"example":"{\"values\":[{\"projectIds\":[\"10010\",\"10020\"],\"workflowScheme\":{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}}]}"}}},"400":{"description":"Returned if the request is invalid.
\n","content":{"application/json":{"example":"{\"errorMessages\":[],\"errors\":{\"projectId\":\"The projectId query param is required.\"}}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user does not have the necessary permission.
\n","content":{"application/json":{"example":"{\"errorMessages\":[\"Only Jira administrators can access workflow scheme associations.\"],\"errors\":{}}"}}}},"deprecated":false,"security":[{"OAuth2":["manage:jira-configuration"]}],"x-experimental":true,"x-atlassian-connect-scope":"ADMIN"}},"/rest/api/3/workflowscheme/{id}":{"get":{"tags":["WorkflowScheme"],"summary":"Get workflow scheme","description":"Returns a workflow scheme.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getWorkflowScheme","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, schemeId=10301.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"returnDraftIfExists","in":"query","description":"Returns the workflow scheme's draft rather than scheme itself, if set to true. If the workflow scheme does not have a draft, then the workflow scheme is returned.
\n","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":"{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to access workflows.
\n"},"404":{"description":"Returned if the workflow scheme is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"put":{"tags":["WorkflowScheme"],"summary":"Update workflow scheme","description":"Updates a workflow scheme, including the name, default workflow, issue type to project mappings, and more. If the workflow scheme is active (that is, being used by at least one project), then a draft workflow scheme is created or updated instead, provided that updateDraftIfNeeded is set to true.
\nPermissions required: Administer Jira global permission.
\n","operationId":"updateWorkflowScheme","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, schemeId=10301.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":{"defaultWorkflow":"jira","updateDraftIfNeeded":false,"name":"Example workflow scheme","description":"The description of the example workflow scheme.","issueTypeMappings":{"10000":"scrum workflow"}}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":"{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to modify workflow schemes.
\n"},"404":{"description":"Returned if the workflow scheme is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["WorkflowScheme"],"summary":"Delete workflow scheme","description":"Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at least one project).
\nPermissions required: Administer Jira global permission.
\n","operationId":"deleteWorkflowScheme","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, schemeId=10301.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the scheme is active.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to delete workflow schemes.
\n"},"404":{"description":"Returned if the workflow scheme is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/workflowscheme/{id}/createdraft":{"post":{"tags":["WorkflowScheme"],"summary":"Create draft workflow scheme","description":"Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an active workflow scheme can only have one draft workflow scheme.
\nPermissions required: Administer Jira global permission.
\n","operationId":"createWorkflowSchemeDraftFromParent","parameters":[{"name":"id","in":"path","description":"The ID of the active workflow scheme that the draft is created from.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"201":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":"{\"id\":17218781,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"scrum workflow\",\"issueTypeMappings\":{\"10000\":\"jira\",\"10001\":\"jira\"},\"originalDefaultWorkflow\":\"jira\",\"originalIssueTypeMappings\":{\"10001\":\"builds workflow\"},\"draft\":true,\"lastModifiedUser\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}},\"lastModified\":\"Today 6:38 PM\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft\"}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to create workflow schemes.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/workflowscheme/{id}/default":{"get":{"tags":["WorkflowScheme"],"summary":"Get default workflow","description":"Returns the default workflow for a workflow scheme. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getDefaultWorkflow","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"returnDraftIfExists","in":"query","description":"Set to true to return the default workflow for the workflow scheme's draft rather than scheme itself. If the workflow scheme does not have a draft, then the default workflow for the workflow scheme is returned.
\n","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultWorkflow"},"example":"{\"workflow\":\"jira\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to access workflows.
\n"},"404":{"description":"Returned if the workflow scheme is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"put":{"tags":["WorkflowScheme"],"summary":"Update default workflow","description":"Sets the default workflow for a workflow scheme.
\nNote that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request object and a draft workflow scheme is created or updated with the new default workflow. The draft workflow scheme can be published in Jira.
\nPermissions required: Administer Jira global permission.
\n","operationId":"updateDefaultWorkflow","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The new default workflow.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultWorkflow"},"example":{"workflow":"jira","updateDraftIfNeeded":false}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":"{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}"}}},"400":{"description":"Returned if the workflow scheme cannot be edited and updateDraftIfNeeded is not true.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to create workflows.
\n"},"404":{"description":"Returned if the workflow scheme is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["WorkflowScheme"],"summary":"Delete default workflow","description":"Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow (the jira workflow).
\nNote that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be published in Jira.
\nPermissions required: Administer Jira global permission.
\n","operationId":"deleteDefaultWorkflow","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"updateDraftIfNeeded","in":"query","description":"Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to false.
\n","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":"{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}"}}},"400":{"description":"Returned if the workflow scheme cannot be edited and updateDraftIfNeeded is not true.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to modify workflows.
\n"},"404":{"description":"Returned if the workflow scheme is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/workflowscheme/{id}/draft":{"get":{"tags":["WorkflowScheme"],"summary":"Get draft workflow scheme","description":"Returns the draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to the active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is modified, then the changes in the draft are copied back to the active workflow scheme. See Configuring workflow schemes for more information.
\nNote that:
\n\nOnly active workflow schemes can have draft workflow schemes.
\nAn active workflow scheme can only have one draft workflow scheme.
\n
\nPermissions required: Administer Jira global permission.
\n","operationId":"getWorkflowSchemeDraft","parameters":[{"name":"id","in":"path","description":"The ID of the active workflow scheme that the draft was created from.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":"{\"id\":17218781,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"scrum workflow\",\"issueTypeMappings\":{\"10000\":\"jira\",\"10001\":\"jira\"},\"originalDefaultWorkflow\":\"jira\",\"originalIssueTypeMappings\":{\"10001\":\"builds workflow\"},\"draft\":true,\"lastModifiedUser\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}},\"lastModified\":\"Today 6:38 PM\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to create workflow schemes.
\n"},"404":{"description":"Returned if:
\n\nthe original active workflow scheme is not found.
\nthe original active workflow scheme does not have a draft.
\n
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"put":{"tags":["WorkflowScheme"],"summary":"Update draft workflow scheme","description":"Updates a draft workflow scheme. If a draft workflow scheme does not exist for the active workflow scheme, then a draft is created. Note that an active workflow scheme can only have one draft workflow scheme.
\nPermissions required: Administer Jira global permission.
\n","operationId":"updateWorkflowSchemeDraft","parameters":[{"name":"id","in":"path","description":"The ID of the active workflow scheme that the draft was created from.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":{"defaultWorkflow":"jira","updateDraftIfNeeded":false,"name":"Example workflow scheme","description":"The description of the example workflow scheme.","issueTypeMappings":{"10000":"scrum workflow"}}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":"{\"id\":17218781,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"scrum workflow\",\"issueTypeMappings\":{\"10000\":\"jira\",\"10001\":\"jira\"},\"originalDefaultWorkflow\":\"jira\",\"originalIssueTypeMappings\":{\"10001\":\"builds workflow\"},\"draft\":true,\"lastModifiedUser\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}},\"lastModified\":\"Today 6:38 PM\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft\"}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to create workflow schemes.
\n"},"404":{"description":"Returned if:
\n\nthe original active workflow scheme is not found.
\nthe original active workflow scheme does not have a draft.
\n
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["WorkflowScheme"],"summary":"Delete draft workflow scheme","description":"Deletes a draft workflow scheme.
\nPermissions required: Administer Jira global permission.
\n","operationId":"deleteWorkflowSchemeDraft","parameters":[{"name":"id","in":"path","description":"The ID of the active workflow scheme that the draft was created from.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to manage workflow schemes.
\n"},"404":{"description":"Returned if:
\n\nthe original active workflow scheme is not found.
\nthe original active workflow scheme does not have a draft.
\n
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/workflowscheme/{id}/draft/default":{"get":{"tags":["WorkflowScheme"],"summary":"Get draft default workflow","description":"Returns the default workflow for a workflow scheme's draft. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getDraftDefaultWorkflow","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme that the draft belongs to.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultWorkflow"},"example":"{\"workflow\":\"jira\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to create workflows.
\n"},"404":{"description":"Returned if any of the following is true:
\n\nThe workflow scheme is not found.
\nThe workflow scheme does not have a draft.
\n
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"put":{"tags":["WorkflowScheme"],"summary":"Update draft default workflow","description":"Sets the default workflow for a workflow scheme's draft.
\nPermissions required: Administer Jira global permission.
\n","operationId":"updateDraftDefaultWorkflow","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme that the draft belongs to.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The object for the new default workflow.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultWorkflow"},"example":{"workflow":"jira","updateDraftIfNeeded":false}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":"{\"id\":17218781,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"scrum workflow\",\"issueTypeMappings\":{\"10000\":\"jira\",\"10001\":\"jira\"},\"originalDefaultWorkflow\":\"jira\",\"originalIssueTypeMappings\":{\"10001\":\"builds workflow\"},\"draft\":true,\"lastModifiedUser\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}},\"lastModified\":\"Today 6:38 PM\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft\"}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to modify workflows.
\n"},"404":{"description":"Returned if any of the following is true:
\n\nThe workflow scheme is not found.
\nThe workflow scheme does not have a draft.
\n
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["WorkflowScheme"],"summary":"Delete draft default workflow","description":"Resets the default workflow for a workflow scheme's draft. That is, the default workflow is set to Jira's system workflow (the jira workflow).
\nPermissions required: Administer Jira global permission.
\n","operationId":"deleteDraftDefaultWorkflow","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme that the draft belongs to.
\n","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":"{\"id\":17218781,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"scrum workflow\",\"issueTypeMappings\":{\"10000\":\"jira\",\"10001\":\"jira\"},\"originalDefaultWorkflow\":\"jira\",\"originalIssueTypeMappings\":{\"10001\":\"builds workflow\"},\"draft\":true,\"lastModifiedUser\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}},\"lastModified\":\"Today 6:38 PM\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to create workflows.
\n"},"404":{"description":"Returned if any of the following is true:
\n\nThe workflow scheme is not found.
\nThe workflow scheme does not have a draft.
\n
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}":{"get":{"tags":["WorkflowScheme"],"summary":"Get workflow for issue type in draft workflow scheme","description":"Returns the issue type-workflow mapping for an issue type in a workflow scheme's draft.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getWorkflowSchemeDraftIssueType","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme that the draft belongs to.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"issueType","in":"path","description":"The ID of the issue type.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeWorkflowMapping"},"example":"{\"issueType\":\"10000\",\"workflow\":\"jira\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to create workflow schemes.
\n"},"404":{"description":"Returned if the workflow scheme or issue type is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"put":{"tags":["WorkflowScheme"],"summary":"Set workflow for issue type in draft workflow scheme","description":"Sets the workflow for an issue type in a workflow scheme's draft.
\nPermissions required: Administer Jira global permission.
\n","operationId":"setWorkflowSchemeDraftIssueType","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme that the draft belongs to.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"issueType","in":"path","description":"The ID of the issue type.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The issue type-project mapping.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeWorkflowMapping"},"example":{"issueType":"10000","workflow":"jira","updateDraftIfNeeded":false}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":"{\"id\":17218781,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"scrum workflow\",\"issueTypeMappings\":{\"10000\":\"jira\",\"10001\":\"jira\"},\"originalDefaultWorkflow\":\"jira\",\"originalIssueTypeMappings\":{\"10001\":\"builds workflow\"},\"draft\":true,\"lastModifiedUser\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}},\"lastModified\":\"Today 6:38 PM\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft\"}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to modify workflows.
\n"},"404":{"description":"Returned if the workflow scheme or issue type is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["WorkflowScheme"],"summary":"Delete workflow for issue type in draft workflow scheme","description":"Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft.
\nPermissions required: Administer Jira global permission.
\n","operationId":"deleteWorkflowSchemeDraftIssueType","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme that the draft belongs to.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"issueType","in":"path","description":"The ID of the issue type.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":"{\"id\":17218781,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"scrum workflow\",\"issueTypeMappings\":{\"10000\":\"jira\",\"10001\":\"jira\"},\"originalDefaultWorkflow\":\"jira\",\"originalIssueTypeMappings\":{\"10001\":\"builds workflow\"},\"draft\":true,\"lastModifiedUser\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"key\":\"\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/useravatar?size=large&ownerId=mia\",\"24x24\":\"http://your-domain.atlassian.net/secure/useravatar?size=small&ownerId=mia\",\"16x16\":\"http://your-domain.atlassian.net/secure/useravatar?size=xsmall&ownerId=mia\",\"32x32\":\"http://your-domain.atlassian.net/secure/useravatar?size=medium&ownerId=mia\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}},\"lastModified\":\"Today 6:38 PM\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to modify workflows.
\n"},"404":{"description":"Returned if the workflow scheme or issue type is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/workflowscheme/{id}/draft/workflow":{"get":{"tags":["WorkflowScheme"],"summary":"Get issue types for workflows in draft workflow scheme","description":"Returns the workflow-issue type mappings for a workflow scheme's draft.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getDraftWorkflow","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme that the draft belongs to.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workflowName","in":"query","description":"The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypesWorkflowMapping"},"example":"{\"workflow\":\"jira\",\"issueTypes\":[\"10000\",\"10001\"],\"defaultMapping\":false}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to create workflows.
\n"},"404":{"description":"Returned if either the workflow scheme or workflow (if specified) is not found. session.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"put":{"tags":["WorkflowScheme"],"summary":"Set issue types for workflow in workflow scheme","description":"Sets the issue types for a workflow in a workflow scheme's draft. The workflow can also be set as the default workflow for the draft workflow scheme. Unmapped issues types are mapped to the default workflow.
\nPermissions required: Administer Jira global permission.
\n","operationId":"updateDraftWorkflowMapping","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme that the draft belongs to.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workflowName","in":"query","description":"The name of the workflow.
\n","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypesWorkflowMapping"},"example":{"workflow":"jira","updateDraftIfNeeded":true,"issueTypes":["10000"]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":"{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to modify workflows.
\n"},"404":{"description":"Returned if any of the following is true:
\n\nThe workflow scheme is not found.
\nThe workflow scheme does not have a draft.
\nThe workflow is not found.
\nThe workflow is not specified.
\n
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["WorkflowScheme"],"summary":"Delete issue types for workflow in draft workflow scheme","description":"Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft.
\nPermissions required: Administer Jira global permission.
\n","operationId":"deleteDraftWorkflowMapping","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme that the draft belongs to.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workflowName","in":"query","description":"The name of the workflow.
\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to modify workflows.
\n"},"404":{"description":"Returned if any of the following is true:
\n\nThe workflow scheme is not found.
\nThe workflow scheme does not have a draft.
\nThe workflow is not found.
\nThe workflow is not specified.
\n
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/workflowscheme/{id}/issuetype/{issueType}":{"get":{"tags":["WorkflowScheme"],"summary":"Get workflow for issue type in workflow scheme","description":"Returns the issue type-workflow mapping for an issue type in a workflow scheme.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getWorkflowSchemeIssueType","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"issueType","in":"path","description":"The ID of the issue type.
\n","required":true,"schema":{"type":"string"}},{"name":"returnDraftIfExists","in":"query","description":"Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned.
\n","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeWorkflowMapping"},"example":"{\"issueType\":\"10000\",\"workflow\":\"jira\"}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to access workflows.
\n"},"404":{"description":"Returned if the workflow scheme or issue type is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"put":{"tags":["WorkflowScheme"],"summary":"Set workflow for issue type in workflow scheme","description":"Sets the workflow for an issue type in a workflow scheme.
\nNote that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The draft workflow scheme can be published in Jira.
\nPermissions required: Administer Jira global permission.
\n","operationId":"setWorkflowSchemeIssueType","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"issueType","in":"path","description":"The ID of the issue type.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The issue type-project mapping.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypeWorkflowMapping"},"example":{"issueType":"10000","workflow":"jira","updateDraftIfNeeded":false}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":"{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}"}}},"400":{"description":"Returned if the workflow cannot be edited and updateDraftIfNeeded is false.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to modify workflows.
\n"},"404":{"description":"Returned if the workflow scheme or issue type is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["WorkflowScheme"],"summary":"Delete workflow for issue type in workflow scheme","description":"Deletes the issue type-workflow mapping for an issue type in a workflow scheme.
\nNote that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow scheme can be published in Jira.
\nPermissions required: Administer Jira global permission.
\n","operationId":"deleteWorkflowSchemeIssueType","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"issueType","in":"path","description":"The ID of the issue type.
\n","required":true,"schema":{"type":"string"}},{"name":"updateDraftIfNeeded","in":"query","description":"Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to false.
\n","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":"{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}"}}},"400":{"description":"Returned if the workflow cannot be edited and updateDraftIfNeeded is false.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to modify workflows.
\n"},"404":{"description":"Returned if the workflow scheme or issue type is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/workflowscheme/{id}/workflow":{"get":{"tags":["WorkflowScheme"],"summary":"Get issue types for workflows in workflow scheme","description":"Returns the workflow-issue type mappings for a workflow scheme.
\nPermissions required: Administer Jira global permission.
\n","operationId":"getWorkflow","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workflowName","in":"query","description":"The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.
\n","schema":{"type":"string"}},{"name":"returnDraftIfExists","in":"query","description":"Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned.
\n","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypesWorkflowMapping"},"example":"{\"workflow\":\"jira\",\"issueTypes\":[\"10000\",\"10001\"],\"defaultMapping\":false}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to access workflows.
\n"},"404":{"description":"Returned if either the workflow scheme or workflow is not found.
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"put":{"tags":["WorkflowScheme"],"summary":"Set issue types for workflow in workflow scheme","description":"Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow.
\nNote that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new workflow-issue types mappings. The draft workflow scheme can be published in Jira.
\nPermissions required: Administer Jira global permission.
\n","operationId":"updateWorkflowMapping","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workflowName","in":"query","description":"The name of the workflow.
\n","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueTypesWorkflowMapping"},"example":{"workflow":"jira","updateDraftIfNeeded":true,"issueTypes":["10000"]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowScheme"},"example":"{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}"}}},"400":{"description":"Returned if the request is invalid.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to modify workflows.
\n"},"404":{"description":"Returned if any of the following is true:
\n\nThe workflow scheme is not found.
\nThe workflow is not found.
\nThe workflow is not specified.
\n
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["WorkflowScheme"],"summary":"Delete issue types for workflow in workflow scheme","description":"Deletes the workflow-issue type mapping for a workflow in a workflow scheme.
\nNote that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira.
\nPermissions required: Administer Jira global permission.
\n","operationId":"deleteWorkflowMapping","parameters":[{"name":"id","in":"path","description":"The ID of the workflow scheme.
\n","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workflowName","in":"query","description":"The name of the workflow.
\n","schema":{"type":"string"}},{"name":"updateDraftIfNeeded","in":"query","description":"Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to false.
\n","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the workflow cannot be edited and updateDraftIfNeeded is not true.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"},"403":{"description":"Returned if the user is not permitted to modify workflows.
\n"},"404":{"description":"Returned if any of the following is true:
\n\nThe workflow scheme is not found.
\nThe workflow is not found.
\nThe workflow is not specified.
\n
\n"}},"deprecated":false,"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/api/3/worklog/deleted":{"get":{"tags":["Worklog"],"summary":"Get IDs of deleted worklogs","description":"Returns a list of IDs and delete timestamps for worklogs deleted after a date and time.
\nThis resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs.
\nThis resource does not return worklogs deleted during the minute preceding the request.
\nPermissions required: Permission to access Jira.
\n","operationId":"getIdsOfWorklogsDeletedSince","parameters":[{"name":"since","in":"query","description":"The date and time, in UNIX timestamp format, after which deleted worklogs are returned.
\n","schema":{"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangedWorklogs"},"example":"{\"values\":[{\"worklogId\":103,\"updatedTime\":1438013671562,\"properties\":[]},{\"worklogId\":104,\"updatedTime\":1438013672165,\"properties\":[]},{\"worklogId\":105,\"updatedTime\":1438013693136,\"properties\":[]}],\"since\":1438013671562,\"until\":1438013693136,\"self\":\"http://your-domain.atlassian.net/worklog/deleted?since=1438013671562\",\"nextPage\":\"http://your-domain.atlassian.net/worklog/deleted?since=1438013693136\",\"lastPage\":true}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/worklog/list":{"post":{"tags":["Worklog"],"summary":"Get worklogs","description":"Returns worklog details for a list of worklog IDs.
\nThe returned list of worklogs is limited to 1000 items.
\nPermissions required: Permission to access Jira, however, worklogs are only returned where either of the following is true:
\n\nthe worklog is set as Viewable by All Users.
\nthe user is a member of a project role or group with permission to view the worklog.
\n
\n","operationId":"getWorklogsForIds","parameters":[{"name":"expand","in":"query","description":"Use expand to include additional information about worklogs in the response. This parameter accepts properties that returns the properties of each worklog.
\n","schema":{"type":"string","default":""}}],"requestBody":{"description":"A JSON object containing a list of worklog IDs.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorklogIdsRequestBean"},"example":{"ids":[1,2,5,10]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Worklog"}},"example":"[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2019-09-05T04:31:45.519+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2019-09-05T04:31:45.519+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}]"}}},"400":{"description":"Returned if the request contains more than 1000 worklog IDs or is empty.
\n"},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/api/3/worklog/updated":{"get":{"tags":["Worklog"],"summary":"Get IDs of updated worklogs","description":"Returns a list of IDs and update timestamps for worklogs updated after a date and time.
\nThis resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs.
\nThis resource does not return worklogs updated during the minute preceding the request.
\nPermissions required: Permission to access Jira, however, worklogs are only returned where either of the following is true:
\n\nthe worklog is set as Viewable by All Users.
\nthe user is a member of a project role or group with permission to view the worklog.
\n
\n","operationId":"getIdsOfWorklogsModifiedSince","parameters":[{"name":"since","in":"query","description":"The date and time, in UNIX timestamp format, after which updated worklogs are returned.
\n","schema":{"type":"integer","format":"int64","default":0}},{"name":"expand","in":"query","description":"Use expand to include additional information about worklogs in the response. This parameter accepts properties that returns the properties of each worklog.
\n","schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangedWorklogs"},"example":"{\"values\":[{\"worklogId\":103,\"updatedTime\":1438013671562,\"properties\":[]},{\"worklogId\":104,\"updatedTime\":1438013672165,\"properties\":[]},{\"worklogId\":105,\"updatedTime\":1438013693136,\"properties\":[]}],\"since\":1438013671562,\"until\":1438013693136,\"self\":\"http://your-domain.atlassian.net/worklog/updated?since=1438013671562\",\"nextPage\":\"http://your-domain.atlassian.net/worklog/updated?since=1438013693136\",\"lastPage\":true}"}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n"}},"deprecated":false,"security":[{"OAuth2":["read:jira-work"]}],"x-atlassian-connect-scope":"READ"}},"/rest/atlassian-connect/1/addons/{addonKey}/properties":{"get":{"tags":["AddonProperties"],"summary":"Get app properties","description":"Gets all the properties of an app.
\nPermissions required: Only a Connect app whose key matches addonKey can make this request.
\n","operationId":"getAddonProperties","parameters":[{"name":"addonKey","in":"path","description":"The key of the app, as defined in its descriptor.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyKeys"},"example":{"keys":[{"self":"http://your-domain.atlassian.net/jira/rest/atlassian-connect/1/addon/example.app.key/properties/propertyKey","key":"propertyKey"}]}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationMessage"},"example":{"message":"Access to this resource must be authenticated as an app.","statusCode":401}}}}},"deprecated":false,"x-atlassian-connect-scope":"NONE"}},"/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}":{"get":{"tags":["AddonProperties"],"summary":"Get app property","description":"Returns the key and value of an app's property.
\nPermissions required: Only a Connect app whose key matches addonKey can make this request.
\n","operationId":"getAddonProperty","parameters":[{"name":"addonKey","in":"path","description":"The key of the app, as defined in its descriptor.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property.
\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityProperty"},"example":{"self":"http://your-domain.atlassian.net/jira/rest/atlassian-connect/1/addon/example.app.key/properties/propertyKey","key":"propertyKey","value":"propertyValue"}}}},"400":{"description":"Returned if the property key is longer than 127 characters.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationMessage"},"example":{"message":"The property key cannot be longer than 127 characters.","statusCode":400}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationMessage"},"example":{"message":"Access to this resource must be authenticated as an app.","statusCode":401}}}},"404":{"description":"Returned if the property is not found or doesn't belong to the app.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationMessage"},"example":{"message":"Property with key not found.","statusCode":404}}}}},"deprecated":false,"x-atlassian-connect-scope":"NONE"},"put":{"tags":["AddonProperties"],"summary":"Set app property","description":"Sets the value of an app's property. Use this resource to store custom data for your app.
\nThe value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
\nPermissions required: Only a Connect app whose key matches addonKey can make this request.
\n","operationId":"putAddonProperty","parameters":[{"name":"addonKey","in":"path","description":"The key of the app, as defined in its descriptor.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property.
\n","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{}}},"required":true},"responses":{"200":{"description":"Returned if the property is updated.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationMessage"},"example":{"message":"Property updated.","statusCode":200}}}},"201":{"description":"Returned is the property is created.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationMessage"},"example":{"message":"Property created.","statusCode":201}}}},"400":{"description":"Returned if:
\n\nthe property key is longer than 127 characters.
\nthe value is not valid JSON.
\nthe value is longer than 32768 characters.
\n
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationMessage"},"example":{"message":"The property key cannot be longer than 127 characters.","statusCode":400}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationMessage"},"example":{"message":"Access to this resource must be authenticated as an app.","statusCode":401}}}}},"deprecated":false,"x-atlassian-connect-scope":"NONE"},"delete":{"tags":["AddonProperties"],"summary":"Delete app property","description":"Deletes an app's property.
\nPermissions required: Only a Connect app whose key matches addonKey can make this request.
\n","operationId":"deleteAddonProperty","parameters":[{"name":"addonKey","in":"path","description":"The key of the app, as defined in its descriptor.
\n","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property.
\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if the property key is longer than 127 characters.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationMessage"},"example":{"message":"The property key cannot be longer than 127 characters.","statusCode":400}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationMessage"},"example":{"message":"Access to this resource must be authenticated as an app.","statusCode":401}}}},"404":{"description":"Returned if the property is not found or doesn't belong to the app.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationMessage"},"example":{"message":"Property with key not found.","statusCode":404}}}}},"deprecated":false,"x-atlassian-connect-scope":"NONE"}},"/rest/atlassian-connect/1/app/module/dynamic":{"get":{"tags":["DynamicModules"],"summary":"Get modules","description":"Returns all modules registered dynamically by the calling app.
\nPermissions required: Only Connect apps can make this request.
\n","operationId":"getModules","parameters":[],"responses":{"200":{"description":"Returned if the request is successful.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectModules"}}}},"401":{"description":"Returned if the call is not from a Connect app.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"example":{"message":"The request is not from a Connect app."}}}}},"deprecated":false,"x-experimental":true,"x-atlassian-connect-scope":"NONE"},"post":{"tags":["DynamicModules"],"summary":"Register modules","description":"Registers a list of modules.
\nPermissions required: Only Connect apps can make this request.
\n","operationId":"registerModules","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectModules"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.
\n"},"400":{"description":"Returned if:
\n\nany of the provided modules is invalid. For example, required properties are missing.
\nany of the modules conflict with registered dynamic modules or modules defined in the app descriptor. For example, there are duplicate keys.
\n
\nDetails of the issues encountered are included in the error message.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"example":{"message":"Installation failed. The app com.example.app.key has duplicate module keys: [module-key]. Please contact the app vendor."}}}},"401":{"description":"Returned if the call is not from a Connect app.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"example":{"message":"The request is not from a Connect app."}}}}},"deprecated":false,"x-experimental":true,"x-atlassian-connect-scope":"NONE"},"delete":{"tags":["DynamicModules"],"summary":"Remove modules","description":"Remove all or a list of modules registered by the calling app.
\nPermissions required: Only Connect apps can make this request.
\n","operationId":"removeModules","parameters":[{"name":"moduleKey","in":"query","description":"The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter.\nFor example, moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field.\nNonexistent keys are ignored.
\n","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"Returned if the request is successful.
\n"},"401":{"description":"Returned if the call is not from a Connect app.
\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"},"example":{"message":"The request is not from a Connect app."}}}}},"deprecated":false,"x-experimental":true,"x-atlassian-connect-scope":"NONE"}}},"components":{"schemas":{"WorkflowStatusProperties":{"required":["issueEditable"],"type":"object","properties":{"issueEditable":{"type":"boolean","description":"Whether issues are editable in this status."}},"additionalProperties":false,"description":"Properties of a workflow status."},"EventNotification":{"type":"object","properties":{"expand":{"type":"string","description":"Expand options that include additional event notification details in the response."},"id":{"type":"integer","description":"The ID of the notification.","format":"int64"},"notificationType":{"type":"string","description":"Identifies the recipients of the notification.","enum":["CurrentAssignee","Reporter","CurrentUser","ProjectLead","ComponentLead","User","Group","ProjectRole","EmailAddress","AllWatchers","UserCustomField","GroupCustomField"]},"parameter":{"type":"string","description":"The value of the `notificationType`:\n\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 *  `UserCustomField` The `parameter` is the ID of the custom field.\n *  `GroupCustomField` The `parameter` is the ID of the custom field."},"group":{"description":"The specified group.","allOf":[{"$ref":"#/components/schemas/GroupName"}]},"field":{"description":"The custom user or group field.","allOf":[{"$ref":"#/components/schemas/FieldDeprecated"}]},"emailAddress":{"type":"string","description":"The email address."},"projectRole":{"description":"The specified project role.","allOf":[{"$ref":"#/components/schemas/ProjectRole"}]},"user":{"description":"The specified user.","allOf":[{"$ref":"#/components/schemas/UserDetails"}]}},"additionalProperties":false,"description":"Details about a notification associated with an event."},"Configuration":{"type":"object","properties":{"votingEnabled":{"type":"boolean","description":"Whether the ability for users to vote on issues is enabled. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.","readOnly":true},"watchingEnabled":{"type":"boolean","description":"Whether the ability for users to watch issues is enabled. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.","readOnly":true},"unassignedIssuesAllowed":{"type":"boolean","description":"Whether the ability to create unassigned issues is enabled. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.","readOnly":true},"subTasksEnabled":{"type":"boolean","description":"Whether the ability to create subtasks for issues is enabled.","readOnly":true},"issueLinkingEnabled":{"type":"boolean","description":"Whether the ability to link issues is enabled.","readOnly":true},"timeTrackingEnabled":{"type":"boolean","description":"Whether the ability to track time is enabled. This property is deprecated.","readOnly":true},"attachmentsEnabled":{"type":"boolean","description":"Whether the ability to add attachments to issues is enabled.","readOnly":true},"timeTrackingConfiguration":{"description":"The configuration of time tracking.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/TimeTrackingConfiguration"}]}},"additionalProperties":false,"description":"Details about the configuration of Jira."},"Transitions":{"type":"object","properties":{"expand":{"type":"string","description":"Expand options that include additional transitions details in the response.","readOnly":true,"xml":{"attribute":true}},"transitions":{"type":"array","description":"List of issue transitions.","readOnly":true,"items":{"$ref":"#/components/schemas/IssueTransition"}}},"additionalProperties":false,"description":"List of issue transitions."},"UserKey":{"type":"object","properties":{"key":{"type":"string","description":"This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."},"accountId":{"type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*."}},"additionalProperties":false,"description":"List of user accountIds."},"IssuePickerSuggestionsIssueType":{"type":"object","properties":{"label":{"type":"string","description":"The label of the type of issues suggested for use in auto-completion.","readOnly":true},"sub":{"type":"string","description":"If issue suggestions are found, returns a message indicating the number of issues suggestions found and returned.","readOnly":true},"id":{"type":"string","description":"The ID of the type of issues suggested for use in auto-completion.","readOnly":true},"msg":{"type":"string","description":"If no issue suggestions are found, returns a message indicating no suggestions were found,","readOnly":true},"issues":{"type":"array","description":"A list of issues suggested for use in auto-completion.","readOnly":true,"items":{"$ref":"#/components/schemas/SuggestedIssue"}}},"additionalProperties":false,"description":"A type of issue suggested for use in auto-completion."},"WorkflowId":{"required":["draft","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the workflow."},"draft":{"type":"boolean","description":"Whether the workflow is in the draft state."}},"additionalProperties":false,"description":"Properties that identify a workflow."},"IssueFieldOptionCreateBean":{"required":["value"],"type":"object","properties":{"value":{"type":"string","description":"The option's name, which is displayed in Jira."},"properties":{"type":"object","additionalProperties":{},"description":"The properties of the option as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/) are defined in the descriptor for the issue field module."},"config":{"$ref":"#/components/schemas/IssueFieldOptionConfiguration"}},"additionalProperties":true},"NotificationRecipientsRestrictions":{"type":"object","properties":{"groups":{"type":"array","description":"List of group memberships required to receive the notification.","items":{"$ref":"#/components/schemas/GroupName"}},"permissions":{"type":"array","description":"List of permissions required to receive the notification.","items":{"$ref":"#/components/schemas/RestrictedPermission"}}},"additionalProperties":false,"description":"Details of the group membership or permissions needed to receive the notification."},"Watchers":{"type":"object","properties":{"self":{"type":"string","description":"The URL of these issue watcher details.","readOnly":true},"isWatching":{"type":"boolean","description":"Indicates whether the calling user is watching this issue.","readOnly":true},"watchCount":{"type":"integer","description":"The number of users watching this issue.","format":"int32","readOnly":true},"watchers":{"type":"array","description":"Details of the users watching this issue.","readOnly":true,"items":{"$ref":"#/components/schemas/UserDetails"}}},"additionalProperties":false,"description":"The details of watchers on an issue.","xml":{"name":"watchers"}},"RemoteObject":{"required":["title","url"],"type":"object","properties":{"url":{"type":"string","description":"The URL of the item."},"title":{"type":"string","description":"The title of the item."},"summary":{"type":"string","description":"The summary details of the item."},"icon":{"description":"Details of the icon for the item. If no icon is defined, the default link icon is used in Jira.","allOf":[{"$ref":"#/components/schemas/Icon"}]},"status":{"description":"The status of the item.","allOf":[{"$ref":"#/components/schemas/Status"}]}},"additionalProperties":true,"description":"The linked item."},"LinkedIssue":{"type":"object","properties":{"id":{"type":"string","description":"The ID of an issue. Required if `key` isn't provided."},"key":{"type":"string","description":"The key of an issue. Required if `id` isn't provided."},"self":{"type":"string","description":"The URL of the issue.","format":"uri","readOnly":true},"fields":{"description":"The fields associated with the issue.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/Fields"}]}},"additionalProperties":false,"description":"The ID or key of a linked issue."},"IssueFieldOption":{"required":["id","value"],"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier for the option. This is only unique within the select field's set of options.","format":"int64"},"value":{"type":"string","description":"The option's name, which is displayed in Jira."},"properties":{"type":"object","additionalProperties":{},"description":"The properties of the object, as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see [Issue Field Option Property Index](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/)) are defined in the descriptor for the issue field module."},"config":{"$ref":"#/components/schemas/IssueFieldOptionConfiguration"}},"additionalProperties":false,"description":"Details of the options for a select list issue field."},"Status":{"type":"object","properties":{"resolved":{"type":"boolean","description":"Indicates whether the item is resolved. If set to \"true\", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font."},"icon":{"description":"Details of the icon representing the status. If not provided, no status icon displays in Jira.","allOf":[{"$ref":"#/components/schemas/Icon"}]}},"additionalProperties":true,"description":"The status of the item."},"IssueLink":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the issue link.","readOnly":true},"self":{"type":"string","description":"The URL of the issue link.","format":"uri","readOnly":true},"type":{"description":"The type of link between the issues.","allOf":[{"$ref":"#/components/schemas/IssueLinkType"}]},"inwardIssue":{"description":"The issue the link joins to.","allOf":[{"$ref":"#/components/schemas/LinkedIssue"}]},"outwardIssue":{"description":"The issue the link originates from.","allOf":[{"$ref":"#/components/schemas/LinkedIssue"}]}},"additionalProperties":false,"description":"Details of a link between issues.","xml":{"name":"issueLinks"}},"ChangedWorklog":{"type":"object","properties":{"worklogId":{"type":"integer","description":"The ID of the worklog.","format":"int64","readOnly":true},"updatedTime":{"type":"integer","description":"The datetime of the change.","format":"int64","readOnly":true},"properties":{"type":"array","description":"Details of properties associated with the change.","readOnly":true,"items":{"$ref":"#/components/schemas/EntityProperty"}}},"additionalProperties":false,"description":"Details of a changed worklog."},"avatarUrls":{"description":"The avatars of the user.","$ref":"#/components/schemas/AvatarUrlsBean"},"BulkOperationErrorResult":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"elementErrors":{"$ref":"#/components/schemas/ErrorCollection"},"failedElementNumber":{"type":"integer","format":"int32"}},"additionalProperties":false},"SimpleErrorCollection":{"type":"object","properties":{"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"The list of errors by parameter returned by the operation. For example,\"projectKey\": \"Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters.\""},"errorMessages":{"type":"array","description":"The list of error messages produced by this operation. For example, \"input parameter 'key' must be provided\"","items":{"type":"string"}},"httpStatusCode":{"type":"integer","format":"int32"}},"additionalProperties":false},"IssuesAndJQLQueries":{"required":["issueIds","jqls"],"type":"object","properties":{"jqls":{"type":"array","description":"A list of JQL queries.","items":{"type":"string","description":"A list of JQL queries."}},"issueIds":{"uniqueItems":true,"type":"array","description":"A list of issue IDs.","items":{"type":"integer","description":"A list of issue IDs.","format":"int64"}}},"additionalProperties":false,"description":"List of issues and JQL queries."},"Workflow":{"required":["description"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/PublishedWorkflowId"},"description":{"type":"string","description":"The description of the workflow."},"transitions":{"type":"array","description":"The transitions of the workflow.","items":{"$ref":"#/components/schemas/Transition"}},"statuses":{"type":"array","description":"The statuses of the workflow.","items":{"$ref":"#/components/schemas/WorkflowStatus"}}},"additionalProperties":false,"description":"Details about a workflow."},"ConnectWorkflowTransitionRule":{"required":["id","key"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the transition rule."},"key":{"type":"string","description":"The key of the rule, as defined in the Connect app descriptor.","readOnly":true},"configuration":{"$ref":"#/components/schemas/RuleConfiguration"},"transition":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/WorkflowTransition"}]}},"additionalProperties":false,"description":"A workflow transition rule."},"JqlQueriesToParse":{"required":["queries"],"type":"object","properties":{"queries":{"minLength":1,"type":"array","description":"A list of queries to parse.","items":{"minLength":1,"type":"string"}}},"additionalProperties":false,"description":"A list of JQL queries to parse.","writeOnly":true},"FoundGroups":{"type":"object","properties":{"header":{"type":"string","description":"Header text indicating the number of groups in the response and the total number of groups found in the search."},"total":{"type":"integer","description":"The total number of groups found in the search.","format":"int32"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/FoundGroup"}}},"additionalProperties":false,"description":"The list of groups found in a search, including header text (Showing X of Y matching groups) and total of matched groups.","xml":{"name":"groupsuggestions"}},"SimpleListWrapperGroupName":{"type":"object","properties":{"size":{"type":"integer","format":"int32","xml":{"attribute":true}},"items":{"type":"array","items":{"$ref":"#/components/schemas/GroupName"}},"pagingCallback":{"$ref":"#/components/schemas/ListWrapperCallbackGroupName"},"callback":{"$ref":"#/components/schemas/ListWrapperCallbackGroupName"},"max-results":{"type":"integer","format":"int32","xml":{"name":"max-results","attribute":true}}},"additionalProperties":false,"xml":{"name":"list"}},"Project":{"type":"object","properties":{"expand":{"type":"string","description":"Expand options that include additional project details in the response.","readOnly":true,"xml":{"attribute":true}},"self":{"type":"string","description":"The URL of the project details.","format":"uri","readOnly":true},"id":{"type":"string","description":"The ID of the project."},"key":{"type":"string","description":"The key of the project.","readOnly":true},"description":{"type":"string","description":"A brief description of the project.","readOnly":true},"lead":{"description":"The username of the project lead.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/User"}]},"components":{"type":"array","description":"List of the components contained in the project.","readOnly":true,"items":{"$ref":"#/components/schemas/Component"}},"issueTypes":{"type":"array","description":"List of the issue types available in the project.","readOnly":true,"items":{"$ref":"#/components/schemas/IssueTypeBean"}},"url":{"type":"string","description":"A link to information about this project, such as project documentation.","readOnly":true},"email":{"type":"string","description":"An email address associated with the project."},"assigneeType":{"type":"string","description":"The default assignee when creating issues for this project.","readOnly":true,"enum":["PROJECT_LEAD","UNASSIGNED"]},"versions":{"type":"array","description":"The versions defined in the project. For more information, see [Create version](#api-rest-api-3-version-post).","readOnly":true,"items":{"$ref":"#/components/schemas/Version"}},"name":{"type":"string","description":"The name of the project.","readOnly":true},"roles":{"type":"object","additionalProperties":{"type":"string","format":"uri","readOnly":true},"description":"The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-3-role-post).","readOnly":true},"avatarUrls":{"description":"The URLs of the project's avatars.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/AvatarUrlsBean"}]},"projectCategory":{"description":"The category the project belongs to.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/ProjectCategory"}]},"projectTypeKey":{"type":"string","description":"The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.","readOnly":true,"enum":["software","service_desk","business"]},"simplified":{"type":"boolean","description":"Indicates whether the project is simplified.","readOnly":true},"style":{"type":"string","description":"The type of the project.","readOnly":true,"enum":["CLASSIC","NEXTGEN","next-gen"]},"isPrivate":{"type":"boolean","description":"Indicates whether the project is private.","readOnly":true},"issueTypeHierarchy":{"description":"The issue type hierarchy for the project","readOnly":true,"allOf":[{"$ref":"#/components/schemas/Hierarchy"}]},"permissions":{"description":"User permissions on the project","readOnly":true,"allOf":[{"$ref":"#/components/schemas/ProjectPermissions"}]},"properties":{"type":"object","additionalProperties":{"readOnly":true},"description":"Map of project properties","readOnly":true},"uuid":{"type":"string","description":"unique ID for next-gen projects","format":"uuid","readOnly":true}},"additionalProperties":false,"description":"Details about a project.","xml":{"name":"project"}},"SimpleListWrapperApplicationRole":{"type":"object","properties":{"size":{"type":"integer","format":"int32","xml":{"attribute":true}},"items":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationRole"}},"pagingCallback":{"$ref":"#/components/schemas/ListWrapperCallbackApplicationRole"},"callback":{"$ref":"#/components/schemas/ListWrapperCallbackApplicationRole"},"max-results":{"type":"integer","format":"int32","xml":{"name":"max-results","attribute":true}}},"additionalProperties":false,"xml":{"name":"list"}},"ProjectAvatars":{"type":"object","properties":{"system":{"type":"array","description":"List of avatars included with Jira. These avatars cannot be deleted.","readOnly":true,"items":{"$ref":"#/components/schemas/Avatar"}},"custom":{"type":"array","description":"List of avatars added to Jira. These avatars may be deleted.","readOnly":true,"items":{"$ref":"#/components/schemas/Avatar"}}},"additionalProperties":false,"description":"List of project avatars."},"LinkIssueRequestJsonBean":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/IssueLinkType"},"inwardIssue":{"$ref":"#/components/schemas/LinkedIssue"},"outwardIssue":{"$ref":"#/components/schemas/LinkedIssue"},"comment":{"$ref":"#/components/schemas/Comment"}},"additionalProperties":false},"IssueFieldOptionConfiguration":{"type":"object","properties":{"scope":{"description":"Defines the projects that the option is available in. If the scope is not defined, then the option is available in all projects.","allOf":[{"$ref":"#/components/schemas/IssueFieldOptionScopeBean"}]},"attributes":{"uniqueItems":true,"type":"array","description":"DEPRECATED","items":{"type":"string","enum":["notSelectable","defaultValue"]}}},"additionalProperties":false,"description":"Details of the projects the option is available in."},"ProjectIssueSecurityLevels":{"required":["levels"],"type":"object","properties":{"levels":{"type":"array","description":"Issue level security items list.","readOnly":true,"items":{"$ref":"#/components/schemas/SecurityLevel"}}},"additionalProperties":false,"description":"List of issue level security items in a project."},"PageBeanUser":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/User"}}},"additionalProperties":false,"description":"A page of items."},"PermittedProjects":{"type":"object","properties":{"projects":{"type":"array","description":"A list of projects.","readOnly":true,"items":{"$ref":"#/components/schemas/ProjectIdentifierBean"}}},"additionalProperties":false,"description":"A list of projects in which a user is granted permissions."},"IconBean":{"type":"object","properties":{"url16x16":{"type":"string","description":"The URL of a 16x16 pixel icon."},"title":{"type":"string","description":"The title of the icon, for use as a tooltip on the icon."},"link":{"type":"string","description":"The URL of the tooltip, used only for a status icon."}},"additionalProperties":false,"description":"An icon.","xml":{"name":"icon"}},"IssueTypeIssueCreateMetadata":{"type":"object","properties":{"self":{"type":"string","description":"The URL of these issue type details.","readOnly":true},"id":{"type":"string","description":"The ID of the issue type.","readOnly":true},"description":{"type":"string","description":"The description of the issue type.","readOnly":true},"iconUrl":{"type":"string","description":"The URL of the issue type's avatar.","readOnly":true},"name":{"type":"string","description":"The name of the issue type.","readOnly":true},"subtask":{"type":"boolean","description":"Indicates whether this issue type is used to create subtasks.","readOnly":true},"avatarId":{"type":"integer","description":"The ID of the issue type's avatar.","format":"int64","readOnly":true},"entityId":{"type":"string","description":"project unique ID for next-gen entities","format":"uuid","readOnly":true},"scope":{"description":"Details of the next-gen projects the issue type is available in.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/Scope"}]},"expand":{"type":"string","description":"Expand options that include additional issue type metadata details in the response.","readOnly":true,"xml":{"attribute":true}},"fields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/FieldMetadata"},"description":"List of the fields available when creating an issue for the issue type.","readOnly":true}},"additionalProperties":false,"description":"Details of the issue creation metadata for an issue type."},"Group":{"type":"object","properties":{"name":{"type":"string","description":"The name of group."},"self":{"type":"string","description":"The URL for these group details.","format":"uri","readOnly":true},"users":{"description":"A paginated list of the users that are members of the group. A maximum of 50 users is returned in the list, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 50 users, use`?expand=users[51:100]`.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/PagedListUserDetailsApplicationUser"}]},"expand":{"type":"string","description":"Expand options that include additional group details in the response.","readOnly":true,"xml":{"attribute":true}}},"additionalProperties":false},"WebhookDetails":{"required":["jqlFilter"],"type":"object","properties":{"jqlFilter":{"type":"string","description":"The JQL filter that specifies which issues the webhook is sent for. Only a subset of JQL can be used. The supported elements are:\n\n *  Fields: `issueKey`, `project`, `issuetype`, `status`, `assignee`, `reporter`, `issue.property`, and `cf[id]` (for custom fields\u2014only the epic label custom field is supported).\n *  Operators: `=`, `!=`, `IN`, and `NOT IN`."},"events":{"type":"array","description":"The Jira events that trigger the webhook.","items":{"type":"string","enum":["jira:issue_created","jira:issue_updated","jira:issue_deleted","comment_created","comment_updated","comment_deleted"]}}},"additionalProperties":false,"description":"A list of webhooks."},"PermissionScheme":{"required":["name"],"type":"object","properties":{"expand":{"type":"string","description":"The expand options available for the permission scheme.","readOnly":true},"id":{"type":"integer","description":"The ID of the permission scheme.","format":"int64","readOnly":true},"self":{"type":"string","description":"The URL of the permission scheme.","format":"uri","readOnly":true},"name":{"type":"string","description":"The name of the permission scheme. Must be unique. Required when creating or updating a permission scheme."},"description":{"type":"string","description":"A description for the permission scheme."},"scope":{"description":"The scope of the permission scheme.","allOf":[{"$ref":"#/components/schemas/Scope"}]},"permissions":{"type":"array","description":"The permission scheme to create or update. See [About permission schemes and grants](#about-permission-schemes-and-grants) for more information.","items":{"$ref":"#/components/schemas/PermissionGrant"}}},"additionalProperties":true,"description":"Details of a permission scheme."},"CreateUpdateRoleRequestBean":{"type":"object","properties":{"name":{"type":"string","description":"The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role."},"description":{"type":"string","description":"A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role."}},"additionalProperties":false},"JqlQuery":{"type":"object","properties":{"where":{"$ref":"#/components/schemas/JqlQueryClause"},"orderBy":{"$ref":"#/components/schemas/JqlQueryOrderByClause"}},"additionalProperties":false,"description":"A parsed JQL query."},"PageBeanWebhook":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/Webhook"}}},"additionalProperties":false,"description":"A page of items."},"DeleteAndReplaceVersionBean":{"type":"object","properties":{"moveFixIssuesTo":{"type":"integer","description":"The ID of the version to update `fixVersion` to when the field contains the deleted version.","format":"int64"},"moveAffectedIssuesTo":{"type":"integer","description":"The ID of the version to update `affectedVersion` to when the field contains the deleted version.","format":"int64"},"customFieldReplacementList":{"type":"array","description":"An array of custom field IDs (`customFieldId`) and version IDs (`moveTo`) to update when the fields contain the deleted version.","items":{"$ref":"#/components/schemas/CustomFieldReplacement"}}},"additionalProperties":false},"Notification":{"type":"object","properties":{"subject":{"type":"string","description":"The subject of the email notification for the issue. If this is not specified, then the subject is set to the issue key and summary."},"textBody":{"type":"string","description":"The plain text body of the email notification for the issue."},"htmlBody":{"type":"string","description":"The HTML body of the email notification for the issue."},"to":{"description":"The recipients of the email notification for the issue.","allOf":[{"$ref":"#/components/schemas/NotificationRecipients"}]},"restrict":{"description":"Restricts the notifications to users with the specified permissions.","allOf":[{"$ref":"#/components/schemas/NotificationRecipientsRestrictions"}]}},"additionalProperties":true,"description":"Details about a notification."},"ChangeDetails":{"type":"object","properties":{"field":{"type":"string","description":"The name of the field changed.","readOnly":true},"fieldtype":{"type":"string","description":"The type of the field changed.","readOnly":true},"fieldId":{"type":"string","description":"The ID of the field changed.","readOnly":true},"from":{"type":"string","description":"The details of the original value.","readOnly":true},"fromString":{"type":"string","description":"The details of the original value as a string.","readOnly":true},"to":{"type":"string","description":"The details of the new value.","readOnly":true},"toString":{"type":"string","description":"The details of the new value as a string.","readOnly":true}},"additionalProperties":false,"description":"A change item."},"UserWriteBean":{"required":["displayName","emailAddress"],"type":"object","properties":{"self":{"type":"string","description":"The URL of the user.","readOnly":true},"key":{"type":"string","description":"The key for the user. When provided with `name`, overrides the value in `name` to set both `name` and `key`. This property is deprecated because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."},"name":{"type":"string","description":"The username for the user. This property is deprecated because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."},"password":{"type":"string","description":"A password for the user. If a password is not set, a random password is generated."},"emailAddress":{"type":"string","description":"The email address for the user. Required."},"displayName":{"type":"string","description":"The display name for the user. Required."},"notification":{"type":"string","description":"Sends the user an email confirmation that they have been added to Jira. Default is `false`."},"applicationKeys":{"type":"array","description":"Deprecated, do not use.","items":{"type":"string"}}},"additionalProperties":true},"IssueTypeWithStatus":{"required":["id","name","self","statuses","subtask"],"type":"object","properties":{"self":{"type":"string","description":"The URL of the issue type's status details.","readOnly":true},"id":{"type":"string","description":"The ID of the issue type.","readOnly":true},"name":{"type":"string","description":"The name of the issue type.","readOnly":true},"subtask":{"type":"boolean","description":"Indicates whether this issue type represents subtasks.","readOnly":true},"statuses":{"type":"array","description":"List of status details for the issue type.","readOnly":true,"items":{"$ref":"#/components/schemas/StatusDetails"}}},"additionalProperties":false,"description":"Status details for an issue type."},"IssueLinkType":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the issue link type and is used as follows:\n\n *  In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `name` isn't provided. Otherwise, read only.\n *  In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is read only."},"name":{"type":"string","description":"The name of the issue link type and is used as follows:\n\n *  In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `id` isn't provided. Otherwise, read only.\n *  In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only."},"inward":{"type":"string","description":"The description of the issue link type inward link and is used as follows:\n\n *  In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only.\n *  In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only."},"outward":{"type":"string","description":"The description of the issue link type outward link and is used as follows:\n\n *  In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only.\n *  In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only."},"self":{"type":"string","description":"The URL of the issue link type. Read only.","format":"uri","readOnly":true}},"additionalProperties":false,"description":"This object is used as follows:\n\n *  In the [ issueLink](#api-rest-api-3-issueLink-post) resource it defines and reports on the type of link between the issues. Find a list of issue link types with [Get issue link types](#api-rest-api-3-issueLinkType-get).\n *  In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it defines and reports on issue link types."},"StatusCategory":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the status category.","readOnly":true},"id":{"type":"integer","description":"The ID of the status category.","format":"int64","readOnly":true},"key":{"type":"string","description":"The key of the status category.","readOnly":true},"colorName":{"type":"string","description":"The name of the color used to represent the status category.","readOnly":true},"name":{"type":"string","description":"The name of the status category.","readOnly":true}},"additionalProperties":true,"description":"A status category."},"Worklog":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the worklog item.","format":"uri","readOnly":true},"author":{"description":"Details of the user who created the worklog.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserDetails"}]},"updateAuthor":{"description":"Details of the user who last updated the worklog.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserDetails"}]},"comment":{"description":"A comment about the worklog in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Optional when creating or updating a worklog."},"created":{"type":"string","description":"The datetime on which the worklog was created.","format":"date-time","readOnly":true},"updated":{"type":"string","description":"The datetime on which the worklog was last updated.","format":"date-time","readOnly":true},"visibility":{"description":"Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog.","allOf":[{"$ref":"#/components/schemas/Visibility"}]},"started":{"type":"string","description":"The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.","format":"date-time"},"timeSpent":{"type":"string","description":"The time spent working on the issue as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). Required when creating a worklog if `timeSpentSeconds` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpentSecond` is provided."},"timeSpentSeconds":{"type":"integer","description":"The time in seconds spent working on the issue. Required when creating a worklog if `timeSpent` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpent` is provided.","format":"int64"},"id":{"type":"string","description":"The ID of the worklog record.","readOnly":true},"issueId":{"type":"string","description":"The ID of the issue this worklog is for.","readOnly":true},"properties":{"type":"array","description":"Details of properties for the worklog. Optional when creating or updating a worklog.","items":{"$ref":"#/components/schemas/EntityProperty"}}},"additionalProperties":true,"description":"Details of a worklog.","xml":{"name":"worklog"}},"JqlQueryOrderByClauseElement":{"required":["direction"],"type":"object","properties":{"field":{"$ref":"#/components/schemas/JqlQueryField"},"direction":{"type":"string","description":"The direction in which to order the results.","enum":["asc","desc"]}},"additionalProperties":false,"description":"An element of the order-by JQL clause."},"JqlQueryUnitaryOperand":{"type":"object","description":"An operand that can be part of a list operand.","anyOf":[{"$ref":"#/components/schemas/ValueOperand"},{"$ref":"#/components/schemas/FunctionOperand"},{"$ref":"#/components/schemas/KeywordOperand"}]},"SystemAvatars":{"type":"object","properties":{"system":{"type":"array","description":"A list of avatar details.","readOnly":true,"items":{"$ref":"#/components/schemas/Avatar"}}},"additionalProperties":false,"description":"List of system avatars."},"Votes":{"type":"object","properties":{"self":{"type":"string","description":"The URL of these issue vote details.","format":"uri","readOnly":true},"votes":{"type":"integer","description":"The number of votes on the issue.","format":"int64","readOnly":true},"hasVoted":{"type":"boolean","description":"Indicates whether the user making this request has voted on the issue.","readOnly":true},"voters":{"type":"array","description":"List of the users who have voted on this issue. An empty list is returned when the calling user doesn't have the *View voters and watchers* project permission.","readOnly":true,"items":{"$ref":"#/components/schemas/User"}}},"additionalProperties":false,"description":"The details of votes on an issue."},"ChangedValueBean":{"type":"object","properties":{"fieldName":{"type":"string","description":"The name of the field changed.","readOnly":true},"changedFrom":{"type":"string","description":"The value of the field before the change.","readOnly":true},"changedTo":{"type":"string","description":"The value of the field after the change.","readOnly":true}},"additionalProperties":false,"description":"Details of names changed in the record event."},"WorkflowTransitionRule":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The type of the transition rule."},"configuration":{"description":"The configuration of the transition rule. This is currently returned only for some of the rule types. Availability of this property is subject to change."}},"additionalProperties":false,"description":"A workflow transition rule."},"BulkIssuePropertyUpdateRequest":{"type":"object","properties":{"value":{"description":"The value of the property. The value must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters."},"filter":{"description":"The bulk operation filter.","allOf":[{"$ref":"#/components/schemas/IssueFilterForBulkPropertySet"}]}},"additionalProperties":false,"description":"Bulk issue property update request details."},"PermissionsKeysBean":{"required":["permissions"],"type":"object","properties":{"permissions":{"type":"array","description":"A list of permission keys.","items":{"type":"string"}}},"additionalProperties":false},"IssueBean":{"type":"object","properties":{"expand":{"type":"string","description":"Expand options that include additional issue details in the response.","readOnly":true,"xml":{"attribute":true}},"id":{"type":"string","description":"The ID of the issue.","readOnly":true},"self":{"type":"string","description":"The URL of the issue details.","format":"uri","readOnly":true},"key":{"type":"string","description":"The key of the issue.","readOnly":true},"renderedFields":{"type":"object","additionalProperties":{"readOnly":true},"description":"The rendered value of each field present on the issue.","readOnly":true},"properties":{"type":"object","additionalProperties":{"readOnly":true},"description":"Details of the issue properties identified in the request.","readOnly":true},"names":{"type":"object","additionalProperties":{"type":"string","readOnly":true},"description":"The ID and name of each field present on the issue.","readOnly":true},"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonTypeBean"},"description":"The schema describing each field present on the issue.","readOnly":true},"transitions":{"type":"array","description":"The transitions that can be performed on the issue.","readOnly":true,"items":{"$ref":"#/components/schemas/IssueTransition"}},"operations":{"description":"The operations that can be performed on the issue.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/Operations"}]},"editmeta":{"description":"The metadata for the fields on the issue that can be amended.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/IssueUpdateMetadata"}]},"changelog":{"description":"Details of changelogs associated with the issue.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/PageOfChangelogs"}]},"versionedRepresentations":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"readOnly":true},"readOnly":true},"description":"The versions of each field on the issue.","readOnly":true},"fieldsToInclude":{"$ref":"#/components/schemas/IncludedFields"},"fields":{"type":"object","additionalProperties":{}}},"additionalProperties":false,"xml":{"name":"issue"}},"ValueOperand":{"required":["value"],"type":"object","properties":{"value":{"type":"string","description":"The operand value."}},"description":"An operand that is a user-provided value."},"PermissionSchemes":{"type":"object","properties":{"permissionSchemes":{"type":"array","description":"Permission schemes list.","readOnly":true,"items":{"$ref":"#/components/schemas/PermissionScheme"}}},"additionalProperties":false,"description":"List of all permission schemes."},"AddGroupBean":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the group."}},"additionalProperties":true},"PageBeanScreen":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/Screen"}}},"additionalProperties":false,"description":"A page of items."},"ProjectRole":{"type":"object","properties":{"self":{"type":"string","description":"The URL the project role details.","format":"uri","readOnly":true},"name":{"type":"string","description":"The name of the project role."},"id":{"type":"integer","description":"The ID of the project role.","format":"int64","readOnly":true},"description":{"type":"string","description":"The description of the project role.","readOnly":true},"actors":{"type":"array","description":"The list of users who act in this role.","readOnly":true,"items":{"$ref":"#/components/schemas/RoleActor"}},"scope":{"description":"The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).","readOnly":true,"allOf":[{"$ref":"#/components/schemas/Scope"}]}},"additionalProperties":false,"description":"Details about the roles in a project."},"PermissionHolder":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The type of permission holder."},"parameter":{"type":"string","description":"The identifier of permission holder."},"expand":{"type":"string","description":"Expand options that include additional permission holder details in the response.","readOnly":true}},"additionalProperties":false,"description":"Details of a user, group, field, or project role that holds a permission. See [Holder object](#holder-object) in *Get all permission schemes* for more information."},"JqlQueryClause":{"type":"object","additionalProperties":false,"description":"A JQL query clause.","anyOf":[{"$ref":"#/components/schemas/CompoundClause"},{"$ref":"#/components/schemas/FieldValueClause"},{"$ref":"#/components/schemas/FieldWasClause"},{"$ref":"#/components/schemas/FieldChangedClause"}]},"IssuePickerSuggestions":{"type":"object","properties":{"sections":{"type":"array","description":"A list of issues for an issue type suggested for use in auto-completion.","readOnly":true,"items":{"$ref":"#/components/schemas/IssuePickerSuggestionsIssueType"}}},"additionalProperties":false,"description":"A list of issues suggested for use in auto-completion."},"IssueTypeUpdateBean":{"type":"object","properties":{"name":{"type":"string","description":"The unique name for the issue type. The maximum length is 60 characters."},"description":{"type":"string","description":"The description of the issue type."},"avatarId":{"type":"integer","description":"The ID of an issue type avatar.","format":"int64"}},"additionalProperties":false},"WorkflowTransition":{"required":["id","name"],"type":"object","properties":{"id":{"type":"integer","description":"The transition ID.","format":"int32"},"name":{"type":"string","description":"The transition name."}},"additionalProperties":false,"description":"A workflow transition."},"JexpJqlIssues":{"type":"object","properties":{"query":{"type":"string","description":"The JQL query."},"startAt":{"type":"integer","description":"The index of the first issue returned from the JQL query.","format":"int64"},"maxResults":{"type":"integer","description":"The maximum number of issues that will be included on the list. This value is currently capped at 1000 but the cap may change without notice.","format":"int32"},"validation":{"type":"string","description":"Determines how to validate the JQL query and treat the validation results.","enum":["strict","warn","none"],"default":"strict"}},"additionalProperties":false,"description":"The JQL specifying the issues available in the evaluated Jira expression under the `issues` context variable. Not all issues returned by the JQL query will be loaded, but only a portion of them, as described by the `startAt` and `maxResults` properties. Iterate over pages by inspecting the meta data included in the response."},"Webhook":{"required":["expirationDate","id","jqlFilter"],"type":"object","properties":{"id":{"type":"integer","description":"The ID of the webhook.","format":"int64"},"jqlFilter":{"type":"string","description":"The JQL filter that specifies which issues the webhook is sent for."},"events":{"type":"array","description":"The Jira events that trigger the webhook.","items":{"type":"string","enum":["jira:issue_created","jira:issue_updated","jira:issue_deleted","comment_created","comment_updated","comment_deleted"]}},"expirationDate":{"type":"integer","format":"int64","readOnly":true}},"additionalProperties":false,"description":"A webhook."},"WorkflowTransitionRulesUpdateErrorDetails":{"required":["ruleUpdateErrors"],"type":"object","properties":{"workflowId":{"$ref":"#/components/schemas/WorkflowId"},"ruleUpdateErrors":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated.","items":{"type":"string","description":"A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated."}},"description":"A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated."},"updateErrors":{"uniqueItems":true,"type":"array","description":"The list of errors that specify why the workflow update failed. The workflow was not updated if the list contains any entries.","items":{"type":"string","description":"An error specifying why the workflow update failed."}}},"additionalProperties":false,"description":"Details of any errors encountered while updating workflow transition rules for a workflow."},"PropertyKey":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the property.","readOnly":true},"key":{"type":"string","description":"The key of the property.","readOnly":true}},"additionalProperties":false,"description":"Property key details."},"IssueCreateMetadata":{"type":"object","properties":{"expand":{"type":"string","description":"Expand options that include additional project details in the response.","readOnly":true,"xml":{"attribute":true}},"projects":{"type":"array","description":"List of projects and their issue creation metadata.","readOnly":true,"items":{"$ref":"#/components/schemas/ProjectIssueCreateMetadata"}}},"additionalProperties":false,"description":"The wrapper for the issue creation metadata for a list of projects."},"MoveFieldBean":{"type":"object","properties":{"after":{"type":"string","description":"The ID of the screen tab field after which to place the moved screen tab field. Required if `position` isn't provided.","format":"uri"},"position":{"type":"string","description":"The named position to which the screen tab field should be moved. Required if `after` isn't provided.","enum":["Earlier","Later","First","Last"]}},"additionalProperties":false},"UserPermission":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions."},"key":{"type":"string","description":"The key of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions."},"name":{"type":"string","description":"The name of the permission."},"type":{"type":"string","description":"The type of the permission.","enum":["GLOBAL","PROJECT"]},"description":{"type":"string","description":"The description of the permission."},"havePermission":{"type":"boolean","description":"Indicates whether the permission is available to the user in the queried context."},"deprecatedKey":{"type":"boolean","description":"Indicate whether the permission key is deprecated. Note that deprecated keys cannot be used in the `permissions parameter of Get my permissions. Deprecated keys are not returned by Get all permissions.`"}},"additionalProperties":true,"description":"Details of a permission and its availability to a user."},"ErrorCollection":{"type":"object","properties":{"errorMessages":{"type":"array","description":"The list of error messages produced by this operation. For example, \"input parameter 'key' must be provided\"","items":{"type":"string"}},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"The list of errors by parameter returned by the operation. For example,\"projectKey\": \"Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters.\""},"status":{"type":"integer","format":"int32"}},"additionalProperties":false,"description":"Error messages from an operation."},"GroupName":{"type":"object","properties":{"name":{"type":"string","description":"The name of group."},"self":{"type":"string","description":"The URL for these group details.","format":"uri","readOnly":true}},"additionalProperties":false,"description":"Details about a group name."},"IncludedFields":{"type":"object","properties":{"included":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"excluded":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"actuallyIncluded":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},"additionalProperties":false},"NestedResponse":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"errorCollection":{"$ref":"#/components/schemas/ErrorCollection"}},"additionalProperties":false},"FieldMetadata":{"required":["key","name","operations","required"],"type":"object","properties":{"required":{"type":"boolean","description":"Indicates whether the field is required.","readOnly":true},"schema":{"description":"The data type of the field.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/JsonTypeBean"}]},"name":{"type":"string","description":"The name of the field.","readOnly":true},"key":{"type":"string","description":"The key of the field.","readOnly":true},"autoCompleteUrl":{"type":"string","description":"The URL that can be used to automatically complete the field.","readOnly":true},"hasDefaultValue":{"type":"boolean","description":"Indicates whether the field has a default value.","readOnly":true},"operations":{"type":"array","description":"The list of operations that can be performed on the field.","readOnly":true,"items":{"type":"string","readOnly":true}},"allowedValues":{"type":"array","description":"The list of values allowed in the field.","readOnly":true,"items":{"readOnly":true}},"defaultValue":{"description":"The default value of the field.","readOnly":true}},"additionalProperties":false,"description":"The metadata describing an issue field.","xml":{"name":"availableField"}},"IssueUpdateDetails":{"type":"object","properties":{"transition":{"description":"Details of a transition. Required when performing a transition, optional when creating or editing an issue.","allOf":[{"$ref":"#/components/schemas/IssueTransition"}]},"fields":{"type":"object","additionalProperties":{},"description":"List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use `update`. Fields included in here cannot be included in `update`."},"update":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/FieldUpdateOperation"}},"description":"List of operations to perform on issue screen fields. Note that fields included in here cannot be included in `fields`."},"historyMetadata":{"description":"Additional issue history details.","allOf":[{"$ref":"#/components/schemas/HistoryMetadata"}]},"properties":{"type":"array","description":"Details of issue properties to be add or update.","items":{"$ref":"#/components/schemas/EntityProperty"}}},"additionalProperties":true,"description":"Details of an issue update request."},"PageOfChangelogs":{"type":"object","properties":{"startAt":{"type":"integer","description":"The index of the first item returned on the page.","format":"int32","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of results that could be on the page.","format":"int32","readOnly":true},"total":{"type":"integer","description":"The number of results on the page.","format":"int32","readOnly":true},"histories":{"type":"array","description":"The list of changelogs.","readOnly":true,"items":{"$ref":"#/components/schemas/Changelog"}}},"additionalProperties":false,"description":"A page of changelogs."},"AssociatedItemBean":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the associated record.","readOnly":true},"name":{"type":"string","description":"The name of the associated record.","readOnly":true},"typeName":{"type":"string","description":"The type of the associated record.","readOnly":true},"parentId":{"type":"string","description":"The ID of the associated parent record.","readOnly":true},"parentName":{"type":"string","description":"The name of the associated parent record.","readOnly":true}},"additionalProperties":false,"description":"Details of an item associated with the changed record."},"Dashboard":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string","description":"The ID of the dashboard.","readOnly":true},"isFavourite":{"type":"boolean","description":"Indicates whether the dashboard is selected as a favorite by the user.","readOnly":true},"name":{"type":"string","description":"The name of the dashboard.","readOnly":true},"owner":{"description":"The owner of the dashboard.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserBean"}]},"popularity":{"type":"integer","description":"The number of users who have this dashboard as a favorite.","format":"int64","readOnly":true},"rank":{"type":"integer","description":"The rank of this dashboard.","format":"int32","readOnly":true},"self":{"type":"string","description":"The URL of these dashboard details.","format":"uri","readOnly":true},"sharePermissions":{"type":"array","description":"The details of any share permissions for the dashboard.","readOnly":true,"items":{"$ref":"#/components/schemas/SharePermission"}},"view":{"type":"string","description":"The URL of the dashboard.","readOnly":true}},"additionalProperties":false,"description":"Details of a dashboard."},"IssueLinkTypes":{"type":"object","properties":{"issueLinkTypes":{"type":"array","description":"The issue link type bean.","readOnly":true,"xml":{"name":"issueLinkTypes"},"items":{"$ref":"#/components/schemas/IssueLinkType"}}},"additionalProperties":false,"description":"A list of issue link type beans.","xml":{"name":"issueLinkTypes"}},"Attachment":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the attachment details response.","readOnly":true},"id":{"type":"string","description":"The ID of the attachment.","readOnly":true},"filename":{"type":"string","description":"The file name of the attachment.","readOnly":true},"author":{"description":"Details of the user who added the attachment.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserDetails"}]},"created":{"type":"string","description":"The datetime the attachment was created.","format":"date-time","readOnly":true},"size":{"type":"integer","description":"The size of the attachment.","format":"int64","readOnly":true},"mimeType":{"type":"string","description":"The MIME type of the attachment.","readOnly":true},"content":{"type":"string","description":"The content of the attachment.","readOnly":true},"thumbnail":{"type":"string","description":"The URL of a thumbnail representing the attachment.","readOnly":true}},"additionalProperties":true,"description":"Details about an attachment."},"SecuritySchemes":{"type":"object","properties":{"issueSecuritySchemes":{"type":"array","description":"List of security schemes.","readOnly":true,"items":{"$ref":"#/components/schemas/SecurityScheme"}}},"additionalProperties":false,"description":"List of security schemes."},"SearchResults":{"type":"object","properties":{"expand":{"type":"string","description":"Expand options that include additional search result details in the response.","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned on the page.","format":"int32","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of results that could be on the page.","format":"int32","readOnly":true},"total":{"type":"integer","description":"The number of results on the page.","format":"int32","readOnly":true},"issues":{"type":"array","description":"The list of issues found by the search.","readOnly":true,"items":{"$ref":"#/components/schemas/IssueBean"}},"warningMessages":{"type":"array","description":"Any warnings related to the JQL query.","readOnly":true,"items":{"type":"string","readOnly":true}},"names":{"type":"object","additionalProperties":{"type":"string","readOnly":true},"description":"The ID and name of each field in the search results.","readOnly":true},"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonTypeBean"},"description":"The schema describing the field types in the search results.","readOnly":true}},"additionalProperties":false,"description":"The result of a JQL search."},"FieldReferenceData":{"type":"object","properties":{"value":{"type":"string","description":"The field identifier."},"displayName":{"type":"string","description":"The display name of the field."},"orderable":{"type":"string","description":"Indicates whether the field can be used in a query's `ORDER BY` clause.","enum":["true","false"]},"searchable":{"type":"string","description":"Indicates whether the content of this field can be searched.","enum":["true","false"]},"auto":{"type":"string","description":"Indicates whether the field provide auto-complete suggestions.","enum":["true","false"]},"cfid":{"type":"string","description":"If the item is a custom field, the ID of the custom field."},"operators":{"type":"array","description":"The valid search operators for the field.","items":{"type":"string"}},"types":{"type":"array","description":"The data types of items in the field.","items":{"type":"string"}}},"additionalProperties":false,"description":"Details of a field that can be used in advanced searches."},"ListOperand":{"type":"object","properties":{"values":{"minLength":1,"type":"array","description":"The list of operand values.","items":{"$ref":"#/components/schemas/JqlQueryUnitaryOperand"}}},"description":"An operand that is a list of values."},"DefaultShareScope":{"required":["scope"],"type":"object","properties":{"scope":{"type":"string","description":"The scope of the default sharing for new filters and dashboards:\n\n *  `AUTHENTICATED` Shared with all logged-in users.\n *  `GLOBAL` Shared with all logged-in users. This shows as `AUTHENTICATED` in the response.\n *  `PRIVATE` Not shared with any users.","enum":["GLOBAL","AUTHENTICATED","PRIVATE"]}},"additionalProperties":false,"description":"Details of the scope of the default sharing for new filters and dashboards.","xml":{"name":"defaultShareScope"}},"ActorsMap":{"type":"object","properties":{"user":{"type":"array","description":"The user account ID of the user to add.","items":{"type":"string"}},"group":{"type":"array","description":"The name of the group to add.","items":{"type":"string"}}},"additionalProperties":false},"AutoCompleteSuggestions":{"type":"object","properties":{"results":{"type":"array","description":"The list of suggested item.","items":{"$ref":"#/components/schemas/AutoCompleteSuggestion"}}},"additionalProperties":false,"description":"The results from a JQL query."},"WebhookRegistrationDetails":{"required":["url","webhooks"],"type":"object","properties":{"webhooks":{"type":"array","description":"A list of webhooks.","items":{"$ref":"#/components/schemas/WebhookDetails"}},"url":{"type":"string","description":"The URL that specifies where to send the webhooks."}},"additionalProperties":false,"description":"Details of webhooks to register."},"JqlQueryClauseTimePredicate":{"required":["operand","operator"],"type":"object","properties":{"operator":{"type":"string","description":"The operator between the field and the operand.","enum":["before","after","from","to","on","during","by"]},"operand":{"$ref":"#/components/schemas/JqlQueryClauseOperand"}},"description":"A time predicate for a temporal JQL clause."},"Version":{"type":"object","properties":{"expand":{"type":"string","description":"Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts multiple values separated by a comma:\n\n *  `operations` Returns the list of operations available for this version.\n *  `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n\nOptional for create and update.","xml":{"attribute":true}},"self":{"type":"string","description":"The URL of the version.","format":"uri","readOnly":true},"id":{"type":"string","description":"The ID of the version.","readOnly":true},"description":{"type":"string","description":"The description of the version. Optional when creating or updating a version."},"name":{"type":"string","description":"The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters."},"archived":{"type":"boolean","description":"Indicates that the version is archived. Optional when creating or updating a version."},"released":{"type":"boolean","description":"Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version."},"startDate":{"type":"string","description":"The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.","format":"date"},"releaseDate":{"type":"string","description":"The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.","format":"date"},"overdue":{"type":"boolean","description":"Indicates that the version is overdue.","readOnly":true},"userStartDate":{"type":"string","description":"The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.","readOnly":true},"userReleaseDate":{"type":"string","description":"The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.","readOnly":true},"project":{"type":"string","description":"Deprecated. Use `projectId`."},"projectId":{"type":"integer","description":"The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.","format":"int64"},"moveUnfixedIssuesTo":{"type":"string","description":"The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.","format":"uri"},"operations":{"type":"array","description":"If the expand option `operations` is used, returns the list of operations available for this version.","readOnly":true,"items":{"$ref":"#/components/schemas/SimpleLink"}},"issuesStatusForFixVersion":{"description":"If the expand option `issuesstatus` is used, returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/VersionIssuesStatus"}]}},"additionalProperties":false,"description":"Details about a project version.","xml":{"name":"version"}},"WorkflowScheme":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the workflow scheme.","format":"int64","readOnly":true},"name":{"type":"string","description":"The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme."},"description":{"type":"string","description":"The description of the workflow scheme."},"defaultWorkflow":{"type":"string","description":"The name of the default workflow for the workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira. If `defaultWorkflow` is not specified when creating a workflow scheme, it is set to *Jira Workflow (jira)*."},"issueTypeMappings":{"type":"object","additionalProperties":{"type":"string"},"description":"The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme."},"originalDefaultWorkflow":{"type":"string","description":"For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira.","readOnly":true},"originalIssueTypeMappings":{"type":"object","additionalProperties":{"type":"string","readOnly":true},"description":"For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.","readOnly":true},"draft":{"type":"boolean","description":"Indicates whether the workflow scheme is a draft or not.","readOnly":true},"lastModifiedUser":{"description":"The user that last modified the draft workflow scheme. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/User"}]},"lastModified":{"type":"string","description":"The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.","readOnly":true},"self":{"type":"string","format":"uri","readOnly":true},"updateDraftIfNeeded":{"type":"boolean","description":"Indicates whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works:\n\n *  Update an active workflow scheme with `updateDraftIfNeeded` set to `true`: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.\n *  Update an active workflow scheme with `updateDraftIfNeeded` set to `false`: An error is returned, as active workflow schemes cannot be updated.\n *  Update an inactive workflow scheme with `updateDraftIfNeeded` set to `true`: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.\n\nDefaults to `false`."},"issueTypes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/IssueTypeBean"},"description":"The issue types available in Jira.","readOnly":true}},"additionalProperties":false,"description":"Details about a workflow scheme."},"SecurityLevel":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the issue level security item.","readOnly":true},"id":{"type":"string","description":"The ID of the issue level security item.","readOnly":true},"description":{"type":"string","description":"The description of the issue level security item.","readOnly":true},"name":{"type":"string","description":"The name of the issue level security item.","readOnly":true}},"additionalProperties":false,"description":"Details of an issue level security item."},"ScreenableTab":{"required":["name"],"type":"object","properties":{"id":{"type":"integer","description":"The ID of the screen tab.","format":"int64","readOnly":true},"name":{"type":"string","description":"The name of the screen tab. Required on create and update. The maximum length is 255 characters."}},"additionalProperties":false,"description":"A screen tab."},"BulkPermissionsRequestBean":{"type":"object","properties":{"projectPermissions":{"uniqueItems":true,"type":"array","description":"Project permissions with associated projects and issues to look up.","items":{"$ref":"#/components/schemas/BulkProjectPermissions"}},"globalPermissions":{"uniqueItems":true,"type":"array","description":"Global permissions to look up.","items":{"type":"string"}}},"additionalProperties":false,"description":"Details of global permissions to look up and project permissions with associated projects and issues to look up."},"Permissions":{"type":"object","properties":{"permissions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/UserPermission"},"description":"List of permissions.","readOnly":true}},"additionalProperties":false,"description":"Details about permissions."},"SimpleApplicationPropertyBean":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the application property."},"value":{"type":"string","description":"The new value."}},"additionalProperties":false,"xml":{"name":"applicationProperty"}},"SecurityScheme":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the issue security scheme.","readOnly":true},"id":{"type":"integer","description":"The ID of the issue security scheme.","format":"int64","readOnly":true},"name":{"type":"string","description":"The name of the issue security scheme.","readOnly":true},"description":{"type":"string","description":"The description of the issue security scheme.","readOnly":true},"defaultSecurityLevelId":{"type":"integer","description":"The ID of the default security level.","format":"int64","readOnly":true},"levels":{"type":"array","items":{"$ref":"#/components/schemas/SecurityLevel"}}},"additionalProperties":false,"description":"Details about a security scheme."},"DeprecatedWorkflow":{"type":"object","properties":{"name":{"type":"string","description":"The name of the workflow.","readOnly":true},"description":{"type":"string","description":"The description of the workflow.","readOnly":true},"lastModifiedDate":{"type":"string","description":"The datetime the workflow was last modified.","readOnly":true},"lastModifiedUser":{"type":"string","description":"This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.","readOnly":true},"lastModifiedUserAccountId":{"type":"string","description":"The account ID of the user that last modified the workflow.","readOnly":true},"steps":{"type":"integer","description":"The number of steps included in the workflow.","format":"int32","readOnly":true},"scope":{"description":"The scope where this workflow applies","readOnly":true,"allOf":[{"$ref":"#/components/schemas/Scope"}]},"default":{"type":"boolean"}},"additionalProperties":false,"description":"Details about a workflow."},"WorkflowRules":{"required":["conditions","postFunctions","validators"],"type":"object","properties":{"conditions":{"type":"array","description":"The workflow conditions.","items":{"$ref":"#/components/schemas/WorkflowTransitionRule"}},"validators":{"type":"array","description":"The workflow validators.","items":{"$ref":"#/components/schemas/WorkflowTransitionRule"}},"postFunctions":{"type":"array","description":"The workflow post functions.","items":{"$ref":"#/components/schemas/WorkflowTransitionRule"}}},"additionalProperties":false,"description":"A collection of transition rules."},"ApplicationProperty":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the application property. The ID and key are the same."},"key":{"type":"string","description":"The key of the application property. The ID and key are the same."},"value":{"type":"string","description":"The new value."},"name":{"type":"string","description":"The name of the application property."},"desc":{"type":"string","description":"The description of the application property."},"type":{"type":"string","description":"The data type of the application property."},"defaultValue":{"type":"string","description":"The default value of the application property."},"example":{"type":"string"},"allowedValues":{"type":"array","description":"The allowed values, if applicable.","items":{"type":"string"}}},"additionalProperties":false,"description":"Details of an application property."},"PagedListUserDetailsApplicationUser":{"type":"object","properties":{"size":{"type":"integer","description":"The number of items on the page.","format":"int32","readOnly":true,"xml":{"attribute":true}},"items":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/UserDetails"}},"max-results":{"type":"integer","description":"The maximum number of results that could be on the page.","format":"int32","readOnly":true,"xml":{"name":"max-results","attribute":true}},"start-index":{"type":"integer","description":"The index of the first item returned on the page.","format":"int32","readOnly":true,"xml":{"name":"start-index","attribute":true}},"end-index":{"type":"integer","description":"The index of the last item returned on the page.","format":"int32","readOnly":true,"xml":{"name":"end-index","attribute":true}}},"additionalProperties":false,"description":"A paged list. To access additional details append `[start-index:end-index]` to the expand request. For example, `?expand=sharedUsers[10:40]` returns a list starting at item 10 and finishing at item 40."},"PublishedWorkflowId":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the workflow."}},"additionalProperties":false,"description":"Properties that identify a published workflow."},"HierarchyOutputFragment":{"type":"object","properties":{"projectId":{"type":"integer","format":"int64"},"hierarchy":{"type":"array","items":{"$ref":"#/components/schemas/HierarchyLevelOutput"}}},"additionalProperties":false},"ContainerForWebhookIDs":{"required":["webhookIds"],"type":"object","properties":{"webhookIds":{"type":"array","description":"A list of webhook IDs.","items":{"type":"integer","description":"A list of webhook IDs.","format":"int64"}}},"additionalProperties":false,"description":"Container for a list of webhook IDs."},"ProjectType":{"type":"object","properties":{"key":{"type":"string","description":"The key of the project type.","readOnly":true},"formattedKey":{"type":"string","description":"The formatted key of the project type.","readOnly":true},"descriptionI18nKey":{"type":"string","description":"The key of the project type's description.","readOnly":true},"icon":{"type":"string","description":"The icon of the project type.","readOnly":true},"color":{"type":"string","description":"The color of the project type.","readOnly":true}},"additionalProperties":false,"description":"Details about a project type."},"FieldUpdateOperation":{"type":"object","properties":{"add":{"description":"A map containing the name of a field and the value to add to it.","example":{"labels":"Training","issuelinks":{"id":10001}}},"set":{"description":"A map containing the name of a field and the value to set in it.","example":{"summary":"A new summary","issuetype":{"id":10010}}},"remove":{"description":"A map containing the name of a field and the value to removed from it.","example":{"labels":"Training","components":{"id":10017}}},"edit":{"description":"A map containing the name of a field and the value to edit in it.","example":{"timetracking":{"key":"JIRA"}}}},"additionalProperties":false,"description":"Details of an operation to perform on a field."},"Icon":{"type":"object","properties":{"url16x16":{"type":"string","description":"The URL of an icon that displays at 16x16 pixel in Jira."},"title":{"type":"string","description":"The title of the icon. This is used as follows:\n\n *  For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira.\n *  For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\"."},"link":{"type":"string","description":"The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable."}},"additionalProperties":true,"description":"An icon. If no icon is defined:\n\n *  for a status icon, no status icon displays in Jira.\n *  for the remote object icon, the default link icon displays in Jira."},"SearchRequestBean":{"type":"object","properties":{"jql":{"type":"string","description":"A [JQL](https://confluence.atlassian.com/x/egORLQ) expression."},"startAt":{"type":"integer","description":"The index of the first item to return in the page of results (page offset). The base index is `0`.","format":"int32"},"maxResults":{"type":"integer","description":"The maximum number of items to return per page. The default is `50` and the maximum is `100`.","format":"int32"},"fields":{"type":"array","description":"A comma-separated list of fields to return for each issue, 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\nThe default is `*navigable`.\n\nExamples:\n\n *  `summary,comment` Returns the summary and comments fields only.\n *  `-description` Returns all navigable (default) fields except description.\n *  `*all,-comment` Returns all fields except comments.\n\nMultiple `fields` parameters can be included in a request.\n\nNote: All navigable fields are returned by default. This differs from [GET issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields.","items":{"type":"string"}},"validateQuery":{"type":"string","description":"Determines how to validate the JQL query and treat the validation results. Supported values:\n\n *  `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings).\n *  `warn` Returns all errors as warnings.\n *  `none` No validation is performed.\n *  `true` *Deprecated* A legacy synonym for `strict`.\n *  `false` *Deprecated* A legacy synonym for `warn`.\n\nThe default is `strict`.\n\nNote: If the JQL is not correctly formed a 400 response code is returned, regardless of the `validateQuery` value.","enum":["strict","warn","none","true","false"]},"expand":{"type":"array","description":"Use [expand](em>#expansion) to include additional information about issues in the response. Note that, unlike the majority of instances where `expand` is specified, `expand` is defined as a list of values. The expand options are:\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 *  `operations` Returns all possible operations 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` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.","items":{"type":"string"}},"properties":{"type":"array","description":"A comma-separated list of up to 5 issue properties to include in the results.","items":{"type":"string"}},"fieldsByKeys":{"type":"boolean","description":"Reference fields by their key (rather than ID). The default is `false`."}},"additionalProperties":false},"AddFieldBean":{"required":["fieldId"],"type":"object","properties":{"fieldId":{"type":"string","description":"The ID of the field to add."}},"additionalProperties":false},"IssueFilterForBulkPropertySet":{"type":"object","properties":{"entityIds":{"uniqueItems":true,"type":"array","description":"List of issues to perform the bulk operation on.","items":{"type":"integer","format":"int64"}},"currentValue":{"description":"The value of properties to perform the bulk operation on."},"hasProperty":{"type":"boolean","description":"Indicates whether the bulk operation occurs only when the property is present on or absent from an issue."}},"additionalProperties":false,"description":"Bulk operation filter details."},"FoundFilter":{"required":["name"],"type":"object","properties":{"self":{"type":"string","description":"The URL of the filter.","format":"uri","readOnly":true},"id":{"type":"string","description":"The unique identifier for the filter.","readOnly":true},"name":{"type":"string","description":"The name of the filter. Must be unique."},"description":{"type":"string","description":"A description of the filter."},"owner":{"description":"The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/User"}]},"jql":{"type":"string","description":"The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*.","readOnly":true},"viewUrl":{"type":"string","description":"A URL to view the filter results in Jira, using the ID of the filter. For example, *https://your-domain.atlassian.net/issues/?filter=10100*.","format":"uri","readOnly":true},"searchUrl":{"type":"string","description":"A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-3-filter-search-get) operation with the filter's JQL string to return the filter results. For example, *https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*.","format":"uri","readOnly":true},"favourite":{"type":"boolean","description":"Indicates whether the filter is selected as a favorite by any users, not including the filter owner.","readOnly":true},"favouritedCount":{"type":"integer","description":"The count of how many users have selected this filter as a favorite, including the filter owner.","format":"int64","readOnly":true},"sharePermissions":{"type":"array","description":"The groups and projects that the filter is shared with. This can be specified when updating a filter, but not when creating a filter.","items":{"$ref":"#/components/schemas/SharePermission"}},"subscriptions":{"type":"array","description":"The users that are subscribed to the filter.","readOnly":true,"items":{"$ref":"#/components/schemas/FilterSubscription"}}},"additionalProperties":false,"description":"Details of a filter identified as part of a search."},"JQLReferenceData":{"type":"object","properties":{"visibleFieldNames":{"type":"array","description":"List of fields usable in JQL queries.","items":{"$ref":"#/components/schemas/FieldReferenceData"}},"visibleFunctionNames":{"type":"array","description":"List of functions usable in JQL queries.","items":{"$ref":"#/components/schemas/FunctionReferenceData"}},"jqlReservedWords":{"type":"array","description":"List of JQL query reserved words.","items":{"type":"string"}}},"additionalProperties":false,"description":"Lists of JQL reference data."},"ProjectRoleActorsUpdateBean":{"type":"object","properties":{"id":{"type":"integer","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.","format":"int64","readOnly":true},"categorisedActors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"The actors to add to the project role. Add groups using `atlassian-group-role-actor` and a list of group names. For example, `\"atlassian-group-role-actor\":[\"another\",\"administrators\"]}`. Add users using `atlassian-user-role-actor` and a list of account IDs. For example, `\"atlassian-user-role-actor\":[\"12345678-9abc-def1-2345-6789abcdef12\", \"abcdef12-3456-789a-bcde-f123456789ab\"]`."}},"additionalProperties":false,"xml":{"name":"actor"}},"ParsedJqlQueries":{"required":["queries"],"type":"object","properties":{"queries":{"minLength":1,"type":"array","description":"A list of parsed JQL queries.","items":{"$ref":"#/components/schemas/ParsedJqlQuery"}}},"additionalProperties":false,"description":"A list of parsed JQL queries."},"DefaultWorkflow":{"required":["workflow"],"type":"object","properties":{"workflow":{"type":"string","description":"The name of the workflow to set as the default workflow."},"updateDraftIfNeeded":{"type":"boolean","description":"Indicates whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new default workflow. Defaults to `false`."}},"additionalProperties":false,"description":"Details about the default workflow."},"ProjectIdentifiers":{"required":["id","key","self"],"type":"object","properties":{"self":{"type":"string","description":"The URL of the created project.","format":"uri","readOnly":true},"id":{"type":"integer","description":"The ID of the created project.","format":"int64","readOnly":true},"key":{"type":"string","description":"The key of the created project.","readOnly":true}},"additionalProperties":false,"description":"Identifiers for a project."},"ChangedWorklogs":{"type":"object","properties":{"values":{"type":"array","description":"Changed worklog list.","readOnly":true,"items":{"$ref":"#/components/schemas/ChangedWorklog"}},"since":{"type":"integer","description":"The datetime of the first worklog item in the list.","format":"int64","readOnly":true},"until":{"type":"integer","description":"The datetime of the last worklog item in the list.","format":"int64","readOnly":true},"self":{"type":"string","description":"The URL of this changed worklogs list.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"The URL of the next list of changed worklogs.","format":"uri","readOnly":true},"lastPage":{"type":"boolean"}},"additionalProperties":false,"description":"List of changed worklogs."},"RemoteIssueLinkRequest":{"type":"object","properties":{"globalId":{"type":"string","description":"An identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: `appId=456&pageId=123`.\n\nSetting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID.\n\nThe maximum length is 255 characters."},"application":{"description":"Details of the remote application the linked item is in. For example, trello.","allOf":[{"$ref":"#/components/schemas/Application"}]},"relationship":{"type":"string","description":"Description of the relationship between the issue and the linked item. If not set, the relationship description \"links to\" is used in Jira."},"object":{"description":"Details of the item linked to.","allOf":[{"$ref":"#/components/schemas/RemoteObject"}]}},"additionalProperties":true,"description":"Details of a remote issue link."},"WebhooksExpirationDate":{"required":["expirationDate"],"type":"object","properties":{"expirationDate":{"type":"integer","format":"int64","readOnly":true}},"additionalProperties":false,"description":"The date the newly refreshed webhooks expire."},"PageOfWorklogs":{"type":"object","properties":{"startAt":{"type":"integer","description":"The index of the first item returned on the page.","format":"int32","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of results that could be on the page.","format":"int32","readOnly":true},"total":{"type":"integer","description":"The number of results on the page.","format":"int32","readOnly":true},"worklogs":{"type":"array","description":"List of worklogs.","readOnly":true,"items":{"$ref":"#/components/schemas/Worklog"}}},"additionalProperties":true,"description":"Paginated list of worklog details"},"ContainerOfWorkflowSchemeAssociations":{"required":["values"],"type":"object","properties":{"values":{"type":"array","description":"A list of workflow schemes together with projects they are associated with.","items":{"$ref":"#/components/schemas/WorkflowSchemeAssociations"}}},"additionalProperties":false,"description":"A container for a list of workflow schemes together with the projects they are associated with."},"JiraExpressionsComplexityValueBean":{"required":["limit","value"],"type":"object","properties":{"value":{"type":"integer","description":"The complexity value of the current expression.","format":"int32"},"limit":{"type":"integer","description":"The maximum allowed complexity. The evaluation will fail if this value is exceeded.","format":"int32"}},"additionalProperties":false},"RuleConfiguration":{"required":["value"],"type":"object","properties":{"value":{"type":"string","description":"Configuration of the rule, as it is stored by the Connect app on the rule configuration page."}},"additionalProperties":false,"description":"A rule configuration."},"Field":{"required":["description","id","key","name"],"type":"object","properties":{"id":{"type":"string","description":"The id of the field."},"key":{"type":"string","description":"The key of the field."},"name":{"type":"string","description":"The name of the field."},"description":{"type":"string","description":"The description of the field."}},"additionalProperties":false,"description":"Details of a field."},"ServerInformation":{"type":"object","properties":{"baseUrl":{"type":"string","description":"The base URL of the Jira instance."},"version":{"type":"string","description":"The version of Jira."},"versionNumbers":{"type":"array","description":"The major, minor, and revision version numbers of the Jira version.","items":{"type":"integer","format":"int32"}},"deploymentType":{"type":"string","description":"The type of server deployment. This is always returned as *Cloud*."},"buildNumber":{"type":"integer","description":"The build number of the Jira version.","format":"int32"},"buildDate":{"type":"string","description":"The timestamp when the Jira version was built.","format":"date-time"},"serverTime":{"type":"string","description":"The time in Jira when this request was responded to.","format":"date-time"},"scmInfo":{"type":"string","description":"The unique identifier of the Jira version."},"serverTitle":{"type":"string","description":"The name of the Jira instance."},"healthChecks":{"type":"array","description":"Jira instance health check results. Deprecated and no longer returned.","items":{"$ref":"#/components/schemas/HealthCheckResult"}}},"additionalProperties":false,"description":"Details about the Jira instance."},"RegisteredWebhook":{"type":"object","properties":{"createdWebhookId":{"type":"integer","description":"The ID of the webhook. Returned if the webhook is created.","format":"int64"},"errors":{"type":"array","description":"Error messages specifying why the webhook creation failed.","items":{"type":"string","description":"Error messages specifying why the webhook creation failed."}}},"additionalProperties":false,"description":"ID of a registered webhook or error messages explaining why a webhook wasn't registered."},"CustomFieldOption":{"type":"object","properties":{"self":{"type":"string","description":"The URL of these custom field option details.","format":"uri","readOnly":true},"value":{"type":"string","description":"The value of the custom field option.","readOnly":true}},"additionalProperties":false,"description":"Details of a custom option for a field.","xml":{"name":"customFieldOption"}},"FunctionReferenceData":{"type":"object","properties":{"value":{"type":"string","description":"The function identifier."},"displayName":{"type":"string","description":"The display name of the function."},"isList":{"type":"string","description":"Indicates whether the function can take a list of arguments.","enum":["true","false"]},"types":{"type":"array","description":"The data types returned by the function.","items":{"type":"string"}}},"additionalProperties":false,"description":"Details of functions that can be used in advanced searches."},"Component":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the component.","format":"uri","readOnly":true},"id":{"type":"string","description":"The unique identifier for the component.","readOnly":true},"name":{"type":"string","description":"The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters."},"description":{"type":"string","description":"The description for the component. Optional when creating or updating a component."},"lead":{"description":"The user details for the component's lead user.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/User"}]},"leadUserName":{"type":"string","description":"This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."},"leadAccountId":{"type":"string","description":"The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.Optional when creating or updating a component."},"assigneeType":{"type":"string","description":"The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:\n\n *  `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n *  `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n *  `UNASSIGNED` an assignee is not set for issues created with this component.\n *  `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.\n\nDefault value: `PROJECT_DEFAULT`.  \nOptional when creating or updating a component.","enum":["PROJECT_DEFAULT","COMPONENT_LEAD","PROJECT_LEAD","UNASSIGNED"]},"assignee":{"description":"The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/User"}]},"realAssigneeType":{"type":"string","description":"The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n *  `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n *  `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n *  `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n *  `PROJECT_DEFAULT` when none of the preceding cases are true.","readOnly":true,"enum":["PROJECT_DEFAULT","COMPONENT_LEAD","PROJECT_LEAD","UNASSIGNED"]},"realAssignee":{"description":"The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/User"}]},"isAssigneeTypeValid":{"type":"boolean","description":"Indicates whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.","readOnly":true},"project":{"type":"string","description":"The key of the project the component is assigned to. Required when creating a component. Can't be updated."},"projectId":{"type":"integer","description":"The ID of the project the component is assigned to.","format":"int64","readOnly":true}},"additionalProperties":false,"description":"Details about a project component.","xml":{"name":"component"}},"UserList":{"type":"object","properties":{"size":{"type":"integer","description":"The number of items on the page.","format":"int32","readOnly":true,"xml":{"attribute":true}},"items":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/User"}},"max-results":{"type":"integer","description":"The maximum number of results that could be on the page.","format":"int32","readOnly":true,"xml":{"name":"max-results","attribute":true}},"start-index":{"type":"integer","description":"The index of the first item returned on the page.","format":"int32","readOnly":true,"xml":{"name":"start-index","attribute":true}},"end-index":{"type":"integer","description":"The index of the last item returned on the page.","format":"int32","readOnly":true,"xml":{"name":"end-index","attribute":true}}},"additionalProperties":false,"description":"A paginated list of users sharing the filter. This includes users that are members of the groups or can browse the projects that the filter is shared with."},"PageOfDashboards":{"type":"object","properties":{"startAt":{"type":"integer","description":"The index of the first item returned on the page.","format":"int32","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of results that could be on the page.","format":"int32","readOnly":true},"total":{"type":"integer","description":"The number of results on the page.","format":"int32","readOnly":true},"prev":{"type":"string","description":"The URL of the previous page of results, if any.","readOnly":true},"next":{"type":"string","description":"The URL of the next page of results, if any.","readOnly":true},"dashboards":{"type":"array","description":"List of dashboards.","readOnly":true,"items":{"$ref":"#/components/schemas/Dashboard"}}},"additionalProperties":false,"description":"A page containing dashboard details."},"JqlQueryOrderByClause":{"required":["fields"],"type":"object","properties":{"fields":{"type":"array","description":"The list of order-by clause fields and their ordering directives.","items":{"$ref":"#/components/schemas/JqlQueryOrderByClauseElement"}}},"additionalProperties":false,"description":"Details of the order-by JQL clause."},"PageBeanString":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"type":"string","readOnly":true}}},"additionalProperties":false,"description":"A page of items."},"JiraExpressionEvalContextBean":{"type":"object","properties":{"issue":{"description":"The issue that is available under the `issue` variable when evaluating the expression.","allOf":[{"$ref":"#/components/schemas/IdOrKeyBean"}]},"issues":{"description":"(EXPERIMENTAL) The collection of issues that is available under the `issues` variable when evaluating the expression.","allOf":[{"$ref":"#/components/schemas/JexpIssues"}]},"project":{"description":"The project that is available under the `project` variable when evaluating the expression.","allOf":[{"$ref":"#/components/schemas/IdOrKeyBean"}]},"sprint":{"type":"integer","description":"The ID of the sprint that is available under the `sprint` variable when evaluating the expression.","format":"int64"},"board":{"type":"integer","description":"The ID of the board that is available under the `board` variable when evaluating the expression.","format":"int64"},"serviceDesk":{"type":"integer","description":"The ID of the service desk that is available under the `serviceDesk` variable when evaluating the expression.","format":"int64"},"customerRequest":{"type":"integer","description":"The ID of the customer request that is available under the `customerRequest` variable when evaluating the expression. This is the same as the ID of the underlying Jira issue, but the customer request context variable will have a different type.","format":"int64"}},"additionalProperties":false},"CustomFieldReplacement":{"type":"object","properties":{"customFieldId":{"type":"integer","description":"The ID of the custom field in which to replace the version number.","format":"int64"},"moveTo":{"type":"integer","description":"The version number to use as a replacement for the deleted version.","format":"int64"}},"additionalProperties":false,"description":"Details about the replacement for a deleted version."},"ColumnItem":{"type":"object","properties":{"label":{"type":"string","description":"The issue navigator column label."},"value":{"type":"string","description":"The issue navigator column value."}},"additionalProperties":false,"description":"Details of an issue navigator column item."},"RemoteIssueLinkIdentifies":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the remote issue link, such as the ID of the item on the remote system.","format":"int64","readOnly":true,"xml":{"attribute":true}},"self":{"type":"string","description":"The URL of the remote issue link.","readOnly":true,"xml":{"attribute":true}}},"additionalProperties":false,"description":"Details of the identifiers for a created or updated remote issue link."},"ConnectModule":{"type":"object","description":"A [Connect module](https://developer.atlassian.com/cloud/jira/platform/about-jira-modules/) in the same format as in the\n[app descriptor](https://developer.atlassian.com/cloud/jira/platform/app-descriptor/).","example":{"description":{"value":"field with team"},"type":"single_select","extractions":[{"path":"category","type":"text","name":"categoryName"}],"name":{"value":"Team"},"key":"team-field"}},"PageBeanVersion":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/Version"}}},"additionalProperties":false,"description":"A page of items."},"Avatar":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the avatar. Required when setting the project avatar."},"owner":{"type":"string","description":"The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the accountId for a user.","readOnly":true},"isSystemAvatar":{"type":"boolean","description":"Indicates whether the avatar is a system avatar.","readOnly":true},"isSelected":{"type":"boolean","description":"Indicates whether the avatar is used in Jira. For example, shown as a project's avatar.","readOnly":true},"isDeletable":{"type":"boolean","description":"Indicates whether the avatar can be deleted.","readOnly":true},"fileName":{"type":"string","description":"The file name of the avatar icon. Returned for system avatars.","readOnly":true},"urls":{"type":"object","additionalProperties":{"type":"string","format":"uri","readOnly":true},"description":"The list of avatar icon URLs.","readOnly":true}},"additionalProperties":false,"description":"Details of an avatar."},"CustomFieldDefinitionJsonBean":{"required":["name","searcherKey","type"],"type":"object","properties":{"name":{"type":"string","description":"The name of the custom field, which is displayed in Jira. This is not the unique identifier."},"description":{"type":"string","description":"The description of the custom field, which is displayed in Jira."},"type":{"type":"string","description":"The type of the custom field. For example, *com.atlassian.jira.plugin.system.customfieldtypes:grouppicker*.\n\n *  `cascadingselect`: Allows multiple values to be selected using two select lists\n *  `datepicker`: Stores a date using a picker control\n *  `datetime`: Stores a date with a time component\n *  `float`: Stores and validates a numeric (floating point) input\n *  `grouppicker`: Stores a user group using a picker control\n *  `importid`: A read-only field that stores the previous ID of the issue from the system that it was imported from\n *  `labels`: Stores labels\n *  `multicheckboxes`: Stores multiple values using checkboxes\n *  `multigrouppicker`: Stores multiple user groups using a picker control\n *  `multiselect`: Stores multiple values using a select list\n *  `multiuserpicker`: Stores multiple users using a picker control\n *  `multiversion`: Stores multiple versions from the versions available in a project using a picker control\n *  `project`: Stores a project from a list of projects that the user is permitted to view\n *  `radiobuttons`: Stores a value using radio buttons\n *  `readonlyfield`: Stores a read-only text value, which can only be populated via the API\n *  `select`: Stores a value from a configurable list of options\n *  `textarea`: Stores a long text string using a multiline text area\n *  `textfield`: Stores a text string using a single-line text box\n *  `url`: Stores a URL\n *  `userpicker`: Stores a user using a picker control\n *  `version`: Stores a version using a picker control","enum":["com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect","com.atlassian.jira.plugin.system.customfieldtypes:datepicker","com.atlassian.jira.plugin.system.customfieldtypes:datetime","com.atlassian.jira.plugin.system.customfieldtypes:float","com.atlassian.jira.plugin.system.customfieldtypes:grouppicker","com.atlassian.jira.plugin.system.customfieldtypes:importid","com.atlassian.jira.plugin.system.customfieldtypes:labels","com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes","com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker","com.atlassian.jira.plugin.system.customfieldtypes:multiselect","com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker","com.atlassian.jira.plugin.system.customfieldtypes:multiversion","com.atlassian.jira.plugin.system.customfieldtypes:project","com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons","com.atlassian.jira.plugin.system.customfieldtypes:readonlyfield","com.atlassian.jira.plugin.system.customfieldtypes:select","com.atlassian.jira.plugin.system.customfieldtypes:textarea","com.atlassian.jira.plugin.system.customfieldtypes:textfield","com.atlassian.jira.plugin.system.customfieldtypes:url","com.atlassian.jira.plugin.system.customfieldtypes:userpicker","com.atlassian.jira.plugin.system.customfieldtypes:version"]},"searcherKey":{"type":"string","description":"The searcher defines the way the field is searched in Jira. For example, *com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher*.  \nThe search UI (basic search and JQL search) will display different operations and values for the field, based on the field searcher. You must specify a searcher that is valid for the field type, as listed below (abbreviated values shown):\n\n *  `cascadingselect`: `cascadingselectsearcher`\n *  `datepicker`: `daterange`\n *  `datetime`: `datetimerange`\n *  `float`: `exactnumber` or `numberrange`\n *  `grouppicker`: `grouppickersearcher`\n *  `importid`: `exactnumber` or `numberrange`\n *  `labels`: `labelsearcher`\n *  `multicheckboxes`: `multiselectsearcher`\n *  `multigrouppicker`: `multiselectsearcher`\n *  `multiselect`: `multiselectsearcher`\n *  `multiuserpicker`: `userpickergroupsearcher`\n *  `multiversion`: `versionsearcher`\n *  `project`: `projectsearcher`\n *  `radiobuttons`: `multiselectsearcher`\n *  `readonlyfield`: `textsearcher`\n *  `select`: `multiselectsearcher`\n *  `textarea`: `textsearcher`\n *  `textfield`: `textsearcher`\n *  `url`: `exacttextsearcher`\n *  `userpicker`: `userpickergroupsearcher`\n *  `version`: `versionsearcher`","enum":["com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher","com.atlassian.jira.plugin.system.customfieldtypes:daterange","com.atlassian.jira.plugin.system.customfieldtypes:datetimerange","com.atlassian.jira.plugin.system.customfieldtypes:exactnumber","com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher","com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher","com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher","com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher","com.atlassian.jira.plugin.system.customfieldtypes:numberrange","com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher","com.atlassian.jira.plugin.system.customfieldtypes:textsearcher","com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher","com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher"]}},"additionalProperties":false},"PageBeanUserKey":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/UserKey"}}},"additionalProperties":false,"description":"A page of items."},"MinimalIssueTypeOutput":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"avatarId":{"type":"integer","format":"int64"}},"additionalProperties":false},"Scope":{"type":"object","properties":{"type":{"type":"string","description":"The type of scope.","readOnly":true,"enum":["PROJECT","TEMPLATE"]},"project":{"description":"The project the entity has scope in.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/ProjectForScope"}]}},"additionalProperties":true,"description":"The scope of an entity. Indicated for entities associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO)."},"PermissionGrant":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the permission granted details.","format":"int64","readOnly":true},"self":{"type":"string","description":"The URL of the permission granted details.","format":"uri","readOnly":true},"holder":{"description":"The user or group being granted the permission. It consists of a `type` and a type-dependent `parameter`. See [Holder object](#holder-object) in *Get all permission schemes* for more information.","allOf":[{"$ref":"#/components/schemas/PermissionHolder"}]},"permission":{"type":"string","description":"The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. See [Built-in permissions](#built-in-permissions) in *Get all permission schemes* for more information about the built-in 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 about custom permissions."}},"additionalProperties":false,"description":"Details about a permission granted to a user or group."},"VersionUsageInCustomField":{"type":"object","properties":{"fieldName":{"type":"string","description":"The name of the custom field.","readOnly":true},"customFieldId":{"type":"integer","description":"The ID of the custom field.","format":"int64","readOnly":true},"issueCountWithVersionInCustomField":{"type":"integer","description":"Count of the issues where the custom field contains the version.","format":"int64","readOnly":true}},"additionalProperties":false,"description":"List of custom fields using the version."},"Filter":{"required":["name"],"type":"object","properties":{"self":{"type":"string","description":"The URL of the filter.","format":"uri","readOnly":true},"id":{"type":"string","description":"The unique identifier for the filter.","readOnly":true},"name":{"type":"string","description":"The name of the filter. Must be unique."},"description":{"type":"string","description":"A description of the filter."},"owner":{"description":"The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/User"}]},"jql":{"type":"string","description":"The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*."},"viewUrl":{"type":"string","description":"A URL to view the filter results in Jira, using the ID of the filter. For example, *https://your-domain.atlassian.net/issues/?filter=10100*.","format":"uri","readOnly":true},"searchUrl":{"type":"string","description":"A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-3-filter-search-get) operation with the filter's JQL string to return the filter results. For example, *https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*.","format":"uri","readOnly":true},"favourite":{"type":"boolean","description":"Indicates whether the filter is selected as a favorite."},"favouritedCount":{"type":"integer","description":"The count of how many users have selected this filter as a favorite, including the filter owner.","format":"int64","readOnly":true},"sharePermissions":{"type":"array","description":"The groups and projects that the filter is shared with.","items":{"$ref":"#/components/schemas/SharePermission"}},"sharedUsers":{"description":"A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserList"}]},"subscriptions":{"description":"A paginated list of the users that are subscribed to the filter.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/FilterSubscriptionsList"}]}},"additionalProperties":false,"description":"Details about a filter.","xml":{"name":"filter"}},"IssuesJqlMetaDataBean":{"required":["count","maxResults","startAt","totalCount"],"type":"object","properties":{"startAt":{"type":"integer","description":"The index of the first issue.","format":"int64"},"maxResults":{"type":"integer","description":"The maximum number of issues that could be loaded in this evaluation.","format":"int32"},"count":{"type":"integer","description":"The number of issues that were loaded in this evaluation.","format":"int32"},"totalCount":{"type":"integer","description":"The total number of issues the JQL returned.","format":"int64"},"validationWarnings":{"type":"array","description":"Any warnings related to the JQL query. Present only if the validation mode was set to `warn`.","items":{"type":"string"}}},"additionalProperties":false,"description":"The description of the page of issues loaded by the provided JQL query."},"CreatedIssues":{"type":"object","properties":{"issues":{"type":"array","description":"Details of the issues created.","readOnly":true,"items":{"$ref":"#/components/schemas/CreatedIssue"}},"errors":{"type":"array","description":"Error details for failed issue creation requests.","readOnly":true,"items":{"$ref":"#/components/schemas/BulkOperationErrorResult"}}},"additionalProperties":false,"description":"Details about the issues created and the errors for requests that failed."},"PageBeanWorkflowTransitionRules":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/WorkflowTransitionRules"}}},"additionalProperties":false,"description":"A page of items."},"VersionUnresolvedIssuesCount":{"type":"object","properties":{"self":{"type":"string","description":"The URL of these count details.","format":"uri","readOnly":true},"issuesUnresolvedCount":{"type":"integer","description":"Count of unresolved issues.","format":"int64","readOnly":true},"issuesCount":{"type":"integer","description":"Count of issues.","format":"int64","readOnly":true}},"additionalProperties":false,"description":"Count of a version's unresolved issues.","xml":{"name":"version"}},"PageBeanWorkflow":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/Workflow"}}},"additionalProperties":false,"description":"A page of items."},"WorklogIdsRequestBean":{"required":["ids"],"type":"object","properties":{"ids":{"uniqueItems":true,"type":"array","description":"A list of worklog IDs.","items":{"type":"integer","format":"int64"}}},"additionalProperties":false},"RemoteIssueLink":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the link.","format":"int64"},"self":{"type":"string","description":"The URL of the link.","format":"uri"},"globalId":{"type":"string","description":"The global ID of the link, such as the ID of the item on the remote system."},"application":{"description":"Details of the remote application the linked item is in.","allOf":[{"$ref":"#/components/schemas/Application"}]},"relationship":{"type":"string","description":"Description of the relationship between the issue and the linked item."},"object":{"description":"Details of the item linked to.","allOf":[{"$ref":"#/components/schemas/RemoteObject"}]}},"additionalProperties":false,"description":"Details of an issue remote link."},"ComponentIssuesCount":{"type":"object","properties":{"self":{"type":"string","description":"The URL for this count of issues for a component.","format":"uri","readOnly":true},"issueCount":{"type":"integer","description":"The count of issues assigned to a component.","format":"int64","readOnly":true}},"additionalProperties":false,"description":"Count of issues assigned to a component.","xml":{"name":"component"}},"IssueTypeCreateBean":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The unique name for the issue type. The maximum length is 60 characters. Required."},"description":{"type":"string","description":"The description of the issue type."},"type":{"type":"string","description":"Whether the issue type is `subtype` or `standard`. Defaults to `standard`.","enum":["subtask","standard"]}},"additionalProperties":false},"IssueFieldOptionScopeBean":{"type":"object","properties":{"projects":{"uniqueItems":true,"type":"array","description":"DEPRECATED","items":{"type":"integer","format":"int64"}},"projects2":{"uniqueItems":true,"type":"array","description":"Defines the projects in which the option is available and the behavior of the option within each project. Specify one object per project. The behavior of the option in a project context overrides the behavior in the global context.","items":{"$ref":"#/components/schemas/ProjectScopeBean"}},"global":{"description":"Defines the behavior of the option within the global context. If this property is set, even if set to an empty object, then the option is available in all projects.","allOf":[{"$ref":"#/components/schemas/GlobalScopeBean"}]}},"additionalProperties":false},"CreatedIssue":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the created issue or subtask.","readOnly":true},"key":{"type":"string","description":"The key of the created issue or subtask.","readOnly":true},"self":{"type":"string","description":"The URL of the created issue or subtask.","readOnly":true},"transition":{"description":"The response code and messages related to any requested transition.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/NestedResponse"}]}},"additionalProperties":false,"description":"Details about a created issue or subtask."},"ProjectInputBean":{"type":"object","properties":{"key":{"type":"string","description":"Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters. Required when creating a project. Optional when updating a project."},"name":{"type":"string","description":"The name of the project. Required when creating a project. Optional when updating a project."},"projectTypeKey":{"type":"string","description":"The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes), which dictates the application-specific feature set. Required when creating a project. Not applicable for the Update project resource.","enum":["software","service_desk","business"]},"projectTemplateKey":{"type":"string","description":"A prebuilt configuration for a project. The type of the `projectTemplateKey` must match with the type of the `projectTypeKey`. Required when creating a project. Not applicable for the Update project resource.","enum":["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","com.atlassian.servicedesk:simplified-it-service-desk","com.atlassian.servicedesk:simplified-internal-service-desk","com.atlassian.servicedesk:simplified-external-service-desk","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-","com.atlassian.jira.jira-incident-management-plugin:im-incident-management"]},"description":{"type":"string","description":"A brief description of the project."},"lead":{"type":"string","description":"This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The user name of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Optional when updating a project. Cannot be provided with `leadAccountId`."},"leadAccountId":{"type":"string","description":"The account id of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Optional when updating a project. Cannot be provided with `lead`."},"url":{"type":"string","description":"A link to information about this project, such as project documentation"},"assigneeType":{"type":"string","description":"The default assignee when creating issues for this project.","enum":["PROJECT_LEAD","UNASSIGNED"]},"avatarId":{"type":"integer","description":"An integer value for the project's avatar.","format":"int64"},"issueSecurityScheme":{"type":"integer","description":"The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) resource to get all issue security scheme IDs.","format":"int64"},"permissionScheme":{"type":"integer","description":"The ID of the permission scheme for the project. Use the [Get all permission schemes](#api-rest-api-3-permissionscheme-get) resource to see a list of all permission scheme IDs.","format":"int64"},"notificationScheme":{"type":"integer","description":"The ID of the notification scheme for the project. Use the [Get notification schemes](#api-rest-api-3-notificationscheme-get) resource to get a list of notification scheme IDs.","format":"int64"},"categoryId":{"type":"integer","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.","format":"int64"}},"additionalProperties":false},"ConnectModules":{"type":"object","additionalProperties":{"type":"array","description":"A list of modules by type.","items":{"$ref":"#/components/schemas/ConnectModule"}},"description":"A list of app modules in the same format as the `modules` property in the\n[app descriptor](https://developer.atlassian.com/cloud/jira/platform/app-descriptor/).","example":{"jiraEntityProperties":[{"keyConfigurations":[{"extractions":[{"objectName":"extension","type":"text","alias":"attachmentExtension"}],"propertyKey":"attachment"}],"entityType":"issue","name":{"value":"Attachment Index Document"},"key":"dynamic-attachment-entity-property"}],"jiraIssueFields":[{"description":{"value":"A dynamically added single-select field"},"type":"single_select","extractions":[{"path":"category","type":"text","name":"categoryName"}],"name":{"value":"Dynamic single select"},"key":"dynamic-select-field"}]}},"TaskProgressBeanRemoveOptionFromIssuesResult":{"required":["elapsedRuntime","id","lastUpdate","progress","self","status","submitted","submittedBy"],"type":"object","properties":{"self":{"type":"string","description":"The URL of the task.","format":"uri"},"id":{"type":"string","description":"The ID of the task."},"description":{"type":"string","description":"The description of the task."},"status":{"type":"string","description":"The status of the task.","enum":["ENQUEUED","RUNNING","COMPLETE","FAILED","CANCEL_REQUESTED","CANCELLED","DEAD"]},"message":{"type":"string","description":"Information about the progress of the task."},"result":{"description":"The result of the task execution.","allOf":[{"$ref":"#/components/schemas/RemoveOptionFromIssuesResult"}]},"submittedBy":{"type":"integer","description":"The ID of the user who submitted the task.","format":"int64"},"progress":{"type":"integer","description":"The progress of the task, as a percentage complete.","format":"int64"},"elapsedRuntime":{"type":"integer","description":"The execution time of the task, in milliseconds.","format":"int64"},"submitted":{"type":"integer","description":"A timestamp recording when the task was submitted.","format":"int64"},"started":{"type":"integer","description":"A timestamp recording when the task was started.","format":"int64"},"finished":{"type":"integer","description":"A timestamp recording when the task was finished.","format":"int64"},"lastUpdate":{"type":"integer","description":"A timestamp recording when the task progress was last updated.","format":"int64"}},"additionalProperties":false,"description":"Details about a task."},"JqlQueryFieldEntityProperty":{"required":["entity","key","path"],"type":"object","properties":{"entity":{"type":"string","description":"The object on which the property is set.","example":"issue"},"key":{"type":"string","description":"The key of the property.","example":"stats"},"path":{"type":"string","description":"The path in the property value to query.","example":"comments.count"},"type":{"type":"string","description":"The type of the property value extraction. Not available if the extraction for the property is not registered on the instance with the [Entity property](https://developer.atlassian.com/cloud/jira/platform/modules/entity-property/) module.","example":"number","enum":["number","string","text","date","user"]}},"description":"Details of an entity property."},"FilterSubscriptionsList":{"type":"object","properties":{"size":{"type":"integer","description":"The number of items on the page.","format":"int32","readOnly":true,"xml":{"attribute":true}},"items":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/FilterSubscription"}},"max-results":{"type":"integer","description":"The maximum number of results that could be on the page.","format":"int32","readOnly":true,"xml":{"name":"max-results","attribute":true}},"start-index":{"type":"integer","description":"The index of the first item returned on the page.","format":"int32","readOnly":true,"xml":{"name":"start-index","attribute":true}},"end-index":{"type":"integer","description":"The index of the last item returned on the page.","format":"int32","readOnly":true,"xml":{"name":"end-index","attribute":true}}},"additionalProperties":false,"description":"A paginated list of subscriptions to a filter."},"RichText":{"type":"object","properties":{"emptyAdf":{"type":"boolean"},"valueSet":{"type":"boolean"}}},"RemoveOptionFromIssuesResult":{"type":"object","properties":{"modifiedIssues":{"type":"array","description":"The IDs of the modified issues.","items":{"type":"integer","format":"int64"}},"unmodifiedIssues":{"type":"array","description":"The IDs of the unchanged issues, those issues where errors prevent modification.","items":{"type":"integer","format":"int64"}},"errors":{"description":"A collection of errors related to unchanged issues. The collection size is limited, which means not all errors may be returned.","allOf":[{"$ref":"#/components/schemas/SimpleErrorCollection"}]}},"additionalProperties":false},"IssueTypeBean":{"type":"object","properties":{"self":{"type":"string","description":"The URL of these issue type details.","readOnly":true},"id":{"type":"string","description":"The ID of the issue type.","readOnly":true},"description":{"type":"string","description":"The description of the issue type.","readOnly":true},"iconUrl":{"type":"string","description":"The URL of the issue type's avatar.","readOnly":true},"name":{"type":"string","description":"The name of the issue type.","readOnly":true},"subtask":{"type":"boolean","description":"Indicates whether this issue type is used to create subtasks.","readOnly":true},"avatarId":{"type":"integer","description":"The ID of the issue type's avatar.","format":"int64","readOnly":true},"entityId":{"type":"string","description":"project unique ID for next-gen entities","format":"uuid","readOnly":true},"scope":{"description":"Details of the next-gen projects the issue type is available in.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/Scope"}]}},"additionalProperties":false,"description":"Details about an issue type."},"AttachmentArchiveMetadataReadable":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the attachment.","format":"int64","readOnly":true},"name":{"type":"string","description":"The name of the archive file.","readOnly":true},"entries":{"type":"array","description":"The list of the items included in the archive.","readOnly":true,"items":{"$ref":"#/components/schemas/AttachmentArchiveItemReadable"}},"totalEntryCount":{"type":"integer","description":"The number of items included in the archive.","format":"int64","readOnly":true},"mediaType":{"type":"string","description":"The MIME type of the attachment.","readOnly":true}},"additionalProperties":false,"description":"Metadata for an archive (for example a zip) and its contents."},"Operations":{"type":"object","properties":{"linkGroups":{"type":"array","description":"Details of the link groups defining issue operations.","readOnly":true,"items":{"$ref":"#/components/schemas/LinkGroup"}}},"additionalProperties":true,"description":"Details of the operations that can be performed on the issue."},"ProjectForScope":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the project details.","readOnly":true},"id":{"type":"string","description":"The ID of the project."},"key":{"type":"string","description":"The key of the project.","readOnly":true},"name":{"type":"string","description":"The name of the project.","readOnly":true},"projectTypeKey":{"type":"string","description":"The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.","readOnly":true,"enum":["software","service_desk","business"]},"simplified":{"type":"boolean","description":"Whether or not the project is simplified.","readOnly":true},"avatarUrls":{"description":"The URLs of the project's avatars.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/AvatarUrlsBean"}]},"projectCategory":{"description":"The category the project belongs to.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/UpdatedProjectCategory"}]}},"additionalProperties":false,"description":"Details about a next-gen project."},"HistoryMetadataParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the user or system associated with a history record."},"displayName":{"type":"string","description":"The display name of the user or system associated with a history record."},"displayNameKey":{"type":"string","description":"The key of the display name of the user or system associated with a history record."},"type":{"type":"string","description":"The type of the user or system associated with a history record."},"avatarUrl":{"type":"string","description":"The URL to an avatar for the user or system associated with a history record."},"url":{"type":"string","description":"The URL of the user or system associated with a history record."}},"additionalProperties":true,"description":"Details of user or system associated with a issue history metadata item."},"ParsedJqlQuery":{"minLength":1,"required":["query"],"type":"object","properties":{"query":{"type":"string","description":"The JQL query that was parsed and validated."},"structure":{"description":"The syntax tree of the query. Empty if the query was invalid.","allOf":[{"$ref":"#/components/schemas/JqlQuery"}]},"errors":{"uniqueItems":true,"type":"array","description":"The list of syntax or validation errors.","items":{"type":"string"}}},"additionalProperties":false,"description":"Details of a parsed JQL query."},"ProjectCategory":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the project category.","format":"uri","readOnly":true},"id":{"type":"string","description":"The ID of the project category.","readOnly":true},"name":{"type":"string","description":"The name of the project category. Required on create, optional on update."},"description":{"type":"string","description":"The description of the project category. Required on create, optional on update."}},"additionalProperties":false,"description":"A project category."},"AttachmentMetadata":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the attachment.","format":"int64","readOnly":true},"self":{"type":"string","description":"The URL of the attachment metadata details.","format":"uri","readOnly":true},"filename":{"type":"string","description":"The name of the attachment file.","readOnly":true},"author":{"description":"Details of the user who attached the file.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/User"}]},"created":{"type":"string","description":"The datetime the attachment was created.","format":"date-time","readOnly":true},"size":{"type":"integer","description":"The size of the attachment.","format":"int64","readOnly":true},"mimeType":{"type":"string","description":"The MIME type of the attachment.","readOnly":true},"properties":{"type":"object","additionalProperties":{"readOnly":true},"description":"Additional properties of the attachment.","readOnly":true},"content":{"type":"string","description":"The URL of the attachment.","readOnly":true},"thumbnail":{"type":"string","description":"The URL of a thumbnail representing the attachment.","readOnly":true}},"additionalProperties":false,"description":"Metadata for an issue attachment.","xml":{"name":"attachment"}},"PageBeanFoundFilter":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/FoundFilter"}}},"additionalProperties":false,"description":"A page of items."},"SuggestedIssue":{"type":"object","properties":{"id":{"type":"integer","description":"The id of the issue.","format":"int64","readOnly":true},"key":{"type":"string","description":"The key of the issue.","readOnly":true},"keyHtml":{"type":"string","description":"The key of the issue in HTML format.","readOnly":true},"img":{"type":"string","description":"The URL of the issue type's avatar.","readOnly":true},"summary":{"type":"string","description":"The phrase containing the query string in HTML format, with the string highlighted with HTML bold tags.","readOnly":true},"summaryText":{"type":"string","description":"The phrase containing the query string, as plain text.","readOnly":true}},"additionalProperties":false,"description":"An issue suggested for use in the issue picker auto-completion."},"AuditRecords":{"type":"object","properties":{"offset":{"type":"integer","description":"The number of audit items skipped before the first item in this list.","format":"int32","readOnly":true},"limit":{"type":"integer","description":"The requested or default limit on the number of audit items to be returned.","format":"int32","readOnly":true},"total":{"type":"integer","description":"The total number of audit items returned.","format":"int64","readOnly":true},"records":{"type":"array","description":"The list of audit items.","readOnly":true,"items":{"$ref":"#/components/schemas/AuditRecordBean"}}},"additionalProperties":false,"description":"Container for a list of audit records."},"PermissionGrants":{"type":"object","properties":{"permissions":{"type":"array","description":"Permission grants list.","readOnly":true,"items":{"$ref":"#/components/schemas/PermissionGrant"}},"expand":{"type":"string","description":"Expand options that include additional permission grant details in the response.","readOnly":true}},"additionalProperties":false,"description":"List of permission grants."},"ProjectIssueCreateMetadata":{"type":"object","properties":{"expand":{"type":"string","description":"Expand options that include additional project issue create metadata details in the response.","readOnly":true,"xml":{"attribute":true}},"self":{"type":"string","description":"The URL of the project.","readOnly":true},"id":{"type":"string","description":"The ID of the project.","readOnly":true},"key":{"type":"string","description":"The key of the project.","readOnly":true},"name":{"type":"string","description":"The name of the project.","readOnly":true},"avatarUrls":{"description":"List of the project's avatars, returning the avatar size and associated URL.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/AvatarUrlsBean"}]},"issuetypes":{"type":"array","description":"List of the issue types supported by the project.","readOnly":true,"items":{"$ref":"#/components/schemas/IssueTypeIssueCreateMetadata"}}},"additionalProperties":false,"description":"Details of the issue creation metadata for a project."},"HierarchyLevelOutput":{"type":"object","properties":{"entityId":{"type":"string","format":"uuid"},"level":{"type":"integer","format":"int32"},"name":{"type":"string"},"issueTypes":{"type":"array","items":{"$ref":"#/components/schemas/MinimalIssueTypeOutput"}}},"additionalProperties":false},"PageBeanChangelog":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/Changelog"}}},"additionalProperties":false,"description":"A page of items."},"RoleActor":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"displayName":{"type":"string","description":"The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.","readOnly":true},"type":{"type":"string"},"name":{"type":"string","description":"This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.","readOnly":true},"avatarUrl":{"type":"string","format":"uri"},"actorUser":{"$ref":"#/components/schemas/ProjectRoleUserBean"},"actorGroup":{"$ref":"#/components/schemas/ProjectRoleGroupBean"},"user":{"type":"string"}},"additionalProperties":false,"description":"Details about a user assigned to a project role.","xml":{"name":"projectRoleActor"}},"UnrestrictedUserEmail":{"type":"object","properties":{"accountId":{"type":"string","description":"The accountId of the user"},"email":{"type":"string","description":"The email of the user"}},"additionalProperties":false},"FieldChangedClause":{"required":["field","operator","predicates"],"type":"object","properties":{"field":{"$ref":"#/components/schemas/JqlQueryField"},"operator":{"type":"string","description":"The operator applied to the field.","enum":["changed"]},"predicates":{"type":"array","description":"The list of time predicates.","items":{"$ref":"#/components/schemas/JqlQueryClauseTimePredicate"}}},"description":"A clause that asserts whether a field was changed. For example, `status CHANGED AFTER startOfMonth(-1M)`.See [CHANGED](https://confluence.atlassian.com/x/dgiiLQ#Advancedsearching-operatorsreference-CHANGEDCHANGED) for more information about the CHANGED operator."},"IssuesUpdateBean":{"type":"object","properties":{"issueUpdates":{"type":"array","items":{"$ref":"#/components/schemas/IssueUpdateDetails"}}},"additionalProperties":true},"ProjectPermissions":{"type":"object","properties":{"canEdit":{"type":"boolean","description":"Indicates whether the logged user can edit the project.","readOnly":true}},"additionalProperties":false,"description":"Permissions which a user has on a project."},"AttachmentArchiveItemReadable":{"type":"object","properties":{"path":{"type":"string","description":"The path of the archive item.","readOnly":true},"index":{"type":"integer","description":"The position of the item within the archive.","format":"int64","readOnly":true},"size":{"type":"string","description":"The size of the archive item.","readOnly":true},"mediaType":{"type":"string","description":"The MIME type of the archive item.","readOnly":true},"label":{"type":"string","description":"The label for the archive item.","readOnly":true}},"additionalProperties":false,"description":"Metadata for an item in an attachment archive."},"AttachmentArchiveImpl":{"type":"object","properties":{"entries":{"type":"array","description":"The list of the items included in the archive.","items":{"$ref":"#/components/schemas/AttachmentArchiveEntry"}},"totalEntryCount":{"type":"integer","description":"The number of items in the archive.","format":"int32"}},"additionalProperties":false},"ComponentWithIssueCount":{"type":"object","properties":{"issueCount":{"type":"integer","description":"Count of issues for the component.","format":"int64","readOnly":true},"description":{"type":"string","description":"The description for the component.","readOnly":true},"self":{"type":"string","description":"The URL for this count of the issues contained in the component.","format":"uri","readOnly":true},"project":{"type":"string","description":"The key of the project to which the component is assigned.","readOnly":true},"assigneeType":{"type":"string","description":"The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Takes the following values:\n\n *  `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n *  `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n *  `UNASSIGNED` an assignee is not set for issues created with this component.\n *  `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.","readOnly":true,"enum":["PROJECT_DEFAULT","COMPONENT_LEAD","PROJECT_LEAD","UNASSIGNED"]},"lead":{"description":"The user details for the component's lead user.","allOf":[{"$ref":"#/components/schemas/User"}]},"projectId":{"type":"integer","description":"Not used.","format":"int64","readOnly":true},"realAssignee":{"description":"The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee.","allOf":[{"$ref":"#/components/schemas/User"}]},"isAssigneeTypeValid":{"type":"boolean","description":"Indicates whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.","readOnly":true},"assignee":{"description":"The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.","allOf":[{"$ref":"#/components/schemas/User"}]},"realAssigneeType":{"type":"string","description":"The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n *  `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n *  `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n *  `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n *  `PROJECT_DEFAULT` when none of the preceding cases are true.","readOnly":true,"enum":["PROJECT_DEFAULT","COMPONENT_LEAD","PROJECT_LEAD","UNASSIGNED"]},"name":{"type":"string","description":"The name for the component.","readOnly":true},"id":{"type":"string","description":"The unique identifier for the component.","readOnly":true}},"additionalProperties":false,"description":"Details about a component with a count of the issues it contains."},"Application":{"type":"object","properties":{"type":{"type":"string","description":"The name-spaced type of the application, used by registered rendering apps."},"name":{"type":"string","description":"The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\". Grouping and sorting of links may place links without an application name last."}},"additionalProperties":true,"description":"The application the linked item is in."},"ProjectScopeBean":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the project that the option's behavior applies to.","format":"int64"},"attributes":{"uniqueItems":true,"type":"array","description":"Defines the behavior of the option in the project.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default.","items":{"type":"string","enum":["notSelectable","defaultValue"]}}},"additionalProperties":false},"Avatars":{"type":"object","properties":{"system":{"type":"array","description":"System avatars list.","readOnly":true,"items":{"$ref":"#/components/schemas/Avatar"}},"custom":{"type":"array","description":"Custom avatars list.","readOnly":true,"items":{"$ref":"#/components/schemas/Avatar"}}},"additionalProperties":false,"description":"Details about system and custom avatars."},"NotificationScheme":{"type":"object","properties":{"expand":{"type":"string","description":"Expand options that include additional notification scheme details in the response."},"id":{"type":"integer","description":"The ID of the notification scheme.","format":"int64"},"self":{"type":"string"},"name":{"type":"string","description":"The name of the notification scheme."},"description":{"type":"string","description":"The description of the notification scheme."},"notificationSchemeEvents":{"type":"array","description":"The notification events and associated recipients.","items":{"$ref":"#/components/schemas/NotificationSchemeEvent"}},"scope":{"description":"The scope of the notification scheme.","allOf":[{"$ref":"#/components/schemas/Scope"}]}},"additionalProperties":false,"description":"Details about a notification scheme."},"UserBeanAvatarUrls":{"type":"object","properties":{"16x16":{"type":"string","description":"The URL of the user's 16x16 pixel avatar.","format":"uri"},"24x24":{"type":"string","description":"The URL of the user's 24x24 pixel avatar.","format":"uri"},"32x32":{"type":"string","description":"The URL of the user's 32x32 pixel avatar.","format":"uri"},"48x48":{"type":"string","description":"The URL of the user's 48x48 pixel avatar.","format":"uri"}},"additionalProperties":false},"UserPickerUser":{"type":"object","properties":{"accountId":{"type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*."},"name":{"type":"string","description":"This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."},"key":{"type":"string","description":"This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."},"html":{"type":"string","description":"The display name, email address, and key of the user with the matched query string highlighted with the HTML bold tag."},"displayName":{"type":"string","description":"The display name of the user. Depending on the user\u2019s privacy setting, this may be returned as null."},"avatarUrl":{"type":"string","description":"The avatar URL of the user.","format":"uri"}},"additionalProperties":false,"description":"A user found in a search."},"UserMigrationBean":{"type":"object","properties":{"key":{"type":"string"},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"EntityProperty":{"type":"object","properties":{"key":{"type":"string","description":"The key of the property. Required on create and update."},"value":{"description":"The value of the property. Required on create and update."}},"additionalProperties":false,"description":"An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)."},"TimeTrackingConfiguration":{"required":["defaultUnit","timeFormat","workingDaysPerWeek","workingHoursPerDay"],"type":"object","properties":{"workingHoursPerDay":{"type":"number","description":"The number of hours in a working day.","format":"double"},"workingDaysPerWeek":{"type":"number","description":"The number of days in a working week.","format":"double"},"timeFormat":{"type":"string","description":"The format that will appear on an issue's *Time Spent* field.","enum":["pretty","days","hours"]},"defaultUnit":{"type":"string","description":"The default unit of time applied to logged time.","enum":["minute","hour","day","week"]}},"additionalProperties":false,"description":"Details of the time tracking configuration."},"IssuesMetaBean":{"type":"object","properties":{"jql":{"$ref":"#/components/schemas/IssuesJqlMetaDataBean"}},"additionalProperties":false,"description":"Meta data describing the `issues` context variable."},"JQLQueryWithUnknownUsers":{"type":"object","properties":{"originalQuery":{"type":"string","description":"The original query, for reference"},"convertedQuery":{"type":"string","description":"The converted query, with accountIDs instead of user identifiers, or 'unknown' for users that could not be found"}},"additionalProperties":false,"description":"JQL queries that contained users that could not be found"},"AttachmentArchiveEntry":{"type":"object","properties":{"entryIndex":{"type":"integer","format":"int64"},"abbreviatedName":{"type":"string"},"mediaType":{"type":"string"},"name":{"type":"string"},"size":{"type":"integer","format":"int64"}},"additionalProperties":false},"PageBeanNotificationScheme":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/NotificationScheme"}}},"additionalProperties":false,"description":"A page of items."},"ProjectIdentifierBean":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the project.","format":"int64","readOnly":true},"key":{"type":"string","description":"The key of the project.","readOnly":true}},"additionalProperties":false,"description":"The identifiers for a project."},"JqlQueryClauseOperand":{"type":"object","description":"Details of an operand in a JQL clause.","anyOf":[{"$ref":"#/components/schemas/ListOperand"},{"$ref":"#/components/schemas/ValueOperand"},{"$ref":"#/components/schemas/FunctionOperand"},{"$ref":"#/components/schemas/KeywordOperand"}]},"FilterSubscription":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the filter subscription.","format":"int64","readOnly":true},"user":{"description":"The user subscribing to filter.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/User"}]},"group":{"description":"The group subscribing to filter.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/GroupName"}]}},"additionalProperties":false,"description":"Details of a user or group subscribing to a filter."},"JiraExpressionEvalRequestBean":{"required":["expression"],"type":"object","properties":{"expression":{"type":"string","description":"The Jira expression to evaluate.","example":"{ key: issue.key, type: issue.issueType.name, links: issue.links.map(link => link.linkedIssue.id) }"},"context":{"description":"The context in which the Jira expression is evaluated.","allOf":[{"$ref":"#/components/schemas/JiraExpressionEvalContextBean"}]}},"additionalProperties":false},"Changelog":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the changelog.","readOnly":true},"author":{"description":"The user who made the change.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserDetails"}]},"created":{"type":"string","description":"The date on which the change took place.","format":"date-time","readOnly":true},"items":{"type":"array","description":"The list of items changed.","readOnly":true,"items":{"$ref":"#/components/schemas/ChangeDetails"}},"historyMetadata":{"description":"The history metadata associated with the changed.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/HistoryMetadata"}]}},"additionalProperties":false,"description":"A changelog."},"FieldDeprecated":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the field."},"key":{"type":"string","description":"The key of the field."},"name":{"type":"string","description":"The name of the field."},"custom":{"type":"boolean","description":"Indicates whether the field is a custom field."},"orderable":{"type":"boolean","description":"Indicates whether the content of the field can be used to order lists."},"navigable":{"type":"boolean","description":"Indicates whether the field can be used as a column on the issue navigator."},"searchable":{"type":"boolean","description":"Indicates whether the content of the field can be searched."},"clauseNames":{"uniqueItems":true,"type":"array","description":"The names that can be used to reference the field in an advanced search. For more information, see [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ).","items":{"type":"string"}},"scope":{"description":"The scope of the field.","allOf":[{"$ref":"#/components/schemas/Scope"}]},"schema":{"description":"The data schema for the field.","allOf":[{"$ref":"#/components/schemas/JsonTypeBean"}]}},"additionalProperties":false,"description":"Details about a field. This object has been deprecated. See [Get Fields Paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-field-search-get) to obtain details about fields.","xml":{"name":"field"}},"SharePermissionInputBean":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The type of the share permission.Specify the type as follows:\n\n *  `group` Share with a group. Specify `groupname` as well.\n *  `project` Share with a project. Specify `projectId` as well.\n *  `projectRole` Share with a project role in a project. Specify `projectId` and `projectRoleId` as well.\n *  `global` Share globally, including anonymous users. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.\n *  `authenticated` Share with all logged-in users. This shows as `loggedin` in the response. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.","enum":["project","group","projectRole","global","authenticated"]},"projectId":{"type":"string","description":"The ID of the project to share the filter with. Set `type` to `project`."},"groupname":{"type":"string","description":"The name of the group to share the filter with. Set `type` to `group`."},"projectRoleId":{"type":"string","description":"The ID of the project role to share the filter with. Set `type` to `projectRole` and the `projectId` for the project that the role is in."}},"additionalProperties":false},"TimeTrackingProvider":{"required":["key"],"type":"object","properties":{"key":{"type":"string","description":"The key for the time tracking provider. For example, *JIRA*."},"name":{"type":"string","description":"The name of the time tracking provider. For example, *JIRA provided time tracking*."},"url":{"type":"string","description":"The URL of the configuration page for the time tracking provider app. For example, */example/config/url*. This property is only returned if the `adminPageKey` property is set in the module descriptor of the time tracking provider app.","readOnly":true}},"additionalProperties":false,"description":"Details about the time tracking provider."},"PageBeanDashboard":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/Dashboard"}}},"additionalProperties":false,"description":"A page of items."},"GlobalScopeBean":{"type":"object","properties":{"attributes":{"uniqueItems":true,"type":"array","description":"Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default.","items":{"type":"string","enum":["notSelectable","defaultValue"]}}},"additionalProperties":false},"FoundGroup":{"type":"object","properties":{"name":{"type":"string","description":"The name of the group."},"html":{"type":"string","description":"The group name with the matched query string highlighted with the HTML bold tag."},"labels":{"type":"array","items":{"$ref":"#/components/schemas/GroupLabel"}}},"additionalProperties":false,"description":"A group found in a search.","xml":{"name":"group"}},"IssueTransition":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the issue transition. Required when specifying a transition to undertake."},"name":{"type":"string","description":"The name of the issue transition.","readOnly":true},"to":{"description":"Details of the issue status after the transition.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/StatusDetails"}]},"hasScreen":{"type":"boolean","description":"Indicates whether there is a screen associated with the issue transition.","readOnly":true},"isGlobal":{"type":"boolean","description":"Indicates whether the issue transition is global, that is, the transition is applied to issues regardless of their status.","readOnly":true},"isInitial":{"type":"boolean","description":"Indicates whether this is the initial issue transition for the workflow.","readOnly":true},"isConditional":{"type":"boolean","description":"Indicates whether the issue has to meet certain criteria before the issue transition is applied.","readOnly":true},"fields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/FieldMetadata"},"description":"Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request.","readOnly":true},"expand":{"type":"string","description":"Expand options that include additional transition details in the response.","readOnly":true}},"additionalProperties":true,"description":"Details of an issue transition."},"HealthCheckResult":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Jira health check item."},"description":{"type":"string","description":"The description of the Jira health check item."},"passed":{"type":"boolean","description":"Indicates whether the Jira health check item passed or failed."}},"additionalProperties":false,"description":"Jira instance health check results. Deprecated and no longer returned."},"JiraExpressionResult":{"required":["value"],"type":"object","properties":{"value":{"description":"The value of the evaluated expression. It may be a primitive JSON value or a Jira REST API object. (Some expressions do not produce any meaningful results\u2014for example, an expression that returns a lambda function\u2014if that's the case a simple string representation is returned. These string representations should not be relied upon and may change without notice.)"},"meta":{"description":"Contains various characteristics of the performed expression evaluation.","allOf":[{"$ref":"#/components/schemas/JiraExpressionEvaluationMetaDataBean"}]}},"additionalProperties":false,"description":"The result of evaluating a Jira expression."},"WorkflowStatus":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the issue status."},"name":{"type":"string","description":"The name of the status in the workflow."},"properties":{"$ref":"#/components/schemas/WorkflowStatusProperties"}},"additionalProperties":false,"description":"Details of a workflow status."},"PageOfComments":{"type":"object","properties":{"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"comments":{"type":"array","description":"The list of comments.","readOnly":true,"items":{"$ref":"#/components/schemas/Comment"}}},"additionalProperties":true,"description":"A page of comments."},"BulkPermissionGrants":{"required":["globalPermissions","projectPermissions"],"type":"object","properties":{"projectPermissions":{"uniqueItems":true,"type":"array","description":"List of project permissions and the projects and issues those permissions provide access to.","items":{"$ref":"#/components/schemas/BulkProjectPermissionGrants"}},"globalPermissions":{"uniqueItems":true,"type":"array","description":"List of permissions granted to the user.","items":{"type":"string"}}},"additionalProperties":false,"description":"Details of global and project permissions granted to the user."},"WorkflowTransitionRules":{"type":"object","properties":{"workflowId":{"$ref":"#/components/schemas/WorkflowId"},"postFunctions":{"type":"array","description":"The list of post functions within the workflow.","items":{"$ref":"#/components/schemas/ConnectWorkflowTransitionRule"}},"conditions":{"type":"array","description":"The list of conditions within the workflow.","items":{"$ref":"#/components/schemas/ConnectWorkflowTransitionRule"}},"validators":{"type":"array","description":"The list of validators within the workflow.","items":{"$ref":"#/components/schemas/ConnectWorkflowTransitionRule"}}},"additionalProperties":false,"description":"A workflow with transition rules."},"Transition":{"required":["description","from","id","name","to","type"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the transition."},"name":{"type":"string","description":"The name of the transition."},"description":{"type":"string","description":"The description of the transition."},"from":{"type":"array","description":"The list of statuses from which the transition can be taken.","items":{"type":"string","description":"The list of statuses from which the transition can be taken."}},"to":{"type":"string","description":"The status to which the transition leads."},"type":{"type":"string","description":"The type of the transition.","enum":["global","initial","directed"]},"screen":{"$ref":"#/components/schemas/ScreenID"},"rules":{"$ref":"#/components/schemas/WorkflowRules"}},"additionalProperties":false,"description":"Details of a workflow transition."},"UpdatedProjectCategory":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the project category.","readOnly":true},"id":{"type":"string","description":"The ID of the project category.","readOnly":true},"description":{"type":"string","description":"The name of the project category.","readOnly":true},"name":{"type":"string","description":"The description of the project category.","readOnly":true}},"additionalProperties":false,"description":"A project category."},"WorkflowTransitionRulesUpdateErrors":{"required":["updateResults"],"type":"object","properties":{"updateResults":{"type":"array","description":"A list of workflows.","items":{"$ref":"#/components/schemas/WorkflowTransitionRulesUpdateErrorDetails"}}},"additionalProperties":false,"description":"Details of any errors encountered while updating workflow transition rules."},"ScreenableField":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the screen tab field.","readOnly":true},"name":{"type":"string","description":"The name of the screen tab field. Required on create and update. The maximum length is 255 characters."}},"additionalProperties":false,"description":"A screen tab field."},"ErrorMessage":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"The error message."}},"additionalProperties":false,"example":{"message":"The request is not from a Connect app."}},"NotificationSchemeEvent":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/NotificationEvent"},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/EventNotification"}}},"additionalProperties":false,"description":"Details about a notification scheme event."},"AutoCompleteSuggestion":{"type":"object","properties":{"value":{"type":"string","description":"The value of a suggested item."},"displayName":{"type":"string","description":"The display name of a suggested item. If `fieldValue` or `predicateValue` are provided, the matching text is highlighted with the HTML bold tag."}},"additionalProperties":false,"description":"A field auto-complete suggestion."},"Locale":{"type":"object","properties":{"locale":{"type":"string","description":"The locale code. The Java the locale format is used: a two character language code (ISO 639), an underscore, and two letter country code (ISO 3166). For example, en\\_US represents a locale of English (United States). Required on create."}},"additionalProperties":false,"description":"Details of a locale."},"ContainerForRegisteredWebhooks":{"type":"object","properties":{"webhookRegistrationResult":{"type":"array","description":"A list of registered webhooks.","items":{"$ref":"#/components/schemas/RegisteredWebhook"}}},"additionalProperties":false,"description":"Container for a list of registered webhooks. Webhook details are returned in the same order as the request."},"UpdateUserToGroupBean":{"type":"object","properties":{"name":{"type":"string","description":"This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."},"accountId":{"type":"string","description":"The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*."}},"additionalProperties":true},"ConvertedJQLQueries":{"type":"object","properties":{"queryStrings":{"type":"array","description":"The list of converted query strings with account IDs in place of user identifiers.","items":{"type":"string"}},"queriesWithUnknownUsers":{"type":"array","description":"List of queries containing user information that could not be mapped to an existing user","items":{"$ref":"#/components/schemas/JQLQueryWithUnknownUsers"}}},"additionalProperties":false,"description":"The converted JQL queries."},"WorkflowTransitionProperty":{"required":["value"],"type":"object","properties":{"key":{"type":"string","description":"The key of the transition property. Also known as the name of the transition property.","readOnly":true},"value":{"type":"string","description":"The value of the transition property."},"id":{"type":"string","description":"The ID of the transition property.","readOnly":true}},"additionalProperties":true,"description":"Details about the server Jira is running on."},"HistoryMetadata":{"type":"object","properties":{"type":{"type":"string","description":"The type of the history record."},"description":{"type":"string","description":"The description of the history record."},"descriptionKey":{"type":"string","description":"The description key of the history record."},"activityDescription":{"type":"string","description":"The activity described in the history record."},"activityDescriptionKey":{"type":"string","description":"The key of the activity described in the history record."},"emailDescription":{"type":"string","description":"The description of the email address associated the history record."},"emailDescriptionKey":{"type":"string","description":"The description key of the email address associated the history record."},"actor":{"description":"Details of the user whose action created the history record.","allOf":[{"$ref":"#/components/schemas/HistoryMetadataParticipant"}]},"generator":{"description":"Details of the system that generated the history record.","allOf":[{"$ref":"#/components/schemas/HistoryMetadataParticipant"}]},"cause":{"description":"Details of the cause that triggered the creation the history record.","allOf":[{"$ref":"#/components/schemas/HistoryMetadataParticipant"}]},"extraData":{"type":"object","additionalProperties":{"type":"string"},"description":"Additional arbitrary information about the history record."}},"additionalProperties":true,"description":"Details of issue history metadata."},"PageBeanComment":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/Comment"}}},"additionalProperties":false,"description":"A page of items."},"ListWrapperCallbackApplicationRole":{"type":"object","additionalProperties":false},"JQLPersonalDataMigrationRequest":{"type":"object","properties":{"queryStrings":{"type":"array","description":"A list of queries with user identifiers. Maximum of 100 queries.","items":{"type":"string"}}},"additionalProperties":false,"description":"The JQL queries to be converted."},"IssueTypesWorkflowMapping":{"type":"object","properties":{"workflow":{"type":"string","description":"The name of the workflow. Optional if updating the workflow-issue types mapping."},"issueTypes":{"type":"array","description":"The list of issue type IDs.","items":{"type":"string"}},"defaultMapping":{"type":"boolean","description":"Indicates whether the workflow is the default workflow for the workflow scheme."},"updateDraftIfNeeded":{"type":"boolean","description":"Indicates whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new workflow-issue types mapping. Defaults to `false`."}},"additionalProperties":false,"description":"Details about the mapping between issue types and a workflow."},"PageBeanField":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/Field"}}},"additionalProperties":false,"description":"A page of items."},"AttachmentSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the ability to add attachments is enabled.","readOnly":true},"uploadLimit":{"type":"integer","description":"The maximum size of attachments permitted, in bytes.","format":"int64","readOnly":true}},"additionalProperties":false,"description":"Details of the instance's attachment settings."},"JiraExpressionsComplexityBean":{"type":"object","properties":{"steps":{"description":"The number of steps it took to evaluate the expression.","allOf":[{"$ref":"#/components/schemas/JiraExpressionsComplexityValueBean"}]},"expensiveOperations":{"description":"The number of expensive operations executed while evaluating the expression. Expensive operations are those that load additional data, such as entity properties, comments, or custom fields.","allOf":[{"$ref":"#/components/schemas/JiraExpressionsComplexityValueBean"}]},"beans":{"description":"The number of Jira REST API beans returned in the response.","allOf":[{"$ref":"#/components/schemas/JiraExpressionsComplexityValueBean"}]},"primitiveValues":{"description":"The number of primitive values returned in the response.","allOf":[{"$ref":"#/components/schemas/JiraExpressionsComplexityValueBean"}]}},"additionalProperties":false},"Hierarchy":{"type":"object","properties":{"level":{"type":"array","items":{"$ref":"#/components/schemas/HierarchyLevel"}}},"additionalProperties":false,"description":"Project Issue Type Hierarchy","xml":{"name":"hierarchy"}},"UserDetails":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the user.","readOnly":true},"name":{"type":"string","description":"This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.","readOnly":true},"key":{"type":"string","description":"This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.","readOnly":true},"accountId":{"type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*."},"emailAddress":{"type":"string","description":"The email address of the user. Depending on the user\u2019s privacy settings, this may be returned as null.","readOnly":true},"avatarUrls":{"description":"The avatars of the user.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/AvatarUrlsBean"}]},"displayName":{"type":"string","description":"The display name of the user. Depending on the user\u2019s privacy settings, this may return an alternative value.","readOnly":true},"active":{"type":"boolean","description":"Whether the user is active.","readOnly":true},"timeZone":{"type":"string","description":"The time zone specified in the user's profile. Depending on the user\u2019s privacy settings, this may be returned as null.","readOnly":true},"accountType":{"type":"string","description":"The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)","readOnly":true}},"additionalProperties":false,"description":"User details."},"SimpleLink":{"type":"object","properties":{"id":{"type":"string"},"styleClass":{"type":"string"},"iconClass":{"type":"string"},"label":{"type":"string"},"title":{"type":"string"},"href":{"type":"string"},"weight":{"type":"integer","format":"int32"}},"additionalProperties":false,"description":"Details about the operations available in this version.","xml":{"name":"link"}},"IssueMatchesForJQL":{"required":["errors","matchedIssues"],"type":"object","properties":{"matchedIssues":{"uniqueItems":true,"type":"array","description":"A list of issue IDs.","items":{"type":"integer","description":"A list of issue IDs.","format":"int64"}},"errors":{"uniqueItems":true,"type":"array","description":"A list of errors.","items":{"type":"string","description":"A list of errors."}}},"additionalProperties":false,"description":"A list of the issues matched to a JQL query or details of errors encountered during matching."},"IssueCommentListRequestBean":{"type":"object","properties":{"ids":{"uniqueItems":true,"type":"array","description":"The list of comment IDs. A maximum of 1000 IDs can be specified. Required.","items":{"type":"integer","format":"int64"}}},"additionalProperties":false},"FoundUsersAndGroups":{"type":"object","properties":{"users":{"$ref":"#/components/schemas/FoundUsers"},"groups":{"$ref":"#/components/schemas/FoundGroups"}},"additionalProperties":false,"description":"List of users and groups found in a search."},"HierarchyLevel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"aboveLevelId":{"type":"integer","format":"int64"},"belowLevelId":{"type":"integer","format":"int64"},"projectConfigurationId":{"type":"integer","format":"int64"},"issueTypeIds":{"type":"array","items":{"type":"integer","format":"int64"}},"externalUuid":{"type":"string","format":"uuid"}},"additionalProperties":false},"RestrictedPermission":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions."},"key":{"type":"string","description":"The key of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions."}},"additionalProperties":true,"description":"Details of the permission."},"NotificationRecipients":{"type":"object","properties":{"reporter":{"type":"boolean","description":"Indicates whether the notification should be sent to the issue's reporter."},"assignee":{"type":"boolean","description":"Indicates whether the notification should be sent to the issue's assignees."},"watchers":{"type":"boolean","description":"Indicates whether the notification should be sent to the issue's watchers."},"voters":{"type":"boolean","description":"Indicates whether the notification should be sent to the issue's voters."},"users":{"type":"array","description":"List of users to receive the notification.","items":{"$ref":"#/components/schemas/UserDetails"}},"groups":{"type":"array","description":"List of groups to receive the notification.","items":{"$ref":"#/components/schemas/GroupName"}}},"additionalProperties":true,"description":"Details of the users and groups to receive the notification."},"WorkflowTransitionRulesUpdate":{"type":"object","properties":{"workflows":{"type":"array","description":"The list of workflows with transition rules to update.","items":{"$ref":"#/components/schemas/WorkflowTransitionRules"}}},"additionalProperties":false,"description":"Details about a workflow configuration update request."},"VersionIssueCounts":{"type":"object","properties":{"self":{"type":"string","description":"The URL of these count details.","format":"uri","readOnly":true},"issuesFixedCount":{"type":"integer","description":"Count of issues where the `fixVersion` is set to the version.","format":"int64","readOnly":true},"issuesAffectedCount":{"type":"integer","description":"Count of issues where the `affectedVersion` is set to the version.","format":"int64","readOnly":true},"issueCountWithCustomFieldsShowingVersion":{"type":"integer","description":"Count of issues where a version custom field is set to the version.","format":"int64","readOnly":true},"customFieldUsage":{"type":"array","description":"List of custom fields using the version.","readOnly":true,"items":{"$ref":"#/components/schemas/VersionUsageInCustomField"}}},"additionalProperties":false,"description":"Various counts of issues within a version.","xml":{"name":"version"}},"Priority":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the issue priority."},"statusColor":{"type":"string","description":"The color used to indicate the issue priority."},"description":{"type":"string","description":"The description of the issue priority."},"iconUrl":{"type":"string","description":"The URL of the icon for the issue priority."},"name":{"type":"string","description":"The name of the issue priority."},"id":{"type":"string","description":"The ID of the issue priority."}},"additionalProperties":true,"description":"An issue priority."},"BulkProjectPermissions":{"required":["permissions"],"type":"object","properties":{"issues":{"uniqueItems":true,"type":"array","description":"List of issue IDs.","items":{"type":"integer","format":"int64"}},"projects":{"uniqueItems":true,"type":"array","description":"List of project IDs.","items":{"type":"integer","format":"int64"}},"permissions":{"uniqueItems":true,"type":"array","description":"List of project permissions.","items":{"type":"string"}}},"additionalProperties":false,"description":"Details of project permissions and associated issues and projects to look up."},"VersionIssuesStatus":{"type":"object","properties":{"unmapped":{"type":"integer","description":"Count of issues with a status other than *to do*, *in progress*, and *done*.","format":"int64","readOnly":true},"toDo":{"type":"integer","description":"Count of issues with status *to do*.","format":"int64","readOnly":true},"inProgress":{"type":"integer","description":"Count of issues with status *in progress*.","format":"int64","readOnly":true},"done":{"type":"integer","description":"Count of issues with status *done*.","format":"int64","readOnly":true}},"additionalProperties":true,"description":"Counts of the number of issues in various statuses."},"PageBeanComponentWithIssueCount":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/ComponentWithIssueCount"}}},"additionalProperties":false,"description":"A page of items."},"JexpIssues":{"type":"object","properties":{"jql":{"description":"The JQL query that specifies the set of issues available in the Jira expression.","allOf":[{"$ref":"#/components/schemas/JexpJqlIssues"}]}},"additionalProperties":false,"description":"The JQL specifying the issues available in the evaluated Jira expression under the `issues` context variable."},"AvatarUrlsBean":{"type":"object","properties":{"16x16":{"type":"string","description":"The URL of the item's 16x16 pixel avatar.","format":"uri"},"24x24":{"type":"string","description":"The URL of the item's 24x24 pixel avatar.","format":"uri"},"32x32":{"type":"string","description":"The URL of the item's 32x32 pixel avatar.","format":"uri"},"48x48":{"type":"string","description":"The URL of the item's 48x48 pixel avatar.","format":"uri"}},"additionalProperties":false},"IdOrKeyBean":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the referenced item.","format":"int64"},"key":{"type":"string","description":"The key of the referenced item."}},"additionalProperties":false},"Fields":{"type":"object","properties":{"summary":{"type":"string","description":"The summary description of the linked issue.","readOnly":true},"status":{"description":"The status of the linked issue.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/StatusDetails"}]},"priority":{"description":"The priority of the linked issue.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/Priority"}]},"assignee":{"description":"The assignee of the linked issue.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserDetails"}]},"issuetype":{"description":"The type of the linked issue.","$ref":"#/components/schemas/IssueTypeBean"},"issueType":{"description":"The type of the linked issue.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/IssueTypeBean"}]}},"additionalProperties":false,"description":"Key fields from the linked issue."},"TaskProgressBeanObject":{"required":["elapsedRuntime","id","lastUpdate","progress","self","status","submitted","submittedBy"],"type":"object","properties":{"self":{"type":"string","description":"The URL of the task.","format":"uri"},"id":{"type":"string","description":"The ID of the task."},"description":{"type":"string","description":"The description of the task."},"status":{"type":"string","description":"The status of the task.","enum":["ENQUEUED","RUNNING","COMPLETE","FAILED","CANCEL_REQUESTED","CANCELLED","DEAD"]},"message":{"type":"string","description":"Information about the progress of the task."},"result":{"description":"The result of the task execution."},"submittedBy":{"type":"integer","description":"The ID of the user who submitted the task.","format":"int64"},"progress":{"type":"integer","description":"The progress of the task, as a percentage complete.","format":"int64"},"elapsedRuntime":{"type":"integer","description":"The execution time of the task, in milliseconds.","format":"int64"},"submitted":{"type":"integer","description":"A timestamp recording when the task was submitted.","format":"int64"},"started":{"type":"integer","description":"A timestamp recording when the task was started.","format":"int64"},"finished":{"type":"integer","description":"A timestamp recording when the task was finished.","format":"int64"},"lastUpdate":{"type":"integer","description":"A timestamp recording when the task progress was last updated.","format":"int64"}},"additionalProperties":false,"description":"Details about a task."},"PropertyKeys":{"type":"object","properties":{"keys":{"type":"array","description":"Property key details.","readOnly":true,"items":{"$ref":"#/components/schemas/PropertyKey"}}},"additionalProperties":false,"description":"List of property keys."},"StatusDetails":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the status.","readOnly":true},"description":{"type":"string","description":"The description of the status.","readOnly":true},"iconUrl":{"type":"string","description":"The URL of the icon used to represent the status.","readOnly":true},"name":{"type":"string","description":"The name of the status.","readOnly":true},"id":{"type":"string","description":"The ID of the status.","readOnly":true},"statusCategory":{"description":"The category assigned to the status.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/StatusCategory"}]}},"additionalProperties":true,"description":"A status."},"ProjectRoleUserBean":{"type":"object","properties":{"accountId":{"type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.","readOnly":true}},"additionalProperties":false},"PageBeanIssueFieldOption":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/IssueFieldOption"}}},"additionalProperties":false,"description":"A page of items."},"IdBean":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"The ID of the permission scheme to associate with the project. Use the [Get all permission schemes](#api-rest-api-3-permissionscheme-get) resource to get a list of permission scheme IDs.","format":"int64"}},"additionalProperties":false},"Visibility":{"type":"object","properties":{"type":{"type":"string","description":"Indicates whether visibility of this item is restricted to a group or role.","enum":["group","role"]},"value":{"type":"string","description":"The name of the group or role to which visibility of this item is restricted."}},"additionalProperties":true,"description":"The group or role to which this item is visible."},"OperationMessage":{"required":["message","statusCode"],"type":"object","properties":{"message":{"type":"string","description":"The human-readable message that describes the result."},"statusCode":{"type":"integer","description":"The status code of the response.","format":"int32"}},"additionalProperties":false,"example":{"message":"An example message.","statusCode":200}},"IssueFilterForBulkPropertyDelete":{"type":"object","properties":{"entityIds":{"uniqueItems":true,"type":"array","description":"List of issues to perform the bulk delete operation on.","items":{"type":"integer","format":"int64"}},"currentValue":{"description":"The value of properties to perform the bulk operation on."}},"additionalProperties":false,"description":"Bulk operation filter details."},"Resolution":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the issue resolution.","format":"uri"},"id":{"type":"string","description":"The ID of the issue resolution."},"description":{"type":"string","description":"The description of the issue resolution."},"name":{"type":"string","description":"The name of the issue resolution."}},"additionalProperties":false,"description":"Details of an issue resolution.","xml":{"name":"resolution"}},"FieldValueClause":{"required":["field","operand","operator"],"type":"object","properties":{"field":{"$ref":"#/components/schemas/JqlQueryField"},"operator":{"type":"string","description":"The operator between the field and operand.","enum":["=","!=",">","<",">=","<=","in","not in","~=","is","is not"]},"operand":{"$ref":"#/components/schemas/JqlQueryClauseOperand"}},"description":"A clause that asserts the current value of a field. For example, `summary ~ test`."},"User":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the user.","format":"uri","readOnly":true},"key":{"type":"string","description":"This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."},"accountId":{"type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. Required in requests."},"accountType":{"type":"string","description":"The user account type. Can take the following values:\n\n *  `atlassian` regular Atlassian user account\n *  `app` system account used for Connect applications and OAuth to represent external systems\n *  `customer` Jira Service Desk account representing an external service desk","readOnly":true,"enum":["atlassian","app","customer","unknown"]},"name":{"type":"string","description":"This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."},"emailAddress":{"type":"string","description":"The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.","readOnly":true},"avatarUrls":{"description":"The avatars of the user.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/AvatarUrlsBean"}]},"displayName":{"type":"string","description":"The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.","readOnly":true},"active":{"type":"boolean","description":"Indicates whether the user is active.","readOnly":true},"timeZone":{"type":"string","description":"The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.","readOnly":true},"locale":{"type":"string","description":"The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.","readOnly":true},"groups":{"description":"The groups that the user belongs to.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/SimpleListWrapperGroupName"}]},"applicationRoles":{"description":"The application roles the user is assigned to.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/SimpleListWrapperApplicationRole"}]},"expand":{"type":"string","description":"Expand options that include additional user details in the response.","readOnly":true,"xml":{"attribute":true}}},"additionalProperties":false,"description":"A user.","xml":{"name":"user"}},"PageBeanUserDetails":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/UserDetails"}}},"additionalProperties":false,"description":"A page of items."},"ActorInputBean":{"type":"object","properties":{"user":{"type":"array","description":"The account IDs of the users to add as default actors. You can add multiple account IDs separated by a comma. For example, `\"user\":[\"12345678-9abc-def1-2345-6789abcdef12\", \"abcdef12-3456-789a-bcde-f123456789ab\"]`.","items":{"type":"string"}},"group":{"type":"array","description":"The name of the group to add as a default actor. You can add multiple groups separated with a comma. For example, `\"group\":[\"project-admin\", \"jira-developers\"]`.","items":{"type":"string"}}},"additionalProperties":false},"Screen":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the screen.","format":"int64","readOnly":true},"name":{"type":"string","description":"The name of the screen.","readOnly":true},"scope":{"description":"The scope of the screen.","allOf":[{"$ref":"#/components/schemas/Scope"}]}},"additionalProperties":false,"description":"A screen."},"FunctionOperand":{"required":["function"],"type":"object","properties":{"function":{"type":"string","description":"The name of the function."},"arguments":{"type":"array","description":"The list of function arguments.","items":{"type":"string"}}},"description":"An operand that is a function. See [Advanced searching - functions reference](https://confluence.atlassian.com/x/dwiiLQ) for more information about JQL functions."},"CompoundClause":{"required":["clauses","operator"],"type":"object","properties":{"clauses":{"type":"array","description":"The list of nested clauses.","items":{"$ref":"#/components/schemas/JqlQueryClause"}},"operator":{"type":"string","description":"The operator between the clauses.","enum":["and","or","not"]}},"description":"A JQL query clause that consists of nested clauses. For example, `(labels in (urgent, blocker) OR lastCommentedBy = currentUser()). Note that, where nesting is not defined, the parser nests JQL clauses based on the operator precedence. For example, \"A OR B AND C\" is parsed as \"(A OR B) AND C\". See Setting the precedence of operators for more information about precedence in JQL queries.`"},"PageBeanProject":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the page.","format":"uri","readOnly":true},"nextPage":{"type":"string","description":"If there is another page of results, the URL of the next page.","format":"uri","readOnly":true},"maxResults":{"type":"integer","description":"The maximum number of items that could be returned.","format":"int32","readOnly":true},"startAt":{"type":"integer","description":"The index of the first item returned.","format":"int64","readOnly":true},"total":{"type":"integer","description":"The number of items returned.","format":"int64","readOnly":true},"isLast":{"type":"boolean","description":"Indicates whether this is the last page.","readOnly":true},"values":{"type":"array","description":"The list of items.","readOnly":true,"items":{"$ref":"#/components/schemas/Project"}}},"additionalProperties":false,"description":"A page of items."},"IssueUpdateMetadata":{"type":"object","properties":{"fields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/FieldMetadata"},"description":"A list of editable field details.","readOnly":true}},"description":"A list of editable field details."},"LinkGroup":{"type":"object","properties":{"id":{"type":"string"},"styleClass":{"type":"string"},"header":{"$ref":"#/components/schemas/SimpleLink"},"weight":{"type":"integer","format":"int32"},"links":{"type":"array","items":{"$ref":"#/components/schemas/SimpleLink"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/LinkGroup"}}},"additionalProperties":false,"description":"Details a link group, which defines issue operations."},"IssueTypeWorkflowMapping":{"type":"object","properties":{"issueType":{"type":"string","description":"The ID of the issue type. Not required if updating the issue type-workflow mapping."},"workflow":{"type":"string","description":"The name of the workflow."},"updateDraftIfNeeded":{"type":"boolean","description":"Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to `false`. Only applicable when updating the workflow-issue types mapping."}},"additionalProperties":false,"description":"Details about the mapping between an issue type and a workflow."},"UserBean":{"type":"object","properties":{"key":{"type":"string","description":"This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.  \nThe key of the user."},"self":{"type":"string","description":"The URL of the user.","format":"uri"},"name":{"type":"string","description":"This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.  \nThe username of the user."},"displayName":{"type":"string","description":"The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value."},"active":{"type":"boolean","description":"Indicates whether the user is active."},"accountId":{"type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*."},"avatarUrls":{"description":"The avatars of the user.","allOf":[{"$ref":"#/components/schemas/UserBeanAvatarUrls"}]}},"additionalProperties":false},"SharePermission":{"required":["type"],"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier of the share permission.","format":"int64","readOnly":true},"type":{"type":"string","description":"The type of share permission:\n\n *  `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n *  `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n *  `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`.\n *  `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n *  `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n *  `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.","enum":["group","project","projectRole","global","loggedin","authenticated","project-unknown"]},"project":{"description":"The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`.  \nFor a request, specify the `id` for the project.","allOf":[{"$ref":"#/components/schemas/Project"}]},"role":{"description":"The project role that the filter is shared with.  \nFor a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in.","allOf":[{"$ref":"#/components/schemas/ProjectRole"}]},"group":{"description":"The group that the filter is shared with. For a request, specify the `name` property for the group.","allOf":[{"$ref":"#/components/schemas/GroupName"}]}},"additionalProperties":false,"description":"Details of a share permission for the filter."},"Comment":{"type":"object","properties":{"self":{"type":"string","description":"The URL of the comment.","readOnly":true},"id":{"type":"string","description":"The ID of the comment.","readOnly":true},"author":{"description":"The ID of the user who created the comment.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserDetails"}]},"body":{"description":"The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)."},"renderedBody":{"type":"string","description":"The rendered version of the comment.","readOnly":true},"updateAuthor":{"description":"The ID of the user who updated the comment last.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserDetails"}]},"created":{"type":"string","description":"The date and time at which the comment was created.","format":"date-time","readOnly":true},"updated":{"type":"string","description":"The date and time at which the comment was updated last.","format":"date-time","readOnly":true},"visibility":{"description":"The group or role to which this comment is visible. Optional on create and update.","allOf":[{"$ref":"#/components/schemas/Visibility"}]},"jsdPublic":{"type":"boolean","description":"Indicates whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation.","readOnly":true},"properties":{"type":"array","description":"A list of comment properties. Optional on create and update.","items":{"$ref":"#/components/schemas/EntityProperty"}}},"additionalProperties":true,"description":"A comment."},"WorkflowSchemeAssociations":{"required":["projectIds"],"type":"object","properties":{"projectIds":{"type":"array","description":"The list of projects that use the workflow scheme.","items":{"type":"string"}},"workflowScheme":{"description":"The workflow scheme.","allOf":[{"$ref":"#/components/schemas/WorkflowScheme"}]}},"additionalProperties":false,"description":"A workflow scheme along with a list of projects that use it."},"FoundUsers":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/UserPickerUser"}},"total":{"type":"integer","description":"The total number of users found in the search.","format":"int32"},"header":{"type":"string","description":"Header text indicating the number of users in the response and the total number of users found in the search."}},"additionalProperties":false,"description":"The list of users found in a search, including header text (Showing X of Y matching users) and total of matched users."},"FieldWasClause":{"required":["field","operand","operator","predicates"],"type":"object","properties":{"field":{"$ref":"#/components/schemas/JqlQueryField"},"operator":{"type":"string","description":"The operator between the field and operand.","enum":["was","was in","was not in","was not"]},"operand":{"$ref":"#/components/schemas/JqlQueryClauseOperand"},"predicates":{"type":"array","description":"The list of time predicates.","items":{"$ref":"#/components/schemas/JqlQueryClauseTimePredicate"}}},"description":"A clause that asserts a previous value of a field. For example, `status WAS \"Resolved\" BY currentUser() BEFORE \"2019/02/02\"`. See [WAS](https://confluence.atlassian.com/x/dgiiLQ#Advancedsearching-operatorsreference-WASWAS) for more information about the WAS operator."},"KeywordOperand":{"required":["keyword"],"type":"object","properties":{"keyword":{"type":"string","description":"The keyword that is the operand value.","enum":["empty"]}},"description":"An operand that is a JQL keyword. See [Advanced searching - keywords reference](https://confluence.atlassian.com/jiracorecloud/advanced-searching-keywords-reference-765593717.html#Advancedsearching-keywordsreference-EMPTYEMPTY) for more information about operand keywords."},"ProjectRoleGroupBean":{"type":"object","properties":{"displayName":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false},"JiraExpressionEvaluationMetaDataBean":{"type":"object","properties":{"complexity":{"description":"Contains information about the expression complexity. For example, the number of steps it took to evaluate the expression.","allOf":[{"$ref":"#/components/schemas/JiraExpressionsComplexityBean"}]},"issues":{"description":"Contains information about the `issues` variable in the context. For example, is the issues were loaded with JQL, information about the page will be included here.","allOf":[{"$ref":"#/components/schemas/IssuesMetaBean"}]}},"additionalProperties":false},"JsonTypeBean":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The data type of the field.","readOnly":true},"items":{"type":"string","description":"When the data type is an array, the name of the field items within the array.","readOnly":true},"system":{"type":"string","description":"If the field is a system field, the name of the field.","readOnly":true},"custom":{"type":"string","description":"If the field is a custom field, the URI of the field.","readOnly":true},"customId":{"type":"integer","description":"If the field is a custom field, the custom ID of the field.","format":"int64","readOnly":true},"configuration":{"type":"object","additionalProperties":{"readOnly":true},"description":"If the field is a custom field, the configuration of the field.","readOnly":true}},"additionalProperties":false,"description":"The schema of a field."},"NotificationEvent":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the event. The event can be a [Jira system event](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-eventsEvents) or a [custom event](https://confluence.atlassian.com/x/AIlKLg).","format":"int64"},"name":{"type":"string","description":"The name of the event."},"description":{"type":"string","description":"The description of the event."},"templateEvent":{"description":"The template of the event. Only custom events configured by Jira administrators have template.","allOf":[{"$ref":"#/components/schemas/NotificationEvent"}]}},"additionalProperties":false,"description":"Details about a notification event."},"AuditRecordBean":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the audit record.","format":"int64","readOnly":true},"summary":{"type":"string","description":"The summary of the audit record.","readOnly":true},"remoteAddress":{"type":"string","description":"The URL of the computer where the creation of the audit record was initiated.","readOnly":true},"authorKey":{"type":"string","description":"The key of the user who created the audit record.","readOnly":true},"created":{"type":"string","description":"The date and time on which the audit record was created.","format":"date-time","readOnly":true},"category":{"type":"string","description":"The category of the audit record. For a list of these categories, see the help article [Auditing in Jira applications](https://confluence.atlassian.com/x/noXKM).","readOnly":true},"eventSource":{"type":"string","description":"The event the audit record originated from.","readOnly":true},"description":{"type":"string","description":"The description of the audit record.","readOnly":true},"objectItem":{"$ref":"#/components/schemas/AssociatedItemBean"},"changedValues":{"type":"array","description":"The list of values changed in the record event.","readOnly":true,"items":{"$ref":"#/components/schemas/ChangedValueBean"}},"associatedItems":{"type":"array","description":"The list of items associated with the changed record.","readOnly":true,"items":{"$ref":"#/components/schemas/AssociatedItemBean"}}},"additionalProperties":false,"description":"An audit record."},"BulkProjectPermissionGrants":{"required":["issues","permission","projects"],"type":"object","properties":{"permission":{"type":"string","description":"A project permission,"},"issues":{"uniqueItems":true,"type":"array","description":"IDs of the issues the user has the permission for.","items":{"type":"integer","format":"int64"}},"projects":{"uniqueItems":true,"type":"array","description":"IDs of the projects the user has the permission for.","items":{"type":"integer","format":"int64"}}},"additionalProperties":false,"description":"List of project permissions and the projects and issues those permissions grant access to."},"IssueMatches":{"required":["matches"],"type":"object","properties":{"matches":{"type":"array","items":{"$ref":"#/components/schemas/IssueMatchesForJQL"}}},"additionalProperties":false,"description":"A list of matched issues or errors for each JQL query, in the order the JQL queries were passed."},"ListWrapperCallbackGroupName":{"type":"object","additionalProperties":false},"ScreenID":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the screen."}},"additionalProperties":false,"description":"ID of a screen."},"VersionMoveBean":{"type":"object","properties":{"after":{"type":"string","description":"The URL (self link) of the version after which to place the moved version. Cannot be used with `position`.","format":"uri"},"position":{"type":"string","description":"An absolute position in which to place the moved version. Cannot be used with `after`.","enum":["Earlier","Later","First","Last"]}},"additionalProperties":false,"xml":{"name":"version"}},"GroupLabel":{"type":"object","properties":{"text":{"type":"string","description":"The group label name."},"title":{"type":"string","description":"The title of the group label."},"type":{"type":"string","description":"The type of the group label.","enum":["ADMIN","SINGLE","MULTIPLE"]}},"additionalProperties":false,"description":"A group label.","xml":{"name":"grouplabel"}},"JqlQueryField":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the field."},"property":{"type":"array","description":"When the field refers to a value in an entity property, details of the entity property value.","items":{"$ref":"#/components/schemas/JqlQueryFieldEntityProperty"}}},"additionalProperties":false,"description":"A field used in a JQL query. See [Advanced searching - fields reference](https://confluence.atlassian.com/x/dAiiLQ) for more information about fields in JQL queries."},"ApplicationRole":{"type":"object","properties":{"key":{"type":"string","description":"The key of the application role."},"groups":{"uniqueItems":true,"type":"array","description":"The groups associated with the application role.","items":{"type":"string"}},"name":{"type":"string","description":"The display name of the application role."},"defaultGroups":{"uniqueItems":true,"type":"array","description":"The groups that are granted default access for this application role.","items":{"type":"string"}},"selectedByDefault":{"type":"boolean","description":"Determines whether this application role should be selected by default on user creation."},"defined":{"type":"boolean","description":"Deprecated."},"numberOfSeats":{"type":"integer","description":"The maximum count of users on your license.","format":"int32"},"remainingSeats":{"type":"integer","description":"The count of users remaining on your license.","format":"int32"},"userCount":{"type":"integer","description":"The number of users counting against your license.","format":"int32"},"userCountDescription":{"type":"string","description":"The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license."},"hasUnlimitedSeats":{"type":"boolean"},"platform":{"type":"boolean","description":"Indicates if the application role belongs to Jira platform (`jira-core`)."}},"additionalProperties":false,"description":"Details of an application role."}},"securitySchemes":{"basicAuth":{"type":"http","description":"You can access this resource via basic auth.","scheme":"basic"},"OAuth2":{"type":"oauth2","description":"OAuth2 scopes for Jira","flows":{"authorizationCode":{"authorizationUrl":"https://auth.atlassian.com/authorize","tokenUrl":"https://auth.atlassian.com/oauth/token","scopes":{"read:jira-user":"View user information in Jira that you have access to, including usernames, email addresses, and avatars.","read:jira-work":"Read project and issue data. Search for issues and objects associated with issues (such as attachments and worklogs).","write:jira-work":"Create and edit issues in Jira, post comments, create worklogs, and delete issues.","manage:jira-project":"Create and edit project settings and create new project-level objects, for example, versions, components.","manage:jira-configuration":"Configure Jira settings that require the Jira administrators permission, for example, create projects and custom fields, view workflows, manage issue link types."}}}}}},"x-atlassian-narrative":{"documents":[{"title":"About","anchor":"about","body":"The Jira REST API enables you to interact with Jira programmatically. Use this API to \n[build apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/), script interactions with \nJira, or develop any other type of integration. This page documents the REST resources available in Jira Cloud, including \nthe HTTP response codes and example requests and responses.\n\n**NOTE:** Personal data that is used to identify users, such as `username` and `userKey`, has been \nremoved from the Jira Cloud REST APIs. In addition, other personal data (for example, email) is now restricted by a \nuser's profile settings (or in the case of managed accounts, the visibility settings decided by the site administrator). \nYou must update your apps to accommodate these changes, if you have not done so already. This change was previously \nannounced on 01 October 2018 and followed by a deprecation period \n(see the [announcement](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/))."},{"title":"Version and URI","anchor":"version","body":"This documentation is for **version 3** of the Jira Cloud platform REST API, which is the latest version. \n\nThe URIs for resources have the following structure:\n\n`https:///rest/api/3/`\n\nFor example,\n`https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`\n\n**Note that version 3 of the Jira Cloud platform REST API is in beta**. All the endpoints from the \n[version 2](https://developer.atlassian.com/cloud/jira/platform/rest/v2/) API are available. However,\nthey are under development and may change. \n\nThe change from version 2 is the introduction of the \n[Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/) \nto: \n- `body` in comments, including where comments are used in issue, issue link, and transition resources.\n- `comment` in worklogs.\n- `description` and `environment` fields in issues.\n- `textarea` type custom fields (multi-line text fields) in issues. Single line custom fields \n  (`textfield`) accept a string and don't handle Atlassian Document Format content."},{"title":"Authentication and authorization","anchor":"authentication","body":"### Connect apps\n\nFor Connect apps, authentication (JWT-based) is built into the Connect libraries. Authorization is implemented using either \nscopes (shown as _App scope required_ for operations on this page) or user impersonation. See \n[Security for Connect apps](https://developer.atlassian.com/cloud/jira/platform/security-for-connect-apps/) \nfor details.\n\n### Other integrations\n\nFor integrations that are not Connect apps, use OAuth 2.0 authorization code grants (3LO) for security \n(3LO scopes are shown as _OAuth scopes required_ for operations on this page). Basic authentication is also available, \nbut you should only use it for tools such as personal scripts or bots. See \n[Security for other integrations](https://developer.atlassian.com/cloud/jira/platform/security-for-other-integrations/) \nfor details."},{"title":"Permissions","anchor":"permissions","body":"Most operations in this API require permissions. The calling user must have the required permissions for an operation to \nuse it. Note that for Connect apps, the app user must have the required permissions for the operation and the app must \nhave scopes that permit the operation.\n\nA permission can be granted to a group, project role, or issue role that the user is a member of, or granted directly to a user. \nSee [Permissions overview](https://confluence.atlassian.com/x/FQiiLQ) for details. The most common permissions are:\n\n- **Administer the Cloud site**: Users in the _site-admins_ group have this \npermission. See [Manage groups](https://confluence.atlassian.com/x/24xjL) for details.\n- **Administer Jira**: Granted by the _Jira Administrators_ global permission. Users in the _administrators_ group have this \npermission. See [Manage groups](https://confluence.atlassian.com/x/24xjL) and \n[Managing global permissions](https://confluence.atlassian.com/x/x4dKLg) for details.\n- **Administer a project in Jira**: Granted by the _Administer projects_ project permission for a project. This can be \ngranted to a user, a group, a project role, and more. \nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for details.\n- **Access a project in Jira**: Granted by the _Browse projects_ project permission for a project. This can be \ngranted to a user, a group, a project role, and more. \nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for details.\n- **Access Jira**: Granted by the _Jira Users_ global permission. Users in the _\\[product]-users_ (for example, \n_jira-software-users_) group have this permission. \nSee [Manage groups](https://confluence.atlassian.com/x/24xjL) and \n[Managing global permissions](https://confluence.atlassian.com/x/x4dKLg) for details."},{"title":"Expansion, pagination, and ordering","anchor":"expansion","body":"### Expansion\n\nThe Jira REST API uses resource expansion, which means that some parts of a resource are not returned unless specified \nin the request. This simplifies responses and minimizes network traffic.\n\nTo expand part of a resource in a request, use the expand query parameter and specify the object(s) to be expanded. \nIf you need to expand nested objects, use the `.` dot notation. If you need to expand multiple objects, use a \ncomma-separated list. \n\nFor example, the following request expands the `names` and `renderedFields` properties for the _JRACLOUD-34423_ issue:\n\n`GET issue/JRACLOUD-34423?expand=names,renderedFields`\n\nTo discover which object can be expanded, refer to the `expand` property in the object. \nIn the JSON example below, the resource declares `widgets` as expandable.\n\n```json\n{\n  \"expand\": \"widgets\", \n  \"self\": \"https://your-domain.atlassian.net/rest/api/3/resource/KEY-1\", \n  \"widgets\": {\n    \"widgets\": [],\n    \"size\": 5\n   }\n}\n```\n\n### Pagination\n\nThe Jira REST API uses pagination to improve performance. Pagination is enforced for operations that could return a large \ncollection of items. When you make a request to a paginated resource, the response wraps the returned array of values in \na JSON object with paging metadata. For example:\n\n```json\n{\n    \"startAt\" : 0,\n    \"maxResults\" : 10,\n    \"total\": 200,\n    \"isLast\": false,\n    \"values\": [\n        { /* result 0 */ },\n        { /* result 1 */ },\n        { /* result 2 */ }\n    ]\n}\n```\n\n*   `startAt` is the index of the first item returned in the page.\n*   `maxResults` is the maximum number of items that can be returned per page. Each API endpoint may have a different \nlimit for the number of items returned, and these limits may change without notice.\n*   `total` is the total number of items contained in all pages. This number **_may change_** as the client \nrequests the subsequent pages, therefore the client should always assume that the requested page can be empty. Note \nthat this property is not returned for all operations.\n*   `isLast` indicates whether the page returned is the last one. Note that this property is not returned for all operations.\n\n### Ordering\n\nSome operations support ordering the elements of a response by a field. Check the documentation for the operation to \nconfirm whether ordering of a response is supported and which fields can be used. Responses are listed in ascending order \nby default. You can change the order using the `orderby` query parameter with a `-` or `+` symbol. For example:\n\n*   `?orderBy=name` to order by `name` field ascending.\n*   `?orderBy=+name` to order by `name` field ascending.\n*   `?orderBy=-name` to order by `name` field descending.\n\n\n"},{"title":"Special headers","anchor":"special-request-headers","body":"The following request and response headers define important metadata for the Jira Cloud REST API resources.\n\n-   `X-Atlassian-Token` (request): Operations that accept multipart/form-data must include the `X-Atlassian-Token: no-check` \nheader in requests. Otherwise the request will be blocked by cross-site request forgery (CSRF/XSRF) protection.\n-   `X-AACCOUNTID` (response): This response header contains the Atlassian account ID of the authenticated user."},{"title":"Anonymous operations","anchor":"anonymous-operations","body":" Jira provides for all permissions, except the [global permission](https://confluence.atlassian.com/x/x4dKLg) Administer Jira, to be assigned to *Anyone*. Once a permission is assigned to *Anyone*, anyone knowing a project's URL is able to use the features in Jira enabled by the permission. However, the Jira REST API does not enable anonymous access for operations by default. This means that an anonymous user who may be able to perform an action through Jira, may not be able to perform the same action where it's enabled by the REST API. \n\n The operations that provide anonymous access are annotated \"This operation can be accessed anonymously.\""},{"title":"Asynchronous operations","anchor":"async-operations","body":"Some Jira REST API operations may trigger long-running or computationally expensive tasks. In these cases, the operation \nwill schedule an asynchronous task and return a `303 (See Other)` response, indicating the location of the queued task \nin the `Location` header. You can query this task to get progress updates.\n\nWhen the task finishes, the response object will contain the `result` field. The content of the field is specific to the \noperation that created the task. Refer to the operation\u2019s documentation for more information.\n\nNote that asynchronous tasks are not guaranteed to be run in order. In other words, if you need your tasks to execute \nin a certain order, you should start a task only after the prerequisite task(s) have finished."},{"title":"Experimental features","anchor":"experimental","body":"Features and methods marked as experimental may change without notice. Feedback on experimental functionality is welcome. \nReport your suggestions and bugs in the [ACJIRA project](https://ecosystem.atlassian.net/projects/ACJIRA) (preferred) or use the \n**Give docs feedback** link at the top of this page. \n"},{"title":"Status codes","anchor":"status-codes","body":"The Jira Cloud platform REST API uses the [standard HTTP status codes](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).\n\nOperations that return an error status code may also return a response body containing details of the error or errors. \nThe schema for the response body is shown below:\n\n\n```json\n{\n  \"id\": \"https://docs.atlassian.com/jira/REST/schema/error-collection#\",\n  \"title\": \"Error Collection\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"errorMessages\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"string\"\n      }\n    },\n    \"errors\": {\n      \"type\": \"object\",\n      \"patternProperties\": {\n        \".+\": {\n          \"type\": \"string\"\n        }\n      },\n      \"additionalProperties\": false\n    },\n    \"status\": { \n      \"type\": \"integer\"\n    }\n  },\n  \"additionalProperties\": false\n}\n```"}]}}
Key	Description	Default value
`jira.clone.prefix`	A string of text that automatically precedes the title of a cloned issue.	`CLONE -`
`jira.date.picker.java.format`	The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting.	`d/MMM/yy`
`jira.date.picker.javascript.format`	This date format is for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting.	`%e/%b/%y`
`jira.date.time.picker.java.format`	The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting.	`dd/MMM/yy h:mm a`
`jira.date.time.picker.javascript.format`	This date format is for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting.	`%e/%b/%y %I:%M %p`
`jira.issue.actions.order`	The default order of actions (such as Comments or Change history) displayed on the issue view.	`asc`
`jira.table.cols.subtasks`	The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue.	`issuetype, status, assignee, progress`
`jira.view.issue.links.sort.order`	The sort order of the list of issue links on the issue view.	`type, status, priority`
`jira.comment.collapsing.minimum.hidden`	The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing.	`4`
`jira.newsletter.tip.delay.days`	The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this functionality.	`7`
Key	Description	Default value
`jira.lf.date.time`	Look and feel of the time format.	`h:mm a`
`jira.lf.date.day`	Look and feel of the day format.	`EEEE h:mm a`
`jira.lf.date.complete`	Look and feel of the date and time format.	`dd/MMM/yy h:mm a`
`jira.lf.date.dmy`	Look and feel of the date format.	`dd/MMM/yy`
`jira.date.time.picker.use.iso8061`	When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard.	`false`
`jira.lf.logo.url`	The URL of the logo image file.	`/images/icon-jira-logo.png`
`jira.lf.logo.show.application.title`	Controls the visibility of the application title on the sidebar.	`false`
`jira.lf.favicon.url`	The URL of the favicon.	`/favicon.ico`
`jira.lf.favicon.hires.url`	The URL of the high resolution favicon.	`/images/64jira.png`
`jira.lf.top.adg3.bgcolour`	The background color of the sidebar.	`#0747A6`
`jira.lf.top.adg3.textcolour`	The color of the text and logo of the sidebar.	`#DEEBFF`
`jira.lf.hero.button.base.bg.colour`		`#3b7fc4`
`jira.title`	The text for the application title. The application title can also be set in General settings.	`Jira`
`jira.option.globalsharing`	boolean	`true`
`xflow.product.suggestions.enabled`	Indicates whether to expose product suggestions for other Atlassian products within Jira.	`true`
Project Type Key	Project Template Key
`business`	`com.atlassian.jira-core-project-templates:jira-core-simplified-content-management`, `com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval`, `com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking`, `com.atlassian.jira-core-project-templates:jira-core-simplified-process-control`, `com.atlassian.jira-core-project-templates:jira-core-simplified-procurement`, `com.atlassian.jira-core-project-templates:jira-core-simplified-project-management`, `com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment`, `com.atlassian.jira-core-project-templates:jira-core-simplified-task-tracking`
`service_desk`	`com.atlassian.servicedesk:simplified-it-service-desk`, `com.atlassian.servicedesk:simplified-internal-service-desk`, `com.atlassian.servicedesk:simplified-external-service-desk`
`software`	`com.pyxis.greenhopper.jira:gh-simplified-agility-kanban`, `com.pyxis.greenhopper.jira:gh-simplified-agility-scrum`, `com.pyxis.greenhopper.jira:gh-simplified-basic`, `com.pyxis.greenhopper.jira:gh-simplified-kanban-classic`, `com.pyxis.greenhopper.jira:gh-simplified-scrum-classic`