Atlassian Jira Atlassian Jira: Issues

Summary

This module contains actions for viewing & managing Jira Issues.

Actions

jira.issues.

assign_issue

Assign issue to a user.

Minimum Plugin Version: 1.0.0

Input
  • access_details: an AccessDetails dictionary

  • issue_id: an Issue ID

  • user_name: name of the user to be assigned

Output

Nothing is outputted by this action.

Example
1
2
3
4
5
- jira.issues.assign_issue:
    issue_id: ppa-123
    user_name: Jon Smith
  load:
    access_details: access_details

jira.issues.

create_issue

Create a new issue.

Minimum Plugin Version: 1.0.0

Input
  • access_details: an AccessDetails dictionary

  • project_key: Project key or ID

  • summary: Issue summary

  • description: Issue description

  • issue_type: Issue category e.g. Bug

Output

A single Issue dictionary.

Example
1
2
3
4
5
6
7
8
- jira.issues.create_issue:
    project_key: ppa
    summary: Short issue summary
    description: Longer description of this issue
    issue_type: Bug
  load:
    access_details: access_details
  save: new_issue

jira.issues.

get_all

Get all Issues for a Project.

Minimum Plugin Version: 1.0.0

Input
  • access_details: an AccessDetails dictionary

  • project_name: a Project name

Output

A list of Issue dictionaries.

Example
1
2
3
4
5
- jira.issues.get_all:
    project_name: ppa
  load:
    access_details: access_details
  save: all_issues

jira.issues.

get_by_id

Get an Issue using its ID.

Minimum Plugin Version: 1.0.0

Input
  • access_details: an AccessDetails dictionary

  • issue_id: an Issue ID

Output

A single Issue dictionary.

Example
1
2
3
4
5
- jira.issues.get_by_id:
    issue_id: ppa-123
  load:
    access_details: access_details
  save: issue

jira.issues.

input_table

Display a list of Issues in a table, & allow the task operator to make a selection.

The table will have the following columns:

  • ID
  • Issuetype
  • Priority
  • Status
  • Summary
  • Reporter
  • Assignee

Minimum Plugin Version: 1.0.0

Input
  • text: the title of the table

  • issues: a list of Issue dictionaries to display in the table

  • minimum: The minimum number of acceptable selections

  • maximum: The maximum number of acceptable selections

Output

A list of Issue dictionaries.

Tip
  • If neither a minimum or maximum is provided, the task operator will be able to submit 0 selections.

  • If minimum or maximum are provided, the operation will repeat until a valid number of selections is made.

Example

Finding issues with get_all, saving them as issues, & waiting for a single selection:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
- jira.issues.get_all:
    project_name: ppa
  load:
    access_details: access_details
  save: all_issues

- jira.issues.input_table:
    text: Choose an issue
    minimum: 1
    maximum: 1
  load:
    issues: all_issues
  save: selected_issue

jira.issues.

output_table

Display a list of Issues in a table.

The table will have the following columns:

  • ID
  • Issuetype
  • Priority
  • Status
  • Summary
  • Reporter
  • Assignee

Minimum Plugin Version: 1.0.0

Input
  • text: the title of the table

  • issues: a single or list of Issue dictionaries

Output

Nothing is outputted by this action.

Single Issue

Finding an issue with get_by_id, saving it as issue, & displaying it:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
- jira.issues.get_by_id:
    issue_id: ppa-123
  load:
    access_details: access_details
  save: issue

- jira.issues.output_table:
    text: Issue ppa-123
  load:
    issues: issue
Multiple Issues

Finding all issue with get_all, saving them as all_project_issues, & displaying them:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
- jira.issues.get_all:
    project_name: ppa
  load:
    access_details: access_details
  save: all_project_issues

- jira.issue.output_table:
    text: All Issues
  load:
    issues: all_project_issues

jira.issues.

transition_issue

Update Issue status.

Minimum Plugin Version: 1.0.0

Input
  • access_details: an AccessDetails dictionary

  • issue_id: an Issue ID

  • status_name: Issue status name

Output

A single Issue dictionary.

Example
1
2
3
4
5
- jira.issues.transition_issue:
    issue_id: ppa-123
    status_name: Done
  load:
    access_details: access_details