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.

...

Table

Get Table

Method:

...

Use this request to get all tabular data from a concrete specific table. You will need the issue ID or key from the issue you want to pull the data from and the custom field ID:

BASEURL/rest/api/2/issue/{issueIDOrKey}

Example URL:

https://

...

JiraURL/rest/api/2/issue/

...

{{issueID}}?fields=

...

{{customfieldID}}&expand=renderedFields

Customfield_22504 and renderedFields are the query params:

...

Update Table

Method:

Updating the entire table is possible via Jira’s REST API.

Request:

BaseURL/rest/api/2/issue/{issueIdOrKey}

Expandexpand
title Status: 200
{ "expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations", "id": "118610", "self": "https://jira-test.stagil.com/rest/api/2/issue/118610", "key": "SDS-66", "fields": { "customfield_11827": [ { "orderPosition": 0, "id": 37241, "field-443": "Hello world :)", "field-443-html": "<p>Hello world <img class=\"emoticon\" src=\"https://jira-test.stagil.com/images/icons/emoticons/smile.png\\" height=\"16\" width=\"16\" align=\"absmiddle\" alt=\"\" border=\"0\"/></p>", "field-477": [ 279 ], "field-477-name": [ "3" ], "field-495": "2023-07-12", "field-501": "TPLR-50", "field-966": [ "agrant-sd-demo" ], "field-966-name": [ "Alana Grant" ], "field-1080": [ 561 ], "field-1080-name": [ "3" ] }, { "orderPosition": 1, "id": 37242, "field-443": "Hello world :)", "field-443-html": "<p>Hello world <img class=\"emoticon\" src=\"https://jira-test.stagil.com/images/icons/emoticons/smile.png\\" height=\"16\" width=\"16\" align=\"absmiddle\" alt=\"\" border=\"0\"/></p>", "field-477": [ 280 ], "field-477-name": [ "4" ], "field-495": "2023-07-12", "field-501": "TPLR-31", "field-966": [ "mheather" ], "field-966-name": [ "Mark Heather " ], "field-1080": [ 560 ], "field-1080-name": [ "4" ] } ] } } Image Added

Update Table

Method:

Updating the entire table is possible via Jira’s REST API.

Request:

BaseURL/rest/api/2/issue/{issueIdOrKey}

{
   "fields":{
      "customfield_id":"{\"values\":[
         {
            \"field-191\":[104],
            \"field-219\":\"text\",
            \"field-192\":\"BD-7\",
            \"field-190\":[\"vkisil\"],
            \"field-247\":8.5,
            \"field-248\":1028.5,
            \"orderPosition\":0,
            \"field-189\":false,
            \"id\":-1
         }
      ]}"
   }
}

GET TABLE SUM

If you want to get the sum of your table directly, you can use the following syntax:

BASEURL/rest/stj/1.0/api/table/sum/customfield/{{customFieldId}}/issue/{{issueIdOrKey}}

Example URL:

...

Get Table Sum

Method:

Returns a sum from the number column from a specific table.

https://JiraURL/rest/stj/1.0/api/table/sum/customfield/

...

{{customFieldId}}/issue/

...

It will give you the following data: Arrays of table sums: columnID, columnsum, columnID, columnsum, columnID, columnsum.

Response:

...

{{issueIdOrKey}}

Expand
title Status: 200
{ "field-1081": 8.0 } Image Added

GET FIELD

This request can be used to get information about the configuration of a STAGIL Tables custom field. This means you will get information like id, default value, column type, max/min values, read-only etc., for each row in your table:

...

• 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!

Create row

Method:

...

1. Navigate to Settings () > Issues > Custom fields under the Fields section

2. Click on the More (⋯) icon to the right of the custom field you are obtaining the ID

3. The next page will list all the context for the current table field. Click ‘Edit STAGIL Tables and Checklists Configuration’.
   

   Image RemovedImage Added

4. The URL of the next page will be quite long. Closer to the end you will find the fieldConfigId value.
   

   

...