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

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

template parameters

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

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

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

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

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

query parameters

available response representations:

• 200 (success) - application/json. Given the grid configuration similar to the Family List the example of request and response are: 

  /rest/idalko-igrid/1.0/grid/10301/issue/11359

  
  
  

  { "startAt" : 0, "maxResults" : 10, "total": 200, "values": [ { "id": 1,  "issueId": 10173,  "modified": 1,  "name": "brad",  "dob": -32756400000,  "gender": "M",  "relation": { "name": "Father",  "value": "Dad" }, "hobbies": "Likes: Acting, Art, Basketball, Golf" }, { "id": 2,  "issueId": 10173,  "modified": 1,  "name": "angelina",  "dob": 171064800,  "gender": "F",  "relation": { "name": "Mother",  "value": "Mom" } //... ] }

  if columns are specified it could be 

  /rest/idalko-igrid/1.0/grid/10301/issue/11359?columns=name,dob

  
  
  

  { "startAt" : 0, "maxResults" : 10, "total": 200, "values": [ {"id": 1, "issueId": 10173, "modified": 1, "name": "brad", "dob": -32752800}, {"id": 2, "issueId": 10173, "modified": 1, "name": "angelina", "dob": 171064800} //... ] }

  if a special column like list is specified - the response contains all the data related to this column. For example, 

  /rest/idalko-igrid/1.0/grid/10301/issue/11359?columns=relation

  
  
  

  { "startAt" : 0, "maxResults" : 10, "total": 200, "values": [ { "id": 1,  "issueId": 10173,  "modified": 1,  "relation": { "value": "Dad",  "name": "Father" }, }, { "id": 2,  "issueId": 10173,  "modified": 1,  "relation": { "value": "Mom",  "name": "Mother" } } //... ] }

  *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

query parameters

available response representations:

• 200 (success) - application/json. Given the grid configuration similar to the Family List the example of request and response are: 

  /rest/idalko-igrid/1.0/grid/10011/issues

  
  
  

  Response

  { "startAt":0, "maxResults":10, "total":2, "values": [ { "issueId":10001, "values": [ {"island":"Baynham Island","latitude":99.1,"modified":1,"location": {"name":"North","value":"N"}, "treasure":"Gold","id":1,"longitude":23.3}, {"island":"Triangle Island","latitude":11.1,"modified":1,"location":{"name":"East","value":"E"},"treasure":"Nobody knows:)","id":2, "longitude":2121.1} ] }, { "issueId":10002, "values": [ {"island":"Mansell Island","latitude":1241.1,"modified":1,"location":{"name":"South","value":"South"},"treasure":"jewelry", "id":3,"longitude":142123.11}, {"island":"Goat Island","latitude":1231.11,"modified":1,"location":{"name":"East","value":"E"},"treasure":"Goats","id":5, "longitude":5431.132}]} ] } }

  if columns are specified it could be 

  /rest/idalko-igrid/1.0/grid/10011/issues?columns=island,treasure

  
  
  

  Response

  { "startAt":0, "maxResults":10, "total":2, "values": [ { "issueId":10001, "values": [ {"island":"Baynham Island","modified":1,"treasure":"Gold","id":1}, {"island":"Triangle Island","modified":1,"treasure":"Nobody knows:)","id":2} ] }, { "issueId":10002, "values": [ {"island":"Mansell Island","modified":1,"treasure":"jewelry","id":3}, {"island":"Goat Island","modified":1,"treasure":"Goats","id":5} ] } }

  
  
  

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

  • TGE customfield with the specified id does not exist

• 401 (not authorised)

• 500 (server error)

Add Rows POST /rest/idalko-igrid/1.0/grid/{gridId}/issue/{issueId}

Add rows to the grid

template parameters

Request body is a JSON array with column names and values