REST API Integrations

Owned by Softlist Sp. z o.o.
Last updated: Jun 04, 2024
2 min read

To write data from the third-part systems your project(s) should be in the “synchronized” state. Read more about how to synchronize your project in this article.

How to write data from the third-part systems

How to Write Data from Third-Party Systems

To write data to the custom field where the table data is saved, you should use the "Edit Issue" endpoint of the REST API. You can write a table to the custom field if the corresponding template exists.

In the Configuration, on the "Templates" tab, you can find a list of all templates, with each template having an associated icon.

 

Here, you can find all the related information you need to write a table to this template using a third-party system:

  1. URL for the specific issue where you want to insert your table.

  2. Method: Always use PUT.

  3. Body of the request (more details below).

The 'Body' section indicates that we intend to modify the 'customfield_10338' of our issue. This custom field was created by our app during the synchronization of our project. The value of 'customfield_10338' represents the data that describes our table, and it should be formatted in JSON format. To ensure it's recognized by our app, you must adhere to the structure of this data.

 

The body data contains the following information:

  1. tableData - an array of rows in the table, with each array element being an object containing properties corresponding to the table's columns. Each property must have the appropriate data type, as specified in this window; otherwise, it may not display correctly.

  2. templateId - the ID of the created template, which marks the template to be used for displaying this table.

Please use this information to write data from third-party systems. If you encounter authorization issues with your request in Jira, you can refer to the following resources for assistance: