Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Resources

/rest/idalko-igrid/1.0/grid/


Methods


Obtain Grid Datasource Info GET  /rest/idalko-igrid/1.0/grid/{gridId}/datasource


Returns the datasource table name and the connection URL for the specified table grid

template parameters

parametervaluerequireddescription
gridIdlong+id of the TGR customfield


available response representations:

  • 200 (success) - application/json. Response example: 

{  
   "databaseTableName":"cwd_user",
   "connectionUrl":"jdbc:h2:file:/Users/strygul/tableGrid/tgrid/target/jira/home/database/h2db"
}

  • 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 in the specified issue

template parameters

parametervaluerequireddescription
gridIdlong+id of the TGR customfield
issueIdlong-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 TGR 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)


 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

parametervaluerequireddescription
gridIdlong+id of the TGR customfield
issueIdlong+id of the issue
rowIdlong-id of the row in grid. Optional. If specified, only data for this row is returned.

 

query parameters

parametervaluerequireddescription
columnsstring-coma-separated list of columns as configured in the grid definition. If omitted - all columns are returned
startAtinteger-startAt pagination parameter. See pagination
maxResultsinteger-maxResults pagination parameter. See pagination 


available response representations:

  • 200 (success) - application/json. Response example: 

/rest/idalko-igrid/1.0/grid/10301/issue/11359
{  
   "startAt":0,
   "maxResults":10,
   "total":3,
   "values":[  
      {  
         "ugroup":"jira-administrators",
         "username":"admin"
      },
      {  
         "ugroup":"jira-servicedesk-users",
         "username":"admin"
      },
      {  
         "ugroup":"jira-software-users",
         "username":"admin"
      }
   ]
}

if columns are specified it could be 

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


{  
   "startAt":0,
   "maxResults":10,
   "total":3,
   "values":[  
      {  
         "username":"admin"
      },
      {  
         "username":"admin"
      },
      {  
         "username":"admin"
      }
   ]
}


  • 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 TGR customfield

    • specified column name(s) does not exist

  • 404 (not found). Returned if:
    • the specified issueId doesn't exist 
    • TGR customfield with the specified id does not exist
  • 401 (not authorised)
  • 500 (server error)
  • No labels