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.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

...

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

Create new option

Method:

Allows to create a new select list option with the following configurations:

...

Update an option

Method:

Allows to update the configuration of an existing option

...

{
    "disabled": false,
    "id": 107,
    "optionValue": "Option name updated",
    "orderPosition": 0
}

Delete option

Method:

Allows to remove an option from a select list column configuration

https://yourJiraURL/rest/stj/1.0/api/table/fieldConfig/{{fieldConfigId}}/field/{{fieldId}}/option/{{optionId}}

Variables

fieldConfigId

Stands for an ID of a table custom field.

To retrieve, follow the following steps:

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. Select the View field information option

4. Observe the URL in your browser, which will contain the ID of the field:

...

In the above example, the custom field ID is 10026.

fieldId

Stands for the id of a table column. Every column that is created is assigned an individual column id, regardless of the table context. To retrieve it, go to the table configuration page. The column id is displayed as a number before the column name.

...

optionID

Stand for an id of an option within a Select List column. To retrieve, use an API call