You can use Jira's REST API to view, create or change data within the STAGIL Table field. The following section will help you to set up your API requests.
...
URL: https://yourjiraURL/rest/stj/1.0/api/table/{{fieldConfigId}}/{{issueIdOrKey}}/COMMA/csv
Response: you will receive the data of your table in csv format (separator = comma)
PUT
...
PUT Request - UPDATE ROW
When you want to change certain rows of your table, you need to use the following API call configuration:
URL: https://yourjiraURL.xyz/rest/stj/1.0/api/table/data/customField/{{customFieldId}}/issue/{{issuekey}}/row/row/ID
Headers:
Your type of authorization
Content-Type: application/json;charset=UTF-8;
Accept: application/json;
You can get the row ID from the GET request, looking at the "id" of the row you want to modify.
URL example: http://localhost:8080/rest/stj/1.0/api/table/data/customField/25504/issue/KEY-4/row/123
With the GET request you can also see all the available fields and the structure of the table data. When you have drop-down, text or user columns, you only need the "field-1" part of the body. The "field-1-html" or "field-1-name" is not needed and will be added automatically. At the end of the body you don't need to add the custom field ID and the issue ID.
Example body: {"field-1": "Customer 7", "field-3": [2], "field-5": "anorth", "field-6": [8]}
This structure is simply retrieved from the GET request and you only modify the fields that you want to change. In this example, field-1 is a text field, field-3 and field-6 are select lists and field-5 is a user picker.For select list it is possible to use just "field-1-name": [“option1“, “option2“].
Please make sure to include all the used columns of your row in your PUT request. Missing columns will be overwritten with empty values!
POST Request - CREATE ROW
To create a new row in your table you can use this request:
...
Create row
Method:
| Status | ||||
|---|---|---|---|---|
|
| Code Block |
|---|
https://jiraURL/rest/stj/1.0/api/table/data/customField/{{customFieldId}}/issue/{{issueIdOrKey}} |
...
Example URL: https://yourjiraURL/rest/stj/1.0/api/table/data/customField/22504/issue/189038
...
Fill out the body of the
...
request with values for
...
the
...
new row
...
. Use the JSON snippet below as an example.
| Expand | ||
|---|---|---|
| ||
// values for the ‘orderPosition’ and id can be skipped. In this case, the new row will be automatically added to the end of the table. { "field-35": 2, "field-34": " |
...
Lorem Ipsum", "field-36": 22.2, "field-37": " |
...
TestUser", "field-38": "2021-02-10" } |
...
DELETE Requests
DELETE ROW
To delete single rows in your table you can use this request:
https://jira-test.stagil.com/rest/stj/1.0/api/table/data/customField/{{customFieldId}}/issue/{{issueId}}/row/23
...
Delete row
Method:
| Status | ||||
|---|---|---|---|---|
|
Removes a single row from the table
| Code Block |
|---|
https://jiraURL/rest/stj/1.0/api/table/data/customField/{{customFieldId}}/issue/{{ |
...
issueId}}/row/ |
...
You can get the row ID from the GET request, looking at the "id" of the row you want to modify.
23 |
Column configuration
Select List column options
...
Get a list of configured select list options
...
Method:
| Status | ||||
|---|---|---|---|---|
|
Returns the list of select list options and their configuration.
| Code Block |
|---|
http://yourjiraURL/rest/stj/1.0/api/table/fieldConfig/{{fieldConfigId}}/field/{{fieldId}}/options |
...
Navigate to Settings () > Issues > Custom fields under the Fields section
Click on the More (⋯) icon to the right of the custom field you are obtaining the ID
The next page will list all the context for the current table field. Click ‘Edit STAGIL Tables and Checklists Configuration’.
The URL of the next page will be quite long. Closer to the end you will find the fieldConfigId value.
...