List Issues
Definition
The List Issues action in the Jira category allows users to retrieve a filtered list of issues based on specified conditions. This action helps in efficiently managing Jira issues by narrowing down results based on criteria such as summary, description, due date, project, and attachments. Additionally, users can select specific fields they want in the result set, making it a flexible tool for issue tracking and reporting.
Example Use Cases
-
Retrieve Overdue Issues
Fetch all issues with a due date in the past to identify pending or overdue tasks. -
Filter Issues by Project
Get a list of issues belonging to a specific project, making it easier to track project-specific tasks. -
Find Issues with Attachments
Identify issues that include attachments, such as error logs or design files, for better context and troubleshooting. -
Generate Custom Reports
Retrieve only selected fields (e.g., summary, description, and due date) to generate a concise issue report for stakeholders. -
Monitor Specific Keywords in Issues
Search for issues containing specific keywords in the summary or description to track recurring problems or trends.
Inputs Section
-
Connection
This is where you provide the connection to your Jira instance. It ensures that the action can interact with your Jira environment and retrieve the necessary data.
How to Use: Select or establish a connection to your Jira instance. The connection is typically set up when you first configure your Jira integration. -
Jira Cloud
This refers to the unique Cloud ID of your Jira instance in the cloud. It connects your Jira instance to other Atlassian products and authenticates interactions with your Jira data.
How to Use: Choose your Jira Cloud instance from the list of available connections after you’ve established the connection. -
Condition
This allows you to define specific conditions to filter the issues you want to retrieve. Conditions can be based on various attributes like summary, description, due date, project, or attachment.
How to Use: Select the conditions you want to filter your issues by. You can set multiple conditions to refine the list of issues retrieved. For example, you could filter by issues that have a specific due date or belong to a particular project. -
Select Field for Result
This defines which fields you want to include in the output result of your search. You can specify which details about the issues should be returned.
How to Use: Select the fields you want to retrieve for each issue. This could include fields like summary, due date, description, project, and attachments. You can choose multiple fields to get a comprehensive view of each issue.
Step-by-Step Guide
Here’s how you can demonstrate the "List Issues" action in a flow:
Step 1: Set Up the Connection
Choose the appropriate connection or create a new one by entering your Jira credentials and relevant details.
Step 2: Select the Jira Cloud Instance
From the available Jira Cloud instances in your connection, select the specific Jira Cloud instance you want to query.
Step 3: Define the Condition
Add filters or conditions based on the issue attributes you want to search by (e.g., summary, description, due date, project, attachments).
Conditions help narrow down the search results and ensure you get only the issues that match specific criteria.
Step 4: Select Fields for Result
Choose which issue fields you want to include in the results. These could be summary, description, due date, project information, or attachments..
Step 6: Run and Handle the Output
After executing the flow, the list of issues will be available in the output.
Why: The output data can then be used for various purposes, such as reporting, creating tasks, or further automation.
How: Use the results (issue ID, summary, due date, etc.) in subsequent actions in your flow, or store them for reporting purposes.
Summary of Steps in the Flow:
- Set up the Jira connection.
- Select your Jira Cloud instance.
- Define any conditions for filtering the issues.
- Choose the fields to include in the output.
- Execute the flow to retrieve the issues.
- Handle the results in subsequent actions.
Outputs
The "List Issues" action returns a collection of issues with details that you specified in the "Select field for result" section. These outputs provide valuable data that can be used in further actions or processed for reporting, notifications, or automations.
Here’s a breakdown of the outputs:
1. Issue ID
This is the unique identifier assigned to each issue in Jira. It helps you track, reference, or update the issue in later steps.
Example Use: If you need to update or delete a specific issue later in the flow, you can use the Issue ID to refer to that particular issue.
2. Issue Key
The Issue Key is a shorthand identifier for the issue, typically a combination of the project key and issue number (e.g., PROJ-123
).
Example Use: This can be used for quick reference or when you need to link issues or display a more human-readable identifier for your users.
3. Summary
: The Summary is the title or brief description of the issue. It provides an overview of what the issue is about and typically serves as the main description in the Jira interface.
Example Use: You can use the Summary field for generating reports or notifications, summarizing the list of issues in a concise way for quick review.
4. Due Date
The Due Date indicates the target date by which the issue should be completed or resolved.
Example Use: You might use this field to prioritize or schedule work, or even create reminders for upcoming deadlines.
5. Description
The Description provides a detailed explanation or context for the issue. It includes all relevant information needed to understand the problem or task.
Example Use: You can use this field to get more context about the issues to share with a team, assign resources, or develop a resolution plan.
6. Attachments
This field lists any files or documents attached to the issue.
Example Use: If the issues have supporting documents, you could download them or extract information from them to process further in the flow, such as sending them via email or using them for audits.
7. Project Array
This is a collection of project information associated with the issue. It includes:
- id: The unique ID of the project.
- key: The key associated with the project (e.g.,
PROJ
). - name: The name of the project.
Example Use: You can use the Project Array to understand the project context of each issue. This is useful for categorizing, filtering, or organizing issues according to their respective projects. If you want to link or sort the issues by project, you can utilize this array.
Example of Output Results
For instance, if you’re listing issues from a Jira project, the output could look like this:
Issue ID | Issue Key | Summary | Due Date | Description | Attachments | Project |
---|---|---|---|---|---|---|
123 | PROJ-123 | Fix login bug | 2025-02-20 | There is an issue with login. | file1.png, file2.pdf | PROJ , 123 , Project A |
124 | PROJ-124 | Update UI design | 2025-02-25 | The UI needs an update. | file3.jpg | PROJ , 124 , Project B |
- Issue ID: 123, 124
- Issue Key: PROJ-123, PROJ-124
- Summary: Fix login bug, Update UI design
- Due Date: 2025-02-20, 2025-02-25
- Description: Descriptions for each issue
- Attachments: file1.png, file2.pdf, file3.jpg
- Project: Associated with projects
PROJ
for each issue.
These outputs enable you to gather detailed information about each issue and decide how to proceed with further automation steps in your flow, whether it’s sending an email, updating an issue, or generating reports.
Updated 9 days ago