Uploaded image for project: 'Xray for Jira Cloud'
  1. Xray for Jira Cloud
  2. XRAYCLOUD-10175

Expose Xray Issue / Work Type Configuration via API

    XporterXMLWordPrintable

Details

    • Suggestion
    • Status: New
    • Resolution: Unresolved
    • None
    • None
    • REST API
    • None
    • UNCOVERED

    • 1

    Description

      Problem Statement: Customers integrating with Jira and Xray currently lack a supported, programmatic way to identify which Jira issue types correspond to Xray entities (e.g., Test, Test Execution, Test Plan, Precondition). Xray does not expose an API endpoint that returns the issue/work type configuration or mappings, making it difficult to reliably detect Xray-specific issue types across projects and instances.

      This impacts customers who need to automate integrations, migrations, reporting, or validation workflows and cannot safely rely on Jira issue type names or assumptions due to Jira’s high level of configurability.

      User Friction:

      • Jira issue types are fully customizable (names, schemes, project-level mappings).
      • Xray entities are implemented as Jira issue types, but there is no API that explicitly identifies which issue types are managed by Xray.
      • Customers cannot reliably determine Xray issue types by name alone, as these may be renamed or reused.
      • Jira REST APIs alone do not guarantee accurate identification of Xray entities.

      As a result, customers must rely on inference or heuristics, which are brittle and error-prone.

      Steps to Reproduce (Workflow)

      1. Install Xray in a Jira Cloud instance.
      2. Customize or rename Xray issue types (e.g., rename “Test” to “QA Case”).
      3. Attempt to programmatically identify which Jira issue types represent Xray entities.
      4. Observe that:
        • Jira REST APIs only return generic issue type metadata.
      5. No supported API exists to retrieve a definitive list or mapping of Xray-managed issue types.

      Impact

      What would improve if solved

      • Customers could reliably and safely identify Xray issue types programmatically.
      • Integrations, migrations, and automation workflows would become more robust and less dependent on naming conventions or manual setup.

      Impact on stakeholders

      • Integrators and platform engineers building automated tooling.

      Current Workaround

      • N/A

      Context & Examples

      Concrete example:
      A customer building an integration needs to identify all Xray Tests across multiple projects. Because issue type names differ per project and may not be called “Test”, they cannot rely on Jira metadata alone. They expect a supported Xray API that clearly states which issue types correspond to Xray entities but currently must infer this via indirect methods.

      Workaround risk:
      N/A

      Attachments

        Activity

          People

            bernardo.cottim Bernardo Cottim
            joshua.tesfaye Joshua Tesfaye
            Votes:
            1 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated: