Jira

Writes

• Create issue

  read back

  jira-create-issue

  Create one issue in a project with a summary, a plain-text description and optional labels. Take the issue type id from list-issue-types; a subtask type is refused, because this action sets no parent. The description becomes one Atlassian Document Format paragraph; headings, lists and formatting are not offered. Set the priority and assignee afterwards with set-issue-priority and assign-issue. Returns the new issue's id and key.

• Rename issue

  read back

  jira-rename-issue

  Change one issue's summary.

• Add issue label

  read back

  jira-add-issue-label

  Add one label to an issue, keeping its other labels. A label has no spaces; Jira creates a label that does not exist yet.

• Set issue priority

  read back

  jira-set-issue-priority

  Set one issue's priority. Take the priority id from list-priorities; a priority outside the project's priority scheme is refused.

• Assign issue

  read back

  jira-assign-issue

  Assign one issue to a user by Atlassian account id. Use get-myself for the connected user's own id, or an assignee or reporter accountId from get-issue. The user must be assignable in the project. Unassigning and the project's default assignee are not offered. Jira can email the new assignee, as its notification scheme says.

• Transition issue

  read back

  jira-transition-issue

  Move one issue through its workflow, for example to In Progress or Done. Take transition_id and to_status_id from the same entry of list-transitions (its id and to.id). A transition whose screen asks for fields (hasScreen) can be refused, because this action sets none.

• Add comment

  read back

  jira-add-comment

  Add one comment to an issue, visible to everyone who can see the issue. The text is sent as one Atlassian Document Format paragraph; formatting, mentions and restricted visibility are not offered. Jira can email the issue's watchers, as its notification scheme says. Returns the comment with its id.

• Delete comment

  read back

  jira-delete-comment

  Delete one comment from an issue. Treat it as final.

• Delete issue

  read back

  jira-delete-issue

  Delete one issue with its comments and history. Treat it as final. An issue with subtasks is refused; delete its subtasks before, or keep the issue.

Reads

• Get myself

  jira-get-myself

  Get the Jira user the connection acts as: account id, display name, email (when the user's privacy settings show it), time zone and whether the account is active. Use its accountId to assign an issue to that user.

• List projects

  jira-list-projects

  List the projects the user can see, 50 a page, optionally filtered by text in the key or name. Each project has its id, key, name and type. The response has startAt, maxResults, total and isLast; when isLast is false, pass startAt plus 50 as start_at for the next page.

• List issue types

  jira-list-issue-types

  List the issue types a project can create, 50 a page: id, name, description and whether it is a subtask type. Use an id with create-issue; a subtask type needs a parent, which create-issue does not set. The response has startAt, maxResults and total.

• List priorities

  jira-list-priorities

  List the issue priorities, 50 a page: id, name, description and whether it is the default. Use an id with set-issue-priority. The response has startAt, maxResults, total and isLast.

• Search issues

  jira-search-issues

  Search issues with JQL, 25 a page. Each issue has its id and key, and the summary, status, assignee, priority, issue type, project, labels and dates. Jira refuses an unbounded query: include a restriction, for example project = OPS AND statusCategory != Done ORDER BY updated DESC. Recent changes can take a moment to show in search; read one issue with get-issue for its current state. When nextPageToken is in the response, pass it as next_page_token for the next page; the last page has none. No total count is returned.

• Get issue

  jira-get-issue

  Get one issue: summary, status, assignee, reporter, priority, issue type, project, labels, description, parent, due date, resolution and dates. The description is Atlassian Document Format (a JSON document), not plain text. Comments are read with list-comments and the moves an issue can make with list-transitions.

• List transitions

  jira-list-transitions

  List the transitions the user can make on an issue from its current status. Each has an id, a name and to, the status it moves the issue to (to.id, to.name). Pass the id and to.id to transition-issue. An empty list means the user may not transition the issue.

• List comments

  jira-list-comments

  List an issue's comments, 20 a page, from the oldest unless order is -created. Each comment has its id, author, body (Atlassian Document Format), and created and updated times. The response has startAt, maxResults and total; pass startAt plus 20 as start_at for the next page.

• Get comment

  jira-get-comment

  Get one comment on an issue: author, body (Atlassian Document Format), and created and updated times.