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.

Content

Table

GET TABLE

Use this request to get all tabular data from a concrete 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://yourjiraURL/rest/api/2/issue/SAJ-2837?fields=customfield_22504&expand=renderedFields

Customfield_22504 and renderedFields are the query params:

Update Table

Method: PUT

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:

https://yourjiraURL.com/rest/stj/1.0/api/table/sum/customfield/22007/issue/KEY-4

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

Response:

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:

BASEURL/rest/stj/1.0/api/table/fields/{{fieldConfigId}}

You can retrieve the field configuration ID from the url of the STAGIL Tables Configuration page:

Example URL:

https://yourjiraURL.com/rest/stj/1.0/api/table/fields/23804

Response: An array which contains configuration information about each row id per index step.

 Click here to expand...

GET FIELD SUM

If you want to get the sum of just one field you can use the following request url:

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

You can retrieve the field ID from the table field configuration screen.

Example URL:

http://yourjiraURL/rest/stj/1.0/api/table/sum/customfield/22007/issue/DEMO-4/field/10

Response:

Table History

Method: GET
Description: provides data about changes in the STAGIL Tables & Checklist field or Table History.

API call: http://yourjiraURL/rest/stj/1.0/api/table/history/customField/{{customfieldID}}/issue/{{issuekey}}

 Response: 200

GET CSV FILE

You can also get a csv export of your table by using REST API:

• 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, POST, DELETE Requests

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:

• BASEURL/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

• In the body of the POST request, you do not need to include values for the orderPosition and the id. The new row will automatically be added at the end of the table.

• Example body:  { "field-35": 2, "field-34": "some example text", "field-36": 22.2, "field-37": "someuser", "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

Example URL: http://yourjiraURL/rest/stj/1.0/api/table/data/customField/{{customFieldId}}/issue/{{issueIdOrKey}}/row/{rowId}

You can get the row ID from the GET request, looking at the "id" of the row you want to modify.

Column configuration

Select List column options

Returns the list of select list options

Method: GET

http://yourjiraURL/rest/stj/1.0/api/table/fieldConfig/{{fieldConfigId}}/field/{{fieldId}}/options

 Variables

{{fieldConfigId}} - field ID of the table custom field.

{{fieldId}} - ID of the select list column