This is the reference document for the REST API and resources provided by JIRA. The REST APIs are developers who want to integrate JIRA with other standalone or web applications, and administrators who want to script interactions with the JIRA server.
If you are after an introductory, high-level view of the JIRA REST API, rather than an exhaustive reference document, then the best place to start is the JIRA REST API home.
Because the REST API is based on open standards, you can use any web development language to access the API. If you are using Java, however, the easiest way to get started using the JIRA REST API is to download with the JIRA REST Java Client (JRJC) and use it as a library within your own application. For other languages, refer to the JIRA REST API home for code examples.
JIRA's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will
make an HTTP request and parse the response. The JIRA REST API uses
JSON as its communication format, and the standard HTTP methods like
GET, PUT, POST and DELETE (see API descriptions below for which
methods are available for each resource). URIs for JIRA's REST API resource have the following structure:
http://host:port/context/rest/api-name/api-version/resource-name
Currently there are two API names available, which will be discussed further below:
auth - for authentication-related operations, andapi - for everything else.
The current API version is 2. However, there is also a symbolic version, called latest,
which resolves to the latest version supported by the given JIRA instance. As an example, if you wanted to retrieve
the JSON representation of issue JRA-9 from Atlassian's public
issue tracker, you would access:
https://jira.atlassian.com/rest/api/latest/issue/JRA-9
There is a WADL document that contains the documentation for each resource in the JIRA REST API. It is available here.
In order to minimise network traffic and server CPU usage, the JIRA REST API sometimes uses a technique called
expansion. When a REST resource uses expansion then parts of that resource will not be included in the JSON response
unless explicitly requested. The way to request those fragments to be included is by using the expand
query parameter.
You can use the expand query parameter to specify a comma-separated list of entities that you want
expanded, identifying each of them by name. For example, appending ?expand=names,renderedFields to an
issue's URI requests the inclusion of the translated field names and the HTML-rendered field values in the response.
Continuing with our example above, we would use the following URL to get that information for JRA-9:
https://jira.atlassian.com/rest/api/latest/issue/JRA-9?expand=names,renderedFields
To discover the identifiers for each entity, look at the expand property in the parent object. In the
JSON example below, the resource declares widgets as being expandable.
{"expand":"widgets", "self":"http://www.example.com/jira/rest/api/resource/KEY-1", "widgets":{"widgets":[],"size":5}}
You can use the dot notation to specify expansion of entities within another entity. For example
?expand=widgets.fringels would expand the widgets collection and also the fringel property on each
widget.
Any authentication that works against JIRA will work against the REST API. The prefered authentication methods are OAuth and HTTP Basic (when using SSL), which are both documented in the JIRA REST API Tutorials. Other supported methods include: HTTP Cookies, and Trusted Applications.
The log-in page uses cookie-based authentication, so if you are using JIRA in a browser you can call REST from
Javascript on the page and rely on the authentication that the browser has established. Callers wanting to reproduce
the behaviour of the JIRA log-in page (for example, to display authentication error messages to users) or who are
calling both the REST and SOAP API can POST to the /auth/1/session resource as per the
documentation below.
You can find OAuth code samples in several programming languages at bitbucket.org/atlassian_tutorial/atlassian-oauth-examples.
Methods marked as experimental may change without an earlier notice. We are looking for your feedback for these methods.
This documents the current REST API provided by JIRA.
REST resource for starting/stopping/querying indexing.
Kicks off a reindex. Need Admin permissions to perform this reindex.
| parameter | value | description |
|---|---|---|
type |
Case insensitive String indicating type of reindex. If ommitted, then defaults to BACKGROUND_PREFERRED |
available response representations:
Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned. If theere is no active index task, then returns information about the latest reindex task run, otherwise simply returns a string indicating that no reindex has taken place.
available response representations:
Returns an application property.
| parameter | value | description |
|---|---|---|
key |
a String containing the property key |
|
permissionLevel |
when fetching a list specifies the permission level of all items in the list see {@link com.atlassian.jira.bc.admin.ApplicationPropertiesService.EditPermissionLevel} |
|
keyFilter |
when fetching a list allows the list to be filtered by the property's start of key e.g. "jira.lf.*" whould fetch only those permissions that are editable and whose keys start with "jira.lf.". This is a regex. |
available response representations:
{"id":"jira.home","key":"jira.home","value":"/var/jira/jira-home","name":"jira.home","desc":"JIRA home directory","type":"string","defaultValue":""}Returned if the property exists and the currently authenticated user has permission to view it. Contains a full representation of the property.
Returned if the property does not exist or the currently authenticated user does not have permission to view it.
| parameter | value | description |
|---|---|---|
id |
Modify an application property via PUT. The "value" field present in the PUT will override thee existing value.
acceptable request representations:
{"id":"jira.home","value":"/var/jira/jira-home"}available response representations:
Returned if the version exists and the currently authenticated user has permission to edit it.
Returned if the currently authenticated user does not have permission to edit the version.
Returned if the version does not exist or the currently authenticated user does not have permission to view it.
| parameter | value | description |
|---|---|---|
id |
the id of the attachment to ddelete. |
Returns the meta-data for an attachment, including the URI of the actual attached file.
available response representations:
{"self":"http://www.example.com/jira/rest/api/2.0/attachments/10000","filename":"picture.jpg","author":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"created":"2013-08-23T16:57:35.977+0200","size":23123,"mimeType":"image/jpeg","content":"http://www.example.com/jira/attachments/10000","thumbnail":"http://www.example.com/jira/secure/thumbnail/10000"}Returns a JSON representation of the attachment meta-data. The representation does not contain the attachment itself, but contains a URI that can be used to download the actual attached file.
Returned if the attachment with the given id does not exist, or is not accessible by the calling user.
Returns the meta informations for an attachments, specifically if they are enabled and the maximum upload size allowed.
available response representations:
{"enabled":true,"uploadLimit":1000000}Returns a JSON representation of the attachment capabilities. Consumers of this resource may also need to check if the logged in user has permission to upload or otherwise manipulate attachments using the {@link com.atlassian.jira.rest.v2.permission.PermissionsResource}.
| parameter | value | description |
|---|---|---|
type |
the avatar type |
Returns all system avatars of the given type.
available response representations:
{"system":[{"id":"1000","owner":"fred","isSystemAvatar":true,"isSelected":true,"selected":true}]}Returns a map containing a list of system avatars. A map is returned to be consistent with the shape of the project/KEY/avatars REST end point.
Returned if an error occurs while retrieving the list of avatars.
| parameter | value | description |
|---|---|---|
type |
the avatar type |
Creates temporary avatar
| parameter | value | description |
|---|---|---|
filename |
name of file being uploaded |
|
size |
size of file |
available response representations:
{"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"url":"http://example.com/jira/secure/temporaryavatar?cropped=true","needsCropping":true}temporary avatar cropping instructions
Valiation failed. For example filesize is beyond max attachment size.
Returned if the request does not conain a valid XSRF token
Returned if an error occurs while converting temporary avatar to real avatar
| parameter | value | description |
|---|---|---|
type |
the avatar type |
Updates the cropping instructions of the temporary avatar.
acceptable request representations:
{"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"needsCropping":false}available response representations:
Create a component via POST.
acceptable request representations:
{"name":"Component 1","description":"This is a JIRA component","leadUserName":"fred","assigneeType":"PROJECT_LEAD","isAssigneeTypeValid":false,"project":"PXA"}available response representations:
{"self":"http://www.example.com/jira/rest/api/2/component/10000","id":"10000","name":"Component 1","description":"This is a JIRA component","lead":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"assigneeType":"PROJECT_LEAD","assignee":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"realAssigneeType":"PROJECT_LEAD","realAssignee":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"isAssigneeTypeValid":false}Returned if the component is created successfully.
Returned if the caller is not logged in and does not have permission to create components in the project.
Returned if the caller is authenticated and does not have permission to create components in the project.
Returned if the project does not exist or the currently authenticated user does not have permission to view it.
| parameter | value | description |
|---|---|---|
id |
Delete a project component.
| parameter | value | description |
|---|---|---|
moveIssuesTo |
The new component applied to issues whose 'id' component will be deleted. If this value is null, then the 'id' component is simply removed from the related isues. |
available response representations:
Returns a project component.
available response representations:
{"self":"http://www.example.com/jira/rest/api/2/component/10000","id":"10000","name":"Component 1","description":"This is a JIRA component","lead":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"assigneeType":"PROJECT_LEAD","assignee":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"realAssigneeType":"PROJECT_LEAD","realAssignee":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"isAssigneeTypeValid":false}Returns a full JSON representation of a project component.
Returned if there is no component with the given key, or if the calling user does not have permission to view the component.
Modify a component via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored. If leadUserName is an empty string ("") the component lead will be removed.
acceptable request representations:
{"name":"Component 1","description":"This is a JIRA component","leadUserName":"fred","assigneeType":"PROJECT_LEAD","isAssigneeTypeValid":false}available response representations:
Returned if the component exists and the currently authenticated user has permission to edit it.
Returned if the currently authenticated user does not have permission to edit the component.
Returned if the component does not exist or the currently authenticated user does not have permission to view it.
| parameter | value | description |
|---|---|---|
id |
a String containing the component id |
Returns counts of issues related to this component.
available response representations:
{"self":"http://www.example.com/jira/rest/api/2/component/10000","issueCount":23}Returned if the component exists and the currently authenticated user has permission to view it. Contains counts of issues related to this component.
Returned if the component does not exist or the currently authenticated user does not have permission to view it.
| parameter | value | description |
|---|---|---|
id |
a String containing an Custom Field Option id |
Returns a full representation of the Custom Field Option that has the given id.
available response representations:
{"self":"http://localhost:8090/jira/rest/api/2.0/customFieldOption/3","value":"Blue"}Returned if the Custom Field Option exists and is visible by the calling user.
Returned if the Custom Field Option does not exist, or is not visible to the calling user.
The /dashboard resource.
Returns a list of all dashboards, optionally filtering them.
| parameter | value | description |
|---|---|---|
filter |
an optional filter that is applied to the list of dashboards. Valid values include
|
|
startAt |
the index of the first dashboard to return (0-based). must be 0 or a multiple of
|
|
maxResults |
a hint as to the the maximum number of dashboards to return in each call. Note that the
JIRA server reserves the right to impose a |
available response representations:
{"startAt":10,"maxResults":10,"total":143,"prev":"http://www.example.com/jira/rest/api/2/dashboard?startAt=0","next":"http://www.example.com/jira/rest/api/2/dashboard?startAt=10","dashboards":[{"id":"10000","name":"System Dashboard","self":"http://www.example.com/jira/rest/api/2/dashboard/10000","view":"http://www.example.com/jira/secure/Dashboard.jspa?selectPageId=10000"},{"id":"20000","name":"Build Engineering","self":"http://www.example.com/jira/rest/api/2/dashboard/20000","view":"http://www.example.com/jira/secure/Dashboard.jspa?selectPageId=20000"}]}Returns a list of dashboards.
| parameter | value | description |
|---|---|---|
id |
the dashboard id |
Returns a single dashboard.
available response representations:
{"id":"10000","name":"System Dashboard","self":"http://www.example.com/jira/rest/api/2/dashboard/10000","view":"http://www.example.com/jira/secure/Dashboard.jspa?selectPageId=10000"}Returns a single dashboard.
Returned if there is no dashboard with the specified id, or if the user does not have permission to see it.
Returns a list of all fields, both System and Custom
available response representations:
[{"id":"description","name":"Description","custom":false,"orderable":true,"navigable":true,"searchable":true,"schema":{"type":"string","system":"description"}},{"id":"summary","name":"Summary","custom":false,"schema":{"type":"string","system":"summary"}}]Contains a full representation of all visible fields in JSON.
Creates a custom field using a definition (object encapsulating custom field data)
acceptable request representations:
{"name":"New custom field","description":"Custom field for picking groups","type":"com.atlassian.jira.plugin.system.customfieldtypes:grouppicker","searcherKey":"com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher"}available response representations:
Resource for searches.
Creates a new filter, and returns newly created filter. Currently sets permissions just using the users default sharing permissions
| parameter | value | description |
|---|---|---|
expand |
the parameters to expand |
acceptable request representations:
{"name":"All Open Bugs","description":"Lists all open bugs","jql":"type = Bug and resolution is empty","favourite":true}available response representations:
{"self":"http://www.example.com/jira/rest/api/2/filter/10000","id":"10000","name":"All Open Bugs","description":"Lists all open bugs","owner":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"jql":"type = Bug and resolution is empty","viewUrl":"http://www.example.com/jira/secure/IssueNavigator.jspa?mode=hide&requestId=10000","searchUrl":"http://www.example.com/jira/rest/api/2/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty","favourite":true,"sharePermissions":[],"subscriptions":{"size":0,"items":[],"max-results":1000,"start-index":0,"end-index":0}}Returns a JSON representation of a filter
Returned if the input is invalid (e.g. filter name was not provided).
| parameter | value | description |
|---|---|---|
id |
The ID of the filter to delete. |
Returns a filter given an id
| parameter | value | description |
|---|---|---|
expand |
the parameters to expand |
available response representations:
{"self":"http://www.example.com/jira/rest/api/2/filter/10000","id":"10000","name":"All Open Bugs","description":"Lists all open bugs","owner":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"jql":"type = Bug and resolution is empty","viewUrl":"http://www.example.com/jira/secure/IssueNavigator.jspa?mode=hide&requestId=10000","searchUrl":"http://www.example.com/jira/rest/api/2/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty","favourite":true,"sharePermissions":[],"subscriptions":{"size":0,"items":[],"max-results":1000,"start-index":0,"end-index":0}}Returns a JSON representation of a filter
Returned if there is a problem looking up the filter given the id
Updates an existing filter, and returns its new value.
| parameter | value | description |
|---|---|---|
expand |
the parameters to expand |
acceptable request representations:
{"name":"All Open Bugs","description":"Lists all open bugs","jql":"type = Bug and resolution is empty","favourite":true}available response representations:
{"self":"http://www.example.com/jira/rest/api/2/filter/10000","id":"10000","name":"All Open Bugs","description":"Lists all open bugs","owner":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"jql":"type = Bug and resolution is empty","viewUrl":"http://www.example.com/jira/secure/IssueNavigator.jspa?mode=hide&requestId=10000","searchUrl":"http://www.example.com/jira/rest/api/2/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty","favourite":true,"sharePermissions":[],"subscriptions":{"size":0,"items":[],"max-results":1000,"start-index":0,"end-index":0}}Returns a JSON representation of a filter
Returned if there is a problem updating up the filter of the given id
| parameter | value | description |
|---|---|---|
id |
id of the filter |
Returns the default columns for the given filter. Currently logged in user will be used as the user making such request.
available response representations:
Sets the default columns for the given filter.
acceptable request representations:
available response representations:
Returns the default share scope of the logged-in user.
available response representations:
Sets the default share scope of the logged-in user. Available values are GLOBAL and PRIVATE.
acceptable request representations:
{"scope":"GLOBAL"}available response representations:
Returns the favourite filters of the logged-in user.
| parameter | value | description |
|---|---|---|
expand |
the parameters to expand |
available response representations:
[{"self":"http://www.example.com/jira/rest/api/2/filter/10000","id":"10000","name":"All Open Bugs","description":"Lists all open bugs","owner":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"jql":"type = Bug and resolution is empty","viewUrl":"http://www.example.com/jira/secure/IssueNavigator.jspa?mode=hide&requestId=10000","searchUrl":"http://www.example.com/jira/rest/api/2/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty","favourite":true,"sharePermissions":[],"subscriptions":{"size":0,"items":[],"max-results":1000,"start-index":0,"end-index":0}},{"self":"http://www.example.com/jira/rest/api/2/filter/10010","id":"10010","name":"My issues","description":"Issues assigned to me","owner":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"jql":"assignee = currentUser() and resolution is empty","viewUrl":"http://www.example.com/jira/secure/IssueNavigator.jspa?mode=hide&requestId=10010","searchUrl":"http://www.example.com/jira/rest/api/2/search?jql=assignee+%3D+currentUser%28%29+and+resolution+is+empty","favourite":true,"sharePermissions":[{"id":10000,"type":"global"},{"id":10010,"type":"project","project":{"self":"http://www.example.com/jira/rest/api/2/project/EX","id":"10000","key":"EX","name":"Example","avatarUrls":{"24x24":"http://www.example.com/jira/secure/projectavatar?size=small&pid=10000","16x16":"http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000","32x32":"http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000","48x48":"http://www.example.com/jira/secure/projectavatar?size=large&pid=10000"}}}],"subscriptions":{"size":0,"items":[],"max-results":1000,"start-index":0,"end-index":0}}]Returns a JSON representation of a list of filters
Creates a group by given group parameter Returns REST representation for the requested group.
acceptable request representations:
available response representations:
{"name":"jira-administrators","self":"http://www.example.com/jira/rest/api/2/group?groupname=jira-administrators","users":{"size":1,"items":[{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false}],"max-results":50,"start-index":0,"end-index":0},"expand":"users"}Returns full representation of a JIRA group in JSON format.
Returned if user requested an empty group name or group already exists
Returned if the current user is not authenticated.
Returned if the current user does not have administrator permissions.
Returned if the operation is not permitted or error occurs while creating the group.
Deletes a group by given group parameter. Returns no content
| parameter | value | description |
|---|---|---|
groupname |
a group to delete |
|
swapGroup |
a group to transfer visibility restrictions of the group that is being deleted |
available response representations:
Returned if the group was deleted.
Returned if user requested an group that does not exist.
Returned if the current user is not authenticated.
Returned if the current user does not have administrator permissions.
Returned if the requested group was not found.
Returned if the operation is not permitted or error occurs while deleting the group.
Returns REST representation for the requested group. Allows to get list of active users belonging to the specified group and its subgroups if "users" expand option is provided. You can page through users list by using indexes in expand param. For example to get users from index 10 to index 15 use "users[10:15]" expand value. This will return 6 users (if there are at least 16 users in this group). Indexes are 0-based and inclusive.
| parameter | value | description |
|---|---|---|
groupname |
A name of requested group. |
|
expand |
List of fields to expand. Currently only available expand is "users". |
available response representations:
{"name":"jira-administrators","self":"http://www.example.com/jira/rest/api/2/group?groupname=jira-administrators","users":{"size":1,"items":[{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false}],"max-results":50,"start-index":0,"end-index":0},"expand":"users"}Returns full representation of a JIRA group in JSON format.
Returned if user requested an empty group name.
Returned if the current user is not authenticated.
Returned if the current user does not have administrator permissions.
Returned if the requested group was not found.
Adds given user to a group. Returns the current state of the group.
| parameter | value | description |
|---|---|---|
groupname |
A name of requested group. |
acceptable request representations:
available response representations:
Returns full representation of a JIRA group in JSON format.
Returned if user requested an empty group name or the user already belongs to the group.
Returned if the current user is not authenticated.
Returned if the current user does not have administrator permissions.
Returned if the requested group was not found or requested user was not found.
Returned if the operation is not permitted or error occurs while adding user the group.
Removes given user from a group. Returns no content
| parameter | value | description |
|---|---|---|
groupname |
A name of requested group. |
|
username |
User to remove from a group |
available response representations:
If the user was removed from the group.
Returned if user requested an empty group name
Returned if the current user is not authenticated.
Returned if the current user does not have administrator permissions.
Returned if the requested group was not found or the requested user wan not found
Returned if the operation is not permitted or error occurs while removing user from the group.
Returns groups with substrings matching a given query. This is mainly for use with the group picker, so the returned groups contain html to be used as picker suggestions. The groups are also wrapped in a single response object that also contains a header for use in the picker, specifically Showing X of Y matching groups. The number of groups returned is limited by the system property "jira.ajax.autocomplete.limit" The groups will be unique and sorted.
| parameter | value | description |
|---|---|---|
query |
a String to match groups agains |
|
exclude |
||
maxResults |
available response representations:
{"header":"Showing 20 of 25 matching groups","total":25,"groups":[{"name":"jdog-developers","html":"<b>j</b>dog-developers"},{"name":"juvenal-bot","html":"<b>j</b>uvenal-bot"}]}Returned even if no groups match the given substring
Returns a list of users and groups matching query with highlighting. This resource cannot be accessed anonymously.
| parameter | value | description |
|---|---|---|
query |
A string used to search username, Name or e-mail address |
|
maxResults |
the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated. |
|
showAvatar |
available response representations:
Creates an issue or a sub-task from a JSON representation.
The fields that can be set on create, in either the fields parameter or the update parameter can be determined using the /rest/api/2/issue/createmeta resource. If a field is not configured to appear on the create screen, then it will not be in the createmeta, and a field validation error will occur if it is submitted.
Creating a sub-task is similar to creating a regular issue, with two important differences:issueType field must correspond to a sub-task issue type (you can use
/issue/createmeta to discover sub-task issue types), andparent field in the issue create request containing the id or key of the
parent issue.acceptable request representations:
{"update":{"worklog":[{"add":{"started":"2011-07-05T11:05:00.000+0000","timeSpent":"60m"}}]},"fields":{"project":{"id":"10000"},"summary":"something's wrong","issuetype":{"id":"10000"},"assignee":{"name":"homer"},"reporter":{"name":"smithers"},"priority":{"id":"20000"},"labels":["bugfix","blitz_test"],"timetracking":{"originalEstimate":"10","remainingEstimate":"5"},"security":{"id":"10000"},"versions":[{"id":"10000"}],"environment":"environment","description":"description","duedate":"2011-03-11","fixVersions":[{"id":"10001"}],"components":[{"id":"10000"}],"customfield_60000":"jira-developers","customfield_20000":"06/Jul/11 3:25 PM","customfield_80000":{"value":"red"},"customfield_40000":"this is a text field","customfield_30000":["10000","10002"],"customfield_70000":["jira-administrators","jira-users"],"customfield_50000":"this is a text area. big text.","customfield_10000":"09/Jun/81"}}available response representations:
{"id":"10000","key":"TST-24","self":"http://www.example.com/jira/rest/api/2/issue/10000"}Returns a link to the created issue.
{"errorMessages":["Field 'priority' is required"],"errors":{}}Returned if the input is invalid (e.g. missing required fields, invalid field values, and so forth).
Creates issues or sub-tasks from a JSON representation.
Creates many issues in one bulk operation.
Creating a sub-task is similar to creating a regular issue. More details can be found in createIssue section: {@link IssueResource#createIssue(IssueUpdateBean)}}acceptable request representations:
{"issueUpdates":[{"update":{"worklog":[{"add":{"started":"2011-07-05T11:05:00.000+0000","timeSpent":"60m"}}]},"fields":{"project":{"id":"10000"},"summary":"something's wrong","issuetype":{"id":"10000"},"assignee":{"name":"homer"},"reporter":{"name":"smithers"},"priority":{"id":"20000"},"labels":["bugfix","blitz_test"],"timetracking":{"originalEstimate":"10","remainingEstimate":"5"},"security":{"id":"10000"},"versions":[{"id":"10000"}],"environment":"environment","description":"description","duedate":"2011-03-11","fixVersions":[{"id":"10001"}],"components":[{"id":"10000"}],"customfield_60000":"jira-developers","customfield_20000":"06/Jul/11 3:25 PM","customfield_80000":{"value":"red"},"customfield_40000":"this is a text field","customfield_30000":["10000","10002"],"customfield_70000":["jira-administrators","jira-users"],"customfield_50000":"this is a text area. big text.","customfield_10000":"09/Jun/81"}},{"update":{},"fields":{"project":{"id":"1000"},"summary":"something's very wrong","issuetype":{"id":"10000"},"assignee":{"name":"jerry"},"reporter":{"name":"kosecki"},"priority":{"id":"20000"},"labels":["new_release"],"timetracking":{"originalEstimate":"15","remainingEstimate":"5"},"security":{"id":"10000"},"versions":[{"id":"10000"}],"environment":"environment","description":"description","duedate":"2011-04-16","fixVersions":[{"id":"10001"}],"components":[{"id":"10000"}],"customfield_60000":"jira-developers","customfield_20000":"06/Jul/11 3:25 PM","customfield_80000":{"value":"red"},"customfield_40000":"this is a text field","customfield_30000":["10000","10002"],"customfield_70000":["jira-administrators","jira-users"],"customfield_50000":"this is a text area. big text.","customfield_10000":"09/Jun/81"}}]}available response representations:
{"issues":[{"id":"10000","key":"TST-24","self":"http://www.example.com/jira/rest/api/2/issue/10000"},{"id":"10001","key":"TST-25","self":"http://www.example.com/jira/rest/api/2/issue/10001"}],"errors":[]}Returns a link to the created issue.
{"status":400,"elementErrors":{"errorMessages":["Field 'priority' is required"],"errors":{}},"failedElementNumber":3}Returned if the input is invalid (e.g. missing required fields, invalid field values, and so forth).
| parameter | value | description |
|---|---|---|
issueIdOrKey |
the issue id or key to update (i.e. JRA-1330) |
Returns a full representation of the issue for the given issue key.
An issue JSON consists of the issue key, a collection of fields, a link to the workflow transition sub-resource, and (optionally) the HTML rendered values of any fields that support it (e.g. if wiki syntax is enabled for the description or comments).
The fields param (which can be specified multiple times) gives a comma-separated list of fields
to include in the response. This can be used to retrieve a subset of fields.
A particular field can be excluded by prefixing it with a minus.
By default, all (*all) fields are returned in this get-issue resource. Note: the default is different
when doing a jql search -- the default there is just navigable fields (*navigable).
*all - include all fields*navigable - include just navigable fieldssummary,comment - include just the summary and comments-comment - include everything except comments (the default is *all for get-issue)*all,-comment - include everything except comments
JIRA will attempt to identify the issue by the issueIdOrKey path parameter. This can be an issue id,
or an issue key. If the issue cannot be found via an exact match, JIRA will also look for the issue in a case-insensitive way, or
by looking to see if the issue was moved. In either of these cases, the request will proceed as normal (a 302 or other redirect
will not be returned). The issue key contained in the response will indicate the current value of issue's key.
| parameter | value | description |
|---|---|---|
fields |
the list of fields to return for the issue. By default, all fields are returned. |
|
expand |
available response representations:
{"id":"10002","self":"http://www.example.com/jira/rest/api/2/issue/10002","key":"EX-1","fields":{"sub-tasks":[{"id":"10000","type":{"id":"10000","name":"","inward":"Parent","outward":"Sub-task"},"outwardIssue":{"id":"10003","key":"EX-2","self":"http://www.example.com/jira/rest/api/2/issue/EX-2","fields":{"status":{"iconUrl":"http://www.example.com/jira//images/icons/statuses/open.png","name":"Open"}}}}],"timetracking":{"originalEstimate":"10m","remainingEstimate":"3m","timeSpent":"6m","originalEstimateSeconds":600,"remainingEstimateSeconds":200,"timeSpentSeconds":400},"project":{"self":"http://www.example.com/jira/rest/api/2/project/EX","id":"10000","key":"EX","name":"Example","avatarUrls":{"24x24":"http://www.example.com/jira/secure/projectavatar?size=small&pid=10000","16x16":"http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000","32x32":"http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000","48x48":"http://www.example.com/jira/secure/projectavatar?size=large&pid=10000"}},"updated":1,"description":"example bug report","issuelinks":[{"id":"10001","type":{"id":"10000","name":"Dependent","inward":"depends on","outward":"is depended by"},"outwardIssue":{"id":"10004L","key":"PRJ-2","self":"http://www.example.com/jira/rest/api/2/issue/PRJ-2","fields":{"status":{"iconUrl":"http://www.example.com/jira//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://www.example.com/jira/rest/api/2/issue/PRJ-3","fields":{"status":{"iconUrl":"http://www.example.com/jira//images/icons/statuses/open.png","name":"Open"}}}}],"attachment":[{"self":"http://www.example.com/jira/rest/api/2.0/attachments/10000","filename":"picture.jpg","author":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"created":"2013-08-23T16:57:35.977+0200","size":23123,"mimeType":"image/jpeg","content":"http://www.example.com/jira/attachments/10000","thumbnail":"http://www.example.com/jira/secure/thumbnail/10000"}],"watcher":{"self":"http://www.example.com/jira/rest/api/2/issue/EX-1/watchers","isWatching":false,"watchCount":1,"watchers":[{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false}]},"comment":[{"self":"http://www.example.com/jira/rest/api/2/issue/10010/comment/10000","id":"10000","author":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"body":"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://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"created":"2013-08-23T16:57:35.982+0200","updated":"2013-08-23T16:57:35.983+0200","visibility":{"type":"role","value":"Administrators"}}],"worklog":[{"self":"http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000","author":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"updateAuthor":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"comment":"I did some work here.","visibility":{"type":"group","value":"jira-developers"},"started":"2013-08-23T16:57:35.985+0200","timeSpent":"3h 20m","timeSpentSeconds":12000,"id":"100028"}]}}Returns a full representation of a JIRA issue in JSON format.
Returned if the requested issue is not found, or the user does not have permission to view it.
Delete an issue. If the issue has subtasks you must set the parameter deleteSubtasks=true to delete the issue. You cannot delete an issue without its subtasks also being deleted.
| parameter | value | description |
|---|---|---|
deleteSubtasks |
a String of true or false indicating that any subtasks should also be deleted. If the issue has no subtasks this parameter is ignored. If the issue has subtasks and this parameter is missing or false, then the issue will not be deleted and an error will be returned. |
available response representations:
Returned if the issue was removed successfully.
Returned if an error occurs.
Returned if the calling user is not authenticated.
Returned if the calling user does not have permission to delete the issue.
Returned if the issue does not exist.
Edits an issue from a JSON representation.
The issue can either be updated by setting explicit the field value(s) or by using an operation to change the field value.
The fields that can be updated, in either the fields parameter or the update parameter, can be determined
using the /rest/api/2/issue/{issueIdOrKey}/editmeta resource.
If a field is not configured to appear on the edit screen, then it will not be in the editmeta, and a field
validation error will occur if it is submitted.
Specifying a "field_id": field_value in the "fields" is a shorthand for a "set" operation in the "update" section.
Field should appear either in "fields" or "update", not in both.
acceptable request representations:
{"update":{"summary":[{"set":"Bug in business logic"}],"timetracking":[{"edit":{"originalEstimate":"1w 1d","remainingEstimate":"4d"}}],"labels":[{"add":"triaged"},{"remove":"blocker"}],"components":[{"set":""}]},"fields":{"summary":"This is a shorthand for a set operation on the summary field","customfield_10010":1,"customfield_10000":"This is a shorthand for a set operation on a text custom field"}}available response representations:
| parameter | value | description |
|---|---|---|
issueIdOrKey |
a String containing an issue key |
Assigns an issue to a user. You can use this resource to assign issues when the user submitting the request has the assign permission but not the edit issue permission. If the name is "-1" automatic assignee is used. A null name will remove the assignee.
acceptable request representations:
{"name":"harry"}available response representations:
Returned if the issue is successfully assigned.
Returned if there is a problem with the received user representation.
Returned if the calling user does not have permission to assign the issue.
Returned if either the issue or the user does not exist.
| parameter | value | description |
|---|---|---|
issueIdOrKey |
a string containing the issue id or key the comment will be added to |
Returns all comments for an issue.
| parameter | value | description |
|---|---|---|
expand |
optional flags: renderedBody (provides body rendered in HTML) |
available response representations:
{"startAt":0,"maxResults":1,"total":1,"comments":[{"self":"http://www.example.com/jira/rest/api/2/issue/10010/comment/10000","id":"10000","author":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"body":"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://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"created":"2013-08-23T16:57:35.982+0200","updated":"2013-08-23T16:57:35.983+0200","visibility":{"type":"role","value":"Administrators"}}]}returns a collection of comments associated with the issue, with count and pagination information.
Returned if the issue with the given id/key does not exist or if the currently authenticated user does not have permission to view it.
Adds a new comment to an issue.
| parameter | value | description |
|---|---|---|
expand |
optional flags: renderedBody (provides body rendered in HTML) |
acceptable request representations:
{"body":"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.","visibility":{"type":"role","value":"Administrators"}}available response representations:
{"self":"http://www.example.com/jira/rest/api/2/issue/10010/comment/10000","id":"10000","author":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"body":"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://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"created":"2013-08-23T16:57:35.982+0200","updated":"2013-08-23T16:57:35.983+0200","visibility":{"type":"role","value":"Administrators"}}Returned if add was successful
Returned if the input is invalid (e.g. missing required fields, invalid values, and so forth).
| parameter | value | description |
|---|---|---|
id |
id of the comment to be deleted |
|
issueIdOrKey |
a string containing the issue id or key the comment belongs to |
Returns all comments for an issue.
| parameter | value | description |
|---|---|---|
expand |
optional flags: renderedBody (provides body rendered in HTML) |
available response representations:
{"startAt":0,"maxResults":1,"total":1,"comments":[{"self":"http://www.example.com/jira/rest/api/2/issue/10010/comment/10000","id":"10000","author":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"body":"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://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"created":"2013-08-23T16:57:35.982+0200","updated":"2013-08-23T16:57:35.983+0200","visibility":{"type":"role","value":"Administrators"}}]}returns a collection of comments associated with the issue, with count and pagination information.
Returned if the issue with the given id/key does not exist or if the currently authenticated user does not have permission to view it.
Updates an existing comment using its JSON representation.
| parameter | value | description |
|---|---|---|
expand |
optional flags: renderedBody (provides body rendered in HTML) |
acceptable request representations:
{"body":"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.","visibility":{"type":"role","value":"Administrators"}}available response representations:
{"self":"http://www.example.com/jira/rest/api/2/issue/10010/comment/10000","id":"10000","author":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"body":"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://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"created":"2013-08-23T16:57:35.982+0200","updated":"2013-08-23T16:57:35.983+0200","visibility":{"type":"role","value":"Administrators"}}Returned if update was successful
Returned if the input is invalid (e.g. missing required fields, invalid values, and so forth).
| parameter | value | description |
|---|---|---|
issueIdOrKey |
the issue whose edit meta data you want to view |
Returns the meta data for editing an issue.
The fields in the editmeta correspond to the fields in the edit screen for the issue. Fields not in the screen will not be in the editemeta.
available response representations:
{"fields":{"summary":{"required":false,"schema":{"type":"array","items":"option","custom":"com.atlassian.jira.plugin.system.customfieldtypes:multiselect","customId":10001},"name":"My Multi Select","operations":["set","add"],"allowedValues":["red","blue"]}}}Returns a response containing a Map of FieldBeans for fields editable by the current user.
Returned if the requested issue is not found or the user does not have permission to view it.
| parameter | value | description |
|---|---|---|
issueIdOrKey |
a string containing the issue id or key the comment will be added to |
Sends a notification (email) to the list or recipients defined in the request.
acceptable request representations:
{"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.","htmlBody":"Lorem ipsum <strong>dolor</strong> 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":{"reporter":false,"assignee":false,"watchers":true,"voters":true,"users":[{"name":"fred","active":false}],"groups":[{"name":"notification-group","self":"http://www.example.com/jira/rest/api/2/group?groupname=notification-group"}]},"restrict":{"groups":[{"name":"notification-group","self":"http://www.example.com/jira/rest/api/2/group?groupname=notification-group"}],"permissions":[{"id":"10","key":"BROWSE"}]}}available response representations:
| parameter | value | description |
|---|---|---|
issueIdOrKey |
the issue to create the remote issue link for |
A REST sub-resource representing the remote issue links on the issue.
| parameter | value | description |
|---|---|---|
globalId |
The id of the remote issue link to be returned. If null (not provided) all remote links for the issue are returned. For a fullexplanation of Issue Link fields please refer to https://developer.atlassian.com/display/JIRADEV/Fields+in+Remote+Issue+Links |
available response representations:
[{"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":"Crazy 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 thing","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/fred.gif","title":"Tested by Fred Jones","link":"http://www.anothercompany.com/tester/person?username=fred"}}}}]Information on the remote issue links for the current issue.
Returned if the calling user is not authenticated.
Returned if the calling user does not have permission to view the remote issue links, or if issue linking is disabled.
Returned if the issue or remote issue link do not exist.
Creates or updates a remote issue link from a JSON representation. If a globalId is provided and a remote issue link exists with that globalId, the remote issue link is updated. Otherwise, the remote issue link is created.
acceptable request representations:
{"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":"Crazy 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"}}}}available response representations:
{"id":10000,"self":"http://www.example.com/jira/rest/api/issue/MKY-1/remotelink/10000"}Returns a link to the created/updated remote issue link.
{"errorMessages":[],"errors":{"title":"'title' is required."}}Returned if the input is invalid (e.g. missing required fields, invalid values, and so forth).
Returned if the calling user is not authenticated.
Returned if the calling user does not have permission to create/update the remote issue link, or if issue linking is disabled.
Delete the remote issue link with the given global id on the issue.
| parameter | value | description |
|---|---|---|
globalId |
the global id of the remote issue link |
available response representations:
Returned if the remote issue link was removed successfully.
Returned if the calling user is not authenticated.
Returned if the calling user does not have permission to delete the remote issue link, or if issue linking is disabled.
Returned if the issue or remote issue link do not exist.
| parameter | value | description |
|---|---|---|
issueIdOrKey |
the issue to create the remote issue link for |
|
linkId |
the id of the remote issue link |
Get the remote issue link with the given id on the issue.
available response representations:
{"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":"Crazy 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"}}}}Information on the remote issue link with the given id.
Returned if the linkId is not a valid number, or if the remote issue link with the given id does not belong to the given issue.
Returned if the calling user is not authenticated.
Returned if the calling user does not have permission to view the remote issue link, or if issue linking is disabled.
Returned if the issue or remote issue link do not exist.
Updates a remote issue link from a JSON representation. Any fields not provided are set to null.
acceptable request representations:
{"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":"Crazy 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"}}}}available response representations:
Returned if the remote issue link was updated successfully.
{"errorMessages":[],"errors":{"title":"'title' is required."}}Returned if the input is invalid (e.g. missing required fields, invalid values, and so forth).
Returned if the calling user is not authenticated.
Returned if the calling user does not have permission to update the remote issue link, or if issue linking is disabled.
Delete the remote issue link with the given id on the issue.
available response representations:
Returned if the remote issue link was removed successfully.
Returned if the calling user is not authenticated.
Returned if the calling user does not have permission to delete the remote issue link, or if issue linking is disabled.
Returned if the issue or remote issue link do not exist.
| parameter | value | description |
|---|---|---|
issueIdOrKey |
the issue you want to transition |
Get a list of the transitions possible for this issue by the current user, along with fields that are required and their types.
Fields will only be returned if expand=transitions.fields.
The fields in the metadata correspond to the fields in the transition screen for that transition. Fields not in the screen will not be in the metadata.
| parameter | value | description |
|---|---|---|
transitionId |
available response representations:
{"transitions":[{"id":"2","name":"Close Issue","to":{"self":"http://localhost:8090/jira/rest/api/2.0/status/10000","description":"The issue is currently being worked on.","iconUrl":"http://localhost:8090/jira/images/icons/progress.gif","name":"In Progress","id":"10000","statusCategory":{"self":"http://localhost:8090/jira/rest/api/2.0/statuscategory/1","id":1,"key":"in-flight","colorName":"yellow"}},"fields":{"summary":{"required":false,"schema":{"type":"array","items":"option","custom":"com.atlassian.jira.plugin.system.customfieldtypes:multiselect","customId":10001},"name":"My Multi Select","operations":["set","add"],"allowedValues":["red","blue"]}}},{"id":"711","name":"QA Review","to":{"self":"http://localhost:8090/jira/rest/api/2.0/status/5","description":"The issue is closed.","iconUrl":"http://localhost:8090/jira/images/icons/closed.gif","name":"Closed","id":"5","statusCategory":{"self":"http://localhost:8090/jira/rest/api/2.0/statuscategory/9","id":9,"key":"completed","colorName":"green"}},"fields":{"colour":{"required":false,"schema":{"type":"array","items":"option","custom":"com.atlassian.jira.plugin.system.customfieldtypes:multiselect","customId":10001},"name":"My Multi Select","operations":["set","add"],"allowedValues":["red","blue"]},"summary":{"required":false,"schema":{"type":"array","items":"option","custom":"com.atlassian.jira.plugin.system.customfieldtypes:multiselect","customId":10001},"name":"My Multi Select","operations":["set","add"],"allowedValues":["red","blue"]}}}]}Returns a full representation of the transitions possible for the specified issue and the fields required to perform the transition.
Returned if the requested issue is not found or the user does not have permission to view it.
Perform a transition on an issue. When performing the transition you can udate or set other issue fields.
The fields that can be set on transtion, in either the fields parameter or the update parameter can be determined using the /rest/api/2/issue/{issueIdOrKey}/transitions?expand=transitions.fields resource. If a field is not configured to appear on the transition screen, then it will not be in the transition metadata, and a field validation error will occur if it is submitted.
acceptable request representations:
{"update":{"comment":[{"add":{"body":"Bug has been fixed."}}]},"fields":{"assignee":{"name":"bob"},"resolution":{"name":"Fixed"}},"transition":{"id":"5"}}available response representations:
| parameter | value | description |
|---|---|---|
issueIdOrKey |
the issue to view voting information for |
Remove your vote from an issue. (i.e. "unvote")
available response representations:
Cast your vote in favour of an issue.
available response representations:
A REST sub-resource representing the voters on the issue.
available response representations:
{"self":"http://www.example.com/jira/rest/api/issue/MKY-1/votes","votes":24,"hasVoted":true,"voters":[{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false}]}Information about voting on the current issue.
Returned if the user cannot view the issue in question or voting is disabled.
| parameter | value | description |
|---|---|---|
issueIdOrKey |
a String containing an issue key. |
Returns the list of watchers for the issue with the given key.
available response representations:
{"self":"http://www.example.com/jira/rest/api/2/issue/EX-1/watchers","isWatching":false,"watchCount":1,"watchers":[{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false}]}Returns the list of watchers for an issue.
Returned if the requested issue is not found, or the user does not have permission to view it.
Adds a user to an issue's watcher list.
acceptable request representations:
"fred"available response representations:
Returned if the watcher was added successfully.
Returned if there is a problem with the received user representation.
Returned if the calling user does not have permission to add the watcher to the issue's list of watchers.
Returned if either the issue or the user does not exist.
Removes a user from an issue's watcher list.
| parameter | value | description |
|---|---|---|
username |
a String containing the name of the user to remove from the watcher list. Must not be null. |
available response representations:
Returned if the watcher was removed successfully.
Returned if a user name query parameter is not supplied.
Returned if the calling user does not have permission to remove the watcher from the issue's list of watchers.
Returned if either the issue does not exist.
| parameter | value | description |
|---|---|---|
issueIdOrKey |
a string containing the issue id or key the worklog will be added to |
Returns all work logs for an issue.
available response representations:
{"startAt":0,"maxResults":1,"total":1,"worklogs":[{"self":"http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000","author":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"updateAuthor":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"comment":"I did some work here.","visibility":{"type":"group","value":"jira-developers"},"started":"2013-08-23T16:57:35.985+0200","timeSpent":"3h 20m","timeSpentSeconds":12000,"id":"100028"}]}returns a collection of worklogs associated with the issue, with count and pagination information.
Returned if the issue with the given id/key does not exist or if the currently authenticated user does not have permission to view it.
Adds a new worklog entry to an issue.
| parameter | value | description |
|---|---|---|
adjustEstimate |
(optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are
|
|
newEstimate |
(required when "new" is selected for adjustEstimate) the new value for the remaining estimate field. e.g. "2d" |
|
reduceBy |
(required when "manual" is selected for adjustEstimate) the amount to reduce the remaining estimate by e.g. "2d" |
acceptable request representations:
{"self":"http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000","author":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"updateAuthor":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"comment":"I did some work here.","visibility":{"type":"group","value":"jira-developers"},"started":"2013-08-23T16:57:35.985+0200","timeSpent":"3h 20m","timeSpentSeconds":12000,"id":"100028"}available response representations:
| parameter | value | description |
|---|---|---|
id |
id of the worklog to be deleted |
|
issueIdOrKey |
a string containing the issue id or key the worklog belongs to |
Returns a specific worklog.
available response representations:
{"self":"http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000","author":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"updateAuthor":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"comment":"I did some work here.","visibility":{"type":"group","value":"jira-developers"},"started":"2013-08-23T16:57:35.985+0200","timeSpent":"3h 20m","timeSpentSeconds":12000,"id":"100028"}Returned if the work log with the given id exists and the currently authenticated user has permission to view it. The returned response contains a full representation of the work log in JSON format.
Returned if the work log with the given id does not exist or if the currently authenticated user does not have permission to view it.
Updates an existing worklog entry using its JSON representation.
| parameter | value | description |
|---|---|---|
adjustEstimate |
(optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are
|
|
newEstimate |
(required when "new" is selected for adjustEstimate) the new value for the remaining estimate field. |
acceptable request representations:
{"self":"http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000","author":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"updateAuthor":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"comment":"I did some work here.","visibility":{"type":"group","value":"jira-developers"},"started":"2013-08-23T16:57:35.985+0200","timeSpent":"3h 20m","timeSpentSeconds":12000,"id":"100028"}available response representations:
{"self":"http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000","author":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"updateAuthor":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"comment":"I did some work here.","visibility":{"type":"group","value":"jira-developers"},"started":"2013-08-23T16:57:35.985+0200","timeSpent":"3h 20m","timeSpentSeconds":12000,"id":"100028"}Returned if update was successful
Returned if the input is invalid (e.g. missing required fields, invalid values, and so forth).
Returned if the calling user does not have permission to update the worklog
Deletes an existing worklog entry .
| parameter | value | description |
|---|---|---|
adjustEstimate |
(optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are
|
|
newEstimate |
(required when "new" is selected for adjustEstimate) the new value for the remaining estimate field. e.g. "2d" |
|
increaseBy |
(required when "manual" is selected for adjustEstimate) the amount to increase the remaining estimate by e.g. "2d" |
available response representations:
Returns the meta data for creating issues. This includes the available projects, issue types and fields, including field types and whether or not those fields are required. Projects will not be returned if the user does not have permission to create issues in that project.
The fields in the createmeta correspond to the fields in the create screen for the project/issuetype. Fields not in the screen will not be in the createmeta.
Fields will only be returned if expand=projects.issuetypes.fields.
The results can be filtered by project and/or issue type, given by the query params.
| parameter | value | description |
|---|---|---|
projectIds |
combined with the projectKeys param, lists the projects with which to filter the results. If absent, all projects are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying a project that does not exist (or that you cannot create issues in) is not an error, but it will not be in the results. |
|
projectKeys |
combined with the projectIds param, lists the projects with which to filter the results. If null, all projects are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying a project that does not exist (or that you cannot create issues in) is not an error, but it will not be in the results. |
|
issuetypeIds |
combinded with issuetypeNames, lists the issue types with which to filter the results. If null, all issue types are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying an issue type that does not exist is not an error. |
|
issuetypeNames |
combinded with issuetypeIds, lists the issue types with which to filter the results. If null, all issue types are returned. This parameter can be specified multiple times, but is NOT interpreted as a comma-separated list. Specifiying an issue type that does not exist is not an error. |
available response representations:
{"projects":[{"self":"http://www.example.com/jira/rest/api/2/project/EX","id":"10000","key":"EX","name":"Example Project","avatarUrls":{"24x24":"http://www.example.com/jira/secure/projectavatar?size=small&pid=10000&avatarId=10011","16x16":"http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011","32x32":"http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000&avatarId=10011","48x48":"http://www.example.com/jira/secure/projectavatar?pid=10000&avatarId=10011"},"issuetypes":[{"self":"http://www.example.com/jira/rest/api/2/issueType/1","id":"1","description":"An error in the code","iconUrl":"http://www.example.com/jira/images/icons/issuetypes/bug.png","name":"Bug","subtask":false,"fields":{"issuetype":{"required":true,"name":"Issue Type","operations":["set"]}}}]}]}Returns the meta data for creating issues.
Returned if the user does not have permission to view any of the requested projects.
Issue attachments
| parameter | value | description |
|---|---|---|
issueIdOrKey |
the issue that you want to add the attachments to |
Add one or more attachments to an issue.
This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
The name of the multipart/form-data parameter that contains attachments must be "file"
A simple example to upload a file called "myfile.txt" to issue REST-123:
curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" http://myhost/rest/api/2/issue/TEST-123/attachments
available response representations:
[{"self":"http://www.example.com/jira/rest/api/2.0/attachments/10000","filename":"picture.jpg","author":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"created":"2013-08-23T16:57:35.977+0200","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/2.0/attachments/10001","filename":"dbeuglog.txt","author":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"created":"2013-08-23T16:57:35.977+0200","size":2460,"mimeType":"text/plain","content":"http://www.example.com/jira/attachments/10001","thumbnail":"http://www.example.com/jira/secure/thumbnail/10002"}]Returned if attachments is disabled or if you don't have permission to add attachments to this issue.
Returned if the requested issue is not found, the user does not have permission to view it, or if the attachments exceeds the maximum configured attachment size.
The Link Issue Resource provides functionality to manage issue links.
Creates an issue link between two issues. The user requires the link issue permission for the issue which will be linked to another issue. The specified link type in the request is used to create the link and will create a link from the first issue to the second issue using the outward description. It also create a link from the second issue to the first issue using the inward description of the issue link type. It will add the supplied comment to the first issue. The comment can have a restriction who can view it. If group is specified, only users of this group can view this comment, if roleLevel is specified only users who have the specified role can view this comment. The user who creates the issue link needs to belong to the specified group or have the specified role.
acceptable request representations:
{"type":{"name":"Duplicate"},"inwardIssue":{"key":"HSP-1"},"outwardIssue":{"key":"MKY-1"},"comment":{"body":"Linked related issue!","visibility":{"type":"group","value":"jira-users"}}}available response representations:
if the issue link was created successfully.
if it can't create the supplied comment. The response will contain an error message indicating why it failed to create the comment. No issue link will be created if it failed to create the comment.
if the user does not have the link issue permission for the issue, which will be linked to another issue.
If issue linking is disabled or it failed to find one of the issues (issue might exist, but it is not visible for this user) or it failed to find the specified issue link type.
if an error occurred when creating the issue link or the comment.
| parameter | value | description |
|---|---|---|
linkId |
the issue link id. |
Returns an issue link with the specified id.
available response representations:
{"id":"10001","type":{"id":"1000","name":"Duplicate","inward":"Duplicated by","outward":"Duplicates","self":"http://www.example.com/jira/rest/api/2//issueLinkType/1000"},"inwardIssue":{"id":"10004","key":"PRJ-3","self":"http://www.example.com/jira/rest/api/2/issue/PRJ-3","fields":{"status":{"iconUrl":"http://www.example.com/jira//images/icons/statuses/open.png","name":"Open"}}},"outwardIssue":{"id":"10004L","key":"PRJ-2","self":"http://www.example.com/jira/rest/api/2/issue/PRJ-2","fields":{"status":{"iconUrl":"http://www.example.com/jira//images/icons/statuses/open.png","name":"Open"}}}}If the specified issue link id is invalid.
if the user does not have the link issue permission for the issue, which will be linked to another issue.
If issue linking is disabled or it failed to find an issue link with the specified id. Either because none exists with this id, or the user doesn't have the permission to see one of the linked issues.
if an error occurred when creating the issue link or the comment.
Deletes an issue link with the specified id. To be able to delete an issue link you must be able to view both issues and must have the link issue permission for at least one of the issues.
available response representations:
If it successfully deleted the issue link.
If the specified issue link id is invalid.
if the user does not have the link issue permission for the source or destination issue of the issue link.
If issue linking is disabled or it failed to find an issue link with the specified id. Either because none exists with this id, or the user doesn't have the permission to see one of the linked issues.
if an error occurred when deleting the issue link or the comment.
Rest resource to retrieve a list of issue link types.
Returns a list of available issue link types, if issue linking is enabled. Each issue link type has an id, a name and a label for the outward and inward link relationship.
available response representations:
{"issueLinkTypes":[{"id":"1000","name":"Duplicate","inward":"Duplicated by","outward":"Duplicates","self":"http://www.example.com/jira/rest/api/2//issueLinkType/1000"},{"id":"1010","name":"Blocks","inward":"Blocked by","outward":"Blocks","self":"http://www.example.com/jira/rest/api/2//issueLinkType/1010"}]}Returns a list of all available issue link types.
Returned if issue linking is disabled.
Create a new issue link type.
acceptable request representations:
{"name":"Duplicate","inward":"Duplicated by","outward":"Duplicates"}available response representations:
{"id":"1000","name":"Duplicate","inward":"Duplicated by","outward":"Duplicates","self":"http://www.example.com/jira/rest/api/2//issueLinkType/1000"}The new issue link type has been created.
Issue linking is disabled or you do not have permission to create issue link types.
| parameter | value | description |
|---|---|---|
issueLinkTypeId |
Returns for a given issue link type id all information about this issue link type.
available response representations:
{"id":"1000","name":"Duplicate","inward":"Duplicated by","outward":"Duplicates","self":"http://www.example.com/jira/rest/api/2//issueLinkType/1000"}Returns the issue link type with the given id.
Returned if issue linking is disabled or no issue link type with the given id exists.
Delete the specified issue link type.
available response representations:
Update the specified issue link type.
acceptable request representations:
{"name":"Duplicate","inward":"Duplicated by","outward":"Duplicates"}available response representations:
{"id":"1000","name":"Duplicate","inward":"Duplicated by","outward":"Duplicates","self":"http://www.example.com/jira/rest/api/2//issueLinkType/1000"}Returned if the supplied id is not a number.
Returned if issue linking is disabled or no issue link type with the given id exists.
Returns a list of all issue types visible to the user
available response representations:
[{"self":"http://localhost:8090/jira/rest/api/2.0/issueType/3","id":"3","description":"A task that needs to be done.","iconUrl":"http://localhost:8090/jira/images/icons/issuetypes/task.png","name":"Task","subtask":false},{"self":"http://localhost:8090/jira/rest/api/2.0/issueType/1","id":"1","description":"A problem with the software.","iconUrl":"http://localhost:8090/jira/images/icons/issuetypes/bug.png","name":"Bug","subtask":false}]Returned if the issue type exists and is visible by the calling user.
| parameter | value | description |
|---|---|---|
id |
a String containing an issue type id |
Returns a full representation of the issue type that has the given id.
available response representations:
{"self":"http://localhost:8090/jira/rest/api/2.0/issueType/3","id":"3","description":"A task that needs to be done.","iconUrl":"http://localhost:8090/jira/images/icons/issuetypes/task.png","name":"Task","subtask":false}Returned if the issue type exists and is visible by the calling user.
Returned if the issue type does not exist, or is not visible to the calling user.
Resource for auto complete data for searches.
Returns the auto complete data required for JQL searches.
available response representations:
"{\"visibleFieldNames\": [{\"value\":\"affectedVersion\",\"displayName\":\"affectedVersion\",\"auto\":\"true\",\"orderable\":\"true\",\"searchable\":\"true\",\"operators\":[\"=\",\"!=\",\"in\",\"not in\",\"is\",\"is not\",\"<\",\"<=\",\">\",\">=\"],\"types\":[\"com.atlassian.jira.project.version.Version\"]},{\"value\":\"assignee\",\"displayName\":\"assignee\",\"auto\":\"true\",\"orderable\":\"true\",\"searchable\":\"true\",\"operators\":[\"!=\",\"was not in\",\"not in\",\"was not\",\"is\",\"was in\",\"was\",\"=\",\"in\",\"changed\",\"is not\"],\"types\":[\"com.atlassian.crowd.embedded.api.User\"]}],\"visibleFunctionNames\": {\"value\":\"currentLogin()\",\"displayName\":\"currentLogin()\",\"types\":[\"java.util.Date\"]},{\"value\":\"currentUser()\",\"displayName\":\"currentUser()\",\"types\":[\"com.atlassian.crowd.embedded.api.User\"]}],\"jqlReservedWords\": \"empty\",\"and\",\"or\",\"in\",\"distinct\"]}"The auto complete data required for JQL searches.
Returned if the calling user is not authenticated.
Returned if an error occurs while generating the response.
A REST endpoint to provide simple validation services for a JIRA license. Typically used by the setup phase of the JIRA application. This will return an object with a list of errors as key, value pairs.
Provide permission information for the current user.
Returns all permissions in the system and whether the currently logged in user has them. You can optionally provide a specific context to get permissions for (projectKey OR projectId OR issueKey OR issueId)
NB: The above means that for issue-level permissions (EDIT_ISSUE for example), hasPermission may be true when no context is provided, or when a project context is provided, but may be false for any given (or all) issues. This would occur (for example) if Reporters were given the EDIT_ISSUE permission. This is because any user could be a reporter, except in the context of a concrete issue, where the reporter is known.
Global permissions will still be returned for all scopes.
| parameter | value | description |
|---|---|---|
projectKey |
- key of project to scope returned permissions for. |
|
projectId |
- id of project to scope returned permissions for. |
|
issueKey |
- key of the issue to scope returned permissions for. |
|
issueId |
- id of the issue to scope returned permissions for. |
available response representations:
{"permissions":{"EDIT_ISSUE":{"id":"12","key":"EDIT_ISSUE","name":"Edit Issues","description":"Ability to edit issues.","havePermission":true}}}Returns a list of all permissions in JIRA and whether the user has them.
Returned if the project or issue id is invalid.
Returned if the project or issue id or key is not found.
Provide preferences of the currently logged in user.
Returns preference of the currently logged in user. Preference key must be provided as input parameter (key). The value is returned exactly as it is. If key parameter is not provided or wrong - status code 404. If value is found - status code 200.
| parameter | value | description |
|---|---|---|
key |
- key of the preference to be returned. |
available response representations:
Sets preference of the currently logged in user. Preference key must be provided as input parameters (key). Value must be provided as post body. If key or value parameter is not provided - status code 404. If preference is set - status code 204.
| parameter | value | description |
|---|---|---|
key |
- key of the preference to be set. |
acceptable request representations:
available response representations:
Removes preference of the currently logged in user. Preference key must be provided as input parameters (key). If key parameter is not provided or wrong - status code 404. If preference is unset - status code 204.
| parameter | value | description |
|---|---|---|
key |
- key of the preference to be removed. |
available response representations:
Currently logged user resource
Returns currently logged user. This resource cannot be accessed anonymously.
available response representations:
{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","emailAddress":"fred@example.com","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":true,"timeZone":"Australia/Sydney","groups":{"size":3,"items":[]}}Returns a full representation of a JIRA user in JSON format.
Returned if the current user is not authenticated.
Returned if the the user could not be found.
Modify currently logged user. The "value" fields present will override the existing value. Fields skipped in request will not be changed. Only email and display name can be change that way.
acceptable request representations:
{"emailAddress":"eddie@atlassian.com","displayName":"Eddie of Atlassian"}available response representations:
{"self":"http://www.example.com/jirahttp://www.example.com/jira/rest/api/2/user/charlie","key":"charlie","name":"eddie","emailAddress":"eddie@atlassian.com","displayName":"Eddie of Atlassian"}Returned if the user exists and the caller has permission to edit it.
Returned if the request is invalid.
Returned if the current user is not authenticated.
Returned if the the user could not be found.
Modify caller password.
acceptable request representations:
available response representations:
Returns user-friendly statements governing the system's password policy.
| parameter | value | description |
|---|---|---|
hasOldPassword |
Default: false |
whether or not the user will be required to enter their current password. Use {@code false} (the default) if this is a new user or if an administrator is forcibly changing another user's password. |
available response representations:
Returns an array of message strings.
Returns a list of all issue priorities.
available response representations:
[{"self":"http://www.example.com/jira/rest/api/2/priority/3","statusColor":"#009900","description":"Major loss of function.","iconUrl":"http://www.example.com/jira/images/icons/priorities/major.png","name":"Major"},{"self":"http://www.example.com/jira/rest/api/2/priority/5","statusColor":"#cfcfcf","description":"Very little impact.","iconUrl":"http://www.example.com/jira/images/icons/priorities/trivial.png","name":"Trivial"}]Returned if the priorities exists and the user has permission to view it. Contains a full representation of the priority in JSON format.
| parameter | value | description |
|---|---|---|
id |
a String containing the priority id |
Returns an issue priority.
available response representations:
{"self":"http://www.example.com/jira/rest/api/2/priority/3","statusColor":"#009900","description":"Major loss of function.","iconUrl":"http://www.example.com/jira/images/icons/priorities/major.png","name":"Major"}Returned if the issue priority exists and is visible by the calling user. Contains a full representation of the issue priority in JSON.
Returned if the issue priority does not exist or is not visible to the calling user.
Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the list of projects that are visible when using anonymous access.
available response representations:
[{"self":"http://www.example.com/jira/rest/api/2/project/EX","id":"10000","key":"EX","name":"Example","avatarUrls":{"24x24":"http://www.example.com/jira/secure/projectavatar?size=small&pid=10000","16x16":"http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000","32x32":"http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000","48x48":"http://www.example.com/jira/secure/projectavatar?size=large&pid=10000"}},{"self":"http://www.example.com/jira/rest/api/2/project/ABC","id":"10001","key":"ABC","name":"Alphabetical","avatarUrls":{"24x24":"http://www.example.com/jira/secure/projectavatar?size=small&pid=10001","16x16":"http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10001","32x32":"http://www.example.com/jira/secure/projectavatar?size=medium&pid=10001","48x48":"http://www.example.com/jira/secure/projectavatar?size=large&pid=10001"}}]Returns a list of projects for which the user has the BROWSE, ADMINISTER or PROJECT_ADMIN project permission.
Returned if an error occurs while retrieving the list of projects.
| parameter | value | description |
|---|---|---|
projectIdOrKey |
the project id or project key |
Contains a full representation of a project in JSON format.
All project keys associated with the project will only be returned if expand=projectKeys.
| parameter | value | description |
|---|---|---|
expand |
available response representations:
{"self":"http://www.example.com/jira/rest/api/2/project/EX","id":"10000","key":"EX","description":"This project was created as an example for REST.","lead":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"components":[{"self":"http://www.example.com/jira/rest/api/2/component/10000","id":"10000","name":"Component 1","description":"This is a JIRA component","lead":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"assigneeType":"PROJECT_LEAD","assignee":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"realAssigneeType":"PROJECT_LEAD","realAssignee":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"isAssigneeTypeValid":false}],"issueTypes":[{"self":"http://localhost:8090/jira/rest/api/2.0/issueType/3","id":"3","description":"A task that needs to be done.","iconUrl":"http://localhost:8090/jira/images/icons/issuetypes/task.png","name":"Task","subtask":false},{"self":"http://localhost:8090/jira/rest/api/2.0/issueType/1","id":"1","description":"A problem with the software.","iconUrl":"http://localhost:8090/jira/images/icons/issuetypes/bug.png","name":"Bug","subtask":false}],"url":"http://www.example.com/jira/browse/EX","email":"from-jira@example.com","assigneeType":"PROJECT_LEAD","versions":[],"name":"Example","roles":{"Developers":"http://www.example.com/jira/rest/api/2/project/EX/role/10000"},"avatarUrls":{"24x24":"http://www.example.com/jira/secure/projectavatar?size=small&pid=10000","16x16":"http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000","32x32":"http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000","48x48":"http://www.example.com/jira/secure/projectavatar?size=large&pid=10000"}}Returned if the project exists and the user has permission to view it. Contains a full representation of a project in JSON format.
Returned if the project is not found, or the calling user does not have permission to view it.
| parameter | value | description |
|---|---|---|
projectIdOrKey |
Converts temporary avatar into a real avatar
acceptable request representations:
{"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"needsCropping":false}available response representations:
{"id":"1000","owner":"fred","isSystemAvatar":true,"isSelected":true,"selected":true}Returns created avatar
Returned if the cropping coordinates are invalid
Returned if the currently authenticated user does not have permission to pick avatar
Returned if the currently authenticated user does not have EDIT PROJECT permission.
Returned if an error occurs while converting temporary avatar to real avatar
| parameter | value | description |
|---|---|---|
id |
database id for avatar |
|
projectIdOrKey |
Project id or project key |
Deletes avatar
available response representations:
Returned if the avatar is successfully deleted.
Returned if the currently authenticated user does not have permission to delete the component.
Returned if the avatar does not exist or the currently authenticated user does not have permission to delete it.
| parameter | value | description |
|---|---|---|
projectIdOrKey |
Project id or project key |
Creates temporary avatar
| parameter | value | description |
|---|---|---|
filename |
name of file being uploaded |
|
size |
size of file |
available response representations:
{"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"url":"http://example.com/jira/secure/temporaryavatar?cropped=true","needsCropping":true}temporary avatar cropping instructions
Valiation failed. For example filesize is beyond max attachment size.
Returned if the request does not conain a valid XSRF token
Returned if the currently authenticated user does not have EDIT PROJECT permission.
Returned if an error occurs while converting temporary avatar to real avatar
Creates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because the client uses remote iframing to submit avatars using multipart. So we must send them a valid HTML page back from which the client parses the JSON.
available response representations:
{"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"url":"http://example.com/jira/secure/temporaryavatar?cropped=true","needsCropping":true}temporary avatar cropping instructions embeded in HTML page. Error messages will also be embeded in the page.
Returned if the currently authenticated user does not have EDIT PROJECT permission.
Returned if an error occurs while converting temporary avatar to real avatar
| parameter | value | description |
|---|---|---|
projectIdOrKey |
project id or project key |
Returns all avatars which are visible for the currently logged in user. The avatars are grouped into system and custom.
available response representations:
{"system":[{"id":"1000","owner":"fred","isSystemAvatar":true,"isSelected":true,"selected":true}],"custom":[{"id":"1010","owner":"andrew","isSystemAvatar":false,"isSelected":false,"selected":false}]}Returns a map containing a list of avatars for both custom an system avatars, which the user has the BROWSE project permission.
Returned if the currently authenticated user does not have VIEW PROJECT permission.
Returned if an error occurs while retrieving the list of avatars.
| parameter | value | description |
|---|---|---|
projectIdOrKey |
the project id or project key |
Contains a full representation of a the specified project's components.
available response representations:
[{"self":"http://www.example.com/jira/rest/api/2/component/10000","id":"10000","name":"Component 1","description":"This is a JIRA component","lead":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"assigneeType":"PROJECT_LEAD","assignee":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"realAssigneeType":"PROJECT_LEAD","realAssignee":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"isAssigneeTypeValid":false},{"self":"http://www.example.com/jira/rest/api/2/component/10000","id":"10050","name":"PXA","description":"This is a another JIRA component","lead":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"assigneeType":"PROJECT_LEAD","assignee":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"realAssigneeType":"PROJECT_LEAD","realAssignee":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},"isAssigneeTypeValid":false}]Returned if the project exists and the user has permission to view its components. Contains a full representation of the project's components in JSON format.
Returned if the project is not found, or the calling user does not have permission to view it.
| parameter | value | description |
|---|---|---|
projectIdOrKey |
Project id or project key |
Get all issue types with valid status values for a project
available response representations:
[{"self":"http://localhost:8090/jira/rest/api/2.0/issueType/3","id":"3","name":"Task","subtask":false,"statuses":[{"self":"http://localhost:8090/jira/rest/api/2.0/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/2.0/status/5","description":"The issue is closed.","iconUrl":"http://localhost:8090/jira/images/icons/closed.gif","name":"Closed","id":"5"}]}]Returned if the project exists and the user has permission to view its components. Contains a full representation of issue types with status values which are valid for each issue type.
Returned if the project is not found, or the calling user does not have permission to view it.
| parameter | value | description |
|---|---|---|
projectIdOrKey |
the project id or project key |
Contains a full representation of a the specified project's versions.
| parameter | value | description |
|---|---|---|
expand |
available response representations:
[{"self":"http://www.example.com/jira/rest/api/2/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://www.example.com/jira/rest/api/2/version/10010","id":"10010","description":"Minor Bugfix version","name":"Next Version","archived":false,"released":false,"overdue":false,"projectId":10000}]Returned if the project exists and the user has permission to view its versions. Contains a full representation of the project's versions in JSON format.
Returned if the project is not found, or the calling user does not have permission to view it.
| parameter | value | description |
|---|---|---|
projectIdOrKey |
the project id or project key |
Contains a list of roles in this project with links to full details.
available response representations:
{"Users":"http://www.example.com/jira/rest/api/2/project/MKY/role/10001","Administrators":"http://www.example.com/jira/rest/api/2/project/MKY/role/10002","Developers":"http://www.example.com/jira/rest/api/2/project/MKY/role/10000"}Returned if the project exists and the user has permission to view it. A maps of roles to URIs containing full details for that role.
Returned if the project is not found, or the calling user does not have permission to view it.
| parameter | value | description |
|---|---|---|
projectIdOrKey |
the project id or project key |
|
id |
the project role id |
|
projectIdOrKey |
the project id or project key |
Details on a given project role.
available response representations:
{"self":"http://www.example.com/jira/rest/api/2/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"}]}Returned if the project and role exists and the user has permission to view it. Contains the role name, description, and project actors.
Returned if the project or role is not found, or the calling user does not have permission to view it.
Updates a project role to contain the sent actors.
acceptable request representations:
{ "user" : ["admin"] } or
{ "group" : ["jira-developers"] }available response representations:
{"self":"http://www.example.com/jira/rest/api/2/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"}]}Returned if the project and role exists and the user has permission to view it. Contains the role name, description, and project actors.
Returned if the actor could not be added to the project role
Add an actor to a project role.
acceptable request representations:
{ "user" : ["admin"] } or
{ "group" : ["jira-developers"] }available response representations:
{"self":"http://www.example.com/jira/rest/api/2/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"}]}Returned if the project and role exists and the user has permission to view it. Contains the role name, description, and project actors.
Returned if the actor could not be added to the project role
Remove actors from a project role.
available response representations:
Validates a project key.
| parameter | value | description |
|---|---|---|
key |
the project key |
available response representations:
{"errorMessages":[],"errors":{"projectKey":"A project with that project key already exists."}}Returns an ErrorCollection containing any validation errors for the project key.
Returns a list of all resolutions.
available response representations:
[{"self":"http://www.example.com/jira/rest/api/2/resolution/1","description":"A fix for this issue is checked into the tree and tested.","iconUrl":"http://www.example.com/jira/images/icons/statuses/resolved.png","name":"Fixed"},{"self":"http://www.example.com/jira/rest/api/2/resolution/3","description":"This is what it is supposed to do.","name":"Works as designed"}]Returned if the resolutions exists and the user has permission to view them. Contains a full representation of the resolution in JSON format.
| parameter | value | description |
|---|---|---|
id |
a String containing the resolution id |
Returns a resolution.
available response representations:
{"self":"http://www.example.com/jira/rest/api/2/resolution/1","description":"A fix for this issue is checked into the tree and tested.","iconUrl":"http://www.example.com/jira/images/icons/statuses/resolved.png","name":"Fixed"}Returned if the resolution exists and the user has permission to view it. Contains a full representation of the resolution in JSON format.
Returned if the resolution does not exist or the user does not have permission to view it.
| parameter | value | description |
|---|---|---|
screenId |
id of screen |
|
tabId |
id of tab |
Adds field to the given tab
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
id |
||
screenId |
id of screen |
|
tabId |
id of tab |
| parameter | value | description |
|---|---|---|
screenId |
id of screen |
Returns a list of all tabs for the given screen
available response representations:
Creates tab for given screen
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
screenId |
id of screen |
|
tabId |
id of tab |
Renames tab on given screen
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
screenId |
id of screen |
|
tabId |
id of tab |
|
pos |
position of tab |
| parameter | value | description |
|---|---|---|
screenId |
id of screen |
| parameter | value | description |
|---|---|---|
id |
||
screenId |
id of screen |
|
tabId |
id of tab |
Moves field on the given tab
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
fieldId |
id of field / custom field |
Resource for searches.
Searches for issues using JQL.
Sorting
the jql parameter is a full JQL
expression, and includes an ORDER BY clause.
The fields param (which can be specified multiple times) gives a comma-separated list of fields
to include in the response. This can be used to retrieve a subset of fields.
A particular field can be excluded by prefixing it with a minus.
By default, only navigable (*navigable) fields are returned in this search resource. Note: the default is different
in the get-issue resource -- the default there all fields (*all).
*all - include all fields*navigable - include just navigable fieldssummary,comment - include just the summary and comments-description - include navigable fields except the description (the default is *navigable for search)*all,-comment - include everything except commentsGET vs POST: If the JQL query is too large to be encoded as a query param you should instead POST to this resource.
Expanding Issues in the Search Result: It is possible to expand the issues returned by directly specifying the expansion on the expand parameter passed in to this resources.
For instance, to expand the "changelog" for all the issues on the search result, it is neccesary to specify "changelog" as one of the values to expand.
| parameter | value | description |
|---|---|---|
jql |
a JQL query string |
|
startAt |
the index of the first issue to return (0-based) |
|
maxResults |
the maximum number of issues to return (defaults to 50). The maximum allowable value is dictated by the JIRA property 'jira.search.views.default.max'. If you specify a value that is higher than this number, your search results will be truncated. |
|
validateQuery |
Default: true |
whether to validate the JQL query |
fields |
the list of fields to return for each issue. By default, all navigable fields are returned. |
|
expand |
A comma-separated list of the parameters to expand. |
available response representations:
{"expand":"names,schema","startAt":0,"maxResults":50,"total":1,"issues":[{"expand":"","id":"10001","self":"http://www.example.com/jira/rest/api/2/issue/10001","key":"HSP-1"}]}Returns a JSON representation of the search results.
Returned if there is a problem with the JQL query.
Performs a search using JQL.
acceptable request representations:
{"jql":"project = HSP","startAt":0,"maxResults":15,"fields":["summary","status","assignee"]}available response representations:
{"expand":"names,schema","startAt":0,"maxResults":50,"total":1,"issues":[{"expand":"","id":"10001","self":"http://www.example.com/jira/rest/api/2/issue/10001","key":"HSP-1"}]}Returns a JSON representation of the search results.
Returned if there is a problem with the JQL query.
| parameter | value | description |
|---|---|---|
id |
a String containing an issue security level id |
Returns a full representation of the security level that has the given id.
available response representations:
{"self":"http://localhost:8090/jira/rest/api/2/securitylevel/10021","id":"10000","description":"Only the reporter and internal staff can see this issue.","name":"Reporter Only"}Returned if the issue type exists and is visible by the calling user.
Returned if the issue type does not exist, or is not visible to the calling user.
Returns general information about the current JIRA server.
| parameter | value | description |
|---|---|---|
doHealthCheck |
available response representations:
Returns a full representation of the server info in JSON format
Sets the base URL that is configured for this JIRA instance.
acceptable request representations:
http://jira.atlassian.com/Returns the default system columns for issue navigator. Admin permission will be required.
available response representations:
Sets the default system columns for issue navigator. Admin permission will be required.
acceptable request representations:
available response representations:
Returns a list of all statuses
available response representations:
[{"self":"http://localhost:8090/jira/rest/api/2.0/status/10000","description":"The issue is currently being worked on.","iconUrl":"http://localhost:8090/jira/images/icons/progress.gif","name":"In Progress","id":"10000","statusCategory":{"self":"http://localhost:8090/jira/rest/api/2.0/statuscategory/1","id":1,"key":"in-flight","colorName":"yellow"}},{"self":"http://localhost:8090/jira/rest/api/2.0/status/5","description":"The issue is closed.","iconUrl":"http://localhost:8090/jira/images/icons/closed.gif","name":"Closed","id":"5","statusCategory":{"self":"http://localhost:8090/jira/rest/api/2.0/statuscategory/9","id":9,"key":"completed","colorName":"green"}}]Returns a list of all JIRA issue statuses in JSON format, that are visible to the user.
Returned if the requested issue status is not found, or the user does not have permission to view it.
| parameter | value | description |
|---|---|---|
idOrName |
a numeric Status id or a status name |
Returns a full representation of the Status having the given id or name.
available response representations:
{"self":"http://localhost:8090/jira/rest/api/2.0/status/10000","description":"The issue is currently being worked on.","iconUrl":"http://localhost:8090/jira/images/icons/progress.gif","name":"In Progress","id":"10000","statusCategory":{"self":"http://localhost:8090/jira/rest/api/2.0/statuscategory/1","id":1,"key":"in-flight","colorName":"yellow"}}Returns a full representation of a JIRA issue status in JSON format.
Returned if the requested issue status is not found, or the user does not have permission to view it.
Returns a list of all status categories
available response representations:
[{"self":"http://localhost:8090/jira/rest/api/2.0/statuscategory/1","id":1,"key":"in-flight","colorName":"yellow"},{"self":"http://localhost:8090/jira/rest/api/2.0/statuscategory/9","id":9,"key":"completed","colorName":"green"}]Returns a list of all JIRA issue status categories in JSON format, that are visible to the user.
Returned if no status categories are found, or the user does not have permission to view them.
| parameter | value | description |
|---|---|---|
idOrKey |
a numeric StatusCategory id or a status category key |
Returns a full representation of the StatusCategory having the given id or key
available response representations:
{"self":"http://localhost:8090/jira/rest/api/2.0/statuscategory/1","id":1,"key":"in-flight","colorName":"yellow"}Returns a full representation of a JIRA issue status category in JSON format.
Returned if the requested issue status category is not found, or the user does not have permission to view it.
Returns a user. This resource cannot be accessed anonymously.
| parameter | value | description |
|---|---|---|
username |
the username |
|
key |
user key |
available response representations:
{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","emailAddress":"fred@example.com","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":true,"timeZone":"Australia/Sydney","groups":{"size":3,"items":[]}}Returns a full representation of a JIRA user in JSON format.
Returned if the current user is not authenticated.
Returned if the requested user is not found.
Modify user. The "value" fields present will override the existing value. Fields skipped in request will not be changed.
| parameter | value | description |
|---|---|---|
username |
the username |
|
key |
user key |
acceptable request representations:
{"name":"eddie","emailAddress":"eddie@atlassian.com","displayName":"Eddie of Atlassian"}available response representations:
{"self":"http://www.example.com/jirahttp://www.example.com/jira/rest/api/2/user/charlie","key":"charlie","name":"charlie","emailAddress":"charlie@atlassian.com","displayName":"Charlie of Atlassian"}Returned if the user exists and the caller has permission to edit it.
Returned if the request is invalid.
Returned if the caller user does not have permission to edit the user.
Returned if the caller does have permission to edit the user but the user does not exist.
Create user. By default created user will not be notified with email. If password field is not set then password will be randomly generated.
acceptable request representations:
{"name":"charlie","password":"abracadabra","emailAddress":"charlie@atlassian.com","displayName":"Charlie of Atlassian"}available response representations:
{"self":"http://www.example.com/jirahttp://www.example.com/jira/rest/api/2/user/charlie","key":"charlie","name":"charlie","emailAddress":"charlie@atlassian.com","displayName":"Charlie of Atlassian"}Returned if the user was created.
Returned if the request is invalid.
Returned if the caller user does not have permission to create the user.
Returned if the user was not created because of other error.
Removes user.
| parameter | value | description |
|---|---|---|
username |
the username |
|
key |
user key |
available response representations:
Returned if the user was deleted successfully.
Returned if the request is invalid or some other server error occurred.
Returned if the caller does not have permission to remove the user.
Returned if the caller does have permission to remove user but the user does not exist.
Returns a list of users that match the search string and can be assigned issues for all the given projects. This resource cannot be accessed anonymously.
| parameter | value | description |
|---|---|---|
username |
the username |
|
projectKeys |
the keys of the projects we are finding assignable users for, comma-separated |
|
startAt |
the index of the first user to return (0-based) |
|
maxResults |
the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated. |
available response representations:
[{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},{"self":"http://www.example.com/jira/rest/api/2/user?username=andrew","name":"andrew","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=andrew","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=andrew","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=andrew","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=andrew"},"displayName":"Andrew Anderson","active":false}]Returns a full representation of a JIRA user in JSON format.
Returned if the current user is not authenticated.
Returned if the requested user is not found.
Returns a list of users that match the search string. This resource cannot be accessed anonymously. Please note that this resource should be called with an issue key when a list of assignable users is retrieved for editing. For create only a project key should be supplied. The list of assignable users may be incorrect if it's called with the project key for editing.
| parameter | value | description |
|---|---|---|
username |
the username |
|
project |
the key of the project we are finding assignable users for |
|
issueKey |
the issue key for the issue being edited we need to find assignable users for. |
|
startAt |
the index of the first user to return (0-based) |
|
maxResults |
the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated. |
|
actionDescriptorId |
available response representations:
{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","emailAddress":"fred@example.com","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":true,"timeZone":"Australia/Sydney","groups":{"size":3,"items":[]}}Returns a full representation of a JIRA user in JSON format.
Returned if no project or issue key was provided
Returned if the current user is not authenticated.
Returned if the requested user is not found.
Converts temporary avatar into a real avatar
| parameter | value | description |
|---|---|---|
username |
username |
acceptable request representations:
{"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"needsCropping":false}available response representations:
{"id":"1000","owner":"fred","isSystemAvatar":true,"isSelected":true,"selected":true}Returns created avatar
Returned if the cropping coordinates are invalid
Returned if the currently authenticated user does not have permission to pick avatar
Returned if the currently authenticated user does not have EDIT PROJECT permission.
Returned if an error occurs while converting temporary avatar to real avatar
| parameter | value | description |
|---|---|---|
id |
database id for avatar |
Deletes avatar
| parameter | value | description |
|---|---|---|
username |
username |
available response representations:
Returned if the avatar is successfully deleted.
Returned if the currently authenticated user does not have permission to delete the avatar.
Returned if the avatar does not exist or the currently authenticated user does not have permission to delete it.
Creates temporary avatar. Creating a temporary avatar is part of a 3-step process in uploading a new avatar for a user: upload, crop, confirm.
The following examples shows these three steps using curl. The cookies (session) need to be preserved between requests, hence the use of -b and -c. The id created in step 2 needs to be passed to step 3 (you can simply pass the whole response of step 2 as the request of step 3).
curl -c cookiejar.txt -X POST -u admin:admin -H "X-Atlassian-Token: no-check" \
-H "Content-Type: image/png" --data-binary @mynewavatar.png \
'http://localhost:8090/jira/rest/api/2/user/avatar/temporary?username=admin&filename=mynewavatar.png'
curl -b cookiejar.txt -X POST -u admin:admin -H "X-Atlassian-Token: no-check" \
-H "Content-Type: application/json" --data '{"cropperWidth": "65","cropperOffsetX": "10","cropperOffsetY": "16"}' \
-o tmpid.json \
http://localhost:8090/jira/rest/api/2/user/avatar?username=admin
curl -b cookiejar.txt -X PUT -u admin:admin -H "X-Atlassian-Token: no-check" \
-H "Content-Type: application/json" --data-binary @tmpid.json \
http://localhost:8090/jira/rest/api/2/user/avatar?username=admin
| parameter | value | description |
|---|---|---|
username |
username |
|
filename |
name of file being uploaded |
|
size |
size of file |
available response representations:
{"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"url":"http://example.com/jira/secure/temporaryavatar?cropped=true","needsCropping":true}temporary avatar cropping instructions
Returned if the request does not conain a valid XSRF token
Returned if the currently authenticated user does not have EDIT PROJECT permission.
Returned if an error occurs while converting temporary avatar to real avatar
Creates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because the client uses remote iframing to submit avatars using multipart. So we must send them a valid HTML page back from which the client parses the JSON from.
Creating a temporary avatar is part of a 3-step process in uploading a new avatar for a user: upload, crop, confirm. This endpoint allows you to use a multipart upload instead of sending the image directly as the request body.
You *must* use "avatar" as the name of the upload parameter:
curl -c cookiejar.txt -X POST -u admin:admin -H "X-Atlassian-Token: no-check" \ -F "avatar=@mynewavatar.png;type=image/png" \ 'http://localhost:8090/jira/rest/api/2/user/avatar/temporary?username=admin'
| parameter | value | description |
|---|---|---|
username |
Username |
available response representations:
{"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"url":"http://example.com/jira/secure/temporaryavatar?cropped=true","needsCropping":true}temporary avatar cropping instructions embeded in HTML page. Error messages will also be embeded in the page.
Returned if user does NOT exist
Returned if an error occurs while converting temporary avatar to real avatar
Returns all avatars which are visible for the currently logged in user.
| parameter | value | description |
|---|---|---|
username |
username |
available response representations:
{"system":[{"id":"1000","owner":"fred","isSystemAvatar":true,"isSelected":true,"selected":true}],"custom":[{"id":"1010","owner":"andrew","isSystemAvatar":false,"isSelected":false,"selected":false}]}Returns a map containing a list of avatars for both custom an system avatars
Returned if the current user is not authenticated.
Returned if the requested user is not found.
Returned if an error occurs while retrieving the list of avatars.
Returns the default columns for the given user. Admin permission will be required to get columns for a user other than the currently logged in user.
| parameter | value | description |
|---|---|---|
username |
username |
available response representations:
Returns a list of columns for configured for the given user
Returned if the current user is not permitted to request the columns for the given user.
Returned if the requested user is not found.
Returned if an error occurs while retrieving the column configuration.
Sets the default columns for the given user. Admin permission will be required to get columns for a user other than the currently logged in user.
acceptable request representations:
available response representations:
Reset the default columns for the given user to the system default. Admin permission will be required to get columns for a user other than the currently logged in user.
| parameter | value | description |
|---|---|---|
username |
username |
available response representations:
Modify user password.
| parameter | value | description |
|---|---|---|
username |
the username |
|
key |
user key |
acceptable request representations:
available response representations:
Returns a list of active users that match the search string and have all specified permissions for the project or issue.
This resource can be accessed by users with ADMINISTER_PROJECT permission for the project or global ADMIN or SYSADMIN rights.
| parameter | value | description |
|---|---|---|
username |
the username filter, list includes all users if unspecified |
|
permissions |
comma separated list of permissions for project or issue returned users must have, see Permissions JavaDoc for the list of all possible permissions. |
|
issueKey |
the issue key for the issue for which returned users have specified permissions. |
|
projectKey |
the optional project key to search for users with if no issueKey is supplied. |
|
startAt |
the index of the first user to return (0-based) |
|
maxResults |
the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated. |
available response representations:
[{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},{"self":"http://www.example.com/jira/rest/api/2/user?username=andrew","name":"andrew","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=andrew","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=andrew","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=andrew","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=andrew"},"displayName":"Andrew Anderson","active":false}]Returns a full representation of a JIRA user in JSON format.
Returned if no project or issue key was provided or when permissions list is empty or contains an invalid entry
Returned if the current user is not authenticated.
Returned if the current user does not have admin rights for the project.
Returned if the requested issue or project is not found.
Returns a list of users matching query with highlighting. This resource cannot be accessed anonymously.
| parameter | value | description |
|---|---|---|
query |
A string used to search username, Name or e-mail address |
|
maxResults |
the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated. |
|
showAvatar |
||
exclude |
available response representations:
{"users":[{"name":"fred","key":"fred","html":"fred@example.com","displayName":"Fred Grumble","avatarUrl":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred"}],"total":25,"header":"Showing 20 of 25 matching groups"}Returns a full representation of a JIRA user in JSON format.
Returned if the current user is not authenticated.
Returned if the requested user is not found.
Returns a list of users that match the search string. This resource cannot be accessed anonymously.
| parameter | value | description |
|---|---|---|
username |
A query string used to search username, name or e-mail address |
|
startAt |
the index of the first user to return (0-based) |
|
maxResults |
the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated. |
|
includeActive |
If true, then active users are included in the results (default true) |
|
includeInactive |
If true, then inactive users are included in the results (default false) |
available response representations:
[{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},{"self":"http://www.example.com/jira/rest/api/2/user?username=andrew","name":"andrew","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=andrew","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=andrew","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=andrew","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=andrew"},"displayName":"Andrew Anderson","active":false}]Returns a full representation of a JIRA user in JSON format.
Returned if the current user is not authenticated.
Returned if the requested user is not found.
Returns a list of active users that match the search string. This resource cannot be accessed anonymously. Given an issue key this resource will provide a list of users that match the search string and have the browse issue permission for the issue provided.
| parameter | value | description |
|---|---|---|
username |
the username filter, no users returned if left blank |
|
issueKey |
the issue key for the issue being edited we need to find viewable users for. |
|
projectKey |
the optional project key to search for users with if no issueKey is supplied. |
|
startAt |
the index of the first user to return (0-based) |
|
maxResults |
the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated. |
available response representations:
[{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":false},{"self":"http://www.example.com/jira/rest/api/2/user?username=andrew","name":"andrew","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=andrew","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=andrew","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=andrew","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=andrew"},"displayName":"Andrew Anderson","active":false}]Returns a full representation of a JIRA user in JSON format.
Returned if no project or issue key was provided
Returned if the current user is not authenticated.
Returned if the requested issue or project is not found.
Create a version via POST.
acceptable request representations:
{"description":"An excellent version","name":"New Version 1","archived":false,"released":true,"releaseDate":"2010-07-06","userReleaseDate":"6/Jul/2010","project":"PXA","projectId":10000}available response representations:
{"description":"An excellent version","name":"New Version 1","archived":false,"released":true,"releaseDate":"2010-07-06","userReleaseDate":"6/Jul/2010","project":"PXA","projectId":10000}Returned if the version is created successfully.
Returned if the currently authenticated user does not have permission to edit the version.
Returned if the version does not exist or the currently authenticated user does not have permission to view it.
| parameter | value | description |
|---|---|---|
id |
a String containing the version id |
Modify a version's sequence within a project. The move version bean has 2 alternative field value pairs:
acceptable request representations:
{"after":"http://www.example.com/jira/rest/api/2/version/10000"}available response representations:
{"self":"http://www.example.com/jira/rest/api/2/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}Returned if the version exists and the currently authenticated user has permission to view it. Contains a full representation of the version moved.
Returned if the version, or target of the version to move after does not exist or the currently authenticated user does not have permission to view it.
| parameter | value | description |
|---|---|---|
id |
Delete a project version.
| parameter | value | description |
|---|---|---|
moveFixIssuesTo |
The version to set fixVersion to on issues where the deleted version is the fix version, If null then the fixVersion is removed. |
|
moveAffectedIssuesTo |
The version to set affectedVersion to on issues where the deleted version is the affected version, If null then the affectedVersion is removed. |
available response representations:
Returns a project version.
| parameter | value | description |
|---|---|---|
expand |
available response representations:
{"self":"http://www.example.com/jira/rest/api/2/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}Returned if the version exists and the currently authenticated user has permission to view it. Contains a full representation of the version.
Returned if the version does not exist or the currently authenticated user does not have permission to view it.
Modify a version via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored.
acceptable request representations:
{"self":"http://www.example.com/jira/rest/api/2/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}available response representations:
Returned if the version exists and the currently authenticated user has permission to edit it.
Returned if the currently authenticated user does not have permission to edit the version.
Returned if the version does not exist or the currently authenticated user does not have permission to view it.
| parameter | value | description |
|---|---|---|
id |
a String containing the version id |
Returns a bean containing the number of fixed in and affected issues for the given version.
available response representations:
{"self":"http://www.example.com/jira/rest/api/2/version/10000","issuesFixedCount":23,"issuesAffectedCount":101}Returned if the version exists and the currently authenticated user has permission to view it. Contains counts of issues fixed in and affecting this version.
Returned if the version does not exist or the currently authenticated user does not have permission to view it.
| parameter | value | description |
|---|---|---|
id |
a String containing the version id |
Returns the number of unresolved issues for the given version
available response representations:
{"self":"http://www.example.com/jira/rest/api/2/version/10000","issuesUnresolvedCount":23}Returned if the version exists and the currently authenticated user has permission to view it. Contains counts of issues unresolved in this version.
Returned if the version does not exist or the currently authenticated user does not have permission to view it.
REST resource for retrieving workflows.
Returns all workflows.
| parameter | value | description |
|---|---|---|
workflowName |
available response representations:
Create a new workflow scheme. The body contains a representation of the new scheme. Values not passed are assumed to be set to their defaults.
acceptable request representations:
{"name":"New Workflow Scheme Name","description":"New Workflow Scheme Description","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId":"WorkflowName"}}available response representations:
{"id":101010,"name":"Workflow Scheme One","description":"Workflow Scheme One Description","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId2":"WorkflowName","IsueTypeId":"WorkflowName"},"draft":false,"self":"http://www.example.com/jira/rest/api/2/workflowscheme/101010"}The newly created scheme.
Returned if there is no user or if the user has not entered a websudo session.
| parameter | value | description |
|---|---|---|
id |
the id of the scheme. |
Update the passed workflow scheme. The body of the request is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created and/or updated when the actual scheme cannot be edited (e.g. when the scheme is being used by a project). Values not appearing the body will not be touched.
acceptable request representations:
{"id":57585,"name":"Updated Workflow Scheme Name","description":"Updated Workflow Scheme Name","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId":"WorkflowName"},"updateDraftIfNeeded":false}available response representations:
{"id":101010,"name":"Workflow Scheme One","description":"Workflow Scheme One Description","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId2":"WorkflowName","IsueTypeId":"WorkflowName"},"draft":false,"self":"http://www.example.com/jira/rest/api/2/workflowscheme/101010"}The updated scheme.
Returned if there is no user or if the user has not entered a websudo session.
Returned if the requested scheme does not exist.
Returns the requested workflow scheme to the caller.
| parameter | value | description |
|---|---|---|
returnDraftIfExists |
Default: false |
when true indicates that a scheme's draft, if it exists, should be queried instead of the scheme itself. |
available response representations:
{"id":101010,"name":"Workflow Scheme One","description":"Workflow Scheme One Description","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId2":"WorkflowName","IsueTypeId":"WorkflowName"},"draft":false,"self":"http://www.example.com/jira/rest/api/2/workflowscheme/101010"}Returned if the scheme exists and the caller has permission to see it.
Returned if there is no user or if the user has not entered a websudo session.
Returned if the requested scheme does not exist.
Delete the passed workflow scheme.
available response representations:
| parameter | value | description |
|---|---|---|
id |
the id of the parent scheme. |
Create a draft for the passed scheme. The draft will be a copy of the state of the parent.
available response representations:
{"id":17218781,"name":"Workflow Scheme Two","description":"Workflow Scheme Two Description","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId2":"WorkflowName","IsueTypeId":"WorkflowName"},"originalDefaultWorkflow":"ParentsDefaultWorkflowName","originalIssueTypeMappings":{"IssueTypeId":"WorkflowName2"},"draft":true,"lastModifiedUser":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","emailAddress":"fred@example.com","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":true,"timeZone":"Australia/Sydney","groups":{"size":3,"items":[]}},"lastModified":"Today 12:45","self":"http://www.example.com/jira/rest/api/2/workflowscheme/17218781/draft"}The newly created scheme.
Returned if there is no user or if the user has not entered a websudo session.
| parameter | value | description |
|---|---|---|
id |
the id of the scheme. |
Return the default workflow from the passed workflow scheme.
| parameter | value | description |
|---|---|---|
returnDraftIfExists |
Default: false |
when true indicates that a scheme's draft, if it exists, should be queried instead of the scheme itself. |
available response representations:
Remove the default workflow from the passed workflow scheme.
| parameter | value | description |
|---|---|---|
updateDraftIfNeeded |
when true will create and return a draft when the workflow scheme cannot be edited (e.g. when it is being used by a project). |
available response representations:
{"id":101010,"name":"Workflow Scheme One","description":"Workflow Scheme One Description","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId2":"WorkflowName","IsueTypeId":"WorkflowName"},"draft":false,"self":"http://www.example.com/jira/rest/api/2/workflowscheme/101010"}Returned on success.
Returned if there is no user or if the user has not entered a websudo session.
Returned if the scheme does not exist.
Set the default workflow for the passed workflow scheme. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.
acceptable request representations:
{"workflow":"WorkflowName","updateDraftIfNeeded":false}available response representations:
{"id":101010,"name":"Workflow Scheme One","description":"Workflow Scheme One Description","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId2":"WorkflowName","IsueTypeId":"WorkflowName"},"draft":false,"self":"http://www.example.com/jira/rest/api/2/workflowscheme/101010"}Returned on success.
Returned if there is no user or if the user has not entered a websudo session.
Returned if the scheme does not exist.
| parameter | value | description |
|---|---|---|
id |
the id of the parent scheme. |
Returns the requested draft workflow scheme to the caller.
available response representations:
{"id":17218781,"name":"Workflow Scheme Two","description":"Workflow Scheme Two Description","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId2":"WorkflowName","IsueTypeId":"WorkflowName"},"originalDefaultWorkflow":"ParentsDefaultWorkflowName","originalIssueTypeMappings":{"IssueTypeId":"WorkflowName2"},"draft":true,"lastModifiedUser":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","emailAddress":"fred@example.com","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":true,"timeZone":"Australia/Sydney","groups":{"size":3,"items":[]}},"lastModified":"Today 12:45","self":"http://www.example.com/jira/rest/api/2/workflowscheme/17218781/draft"}Returned if the scheme exists and the caller has permission to see it.
Returned if there is no user or if the user has not entered a websudo session.
Returned if the requested draft scheme does not exist.
Delete the passed draft workflow scheme.
available response representations:
Update a draft workflow scheme. The draft will created if necessary. The body is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field.
acceptable request representations:
{"id":57585,"name":"Updated Workflow Scheme Name","description":"Updated Workflow Scheme Name","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId":"WorkflowName"},"updateDraftIfNeeded":false}available response representations:
{"id":17218781,"name":"Workflow Scheme Two","description":"Workflow Scheme Two Description","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId2":"WorkflowName","IsueTypeId":"WorkflowName"},"originalDefaultWorkflow":"ParentsDefaultWorkflowName","originalIssueTypeMappings":{"IssueTypeId":"WorkflowName2"},"draft":true,"lastModifiedUser":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","emailAddress":"fred@example.com","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":true,"timeZone":"Australia/Sydney","groups":{"size":3,"items":[]}},"lastModified":"Today 12:45","self":"http://www.example.com/jira/rest/api/2/workflowscheme/17218781/draft"}The updated/created scheme.
Returned if there is no user or if the user has not entered a websudo session.
Returned if the requested scheme does not exist.
| parameter | value | description |
|---|---|---|
id |
the id of the parent scheme. |
Return the default workflow from the passed draft workflow scheme to the caller.
available response representations:
Remove the default workflow from the passed draft workflow scheme.
available response representations:
{"id":17218781,"name":"Workflow Scheme Two","description":"Workflow Scheme Two Description","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId2":"WorkflowName","IsueTypeId":"WorkflowName"},"originalDefaultWorkflow":"ParentsDefaultWorkflowName","originalIssueTypeMappings":{"IssueTypeId":"WorkflowName2"},"draft":true,"lastModifiedUser":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","emailAddress":"fred@example.com","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":true,"timeZone":"Australia/Sydney","groups":{"size":3,"items":[]}},"lastModified":"Today 12:45","self":"http://www.example.com/jira/rest/api/2/workflowscheme/17218781/draft"}Returned on success.
Returned if there is no user or if the user has not entered a websudo session.
Returned if the scheme does not exist.
Set the default workflow for the passed draft workflow scheme.
acceptable request representations:
{"workflow":"WorkflowName","updateDraftIfNeeded":false}available response representations:
{"id":17218781,"name":"Workflow Scheme Two","description":"Workflow Scheme Two Description","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId2":"WorkflowName","IsueTypeId":"WorkflowName"},"originalDefaultWorkflow":"ParentsDefaultWorkflowName","originalIssueTypeMappings":{"IssueTypeId":"WorkflowName2"},"draft":true,"lastModifiedUser":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","emailAddress":"fred@example.com","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":true,"timeZone":"Australia/Sydney","groups":{"size":3,"items":[]}},"lastModified":"Today 12:45","self":"http://www.example.com/jira/rest/api/2/workflowscheme/17218781/draft"}Returned on success.
Returned if there is no user or if the user has not entered a websudo session.
Returned if the scheme does not exist.
| parameter | value | description |
|---|---|---|
id |
the id of the parent scheme. |
|
issueType |
the issue type being set. |
Returns the issue type mapping for the passed draft workflow scheme.
available response representations:
Remove the specified issue type mapping from the draft scheme.
available response representations:
{"id":17218781,"name":"Workflow Scheme Two","description":"Workflow Scheme Two Description","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId2":"WorkflowName","IsueTypeId":"WorkflowName"},"originalDefaultWorkflow":"ParentsDefaultWorkflowName","originalIssueTypeMappings":{"IssueTypeId":"WorkflowName2"},"draft":true,"lastModifiedUser":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","emailAddress":"fred@example.com","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":true,"timeZone":"Australia/Sydney","groups":{"size":3,"items":[]}},"lastModified":"Today 12:45","self":"http://www.example.com/jira/rest/api/2/workflowscheme/17218781/draft"}Returned on success.
Returned if there is no user or if the user has not entered a websudo session.
Returned if either the requested scheme or issue type does not exist.
Set the issue type mapping for the passed draft scheme. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.
acceptable request representations:
{"issueType":"IssueTypeId","workflow":"WorkflowName","updateDraftIfNeeded":false}available response representations:
{"id":17218781,"name":"Workflow Scheme Two","description":"Workflow Scheme Two Description","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId2":"WorkflowName","IsueTypeId":"WorkflowName"},"originalDefaultWorkflow":"ParentsDefaultWorkflowName","originalIssueTypeMappings":{"IssueTypeId":"WorkflowName2"},"draft":true,"lastModifiedUser":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","emailAddress":"fred@example.com","avatarUrls":{"24x24":"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred","16x16":"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred","32x32":"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred","48x48":"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"},"displayName":"Fred F. User","active":true,"timeZone":"Australia/Sydney","groups":{"size":3,"items":[]}},"lastModified":"Today 12:45","self":"http://www.example.com/jira/rest/api/2/workflowscheme/17218781/draft"}Returned on success.
Returned if there is no user or if the user has not entered a websudo session.
Returned if either the requested scheme or issue type does not exist.
| parameter | value | description |
|---|---|---|
id |
the id of the parent scheme. |
Returns the draft workflow mappings or requested mapping to the caller.
| parameter | value | description |
|---|---|---|
workflowName |
the workflow mapping to return. Null can be passed to return all mappings. Must be a valid workflow name. |
available response representations:
{"workflow":"WorkflowName","issueTypes":["IssueTypeId","IssueTypeId2"],"defaultMapping":false}Returned on success.
Returned if there is no user or if the user has not entered a websudo session.
Returned if either the requested scheme or workflow does not exist.
Delete the passed workflow from the draft workflow scheme.
| parameter | value | description |
|---|---|---|
workflowName |
the name of the workflow to delete. |
available response representations:
Update the draft scheme to include the passed mapping. The body is a representation of the workflow mapping. Values not passed are assumed to indicate no change for that field.
| parameter | value | description |
|---|---|---|
workflowName |
the name of the workflow mapping to update. |
acceptable request representations:
{"workflow":"WorkflowName3","issueTypes":["IssueTypeId"],"updateDraftIfNeeded":true}available response representations:
{"id":101010,"name":"Workflow Scheme One","description":"Workflow Scheme One Description","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId2":"WorkflowName","IsueTypeId":"WorkflowName"},"draft":false,"self":"http://www.example.com/jira/rest/api/2/workflowscheme/101010"}The updated scheme.
Returned if there is no user or if the user has not entered a websudo session.
| parameter | value | description |
|---|---|---|
id |
the id of the scheme. |
|
issueType |
the issue type being set. |
Returns the issue type mapping for the passed workflow scheme.
| parameter | value | description |
|---|---|---|
returnDraftIfExists |
Default: false |
when true indicates that a scheme's draft, if it exists, should be queried instead of the scheme itself. |
available response representations:
Remove the specified issue type mapping from the scheme.
| parameter | value | description |
|---|---|---|
updateDraftIfNeeded |
when true will create and return a draft when the workflow scheme cannot be edited (e.g. when it is being used by a project). |
available response representations:
{"id":101010,"name":"Workflow Scheme One","description":"Workflow Scheme One Description","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId2":"WorkflowName","IsueTypeId":"WorkflowName"},"draft":false,"self":"http://www.example.com/jira/rest/api/2/workflowscheme/101010"}Returned on success.
Returned if there is no user or if the user has not entered a websudo session.
Returned if either the requested scheme or issue type does not exist.
Set the issue type mapping for the passed scheme. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.
acceptable request representations:
{"issueType":"IssueTypeId","workflow":"WorkflowName","updateDraftIfNeeded":false}available response representations:
{"id":101010,"name":"Workflow Scheme One","description":"Workflow Scheme One Description","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId2":"WorkflowName","IsueTypeId":"WorkflowName"},"draft":false,"self":"http://www.example.com/jira/rest/api/2/workflowscheme/101010"}Returned on success.
Returned if there is no user or if the user has not entered a websudo session.
Returned if either the requested scheme or issue type does not exist.
| parameter | value | description |
|---|---|---|
id |
the id of the scheme. |
Returns the workflow mappings or requested mapping to the caller for the passed scheme.
| parameter | value | description |
|---|---|---|
workflowName |
the workflow mapping to return. Null can be passed to return all mappings. Must be a valid workflow name. |
|
returnDraftIfExists |
Default: false |
when true indicates that a scheme's draft, if it exists, should be queried instead of the scheme itself. |
available response representations:
{"workflow":"WorkflowName","issueTypes":["IssueTypeId","IssueTypeId2"],"defaultMapping":false}Returned on success.
Returned if there is no user or if the user has not entered a websudo session.
Returned if either the requested scheme or workflow does not exist.
Delete the passed workflow from the workflow scheme.
| parameter | value | description |
|---|---|---|
workflowName |
the name of the workflow to delete. |
|
updateDraftIfNeeded |
flag to indicate if a draft should be created if necessary to delete the workflow from the scheme. |
available response representations:
Update the scheme to include the passed mapping. The body is a representation of the workflow mapping. Values not passed are assumed to indicate no change for that field. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.
| parameter | value | description |
|---|---|---|
workflowName |
the name of the workflow mapping to update. |
acceptable request representations:
{"workflow":"WorkflowName3","issueTypes":["IssueTypeId"],"updateDraftIfNeeded":true}available response representations:
{"id":101010,"name":"Workflow Scheme One","description":"Workflow Scheme One Description","defaultWorkflow":"DefaultWorkflowName","issueTypeMappings":{"IsueTypeId2":"WorkflowName","IsueTypeId":"WorkflowName"},"draft":false,"self":"http://www.example.com/jira/rest/api/2/workflowscheme/101010"}The updated scheme.
Returned if there is no user or if the user has not entered a websudo session.
Implement a REST resource for acquiring a session cookie.
Returns information about the currently authenticated user's session. If the caller is not authenticated they will get a 401 Unauthorized status code.
available response representations:
Creates a new session for a user in JIRA. Once a session has been successfully created it can be used to access any of JIRA's remote APIs and also the web UI by passing the appropriate HTTP Cookie header.
Note that it is generally preferrable to use HTTP BASIC authentication with the REST API. However, this resource may be used to mimic the behaviour of JIRA's log-in page (e.g. to display log-in errors to a user).acceptable request representations:
available response representations:
Returns information about the caller's session if the caller is authenticated.
Note that the response contains theSet-Cookie HTTP headers that must be honoured by the
caller. If you are using a cookie-aware HTTP client then it will handle all Set-Cookie headers
automatically. This is important because setting the JSESSIONID cookie alone may not be
sufficient for the authentication to work.Returned if the login fails due to invalid credentials.
Returned if the login is denied due to a CAPTCHA requirement, throtting, or any other reason. In case of a 403 status code it is possible that the supplied credentials are valid but the user is not allowed to log in at this point in time.
This method invalidates the any current WebSudo session.
available response representations:
Returned if no error occurs