The Grid Web API enables you to post a specific grid view. The post call returns all of the Grid Views for a specified module in JSON format. The following details describe the Grid Web API:
| Returns all the Grid Views for the specified Module in JSON format |
|---|
| |
|---|
| http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/grid/Views/GetData{gridParamInput} |
|---|
Request Authorization Header | Bearer access_token received through the Token API call. |
|---|
| (required) gridParamInput
Specify the Grid View Name, which is the sequence of the WorkSpace view prefixed by the WebGrid keyword. The following table lists the available Grid Views and their WebGrid keywords: | |
|---|
| | | | All Tickets under Change Management | | | | | | | | | | | | | |
- (optional) PageSize
Specify the PageSize, which is an integer. The default is 0. - (optional) PageNumber
Specify PageNumber, which is an integer. The default is 0.
|
|---|
| The following values are retrieved: - Count of rows
- Individual Column Sequence and Field display names of each row
|
|---|
| - You can retrieve only records for system views of the HelpDesk module.
- Only a technician with a permission to view the respective module can view the response.
- Data segregation rules are applied.
- The filter is applied in the view.
- Formatting, Order by, Sort By, Manage Columns are not applied in the view.
- Fields in the individual rows are sorted by column sequence and not by the saved sequence.
- Both column names and display names are retrieved.
- If the display names have been changed, the updated values are retrieved.
- If zero is specified for PageSize or PageNumber, all records are retrieved.
|
|---|
Example
http(s)://<servernameOrIP>/<trackitvirtuadirectory>/WebApi/grid/Views/GetData
{
"GridViewName": "WebGrid.103",
"PageSize": 0,
"PageNumber": 0,
"OptionalParams": {
"Param1": {},
"Param2": {}
}}
Request Authorization Header:
Bearer access_token:"ExPqpLF79Zi+vHZJIXZOGBSQVPKXlFVOfmQzMyfS7SGYJolrDAf3/LZR1qm9X+2OVY60OlEuUYOYaflcIjj7ytZ336b50mu4ieuPnx2AU2vCFgO3eqUe22Up"
Response:
{ ...... Fields of First row....} { ...... Fields of Second row....} { ...... Fields of Third row....}