REST APIs
This page describes how to use REST APIs for Table Grid Next Generation for Jira Server / Datacenter. Our APIs endpoints are deployed within your Jira Platform, directly embed in our app.
Value format Values in columns are stored in the following format: Checkboxes are stored as booleans. Integers, Numbers, Dates, DateTimes and Times are stored as numbers. Values of Date, DateTime and Time columns are stored in Unix time format in milliseconds. Strings, Textareas, Single Select Lists and Sequences are stored as strings. Value of a single select list is a string containing a selected item's title. Multi Select Lists are stored as lists of strings containing titles of selected items. Formulas are stored as numbers or strings depending on return type. Userlists are stored as Maps with the following entries: "key" contains user key, which uniquely identifies a user.
"key" may be missing if a user could not be found.
When using "Add Grid Data" or "Update Grid Data" methods, "key" MUST be provided, and the rest of the entries are optional. "username" contains user's username. "value" contains user's full name. "avatar" contains a link to user's avatar. The term empty value refers to nulls, empty strings and empty lists.
Read Grid Data API call: GET /rest/idalko-grid/1.0/api/grid/{gridCustomFieldId}/issue/{issueIdOrKey} Description: Read all rows of the Grid custom field Request PATH PARAMETERS gridCustomFieldId REQUIRED string The id of the Grid custom field. issueIdOrKey REQUIRED string The ID or key of the issue. QUERY PARAMETERS Responses
Add Grid Data API call: POST /rest/idalko-grid/1.0/api/grid/{gridCustomFieldId}/issue/{issueIdOrKey} Description: Add rows to the Grid custom field Request PATH PARAMETERS gridCustomFieldId REQUIRED string The id of the Grid custom field. issueIdOrKey REQUIRED string The ID or key of the issue. QUERY PARAMETERS acceptInvalidSelectListOption boolean Indicates whether to accept invalid values for single or multi-select list columns. Default: false Note: When set to true, the system will accept values that are not currently defined in the select list options. BODY Example (application/json) {
"rows":[
{
"status":"Open",
"user":"Stephen Curry",
"summary":"New row"
}
]
} Responses
Update Grid Data API call: PUT /rest/idalko-grid/1.0/api/grid/{gridCustomFieldId}/issue/{issueIdOrKey} Description: Update rows of the Grid custom field Request PATH PARAMETERS gridCustomFieldId REQUIRED string The id of the Grid custom field. issueIdOrKey REQUIRED string The ID or key of the issue. QUERY PARAMETERS acceptInvalidSelectListOption boolean Indicates whether to accept invalid values for single or multi-select list columns. Default: false Note: When set to true, the system will accept values that are not currently defined in the select list options. BODY Example (application/json) {
"rows":[
{
"rowId":"row_b089f167-9475-401b-88bd-2c2d25052196",
"columns":{
"status":"Open",
"user":"Blake Griffin",
"summary":"Updated value"
}
}
]
} Responses
Delete Grid Data Delete one or more rows API call: DELETE /rest/idalko-grid/1.0/api/grid/{gridCustomFieldId}/issue/{issueIdOrKey} Description: Delete rows of the Grid custom field Request PATH PARAMETERS gridCustomFieldId REQUIRED string The id of the Grid custom field. issueIdOrKey REQUIRED string The ID or key of the issue. BODY Example (application/json) {
"rows":[
"rowId_823e747c-a38a-4f14-8fe4-2ee565124503",
"rowId_7424bd1a-4c1f-404c-988b-1059756f3d72"
]
} Responses
Delete ALL rows API call: DELETE /rest/idalko-grid/1.0/api/grid/{gridCustomFieldId}/issue/{issueIdOrKey} Description: Delete all rows of the Grid custom field Request PATH PARAMETERS gridCustomFieldId REQUIRED string The id of the Grid custom field. issueIdOrKey REQUIRED string The ID or key of the issue. BODY Example (application/json) {
"rows":"all"
} Responses
Read Grid Configuration Read grid configuration for one grid custom field API call: GET /rest/idalko-grid/1.0/api/grid/config/{gridCustomFieldId}/issue/{issueIdOrKey} Description: Reads configuration of the Grid custom field Request PATH PARAMETERS gridCustomFieldId REQUIRED string The id of the Grid custom field. issueIdOrKey REQUIRED string The ID or key of the issue. ResponsesRead all Grid custom fields configurations API call: GET /rest/idalko-grid/1.0/api/grid/config/all Description: Read all Grid custom field configurations Responses