Uploaded image for project: 'Jira Service Management Cloud'
  1. Jira Service Management Cloud
  2. JSDCLOUD-10671

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 .

    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

    • 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:

            [JSDCLOUD-10671] REST API for ProForma/Forms in Jira

            Nicole made changes -
            Remote Link New: This issue links to "Page (Confluence)" [ 928650 ]
            Angélica Luz made changes -
            Remote Link New: This issue links to "Page (Confluence)" [ 872320 ]
            Paige Martin made changes -
            Remote Link New: This issue links to "Page (Confluence)" [ 856145 ]
            Nicole made changes -
            Labels Original: RIBS jsm-s15 New: RIBS RIBS-SHORT jsm-s15
            Iris Zhang made changes -
            Comment [ We have completed Forms API support for Jira cloud.  ]

            Iris Zhang added a comment -

            467bada285f8 Hi Rudy, thank you for pointing out the error in our changelog. We have fixed the links. We greatly appreciate your help.

            Iris Zhang added a comment - 467bada285f8 Hi Rudy, thank you for pointing out the error in our changelog. We have fixed the links. We greatly appreciate your help.

            Rudy Holtkamp added a comment -

            Hi  Iris (and other Atlassian),

            If we go to the link https://developer.atlassian.com/cloud/forms/changelog/#CHANGE-1193

            The links mentioned there are referring to internal Atlassian pages:

            https://developer.stg.internal.atlassian.com/cloud/forms/rest/api-group-forms-on-customer-request/#api-request-issueidorkey-form-formid-attachments-get

            https://developer.stg.internal.atlassian.com/cloud/forms/rest/api-group-forms-on-issue/#api-issue-issueidorkey-form-formid-attachments-get

            Could you please correct them? 

            Rudy Holtkamp added a comment - Hi  Iris (and other Atlassian), If we go to the link https://developer.atlassian.com/cloud/forms/changelog/#CHANGE-1193 The links mentioned there are referring to internal Atlassian pages: https://developer.stg.internal.atlassian.com/cloud/forms/rest/api-group-forms-on-customer-request/#api-request-issueidorkey-form-formid-attachments-get https://developer.stg.internal.atlassian.com/cloud/forms/rest/api-group-forms-on-issue/#api-issue-issueidorkey-form-formid-attachments-get Could you please correct them? 
            Nicole made changes -
            Labels Original: jsm-s15 New: RIBS jsm-s15
            Iris Zhang made changes -
            Resolution New: Fixed [ 1 ]
            Status Original: In Progress [ 3 ] New: Closed [ 6 ]
            Iris Zhang made changes -
            Latest Update Original: ||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|https://developer.atlassian.com/cloud/forms/changelog/#CHANGE-1193] and [Supporting form attachments when get attachments|https://developer.atlassian.com/cloud/jira/service-desk/changelog/#CHANGE-1211].
             
            Furthermore, we now support the saving of form answers and the retrieval of external form data. The changelog entry is [here|https://developer.atlassian.com/cloud/forms/changelog/#CHANGE-1126].
             
            Iris
            Developer - Forms
             |

                          		New: ||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|https://developer.atlassian.com/cloud/forms/changelog/#CHANGE-1193] and [Supporting form attachments when get attachments|https://developer.atlassian.com/cloud/jira/service-desk/changelog/#CHANGE-1211].
             
            Furthermore, we now support the saving of form answers and the retrieval of external form data. The changelog entry is [here|https://developer.atlassian.com/cloud/forms/changelog/#CHANGE-1126].
             
            Therefore, we are closing this issue as resolved.
             
            Iris
            Developer - Forms
             |

             
            Status Original: In Progress [ 3 ] New: In Progress [ 3 ]

              3a5d08b54945 Mauricio Franzoni (Inactive)
              gfranck Gabriele Franck
              Votes:
              529 Vote for this issue
              Watchers:
              344 Start watching this issue

                Created:
                Updated:
                Resolved: