Using Proforma data connections with Jira Property
Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.
Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
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.
The primary source for documentation on Jira property connection types and setup details is the Atlassian Data Center developer documentation, specifically the Entity Properties documentation.
Solution
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):
1
GET /rest/api/2/project/{projectKey}/propertiesFetching 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):
1
GET /rest/api/2/application-propertiesExample using project properties:
Setting a Property
To set a property for a project, you can use the following cURL command:
1
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:
1
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:
1 - Navigate to the Connection page:
a. Jira Administration (Cog icon) > Manage Apps
b. Connection > Add connection
2 - Configure a Jira Property connection
3 - A successful connection will return a 200 response:
4 - The response will return the JSON payload:
5 - The value can now be configured and used for data connection.
Was this helpful?