Summary

This article provides guidance on using Proforma data connection with Jira Property. Entity properties allow you to store JSON data to Jira entities, such as applications or projects.

Currently, Proforma supports 2 types of Connections for the data connection feature: 

• Connection Type

  • REST API

    • This is the standard form of retrieving external data values for a choice list.

  • Jira Property

    • Use this setting to retrieve JSON data that have been stored as either an Application or Project property within Jira.

We will cover the setup and documentation needed for using Jira properties for project properties.

Identifying a Property Name for Data Connection

You can identify and manage property names for data connections using the Jira REST API. Here is how you can do it for projects and application:

Fetching a List of Properties per Project

To fetch a list of all properties associated with a project, use the following endpoint (This can be accessed directly from the browser):

GET /rest/api/2/project/{projectKey}/properties

Fetching a List of application Properties

To fetch a list of all properties associated with the application properties, use the following endpoint (This can be accessed directly from the browser):

GET /rest/api/2/application-properties

Example using project properties:

Setting a Property

To set a property for a project, you can use the following cURL command:

curl -u yourUsername:yourPassword -X PUT --data '{"value": "newPropertyValue"}' -H "Content-Type: application/json" https://your-jira-instance.com/rest/api/2/project/{projectIdOrKey}/properties/{propertyKey}

Note: Replace yourUsername, yourPassword, your-jira-instance.com, projectIdOrKey, and propertyKey with your actual Jira instance details and credentials.

Example with Proforma

Here is an example of setting a property named exampleProperty with a value of exampleValue:

curl -u yourUsername:yourPassword -X PUT --data '{"value": "exampleValue"}' -H "Content-Type: application/json" https://your-jira-instance.com/rest/api/2/project/AS/properties/exampleProperty

Creating a data connection with Jira Property

Having the property added, we can use it on the data connection page: