• Products
  • Get started
  • Documentation
  • Resources

Create, edit, test, or delete data connections for forms

The features described on this page may not yet be available on your Jira Service Management site. To find out when these features will be live on your site, keep an eye on our release notes or the Atlassian Community.

Forms can retrieve JSON data from REST APIs and use this data to populate choice lists on forms. In order to use external data in a form, you’ll need to set up a connection.

Once you’ve created a data connection, you can add it to a form. Learn how to add a data connection to a form.

You need to be a Jira admin to create, test, edit, or delete data connections.

Create a data connection

To create a new data connection for forms:

  1. From your service project, go to Settings () > Issues.

  2. Under Forms, select Data connections.

  3. Select Add connection.

  4. Fill out the fields as desired, then select Next.

  5. If the connection is successful, select Next.

  6. Configure your Items, ID, and Label.

    • Items - The list or array of objects within the JSON data set that contains the required data. 

    • ID - The object must contain an ID value that be a number or a string. The ID is not displayed on the form. 

    • Label - any individual string field within the object. This is the field that will be displayed to users on the form.

  7. Select Next.

  8. Select Create.

Test a data connection

When a new connection is created, Jira Service Management will test the URL as part of creating the connection. To test an already existing connection:

  1. From your service project, go to Settings () > Issues.

  2. Under Forms, select Data connections.

  3. Next to the connection you want to test, select Edit.

  4. To test the connection again, select Next.

  5. Select Back > Back to return to the data connections page.

Edit a data connection

To delete a connection:

  1. From your service project, go to Settings () > Issues.

  2. Under Forms, select Data connections.

  3. Next to the connection you want to edit, select Edit.

  4. Make your changes as desired, and select Next. Repeat until until you see Save.

  5. Select Save.

Delete a data connection

To delete a connection:

  1. From your service project, go to Settings () > Issues.

  2. Under Forms, select Data connections.

  3. Next to the connection you want to test, select Delete.

  4. Select Delete.

Given the potential impact on the data contained within forms that use a data connection, a data connection is never permanently deleted. Instead, it’s placed in a deleted state and all authentication information is removed. The connection itself can be restored if the connection is re-configured with new authentication details. 

The impact of deleting a data connection depends on the state of the form that uses that connection:

  • If the form is open, all choice list values (including any selected choices) are removed from the form.

  • If the form is submitted, all choice list values (including any selected choices) are preserved.

  • If the form is reopened (for example, if a submitted form is reopened after a connection is deleted), all of the choice values will be removed from the form. 

Learn more about form states.

 

Additional Help