REST API For Table Grid Editor
The public API is delivered in v1.18.0 or higher of the add-on.
- 1 Resources
- 1.1 Methods
- 1.1.1 Obtain Grid List GET /rest/idalko-igrid/1.0/grid/list
- 1.1.2 Obtain Grid Datasource Info GET /rest/idalko-igrid/1.0/grid/{gridId}/datasource
- 1.1.3 Obtain Number of Rows GET /rest/idalko-igrid/1.0/grid/{gridId}[/issue/{issueId}]/rowcount
- 1.1.4 Reload Grid POST /rest/idalko-igrid/1.0/grid/issue/{issueId}/reload
- 1.1.5 Clear Grid Data PUT /rest/idalko-igrid/1.0/grid/{gridId}/issue/{issueId}/clear
- 1.1.6 Clear All Duplicates PUT /rest/idalko-igrid/1.0/grid/{gridId}/issue/{issueId}/clearDuplicates
- 1.1.7 Clear All Not Modified PUT /rest/idalko-igrid/1.0/grid/{gridId}/issue/{issueId}/clearNotModified
- 1.1.8 Read Grid Data GET /rest/idalko-igrid/1.0/grid/{gridId}/issue/{issueId}/[row/{rowId}]?columns&startAt&maxResults
- 1.1.9 Read Grid Data for all issues GET /rest/idalko-igrid/1.0/grid/{gridId}/issues?startAt&maxResults&rowId&columns
- 1.1.10 Add Rows POST /rest/idalko-igrid/1.0/grid/{gridId}/issue/{issueId}
- 1.1.11 Edit Rows PUT /rest/idalko-igrid/1.0/grid/{gridId}/issue/{issueId}
- 1.1.12 Remove Rows DELETE /rest/idalko-igrid/1.0/grid/{gridId}/issue/{issueId}
- 1.1.13 Synchronize Custom Field Values PUT /rest/idalko-igrid/1.0/grid/synchronize
- 1.1 Methods
Resources
/rest/idalko-igrid/1.0/grid/
Methods
Obtain Grid List GET /rest/idalko-igrid/1.0/grid/list
Returns a list of TGE customfields in the JIRA instance. Only available for admins
available response representations:
200 (success) - application/json. Response example:
[ {"id": "10001", name: "TGE"}, {"id": "10002", name: "Sandwich Order"}, {"id": "10003", name: "Purchase"} ]
403 (forbidden). Returned if:
the user has no permissions to get this info
401 (not authorised)
500 (server error)
Obtain Grid Datasource Info GET /rest/idalko-igrid/1.0/grid/{gridId}/datasource
Returns the table name, data source and connection url for a grid table.
template parameters
parameter | value | required | description |
---|---|---|---|
gridId | long | + | id of the TGE customfield |
available response representations:
200 (success) - application/json. Response example:
{ "configurationTableName": "actions", "databaseTableName": "actions_c10200", "connectionUrl": "jdbc:mysql://localhost:3306/jiradb?useUnicode=true&characterEncoding=UTF8&sessionVariables=storage_engine=InnoDB" }
403 (forbidden). Returned if:
the user has no permissions to get this info
400 (bad request). Returned if:
the specified customfield id exists but it is not a TGE customfield
404 (not found). Returned if:
customfield with the specified id does not exist
401 (not authorised)
500 (server error)
Obtain Number of Rows GET /rest/idalko-igrid/1.0/grid/{gridId}[/issue/{issueId}]/rowcount
Returns the number of rows of the grid across all the issues or only in a certain issue
Note
If a user does not have permissions to see all the projects with the configured grids, he will see a number of rows only in issues invisible to his projects.
template parameters
parameter | value | required | description |
---|---|---|---|
gridId | long | + | id of the TGE customfield |
issueId | long | - | id of the issue |
available response representations:
200 (success) - application/json. Response example:
{ "rowCount": 12 }
403 (forbidden). Returned if:
the user has no permissions to view specified issue
400 (bad request). Returned if:
the specified customfield id exists but it is not a TGE customfield
404 (not found). Returned if:
customfield with the specified id does not exist
issue with the specified id does not exist
401 (not authorised)
500 (server error)
Reload Grid POST /rest/idalko-igrid/1.0/grid/issue/{issueId}/reload
Reloads a single grid or multiple grids at once
template parameters
parameter | value | required | description |
---|---|---|---|
issueId | long | + | id of the issue |
acceptable request representations:
Request body is a JSON with array of ids of grids to reload
available response representations:
200 (success)
403 (forbidden). Returned if:
the user has no permissions for the specified issue
400 (bad request). Returned if:
invalid custom field context, i.e this issue is not applicable to the context of the specified grid
the specified customfield(s) id exists but it is not a TGE customfield
404 (not found). Returned if:
the specified issueId doesn't exist
TGE customfield with the specified id does not exist
401 (not authorised)
500 (server error)
Clear Grid Data PUT /rest/idalko-igrid/1.0/grid/{gridId}/issue/{issueId}/clear
Clears all the data from the specified grid in the specified issue
template parameters
parameter | value | required | description |
---|---|---|---|
issueId | long | + | id of the issue |
gridId | long | + | id of the TGE customfield |
available response representations:
200 (success)
403 (forbidden). Returned if:
the user has no permissions for the specified issue
400 (bad request). Returned if:
invalid custom field context, i.e this issue is not applicable to the context of the specified grid
the specified customfield(s) id exists but it is not a TGE customfield
404 (not found). Returned if:
the specified issueId doesn't exist
TGE customfield with the specified id does not exist
401 (not authorised)
500 (server error)
Clear All Duplicates PUT /rest/idalko-igrid/1.0/grid/{gridId}/issue/{issueId}/clearDuplicates
Removes duplicate rows from the specified grid in the specified issue
template parameters
parameter | value | required | description |
---|---|---|---|
issueId | long | + | id of the issue |
gridId | long | + | id of the TGE customfield |
available response representations:
200 (success)
403 (forbidden). Returned if:
the user has no permissions for the specified issue
400 (bad request). Returned if:
invalid custom field context, i.e this issue is not applicable to the context of the specified grid
the specified customfield(s) id exists but it is not a TGE customfield
404 (not found). Returned if:
the specified issueId doesn't exist
TGE customfield with the specified id does not exist
401 (not authorised)
500 (server error)
Clear All Not Modified PUT /rest/idalko-igrid/1.0/grid/{gridId}/issue/{issueId}/clearNotModified
Removes all non-modified rows from the specified grid in the specified issue
template parameters
parameter | value | required | description |
---|---|---|---|
issueId | long | + | id of the issue |
gridId | long | + | id of the TGE customfield |
available response representations:
200 (success)
403 (forbidden). Returned if:
the user has no permissions for the specified issue
400 (bad request). Returned if:
invalid custom field context, i.e this issue is not applicable to the context of the specified grid
the specified customfield(s) id exists but it is not a TGE customfield
404 (not found). Returned if:
the specified issueId doesn't exist
TGE customfield with the specified id does not exist
401 (not authorised)
500 (server error)
Read Grid Data GET /rest/idalko-igrid/1.0/grid/{gridId}/issue/{issueId}/[row/{rowId}]?columns&startAt&maxResults
Returns grid data for the issue
template parameters
parameter | value | required | description |
---|---|---|---|
gridId | long | + | id of the TGE customfield |
issueId | long | + | id of the issue |
rowId | long | - | id of the row in grid. Optional. If specified, only data for this row is returned. |
query parameters
parameter | value | required | description |
---|---|---|---|
columns | string | - | coma-separated list of columns as configured in the grid definition. If omitted - all columns are returned |
startAt | integer | - | startAt pagination parameter. See pagination |
maxResults | integer | - | maxResults pagination parameter. See pagination |
available response representations:
200 (success) - application/json. Given the grid configuration similar to the Family List the example of request and response are:
if columns are specified it could be
if a special column like list is specified - the response contains all the data related to this column. For example,
*NOTE*: the dob field in the example actually has to contain time in milliseconds instead of date string - to be done
403 (forbidden). Returned if:
the user has no permissions for the specified issue
400 (bad request). Returned if:
invalid custom field context, i.e this issue is not applicable to the context of the specified grid
the specified customfield id exists but it is not a TGE customfield
specified column name(s) does not exist
404 (not found). Returned if:
the specified issueId doesn't exist
TGE customfield with the specified id does not exist
401 (not authorised)
500 (server error)
Read Grid Data for all issues GET /rest/idalko-igrid/1.0/grid/{gridId}/issues?startAt&maxResults&rowId&columns
Returns grid data for all issues
template parameters
parameter | value | required | description |
---|---|---|---|
gridId |