REST API for ProForma/Forms in Jira

XMLWordPrintable

    • 1,578
    • Hide

      As of 30 October, we have finished the process of assigning Universal Unique Identifiers (UUIDs) to all existing forms, including the older ones that initially lacked them. This ensures that our Forms APIs now support all forms.

      We are excited to announce that we have released the capability to obtain form attachments through our Forms API and the Jira Service Management Public API. You can find all the details about these updates in the changelog entries Get metadata on all form attachments and Supporting form attachments when get attachments.

      Furthermore, we now support the saving of form answers and the retrieval of external form data. The changelog entry is here.

      Show
      As of 30 October, we have finished the process of assigning Universal Unique Identifiers (UUIDs) to all existing forms, including the older ones that initially lacked them. This ensures that our Forms APIs now support all forms. We are excited to announce that we have released the capability to obtain form attachments through our Forms API and the Jira Service Management Public API. You can find all the details about these updates in the changelog entries Get metadata on all form attachments and Supporting form attachments when get attachments . Furthermore, we now support the saving of form answers and the retrieval of external form data. The changelog entry is here .
    • Hide
      Update 30 October 2023 - API support for older forms, saving form answers and form attachments
      As of 30 October, we have finished the process of assigning Universal Unique Identifiers (UUIDs) to all existing forms, including the older ones that initially lacked them. This ensures that our Forms APIs now support all forms.
       
      We are excited to announce that we have released the capability to obtain form attachments through our Forms API and the Jira Service Management Public API. You can find all the details about these updates in the changelog entries Get metadata on all form attachments and Supporting form attachments when get attachments.
       
      Furthermore, we now support the saving of form answers and the retrieval of external form data. The changelog entry is here.
       
      Therefore, we are closing this issue as resolved.
       
      Iris
      Developer - Forms
       

       

      Show
      Update 30 October 2023 - API support for older forms, saving form answers and form attachments As of 30 October, we have finished the process of assigning Universal Unique Identifiers (UUIDs) to all existing forms, including the older ones that initially lacked them. This ensures that our Forms APIs now support all forms.   We are excited to announce that we have released the capability to obtain form attachments through our Forms API and the Jira Service Management Public API. You can find all the details about these updates in the changelog entries Get metadata on all form attachments and Supporting form attachments when get attachments .   Furthermore, we now support the saving of form answers and the retrieval of external form data. The changelog entry is here .   Therefore, we are closing this issue as resolved.   Iris Developer - Forms    

      Note: Forms API are now available and documentation is available here. We are continuing to work on the functionality available which is why this issue remains In Progress.

      Problem Definition

      It would be nice to have a REST API (similar to what Jira already has for its Core features) to integrate it with an external application and manage Forms.

      Reproducing the following APIs form ProForma in Server/DC would be a good start:

      Form Functions

      • Add a form to an issue
      • Submit a form  
      • Reopen a form 
      • Unlock a form
      • Copy a form from one issue to another
      • Change the visibility of a form 
      • Attach PDF of a form to an issue 

      Reporting / Export

      • Access an array of form responses 
      • Download a PDF, XLSX
      • or JSON of form 

      Workaround to access the structure of the forms:

      Examples of using the Experimental Forms API:

            Assignee:
            Mauricio Franzoni (Inactive)
            Reporter:
            Gabriele Franck
            Votes:
            529 Vote for this issue
            Watchers:
            343 Start watching this issue

              Created:
              Updated:
              Resolved: