.. _auto_jira_connection_worker:

*JIRA CONNECTION*
=================

Connects to a Jira Cloud instance via REST API to perform a wide range of project-management operations, including searching, creating, updating, and deleting issues, as well as managing projects, transitions, comments, worklogs, watchers, boards, and sprints. Use this worker whenever a d3VIEW workflow needs to read from or write to Jira as part of an automated engineering or project-tracking pipeline.

When to use
-----------

Tagged: ``atlassian``, ``boards``, ``comments``, ``integration``, ``issues``, ``jira``, ``jira-cloud``, ``jql``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Jira Instance URL
     - jira_url
     - text
     - —
     - ✓
     - Base URL of the Jira Cloud instance (e.g., https://yourorg.atlassian.net); must start with https:// — trailing slashes are stripped automatically.
   * - User Email
     - email
     - text
     - —
     - ✓
     - Atlassian account email address used for Basic-Auth; must match the account that owns the API token.
   * - API Token
     - api_token
     - text
     - —
     - ✓
     - Atlassian API token (generated at id.atlassian.com) used for authentication; never use an account password here.
   * - Operation
     - operation
     - select
     - —
     - ✓
     - The Jira REST API operation to execute (e.g., search_issues, create_issue, transition_issue); determines which other inputs are required.
   * - JQL Query
     - jql_query
     - textarea
     - —
     - 
     - JQL filter string required when operation is search_issues (e.g., 'project = PROJ AND status = Open'); leave blank for all other operations.
   * - Issue Key
     - issue_key
     - text
     - —
     - 
     - Jira issue key (e.g., PROJ-123) required for issue-level operations such as get_issue, update_issue, add_comment, and transition_issue; leave blank for project- or board-level operations.
   * - Project Key
     - project_key
     - text
     - —
     - 
     - Jira project key (e.g., PROJ) required only when operation is get_project; leave blank for all other operations.
   * - Fields
     - fields
     - text
     - —
     - 
     - Comma-separated list of Jira field names to include in the response (e.g., summary,status,assignee); leave blank to retrieve all fields.
   * - Expand
     - expand
     - text
     - —
     - 
     - Comma-separated list of Jira expand options (e.g., renderedFields,transitions) to include additional data in the API response; leave blank if not needed.
   * - Max Results
     - max_results
     - number
     - 50
     - 
     - Maximum number of records to return for list/search operations; integer between 1 and 1000, defaults to 50.
   * - Request Body
     - request_body
     - textarea
     - —
     - 
     - JSON payload for write operations (create_issue, update_issue, add_comment, add_worklog, transition_issue); must conform to the Jira REST API v3 schema for the selected operation — leave blank for read-only operations.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - Status
     - status
     - text
     - Human-readable success or error message indicating whether the selected Jira operation completed successfully (e.g., 'Success: search_issues completed successfully.').
   * - Results
     - results
     - dataset
     - Structured dataset representation of the Jira API response, normalised into tabular form for downstream workers (rows correspond to issues, projects, sprints, etc., depending on the operation).
   * - Raw Response
     - raw_response
     - json
     - Unmodified JSON object returned by the Jira REST API, useful for debugging or extracting fields not captured in the normalised dataset output.

Disciplines
-----------

- platform.integration

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>jira_connection_worker</code>. Schema hash: <code>4ab9ff32eb43</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>