API Param Descriptions - Big Parser
 Share
The version of the browser you are using is no longer supported. Please upgrade to a supported browser.Dismiss

 
View only
 
 
ABCDEFGHIJKLMNOPQRSTUVWXYZAA
1
#APITypeParam NameRequired/OptionalParam DescriptionAddn'l comments
2
3
1/common/signupRequestfullNamerequired
4
emailIdrequired
5
passwordrequired
6
mobileNumberoptional
7
8
Response
9
status code : 200
10
11
2/common/loginRequestemailIdrequired
12
passwordrequired
13
loggedInoptionaloptional field, for "keep me loggedin" feature. pass value
"true" in case the feature needs to be enabled
14
15
ResponseauthIduse as authId (token accessing other apis)
16
activationStatuswhether user is active or not
17
Common params for all APIs (except signup, login)
18
3All APISRequest headerauthIdrequiredauthId is the authentication id/token which needs to be passed
in the header of every API call (except signup, login APIs).
The authId is obtained by calling the login API call.
19
20
4
/query/table
(global(full text) search,
&
column search)
RequestgridIdrequiredrequired field, gridId on which you like to perform search
21
rowCountrequiredNo of rows to fetch. If value not provided then default is 10
Note that rowCount is optional if start index and end index
are specified
22
startIndexoptionalstart index for pagination (lowest value is 0)
23
endIndexoptionalend index for pagination (highest value is the row count/max no.
of records in grid)
24
selectColumnNamesoptionalarray of column store name which you like to fetch, by default all columns will be fetched
25
tagsoptionalarray of column level filters. sample format
"tags": [
{
"columnValue": "Hello World",
"columnStoreName": "1"
},
{
"columnValue": "Hello Alexa",
"columnStoreName": "4"
}
]
26
keywordsoptional
array of global level keywords. sample format
"keywords": [
"Bear Story",
"spectre"
]
27
sortFieldsoptionalarray of sort fields
"sortKeys": [
{
"columnStoreName": "1",
"ascending": true
}
]
28
29
Responsecounttotal no of rows fetched
30
rowsrows in the grid
31
keywordslists the keywords and count for each key word
32
tagslists the column tags/filters and count for each of them
33
otherGridsthr gridIds of other sheets in case of multisheet grid
34
35
5
/query/search
(column autocomplete)
RequestgridIdrequiredgridId on which you like to perform search
36
columnStoreNamerequiredcolumn store name for the column which you are searching.
column store name is the array index position of the respective
column header in the grid. It starts with 0.
37
searchKeyrequiredcolumn value to search
38
pageSizerequiredno. of records to fetch
39
40
ResponsematchingValuesArray of matching records (result)
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
Loading...
 
 
 
API field details - latest
 
 
Main menu