Adds actors to a project role for the project. To replace all actors for the project, use Set actors for project role. This operation can be accessed anonymously. Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

Project role actors

AddActorUsers

Add actors to project role

POST:/rest/api/2/project/{projectIdOrKey}/role/{id}

Adds one or more attachments to an issue. Attachments are posted as multipart/form-data (RFC 1867). Note that: * The request must have a X-Atlassian-Token: no-check header, if not it is blocked. See Special headers for more information. * The name of the multipart/form-data parameter that contains the attachments must be file. The following examples upload a file called myfile.txt to the issue TEST-123: #### curl #### curl --location --request POST 'https://your-domain.atlassian.net/rest/api/2/issue/TEST-123/attachments' -u 'email@example.com:' -H 'X-Atlassian-Token: no-check' --form 'file=@"myfile.txt"' #### Node.js #### // This code sample uses the 'node-fetch' and 'form-data' libraries: // https://www.npmjs.com/package/node-fetch // https://www.npmjs.com/package/form-data const fetch = require('node-fetch'); const FormData = require('form-data'); const fs = require('fs'); const filePath = 'myfile.txt'; const form = new FormData(); const stats = fs.statSync(filePath); const fileSizeInBytes = stats.size; const fileStream = fs.createReadStream(filePath); form.append('file', fileStream, {knownLength: fileSizeInBytes}); fetch('https://your-domain.atlassian.net/rest/api/2/issue/TEST-123/attachments', { method: 'POST', body: form, headers: { 'Authorization': Basic ${Buffer.from( 'email@example.com:' ).toString('base64')}, 'Accept': 'application/json', 'X-Atlassian-Token': 'no-check' } }) .then(response => { console.log( Response: ${response.status} ${response.statusText} ); return response.text(); }) .then(text => console.log(text)) .catch(err => console.error(err)); #### Java #### // This code sample uses the 'Unirest' library: // http://unirest.io/java.html HttpResponse response = Unirest.post("https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments") .basicAuth("email@example.com", "") .header("Accept", "application/json") .header("X-Atlassian-Token", "no-check") .field("file", new File("myfile.txt")) .asJson(); System.out.println(response.getBody()); #### Python #### # This code sample uses the 'requests' library: # http://docs.python-requests.org import requests from requests.auth import HTTPBasicAuth import json url = "https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments" auth = HTTPBasicAuth("email@example.com", "") headers = { "Accept": "application/json", "X-Atlassian-Token": "no-check" } response = requests.request( "POST", url, headers = headers, auth = auth, files = { "file": ("myfile.txt", open("myfile.txt","rb"), "application-type") } ) print(json.dumps(json.loads(response.text), sort_keys=True, indent=4, separators=(",", ": "))) #### PHP #### // This code sample uses the 'Unirest' library: // http://unirest.io/php.html Unirest\Request::auth('email@example.com', ''); $headers = array( 'Accept' => 'application/json', 'X-Atlassian-Token' => 'no-check' ); $parameters = array( 'file' => File::add('myfile.txt') ); $response = Unirest\Request::post( 'https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments', $headers, $parameters ); var_dump($response) #### Forge #### // This sample uses Atlassian Forge and the form-data library. // https://developer.atlassian.com/platform/forge/ // https://www.npmjs.com/package/form-data import api from "@forge/api"; import FormData from "form-data"; const form = new FormData(); form.append('file', fileStream, {knownLength: fileSizeInBytes}); const response = await api.asApp().requestJira('/rest/api/2/issue/{issueIdOrKey}/attachments', { method: 'POST', body: form, headers: { 'Accept': 'application/json', 'X-Atlassian-Token': 'no-check' } }); console.log(Response: ${response.status} ${response.statusText}); console.log(await response.json()); Tip: Use a client library. Many client libraries have classes for handling multipart POST operations. For example, in Java, the Apache HTTP Components library provides a MultiPartEntity class for multipart POST operations. This operation can be accessed anonymously. Permissions required: * Browse Projects and Create attachments project permission for the project that the issue is in. * If issue-level security is configured, issue-level security permission to view the issue.

Issue attachments

AddAttachment

Add attachment

POST:/rest/api/2/issue/{issueIdOrKey}/attachments

Adds a comment to an issue. This operation can be accessed anonymously. Permissions required: * Browse projects and Add comments project permission for the project that the issue containing the comment is in. * If issue-level security is configured, issue-level security permission to view the issue.

Issue comments

AddComment

Add comment

POST:/rest/api/2/issue/{issueIdOrKey}/comment

Adds a field to the default tab of the default screen. Permissions required: Administer Jira global permission.

Screens

AddFieldToDefaultScreen

Add field to default screen

POST:/rest/api/2/screens/addToDefault/{fieldId}

Adds issue types to a custom field context, appending the issue types to the issue types list. A custom field context without any issue types applies to all issue types. Adding issue types to such a custom field context would result in it applying to only the listed issue types. If any of the issue types exists in the custom field context, the operation fails and no issue types are added. Permissions required: Administer Jira global permission.

Issue custom field contexts

AddIssueTypesToContext

Add issue types to context

PUT:/rest/api/2/field/{fieldId}/context/{contextId}/issuetype

Adds issue types to an issue type scheme. The added issue types are appended to the issue types list. If any of the issue types exist in the issue type scheme, the operation fails and no issue types are added. Permissions required: Administer Jira global permission.

Issue type schemes

AddIssueTypesToIssueTypeScheme

Add issue types to issue type scheme

PUT:/rest/api/2/issuetypescheme/{issueTypeSchemeId}/issuetype

Adds default actors to a role. You may add groups or users, but you cannot add groups and users in the same request. Changing a project role's default actors does not affect project role members for projects already created. Permissions required: Administer Jira global permission.

Project role actors

AddProjectRoleActorsToRole

Add default actors to project role

POST:/rest/api/2/role/{id}/actors

Creates a tab for a screen. Permissions required: Administer Jira global permission.

Screen tabs

AddScreenTab

Create screen tab

POST:/rest/api/2/screens/{screenId}/tabs

Adds a field to a screen tab. Permissions required: Administer Jira global permission.

Screen tab fields

AddScreenTabField

Add screen tab field

POST:/rest/api/2/screens/{screenId}/tabs/{tabId}/fields

Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter. Be aware that this operation uses different objects for updating share permissions compared to Update filter. Permissions required: Share dashboards and filters global permission and the user must own the filter.

Filter sharing

AddSharePermission

Add share permission

POST:/rest/api/2/filter/{id}/permission

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

Groups

AddUserToGroup

Add user to group

POST:/rest/api/2/group/user

Adds the user's vote to an issue. This is the equivalent of the user clicking Vote on an issue in Jira. This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details. Permissions required: * Browse projects project permission for the project that the issue is in. * If issue-level security is configured, issue-level security permission to view the issue.

Issue votes

AddVote

Add vote

POST:/rest/api/2/issue/{issueIdOrKey}/votes

Adds a user as a watcher of an issue by passing the account ID of the user. For example, "5b10ac8d82e05b22cc7d4ef5". If no user is specified the calling user is added. This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details. Permissions required: * Browse projects project permission for the project that the issue is in. * If issue-level security is configured, issue-level security permission to view the issue. * To add users other than themselves to the watchlist, Manage watcher list project permission for the project that the issue is in.

Issue watchers

AddWatcher

Add watcher

POST:/rest/api/2/issue/{issueIdOrKey}/watchers

Adds a worklog to an issue. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking. This operation can be accessed anonymously. Permissions required: * Browse projects and Work on issues project permission for the project that the issue is in. * If issue-level security is configured, issue-level security permission to view the issue.

Issue worklogs

AddWorklog

Add worklog

POST:/rest/api/2/issue/{issueIdOrKey}/worklog

Deletes an app's property. Permissions required: Only a Connect app whose key matches addonKey can make this request.

App properties

AddonPropertiesResourceDeleteAddonPropertyDelete

Delete app property

DELETE:/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}

Gets all the properties of an app. Permissions required: Only a Connect app whose key matches addonKey can make this request.

App properties

AddonPropertiesResourceGetAddonPropertiesGet

Get app properties

GET:/rest/atlassian-connect/1/addons/{addonKey}/properties

Returns the key and value of an app's property. Permissions required: Only a Connect app whose key matches addonKey can make this request.

App properties

AddonPropertiesResourceGetAddonPropertyGet

Get app property

GET:/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}

Sets the value of an app's property. Use this resource to store custom data for your app. The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters. Permissions required: Only a Connect app whose key matches addonKey can make this request.

App properties

AddonPropertiesResourcePutAddonPropertyPut

Set app property

PUT:/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}

Analyses and validates Jira expressions. As an experimental feature, this operation can also attempt to type-check the expressions. Learn more about Jira expressions in the documentation. Permissions required: None.

Jira expressions

AnalyseExpression

Analyse Jira expression

POST:/rest/api/2/expression/analyse

Updates the value of a custom field added by Connect apps on one or more issues. The values of up to 200 custom fields can be updated. Permissions required: Only Connect apps can make this request.

App migration

AppIssueFieldValueUpdateResourceUpdateIssueFieldsPut

Bulk update custom field value

PUT:/rest/atlassian-connect/1/migration/field

Appends issue type to screen scheme mappings to an issue type screen scheme. Permissions required: Administer Jira global permission.

Issue type screen schemes

AppendMappingsForIssueTypeScreenScheme

Append mappings to issue type screen scheme

PUT:/rest/api/2/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping

Archives a project. You can't delete a project if it's archived. To delete an archived project, restore the project and then delete it. To restore a project, use the Jira UI. Permissions required: Administer Jira global permission.

Projects

ArchiveProject

Archive project

POST:/rest/api/2/project/{projectIdOrKey}/archive

Assigns a field configuration scheme to a project. If the field configuration scheme ID is null, the operation assigns the default field configuration scheme. Field configuration schemes can only be assigned to classic projects. Permissions required: Administer Jira global permission.

Issue field configurations

AssignFieldConfigurationSchemeToProject

Assign field configuration scheme to project

PUT:/rest/api/2/fieldconfigurationscheme/project

Assigns an issue to a user. Use this operation when the calling user does not have the Edit Issues permission but has the Assign issue permission for the project that the issue is in. If name or accountId is set to: * "-1", the issue is assigned to the default assignee for the project. * null, the issue is set to unassigned. This operation can be accessed anonymously. Permissions required: * Browse Projects and Assign Issues project permission for the project that the issue is in. * If issue-level security is configured, issue-level security permission to view the issue.

Issues

AssignIssue

Assign issue

PUT:/rest/api/2/issue/{issueIdOrKey}/assignee

Assigns an issue type scheme to a project. If any issues in the project are assigned issue types not present in the new scheme, the operation will fail. To complete the assignment those issues must be updated to use issue types in the new scheme. Issue type schemes can only be assigned to classic projects. Permissions required: Administer Jira global permission.

Issue type schemes

AssignIssueTypeSchemeToProject

Assign issue type scheme to project

PUT:/rest/api/2/issuetypescheme/project

Assigns an issue type screen scheme to a project. Issue type screen schemes can only be assigned to classic projects. Permissions required: Administer Jira global permission.

Issue type screen schemes

AssignIssueTypeScreenSchemeToProject

Assign issue type screen scheme to project

PUT:/rest/api/2/issuetypescreenscheme/project

Assigns a permission scheme with a project. See Managing project permissions for more information about permission schemes. Permissions required: Administer Jira global permission

Project permission schemes

AssignPermissionScheme

Assign permission scheme

PUT:/rest/api/2/project/{projectKeyOrId}/permissionscheme

Assigns a custom field context to projects. If any project in the request is assigned to any context of the custom field, the operation fails. Permissions required: Administer Jira global permission.

Issue custom field contexts

AssignProjectsToCustomFieldContext

Assign custom field context to projects

PUT:/rest/api/2/field/{fieldId}/context/{contextId}/project

Assigns a workflow scheme to a project. This operation is performed only when there are no issues in the project. Workflow schemes can only be assigned to classic projects. Permissions required: Administer Jira global permission.

Workflow scheme project associations

AssignSchemeToProject

Assign workflow scheme to project

PUT:/rest/api/2/workflowscheme/project

Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria. The criteria the filter used to identify eligible issues are: * entityIds Only issues from this list are eligible. * currentValue Only issues with the property set to this value are eligible. If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible. If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible. This operation is: * transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted. * asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates. Permissions required: * Browse projects project permission for each project containing issues. * If issue-level security is configured, issue-level security permission to view the issue. * Edit issues project permission for each issue.

Issue properties

BulkDeleteIssueProperty

Bulk delete issue property

DELETE:/rest/api/2/issue/properties/{propertyKey}

Returns a paginated list of groups. Permissions required: Browse users and groups global permission.

Groups

BulkGetGroups

Bulk get groups

GET:/rest/api/2/group/bulk

Returns a paginated list of the users specified by one or more account IDs. Permissions required: Permission to access Jira.

Users

BulkGetUsers

Bulk get users

GET:/rest/api/2/user/bulk

Returns the account IDs for the users specified in the key or username parameters. Note that multiple key or username parameters can be specified. Permissions required: Permission to access Jira.

Users

BulkGetUsersMigration

Get account IDs for users

GET:/rest/api/2/user/bulk/migration

Sets a property value on multiple issues. The value set can be a constant or determined by a Jira expression. Expressions must be computable with constant complexity when applied to a set of issues. Expressions must also comply with the restrictions that apply to all Jira expressions. The issues to be updated can be specified by a filter. The filter identifies issues eligible for update using these criteria: * entityIds Only issues from this list are eligible. * currentValue Only issues with the property set to this value are eligible. * hasProperty: * If true, only issues with the property are eligible. * If false, only issues without the property are eligible. If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible. If an invalid combination of criteria is provided, an error is returned. For example, specifying a currentValue and hasProperty as false would not match any issues (because without the property the property cannot have a value). The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible. This operation is: * transactional, either all eligible issues are updated or, when errors occur, none are updated. * asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates. Permissions required: * Browse projects project permission for each project containing issues. * If issue-level security is configured, issue-level security permission to view the issue. * Edit issues project permission for each issue.

Issue properties

BulkSetIssueProperty

Bulk set issue property

PUT:/rest/api/2/issue/properties/{propertyKey}

Sets the values of entity properties on issues. It can set up to 10 entity properties on up to 10,000 issues. The value of the request body must be a valid, non-empty JSON. The maximum length of single issue property value is 32768 characters. This operation can be accessed anonymously. This operation is: * transactional, either all properties are updated in all eligible issues or, when errors occur, no properties are updated. * asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates. Permissions required: * Browse projects and Edit issues project permissions for the project containing the issue. * If issue-level security is configured, issue-level security permission to view the issue.

Issue properties

BulkSetIssuesProperties

Bulk set issues properties

POST:/rest/api/2/issue/properties

Cancels a task. Permissions required: either of: * Administer Jira global permission. * Creator of the task.

Tasks

CancelTask

Cancel task

POST:/rest/api/2/task/{taskId}/cancel

Copies a dashboard. Any values provided in the dashboard parameter replace those in the copied dashboard. Permissions required: None The dashboard to be copied must be owned by or shared with the user.

Dashboards

CopyDashboard

Copy dashboard

POST:/rest/api/2/dashboard/{id}/copy

Creates a component. Use components to provide containers for issues within a project. This operation can be accessed anonymously. Permissions required: Administer projects project permission for the project in which the component is created or Administer Jira global permission.

Project components

CreateComponent

Create component

POST:/rest/api/2/component

Creates a custom field. Permissions required: Administer Jira global permission.

Issue fields

CreateCustomField

Create custom field

POST:/rest/api/2/field

Creates a custom field context. If projectIds is empty, a global context is created. A global context is one that applies to all project. If issueTypeIds is empty, the context applies to all issue types. Permissions required: Administer Jira global permission.

Issue custom field contexts

CreateCustomFieldContext

Create custom field context

POST:/rest/api/2/field/{fieldId}/context

Creates options and, where the custom select field is of the type Select List (cascading), cascading options for a custom select field. The options are added to a context of the field. The maximum number of options that can be created per request is 1000 and each field can have a maximum of 10000 options. This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options (apps) operations. Permissions required: Administer Jira global permission.

Issue custom field options

CreateCustomFieldOption

Create custom field options (context)

POST:/rest/api/2/field/{fieldId}/context/{contextId}/option

Creates a dashboard. Permissions required: None.

Dashboards

CreateDashboard

Create dashboard

POST:/rest/api/2/dashboard

Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional. This operation can only create configurations for use in company-managed (classic) projects. Permissions required: Administer Jira global permission.

Issue field configurations

CreateFieldConfiguration

Create field configuration

POST:/rest/api/2/fieldconfiguration

Creates a field configuration scheme. This operation can only create field configuration schemes used in company-managed (classic) projects. Permissions required: Administer Jira global permission.

Issue field configurations

CreateFieldConfigurationScheme

Create field configuration scheme

POST:/rest/api/2/fieldconfigurationscheme

Creates a filter. The filter is shared according to the default share scope. The filter is not selected as a favorite. Permissions required: Permission to access Jira.

Filters

CreateFilter

Create filter

POST:/rest/api/2/filter

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

Groups

CreateGroup

Create group

POST:/rest/api/2/group

Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be applied, to move the issue or subtask to a workflow step other than the default start step, and issue properties set. The content of the issue or subtask is defined using update and fields. The fields that can be set in the issue or subtask are determined using the Get create issue metadata. These are the same fields that appear on the issue's create screen. Creating a subtask differs from creating an issue as follows: * issueType must be set to a subtask issue type (use Get create issue metadata to find subtask issue types). * parent must contain the ID or key of the parent issue. Permissions required: Browse projects and Create issues project permissions for the project in which the issue or subtask is created.

Issues

CreateIssue

Create issue

POST:/rest/api/2/issue

Creates an option for a select list issue field. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource. Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

Issue custom field options (apps)

CreateIssueFieldOption

Create issue field option

POST:/rest/api/2/field/{fieldKey}/option

Creates an issue link type. Use this operation to create descriptions of the reasons why issues are linked. The issue link type consists of a name and descriptions for a link's inward and outward relationships. To use this operation, the site must have issue linking enabled. Permissions required: Administer Jira global permission.

Issue link types

CreateIssueLinkType

Create issue link type

POST:/rest/api/2/issueLinkType

Creates an issue type and adds it to the default issue type scheme. Permissions required: Administer Jira global permission.

Issue types

CreateIssueType

Create issue type

POST:/rest/api/2/issuetype

Loads an avatar for the issue type. Specify the avatar's local file location in the body of the request. Also, include the following headers: * X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers. * Content-Type: image/image type Valid image types are JPEG, GIF, or PNG. For example: curl --request POST \ --user email@example.com:<api_token> \ --header 'X-Atlassian-Token: no-check' \ --header 'Content-Type: image/< image_type>' \ --data-binary "<@/path/to/file/with/your/avatar>" \ --url 'https://your-domain.atlassian.net/rest/api/2/issuetype/{issueTypeId}'This The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image. The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size. After creating the avatar, use Update issue type to set it as the issue type's displayed avatar. Permissions required: Administer Jira global permission.

Issue types

CreateIssueTypeAvatar

Load issue type avatar

POST:/rest/api/2/issuetype/{id}/avatar2

Creates an issue type scheme. Permissions required: Administer Jira global permission.

Issue type schemes

CreateIssueTypeScheme

Create issue type scheme

POST:/rest/api/2/issuetypescheme

Creates an issue type screen scheme. Permissions required: Administer Jira global permission.

Issue type screen schemes

CreateIssueTypeScreenScheme

Create issue type screen scheme

POST:/rest/api/2/issuetypescreenscheme

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. The content of each issue or subtask is defined using update and fields. The fields that can be set in the issue or subtask are determined using the Get create issue metadata. These are the same fields that appear on the issues' create screens. Creating a subtask differs from creating an issue as follows: * issueType must be set to a subtask issue type (use Get create issue metadata to find subtask issue types). * parent the must contain the ID or key of the parent issue. Permissions required: Browse projects and Create issues project permissions for the project in which each issue or subtask is created.

Issues

CreateIssues

Bulk create issue

POST:/rest/api/2/issue/bulk

Creates or updates a remote issue link for an issue. If a globalId is provided and a remote issue link with that global ID is found it is updated. Any fields without values in the request are set to null. Otherwise, the remote issue link is created. This operation requires issue linking to be active. This operation can be accessed anonymously. Permissions required: * Browse projects and Link issues project permission for the project that the issue is in. * If issue-level security is configured, issue-level security permission to view the issue.

Issue remote links

CreateOrUpdateRemoteIssueLink

Create or update remote issue link

POST:/rest/api/2/issue/{issueIdOrKey}/remotelink

Creates a permission grant in a permission scheme. Permissions required: Administer Jira global permission.

Permission schemes

CreatePermissionGrant

Create permission grant

POST:/rest/api/2/permissionscheme/{schemeId}/permission

Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants. Permissions required: Administer Jira global permission.

Permission schemes

CreatePermissionScheme

Create permission scheme

POST:/rest/api/2/permissionscheme

Creates a project based on a project type template, as shown in the following table: | Project Type Key | Project Template Key | |--|--| | business | com.atlassian.jira-core-project-templates:jira-core-simplified-content-management, com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval, com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking, com.atlassian.jira-core-project-templates:jira-core-simplified-process-control, com.atlassian.jira-core-project-templates:jira-core-simplified-procurement, com.atlassian.jira-core-project-templates:jira-core-simplified-project-management, com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment, com.atlassian.jira-core-project-templates:jira-core-simplified-task-tracking | | service_desk | com.atlassian.servicedesk:simplified-it-service-management, com.atlassian.servicedesk:simplified-general-service-desk, com.atlassian.servicedesk:simplified-internal-service-desk, com.atlassian.servicedesk:simplified-external-service-desk, com.atlassian.servicedesk:simplified-hr-service-desk, com.atlassian.servicedesk:simplified-facilities-service-desk, com.atlassian.servicedesk:simplified-legal-service-desk | | software | com.pyxis.greenhopper.jira:gh-simplified-agility-kanban, com.pyxis.greenhopper.jira:gh-simplified-agility-scrum, com.pyxis.greenhopper.jira:gh-simplified-basic, com.pyxis.greenhopper.jira:gh-simplified-kanban-classic, com.pyxis.greenhopper.jira:gh-simplified-scrum-classic | The project types are available according to the installed Jira features as follows: * Jira Core, the default, enables business projects. * Jira Service Management enables service_desk projects. * Jira Software enables software projects. To determine which features are installed, go to Jira settings > Apps > Manage apps and review the System Apps list. To add Jira Software or Jira Service Management into a JIRA instance, use Jira settings > Apps > Finding new apps. For more information, see Managing add-ons. Permissions required: Administer Jira global permission.

Projects

CreateProject

Create project

POST:/rest/api/2/project

Loads an avatar for a project. Specify the avatar's local file location in the body of the request. Also, include the following headers: * X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers. * Content-Type: image/image type Valid image types are JPEG, GIF, or PNG. For example: curl --request POST --user email@example.com:<api_token> --header 'X-Atlassian-Token: no-check' --header 'Content-Type: image/< image_type>' --data-binary "<@/path/to/file/with/your/avatar>" --url 'https://your-domain.atlassian.net/rest/api/2/project/{projectIdOrKey}/avatar2' The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image. The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size. After creating the avatar use Set project avatar to set it as the project's displayed avatar. Permissions required: Administer projects project permission.

Project avatars

CreateProjectAvatar

Load project avatar

POST:/rest/api/2/project/{projectIdOrKey}/avatar2

Creates a project category. Permissions required: Administer Jira global permission.

Project categories

CreateProjectCategory

Create project category

POST:/rest/api/2/projectCategory

Creates a new project role with no default actors. You can use the Add default actors to project role operation to add default actors to the project role after creating it. Note that although a new project role is available to all projects upon creation, any default actors that are associated with the project role are not added to projects that existed prior to the role being created.< Permissions required: Administer Jira global permission.

Project roles

CreateProjectRole

Create project role

POST:/rest/api/2/role

Creates a screen with a default field tab. Permissions required: Administer Jira global permission.

Screens

CreateScreen

Create screen

POST:/rest/api/2/screens

Creates a screen scheme. Permissions required: Administer Jira global permission.

Screen schemes

CreateScreenScheme

Create screen scheme

POST:/rest/api/2/screenscheme

Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated. If the user exists and has access to Jira, the operation returns a 201 status. If the user exists but does not have access to Jira, the operation returns a 400 status. Permissions required: Administer Jira global permission.

Users

CreateUser

Create user

POST:/rest/api/2/user

Creates a project version. This operation can be accessed anonymously. Permissions required: Administer Jira global permission or Administer Projects project permission for the project the version is added to.

Project versions

CreateVersion

Create version

POST:/rest/api/2/version

Creates a workflow. You can define transition rules using the shapes detailed in the following sections. If no transitional rules are specified the default system transition rules are used. #### Conditions #### Conditions enable workflow rules that govern whether a transition can execute. ##### Always false condition ##### A condition that always fails. { "type": "AlwaysFalseCondition" } ##### Block transition until approval ##### A condition that blocks issue transition if there is a pending approval. { "type": "BlockInProgressApprovalCondition" } ##### Compare number custom field condition ##### A condition that allows transition if a comparison between a number custom field and a value is true. { "type": "CompareNumberCFCondition", "configuration": { "comparator": "=", "fieldId": "customfield_10029", "fieldValue": 2 } } * comparator One of the supported comparator: =, >, and <. * fieldId The custom numeric field ID. Allowed field types: * com.atlassian.jira.plugin.system.customfieldtypes:float * com.pyxis.greenhopper.jira:jsw-story-points * fieldValue The value for comparison. ##### Hide from user condition ##### A condition that hides a transition from users. The transition can only be triggered from a workflow function or REST API operation. { "type": "RemoteOnlyCondition" } ##### Only assignee condition ##### A condition that allows only the assignee to execute a transition. { "type": "AllowOnlyAssignee" } ##### Only Bamboo notifications workflow condition ##### A condition that makes the transition available only to Bamboo build notifications. { "type": "OnlyBambooNotificationsCondition" } ##### Only reporter condition ##### A condition that allows only the reporter to execute a transition. { "type": "AllowOnlyReporter" } ##### Permission condition ##### A condition that allows only users with a permission to execute a transition. { "type": "PermissionCondition", "configuration": { "permissionKey": "BROWSE_PROJECTS" } } * permissionKey The permission required to perform the transition. Allowed values: built-in or app defined permissions. ##### Previous status condition ##### A condition that allows a transition based on whether an issue has or has not transitioned through a status. { "type": "PreviousStatusCondition", "configuration": { "ignoreLoopTransitions": true, "includeCurrentStatus": true, "mostRecentStatusOnly": true, "reverseCondition": true, "previousStatus": { "id": "5" } } } By default this condition allows the transition if the status, as defined by its ID in the previousStatus object, matches any previous issue status, unless: * ignoreLoopTransitions is true, then loop transitions (from and to the same status) are ignored. * includeCurrentStatus is true, then the current issue status is also checked. * mostRecentStatusOnly is true, then only the issue's preceding status (the one immediately before the current status) is checked. * reverseCondition is true, then the status must not be present. ##### Separation of duties condition ##### A condition that prevents a user to perform the transition, if the user has already performed a transition on the issue. { "type": "SeparationOfDutiesCondition", "configuration": { "fromStatus": { "id": "5" }, "toStatus": { "id": "6" } } } * fromStatus OPTIONAL. An object containing the ID of the source status of the transition that is blocked. If omitted any transition to toStatus is blocked. * toStatus An object containing the ID of the target status of the transition that is blocked. ##### Subtask blocking condition ##### A condition that blocks transition on a parent issue if any of its subtasks are in any of one or more statuses. { "type": "SubTaskBlockingCondition", "configuration": { "statuses": [ { "id": "1" }, { "id": "3" } ] } } * statuses A list of objects containing status IDs. ##### User is in any group condition ##### A condition that allows users belonging to any group from a list of groups to execute a transition. { "type": "UserInAnyGroupCondition", "configuration": { "groups": [ "administrators", "atlassian-addons-admin" ] } } * groups A list of group names. ##### User is in any project role condition ##### A condition that allows only users with at least one project roles from a list of project roles to execute a transition. { "type": "InAnyProjectRoleCondition", "configuration": { "projectRoles": [ { "id": "10002" }, { "id": "10003" }, { "id": "10012" }, { "id": "10013" } ] } } * projectRoles A list of objects containing project role IDs. ##### User is in custom field condition ##### A condition that allows only users listed in a given custom field to execute the transition. { "type": "UserIsInCustomFieldCondition", "configuration": { "allowUserInField": false, "fieldId": "customfield_10010" } } * allowUserInField If true only a user who is listed in fieldId can perform the transition, otherwise, only a user who is not listed in fieldId can perform the transition. * fieldId The ID of the field containing the list of users. ##### User is in group condition ##### A condition that allows users belonging to a group to execute a transition. { "type": "UserInGroupCondition", "configuration": { "group": "administrators" } } * group The name of the group. ##### User is in group custom field condition ##### A condition that allows users belonging to a group specified in a custom field to execute a transition. { "type": "InGroupCFCondition", "configuration": { "fieldId": "customfield_10012" } } * fieldId The ID of the field. Allowed field types: * com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker * com.atlassian.jira.plugin.system.customfieldtypes:grouppicker * com.atlassian.jira.plugin.system.customfieldtypes:select * com.atlassian.jira.plugin.system.customfieldtypes:multiselect * com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons * com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes * com.pyxis.greenhopper.jira:gh-epic-status ##### User is in project role condition ##### A condition that allows users with a project role to execute a transition. { "type": "InProjectRoleCondition", "configuration": { "projectRole": { "id": "10002" } } } * projectRole An object containing the ID of a project role. ##### Value field condition ##### A conditions that allows a transition to execute if the value of a field is equal to a constant value or simply set. { "type": "ValueFieldCondition", "configuration": { "fieldId": "assignee", "fieldValue": "qm:6e1ecee6-8e64-4db6-8c85-916bb3275f51:54b56885-2bd2-4381-8239-78263442520f", "comparisonType": "NUMBER", "comparator": "=" } } * fieldId The ID of a field used in the comparison. * fieldValue The expected value of the field. * comparisonType The type of the comparison. Allowed values: STRING, NUMBER, DATE, DATE_WITHOUT_TIME, or OPTIONID. * comparator One of the supported comparator: >, >=, =, <=, <, !=. Notes: * If you choose the comparison type STRING, only = and != are valid options. * You may leave fieldValue empty when comparison type is != to indicate that a value is required in the field. * For date fields without time format values as yyyy-MM-dd, and for those with time as yyyy-MM-dd HH:mm. For example, for July 16 2021 use 2021-07-16, for 8:05 AM use 2021-07-16 08:05, and for 4 PM: 2021-07-16 16:00. #### Validators #### Validators check that any input made to the transition is valid before the transition is performed. ##### Date field validator ##### A validator that compares two dates. { "type": "DateFieldValidator", "configuration": { "comparator": ">", "date1": "updated", "date2": "created", "expression": "1d", "includeTime": true } } * comparator One of the supported comparator: >, >=, =, <=, <, or !=. * date1 The date field to validate. Allowed field types: * com.atlassian.jira.plugin.system.customfieldtypes:datepicker * com.atlassian.jira.plugin.system.customfieldtypes:datetime * com.atlassian.jpo:jpo-custom-field-baseline-end * com.atlassian.jpo:jpo-custom-field-baseline-start * duedate * created * updated * Resolved * date2 The second date field. Required, if expression is not passed. Allowed field types: * com.atlassian.jira.plugin.system.customfieldtypes:datepicker * com.atlassian.jira.plugin.system.customfieldtypes:datetime * com.atlassian.jpo:jpo-custom-field-baseline-end * com.atlassian.jpo:jpo-custom-field-baseline-start * duedate * created * updated * Resolved * expression An expression specifying an offset. Required, if date2 is not passed. Offsets are built with a number, with - as prefix for the past, and one of these time units: d for day, w for week, m for month, or y for year. For example, -2d means two days into the past and 1w means one week into the future. The now keyword enables a comparison with the current date. * includeTime If true, then the time part of the data is included for the comparison. If the field doesn't have a time part, 00:00:00 is used. ##### Windows date validator ##### A validator that checks that a date falls on or after a reference date and before or on the reference date plus a number of days. { "type": "WindowsDateValidator", "configuration": { "date1": "customfield_10009", "date2": "created", "windowsDays": 5 } } * date1 The date field to validate. Allowed field types: * com.atlassian.jira.plugin.system.customfieldtypes:datepicker * com.atlassian.jira.plugin.system.customfieldtypes:datetime * com.atlassian.jpo:jpo-custom-field-baseline-end * com.atlassian.jpo:jpo-custom-field-baseline-start * duedate * created * updated * Resolved * date2 The reference date. Allowed field types: * com.atlassian.jira.plugin.system.customfieldtypes:datepicker * com.atlassian.jira.plugin.system.customfieldtypes:datetime * com.atlassian.jpo:jpo-custom-field-baseline-end * com.atlassian.jpo:jpo-custom-field-baseline-start * duedate * created * updated * Resolved * windowsDays A positive integer indicating a number of days. ##### Field required validator ##### A validator that checks fields are not empty. By default, if a field is not included in the current context it's ignored and not validated. { "type": "FieldRequiredValidator", "configuration": { "ignoreContext": true, "errorMessage": "Hey", "fieldIds": [ "versions", "customfield_10037", "customfield_10003" ] } } * ignoreContext If true, then the context is ignored and all the fields are validated. * errorMessage OPTIONAL. The error message displayed when one or more fields are empty. A default error message is shown if an error message is not provided. * fieldIds The list of fields to validate. ##### Field changed validator ##### A validator that checks that a field value is changed. However, this validation can be ignored for users from a list of groups. { "type": "FieldChangedValidator", "configuration": { "fieldId": "comment", "errorMessage": "Hey", "exemptedGroups": [ "administrators", "atlassian-addons-admin" ] } } * fieldId The ID of a field. * errorMessage OPTIONAL. The error message displayed if the field is not changed. A default error message is shown if the error message is not provided. * exemptedGroups OPTIONAL. The list of groups. ##### Field has single value validator ##### A validator that checks that a multi-select field has only one value. Optionally, the validation can ignore values copied from subtasks. { "type": "FieldHasSingleValueValidator", "configuration": { "fieldId": "attachment, "excludeSubtasks": true } } * fieldId The ID of a field. * excludeSubtasks If true, then values copied from subtasks are ignored. ##### Parent status validator ##### A validator that checks the status of the parent issue of a subtask. Ìf the issue is not a subtask, no validation is performed. { "type": "ParentStatusValidator", "configuration": { "parentStatuses": [ { "id":"1" }, { "id":"2" } ] } } * parentStatus The list of required parent issue statuses. ##### Permission validator ##### A validator that checks the user has a permission. { "type": "PermissionValidator", "configuration": { "permissionKey": "ADMINISTER_PROJECTS" } } * permissionKey The permission required to perform the transition. Allowed values: built-in or app defined permissions. ##### Previous status validator ##### A validator that checks if the issue has held a status. { "type": "PreviousStatusValidator", "configuration": { "mostRecentStatusOnly": false, "previousStatus": { "id": "15" } } } * mostRecentStatusOnly If true, then only the issue's preceding status (the one immediately before the current status) is checked. * previousStatus An object containing the ID of an issue status. ##### Regular expression validator ##### A validator that checks the content of a field against a regular expression. { "type": "RegexpFieldValidator", "configuration": { "regExp": "[0-9]", "fieldId": "customfield_10029" } } * regExpA regular expression. * fieldId The ID of a field. Allowed field types: * com.atlassian.jira.plugin.system.customfieldtypes:select * com.atlassian.jira.plugin.system.customfieldtypes:multiselect * com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons * com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes * com.atlassian.jira.plugin.system.customfieldtypes:textarea * com.atlassian.jira.plugin.system.customfieldtypes:textfield * com.atlassian.jira.plugin.system.customfieldtypes:url * com.atlassian.jira.plugin.system.customfieldtypes:float * com.pyxis.greenhopper.jira:jsw-story-points * com.pyxis.greenhopper.jira:gh-epic-status * description * summary ##### User permission validator ##### A validator that checks if a user has a permission. Obsolete. You may encounter this validator when getting transition rules and can pass it when updating or creating rules, for example, when you want to duplicate the rules from a workflow on a new workflow. { "type": "UserPermissionValidator", "configuration": { "permissionKey": "BROWSE_PROJECTS", "nullAllowed": false, "username": "TestUser" } } * permissionKey The permission to be validated. Allowed values: built-in or app defined permissions. * nullAllowed If true, allows the transition when username is empty. * username The username to validate against the permissionKey. #### Post functions #### Post functions carry out any additional processing required after a Jira workflow transition is executed. ##### Fire issue event function ##### A post function that fires an event that is processed by the listeners. { "type": "FireIssueEventFunction", "configuration": { "event": { "id":"1" } } } Note: If provided, this post function overrides the default FireIssueEventFunction. Can be included once in a transition. * event An object containing the ID of the issue event. ##### Update issue status ##### A post function that sets issue status to the linked status of the destination workflow status. { "type": "UpdateIssueStatusFunction" } Note: This post function is a default function in global and directed transitions. It can only be added to the initial transition and can only be added once. ##### Create comment ##### A post function that adds a comment entered during the transition to an issue. { "type": "CreateCommentFunction" } Note: This post function is a default function in global and directed transitions. It can only be added to the initial transition and can only be added once. ##### Store issue ##### A post function that stores updates to an issue. { "type": "IssueStoreFunction" } Note: This post function can only be added to the initial transition and can only be added once. ##### Assign to current user function ##### A post function that assigns the issue to the current user if the current user has the ASSIGNABLE_USER permission. { "type": "AssignToCurrentUserFunction" } Note: This post function can be included once in a transition. ##### Assign to lead function ##### A post function that assigns the issue to the project or component lead developer. { "type": "AssignToLeadFunction" } Note: This post function can be included once in a transition. ##### Assign to reporter function ##### A post function that assigns the issue to the reporter. { "type": "AssignToReporterFunction" } Note: This post function can be included once in a transition. ##### Clear field value function ##### A post function that clears the value from a field. { "type": "ClearFieldValuePostFunction", "configuration": { "fieldId": "assignee" } } * fieldId The ID of the field. ##### Copy value from other field function ##### A post function that copies the value of one field to another, either within an issue or from parent to subtask. { "type": "CopyValueFromOtherFieldPostFunction", "configuration": { "sourceFieldId": "assignee", "destinationFieldId": "creator", "copyType": "same" } } * sourceFieldId The ID of the source field. * destinationFieldId The ID of the destination field. * copyType Use same to copy the value from a field inside the issue, or parent to copy the value from the parent issue. ##### Create Crucible review workflow function ##### A post function that creates a Crucible review for all unreviewed code for the issue. { "type": "CreateCrucibleReviewWorkflowFunction" } Note: This post function can be included once in a transition. ##### Set issue security level based on user's project role function ##### A post function that sets the issue's security level if the current user has a project role. { "type": "SetIssueSecurityFromRoleFunction", "configuration": { "projectRole": { "id":"10002" }, "issueSecurityLevel": { "id":"10000" } } } * projectRole An object containing the ID of the project role. * issueSecurityLevel OPTIONAL. The object containing the ID of the security level. If not passed, then the security level is set to none. ##### Trigger a webhook function ##### A post function that triggers a webhook. { "type": "TriggerWebhookFunction", "configuration": { "webhook": { "id": "1" } } } * webhook An object containing the ID of the webhook listener to trigger. ##### Update issue custom field function ##### A post function that updates the content of an issue custom field. { "type": "UpdateIssueCustomFieldPostFunction", "configuration": { "mode": "append", "fieldId": "customfield_10003", "fieldValue": "yikes" } } * mode Use replace to override the field content with fieldValue or append to add fieldValue to the end of the field content. * fieldId The ID of the field. * fieldValue The update content. ##### Update issue field function ##### A post function that updates a simple issue field. { "type": "UpdateIssueFieldFunction", "configuration": { "fieldId": "assignee", "fieldValue": "5f0c277e70b8a90025a00776" } } * fieldId The ID of the field. Allowed field types: * assignee * description * environment * priority * resolution * summary * timeoriginalestimate * timeestimate * timespent * fieldValue The update value. * If the fieldId is assignee, the fieldValue should be one of these values: * an account ID. * automatic. * a blank string, which sets the value to unassigned. #### Connect rules #### Connect rules are conditions, validators, and post functions of a transition that are registered by Connect apps. To create a rule registered by the app, the app must be enabled and the rule's module must exist. { "type": "appKey__moduleKey", "configuration": { "value":"{"isValid":"true"}" } } * type A Connect rule key in a form of appKey__moduleKey. * value The stringified JSON configuration of a Connect rule. Permissions required: Administer Jira global permission.

Workflows

CreateWorkflow

Create workflow

POST:/rest/api/2/workflow

Creates a workflow scheme. Permissions required: Administer Jira global permission.

Workflow schemes

CreateWorkflowScheme

Create workflow scheme

POST:/rest/api/2/workflowscheme

Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an active workflow scheme can only have one draft workflow scheme. Permissions required: Administer Jira global permission.

Workflow scheme drafts

CreateWorkflowSchemeDraftFromParent

Create draft workflow scheme

POST:/rest/api/2/workflowscheme/{id}/createdraft

Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties. Permissions required: Administer Jira global permission.

Workflow transition properties

CreateWorkflowTransitionProperty

Create workflow transition property

POST:/rest/api/2/workflow/transitions/{transitionId}/properties

Deletes actors from a project role for the project. To remove default actors from the project role, use Delete default actors from project role. This operation can be accessed anonymously. Permissions required: Administer Projects project permission for the project or Administer Jira global permission.

Project role actors

DeleteActor

Delete actors from project role

DELETE:/rest/api/2/project/{projectIdOrKey}/role/{id}

Deletes a project version. Alternative versions can be provided to update issues that use the deleted version in fixVersion, affectedVersion, or any version picker custom fields. If alternatives are not provided, occurrences of fixVersion, affectedVersion, and any version picker custom field, that contain the deleted version, are cleared. Any replacement version must be in the same project as the version being deleted and cannot be the version being deleted. This operation can be accessed anonymously. Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.

Project versions

DeleteAndReplaceVersion

Delete and replace version

POST:/rest/api/2/version/{id}/removeAndSwap

Deletes an avatar from a project or issue type. Permissions required: Administer Jira global permission.

Avatars

DeleteAvatar

Delete avatar

DELETE:/rest/api/2/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}

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

Issue comments

DeleteComment

Delete comment

DELETE:/rest/api/2/issue/{issueIdOrKey}/comment/{id}

Deletes a comment property. Permissions required: either of: * Edit All Comments project permission to delete a property from any comment. * Edit Own Comments project permission to delete a property from a comment created by the user. Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.

Issue comment properties

DeleteCommentProperty

Delete comment property

DELETE:/rest/api/2/comment/{commentId}/properties/{propertyKey}

Deletes a component. This operation can be accessed anonymously. Permissions required: Administer projects project permission for the project containing the component or Administer Jira global permission.

Project components

DeleteComponent

Delete component

DELETE:/rest/api/2/component/{id}

Deletes a custom field. The custom field is deleted whether it is in the trash or not. See Edit or delete a custom field for more information on trashing and deleting custom fields. This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates. Permissions required: Administer Jira global permission.

Issue fields

DeleteCustomField

Delete custom field

DELETE:/rest/api/2/field/{id}

Deletes a custom field context. Permissions required: Administer Jira global permission.

Issue custom field contexts

DeleteCustomFieldContext

Delete custom field context

DELETE:/rest/api/2/field/{fieldId}/context/{contextId}

Deletes a custom field option. Options with cascading options cannot be deleted without deleting the cascading options first. This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options (apps) operations. Permissions required: Administer Jira global permission.

Issue custom field options

DeleteCustomFieldOption

Delete custom field options (context)

DELETE:/rest/api/2/field/{fieldId}/context/{contextId}/option/{optionId}