Uploaded image for project: 'Xporter for Jira Cloud'
  1. Xporter for Jira Cloud
  2. XPORTERCLOUD-2529

As a user, I want to be able to use REST API in Xporter for Cloud

    XporterXMLWordPrintable

Details

    • Suggestion
    • Status: New
    • Resolution: Unresolved
    • None
    • None
    • Automation
    • None
    • UNCOVERED

    Description

      Description

      Users should be able to use a REST API in Xporter for Jira Cloud to generate documents programmatically.

      Currently, there is no public REST API available to trigger template-based document generation (single issue or JQL-based export) in Cloud. This prevents automation of document generation workflows and blocks use cases that depend on backend integrations.

      User friction

      • No REST endpoint exists to trigger document generation.
      • Users cannot automate exports from external systems or web servers.
      • Existing automation workflows from Data Center cannot be replicated in Cloud.
      • Manual export via the UI is the only available option.

      Steps to reproduce (right now) / Actual Result:

      • Attempt to replicate a Data Center REST-based export workflow in Jira Cloud.
      • Search for a REST endpoint in Xporter for Cloud to trigger template-based export.
      • Observe that no public REST API exists for automation.
      • User must manually generate documents through the UI instead of automated backend processes.

      IMPACT{}

      What would improve if solved:

      • Enable automated document generation through REST API endpoints.
      • Support migration scenarios from Data Center to Cloud without redesigning automation architecture.
      • Allow integration with external systems, web portals, and CI/CD pipelines.
      • Reduce manual effort and operational overhead.

      Impact on stakeholders:

      • Project Managers, QA teams, and documentation teams relying on automated exports.
      • Organizations with custom portals or middleware generating documents dynamically.
      • Customers migrating from Data Center who previously depended on servlet-based REST calls.

      Current workaround:

      • Manual export through the Xporter Cloud UI.
      • Custom redevelopment using alternative automation tools outside of Xporter.
      • Redesigning workflows to avoid real-time document generation.

      These workarounds are inefficient and may require significant architectural changes.

      CONTEXT & EXAMPLES:

      Concrete example: A company uses a web server where users input parameters that generate a JQL query and additional template variables (e.g., document title). In Data Center, the system sends this data via REST to a servlet endpoint to generate a Word document dynamically. In Cloud, there is no equivalent REST endpoint, preventing automated document creation.

      Workaround risk:

      • Increased manual processing and risk of human error.
      • Inconsistent document generation workflows.
      • Additional development effort to rebuild automation using external tools.
      • Reduced adoption of Cloud due to missing automation capabilities.

       

      Attachments

        Activity

          People

            Unassigned Unassigned
            tripti.kumari Tripti Kumari
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:

              Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 25 minutes
                25m