This document does not display the base URLs used by on-premises integrations. The current API version is 1. However, there is also a symbolic version, called latest , which resolves to the latest version supported by the given Jira Software Cloud instance.
Pagination is used for the Jira REST APIs to conserve server resources and limit response size for resources that return potentially large collection of items. Clients can use the startAt , maxResults , and total parameters to retrieve the desired number of results. Note, each API resource or method may have a different limit on the number of items returned, which means you can ask for more than you are given.
The actual number of items returned is an implementation detail and this can be changed over time. Methods marked as experimental may change without an earlier notice. We are looking for your feedback for these methods.
The custom fields are: Sprint , Epic link , Epic name , and Story points. In order to identify the custom field that you want to read or edit, you'll need the custom field id. To obtain the custom field id, retrieve the list of fields from the fields resource and search for the custom field.
It's better to find the field based on the schema where possible e. Returns the value of the property with a given key from the comment identified by the key or by the id. The user who retrieves the property is required to have permissions to read the comment. 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.
The new component applied to issues whose 'id' component will be deleted. If this value is null, then the 'id' component is simply removed from the related isues. Returns the information if the optional features in JIRA are enabled or disabled. If the time tracking is enabled, it also returns the detailed information about time tracking configuration. Valid values include "favourite" for returning only favourite dashboards, and "my" for returning dashboards that are owned by the calling user.
Note that the JIRA server reserves the right to impose a maxResults limit that is lower than the value that a client provides, dues to lack or resources or any other condition. When this happens, your results will be truncated. Callers should always check the returned maxResults to determine the value that is effectively being used. Removes the property from the dashboard item identified by the key or by the id.
Ths user removing the property is required to have permissions to administer the dashboard item. Sets the value of the specified dashboard item's property. You can use this resource to store a custom data against the dashboard item identified by the id.
The user who stores the data is required to have permissions to administer the dashboard item. Returns the value of the property with a given key from the dashboard item identified by the id. The user who retrieves the property is required to have permissions to read the dashboard item. Creates a new filter, and returns newly created filter. Currently sets permissions just using the users default sharing permissions. Returns the default columns for the given filter.
Currently logged in user will be used as the user making such request. Resets the columns for the given filter such that the filter no longer has its own column config.
Adds a share permissions to the given filter. Adding a global permission removes all previous permissions from the filter. 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[]" expand value. This will return 6 users if there are at least 16 users in this group. Indexes are 0-based and inclusive. If you delete a group and content is restricted to that group, the content will be hidden from all users. To prevent this, use this parameter to specify a different group to transfer the restrictions comments and worklogs only to.
This resource returns a paginated list of users who are members of the specified group and its subgroups. Users in the page are ordered by user names. User of this resource is required to have sysadmin or admin permissions. 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. Returns a list of users and groups matching query with highlighting. This resource cannot be accessed anonymously. The maximum allowed value is If you specify a value that is higher than this number, your search results will be truncated. The list of project ids to further restrict the search This parameter can occur multiple times to pass in multiple project ids.
Comma separated value is not supported. This parameter is only used when fieldId is present. The list of issue type ids to further restrict the search. This parameter can occur multiple times to pass in multiple issue type ids. Special values such as -1 all standard issue types , -2 all subtask issue types are supported.
Summarizes index condition of current node. Returned data consists of: nodeId - Node identifier. When false other fields of issueIndex can be not visible. Creates an issue or a sub-task from a JSON representation. 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. 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.
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.
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. You can also include only specified properties or exclude some properties with a minus - sign. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.
Delete an issue. You cannot delete an issue without its subtasks also being deleted. If the issue has no subtasks this parameter is ignored. If the issue has subtasks and this parameter is missing or false, then the issue will not be deleted and an error will be returned.
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. 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. Field should appear either in "fields" or "update", not in both. Admin or project admin permissions are required to disable the notification.
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. Returns all comments for an issue. Results can be ordered by the "created" field which means the date a comment was added. 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 editmeta. The id of the remote issue link to be returned.
If null not provided all remote links for the issue are returned. 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. Perform a transition on an issue. When performing the transition you can update or set other issue fields. 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.
Get a list of the transitions possible for this issue by the current user, along with fields that are required and their types. 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.
Returns all work logs for an issue. Note: Work logs won't be returned if the Log work field is hidden for the project. Valid values are "new" - sets the estimate to a specific value "leave"- leaves the estimate as is "manual" - specify a specific amount to increase remaining estimate by "auto"- Default option. Will automatically adjust the value based on the new timeSpent specified on the worklog.
Returns a specific worklog. Note: The work log won't be returned if the Log work field is hidden for the project. Valid values are "new" - sets the estimate to a specific value "leave"- leaves the estimate as is "auto"- Default option. 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.
Fields not in the screen will not be in the createmeta. If absent, all projects are returned. Specifiying a project that does not exist or that you cannot create issues in is not an error, but it will not be in the results. If null, all projects are returned.
If null, all issue types are returned. Specifiying an issue type that does not exist is not an error. This parameter can be specified multiple times, but is NOT interpreted as a comma-separated list. Returns suggested issues which match the auto-completion query for the user which executes this request. This REST method will check the user's history and the user's browsing context and select this issues, which match the query.
Only issues which match this JQL query will be included in results. The issue which is in context will not be included in the auto-completion result, even if it matches the query. Suggested issues will be only from this project. Add one or more attachments to an issue. This resource expects a multipart post. Most client libraries have classes that make dealing with multipart posts simple.
This means you must submit a header of X-Atlassian-Token: no-check with the request, otherwise it will be blocked. 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. 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. 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. 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. 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. 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. Creates an issue type from a JSON representation and adds the issue newly created issue type to the default issue type scheme.
Deletes the specified issue type. If the issue type has any associated issues, these issues will be migrated to the alternative issue type specified in the parameter. Returns a list of all alternative issue types for the given issue type id. The list will contain these issues types, to which issues assigned to the given issue type can be migrated. The suitable alternatives are issue types which are assigned to the same workflow, the same field configuration and the same screen scheme.
Creates temporary avatar. Creating a temporary avatar is part of a 3-step process in uploading a new avatar for an issue type: upload, crop, confirm. The following examples shows these three steps using curl. The cookies session need to be preserved between requests, hence the use of -b and -c.
The id created in step 2 needs to be passed to step 3 you can simply pass the whole response of step 2 as the request of step 3. 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. This endpoint allows you to use a multipart upload instead of sending the image directly as the request body.
Removes the property from the issue type identified by the id. Ths user removing the property is required to have permissions to edit the issue type.
Sets the value of the specified issue type's property. You can use this resource to store a custom data against an issue type identified by the id. The user who stores the data is required to have permissions to edit an issue type. Returns the value of the property with a given key from the issue type identified by the id.
The user who retrieves the property is required to have permissions to view the issue type. Suggestions are generated only for: "by", "from" and "to".
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 If value is found - status code Removes preference of the currently logged in user.
Preference key must be provided as input parameters key. If preference is unset - status code Sets preference of the currently logged in user. Value must be provided as post body. If key or value parameter is not provided - status code If preference is set - status code Modify currently logged user. Returned if the calling user does not have permission to update the remote issue link, or if issue linking is disabled.
Responses Status Returned if the calling user is not authenticated. The issue does not exist or the user does not have permission to view it. 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. Responses Status Nothing is returned on success. 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. Returned if the user cannot view the issue in question or voting is disabled. Request Example "fred". Returned if the calling user does not have permission to add the watcher to the issue's list of watchers.
Request query parameters parameter type description username string a String containing the name of the user to remove from the watcher list.
Must not be null. Responses Status Returned if a user name query parameter is not supplied. Returned if the calling user does not have permission to remove the watcher from the issue's list of watchers. Request query parameters parameter type description expand string Default: optional comma separated list of parameters to expand: properties provides worklog properties.
Request query parameters parameter type description adjustEstimate string optional allows you to provide specific instructions to update the remaining time estimate of the issue. Will automatically adjust the value based on the new timeSpent specified on the worklog newEstimate string required when "new" is selected for adjustEstimate the new value for the remaining estimate field. Returned if the calling user does not have permission to add the worklog. 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.
Note that: Fields possible for editing are: comment, visibility, started, timeSpent and timeSpentSeconds. Either timeSpent or timeSpentSeconds can be set. Fields which are not set will not be updated.
For a request to be valid, it has to have at least one field change. Returned if the calling user does not have permission to update the worklog. Returned if the calling user does not have permission to delete the worklog. Request query parameters parameter type description projectIds string combined with the projectKeys param, lists the projects with which to filter the results.
Returned if the user does not have permission to view any of the requested projects. Request query parameters parameter type description query string the query. Returned if attachments is disabled or if you don't have permission to add attachments to this issue. Returned if the requested issue is not found, the user does not have permission to view it, or if the attachments exceeds the maximum configured attachment size.
Returned if the calling user does not have permission to view the issue. Returned if the issue with given key or id does not exist or if the property with given key is not found.
Responses Status Returned if the issue key or id is invalid. Returned if the calling user does not have permission to edit the issue.
Responses Status Returned if the issue property is successfully updated. Returned if the calling user does not have permission to browse the worklog.
Returned if the worklog with given key or id does not exist or if the property with given key is not found. Responses Status Returned if the worklog key or id is invalid. Returned if the calling user does not have permission to edit the worklog. Responses Status Returned if the worklog property is successfully updated. Returned if the calling user does not have permission to administer the worklog. The response will contain an error message indicating why it failed to create the comment.
No issue link will be created if it failed to create the comment. If issue linking is disabled or it failed to find one of the issues issue might exist, but it is not visible for this user or it failed to find the specified issue link type. If 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. Issue linking is disabled or you do not have permission to create issue link types. Returned if issue linking is disabled or no issue link type with the given id exists. Responses Status Returned if the user does not have the administrator permission and the scheme is not used in any project where the user has administrative permission.
Returned if the issue type was successfully created. Returned if the request is invalid. This happens when the name is invalid or issue type is subtask on instance which has subtasks disabled.
Returned if the calling user does not have permission to administer JIRA. Returned if there already exists an issue type with the specified name. Returned if the issue type does not exist, or is not visible to the calling user. Request query parameters parameter type description alternativeIssueTypeId string the id of an issue type to which issues associated with the removed issue type will be migrated.
Responses Status Returned if the request is invalid. It happens when there are associated issues with the issue type which is being removed, but it is impossible to migrate these issues to the alternative issue type. Returned if the issue type which is supposed to be removed does not exist or the alternative issue type does not exist.
Returned if the issue type was successfully updated. This happens when the name is invalid or if the avatar with given id does not exist. Request query parameters parameter type description x int optional The X coordinate of the top-left corner of the crop region. Default: 0. Returned if the issue type to update does not exist or if the request does not contain a valid XSRF token.
Returned if the issue type with given id does not exist or if the user does not have permissions to view this issue type. Responses Status Returned if the issue type id is invalid. Returned if the issue type with given id does not exist or if the property with given key is not found.
Responses Status Returned if the issue type property is successfully updated. Returned if the issue type with given id does not exist or if the user does not have permissions to edit this issue type. Request query parameters parameter type description fieldName string the field name for which the suggestions are generated. Typically used by the setup phase of the JIRA application.
This will return an object with a list of errors as key, value pairs. Request query parameters parameter type description key string - key of the preference to be returned. Request query parameters parameter type description key string - key of the preference to be set.
Request query parameters parameter type description key string - key of the preference to be removed. Request query parameters parameter type description startAt long the index of the first notification scheme to return 0 based.
The events can be JIRA system events or events configured by administrator. In case of the system events, data about theirs ids, names and descriptions is provided. In case of custom events, the template event is included as well. Returned if the notification scheme does not exist, or is not visible to the calling user.
Responses Status Returned if user is not logged in. To update just the name and description, do not send permissions list at all. Responses Status Returned if the user is not logged. Returned if the issue priority does not exist or is not visible to the calling user. Request query parameters parameter type description expand string the parameters to expand recent int if this parameter is set then only projects recently accessed by the current user if not logged in then based on HTTP session will be returned maximum count limited to the specified number but no more than Returned if the request is not valid and the project could not be created.
Only non null values sent in JSON will be updated in the project. Returned if the request is not valid and the project could not be updated. Responses Status Returned if the user is not logged in. Returned if the currently authenticated user does not have permission to delete the project. Returned if the project is not found, or the calling user does not have permission to view it. Returned if the avatar does not exist or the currently authenticated user does not have permission to delete it.
Returned if the currently authenticated user does not have permission to pick an avatar or if the request does not contain a valid XSRF token.
Returned if the request is not valid and the project type could not be updated. Results can be ordered by the following fields: sequence name startDate releaseDate Request query parameters parameter type description startAt long the page offset, if not specified then defaults to 0 maxResults int how many results on the page should be included. Returned if the calling user does not have permission to browse the project. Returned if the project with given key or id does not exist or if the property with given key is not found.
Responses Status Returned if the project key or id is invalid. Returned if the calling user does not have permission to edit the project. Responses Status Returned if the project property is successfully updated. Returned if the calling user does not have permission to administer the project. Returned if the project or role is not found, or the calling user does not have permission to view it. 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.
Returned if the project is visible for calling user, but the user doesn't have administrative permissions. Returned if the project does not exist, or is not visible to the calling user. Returned if the user is allowed to access the project, but is not an administrator of the project or JIRA and therefore can't see the notification scheme of the project.
Returned if the user does not have permissions to view the project's configuration. In practice the user needs to be a JRA administrator or the project's administrator to get the assigned permission scheme.
Returned if the project is not found or the user does not have permissions to view the project. Returned if the user does not have permissions to edit project's permission schemes. In practice the user needs to be a JIRA administrator.
Returned if the project is not found or the user does not have permissions to browse it. A response status of indicates that there is not a logged in user and therefore this operation can't be performed.
A response status of indicates that the project type is not accessible for the logged in user. Returned if the caller is not logged in so does not have permission to create project categories. Returned if the caller is authenticated and does not have permission to create project categories is not global admin.
Returned if the project category does not exist or the currently authenticated user does not have permission to view it. Responses Status Returned if the caller is not logged in so does not have permission to delete project categories.
Returned if the caller is authenticated and does not have permission to delete project categories is not global admin. Returned if the project category exists and the currently authenticated user has permission to edit it.
Returned if the caller is not logged in so does not have permission to change project categories. Returned if the caller is authenticated and does not have permission to change project categories is not global admin. Request query parameters parameter type description type string Case insensitive String indicating type of reindex. Request query parameters parameter type description taskId long the id of an indexing task you wish to obtain details on.
Request query parameters parameter type description issueId string the IDs or keys of one or more issues to reindex. Request query parameters parameter type description requestId string the reindex request IDs. Returned if the resolution does not exist or the user does not have permission to view it. Returned if the request json does not have a name field or the name field is invalid empty or starts or ends with whitespace.
Currently this list is global. Returned when both name and description are not given or name field is invalid empty or starts or ends with whitespace. Both name and description must be given. Returned when name or description is not given or the name field is invalid empty or starts or ends with whitespace. May return in the future Request query parameters parameter type description swap long if given, removes a role even if it is used in scheme by replacing the role with the given one Responses Status Returned if given role with given swap id does not exist.
Returned if the project role is used in schemes and roleToSwap query parameter is not given. Returned if user and group are both given or none are given or group or user in their respective lists does not exist. Returned if user and group are not given, both user and group are given or provided group or user does not exist. Returned if screen or tab does not exist. Or move cooridinates invalid. Returned if screen, tab or field does not exist or field is already present on a selected tab.
Request query parameters parameter type description jql string a JQL query string startAt int the index of the first issue to return 0-based maxResults int the maximum number of issues to return defaults to By default, all navigable fields are returned. Admin permission will be required.
Returned if the requested issue status is not found, or the user does not have permission to view it. Returned if no status categories are found, or the user does not have permission to view them. Returned if the requested issue status category is not found, or the user does not have permission to view it. Returned if the task does not exist, or its trace has been already removed from the system. Returned if the user does not have permission to upload an avatar for the given entity.
Returned if the icon type is invalid or if the request does not contain a valid XSRF token. Returned if the caller user does not have permission to create the user. Returned if the caller user does not have permission to edit the user. Returned if the caller does have permission to edit the user but the user does not exist. Request query parameters parameter type description username string the username key string user key Responses Status Returned if the request is invalid or some other server error occurred.
Returned if the caller does have permission to remove user but the user does not exist. Request query parameters parameter type description username string the username projectKeys string the keys of the projects we are finding assignable users for, comma-separated startAt int the index of the first user to return 0-based maxResults int the maximum number of users to return defaults to Request query parameters parameter type description username string the username project string the key of the project we are finding assignable users for issueKey string the issue key for the issue being edited we need to find assignable users for.
Request query parameters parameter type description username string username Responses Status Returned if the current user is not permitted to request the columns for the given user. Returned if an error occurs while resetting the column configuration. Returned if the current user is not permitted to request the columns for the given user.
Request query parameters parameter type description username string the username filter, list includes all users if unspecified permissions string comma separated list of permissions for project or issue returned users must have, see Permissions JavaDoc for the list of all possible permissions.
Returned if no project or issue key was provided or when permissions list is empty or contains an invalid entry. Returned if the current user does not have admin rights for the project. Request query parameters parameter type description username string A query string used to search username, name or e-mail address startAt int the index of the first user to return 0-based maxResults int the maximum number of users to return defaults to Returned if username and property params are missing or property param is not valid.
Request query parameters parameter type description username string the username filter, no users returned if left blank issueKey string the issue key for the issue being edited we need to find viewable users for. Returned if the calling user does not have permission to browse the user. Returned if the user with given key or id does not exist or if the property with given key is not found.
Request query parameters parameter type description userKey string key of the user whose property is to be removed username string username of the user whose property is to be removed Responses Status Returned if the user key or id is invalid. Returned if the calling user does not have permission to edit the user.
Request query parameters parameter type description userKey string key of the user whose property is to be set username string username of the user whose property is to be set Responses Status Returned if the user property is successfully updated.
Returned if the calling user does not have permission to administer the user. Returned if the currently authenticated user does not have permission to edit the version. Returned if the version does not exist or the currently authenticated user does not have permission to view it.
Returned if the version, or target of the version to move after does not exist or the currently authenticated user does not have permission to view it. Returned if the version exists and the currently authenticated user has permission to edit it. Request query parameters parameter type description moveFixIssuesTo string The version to set fixVersion to on issues where the deleted version is the fix version, If null then the fixVersion is removed.
Responses Status Returned if the version is successfully deleted. Returned if the currently authenticated user does not have permission to delete the version. Responses Status Returned if the remote version links are successfully deleted. Returned if the currently authenticated user does not have administrative rights to the project and thereby cannot delete remote links to the version. Returned if the version does not exist, the currently authenticated user does not have permission to view it, or the version does not have any remote links to delete.
Returned if the version or remote version link does not exist or if the user does not have the BROWSE permission for the project that owns the specified version. Responses Status Returned if the remote version link is successfully deleted. Returned if the version does not exist, the currently authenticated user does not have permission to view it, or the version does not have a link for the given global ID. Contains a full representation of every workflow.
Returned if the currently authenticated user does not have administration permission. Trying to add a property that already exists will fail. Request query parameters parameter type description key string the name of the property to add. Can either be "live" or "draft". Returned if no changes were actually made by the request e. Request query parameters parameter type description includeReservedKeys boolean some keys under the "jira.
Can be left off the query to return all properties. Returned if there is no user or if the user has not entered a websudo session. Better PDF Exporter exports Jira issues to PDF documents, to share, print, email, archive and report issues in the standard business document file format.
Lots of PDF templates are available out of the box. Use them as is, customize the content and look and run scripts for data processing, with virtually no limitations! Integrated with all major Jira apps! PDF samples:.
0コメント