Jira tools
The 13 Jira operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- Search issuesGETSearches issues with JQL. The query must be bounded, for example project = KEY. Only the issue id comes back unless fields lists what to include. Pass the nextPageToken of the response to read the next page.
- Get issueGETReturns one issue by id or key, with all navigable fields unless fields lists what to include.
- Create issuePOSTCreates an issue. fields needs at least project, issuetype and summary, and any other field must exist on the create screen of the project, as List create fields shows. In this API version the description field takes an Atlassian Document Format object, not plain text.
- Update issuePUTEdits the fields of an issue: fields sets values, and update applies operations such as adding or removing one label. A field goes in fields or in update, never both. The status does not change here: use Transition issue. The response is empty, status 204, unless returnIssue is true.
- Delete issueDELETEDeletes an issue. An issue with subtasks is only deleted with deleteSubtasks set to true, which deletes them too. Needs the Delete issues permission in the project. The response is empty, status 204.
- List transitionsGETLists the transitions the user can make on an issue now, each with the id that Transition issue takes, its name and the status it leads to in to.
- Transition issuePOSTMoves an issue to another status by running one of its transitions. When the transition has a screen, its required fields, such as resolution, go in fields or update. The response is empty, status 204.
- List commentsGETLists the comments of an issue, with the body in Atlassian Document Format. Page with startAt and maxResults until startAt plus the returned count reaches total.
- Create commentPOSTAdds a comment to an issue, visible to everyone who can see the issue. Jira notifies the watchers by the notification scheme of the project. Returns the new comment.
- List projectsGETLists the projects the user can see, with the key and id that the issue tools and JQL take. Page with startAt and maxResults until isLast is true.
- List issue typesGETLists the issue types the user can create in a project, with the id and name that Create issue and List create fields take, and subtask true for subtask types.
- List create fieldsGETLists the fields of the create screen for a project and issue type: the fieldId that Create issue takes, whether it is required, its schema and its allowed values with their ids. Page with startAt and maxResults until total.
- Search assignable usersGETFinds users who can be assigned to new issues of a project or to one issue, with the accountId that the assignee field takes. Send project or issueKey. Returns a list, which can be shorter than maxResults even when more users exist.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
