JIRA 6.2 REST API documentation

GET 

/rest/api/2/application-properties?key&permissionLevel&keyFilter

Returns an application property.

request query parameters

available response representations:

• 200 - application/json (property) [expand]

  Example

  {"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.
• 404 [expand]

  Returned if the property does not exist or the currently authenticated user does not have permission to view it.

PUT 

Modify an application property via PUT. The "value" field present in the PUT will override thee existing value.

acceptable request representations:

• */* [expand]

  Example

  {"id":"jira.home","value":"/var/jira/jira-home"}

available response representations:

• 200 [expand]

  Returned if the version exists and the currently authenticated user has permission to edit it.

• 403 [expand]

  Returned if the currently authenticated user does not have permission to edit the version.

• 404 [expand]

  Returned if the version does not exist or the currently authenticated user does not have permission to view it.

GET 

Returns the meta-data for an attachment, including the URI of the actual attached file.

available response representations:

• 200 - application/json (attachment) [expand]

  Example

  {"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":"2014-02-25T01:28:01.880+0000","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.
• 404 [expand]

  Returned if the attachment with the given id does not exist, or is not accessible by the calling user.

DELETE 

Remove an attachment from an issue.

available response representations:

• 204 [expand]

  Returned if successful.

• 403 [expand]

  Returned if attachments is disabled or if you don't have permission to remove attachments from this issue.

• 404 [expand]

  Returned if the attachment is not found

GET 

Returns the meta informations for an attachments, specifically if they are enabled and the maximum upload size allowed.

available response representations:

• 200 - application/json (attachmentMeta) [expand]

  Example

  {"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}.

GET 

Returns current Auditing settings.

available response representations:

• 200 - application/json (settings) [expand]

  Example

  {"enabled":true}

  Returns a JSON representation of settings.

PUT 

Changed current Auditing settings Returns REST representation for the requested group.

acceptable request representations:

• application/json [expand]

available response representations:

• 200 - application/json (settings) [expand]

  Example

  {"enabled":true}

  Returns all Auditing settings currently set.
• 401 [expand]

  Returned if the current user is not a sysadmin.

POST 

Updates the cropping instructions of the temporary avatar.

acceptable request representations:

• application/json [expand]

  Example

  {"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"needsCropping":false}

available response representations:

• 201 - application/json (avatar) [expand]
• 400 [expand]

  Returned if the cropping coordinates are invalid

• 500 [expand]

  Returned if an error occurs while cropping the temporary avatar

POST 

/rest/api/2/avatar/{type}/temporary?filename&size

Creates temporary avatar

request query parameters

available response representations:

• 201 - application/json (avatar) [expand]

  Example

  {"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"url":"http://example.com/jira/secure/temporaryavatar?cropped=true","needsCropping":true}

  temporary avatar cropping instructions
• 400 [expand]

  Valiation failed. For example filesize is beyond max attachment size.

• 403 [expand]

  Returned if the request does not conain a valid XSRF token

• 500 [expand]

  Returned if an error occurs while converting temporary avatar to real avatar

GET 

Returns all system avatars of the given type.

available response representations:

• 200 - application/json (avatars) [expand]

  Example

  {"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.
• 500 [expand]

  Returned if an error occurs while retrieving the list of avatars.

POST 

Create a component via POST.

acceptable request representations:

• application/json [expand]

  Example

  {"name":"Component 1","description":"This is a JIRA component","leadUserName":"fred","assigneeType":"PROJECT_LEAD","isAssigneeTypeValid":false,"project":"PXA"}

available response representations:

• 201 - application/json [expand]

  Example

  {"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.

• 401 [expand]

  Returned if the caller is not logged in and does not have permission to create components in the project.

• 403 [expand]

  Returned if the caller is authenticated and does not have permission to create components in the project.

• 404 [expand]

  Returned if the project does not exist or the currently authenticated user does not have permission to view it.

DELETE 

/rest/api/2/component/{id}?moveIssuesTo

Delete a project component.

request query parameters

available response representations:

• 204 [expand]

  Returned if the component is successfully deleted.

• 403 [expand]

  Returned if the currently authenticated user does not have permission to delete the component.

• 404 [expand]

  Returned if the component does not exist or the currently authenticated user does not have permission to view it.

GET 

Returns a project component.

available response representations:

• 200 - application/json (component) [expand]

  Example

  {"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.
• 404 [expand]

  Returned if there is no component with the given key, or if the calling user does not have permission to view the component.

PUT 

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:

• application/json [expand]

  Example

  {"name":"Component 1","description":"This is a JIRA component","leadUserName":"fred","assigneeType":"PROJECT_LEAD","isAssigneeTypeValid":false}

available response representations:

• 200 [expand]

  Returned if the component exists and the currently authenticated user has permission to edit it.

• 403 [expand]

  Returned if the currently authenticated user does not have permission to edit the component.

• 404 [expand]

  Returned if the component does not exist or the currently authenticated user does not have permission to view it.

GET 

Returns counts of issues related to this component.

available response representations:

• 200 - application/json (issue Count Bean) [expand]

  Example

  {"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.
• 404 [expand]

  Returned if the component does not exist or the currently authenticated user does not have permission to view it.

GET 

Returns a full representation of the Custom Field Option that has the given id.

available response representations:

• 200 - application/json (customFieldOption) [expand]

  Example

  {"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.
• 404 [expand]

  Returned if the Custom Field Option does not exist, or is not visible to the calling user.

GET 

/rest/api/2/dashboard?filter&startAt&maxResults

Returns a list of all dashboards, optionally filtering them.

request query parameters

available response representations:

• 200 [expand]

  Example

  {"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.

GET 

Returns a single dashboard.

available response representations:

• 200 [expand]

  Example

  {"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.

• 404 [expand]

  Returned if there is no dashboard with the specified id, or if the user does not have permission to see it.

GET 

Returns a list of all fields, both System and Custom

available response representations:

• 200 - application/json (List of field) [expand]

  Example

  [{"id":"description","name":"Description","custom":false,"orderable":true,"navigable":true,"searchable":true,"clauseNames":["description"],"schema":{"type":"string","system":"description"}},{"id":"summary","name":"Summary","custom":false,"orderable":true,"navigable":true,"searchable":true,"clauseNames":["summary"],"schema":{"type":"string","system":"summary"}}]

  Contains a full representation of all visible fields in JSON.

POST 

Creates a custom field using a definition (object encapsulating custom field data)

acceptable request representations:

• application/json [expand]

  Example

  {"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:

• 201 [expand]

  Returned if custom field was created. {@link FieldBean#DOC_EXAMPLE_CF}

• 400 [expand]

  Returned if the input is invalid (e.g. invalid values).

• 500 [expand]

  Returned if exception occured during custom field creation.

POST 

/rest/api/2/filter?expand

Creates a new filter, and returns newly created filter. Currently sets permissions just using the users default sharing permissions

request query parameters

acceptable request representations:

• application/json [expand]

  Example

  {"name":"All Open Bugs","description":"Lists all open bugs","jql":"type = Bug and resolution is empty","favourite":true}

available response representations:

• 200 - application/json (filter) [expand]

  Example

  {"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
• 400 [expand]

  Returned if the input is invalid (e.g. filter name was not provided).

GET 

/rest/api/2/filter/{id}?expand

Returns a filter given an id

request query parameters

available response representations:

• 200 - application/json (filter) [expand]

  Example

  {"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
• 400 [expand]

  Returned if there is a problem looking up the filter given the id

PUT 

/rest/api/2/filter/{id}?expand

Updates an existing filter, and returns its new value.

request query parameters

acceptable request representations:

• application/json [expand]

  Example

  {"name":"All Open Bugs","description":"Lists all open bugs","jql":"type = Bug and resolution is empty","favourite":true}

available response representations:

• 200 - application/json (filter) [expand]

  Example

  {"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
• 400 [expand]

  Returned if there is a problem updating up the filter of the given id

DELETE 

Delete a filter.

available response representations:

• 204 [expand]

  Returned if the filter was removed successfully.

• 400 [expand]

  Returned if an error occurs.

• 401 [expand]

  Returned if the calling user is not authenticated.

GET 

Returns the default columns for the given filter. Currently logged in user will be used as the user making such request.

available response representations:

• 200 - application/json (columns) [expand]

  Returns a list of columns for configured for the given user
• 404 [expand]

  Returned if the filter does not have any columns.

• 500 [expand]

  Returned if an error occurs while retrieving the column configuration.

PUT 

Sets the default columns for the given filter.

acceptable request representations:

• application/x-www-form-urlencoded [expand]

available response representations:

• 200 [expand]

  Returned when the columns are saved successfully

• 500 [expand]

  Returned if an error occurs while retrieving the column configuration.

DELETE 

Resets the columns for the given filter such that the filter no longer has its own column config.

available response representations:

• 204 [expand]

  Returned when the columns are reset/removed successfully

• 500 [expand]

  Returned if an error occurs while retrieving the column configuration.

GET 

Returns the default share scope of the logged-in user.

available response representations:

• 200 - application/json [expand]

  Example

  {"scope":"GLOBAL"}

  Returns the default share scope of the logged-in user.

• 400 [expand]

  Returned if there is a problem looking up preferences for the logged-in user

PUT 

Sets the default share scope of the logged-in user. Available values are GLOBAL and PRIVATE.

acceptable request representations:

• application/json [expand]

  Example

  {"scope":"GLOBAL"}

available response representations:

• 200 - application/json [expand]

  Example

  {"scope":"GLOBAL"}

  Returns the new default share scope of the logged-in user.

• 400 [expand]

  Returned if there is a problem setting the preferences for the logged-in user

GET 

/rest/api/2/filter/favourite?expand

Returns the favourite filters of the logged-in user.

request query parameters

available response representations:

• 200 - application/json (filter) [expand]

  Example

  [{"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

POST  (experimental)

Creates a group by given group parameter Returns REST representation for the requested group.

acceptable request representations:

• application/json [expand]

available response representations:

• 201 - application/json (group) [expand]

  Example

  {"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.
• 400 [expand]

  Returned if user requested an empty group name or group already exists

• 401 [expand]

  Returned if the current user is not authenticated.

• 403 [expand]

  Returned if the current user does not have administrator permissions.

• 500 [expand]

  Returned if the operation is not permitted or error occurs while creating the group.

GET 

/rest/api/2/group?groupname&expand

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.

request query parameters

available response representations:

• 200 - application/json (group) [expand]

  Example

  {"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.
• 400 [expand]

  Returned if user requested an empty group name.

• 401 [expand]

  Returned if the current user is not authenticated.

• 403 [expand]

  Returned if the current user does not have administrator permissions.

• 404 [expand]

  Returned if the requested group was not found.

DELETE  (experimental)

/rest/api/2/group?groupname&swapGroup

Deletes a group by given group parameter. Returns no content

request query parameters

available response representations:

• 200 - application/json [expand]

  Returned if the group was deleted.

• 400 [expand]

  Returned if user requested an group that does not exist.

• 401 [expand]

  Returned if the current user is not authenticated.

• 403 [expand]

  Returned if the current user does not have administrator permissions.

• 404 [expand]

  Returned if the requested group was not found.

• 500 [expand]

  Returned if the operation is not permitted or error occurs while deleting the group.

POST  (experimental)

/rest/api/2/group/user?groupname

Adds given user to a group. Returns the current state of the group.

request query parameters

acceptable request representations:

• application/json [expand]

available response representations:

• 201 - application/json (group) [expand]

  Returns full representation of a JIRA group in JSON format.
• 400 [expand]

  Returned if user requested an empty group name or the user already belongs to the group.

• 401 [expand]

  Returned if the current user is not authenticated.

• 403 [expand]

  Returned if the current user does not have administrator permissions.

• 404 [expand]

  Returned if the requested group was not found or requested user was not found.

• 500 [expand]

  Returned if the operation is not permitted or error occurs while adding user the group.

DELETE  (experimental)

/rest/api/2/group/user?groupname&username

Removes given user from a group. Returns no content

request query parameters

available response representations:

• 200 - application/json (group) [expand]

  If the user was removed from the group.
• 400 [expand]

  Returned if user requested an empty group name

• 401 [expand]

  Returned if the current user is not authenticated.

• 403 [expand]

  Returned if the current user does not have administrator permissions.

• 404 [expand]

  Returned if the requested group was not found or the requested user wan not found

• 500 [expand]

  Returned if the operation is not permitted or error occurs while removing user from the group.

GET 

/rest/api/2/groups/picker?query&exclude&maxResults

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.

request query parameters

available response representations:

• 200 - application/json (groupsuggestions) [expand]

  Example

  {"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

GET 

/rest/api/2/groupuserpicker?query&maxResults&showAvatar&fieldId&projectId&issueTypeId

Returns a list of users and groups matching query with highlighting. This resource cannot be accessed anonymously.

request query parameters

available response representations:

• application/json [expand]

POST 

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:

• the issueType field must correspond to a sub-task issue type (you can use /issue/createmeta to discover sub-task issue types), and
• you must provide a parent field in the issue create request containing the id or key of the parent issue.

acceptable request representations:

• application/json [expand]

  Example

  {"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:

• 200 - application/json (issue) [expand]

  Example

  {"id":"10000","key":"TST-24","self":"http://www.example.com/jira/rest/api/2/issue/10000"}

  Returns a link to the created issue.
• 400 [expand]

  Example

  {"errorMessages":["Field 'priority' is required"],"errors":{}}

  Returned if the input is invalid (e.g. missing required fields, invalid field values, and so forth).

POST 

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:

• application/json [expand]

  Example

  {"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:

• 200 - application/json (issue) [expand]

  Example

  {"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.
• 400 [expand]

  Example

  {"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).

GET 

/rest/api/2/issue/{issueIdOrKey}?fields&expand

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 fields
• summary,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.

request query parameters

available response representations:

• 200 - application/json (issue) [expand]

  Example

  {"expand":"renderedFields,names,schema,transitions,operations,editmeta,changelog","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":"2014-02-25T01:28:01.880+0000","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":"2014-02-25T01:28:02.124+0000","updated":"2014-02-25T01:28:02.124+0000","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":"2014-02-25T01:28:02.531+0000","timeSpent":"3h 20m","timeSpentSeconds":12000,"id":"100028"}]},"names":{"sub-tasks":"sub-tasks","timetracking":"timetracking","project":"project","updated":"updated","description":"description","issuelinks":"issuelinks","attachment":"attachment","watcher":"watcher","comment":"comment","worklog":"worklog"},"schema":{}}

  Returns a full representation of a JIRA issue in JSON format.
• 404 [expand]

  Returned if the requested issue is not found, or the user does not have permission to view it.

DELETE 

/rest/api/2/issue/{issueIdOrKey}?deleteSubtasks

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.

request query parameters

available response representations:

• 204 [expand]

  Returned if the issue was removed successfully.

• 400 [expand]

  Returned if an error occurs.

• 401 [expand]

  Returned if the calling user is not authenticated.

• 403 [expand]

  Returned if the calling user does not have permission to delete the issue.

• 404 [expand]

  Returned if the issue does not exist.

PUT 

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:

• application/json [expand]

  Example

  {"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:

• 200 - application/json [expand]

  Returned if it updated the issue succesfully.

• 400 [expand]

  Returned if the requested issue update failed.

PUT 

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:

• application/json [expand]

  Example

  {"name":"harry"}

available response representations:

• 204 [expand]

  Returned if the issue is successfully assigned.

• 400 [expand]

  Returned if there is a problem with the received user representation.

• 401 [expand]

  Returned if the calling user does not have permission to assign the issue.

• 404 [expand]

  Returned if either the issue or the user does not exist.

GET 

/rest/api/2/issue/{issueIdOrKey}/comment?expand

Returns all comments for an issue.

request query parameters

available response representations:

• 200 - application/json [expand]

  Example

  {"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":"2014-02-25T01:28:02.124+0000","updated":"2014-02-25T01:28:02.124+0000","visibility":{"type":"role","value":"Administrators"}}]}

  returns a collection of comments associated with the issue, with count and pagination information.

• 404 [expand]

  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.

POST 

/rest/api/2/issue/{issueIdOrKey}/comment?expand

Adds a new comment to an issue.

request query parameters

acceptable request representations:

• application/json [expand]

  Example

  {"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:

• 201 [expand]

  Example

  {"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":"2014-02-25T01:28:02.124+0000","updated":"2014-02-25T01:28:02.124+0000","visibility":{"type":"role","value":"Administrators"}}

  Returned if add was successful

• 400 [expand]

  Returned if the input is invalid (e.g. missing required fields, invalid values, and so forth).

GET 

/rest/api/2/issue/{issueIdOrKey}/comment/{id}?expand

Returns all comments for an issue.

request query parameters

available response representations:

• 200 - application/json [expand]

  Example

  {"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":"2014-02-25T01:28:02.124+0000","updated":"2014-02-25T01:28:02.124+0000","visibility":{"type":"role","value":"Administrators"}}]}

  returns a collection of comments associated with the issue, with count and pagination information.

• 404 [expand]

  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.

PUT 

/rest/api/2/issue/{issueIdOrKey}/comment/{id}?expand

Updates an existing comment using its JSON representation.

request query parameters

acceptable request representations:

• application/json [expand]

  Example

  {"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:

• 200 [expand]

  Example

  {"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":"2014-02-25T01:28:02.124+0000","updated":"2014-02-25T01:28:02.124+0000","visibility":{"type":"role","value":"Administrators"}}

  Returned if update was successful

• 400 [expand]

  Returned if the input is invalid (e.g. missing required fields, invalid values, and so forth).

DELETE 

Deletes an existing comment .

available response representations:

• 204 [expand]

  Returned if delete was successful

• 400 [expand]

  Returned if the input is invalid (e.g. missing required fields, invalid values, and so forth).

GET 

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:

• 200 - application/json [expand]

  Example

  {"fields":{"summary":{"required":false,"schema":{"type":"array","items":"option","custom":"com.atlassian.jira.plugin.system.customfieldtypes:multiselect","customId":10001},"name":"My Multi Select","hasDefaultValue":false,"operations":["set","add"],"allowedValues":["red","blue"]}}}

  Returns a response containing a Map of FieldBeans for fields editable by the current user.

• 404 [expand]

  Returned if the requested issue is not found or the user does not have permission to view it.

POST 

Sends a notification (email) to the list or recipients defined in the request.

acceptable request representations:

• application/json [expand]

  Example

  {"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:

• 204 [expand]

  Returned if adding to the mail queue was successful

• 400 [expand]

  Returned if the input is invalid (e.g. missing required fields, invalid values, and so forth).

• 403 [expand]

  Returned is outgoing emails are disabled OR no SMTP server is defined.

GET 

/rest/api/2/issue/{issueIdOrKey}/remotelink?globalId

A REST sub-resource representing the remote issue links on the issue.

request query parameters

available response representations:

• 200 - application/json [expand]

  Example

  [{"id":10000,"self":"http://www.example.com/jira/rest/api/issue/MKY-1/remotelink/10000","globalId":"system=http://www.mycompany.com/support&id=1","application":{"type":"com.acme.tracker","name":"My Acme Tracker"},"relationship":"causes","object":{"url":"http://www.mycompany.com/support?id=1","title":"TSTSUP-111","summary":"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.

• 401 [expand]

  Returned if the calling user is not authenticated.

• 403 [expand]

  Returned if the calling user does not have permission to view the remote issue links, or if issue linking is disabled.

• 404 [expand]

  Returned if the issue or remote issue link do not exist.

POST 

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:

• application/json [expand]

  Example

  {"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:

• 200 - application/json (remote issue link) [expand]

  Example

  {"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.
• 400 [expand]

  Example

  {"errorMessages":[],"errors":{"title":"'title' is required."}}

  Returned if the input is invalid (e.g. missing required fields, invalid values, and so forth).

• 401 [expand]

  Returned if the calling user is not authenticated.

• 403 [expand]

  Returned if the calling user does not have permission to create/update the remote issue link, or if issue linking is disabled.

DELETE 

/rest/api/2/issue/{issueIdOrKey}/remotelink?globalId

Delete the remote issue link with the given global id on the issue.

request query parameters

available response representations:

• 204 [expand]

  Returned if the remote issue link was removed successfully.

• 401 [expand]

  Returned if the calling user is not authenticated.

• 403 [expand]

  Returned if the calling user does not have permission to delete the remote issue link, or if issue linking is disabled.

• 404 [expand]

  Returned if the issue or remote issue link do not exist.

GET 

Get the remote issue link with the given id on the issue.

available response representations:

• 200 - application/json [expand]

  Example

  {"id":10000,"self":"http://www.example.com/jira/rest/api/issue/MKY-1/remotelink/10000","globalId":"system=http://www.mycompany.com/support&id=1","application":{"type":"com.acme.tracker","name":"My Acme Tracker"},"relationship":"causes","object":{"url":"http://www.mycompany.com/support?id=1","title":"TSTSUP-111","summary":"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.

• 400 [expand]

  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.

• 401 [expand]

  Returned if the calling user is not authenticated.

• 403 [expand]

  Returned if the calling user does not have permission to view the remote issue link, or if issue linking is disabled.

• 404 [expand]

  Returned if the issue or remote issue link do not exist.

PUT 

Updates a remote issue link from a JSON representation. Any fields not provided are set to null.

acceptable request representations:

• application/json [expand]

  Example

  {"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:

• 204 [expand]

  Returned if the remote issue link was updated successfully.

• 400 [expand]

  Example

  {"errorMessages":[],"errors":{"title":"'title' is required."}}

  Returned if the input is invalid (e.g. missing required fields, invalid values, and so forth).

• 401 [expand]

  Returned if the calling user is not authenticated.

• 403 [expand]

  Returned if the calling user does not have permission to update the remote issue link, or if issue linking is disabled.

DELETE 

Delete the remote issue link with the given id on the issue.

available response representations:

• 204 [expand]

  Returned if the remote issue link was removed successfully.

• 401 [expand]

  Returned if the calling user is not authenticated.

• 403 [expand]

  Returned if the calling user does not have permission to delete the remote issue link, or if issue linking is disabled.

• 404 [expand]

  Returned if the issue or remote issue link do not exist.

GET 

/rest/api/2/issue/{issueIdOrKey}/transitions?transitionId

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.

request query parameters

available response representations:

• 200 - application/json [expand]

  Example

  {"expand":"transitions","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","name":"In Progress"}},"fields":{"summary":{"required":false,"schema":{"type":"array","items":"option","custom":"com.atlassian.jira.plugin.system.customfieldtypes:multiselect","customId":10001},"name":"My Multi Select","hasDefaultValue":false,"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","hasDefaultValue":false,"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","hasDefaultValue":false,"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.

• 404 [expand]

  Returned if the requested issue is not found or the user does not have permission to view it.

POST 

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:

• application/json [expand]

  Example

  {"update":{"comment":[{"add":{"body":"Bug has been fixed."}}]},"fields":{"assignee":{"name":"bob"},"resolution":{"name":"Fixed"}},"transition":{"id":"5"}}

available response representations:

• 204 [expand]

  Returned if the transition was successful.

• 400 [expand]

  If there is no transition specified.

• 404 [expand]

  The issue does not exist or the user does not have permission to view it

DELETE 

Remove your vote from an issue. (i.e. "unvote")

available response representations:

• 204 [expand]

  Nothing is returned on success.

• 404 [expand]

  Returned if the user cannot remove a vote for any reason. (The user did not vote on the issue, the user is the reporter, voting is disabled, the issue does not exist, etc.)

POST 

Cast your vote in favour of an issue.

available response representations:

• 204 [expand]

  Nothing is returned on success.

• 404 [expand]

  Returned if the user cannot vote for any reason. (The user is the reporter, the user does not have permission to vote, voting is disabled in the instance, the issue does not exist, etc.)

GET 

A REST sub-resource representing the voters on the issue.

available response representations:

• 200 - application/json [expand]

  Example

  {"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.

• 404 [expand]

  Returned if the user cannot view the issue in question or voting is disabled.

GET 

Returns the list of watchers for the issue with the given key.

available response representations:

• 200 - application/json (watchers) [expand]

  Example

  {"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.
• 404 [expand]

  Returned if the requested issue is not found, or the user does not have permission to view it.

POST 

Adds a user to an issue's watcher list.

acceptable request representations:

• application/json [expand]

  Example

  "fred"

available response representations:

• 204 [expand]

  Returned if the watcher was added successfully.

• 400 [expand]

  Returned if there is a problem with the received user representation.

• 401 [expand]

  Returned if the calling user does not have permission to add the watcher to the issue's list of watchers.

• 404 [expand]

  Returned if either the issue or the user does not exist.

DELETE 

/rest/api/2/issue/{issueIdOrKey}/watchers?username

Removes a user from an issue's watcher list.

request query parameters

available response representations:

• 204 [expand]

  Returned if the watcher was removed successfully.

• 400 [expand]

  Returned if a user name query parameter is not supplied.

• 401 [expand]

  Returned if the calling user does not have permission to remove the watcher from the issue's list of watchers.

• 404 [expand]

  Returned if either the issue does not exist.

GET 

Returns all work logs for an issue.

available response representations:

• 200 - application/json [expand]

  Example

  {"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":"2014-02-25T01:28:02.531+0000","timeSpent":"3h 20m","timeSpentSeconds":12000,"id":"100028"}]}

  returns a collection of worklogs associated with the issue, with count and pagination information.

• 404 [expand]

  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.

POST 

/rest/api/2/issue/{issueIdOrKey}/worklog?adjustEstimate&newEstimate&reduceBy

Adds a new worklog entry to an issue.

request query parameters

acceptable request representations:

• application/json [expand]

  Example

  {"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":"2014-02-25T01:28:02.531+0000","timeSpent":"3h 20m","timeSpentSeconds":12000,"id":"100028"}

available response representations:

• 201 [expand]

  Returned if add was successful

• 400 [expand]

  Returned if the input is invalid (e.g. missing required fields, invalid values, and so forth).

• 403 [expand]

  Returned if the calling user does not have permission to add the worklog

GET 

Returns a specific worklog.

available response representations:

• 200 - application/json (worklog) [expand]

  Example

  {"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":"2014-02-25T01:28:02.531+0000","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.
• 404 [expand]

  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.

PUT 

/rest/api/2/issue/{issueIdOrKey}/worklog/{id}?adjustEstimate&newEstimate

Updates an existing worklog entry using its JSON representation.

request query parameters

acceptable request representations:

• application/json [expand]

  Example

  {"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":"2014-02-25T01:28:02.531+0000","timeSpent":"3h 20m","timeSpentSeconds":12000,"id":"100028"}

available response representations:

• 200 [expand]

  Example

  {"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":"2014-02-25T01:28:02.531+0000","timeSpent":"3h 20m","timeSpentSeconds":12000,"id":"100028"}

  Returned if update was successful

• 400 [expand]

  Returned if the input is invalid (e.g. missing required fields, invalid values, and so forth).

• 403 [expand]

  Returned if the calling user does not have permission to update the worklog

DELETE 

/rest/api/2/issue/{issueIdOrKey}/worklog/{id}?adjustEstimate&newEstimate&increaseBy

Deletes an existing worklog entry .

request query parameters

available response representations:

• 204 [expand]

  Returned if delete was successful

• 400 [expand]

  Returned if the input is invalid (e.g. missing required fields, invalid values, and so forth).

• 403 [expand]

  Returned if the calling user does not have permission to delete the worklog

GET 

/rest/api/2/issue/createmeta?projectIds&projectKeys&issuetypeIds&issuetypeNames

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.

request query parameters

available response representations:

• 200 - application/json [expand]

  Example

  {"expand":"projects","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","hasDefaultValue":false,"operations":["set"]}}}]}]}

  Returns the meta data for creating issues.

• 403 [expand]

  Returned if the user does not have permission to view any of the requested projects.

POST 

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:

• 200 - application/json [expand]

  Example

  [{"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":"2014-02-25T01:28:01.880+0000","size":23123,"mimeType":"image/jpeg","content":"http://www.example.com/jira/attachments/10000","thumbnail":"http://www.example.com/jira/secure/thumbnail/10000"},{"self":"http://www.example.com/jira/rest/api/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":"2014-02-25T01:28:01.880+0000","size":2460,"mimeType":"text/plain","content":"http://www.example.com/jira/attachments/10001","thumbnail":"http://www.example.com/jira/secure/thumbnail/10002"}]

• 403 [expand]

  Returned if attachments is disabled or if you don't have permission to add attachments to this issue.

• 404 [expand]

  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.

GET  (experimental)

Returns the keys of all properties for the issue identified by the key or by the id.

available response representations:

• 200 - application/json (issue-properties-keys) [expand]

  Example

  {"keys":[{"self":"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support","key":"issue.support"}]}

  Returned if the issue was found.
• 400 [expand]

  Returned if the issue key or id is invalid.

• 401 [expand]

  Returned if the calling user is not authenticated.

• 403 [expand]

  Returned if the calling user does not have permission to view the issue.

• 404 [expand]

  Returned if the issue with given key or id does not exist or if the property with given key is not found.

PUT  (experimental)

Sets the value of the specified issue's property.

You can use this resource to store a custom data against the issue identified by the key or by the id. The user who stores the data is required to have permissions to edit the issue.

available response representations:

• 200 [expand]

  Returned if the issue property is successfully updated.

• 201 [expand]

  Returned if the issue property is successfully created.

• 400 [expand]

  Returned if the issue key or id is invalid.

• 401 [expand]

  Returned if the calling user is not authenticated.

• 403 [expand]

  Returned if the calling user does not have permission to edit the issue.

• 404 [expand]

  Returned if the issue with given key or id does not exist.

GET  (experimental)

Returns the value of the property with a given key from the issue identified by the key or by the id. The user who retrieves the property is required to have permissions to read the issue.

available response representations:

• 200 - application/json (issue-property) [expand]

  Example

  {"self":"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support","key":"issue.support","value":{}}

  Returned if the issue property was found.
• 400 [expand]

  Returned if the issue key or id is invalid.

• 401 [expand]

  Returned if the calling user is not authenticated.

• 403 [expand]

  Returned if the calling user does not have permission to view the issue.

• 404 [expand]

  Returned if the issue with given key or id does not exist or if the property with given key is not found.

DELETE  (experimental)

Removes the property from the issue identified by the key or by the id. Ths user removing the property is required to have permissions to edit the issue.

available response representations:

• 204 [expand]

  Returned if the issue property was removed successfully.

• 400 [expand]

  Returned if the issue key or id is invalid.

• 401 [expand]

  Returned if the calling user is not authenticated.

• 403 [expand]

  Returned if the calling user does not have permission to edit the issue.

• 404 [expand]

  Returned if the issue with given key or id does not exist or if the property with given key is not found.

POST 

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:

• application/json [expand]

  Example

  {"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:

• 200 - application/json [expand]

  if the issue link was created successfully.

• 400 [expand]

  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.

• 401 [expand]

  if the user does not have the link issue permission for the issue, which will be linked to another issue.

• 404 [expand]

  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.

• 500 [expand]

  if an error occurred when creating the issue link or the comment.

GET 

Returns an issue link with the specified id.

available response representations:

• 200 - application/json [expand]

  Example

  {"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"}}}}

• 400 [expand]

  If the specified issue link id is invalid.

• 401 [expand]

  if the user does not have the link issue permission for the issue, which will be linked to another issue.

• 404 [expand]

  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.

• 500 [expand]

  if an error occurred when creating the issue link or the comment.

DELETE 

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:

• 200 - application/json [expand]
• 204 [expand]

  If it successfully deleted the issue link.

• 400 [expand]

  If the specified issue link id is invalid.

• 401 [expand]

  if the user does not have the link issue permission for the source or destination issue of the issue link.

• 404 [expand]

  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.

• 500 [expand]

  if an error occurred when deleting the issue link or the comment.

GET 

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:

• 200 - application/json (issueLinkTypes) [expand]

  Example

  {"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.
• 404 [expand]

  Returned if issue linking is disabled.

POST 

Create a new issue link type.

acceptable request representations:

• application/json [expand]

  Example

  {"name":"Duplicate","inward":"Duplicated by","outward":"Duplicates"}

available response representations:

• 201 - application/json (issueLinkType) [expand]

  Example

  {"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.
• 404 [expand]

  Issue linking is disabled or you do not have permission to create issue link types.

GET 

Returns for a given issue link type id all information about this issue link type.

available response representations:

• 200 - application/json (issueLinkType) [expand]

  Example

  {"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.
• 404 [expand]

  Returned if issue linking is disabled or no issue link type with the given id exists.

DELETE 

Delete the specified issue link type.

available response representations:

• 204 (issueLinkType) [expand]
• 404 [expand]

  Returned if issue linking is disabled or no issue link type with the given id exists.

PUT 

Update the specified issue link type.

acceptable request representations:

• application/json [expand]

  Example

  {"name":"Duplicate","inward":"Duplicated by","outward":"Duplicates"}

available response representations:

• 200 [expand]

  Example

  {"id":"1000","name":"Duplicate","inward":"Duplicated by","outward":"Duplicates","self":"http://www.example.com/jira/rest/api/2//issueLinkType/1000"}

• 400 [expand]

  Returned if the supplied id is not a number.

• 404 [expand]

  Returned if issue linking is disabled or no issue link type with the given id exists.

GET 

Returns a list of all issue types visible to the user

available response representations:

• 200 - application/json [expand]

  Example

  [{"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.

GET 

Returns a full representation of the issue type that has the given id.

available response representations:

• 200 - application/json (issueType) [expand]

  Example

  {"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.
• 404 [expand]

  Returned if the issue type does not exist, or is not visible to the calling user.

GET 

Returns the auto complete data required for JQL searches.

available response representations:

• 200 - application/json [expand]

  Example

  "{\"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.

• 401 [expand]

  Returned if the calling user is not authenticated.

• 500 [expand]

  Returned if an error occurs while generating the response.

POST 

acceptable request representations:

• application/json [expand]

available response representations:

• application/json [expand]

GET 

/rest/api/2/mypermissions?projectKey&projectId&issueKey&issueId

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)

• When no context supplied the project related permissions will return true if the user has that permission in ANY project
• If a project context is provided, project related permissions will return true if the user has the permissions in the specified project. For permissions that are determined using issue data (e.g Current Assignee), true will be returned if the user meets the permission criteria in ANY issue in that project
• If an issue context is provided, it will return whether or not the user has each permission in that specific issue

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.

request query parameters

available response representations:

• 200 - application/json (permission) [expand]

  Example

  {"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.
• 400 [expand]

  Returned if the project or issue id is invalid.

• 404 [expand]

  Returned if the project or issue id or key is not found.

GET 

/rest/api/2/mypreferences?key

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.

request query parameters

available response representations:

• application/json [expand]

PUT 

/rest/api/2/mypreferences?key

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.

request query parameters

acceptable request representations:

• application/json [expand]

available response representations:

• application/json [expand]

DELETE 

/rest/api/2/mypreferences?key

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.

request query parameters

available response representations:

• application/json [expand]

GET 

Returns currently logged user. This resource cannot be accessed anonymously.

available response representations:

• 200 - application/json (user) [expand]

  Example

  {"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":[{"name":"jira-user","self":"http://www.example.com/jira/rest/api/2/group?groupname=jira-user"},{"name":"jira-admin","self":"http://www.example.com/jira/rest/api/2/group?groupname=jira-admin"},{"name":"important","self":"http://www.example.com/jira/rest/api/2/group?groupname=important"}]},"expand":"groups"}

  Returns a full representation of a JIRA user in JSON format.
• 403 [expand]

  Returned if the current user is not authenticated.

• 404 [expand]

  Returned if the the user could not be found.

PUT 

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:

• application/json [expand]

  Example

  {"emailAddress":"eddie@atlassian.com","displayName":"Eddie of Atlassian"}

available response representations:

• 200 - application/json (user) [expand]

  Example

  {"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.
• 400 [expand]

  Returned if the request is invalid.

• 403 [expand]

  Returned if the current user is not authenticated.

• 404 [expand]

  Returned if the the user could not be found.

PUT 

Modify caller password.

acceptable request representations:

• application/json [expand]

available response representations:

• 204 [expand]

  Returned if the user exists and the caller has permission to edit it.

• 403 [expand]

  Returned if the caller does not have permission to change the user password.

• 404 [expand]

  Returned if the caller does have permission to change user password but the user does not exist.

GET 

/rest/api/2/password/policy?hasOldPassword

Returns user-friendly statements governing the system's password policy.

request query parameters

available response representations:

• 200 - application/json [expand]

  Returns an array of message strings.

POST 

acceptable request representations:

• application/json [expand]

available response representations:

• application/json [expand]

POST 

acceptable request representations:

• application/json [expand]

available response representations:

• application/json [expand]

GET 

Returns a list of all issue priorities.

available response representations:

• 200 - application/json (list of priorities) [expand]

  Example

  [{"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.

GET 

Returns an issue priority.

available response representations:

• 200 - application/json (issuePriority) [expand]

  Example

  {"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.
• 404 [expand]

  Returned if the issue priority does not exist or is not visible to the calling user.

GET 

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:

• 200 - application/json (projects) [expand]

  Example

  [{"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.
• 500 [expand]

  Returned if an error occurs while retrieving the list of projects.

GET 

/rest/api/2/project/{projectIdOrKey}?expand

Contains a full representation of a project in JSON format.

All project keys associated with the project will only be returned if expand=projectKeys.

request query parameters

available response representations:

• 200 - application/json (project) [expand]

  Example

  {"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.
• 404 [expand]

  Returned if the project is not found, or the calling user does not have permission to view it.

POST 

Converts temporary avatar into a real avatar

acceptable request representations:

• application/json [expand]

  Example

  {"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"needsCropping":false}

available response representations:

• 201 - application/json (avatar) [expand]

  Example

  {"id":"1000","owner":"fred","isSystemAvatar":true,"isSelected":true,"selected":true}

  Returns created avatar
• 400 [expand]

  Returned if the cropping coordinates are invalid

• 403 [expand]

  Returned if the currently authenticated user does not have permission to pick avatar

• 404 [expand]

  Returned if the currently authenticated user does not have EDIT PROJECT permission.

• 500 [expand]

  Returned if an error occurs while converting temporary avatar to real avatar

PUT 

acceptable request representations:

• application/json [expand]

available response representations:

• application/json [expand]

DELETE 

Deletes avatar

available response representations:

• 204 - application/json [expand]

  Returned if the avatar is successfully deleted.

• 403 [expand]

  Returned if the currently authenticated user does not have permission to delete the component.

• 404 [expand]

  Returned if the avatar does not exist or the currently authenticated user does not have permission to delete it.

POST 

/rest/api/2/project/{projectIdOrKey}/avatar/temporary?filename&size

Creates temporary avatar

request query parameters

available response representations:

• 201 - application/json (avatar) [expand]

  Example

  {"cropperWidth":120,"cropperOffsetX":50,"cropperOffsetY":50,"url":"http://example.com/jira/secure/temporaryavatar?cropped=true","needsCropping":true}

  temporary avatar cropping instructions
• 400 [expand]

  Validation failed. For example filesize is beyond max attachment size.

• 403 [expand]

  Returned if the request does not contain a valid XSRF token

• 404 [expand]

  Returned if the currently authenticated user does not have EDIT PROJECT permission.

• 500 [expand]

  Returned if an error occurs while converting temporary avatar to real avatar

POST 

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:

• 201 - text/html (avatar) [expand]

  Example

  {"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.
• 404 [expand]

  Returned if the currently authenticated user does not have EDIT PROJECT permission.

• 500 [expand]

  Returned if an error occurs while converting temporary avatar to real avatar

GET 

Returns all avatars which are visible for the currently logged in user. The avatars are grouped into system and custom.

available response representations:

• 200 - application/json (avatars) [expand]

  Example

  {"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.
• 404 [expand]

  Returned if the currently authenticated user does not have VIEW PROJECT permission.

• 500 [expand]

  Returned if an error occurs while retrieving the list of avatars.

GET 

Contains a full representation of a the specified project's components.

available response representations:

• 200 - application/json (components) [expand]

  Example

  [{"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.
• 404 [expand]

  Returned if the project is not found, or the calling user does not have permission to view it.

GET 

Get all issue types with valid status values for a project

available response representations:

• 200 - application/json [expand]

  Example

  [{"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.

• 400 [expand]

  Returned if the project is not found, or the calling user does not have permission to view it.

GET 

/rest/api/2/project/{projectIdOrKey}/versions?expand

Contains a full representation of a the specified project's versions.

request query parameters

available response representations:

• 200 - application/json (versions) [expand]

  Example

  [{"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.
• 404 [expand]

  Returned if the project is not found, or the calling user does not have permission to view it.

GET  (experimental)

Returns the keys of all properties for the project identified by the key or by the id.

available response representations:

• 200 - application/json (project-properties-keys) [expand]

  Example

  {"keys":[{"self":"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support","key":"issue.support"}]}

  Returned if the project was found.
• 400 [expand]

  Returned if the project key or id is invalid.

• 401 [expand]

  Returned if the calling user is not authenticated.

• 403 [expand]

  Returned if the calling user does not have permission to browse the project.

• 404 [expand]

  Returned if the project with given key or id does not exist or if the property with given key is not found.

PUT  (experimental)

Sets the value of the specified project's property.

You can use this resource to store a custom data against the project identified by the key or by the id. The user who stores the data is required to have permissions to administer the project.

available response representations:

• 200 [expand]

  Returned if the project property is successfully updated.

• 201 [expand]

  Returned if the project property is successfully created.

• 400 [expand]

  Returned if the project key or id is invalid.

• 401 [expand]

  Returned if the calling user is not authenticated.

• 403 [expand]

  Returned if the calling user does not have permission to administer the project.

• 404 [expand]

  Returned if the project with given key or id does not exist.

GET  (experimental)

Returns the value of the property with a given key from the project identified by the key or by the id. The user who retrieves the property is required to have permissions to read the project.

available response representations:

• 200 - application/json (project-property) [expand]

  Example

  {"self":"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support","key":"issue.support","value":{}}

  Returned if the project property was found.
• 400 [expand]

  Returned if the project key or id is invalid.

• 401 [expand]

  Returned if the calling user is not authenticated.

• 403 [expand]

  Returned if the calling user does not have permission to browse the project.

• 404 [expand]

  Returned if the project with given key or id does not exist or if the property with given key is not found.

DELETE  (experimental)

Removes the property from the project identified by the key or by the id. Ths user removing the property is required to have permissions to administer the project.

available response representations:

• 204 [expand]

  Returned if the project property was removed successfully.

• 400 [expand]

  Returned if the project key or id is invalid.

• 401 [expand]

  Returned if the calling user is not authenticated.

• 403 [expand]

  Returned if the calling user does not have permission to edit the project.

• 404 [expand]

  Returned if the project with given key or id does not exist or if the property with given key is not found.

GET 

Contains a list of roles in this project with links to full details.

available response representations:

• 200 - application/json [expand]

  Example

  {"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.

• 404 [expand]

  Returned if the project is not found, or the calling user does not have permission to view it.

GET 

Details on a given project role.

available response representations:

• 200 - application/json [expand]

  Example

  {"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.

• 404 [expand]

  Returned if the project or role is not found, or the calling user does not have permission to view it.

PUT 

Updates a project role to contain the sent actors.

acceptable request representations:

• application/json [expand]

  Example

  { "user" : ["admin"] } or
  { "group" : ["jira-developers"] }

available response representations:

• 200 - application/json [expand]

  Example

  {"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.

• 404 [expand]

  Returned if the actor could not be added to the project role

POST 

Add an actor to a project role.

acceptable request representations:

• application/json [expand]

  Example

  { "user" : ["admin"] }  or
  { "group" : ["jira-developers"] }

available response representations:

• 200 - application/json [expand]

  Example

  {"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.

• 404 [expand]

  Returned if the actor could not be added to the project role

DELETE 

Remove actors from a project role.

available response representations:

• 204 [expand]

  Returned if the actor was successfully removed from the project role.

• 404 [expand]

  Returned if the project or role is not found, the calling user does not have permission to view it, or does not have permission to modify the actors in the project role.

GET 

/rest/api/2/projectvalidate/key?key

Validates a project key.

request query parameters

available response representations:

• 200 - application/json (errorCollection) [expand]

  Example

  {"errorMessages":[],"errors":{"projectKey":"A project with that project key already exists."}}

  Returns an ErrorCollection containing any validation errors for the project key.

POST 

/rest/api/2/reindex?type&indexComments&indexChangeHistory

Kicks off a reindex. Need Admin permissions to perform this reindex.

request query parameters

available response representations:

• 202 - application/json [expand]

  Example

  {"progressUrl":"http://localhost:8080/jira","currentProgress":0,"type":"FOREGROUND","submittedTime":"2014-02-25T01:28:01.843+0000","startTime":"2014-02-25T01:28:01.843+0000","finishTime":"2014-02-25T01:28:01.843+0000","success":true}

  Returns a representation of the progress of the re-index operation.

GET 

/rest/api/2/reindex?taskId

Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned. If there is no active index task, then returns information about the latest reindex task run, otherwise returns a 404 indicating that no reindex has taken place.

request query parameters

available response representations:

• 200 - application/json [expand]

  Example

  {"progressUrl":"http://localhost:8080/jira","currentProgress":0,"type":"FOREGROUND","submittedTime":"2014-02-25T01:28:01.843+0000","startTime":"2014-02-25T01:28:01.843+0000","finishTime":"2014-02-25T01:28:01.843+0000","success":true}

  Returns a representation of the progress of the re-index operation.

• 404 [expand]

  Returned if there is no re-indexing task found

GET 

Returns a list of all resolutions.

available response representations:

• 200 - application/json (list of resolutions) [expand]

  Example

  [{"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.

GET 

Returns a resolution.

available response representations:

• 200 - application/json (resolution) [expand]

  Example

  {"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.
• 404 [expand]

  Returned if the resolution does not exist or the user does not have permission to view it.

POST 

Creates tab for given screen

acceptable request representations:

• application/json [expand]

available response representations:

• 200 - application/json (Newly created tab) [expand]

  Example

  {"id":10000,"name":"Fields Tab"}

  Newly created tab in JSON.
• 400 [expand]

  Returned if screen does not exist or tab name is invalid

• 401 [expand]

  Returned if you do not have permissions

GET 

/rest/api/2/screens/{screenId}/tabs?projectKey

Returns a list of all tabs for the given screen

request query parameters

available response representations:

• 200 - application/json [expand]

  Contains a full representation of all visible tabs in JSON.

• 400 [expand]

  Returned if screen does not exist

• 401 [expand]

  Returned if you do not have permissions

POST 

Adds field to the given tab

acceptable request representations:

• application/json [expand]

available response representations:

• 200 [expand]

  Example

  {"id":"summary","name":"Summary"}

  Newly added field as json

• 400 [expand]

  Returned if screen,tab or field does not exist.

• 401 [expand]

  Returned if you do not have permissions

GET 

/rest/api/2/screens/{screenId}/tabs/{tabId}/fields?projectKey

Gets all fields for a given tab

request query parameters

available response representations:

• 200 [expand]

  List of fields for given tab

• 400 [expand]

  Returned if screen or tab does not exist

• 401 [expand]

  Returned if you do not have permissions

DELETE 

Removes field from given tab

available response representations:

• 201 [expand]

  Successfully removed field from tab

• 400 [expand]

  Returned if screen or tab does not exist

• 401 [expand]

  Returned if you do not have permissions

PUT 

Renames tab on given screen

acceptable request representations:

• application/json [expand]

available response representations:

• 200 - application/json (Modified tab) [expand]

  Example

  {"id":10000,"name":"Fields Tab"}

  Modified tab in JSON.
• 400 [expand]

  Returned if screen does not exist or tab name is invalid

• 401 [expand]

  Returned if you do not have permissions

DELETE 

Deletes tab to give screen

available response representations:

• 201 [expand]

  Successfully deleted tab

• 400 [expand]

  Returned if screen or tab does not exist

• 401 [expand]

  Returned if you do not have permissions

POST 

Moves tab position

available response representations:

• 201 [expand]

  Successfully moved tab

• 400 [expand]

  Returned if screen or tab does not exist

• 401 [expand]

  Returned if you do not have permissions

GET 

Gets available fields for screen. i.e ones that haven't already been added.

available response representations:

• 200 [expand]

  List of available fields for screen

• 400 [expand]

  Returned if screen does not exist

• 401 [expand]

  Returned if you do not have permissions