quickbase-js 0.1.0-beta.12 → 0.1.0-beta.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (168) hide show
  1. package/README.md +48 -18
  2. package/dist/esm/quickbase.d.ts +13 -3
  3. package/dist/esm/quickbase.js +416 -49
  4. package/dist/esm/quickbase.js.map +1 -1
  5. package/dist/esm/quickbase.min.js +1 -1
  6. package/dist/esm/quickbase.min.js.map +1 -1
  7. package/dist/umd/quickbase.umd.js +416 -49
  8. package/dist/umd/quickbase.umd.js.map +1 -1
  9. package/dist/umd/quickbase.umd.min.js +1 -1
  10. package/dist/umd/quickbase.umd.min.js.map +1 -1
  11. package/package.json +11 -4
  12. package/CHANGELOG.md +0 -227
  13. package/build-common.js +0 -131
  14. package/build-esm.js +0 -71
  15. package/build-umd.js +0 -69
  16. package/docs/.vitepress/cache/deps/@theme_index.js +0 -275
  17. package/docs/.vitepress/cache/deps/@theme_index.js.map +0 -7
  18. package/docs/.vitepress/cache/deps/_metadata.json +0 -40
  19. package/docs/.vitepress/cache/deps/chunk-5A67QEFC.js +0 -12542
  20. package/docs/.vitepress/cache/deps/chunk-5A67QEFC.js.map +0 -7
  21. package/docs/.vitepress/cache/deps/chunk-7D4P4MMP.js +0 -9719
  22. package/docs/.vitepress/cache/deps/chunk-7D4P4MMP.js.map +0 -7
  23. package/docs/.vitepress/cache/deps/package.json +0 -3
  24. package/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js +0 -4504
  25. package/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js.map +0 -7
  26. package/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js +0 -583
  27. package/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js.map +0 -7
  28. package/docs/.vitepress/cache/deps/vue.js +0 -343
  29. package/docs/.vitepress/cache/deps/vue.js.map +0 -7
  30. package/docs/.vitepress/config.mts +0 -26
  31. package/docs/api-examples.md +0 -49
  32. package/docs/index.md +0 -59
  33. package/docs/markdown-examples.md +0 -85
  34. package/docs-data/api-docs.json +0 -4143
  35. package/examples/quicbase-jsCDN.html +0 -36
  36. package/examples/react.js +0 -48
  37. package/examples/vanillajs.html +0 -47
  38. package/index.md +0 -25
  39. package/open-api/fix-spec-main.ts +0 -133
  40. package/open-api/generate-unified-interface.ts +0 -104
  41. package/open-api/generateDocsJson.ts +0 -24
  42. package/open-api/output/quickbase-fixed.json +0 -11191
  43. package/open-api/post-process-generated.ts +0 -226
  44. package/open-api/regenerate-client.ts +0 -117
  45. package/open-api/schema/enhance-general.ts +0 -111
  46. package/open-api/schema/fix-arrays.ts +0 -68
  47. package/open-api/schema/tags/apps.ts +0 -90
  48. package/open-api/schema/tags/fields.ts +0 -471
  49. package/open-api/schema/tags/groups.ts +0 -51
  50. package/open-api/schema/tags/index.ts +0 -66
  51. package/open-api/schema/tags/records.ts +0 -115
  52. package/open-api/schema/tags/tables.ts +0 -211
  53. package/open-api/schema/tags/users.ts +0 -47
  54. package/open-api/types/spec.ts +0 -42
  55. package/open-api/utils/common.ts +0 -29
  56. package/open-api/utils/generateJsDoc.ts +0 -74
  57. package/open-api/utils/infer-schema.ts +0 -40
  58. package/open-api/utils/naming.ts +0 -10
  59. package/open-api/utils/sharedUtils.ts +0 -352
  60. package/playwright.config.ts +0 -37
  61. package/rollup.config.js +0 -114
  62. package/specs/QuickBase_RESTful_API_2025-03-04T06_22_39.725Z.json +0 -46878
  63. package/specs/split/apps.json +0 -1315
  64. package/specs/split/auth.json +0 -191
  65. package/specs/split/fields.json +0 -3869
  66. package/specs/split/records.json +0 -754
  67. package/specs/split/reports.json +0 -619
  68. package/specs/split/tables.json +0 -1605
  69. package/src/RateLimitError.ts +0 -12
  70. package/src/ThrottleBucket.ts +0 -77
  71. package/src/authorizationStrategy.ts +0 -310
  72. package/src/generated-unified/QuickbaseClient.ts +0 -1135
  73. package/src/generated-unified/missing-types-report.json +0 -3
  74. package/src/index.ts +0 -1
  75. package/src/invokeMethod.ts +0 -212
  76. package/src/quickbaseClient.ts +0 -199
  77. package/src/rateLimiter.ts +0 -30
  78. package/src/tokenCache.ts +0 -39
  79. package/src/utils.ts +0 -50
  80. package/tests/playwright/qb/auth/cacheSwitching.test.ts +0 -159
  81. package/tests/playwright/qb/auth/fetchTempToken401.test.ts +0 -219
  82. package/tests/playwright/qb/auth/getAppWithTempToken.test.ts +0 -162
  83. package/tests/playwright/qb/auth/getAppWithTempTokenConcurrency.test.ts +0 -208
  84. package/tests/playwright/qb/auth/getAppWithUserToken.test.ts +0 -153
  85. package/tests/playwright/qb/auth/getTempToken.test.ts +0 -152
  86. package/tests/playwright/qb/auth/tempTokenPrefetch.test.ts +0 -179
  87. package/tests/playwright/qb/auth/tempTokenRenewal.test.ts +0 -133
  88. package/tests/setup.ts +0 -53
  89. package/tests/vitest/qb/ThrottleBucket.test.ts +0 -77
  90. package/tests/vitest/qb/apps/copyApp.test.ts +0 -76
  91. package/tests/vitest/qb/apps/createApp.test.ts +0 -64
  92. package/tests/vitest/qb/apps/deleteApp.test.ts +0 -76
  93. package/tests/vitest/qb/apps/getApp.test.ts +0 -44
  94. package/tests/vitest/qb/apps/getAppEvents.test.ts +0 -67
  95. package/tests/vitest/qb/apps/updateApp.test.ts +0 -58
  96. package/tests/vitest/qb/auth/mockQuickbaseServer.ts +0 -60
  97. package/tests/vitest/qb/auth/retryUserToken401.test.ts +0 -73
  98. package/tests/vitest/qb/auth/ssoTokenConcurrency.test.ts +0 -68
  99. package/tests/vitest/qb/auth/ssoTokenIntegrationWithServer.test.ts +0 -65
  100. package/tests/vitest/qb/auth/userTokenConcurrency.test.ts +0 -63
  101. package/tests/vitest/qb/fields/createField.test.ts +0 -77
  102. package/tests/vitest/qb/fields/deleteFields.test.ts +0 -83
  103. package/tests/vitest/qb/fields/getField.test.ts +0 -85
  104. package/tests/vitest/qb/fields/getFieldUsage.test.ts +0 -82
  105. package/tests/vitest/qb/fields/getFields.test.ts +0 -232
  106. package/tests/vitest/qb/fields/getFieldsUsage.test.ts +0 -77
  107. package/tests/vitest/qb/fields/updateField.test.ts +0 -93
  108. package/tests/vitest/qb/formulas/runFormula.test.ts +0 -96
  109. package/tests/vitest/qb/index.ts +0 -29
  110. package/tests/vitest/qb/records/deleteRecords.test.ts +0 -110
  111. package/tests/vitest/qb/records/runQuery.test.ts +0 -146
  112. package/tests/vitest/qb/records/upsert.test.ts +0 -102
  113. package/tests/vitest/qb/tables/createRelationship.test.ts +0 -102
  114. package/tests/vitest/qb/tables/createTable.test.ts +0 -55
  115. package/tests/vitest/qb/tables/deleteRelationship.test.ts +0 -143
  116. package/tests/vitest/qb/tables/deleteTable.test.ts +0 -50
  117. package/tests/vitest/qb/tables/getAppTables.test.ts +0 -46
  118. package/tests/vitest/qb/tables/getRelationships.test.ts +0 -80
  119. package/tests/vitest/qb/tables/getTable.test.ts +0 -26
  120. package/tests/vitest/qb/tables/updateRelationship.test.ts +0 -250
  121. package/tests/vitest/qb/tables/updateTable.test.ts +0 -48
  122. package/tests/vitest/unit/ThrottleBucket.test.ts +0 -101
  123. package/tests/vitest/unit/apps/copyApp.test.ts +0 -581
  124. package/tests/vitest/unit/apps/createApp.test.ts +0 -186
  125. package/tests/vitest/unit/apps/deleteApp.test.ts +0 -216
  126. package/tests/vitest/unit/apps/getApp.test.ts +0 -128
  127. package/tests/vitest/unit/apps/getAppConcurrency.test.ts +0 -151
  128. package/tests/vitest/unit/apps/getAppEvents.test.ts +0 -193
  129. package/tests/vitest/unit/apps/updateApp.test.ts +0 -412
  130. package/tests/vitest/unit/auth/fetchTempToken401.test.ts +0 -81
  131. package/tests/vitest/unit/auth/getTempToken.test.ts +0 -119
  132. package/tests/vitest/unit/auth/retryTempToken401.test.ts +0 -95
  133. package/tests/vitest/unit/auth/retryTempTokenMaxRetries.test.ts +0 -206
  134. package/tests/vitest/unit/auth/retryUserToken401.test.ts +0 -69
  135. package/tests/vitest/unit/auth/ssoTokenRefresh.test.ts +0 -325
  136. package/tests/vitest/unit/auth/userTokenConcurrency.test.ts +0 -62
  137. package/tests/vitest/unit/fields/createField.test.ts +0 -451
  138. package/tests/vitest/unit/fields/deleteFields.test.ts +0 -141
  139. package/tests/vitest/unit/fields/getField.test.ts +0 -189
  140. package/tests/vitest/unit/fields/getFieldUsage.test.ts +0 -180
  141. package/tests/vitest/unit/fields/getFields.test.ts +0 -122
  142. package/tests/vitest/unit/fields/getFieldsUsage.test.ts +0 -160
  143. package/tests/vitest/unit/fields/updateField.test.ts +0 -285
  144. package/tests/vitest/unit/formulas/runFormula.test.ts +0 -205
  145. package/tests/vitest/unit/index.ts +0 -34
  146. package/tests/vitest/unit/quickbaseClientHttpMethods.test.ts +0 -139
  147. package/tests/vitest/unit/rateLimit.test.ts +0 -191
  148. package/tests/vitest/unit/records/deleteRecords.test.ts +0 -112
  149. package/tests/vitest/unit/records/runQuery.test.ts +0 -102
  150. package/tests/vitest/unit/records/upsert.test.ts +0 -234
  151. package/tests/vitest/unit/tables/createRelationship.test.ts +0 -212
  152. package/tests/vitest/unit/tables/createTable.test.ts +0 -70
  153. package/tests/vitest/unit/tables/deleteRelationship.test.ts +0 -97
  154. package/tests/vitest/unit/tables/deleteTable.test.ts +0 -77
  155. package/tests/vitest/unit/tables/getAppTables.test.ts +0 -85
  156. package/tests/vitest/unit/tables/getRelationships.test.ts +0 -259
  157. package/tests/vitest/unit/tables/getTable.test.ts +0 -233
  158. package/tests/vitest/unit/tables/updateRelationship.test.ts +0 -307
  159. package/tests/vitest/unit/tables/updateTable.test.ts +0 -80
  160. package/tests/vitest/unit/tokenLifespan.test.ts +0 -204
  161. package/tests/vitest/unit/umd.test.ts +0 -8
  162. package/tools/log-gen.ts +0 -251
  163. package/tools/log-gen.yaml +0 -4829
  164. package/tools/openapi-jars/openapi-generator-cli-7.12.0.jar +0 -0
  165. package/tsconfig.build.json +0 -17
  166. package/tsconfig.json +0 -32
  167. package/versionrc.json +0 -9
  168. package/vitest.config.ts +0 -27
@@ -1,4143 +0,0 @@
1
- [
2
- {
3
- "name": "createApp",
4
- "summary": "Create an app",
5
- "method": "POST",
6
- "path": "/apps",
7
- "parameters": [
8
- {
9
- "name": "body",
10
- "type": "CreateAppRequest",
11
- "required": false,
12
- "description": "",
13
- "properties": [
14
- {
15
- "name": "name",
16
- "type": "string",
17
- "required": true,
18
- "jsdoc": "The name of the app."
19
- },
20
- {
21
- "name": "description",
22
- "type": "string",
23
- "required": false,
24
- "jsdoc": "A description for the app."
25
- },
26
- {
27
- "name": "assignToken",
28
- "type": "boolean",
29
- "required": true,
30
- "jsdoc": "Whether to assign the user token."
31
- }
32
- ]
33
- }
34
- ],
35
- "returns": "CreateApp200Response",
36
- "returnTypeDetails": [
37
- {
38
- "name": "name",
39
- "type": "string",
40
- "required": true,
41
- "jsdoc": "The app name. You are allowed to create multiple apps with the same name, in the same realm, because they will have different dbid values. We urge you to be careful about doing this."
42
- },
43
- {
44
- "name": "description",
45
- "type": "string",
46
- "required": false,
47
- "jsdoc": "The description for the app. If this property is left out, the app description will be blank."
48
- },
49
- {
50
- "name": "created",
51
- "type": "string",
52
- "required": false,
53
- "jsdoc": "The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
54
- },
55
- {
56
- "name": "updated",
57
- "type": "string",
58
- "required": false,
59
- "jsdoc": "The time and date the app was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
60
- },
61
- {
62
- "name": "dateFormat",
63
- "type": "string",
64
- "required": false,
65
- "jsdoc": "A description of the format used when displaying date values in this app. Note that this is a browser-only parameter - see the [Field type details](../fieldInfo) page in the API Guide for how time values are returned in API calls. See [About Localizing Dates](https://help.quickbase.com/user-assistance/about_localizing_dates_numbers.html) to set the app’s date format."
66
- },
67
- {
68
- "name": "timeZone",
69
- "type": "string",
70
- "required": false,
71
- "jsdoc": "A description of the time zone used when displaying time values in this app. Note that this is a browser-only parameter - see the [Field type details](../fieldInfo) page in the portal for how time values are returned in API calls. See [Set the Time Zone for Both the Application and the Account](https://help.quickbase.com/user-assistance/application_local_timezone.html) to set the application’s time zone."
72
- },
73
- {
74
- "name": "memoryInfo",
75
- "type": "object",
76
- "required": false,
77
- "jsdoc": "Application memory info"
78
- },
79
- {
80
- "name": "id",
81
- "type": "string",
82
- "required": false,
83
- "jsdoc": "The unique identifier for this application."
84
- },
85
- {
86
- "name": "hasEveryoneOnTheInternet",
87
- "type": "boolean",
88
- "required": false,
89
- "jsdoc": "Indicates whether app includes Everyone On The Internet access. See [Sharing apps with Everyone on the Internet (EOTI).](https://help.quickbase.com/user-assistance/share_with_everyone_on_internet.html)"
90
- },
91
- {
92
- "name": "variables",
93
- "type": "any",
94
- "required": false,
95
- "jsdoc": "The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)"
96
- },
97
- {
98
- "name": "dataClassification",
99
- "type": "string",
100
- "required": false,
101
- "jsdoc": "The Data Classification label assigned to the application. If Data Classification is not turned on, this will not be returned. If Data Classification is turned on, but application is not labeled, we return “None\". Data Classification labels can be added in the Admin Console by a Realm Administrator for Platform+ plans."
102
- },
103
- {
104
- "name": "securityProperties",
105
- "type": "object",
106
- "required": false,
107
- "jsdoc": "Security properties of the application"
108
- }
109
- ],
110
- "docLink": "https://developer.quickbase.com/operation/createApp"
111
- },
112
- {
113
- "name": "getApp",
114
- "summary": "Get an app",
115
- "method": "GET",
116
- "path": "/apps/{appId}",
117
- "parameters": [
118
- {
119
- "name": "appId",
120
- "type": "string",
121
- "required": true,
122
- "description": "The unique identifier of an app",
123
- "properties": []
124
- }
125
- ],
126
- "returns": "GetApp200Response",
127
- "returnTypeDetails": [
128
- {
129
- "name": "ancestorId",
130
- "type": "string",
131
- "required": false,
132
- "jsdoc": "The id of the app from which this app was copied"
133
- },
134
- {
135
- "name": "name",
136
- "type": "string",
137
- "required": true,
138
- "jsdoc": "The app name. You are allowed to create multiple apps with the same name, in the same realm, because they will have different dbid values. We urge you to be careful about doing this."
139
- },
140
- {
141
- "name": "description",
142
- "type": "string",
143
- "required": false,
144
- "jsdoc": "The description for the app. If this property is left out, the app description will be blank."
145
- },
146
- {
147
- "name": "created",
148
- "type": "string",
149
- "required": false,
150
- "jsdoc": "The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
151
- },
152
- {
153
- "name": "updated",
154
- "type": "string",
155
- "required": false,
156
- "jsdoc": "The time and date the app was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
157
- },
158
- {
159
- "name": "dateFormat",
160
- "type": "string",
161
- "required": false,
162
- "jsdoc": "A description of the format used when displaying date values in this app. Note that this is a browser-only parameter - see the [Field type details](../fieldInfo) page in the API Guide for how time values are returned in API calls. See [About Localizing Dates](https://help.quickbase.com/user-assistance/about_localizing_dates_numbers.html) to set the app’s date format."
163
- },
164
- {
165
- "name": "timeZone",
166
- "type": "string",
167
- "required": false,
168
- "jsdoc": "A description of the time zone used when displaying time values in this app. Note that this is a browser-only parameter - see the [Field type details](../fieldInfo) page in the portal for how time values are returned in API calls. See [Set the Time Zone for Both the Application and the Account](https://help.quickbase.com/user-assistance/application_local_timezone.html) to set the application’s time zone."
169
- },
170
- {
171
- "name": "memoryInfo",
172
- "type": "object",
173
- "required": false,
174
- "jsdoc": "Application memory info"
175
- },
176
- {
177
- "name": "id",
178
- "type": "string",
179
- "required": false,
180
- "jsdoc": "The unique identifier for this application."
181
- },
182
- {
183
- "name": "hasEveryoneOnTheInternet",
184
- "type": "boolean",
185
- "required": false,
186
- "jsdoc": "Indicates whether app includes Everyone On The Internet access. See [Sharing apps with Everyone on the Internet (EOTI).](https://help.quickbase.com/user-assistance/share_with_everyone_on_internet.html)"
187
- },
188
- {
189
- "name": "variables",
190
- "type": "any",
191
- "required": false,
192
- "jsdoc": "The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)"
193
- },
194
- {
195
- "name": "dataClassification",
196
- "type": "string",
197
- "required": false,
198
- "jsdoc": "The Data Classification label assigned to the application. If Data Classification is not turned on, this will not be returned. If Data Classification is turned on, but application is not labeled, we return “None\". Data Classification labels can be added in the Admin Console by a Realm Administrator for Platform+ plans."
199
- },
200
- {
201
- "name": "securityProperties",
202
- "type": "object",
203
- "required": false,
204
- "jsdoc": "Security properties of the application"
205
- }
206
- ],
207
- "docLink": "https://developer.quickbase.com/operation/getApp"
208
- },
209
- {
210
- "name": "updateApp",
211
- "summary": "Update an app",
212
- "method": "POST",
213
- "path": "/apps/{appId}",
214
- "parameters": [
215
- {
216
- "name": "appId",
217
- "type": "string",
218
- "required": true,
219
- "description": "The unique identifier of an app",
220
- "properties": []
221
- },
222
- {
223
- "name": "body",
224
- "type": "UpdateAppRequest",
225
- "required": false,
226
- "description": "",
227
- "properties": [
228
- {
229
- "name": "name",
230
- "type": "string",
231
- "required": true,
232
- "jsdoc": "The name of the app."
233
- },
234
- {
235
- "name": "description",
236
- "type": "string",
237
- "required": false,
238
- "jsdoc": "A description for the app."
239
- },
240
- {
241
- "name": "assignToken",
242
- "type": "boolean",
243
- "required": true,
244
- "jsdoc": "Whether to assign the user token."
245
- }
246
- ]
247
- }
248
- ],
249
- "returns": "UpdateApp200Response",
250
- "returnTypeDetails": [
251
- {
252
- "name": "ancestorId",
253
- "type": "string",
254
- "required": false,
255
- "jsdoc": "The id of the app from which this app was copied"
256
- },
257
- {
258
- "name": "name",
259
- "type": "string",
260
- "required": true,
261
- "jsdoc": "The app name. You are allowed to create multiple apps with the same name, in the same realm, because they will have different dbid values. We urge you to be careful about doing this."
262
- },
263
- {
264
- "name": "description",
265
- "type": "string",
266
- "required": false,
267
- "jsdoc": "The description for the app. If this property is left out, the app description will be blank."
268
- },
269
- {
270
- "name": "created",
271
- "type": "string",
272
- "required": false,
273
- "jsdoc": "The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
274
- },
275
- {
276
- "name": "updated",
277
- "type": "string",
278
- "required": false,
279
- "jsdoc": "The time and date the app was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
280
- },
281
- {
282
- "name": "dateFormat",
283
- "type": "string",
284
- "required": false,
285
- "jsdoc": "A description of the format used when displaying date values in this app. Note that this is a browser-only parameter - see the [Field type details](../fieldInfo) page in the API Guide for how time values are returned in API calls. See [About Localizing Dates](https://help.quickbase.com/user-assistance/about_localizing_dates_numbers.html) to set the app’s date format."
286
- },
287
- {
288
- "name": "timeZone",
289
- "type": "string",
290
- "required": false,
291
- "jsdoc": "A description of the time zone used when displaying time values in this app. Note that this is a browser-only parameter - see the [Field type details](../fieldInfo) page in the portal for how time values are returned in API calls. See [Set the Time Zone for Both the Application and the Account](https://help.quickbase.com/user-assistance/application_local_timezone.html) to set the application’s time zone."
292
- },
293
- {
294
- "name": "memoryInfo",
295
- "type": "object",
296
- "required": false,
297
- "jsdoc": "Application memory info"
298
- },
299
- {
300
- "name": "id",
301
- "type": "string",
302
- "required": false,
303
- "jsdoc": "The unique identifier for this application."
304
- },
305
- {
306
- "name": "hasEveryoneOnTheInternet",
307
- "type": "boolean",
308
- "required": false,
309
- "jsdoc": "Indicates whether app includes Everyone On The Internet access. See [Sharing apps with Everyone on the Internet (EOTI).](https://help.quickbase.com/user-assistance/share_with_everyone_on_internet.html)"
310
- },
311
- {
312
- "name": "variables",
313
- "type": "any",
314
- "required": false,
315
- "jsdoc": "The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)"
316
- },
317
- {
318
- "name": "dataClassification",
319
- "type": "string",
320
- "required": false,
321
- "jsdoc": "The Data Classification label assigned to the application. If Data Classification is not turned on, this will not be returned. If Data Classification is turned on, but application is not labeled, we return “None\". Data Classification labels can be added in the Admin Console by a Realm Administrator for Platform+ plans."
322
- },
323
- {
324
- "name": "securityProperties",
325
- "type": "object",
326
- "required": false,
327
- "jsdoc": "Security properties of the application"
328
- }
329
- ],
330
- "docLink": "https://developer.quickbase.com/operation/updateApp"
331
- },
332
- {
333
- "name": "deleteApp",
334
- "summary": "Delete an app",
335
- "method": "DELETE",
336
- "path": "/apps/{appId}",
337
- "parameters": [
338
- {
339
- "name": "appId",
340
- "type": "string",
341
- "required": true,
342
- "description": "The unique identifier of an app",
343
- "properties": []
344
- },
345
- {
346
- "name": "body",
347
- "type": "DeleteAppRequest",
348
- "required": false,
349
- "description": "",
350
- "properties": [
351
- {
352
- "name": "name",
353
- "type": "string",
354
- "required": true,
355
- "jsdoc": "The name of the app."
356
- },
357
- {
358
- "name": "description",
359
- "type": "string",
360
- "required": false,
361
- "jsdoc": "A description for the app."
362
- },
363
- {
364
- "name": "assignToken",
365
- "type": "boolean",
366
- "required": true,
367
- "jsdoc": "Whether to assign the user token."
368
- }
369
- ]
370
- }
371
- ],
372
- "returns": "DeleteApp200Response",
373
- "returnTypeDetails": [
374
- {
375
- "name": "deletedAppId",
376
- "type": "string",
377
- "required": false,
378
- "jsdoc": "An ID of deleted application."
379
- }
380
- ],
381
- "docLink": "https://developer.quickbase.com/operation/deleteApp"
382
- },
383
- {
384
- "name": "getAppEvents",
385
- "summary": "Get app events",
386
- "method": "GET",
387
- "path": "/apps/{appId}/events",
388
- "parameters": [
389
- {
390
- "name": "appId",
391
- "type": "string",
392
- "required": true,
393
- "description": "The unique identifier of an app",
394
- "properties": []
395
- }
396
- ],
397
- "returns": "GetAppEvents200Response",
398
- "returnTypeDetails": [
399
- {
400
- "name": "isActive",
401
- "type": "boolean",
402
- "required": false,
403
- "jsdoc": "Indication of whether current event is active."
404
- },
405
- {
406
- "name": "type",
407
- "type": "string",
408
- "required": false,
409
- "jsdoc": "Type of an event."
410
- },
411
- {
412
- "name": "name",
413
- "type": "string",
414
- "required": false,
415
- "jsdoc": "The name of the event. This property is not returned for automations."
416
- },
417
- {
418
- "name": "url",
419
- "type": "string",
420
- "required": false,
421
- "jsdoc": "The url to automation that can be accessed from the browser. Only returned for automations."
422
- },
423
- {
424
- "name": "owner",
425
- "type": "object",
426
- "required": false,
427
- "jsdoc": "The user that owns the event."
428
- },
429
- {
430
- "name": "tableId",
431
- "type": "string",
432
- "required": false,
433
- "jsdoc": "The unique identifier of the table to which event belongs to."
434
- }
435
- ],
436
- "docLink": "https://developer.quickbase.com/operation/getAppEvents"
437
- },
438
- {
439
- "name": "copyApp",
440
- "summary": "Copy an app",
441
- "method": "POST",
442
- "path": "/apps/{appId}/copy",
443
- "parameters": [
444
- {
445
- "name": "appId",
446
- "type": "string",
447
- "required": true,
448
- "description": "The unique identifier of an app",
449
- "properties": []
450
- },
451
- {
452
- "name": "body",
453
- "type": "CopyAppRequest",
454
- "required": false,
455
- "description": "",
456
- "properties": [
457
- {
458
- "name": "name",
459
- "type": "string",
460
- "required": true,
461
- "jsdoc": "The name of the new app."
462
- },
463
- {
464
- "name": "description",
465
- "type": "string",
466
- "required": false,
467
- "jsdoc": "A description for the new app."
468
- },
469
- {
470
- "name": "properties",
471
- "type": "CopyAppRequestProperties",
472
- "required": false,
473
- "jsdoc": ""
474
- }
475
- ]
476
- }
477
- ],
478
- "returns": "CopyApp200Response",
479
- "returnTypeDetails": [
480
- {
481
- "name": "name",
482
- "type": "string",
483
- "required": true,
484
- "jsdoc": "The app name. You are allowed to create multiple apps with the same name, in the same realm, because they will have different dbid values. We urge you to be careful about doing this."
485
- },
486
- {
487
- "name": "description",
488
- "type": "string",
489
- "required": false,
490
- "jsdoc": "The description for the app"
491
- },
492
- {
493
- "name": "created",
494
- "type": "string",
495
- "required": false,
496
- "jsdoc": "The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
497
- },
498
- {
499
- "name": "updated",
500
- "type": "string",
501
- "required": false,
502
- "jsdoc": "The time and date the app was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
503
- },
504
- {
505
- "name": "dateFormat",
506
- "type": "string",
507
- "required": false,
508
- "jsdoc": "A description of the format used when displaying date values in this app. Note that this is a browser-only parameter - see the [Field type details](../fieldInfo) page in the API Guide for how time values are returned in API calls. See [About Localizing Dates](https://help.quickbase.com/user-assistance/about_localizing_dates_numbers.html) to set the app’s date format."
509
- },
510
- {
511
- "name": "timeZone",
512
- "type": "string",
513
- "required": false,
514
- "jsdoc": "A description of the time zone used when displaying time values in this app. Note that this is a browser-only parameter - see the [Field type details](../fieldInfo) page in the portal for how time values are returned in API calls. See [Set the Time Zone for Both the Application and the Account](https://help.quickbase.com/user-assistance/application_local_timezone.html) to set the application’s time zone."
515
- },
516
- {
517
- "name": "id",
518
- "type": "string",
519
- "required": false,
520
- "jsdoc": "The unique identifier for this application."
521
- },
522
- {
523
- "name": "hasEveryoneOnTheInternet",
524
- "type": "boolean",
525
- "required": false,
526
- "jsdoc": "Indicates whether app includes Everyone On The Internet access. See [Sharing apps with Everyone on the Internet (EOTI).](https://help.quickbase.com/user-assistance/share_with_everyone_on_internet.html)"
527
- },
528
- {
529
- "name": "variables",
530
- "type": "any",
531
- "required": false,
532
- "jsdoc": "The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)"
533
- },
534
- {
535
- "name": "ancestorId",
536
- "type": "string",
537
- "required": false,
538
- "jsdoc": "The id of the app from which this app was copied"
539
- },
540
- {
541
- "name": "dataClassification",
542
- "type": "string",
543
- "required": false,
544
- "jsdoc": "The Data Classification label assigned to the application. If Data Classification is not turned on, this will not be returned. If Data Classification is turned on, but application is not labeled, we return “None\". Data Classification labels can be added in the Admin Console by a Realm Administrator for Platform+ plans."
545
- }
546
- ],
547
- "docLink": "https://developer.quickbase.com/operation/copyApp"
548
- },
549
- {
550
- "name": "createTable",
551
- "summary": "Create a table",
552
- "method": "POST",
553
- "path": "/tables",
554
- "parameters": [
555
- {
556
- "name": "appId",
557
- "type": "string",
558
- "required": true,
559
- "description": "The unique identifier of an app",
560
- "properties": []
561
- },
562
- {
563
- "name": "body",
564
- "type": "CreateTableRequest",
565
- "required": false,
566
- "description": "",
567
- "properties": [
568
- {
569
- "name": "name",
570
- "type": "string",
571
- "required": true,
572
- "jsdoc": "The name for the table."
573
- },
574
- {
575
- "name": "description",
576
- "type": "string",
577
- "required": false,
578
- "jsdoc": "The description for the table..."
579
- },
580
- {
581
- "name": "singleRecordName",
582
- "type": "string",
583
- "required": false,
584
- "jsdoc": "The singular noun for records..."
585
- },
586
- {
587
- "name": "pluralRecordName",
588
- "type": "string",
589
- "required": false,
590
- "jsdoc": "The plural noun for records..."
591
- }
592
- ]
593
- }
594
- ],
595
- "returns": "CreateTable200Response",
596
- "returnTypeDetails": [
597
- {
598
- "name": "name",
599
- "type": "string",
600
- "required": false,
601
- "jsdoc": "The name of the table."
602
- },
603
- {
604
- "name": "id",
605
- "type": "string",
606
- "required": false,
607
- "jsdoc": "The unique identifier (dbid) of the table."
608
- },
609
- {
610
- "name": "alias",
611
- "type": "string",
612
- "required": false,
613
- "jsdoc": "The automatically-created table alias for the table."
614
- },
615
- {
616
- "name": "description",
617
- "type": "string",
618
- "required": false,
619
- "jsdoc": "The description of the table, as configured by an application administrator."
620
- },
621
- {
622
- "name": "created",
623
- "type": "string",
624
- "required": false,
625
- "jsdoc": "The time and date when the table was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
626
- },
627
- {
628
- "name": "updated",
629
- "type": "string",
630
- "required": false,
631
- "jsdoc": "The time and date when the table schema or data was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
632
- },
633
- {
634
- "name": "nextRecordId",
635
- "type": "number",
636
- "required": false,
637
- "jsdoc": "The incremental Record ID that will be used when the next record is created, as determined when the API call was ran."
638
- },
639
- {
640
- "name": "nextFieldId",
641
- "type": "number",
642
- "required": false,
643
- "jsdoc": "The incremental Field ID that will be used when the next field is created, as determined when the API call was ran."
644
- },
645
- {
646
- "name": "defaultSortFieldId",
647
- "type": "number",
648
- "required": false,
649
- "jsdoc": "The id of the field that is configured for default sorting."
650
- },
651
- {
652
- "name": "defaultSortOrder",
653
- "type": "string",
654
- "required": false,
655
- "jsdoc": "The configuration of the default sort order on the table."
656
- },
657
- {
658
- "name": "keyFieldId",
659
- "type": "number",
660
- "required": false,
661
- "jsdoc": "The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID."
662
- },
663
- {
664
- "name": "singleRecordName",
665
- "type": "string",
666
- "required": false,
667
- "jsdoc": "The builder-configured singular noun of the table."
668
- },
669
- {
670
- "name": "pluralRecordName",
671
- "type": "string",
672
- "required": false,
673
- "jsdoc": "The builder-configured plural noun of the table."
674
- },
675
- {
676
- "name": "sizeLimit",
677
- "type": "string",
678
- "required": false,
679
- "jsdoc": "The size limit for the table."
680
- },
681
- {
682
- "name": "spaceUsed",
683
- "type": "string",
684
- "required": false,
685
- "jsdoc": "The amount of space currently being used by the table."
686
- },
687
- {
688
- "name": "spaceRemaining",
689
- "type": "string",
690
- "required": false,
691
- "jsdoc": "The amount of space remaining for use by the table."
692
- }
693
- ],
694
- "docLink": "https://developer.quickbase.com/operation/createTable"
695
- },
696
- {
697
- "name": "getAppTables",
698
- "summary": "Get tables for an app",
699
- "method": "GET",
700
- "path": "/tables",
701
- "parameters": [
702
- {
703
- "name": "appId",
704
- "type": "string",
705
- "required": true,
706
- "description": "The unique identifier of an app",
707
- "properties": []
708
- }
709
- ],
710
- "returns": "GetAppTables200Response",
711
- "returnTypeDetails": [
712
- {
713
- "name": "name",
714
- "type": "string",
715
- "required": false,
716
- "jsdoc": "The name of the table."
717
- },
718
- {
719
- "name": "id",
720
- "type": "string",
721
- "required": false,
722
- "jsdoc": "The unique identifier (dbid) of the table."
723
- },
724
- {
725
- "name": "alias",
726
- "type": "string",
727
- "required": false,
728
- "jsdoc": "The automatically-created table alias for the table."
729
- },
730
- {
731
- "name": "description",
732
- "type": "string",
733
- "required": false,
734
- "jsdoc": "The description of the table, as configured by an application administrator."
735
- },
736
- {
737
- "name": "created",
738
- "type": "string",
739
- "required": false,
740
- "jsdoc": "The time and date when the table was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
741
- },
742
- {
743
- "name": "updated",
744
- "type": "string",
745
- "required": false,
746
- "jsdoc": "The time and date when the table schema or data was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
747
- },
748
- {
749
- "name": "nextRecordId",
750
- "type": "number",
751
- "required": false,
752
- "jsdoc": "The incremental Record ID that will be used when the next record is created, as determined when the API call was ran."
753
- },
754
- {
755
- "name": "nextFieldId",
756
- "type": "number",
757
- "required": false,
758
- "jsdoc": "The incremental Field ID that will be used when the next field is created, as determined when the API call was ran."
759
- },
760
- {
761
- "name": "defaultSortFieldId",
762
- "type": "number",
763
- "required": false,
764
- "jsdoc": "The id of the field that is configured for default sorting."
765
- },
766
- {
767
- "name": "defaultSortOrder",
768
- "type": "string",
769
- "required": false,
770
- "jsdoc": "The configuration of the default sort order on the table."
771
- },
772
- {
773
- "name": "keyFieldId",
774
- "type": "number",
775
- "required": false,
776
- "jsdoc": "The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID."
777
- },
778
- {
779
- "name": "singleRecordName",
780
- "type": "string",
781
- "required": false,
782
- "jsdoc": "The builder-configured singular noun of the table."
783
- },
784
- {
785
- "name": "pluralRecordName",
786
- "type": "string",
787
- "required": false,
788
- "jsdoc": "The builder-configured plural noun of the table."
789
- },
790
- {
791
- "name": "sizeLimit",
792
- "type": "string",
793
- "required": false,
794
- "jsdoc": "The size limit for the table."
795
- },
796
- {
797
- "name": "spaceUsed",
798
- "type": "string",
799
- "required": false,
800
- "jsdoc": "The amount of space currently being used by the table."
801
- },
802
- {
803
- "name": "spaceRemaining",
804
- "type": "string",
805
- "required": false,
806
- "jsdoc": "The amount of space remaining for use by the table."
807
- }
808
- ],
809
- "docLink": "https://developer.quickbase.com/operation/getAppTables"
810
- },
811
- {
812
- "name": "getTable",
813
- "summary": "Get a table",
814
- "method": "GET",
815
- "path": "/tables/{tableId}",
816
- "parameters": [
817
- {
818
- "name": "appId",
819
- "type": "string",
820
- "required": true,
821
- "description": "The unique identifier of an app",
822
- "properties": []
823
- },
824
- {
825
- "name": "tableId",
826
- "type": "string",
827
- "required": true,
828
- "description": "The unique identifier (dbid) of the table.",
829
- "properties": []
830
- }
831
- ],
832
- "returns": "GetTable200Response",
833
- "returnTypeDetails": [
834
- {
835
- "name": "name",
836
- "type": "string",
837
- "required": false,
838
- "jsdoc": "The name of the table."
839
- },
840
- {
841
- "name": "id",
842
- "type": "string",
843
- "required": false,
844
- "jsdoc": "The unique identifier (dbid) of the table."
845
- },
846
- {
847
- "name": "alias",
848
- "type": "string",
849
- "required": false,
850
- "jsdoc": "The automatically-created table alias for the table."
851
- },
852
- {
853
- "name": "description",
854
- "type": "string",
855
- "required": false,
856
- "jsdoc": "The description of the table, as configured by an application administrator."
857
- },
858
- {
859
- "name": "created",
860
- "type": "string",
861
- "required": false,
862
- "jsdoc": "The time and date when the table was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
863
- },
864
- {
865
- "name": "updated",
866
- "type": "string",
867
- "required": false,
868
- "jsdoc": "The time and date when the table schema or data was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
869
- },
870
- {
871
- "name": "nextRecordId",
872
- "type": "number",
873
- "required": false,
874
- "jsdoc": "The incremental Record ID that will be used when the next record is created, as determined when the API call was ran."
875
- },
876
- {
877
- "name": "nextFieldId",
878
- "type": "number",
879
- "required": false,
880
- "jsdoc": "The incremental Field ID that will be used when the next field is created, as determined when the API call was ran."
881
- },
882
- {
883
- "name": "defaultSortFieldId",
884
- "type": "number",
885
- "required": false,
886
- "jsdoc": "The id of the field that is configured for default sorting."
887
- },
888
- {
889
- "name": "defaultSortOrder",
890
- "type": "string",
891
- "required": false,
892
- "jsdoc": "The configuration of the default sort order on the table."
893
- },
894
- {
895
- "name": "keyFieldId",
896
- "type": "number",
897
- "required": false,
898
- "jsdoc": "The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID."
899
- },
900
- {
901
- "name": "singleRecordName",
902
- "type": "string",
903
- "required": false,
904
- "jsdoc": "The builder-configured singular noun of the table."
905
- },
906
- {
907
- "name": "pluralRecordName",
908
- "type": "string",
909
- "required": false,
910
- "jsdoc": "The builder-configured plural noun of the table."
911
- },
912
- {
913
- "name": "sizeLimit",
914
- "type": "string",
915
- "required": false,
916
- "jsdoc": "The size limit for the table."
917
- },
918
- {
919
- "name": "spaceUsed",
920
- "type": "string",
921
- "required": false,
922
- "jsdoc": "The amount of space currently being used by the table."
923
- },
924
- {
925
- "name": "spaceRemaining",
926
- "type": "string",
927
- "required": false,
928
- "jsdoc": "The amount of space remaining for use by the table."
929
- }
930
- ],
931
- "docLink": "https://developer.quickbase.com/operation/getTable"
932
- },
933
- {
934
- "name": "updateTable",
935
- "summary": "Update a table",
936
- "method": "POST",
937
- "path": "/tables/{tableId}",
938
- "parameters": [
939
- {
940
- "name": "appId",
941
- "type": "string",
942
- "required": true,
943
- "description": "The unique identifier of an app",
944
- "properties": []
945
- },
946
- {
947
- "name": "tableId",
948
- "type": "string",
949
- "required": true,
950
- "description": "The unique identifier (dbid) of the table.",
951
- "properties": []
952
- },
953
- {
954
- "name": "body",
955
- "type": "UpdateTableRequest",
956
- "required": false,
957
- "description": "",
958
- "properties": [
959
- {
960
- "name": "name",
961
- "type": "string",
962
- "required": false,
963
- "jsdoc": "The updated name of the table."
964
- },
965
- {
966
- "name": "description",
967
- "type": "string",
968
- "required": false,
969
- "jsdoc": "The updated description for the table."
970
- }
971
- ]
972
- }
973
- ],
974
- "returns": "UpdateTable200Response",
975
- "returnTypeDetails": [
976
- {
977
- "name": "name",
978
- "type": "string",
979
- "required": false,
980
- "jsdoc": "The name of the table."
981
- },
982
- {
983
- "name": "id",
984
- "type": "string",
985
- "required": false,
986
- "jsdoc": "The unique identifier (dbid) of the table."
987
- },
988
- {
989
- "name": "alias",
990
- "type": "string",
991
- "required": false,
992
- "jsdoc": "The automatically-created table alias for the table."
993
- },
994
- {
995
- "name": "description",
996
- "type": "string",
997
- "required": false,
998
- "jsdoc": "The description of the table, as configured by an application administrator."
999
- },
1000
- {
1001
- "name": "created",
1002
- "type": "string",
1003
- "required": false,
1004
- "jsdoc": "The time and date when the table was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
1005
- },
1006
- {
1007
- "name": "updated",
1008
- "type": "string",
1009
- "required": false,
1010
- "jsdoc": "The time and date when the table schema or data was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
1011
- },
1012
- {
1013
- "name": "nextRecordId",
1014
- "type": "number",
1015
- "required": false,
1016
- "jsdoc": "The incremental Record ID that will be used when the next record is created, as determined when the API call was ran."
1017
- },
1018
- {
1019
- "name": "nextFieldId",
1020
- "type": "number",
1021
- "required": false,
1022
- "jsdoc": "The incremental Field ID that will be used when the next field is created, as determined when the API call was ran."
1023
- },
1024
- {
1025
- "name": "defaultSortFieldId",
1026
- "type": "number",
1027
- "required": false,
1028
- "jsdoc": "The id of the field that is configured for default sorting."
1029
- },
1030
- {
1031
- "name": "defaultSortOrder",
1032
- "type": "string",
1033
- "required": false,
1034
- "jsdoc": "The configuration of the default sort order on the table."
1035
- },
1036
- {
1037
- "name": "keyFieldId",
1038
- "type": "number",
1039
- "required": false,
1040
- "jsdoc": "The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID."
1041
- },
1042
- {
1043
- "name": "singleRecordName",
1044
- "type": "string",
1045
- "required": false,
1046
- "jsdoc": "The builder-configured singular noun of the table."
1047
- },
1048
- {
1049
- "name": "pluralRecordName",
1050
- "type": "string",
1051
- "required": false,
1052
- "jsdoc": "The builder-configured plural noun of the table."
1053
- },
1054
- {
1055
- "name": "sizeLimit",
1056
- "type": "string",
1057
- "required": false,
1058
- "jsdoc": "The size limit for the table."
1059
- },
1060
- {
1061
- "name": "spaceUsed",
1062
- "type": "string",
1063
- "required": false,
1064
- "jsdoc": "The amount of space currently being used by the table."
1065
- },
1066
- {
1067
- "name": "spaceRemaining",
1068
- "type": "string",
1069
- "required": false,
1070
- "jsdoc": "The amount of space remaining for use by the table."
1071
- }
1072
- ],
1073
- "docLink": "https://developer.quickbase.com/operation/updateTable"
1074
- },
1075
- {
1076
- "name": "deleteTable",
1077
- "summary": "Delete a table",
1078
- "method": "DELETE",
1079
- "path": "/tables/{tableId}",
1080
- "parameters": [
1081
- {
1082
- "name": "appId",
1083
- "type": "string",
1084
- "required": true,
1085
- "description": "The unique identifier of an app",
1086
- "properties": []
1087
- },
1088
- {
1089
- "name": "tableId",
1090
- "type": "string",
1091
- "required": true,
1092
- "description": "The unique identifier (dbid) of the table.",
1093
- "properties": []
1094
- }
1095
- ],
1096
- "returns": "DeleteTable200Response",
1097
- "returnTypeDetails": [
1098
- {
1099
- "name": "deletedTableId",
1100
- "type": "string",
1101
- "required": false,
1102
- "jsdoc": "The deleted table id."
1103
- }
1104
- ],
1105
- "docLink": "https://developer.quickbase.com/operation/deleteTable"
1106
- },
1107
- {
1108
- "name": "getRelationships",
1109
- "summary": "Get all relationships",
1110
- "method": "GET",
1111
- "path": "/tables/{tableId}/relationships",
1112
- "parameters": [
1113
- {
1114
- "name": "skip",
1115
- "type": "number",
1116
- "required": false,
1117
- "description": "The number of relationships to skip.",
1118
- "properties": []
1119
- },
1120
- {
1121
- "name": "tableId",
1122
- "type": "string",
1123
- "required": true,
1124
- "description": "The unique identifier (dbid) of the child table.",
1125
- "properties": []
1126
- }
1127
- ],
1128
- "returns": "GetRelationships200Response",
1129
- "returnTypeDetails": [
1130
- {
1131
- "name": "relationships",
1132
- "type": "any",
1133
- "required": true,
1134
- "jsdoc": "The relationships in a table."
1135
- },
1136
- {
1137
- "name": "metadata",
1138
- "type": "object",
1139
- "required": false,
1140
- "jsdoc": "Additional information about the results that may be helpful."
1141
- }
1142
- ],
1143
- "docLink": "https://developer.quickbase.com/operation/getRelationships"
1144
- },
1145
- {
1146
- "name": "createRelationship",
1147
- "summary": "Create a relationship",
1148
- "method": "POST",
1149
- "path": "/tables/{tableId}/relationship",
1150
- "parameters": [
1151
- {
1152
- "name": "tableId",
1153
- "type": "string",
1154
- "required": true,
1155
- "description": "The unique identifier (dbid) of the table. This will be the child table.",
1156
- "properties": []
1157
- },
1158
- {
1159
- "name": "body",
1160
- "type": "CreateRelationshipRequest",
1161
- "required": false,
1162
- "description": "",
1163
- "properties": [
1164
- {
1165
- "name": "parentTableId",
1166
- "type": "string",
1167
- "required": true,
1168
- "jsdoc": "The parent table id for the relationship."
1169
- },
1170
- {
1171
- "name": "foreignKeyField",
1172
- "type": "{ [key: string]: any; }",
1173
- "required": false,
1174
- "jsdoc": ""
1175
- },
1176
- {
1177
- "name": "lookupFieldIds",
1178
- "type": "number[]",
1179
- "required": false,
1180
- "jsdoc": "Array of field ids..."
1181
- },
1182
- {
1183
- "name": "summaryFields",
1184
- "type": "{ [key: string]: any; }[]",
1185
- "required": false,
1186
- "jsdoc": "Array of summary field objects..."
1187
- }
1188
- ]
1189
- }
1190
- ],
1191
- "returns": "CreateRelationship200Response",
1192
- "returnTypeDetails": [
1193
- {
1194
- "name": "id",
1195
- "type": "number",
1196
- "required": true,
1197
- "jsdoc": "The relationship id (foreign key field id)."
1198
- },
1199
- {
1200
- "name": "parentTableId",
1201
- "type": "string",
1202
- "required": true,
1203
- "jsdoc": "The parent table id of the relationship."
1204
- },
1205
- {
1206
- "name": "childTableId",
1207
- "type": "string",
1208
- "required": true,
1209
- "jsdoc": "The child table id of the relationship."
1210
- },
1211
- {
1212
- "name": "foreignKeyField",
1213
- "type": "object",
1214
- "required": false,
1215
- "jsdoc": "The foreign key field information."
1216
- },
1217
- {
1218
- "name": "isCrossApp",
1219
- "type": "boolean",
1220
- "required": true,
1221
- "jsdoc": "Whether this is a cross-app relationship."
1222
- },
1223
- {
1224
- "name": "lookupFields",
1225
- "type": "any",
1226
- "required": false,
1227
- "jsdoc": "The lookup fields array."
1228
- },
1229
- {
1230
- "name": "summaryFields",
1231
- "type": "any",
1232
- "required": false,
1233
- "jsdoc": "The summary fields array."
1234
- }
1235
- ],
1236
- "docLink": "https://developer.quickbase.com/operation/createRelationship"
1237
- },
1238
- {
1239
- "name": "updateRelationship",
1240
- "summary": "Update a relationship",
1241
- "method": "POST",
1242
- "path": "/tables/{tableId}/relationship/{relationshipId}",
1243
- "parameters": [
1244
- {
1245
- "name": "tableId",
1246
- "type": "string",
1247
- "required": true,
1248
- "description": "The unique identifier (dbid) of the table. This will be the child table.",
1249
- "properties": []
1250
- },
1251
- {
1252
- "name": "relationshipId",
1253
- "type": "number",
1254
- "required": true,
1255
- "description": "The relationship id. This is the field id of the reference field on the child table.",
1256
- "properties": []
1257
- },
1258
- {
1259
- "name": "body",
1260
- "type": "UpdateRelationshipRequest",
1261
- "required": false,
1262
- "description": "",
1263
- "properties": [
1264
- {
1265
- "name": "parentTableId",
1266
- "type": "string",
1267
- "required": false,
1268
- "jsdoc": "The updated parent table id..."
1269
- },
1270
- {
1271
- "name": "foreignKeyField",
1272
- "type": "{ [key: string]: any; }",
1273
- "required": false,
1274
- "jsdoc": ""
1275
- },
1276
- {
1277
- "name": "lookupFieldIds",
1278
- "type": "number[]",
1279
- "required": false,
1280
- "jsdoc": "Updated array of field ids..."
1281
- },
1282
- {
1283
- "name": "summaryFields",
1284
- "type": "{ [key: string]: any; }[]",
1285
- "required": false,
1286
- "jsdoc": ""
1287
- }
1288
- ]
1289
- }
1290
- ],
1291
- "returns": "UpdateRelationship200Response",
1292
- "returnTypeDetails": [
1293
- {
1294
- "name": "id",
1295
- "type": "number",
1296
- "required": true,
1297
- "jsdoc": "The relationship id (foreign key field id)."
1298
- },
1299
- {
1300
- "name": "parentTableId",
1301
- "type": "string",
1302
- "required": true,
1303
- "jsdoc": "The parent table id of the relationship."
1304
- },
1305
- {
1306
- "name": "childTableId",
1307
- "type": "string",
1308
- "required": true,
1309
- "jsdoc": "The child table id of the relationship."
1310
- },
1311
- {
1312
- "name": "foreignKeyField",
1313
- "type": "object",
1314
- "required": false,
1315
- "jsdoc": "The foreign key field information."
1316
- },
1317
- {
1318
- "name": "isCrossApp",
1319
- "type": "boolean",
1320
- "required": true,
1321
- "jsdoc": "Whether this is a cross-app relationship."
1322
- },
1323
- {
1324
- "name": "lookupFields",
1325
- "type": "any",
1326
- "required": false,
1327
- "jsdoc": "The lookup fields array."
1328
- },
1329
- {
1330
- "name": "summaryFields",
1331
- "type": "any",
1332
- "required": false,
1333
- "jsdoc": "The summary fields array."
1334
- }
1335
- ],
1336
- "docLink": "https://developer.quickbase.com/operation/updateRelationship"
1337
- },
1338
- {
1339
- "name": "deleteRelationship",
1340
- "summary": "Delete a relationship",
1341
- "method": "DELETE",
1342
- "path": "/tables/{tableId}/relationship/{relationshipId}",
1343
- "parameters": [
1344
- {
1345
- "name": "tableId",
1346
- "type": "string",
1347
- "required": true,
1348
- "description": "The unique identifier (dbid) of the table. This will be the child table.",
1349
- "properties": []
1350
- },
1351
- {
1352
- "name": "relationshipId",
1353
- "type": "number",
1354
- "required": true,
1355
- "description": "The relationship id. This is the field id of the reference field on the child table.",
1356
- "properties": []
1357
- }
1358
- ],
1359
- "returns": "DeleteRelationship200Response",
1360
- "returnTypeDetails": [
1361
- {
1362
- "name": "relationshipId",
1363
- "type": "number",
1364
- "required": true,
1365
- "jsdoc": "The relationship id."
1366
- }
1367
- ],
1368
- "docLink": "https://developer.quickbase.com/operation/deleteRelationship"
1369
- },
1370
- {
1371
- "name": "getTableReports",
1372
- "summary": "Get reports for a table",
1373
- "method": "GET",
1374
- "path": "/reports",
1375
- "parameters": [
1376
- {
1377
- "name": "tableId",
1378
- "type": "string",
1379
- "required": true,
1380
- "description": "The unique identifier of the table.",
1381
- "properties": []
1382
- }
1383
- ],
1384
- "returns": "GetTableReports200Response",
1385
- "returnTypeDetails": [
1386
- {
1387
- "name": "id",
1388
- "type": "string",
1389
- "required": false,
1390
- "jsdoc": "The identifier of the report, unique to the table."
1391
- },
1392
- {
1393
- "name": "name",
1394
- "type": "string",
1395
- "required": false,
1396
- "jsdoc": "The configured name of the report."
1397
- },
1398
- {
1399
- "name": "type",
1400
- "type": "string",
1401
- "required": false,
1402
- "jsdoc": "The type of report in Quickbase (e.g., chart)."
1403
- },
1404
- {
1405
- "name": "description",
1406
- "type": "string",
1407
- "required": false,
1408
- "jsdoc": "The configured description of a report."
1409
- },
1410
- {
1411
- "name": "ownerId",
1412
- "type": "number",
1413
- "required": false,
1414
- "jsdoc": "Optional, showed only for personal reports. The user ID of report owner."
1415
- },
1416
- {
1417
- "name": "query",
1418
- "type": "object",
1419
- "required": false,
1420
- "jsdoc": "The query definition as configured in Quickbase that gets executed when the report is run."
1421
- },
1422
- {
1423
- "name": "properties",
1424
- "type": "{ [key: string]: any; }",
1425
- "required": false,
1426
- "jsdoc": "A list of properties specific to the report type. To see a detailed description of the properties for each report type, See [Report Types.](../reportTypes)"
1427
- },
1428
- {
1429
- "name": "usedLast",
1430
- "type": "string",
1431
- "required": false,
1432
- "jsdoc": "The instant at which a report was last used."
1433
- },
1434
- {
1435
- "name": "usedCount",
1436
- "type": "number",
1437
- "required": false,
1438
- "jsdoc": "The number of times a report has been used."
1439
- }
1440
- ],
1441
- "docLink": "https://developer.quickbase.com/operation/getTableReports"
1442
- },
1443
- {
1444
- "name": "getReport",
1445
- "summary": "Get a report",
1446
- "method": "GET",
1447
- "path": "/reports/{reportId}",
1448
- "parameters": [
1449
- {
1450
- "name": "tableId",
1451
- "type": "string",
1452
- "required": true,
1453
- "description": "The unique identifier of table.",
1454
- "properties": []
1455
- },
1456
- {
1457
- "name": "reportId",
1458
- "type": "string",
1459
- "required": true,
1460
- "description": "The identifier of the report, unique to the table.",
1461
- "properties": []
1462
- }
1463
- ],
1464
- "returns": "GetReport200Response",
1465
- "returnTypeDetails": [
1466
- {
1467
- "name": "id",
1468
- "type": "string",
1469
- "required": false,
1470
- "jsdoc": "The identifier of the report, unique to the table."
1471
- },
1472
- {
1473
- "name": "name",
1474
- "type": "string",
1475
- "required": false,
1476
- "jsdoc": "The configured name of the report."
1477
- },
1478
- {
1479
- "name": "type",
1480
- "type": "string",
1481
- "required": false,
1482
- "jsdoc": "The type of report in Quickbase (e.g., chart)."
1483
- },
1484
- {
1485
- "name": "description",
1486
- "type": "string",
1487
- "required": false,
1488
- "jsdoc": "The configured description of a report."
1489
- },
1490
- {
1491
- "name": "ownerId",
1492
- "type": "number",
1493
- "required": false,
1494
- "jsdoc": "Optional, showed only for personal reports. The user ID of report owner."
1495
- },
1496
- {
1497
- "name": "query",
1498
- "type": "object",
1499
- "required": false,
1500
- "jsdoc": "The query definition as configured in Quickbase that gets executed when the report is run."
1501
- },
1502
- {
1503
- "name": "properties",
1504
- "type": "{ [key: string]: any; }",
1505
- "required": false,
1506
- "jsdoc": "A list of properties specific to the report type. To see a detailed description of the properties for each report type, See [Report Types.](../reportTypes)"
1507
- },
1508
- {
1509
- "name": "usedLast",
1510
- "type": "string",
1511
- "required": false,
1512
- "jsdoc": "The instant at which a report was last used."
1513
- },
1514
- {
1515
- "name": "usedCount",
1516
- "type": "number",
1517
- "required": false,
1518
- "jsdoc": "The number of times a report has been used."
1519
- }
1520
- ],
1521
- "docLink": "https://developer.quickbase.com/operation/getReport"
1522
- },
1523
- {
1524
- "name": "runReport",
1525
- "summary": "Run a report",
1526
- "method": "POST",
1527
- "path": "/reports/{reportId}/run",
1528
- "parameters": [
1529
- {
1530
- "name": "tableId",
1531
- "type": "string",
1532
- "required": true,
1533
- "description": "The identifier of the table for the report.",
1534
- "properties": []
1535
- },
1536
- {
1537
- "name": "skip",
1538
- "type": "number",
1539
- "required": false,
1540
- "description": "The number of records to skip. You can set this value when paginating through a set of results.",
1541
- "properties": []
1542
- },
1543
- {
1544
- "name": "top",
1545
- "type": "number",
1546
- "required": false,
1547
- "description": "The maximum number of records to return. You can override the default Quickbase pagination to get more or fewer results. If your requested value here exceeds the dynamic maximums, we will return a subset of results and the rest can be gathered in subsequent API calls.",
1548
- "properties": []
1549
- },
1550
- {
1551
- "name": "reportId",
1552
- "type": "string",
1553
- "required": true,
1554
- "description": "The identifier of the report, unique to the table.",
1555
- "properties": []
1556
- },
1557
- {
1558
- "name": "body",
1559
- "type": "any",
1560
- "required": false,
1561
- "description": "",
1562
- "properties": []
1563
- }
1564
- ],
1565
- "returns": "RunReport200Response",
1566
- "returnTypeDetails": [
1567
- {
1568
- "name": "fields",
1569
- "type": "any",
1570
- "required": false,
1571
- "jsdoc": "An array of objects that contains limited meta-data of each field displayed in the report. This assists in building logic that depends on field types and IDs."
1572
- },
1573
- {
1574
- "name": "data",
1575
- "type": "any",
1576
- "required": false,
1577
- "jsdoc": "An array of objects that either represents the record data or summarized values, depending on the report type."
1578
- },
1579
- {
1580
- "name": "metadata",
1581
- "type": "object",
1582
- "required": false,
1583
- "jsdoc": "Additional information about the results that may be helpful. Pagination may be needed if either you specify a smaller number of results to skip than is available, or if the API automatically returns fewer results. numRecords can be compared to totalRecords to determine if further pagination is needed."
1584
- }
1585
- ],
1586
- "docLink": "https://developer.quickbase.com/operation/runReport"
1587
- },
1588
- {
1589
- "name": "getFields",
1590
- "summary": "Get fields for a table",
1591
- "method": "GET",
1592
- "path": "/fields",
1593
- "parameters": [
1594
- {
1595
- "name": "tableId",
1596
- "type": "string",
1597
- "required": true,
1598
- "description": "The unique identifier (dbid) of the table.",
1599
- "properties": []
1600
- },
1601
- {
1602
- "name": "includeFieldPerms",
1603
- "type": "boolean",
1604
- "required": false,
1605
- "description": "Set to 'true' if you'd like to get back the custom permissions for the field(s).",
1606
- "properties": []
1607
- }
1608
- ],
1609
- "returns": "GetFields200Response",
1610
- "returnTypeDetails": [
1611
- {
1612
- "name": "id",
1613
- "type": "number",
1614
- "required": true,
1615
- "jsdoc": "The id of the field, unique to this table."
1616
- },
1617
- {
1618
- "name": "fieldType",
1619
- "type": "string",
1620
- "required": false,
1621
- "jsdoc": "The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html)."
1622
- },
1623
- {
1624
- "name": "mode",
1625
- "type": "string",
1626
- "required": false,
1627
- "jsdoc": "For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank."
1628
- },
1629
- {
1630
- "name": "label",
1631
- "type": "string",
1632
- "required": false,
1633
- "jsdoc": "The label (name) of the field."
1634
- },
1635
- {
1636
- "name": "noWrap",
1637
- "type": "boolean",
1638
- "required": false,
1639
- "jsdoc": "Indicates if the field is configured to not wrap when displayed in the product."
1640
- },
1641
- {
1642
- "name": "bold",
1643
- "type": "boolean",
1644
- "required": false,
1645
- "jsdoc": "Indicates if the field is configured to display in bold in the product."
1646
- },
1647
- {
1648
- "name": "required",
1649
- "type": "boolean",
1650
- "required": false,
1651
- "jsdoc": "Indicates if the field is marked required."
1652
- },
1653
- {
1654
- "name": "appearsByDefault",
1655
- "type": "boolean",
1656
- "required": false,
1657
- "jsdoc": "Indicates if the field is marked as a default in reports."
1658
- },
1659
- {
1660
- "name": "findEnabled",
1661
- "type": "boolean",
1662
- "required": false,
1663
- "jsdoc": "Indicates if the field is marked as searchable."
1664
- },
1665
- {
1666
- "name": "unique",
1667
- "type": "boolean",
1668
- "required": false,
1669
- "jsdoc": "Indicates if the field is marked unique."
1670
- },
1671
- {
1672
- "name": "doesDataCopy",
1673
- "type": "boolean",
1674
- "required": false,
1675
- "jsdoc": "Indicates if the field data will copy when a user copies the record."
1676
- },
1677
- {
1678
- "name": "fieldHelp",
1679
- "type": "string",
1680
- "required": false,
1681
- "jsdoc": "The configured help text shown to users within the product."
1682
- },
1683
- {
1684
- "name": "audited",
1685
- "type": "boolean",
1686
- "required": false,
1687
- "jsdoc": "Indicates if the field is being tracked as part of Quickbase Audit Logs."
1688
- },
1689
- {
1690
- "name": "properties",
1691
- "type": "{ [key: string]: any; }",
1692
- "required": false,
1693
- "jsdoc": "Additional properties for the field. Please see [Field type details](../fieldInfo) page for more details on the properties for each field type."
1694
- },
1695
- {
1696
- "name": "permissions",
1697
- "type": "Permission[]",
1698
- "required": false,
1699
- "jsdoc": "Field Permissions for different roles.",
1700
- "properties": [
1701
- {
1702
- "name": "role",
1703
- "type": "string",
1704
- "required": true,
1705
- "jsdoc": "The role name"
1706
- },
1707
- {
1708
- "name": "permissionType",
1709
- "type": "string",
1710
- "required": true,
1711
- "jsdoc": "Permission type (e.g., View, Modify)"
1712
- },
1713
- {
1714
- "name": "roleId",
1715
- "type": "number",
1716
- "required": true,
1717
- "jsdoc": "The role identifier"
1718
- }
1719
- ]
1720
- }
1721
- ],
1722
- "docLink": "https://developer.quickbase.com/operation/getFields"
1723
- },
1724
- {
1725
- "name": "createField",
1726
- "summary": "Create a field",
1727
- "method": "POST",
1728
- "path": "/fields",
1729
- "parameters": [
1730
- {
1731
- "name": "tableId",
1732
- "type": "string",
1733
- "required": true,
1734
- "description": "The unique identifier of the table.",
1735
- "properties": []
1736
- },
1737
- {
1738
- "name": "body",
1739
- "type": "CreateFieldRequest",
1740
- "required": false,
1741
- "description": "",
1742
- "properties": [
1743
- {
1744
- "name": "label",
1745
- "type": "string",
1746
- "required": true,
1747
- "jsdoc": "The label of the field"
1748
- },
1749
- {
1750
- "name": "fieldType",
1751
- "type": "CreateFieldRequestFieldTypeEnum",
1752
- "required": true,
1753
- "jsdoc": "The type of the field"
1754
- },
1755
- {
1756
- "name": "fieldHelp",
1757
- "type": "string",
1758
- "required": false,
1759
- "jsdoc": "Help text for the field"
1760
- },
1761
- {
1762
- "name": "addToForms",
1763
- "type": "boolean",
1764
- "required": false,
1765
- "jsdoc": "Whether to add the field to forms"
1766
- },
1767
- {
1768
- "name": "permissions",
1769
- "type": "object",
1770
- "required": false,
1771
- "jsdoc": "Custom permissions for the field"
1772
- },
1773
- {
1774
- "name": "required",
1775
- "type": "boolean",
1776
- "required": false,
1777
- "jsdoc": "Whether the field is required"
1778
- },
1779
- {
1780
- "name": "unique",
1781
- "type": "boolean",
1782
- "required": false,
1783
- "jsdoc": "Whether the field must have unique values"
1784
- },
1785
- {
1786
- "name": "noWrap",
1787
- "type": "boolean",
1788
- "required": false,
1789
- "jsdoc": "Whether text wrapping is disabled"
1790
- },
1791
- {
1792
- "name": "bold",
1793
- "type": "boolean",
1794
- "required": false,
1795
- "jsdoc": "Whether the field is bolded"
1796
- },
1797
- {
1798
- "name": "appearsByDefault",
1799
- "type": "boolean",
1800
- "required": false,
1801
- "jsdoc": "Whether the field appears by default in reports"
1802
- },
1803
- {
1804
- "name": "findEnabled",
1805
- "type": "boolean",
1806
- "required": false,
1807
- "jsdoc": "Whether the field is searchable"
1808
- },
1809
- {
1810
- "name": "doesDataCopy",
1811
- "type": "boolean",
1812
- "required": false,
1813
- "jsdoc": "Whether the field copies data"
1814
- },
1815
- {
1816
- "name": "audited",
1817
- "type": "boolean",
1818
- "required": false,
1819
- "jsdoc": "Whether changes to the field are audited"
1820
- },
1821
- {
1822
- "name": "properties",
1823
- "type": "CreateFieldRequestProperties",
1824
- "required": false,
1825
- "jsdoc": ""
1826
- }
1827
- ]
1828
- }
1829
- ],
1830
- "returns": "CreateField200Response",
1831
- "returnTypeDetails": [
1832
- {
1833
- "name": "id",
1834
- "type": "number",
1835
- "required": true,
1836
- "jsdoc": "The id of the field, unique to this table."
1837
- },
1838
- {
1839
- "name": "fieldType",
1840
- "type": "string",
1841
- "required": false,
1842
- "jsdoc": "The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html)."
1843
- },
1844
- {
1845
- "name": "mode",
1846
- "type": "string",
1847
- "required": false,
1848
- "jsdoc": "For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank."
1849
- },
1850
- {
1851
- "name": "label",
1852
- "type": "string",
1853
- "required": false,
1854
- "jsdoc": "The label (name) of the field."
1855
- },
1856
- {
1857
- "name": "noWrap",
1858
- "type": "boolean",
1859
- "required": false,
1860
- "jsdoc": "Indicates if the field is configured to not wrap when displayed in the product."
1861
- },
1862
- {
1863
- "name": "bold",
1864
- "type": "boolean",
1865
- "required": false,
1866
- "jsdoc": "Indicates if the field is configured to display in bold in the product."
1867
- },
1868
- {
1869
- "name": "required",
1870
- "type": "boolean",
1871
- "required": false,
1872
- "jsdoc": "Indicates if the field is marked required."
1873
- },
1874
- {
1875
- "name": "appearsByDefault",
1876
- "type": "boolean",
1877
- "required": false,
1878
- "jsdoc": "Indicates if the field is marked as a default in reports."
1879
- },
1880
- {
1881
- "name": "findEnabled",
1882
- "type": "boolean",
1883
- "required": false,
1884
- "jsdoc": "Indicates if the field is marked as searchable."
1885
- },
1886
- {
1887
- "name": "unique",
1888
- "type": "boolean",
1889
- "required": false,
1890
- "jsdoc": "Indicates if the field is marked unique."
1891
- },
1892
- {
1893
- "name": "doesDataCopy",
1894
- "type": "boolean",
1895
- "required": false,
1896
- "jsdoc": "Indicates if the field data will copy when a user copies the record."
1897
- },
1898
- {
1899
- "name": "fieldHelp",
1900
- "type": "string",
1901
- "required": false,
1902
- "jsdoc": "The configured help text shown to users within the product."
1903
- },
1904
- {
1905
- "name": "audited",
1906
- "type": "boolean",
1907
- "required": false,
1908
- "jsdoc": "Indicates if the field is being tracked as part of Quickbase Audit Logs."
1909
- },
1910
- {
1911
- "name": "properties",
1912
- "type": "{ [key: string]: any; }",
1913
- "required": false,
1914
- "jsdoc": "Additional properties for the field. Please see [Field type details](../fieldInfo) page for more details on the properties for each field type."
1915
- },
1916
- {
1917
- "name": "permissions",
1918
- "type": "Permission[]",
1919
- "required": false,
1920
- "jsdoc": "Field Permissions for different roles.",
1921
- "properties": [
1922
- {
1923
- "name": "role",
1924
- "type": "string",
1925
- "required": true,
1926
- "jsdoc": "The role name"
1927
- },
1928
- {
1929
- "name": "permissionType",
1930
- "type": "string",
1931
- "required": true,
1932
- "jsdoc": "Permission type (e.g., View, Modify)"
1933
- },
1934
- {
1935
- "name": "roleId",
1936
- "type": "number",
1937
- "required": true,
1938
- "jsdoc": "The role identifier"
1939
- }
1940
- ]
1941
- }
1942
- ],
1943
- "docLink": "https://developer.quickbase.com/operation/createField"
1944
- },
1945
- {
1946
- "name": "deleteFields",
1947
- "summary": "Delete field(s)",
1948
- "method": "DELETE",
1949
- "path": "/fields",
1950
- "parameters": [
1951
- {
1952
- "name": "tableId",
1953
- "type": "string",
1954
- "required": true,
1955
- "description": "The unique identifier of the table.",
1956
- "properties": []
1957
- },
1958
- {
1959
- "name": "body",
1960
- "type": "DeleteFieldsRequest",
1961
- "required": false,
1962
- "description": "",
1963
- "properties": [
1964
- {
1965
- "name": "fieldIds",
1966
- "type": "number[]",
1967
- "required": true,
1968
- "jsdoc": ""
1969
- }
1970
- ]
1971
- }
1972
- ],
1973
- "returns": "DeleteFields200Response",
1974
- "returnTypeDetails": [
1975
- {
1976
- "name": "deletedFieldIds",
1977
- "type": "any",
1978
- "required": true,
1979
- "jsdoc": "List of field ids to were deleted."
1980
- },
1981
- {
1982
- "name": "errors",
1983
- "type": "any",
1984
- "required": true,
1985
- "jsdoc": "List of errors found."
1986
- }
1987
- ],
1988
- "docLink": "https://developer.quickbase.com/operation/deleteFields"
1989
- },
1990
- {
1991
- "name": "getField",
1992
- "summary": "Get field",
1993
- "method": "GET",
1994
- "path": "/fields/{fieldId}",
1995
- "parameters": [
1996
- {
1997
- "name": "tableId",
1998
- "type": "string",
1999
- "required": true,
2000
- "description": "The unique identifier (dbid) of the table.",
2001
- "properties": []
2002
- },
2003
- {
2004
- "name": "includeFieldPerms",
2005
- "type": "boolean",
2006
- "required": false,
2007
- "description": "Set to 'true' if you'd like to get back the custom permissions for the field(s).",
2008
- "properties": []
2009
- },
2010
- {
2011
- "name": "fieldId",
2012
- "type": "number",
2013
- "required": true,
2014
- "description": "The unique identifier (fid) of the field.",
2015
- "properties": []
2016
- }
2017
- ],
2018
- "returns": "GetField200Response",
2019
- "returnTypeDetails": [
2020
- {
2021
- "name": "id",
2022
- "type": "number",
2023
- "required": true,
2024
- "jsdoc": "The id of the field, unique to this table."
2025
- },
2026
- {
2027
- "name": "fieldType",
2028
- "type": "string",
2029
- "required": false,
2030
- "jsdoc": "The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html)."
2031
- },
2032
- {
2033
- "name": "mode",
2034
- "type": "string",
2035
- "required": false,
2036
- "jsdoc": "For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank."
2037
- },
2038
- {
2039
- "name": "label",
2040
- "type": "string",
2041
- "required": false,
2042
- "jsdoc": "The label (name) of the field."
2043
- },
2044
- {
2045
- "name": "noWrap",
2046
- "type": "boolean",
2047
- "required": false,
2048
- "jsdoc": "Indicates if the field is configured to not wrap when displayed in the product."
2049
- },
2050
- {
2051
- "name": "bold",
2052
- "type": "boolean",
2053
- "required": false,
2054
- "jsdoc": "Indicates if the field is configured to display in bold in the product."
2055
- },
2056
- {
2057
- "name": "required",
2058
- "type": "boolean",
2059
- "required": false,
2060
- "jsdoc": "Indicates if the field is marked required."
2061
- },
2062
- {
2063
- "name": "appearsByDefault",
2064
- "type": "boolean",
2065
- "required": false,
2066
- "jsdoc": "Indicates if the field is marked as a default in reports."
2067
- },
2068
- {
2069
- "name": "findEnabled",
2070
- "type": "boolean",
2071
- "required": false,
2072
- "jsdoc": "Indicates if the field is marked as searchable."
2073
- },
2074
- {
2075
- "name": "unique",
2076
- "type": "boolean",
2077
- "required": false,
2078
- "jsdoc": "Indicates if the field is marked unique."
2079
- },
2080
- {
2081
- "name": "doesDataCopy",
2082
- "type": "boolean",
2083
- "required": false,
2084
- "jsdoc": "Indicates if the field data will copy when a user copies the record."
2085
- },
2086
- {
2087
- "name": "fieldHelp",
2088
- "type": "string",
2089
- "required": false,
2090
- "jsdoc": "The configured help text shown to users within the product."
2091
- },
2092
- {
2093
- "name": "audited",
2094
- "type": "boolean",
2095
- "required": false,
2096
- "jsdoc": "Indicates if the field is being tracked as part of Quickbase Audit Logs."
2097
- },
2098
- {
2099
- "name": "properties",
2100
- "type": "{ [key: string]: any; }",
2101
- "required": false,
2102
- "jsdoc": "Additional properties for the field. Please see [Field type details](../fieldInfo) page for more details on the properties for each field type."
2103
- },
2104
- {
2105
- "name": "permissions",
2106
- "type": "Permission[]",
2107
- "required": false,
2108
- "jsdoc": "Field Permissions for different roles.",
2109
- "properties": [
2110
- {
2111
- "name": "role",
2112
- "type": "string",
2113
- "required": true,
2114
- "jsdoc": "The role name"
2115
- },
2116
- {
2117
- "name": "permissionType",
2118
- "type": "string",
2119
- "required": true,
2120
- "jsdoc": "Permission type (e.g., View, Modify)"
2121
- },
2122
- {
2123
- "name": "roleId",
2124
- "type": "number",
2125
- "required": true,
2126
- "jsdoc": "The role identifier"
2127
- }
2128
- ]
2129
- }
2130
- ],
2131
- "docLink": "https://developer.quickbase.com/operation/getField"
2132
- },
2133
- {
2134
- "name": "updateField",
2135
- "summary": "Update a field",
2136
- "method": "POST",
2137
- "path": "/fields/{fieldId}",
2138
- "parameters": [
2139
- {
2140
- "name": "tableId",
2141
- "type": "string",
2142
- "required": true,
2143
- "description": "The unique identifier of the table.",
2144
- "properties": []
2145
- },
2146
- {
2147
- "name": "fieldId",
2148
- "type": "number",
2149
- "required": true,
2150
- "description": "The unique identifier (fid) of the field.",
2151
- "properties": []
2152
- },
2153
- {
2154
- "name": "body",
2155
- "type": "UpdateFieldRequest",
2156
- "required": false,
2157
- "description": "",
2158
- "properties": [
2159
- {
2160
- "name": "label",
2161
- "type": "string",
2162
- "required": true,
2163
- "jsdoc": "The label of the field"
2164
- },
2165
- {
2166
- "name": "fieldType",
2167
- "type": "UpdateFieldRequestFieldTypeEnum",
2168
- "required": false,
2169
- "jsdoc": "The type of the field"
2170
- },
2171
- {
2172
- "name": "fieldHelp",
2173
- "type": "string",
2174
- "required": false,
2175
- "jsdoc": "Help text for the field"
2176
- },
2177
- {
2178
- "name": "addToForms",
2179
- "type": "boolean",
2180
- "required": false,
2181
- "jsdoc": "Whether to add the field to forms"
2182
- },
2183
- {
2184
- "name": "permissions",
2185
- "type": "object",
2186
- "required": false,
2187
- "jsdoc": "Custom permissions for the field"
2188
- },
2189
- {
2190
- "name": "required",
2191
- "type": "boolean",
2192
- "required": false,
2193
- "jsdoc": "Whether the field is required"
2194
- },
2195
- {
2196
- "name": "unique",
2197
- "type": "boolean",
2198
- "required": false,
2199
- "jsdoc": "Whether the field must have unique values"
2200
- },
2201
- {
2202
- "name": "noWrap",
2203
- "type": "boolean",
2204
- "required": false,
2205
- "jsdoc": "Whether text wrapping is disabled"
2206
- },
2207
- {
2208
- "name": "bold",
2209
- "type": "boolean",
2210
- "required": false,
2211
- "jsdoc": "Whether the field is bolded"
2212
- },
2213
- {
2214
- "name": "appearsByDefault",
2215
- "type": "boolean",
2216
- "required": false,
2217
- "jsdoc": "Whether the field appears by default in reports"
2218
- },
2219
- {
2220
- "name": "findEnabled",
2221
- "type": "boolean",
2222
- "required": false,
2223
- "jsdoc": "Whether the field is searchable"
2224
- },
2225
- {
2226
- "name": "doesDataCopy",
2227
- "type": "boolean",
2228
- "required": false,
2229
- "jsdoc": "Whether the field copies data"
2230
- },
2231
- {
2232
- "name": "audited",
2233
- "type": "boolean",
2234
- "required": false,
2235
- "jsdoc": "Whether changes to the field are audited"
2236
- },
2237
- {
2238
- "name": "properties",
2239
- "type": "CreateFieldRequestProperties",
2240
- "required": false,
2241
- "jsdoc": ""
2242
- }
2243
- ]
2244
- }
2245
- ],
2246
- "returns": "UpdateField200Response",
2247
- "returnTypeDetails": [
2248
- {
2249
- "name": "id",
2250
- "type": "number",
2251
- "required": true,
2252
- "jsdoc": "The id of the field, unique to this table."
2253
- },
2254
- {
2255
- "name": "fieldType",
2256
- "type": "string",
2257
- "required": false,
2258
- "jsdoc": "The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html)."
2259
- },
2260
- {
2261
- "name": "mode",
2262
- "type": "string",
2263
- "required": false,
2264
- "jsdoc": "For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank."
2265
- },
2266
- {
2267
- "name": "label",
2268
- "type": "string",
2269
- "required": false,
2270
- "jsdoc": "The label (name) of the field."
2271
- },
2272
- {
2273
- "name": "noWrap",
2274
- "type": "boolean",
2275
- "required": false,
2276
- "jsdoc": "Indicates if the field is configured to not wrap when displayed in the product."
2277
- },
2278
- {
2279
- "name": "bold",
2280
- "type": "boolean",
2281
- "required": false,
2282
- "jsdoc": "Indicates if the field is configured to display in bold in the product."
2283
- },
2284
- {
2285
- "name": "required",
2286
- "type": "boolean",
2287
- "required": false,
2288
- "jsdoc": "Indicates if the field is marked required."
2289
- },
2290
- {
2291
- "name": "appearsByDefault",
2292
- "type": "boolean",
2293
- "required": false,
2294
- "jsdoc": "Indicates if the field is marked as a default in reports."
2295
- },
2296
- {
2297
- "name": "findEnabled",
2298
- "type": "boolean",
2299
- "required": false,
2300
- "jsdoc": "Indicates if the field is marked as searchable."
2301
- },
2302
- {
2303
- "name": "unique",
2304
- "type": "boolean",
2305
- "required": false,
2306
- "jsdoc": "Indicates if the field is marked unique."
2307
- },
2308
- {
2309
- "name": "doesDataCopy",
2310
- "type": "boolean",
2311
- "required": false,
2312
- "jsdoc": "Indicates if the field data will copy when a user copies the record."
2313
- },
2314
- {
2315
- "name": "fieldHelp",
2316
- "type": "string",
2317
- "required": false,
2318
- "jsdoc": "The configured help text shown to users within the product."
2319
- },
2320
- {
2321
- "name": "audited",
2322
- "type": "boolean",
2323
- "required": false,
2324
- "jsdoc": "Indicates if the field is being tracked as part of Quickbase Audit Logs."
2325
- },
2326
- {
2327
- "name": "properties",
2328
- "type": "{ [key: string]: any; }",
2329
- "required": false,
2330
- "jsdoc": "Additional properties for the field. Please see [Field type details](../fieldInfo) page for more details on the properties for each field type."
2331
- },
2332
- {
2333
- "name": "permissions",
2334
- "type": "Permission[]",
2335
- "required": false,
2336
- "jsdoc": "Field Permissions for different roles.",
2337
- "properties": [
2338
- {
2339
- "name": "role",
2340
- "type": "string",
2341
- "required": true,
2342
- "jsdoc": "The role name"
2343
- },
2344
- {
2345
- "name": "permissionType",
2346
- "type": "string",
2347
- "required": true,
2348
- "jsdoc": "Permission type (e.g., View, Modify)"
2349
- },
2350
- {
2351
- "name": "roleId",
2352
- "type": "number",
2353
- "required": true,
2354
- "jsdoc": "The role identifier"
2355
- }
2356
- ]
2357
- }
2358
- ],
2359
- "docLink": "https://developer.quickbase.com/operation/updateField"
2360
- },
2361
- {
2362
- "name": "getFieldsUsage",
2363
- "summary": "Get usage for all fields",
2364
- "method": "GET",
2365
- "path": "/fields/usage",
2366
- "parameters": [
2367
- {
2368
- "name": "tableId",
2369
- "type": "string",
2370
- "required": true,
2371
- "description": "The unique identifier (dbid) of the table.",
2372
- "properties": []
2373
- },
2374
- {
2375
- "name": "skip",
2376
- "type": "number",
2377
- "required": false,
2378
- "description": "The number of fields to skip from the list.",
2379
- "properties": []
2380
- },
2381
- {
2382
- "name": "top",
2383
- "type": "number",
2384
- "required": false,
2385
- "description": "The maximum number of fields to return.",
2386
- "properties": []
2387
- }
2388
- ],
2389
- "returns": "GetFieldsUsage200Response",
2390
- "returnTypeDetails": [
2391
- {
2392
- "name": "field",
2393
- "type": "object",
2394
- "required": true,
2395
- "jsdoc": "Basic information about the field."
2396
- },
2397
- {
2398
- "name": "usage",
2399
- "type": "object",
2400
- "required": true,
2401
- "jsdoc": "Usage Information about the field."
2402
- }
2403
- ],
2404
- "docLink": "https://developer.quickbase.com/operation/getFieldsUsage"
2405
- },
2406
- {
2407
- "name": "getFieldUsage",
2408
- "summary": "Get usage for a field",
2409
- "method": "GET",
2410
- "path": "/fields/usage/{fieldId}",
2411
- "parameters": [
2412
- {
2413
- "name": "tableId",
2414
- "type": "string",
2415
- "required": true,
2416
- "description": "The unique identifier (dbid) of the table.",
2417
- "properties": []
2418
- },
2419
- {
2420
- "name": "fieldId",
2421
- "type": "number",
2422
- "required": true,
2423
- "description": "The unique identifier (fid) of the field.",
2424
- "properties": []
2425
- }
2426
- ],
2427
- "returns": "GetFieldUsage200Response",
2428
- "returnTypeDetails": [
2429
- {
2430
- "name": "field",
2431
- "type": "object",
2432
- "required": true,
2433
- "jsdoc": "Basic information about the field."
2434
- },
2435
- {
2436
- "name": "usage",
2437
- "type": "object",
2438
- "required": true,
2439
- "jsdoc": "Usage Information about the field."
2440
- }
2441
- ],
2442
- "docLink": "https://developer.quickbase.com/operation/getFieldUsage"
2443
- },
2444
- {
2445
- "name": "runFormula",
2446
- "summary": "Run a formula",
2447
- "method": "POST",
2448
- "path": "/formula/run",
2449
- "parameters": [
2450
- {
2451
- "name": "body",
2452
- "type": "{ formula?: string; rid?: number; from?: string }",
2453
- "required": false,
2454
- "description": "",
2455
- "properties": []
2456
- }
2457
- ],
2458
- "returns": "RunFormula200Response",
2459
- "returnTypeDetails": [
2460
- {
2461
- "name": "result",
2462
- "type": "string",
2463
- "required": false,
2464
- "jsdoc": "The formula execution result."
2465
- }
2466
- ],
2467
- "docLink": "https://developer.quickbase.com/operation/runFormula"
2468
- },
2469
- {
2470
- "name": "upsert",
2471
- "summary": "Insert/Update record(s)",
2472
- "method": "POST",
2473
- "path": "/records",
2474
- "parameters": [
2475
- {
2476
- "name": "body",
2477
- "type": "UpsertRequest",
2478
- "required": false,
2479
- "description": "",
2480
- "properties": [
2481
- {
2482
- "name": "data",
2483
- "type": "Record[]",
2484
- "required": false,
2485
- "jsdoc": ""
2486
- },
2487
- {
2488
- "name": "to",
2489
- "type": "string",
2490
- "required": false,
2491
- "jsdoc": ""
2492
- },
2493
- {
2494
- "name": "fieldsToReturn",
2495
- "type": "number[]",
2496
- "required": false,
2497
- "jsdoc": ""
2498
- }
2499
- ]
2500
- }
2501
- ],
2502
- "returns": "Upsert200Response | Upsert207Response",
2503
- "returnTypeDetails": [
2504
- {
2505
- "name": "metadata",
2506
- "type": "object",
2507
- "required": false,
2508
- "jsdoc": "Information about created records, updated records, referenced but unchanged records, and records having any errors while being processed."
2509
- },
2510
- {
2511
- "name": "data",
2512
- "type": "any",
2513
- "required": false,
2514
- "jsdoc": "The data that is expected to be returned."
2515
- },
2516
- {
2517
- "name": "metadata",
2518
- "type": "{ [key: string]: any; }",
2519
- "required": false,
2520
- "jsdoc": "Information about created records, updated records, referenced but unchanged records, and records having any errors while being processed."
2521
- },
2522
- {
2523
- "name": "data",
2524
- "type": "string[]",
2525
- "required": false,
2526
- "jsdoc": "The data that is expected to be returned."
2527
- }
2528
- ],
2529
- "docLink": "https://developer.quickbase.com/operation/upsert"
2530
- },
2531
- {
2532
- "name": "deleteRecords",
2533
- "summary": "Delete record(s)",
2534
- "method": "DELETE",
2535
- "path": "/records",
2536
- "parameters": [
2537
- {
2538
- "name": "body",
2539
- "type": "DeleteRecordsRequest",
2540
- "required": false,
2541
- "description": "",
2542
- "properties": [
2543
- {
2544
- "name": "from",
2545
- "type": "string",
2546
- "required": true,
2547
- "jsdoc": ""
2548
- },
2549
- {
2550
- "name": "where",
2551
- "type": "string",
2552
- "required": false,
2553
- "jsdoc": ""
2554
- }
2555
- ]
2556
- }
2557
- ],
2558
- "returns": "DeleteRecords200Response",
2559
- "returnTypeDetails": [
2560
- {
2561
- "name": "numberDeleted",
2562
- "type": "number",
2563
- "required": false,
2564
- "jsdoc": "The number of records deleted."
2565
- }
2566
- ],
2567
- "docLink": "https://developer.quickbase.com/operation/deleteRecords"
2568
- },
2569
- {
2570
- "name": "runQuery",
2571
- "summary": "Query for data",
2572
- "method": "POST",
2573
- "path": "/records/query",
2574
- "parameters": [
2575
- {
2576
- "name": "body",
2577
- "type": "RunQueryRequest",
2578
- "required": false,
2579
- "description": "",
2580
- "properties": [
2581
- {
2582
- "name": "from",
2583
- "type": "string",
2584
- "required": true,
2585
- "jsdoc": "The table identifier."
2586
- },
2587
- {
2588
- "name": "select",
2589
- "type": "number[]",
2590
- "required": false,
2591
- "jsdoc": "An array of field ids..."
2592
- },
2593
- {
2594
- "name": "where",
2595
- "type": "string",
2596
- "required": false,
2597
- "jsdoc": "The filter, using the Quickbase query language..."
2598
- },
2599
- {
2600
- "name": "sortBy",
2601
- "type": "RunQueryRequestSortByInner[]",
2602
- "required": false,
2603
- "jsdoc": "An array of field IDs and sort directions...",
2604
- "properties": [
2605
- {
2606
- "name": "fieldId",
2607
- "type": "number",
2608
- "required": true,
2609
- "jsdoc": ""
2610
- },
2611
- {
2612
- "name": "order",
2613
- "type": "RunQueryRequestSortByInnerOrderEnum",
2614
- "required": true,
2615
- "jsdoc": ""
2616
- }
2617
- ]
2618
- },
2619
- {
2620
- "name": "groupBy",
2621
- "type": "RunQueryRequestGroupByInner[]",
2622
- "required": false,
2623
- "jsdoc": "An array that contains the fields to group the records by.",
2624
- "properties": [
2625
- {
2626
- "name": "fieldId",
2627
- "type": "number",
2628
- "required": true,
2629
- "jsdoc": ""
2630
- },
2631
- {
2632
- "name": "grouping",
2633
- "type": "\"equal-values\"",
2634
- "required": true,
2635
- "jsdoc": ""
2636
- }
2637
- ]
2638
- },
2639
- {
2640
- "name": "options",
2641
- "type": "RunQueryRequestOptions",
2642
- "required": false,
2643
- "jsdoc": ""
2644
- }
2645
- ]
2646
- }
2647
- ],
2648
- "returns": "RunQuery200Response",
2649
- "returnTypeDetails": [
2650
- {
2651
- "name": "fields",
2652
- "type": "any",
2653
- "required": false,
2654
- "jsdoc": "An array of objects that contains limited meta-data of each field displayed in the report. This assists in building logic that depends on field types and IDs."
2655
- },
2656
- {
2657
- "name": "data",
2658
- "type": "any",
2659
- "required": false,
2660
- "jsdoc": "An array of objects that either represents the record data or summarized values, depending on the report type."
2661
- },
2662
- {
2663
- "name": "metadata",
2664
- "type": "object",
2665
- "required": false,
2666
- "jsdoc": "Additional information about the results that may be helpful. Pagination may be needed if either you specify a smaller number of results to skip than is available, or if the API automatically returns fewer results. numRecords can be compared to totalRecords to determine if further pagination is needed."
2667
- }
2668
- ],
2669
- "docLink": "https://developer.quickbase.com/operation/runQuery"
2670
- },
2671
- {
2672
- "name": "getTempTokenDBID",
2673
- "summary": "Get a temporary token for a dbid",
2674
- "method": "GET",
2675
- "path": "/auth/temporary/{dbid}",
2676
- "parameters": [
2677
- {
2678
- "name": "dbid",
2679
- "type": "string",
2680
- "required": true,
2681
- "description": "The unique identifier of an app or table.",
2682
- "properties": []
2683
- },
2684
- {
2685
- "name": "qBAppToken",
2686
- "type": "string",
2687
- "required": false,
2688
- "description": "Your Quickbase app token",
2689
- "properties": []
2690
- }
2691
- ],
2692
- "returns": "GetTempTokenDBID200Response",
2693
- "returnTypeDetails": [
2694
- {
2695
- "name": "temporaryAuthorization",
2696
- "type": "string",
2697
- "required": false,
2698
- "jsdoc": "Temporary authorization token."
2699
- }
2700
- ],
2701
- "docLink": "https://developer.quickbase.com/operation/getTempTokenDBID"
2702
- },
2703
- {
2704
- "name": "exchangeSsoToken",
2705
- "summary": "Exchange an SSO token",
2706
- "method": "POST",
2707
- "path": "/auth/oauth/token",
2708
- "parameters": [
2709
- {
2710
- "name": "body",
2711
- "type": "{ grant_type?: string; requested_token_type?: string; subject_token?: string; subject_token_type?: string }",
2712
- "required": false,
2713
- "description": "",
2714
- "properties": []
2715
- }
2716
- ],
2717
- "returns": "ExchangeSsoToken200Response",
2718
- "returnTypeDetails": [
2719
- {
2720
- "name": "access_token",
2721
- "type": "string",
2722
- "required": false,
2723
- "jsdoc": "The security token issued by the authorization server in response to the token exchange request. The identifier `access_token` is used for historical reasons and the issued token need not be an OAuth access token."
2724
- },
2725
- {
2726
- "name": "issued_token_type",
2727
- "type": "string",
2728
- "required": false,
2729
- "jsdoc": "An identifier for the representation of the issued security token."
2730
- },
2731
- {
2732
- "name": "token_type",
2733
- "type": "string",
2734
- "required": false,
2735
- "jsdoc": "Will always return `N_A`"
2736
- }
2737
- ],
2738
- "docLink": "https://developer.quickbase.com/operation/exchangeSsoToken"
2739
- },
2740
- {
2741
- "name": "cloneUserToken",
2742
- "summary": "Clone a user token",
2743
- "method": "POST",
2744
- "path": "/usertoken/clone",
2745
- "parameters": [
2746
- {
2747
- "name": "body",
2748
- "type": "{ name?: string; description?: string }",
2749
- "required": false,
2750
- "description": "",
2751
- "properties": []
2752
- }
2753
- ],
2754
- "returns": "CloneUserToken200Response",
2755
- "returnTypeDetails": [
2756
- {
2757
- "name": "active",
2758
- "type": "boolean",
2759
- "required": false,
2760
- "jsdoc": "Whether the user token is active."
2761
- },
2762
- {
2763
- "name": "apps",
2764
- "type": "any",
2765
- "required": false,
2766
- "jsdoc": "The list of apps this user token is assigned to."
2767
- },
2768
- {
2769
- "name": "lastUsed",
2770
- "type": "string",
2771
- "required": false,
2772
- "jsdoc": "The last date this user token was used, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
2773
- },
2774
- {
2775
- "name": "description",
2776
- "type": "string",
2777
- "required": false,
2778
- "jsdoc": "User Token description."
2779
- },
2780
- {
2781
- "name": "id",
2782
- "type": "number",
2783
- "required": false,
2784
- "jsdoc": "User Token id."
2785
- },
2786
- {
2787
- "name": "name",
2788
- "type": "string",
2789
- "required": false,
2790
- "jsdoc": "User Token name."
2791
- },
2792
- {
2793
- "name": "token",
2794
- "type": "string",
2795
- "required": false,
2796
- "jsdoc": "User Token value."
2797
- }
2798
- ],
2799
- "docLink": "https://developer.quickbase.com/operation/cloneUserToken"
2800
- },
2801
- {
2802
- "name": "transferUserToken",
2803
- "summary": "Transfer a user token",
2804
- "method": "POST",
2805
- "path": "/usertoken/transfer",
2806
- "parameters": [
2807
- {
2808
- "name": "body",
2809
- "type": "{ id?: number; from?: string; to?: string }",
2810
- "required": false,
2811
- "description": "",
2812
- "properties": []
2813
- }
2814
- ],
2815
- "returns": "TransferUserToken200Response",
2816
- "returnTypeDetails": [
2817
- {
2818
- "name": "active",
2819
- "type": "boolean",
2820
- "required": false,
2821
- "jsdoc": "Whether the user token is active."
2822
- },
2823
- {
2824
- "name": "apps",
2825
- "type": "any",
2826
- "required": false,
2827
- "jsdoc": "The list of apps this user token is assigned to."
2828
- },
2829
- {
2830
- "name": "lastUsed",
2831
- "type": "string",
2832
- "required": false,
2833
- "jsdoc": "The last date this user token was used, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone)."
2834
- },
2835
- {
2836
- "name": "description",
2837
- "type": "string",
2838
- "required": false,
2839
- "jsdoc": "User Token description."
2840
- },
2841
- {
2842
- "name": "id",
2843
- "type": "number",
2844
- "required": false,
2845
- "jsdoc": "User Token id."
2846
- },
2847
- {
2848
- "name": "name",
2849
- "type": "string",
2850
- "required": false,
2851
- "jsdoc": "User Token name."
2852
- }
2853
- ],
2854
- "docLink": "https://developer.quickbase.com/operation/transferUserToken"
2855
- },
2856
- {
2857
- "name": "deactivateUserToken",
2858
- "summary": "Deactivate a user token",
2859
- "method": "POST",
2860
- "path": "/usertoken/deactivate",
2861
- "parameters": [],
2862
- "returns": "DeactivateUserToken200Response",
2863
- "returnTypeDetails": [
2864
- {
2865
- "name": "id",
2866
- "type": "number",
2867
- "required": false,
2868
- "jsdoc": "The user token id."
2869
- }
2870
- ],
2871
- "docLink": "https://developer.quickbase.com/operation/deactivateUserToken"
2872
- },
2873
- {
2874
- "name": "deleteUserToken",
2875
- "summary": "Delete a user token",
2876
- "method": "DELETE",
2877
- "path": "/usertoken",
2878
- "parameters": [],
2879
- "returns": "DeleteUserToken200Response",
2880
- "returnTypeDetails": [
2881
- {
2882
- "name": "id",
2883
- "type": "number",
2884
- "required": false,
2885
- "jsdoc": "The user token id."
2886
- }
2887
- ],
2888
- "docLink": "https://developer.quickbase.com/operation/deleteUserToken"
2889
- },
2890
- {
2891
- "name": "downloadFile",
2892
- "summary": "Download file",
2893
- "method": "GET",
2894
- "path": "/files/{tableId}/{recordId}/{fieldId}/{versionNumber}",
2895
- "parameters": [
2896
- {
2897
- "name": "tableId",
2898
- "type": "string",
2899
- "required": true,
2900
- "description": "The unique identifier of the table.",
2901
- "properties": []
2902
- },
2903
- {
2904
- "name": "recordId",
2905
- "type": "number",
2906
- "required": true,
2907
- "description": "The unique identifier of the record.",
2908
- "properties": []
2909
- },
2910
- {
2911
- "name": "fieldId",
2912
- "type": "number",
2913
- "required": true,
2914
- "description": "The unique identifier of the field.",
2915
- "properties": []
2916
- },
2917
- {
2918
- "name": "versionNumber",
2919
- "type": "number",
2920
- "required": true,
2921
- "description": "The file attachment version number.",
2922
- "properties": []
2923
- }
2924
- ],
2925
- "returns": "DownloadFile200Response",
2926
- "returnTypeDetails": [
2927
- {
2928
- "name": "data",
2929
- "type": "string",
2930
- "required": false,
2931
- "jsdoc": ""
2932
- }
2933
- ],
2934
- "docLink": "https://developer.quickbase.com/operation/downloadFile"
2935
- },
2936
- {
2937
- "name": "deleteFile",
2938
- "summary": "Delete file",
2939
- "method": "DELETE",
2940
- "path": "/files/{tableId}/{recordId}/{fieldId}/{versionNumber}",
2941
- "parameters": [
2942
- {
2943
- "name": "tableId",
2944
- "type": "string",
2945
- "required": true,
2946
- "description": "The unique identifier of the table.",
2947
- "properties": []
2948
- },
2949
- {
2950
- "name": "recordId",
2951
- "type": "number",
2952
- "required": true,
2953
- "description": "The unique identifier of the record.",
2954
- "properties": []
2955
- },
2956
- {
2957
- "name": "fieldId",
2958
- "type": "number",
2959
- "required": true,
2960
- "description": "The unique identifier of the field.",
2961
- "properties": []
2962
- },
2963
- {
2964
- "name": "versionNumber",
2965
- "type": "number",
2966
- "required": true,
2967
- "description": "The file attachment version number.",
2968
- "properties": []
2969
- }
2970
- ],
2971
- "returns": "DeleteFile200Response",
2972
- "returnTypeDetails": [
2973
- {
2974
- "name": "versionNumber",
2975
- "type": "number",
2976
- "required": false,
2977
- "jsdoc": "The number of deleted version."
2978
- },
2979
- {
2980
- "name": "fileName",
2981
- "type": "string",
2982
- "required": false,
2983
- "jsdoc": "The name of file associated with deleted version."
2984
- },
2985
- {
2986
- "name": "uploaded",
2987
- "type": "string",
2988
- "required": false,
2989
- "jsdoc": "The timestamp when the version was originally uploaded."
2990
- },
2991
- {
2992
- "name": "creator",
2993
- "type": "object",
2994
- "required": false,
2995
- "jsdoc": "The user that uploaded version."
2996
- }
2997
- ],
2998
- "docLink": "https://developer.quickbase.com/operation/deleteFile"
2999
- },
3000
- {
3001
- "name": "getUsers",
3002
- "summary": "Get users",
3003
- "method": "POST",
3004
- "path": "/users",
3005
- "parameters": [
3006
- {
3007
- "name": "accountId",
3008
- "type": "number",
3009
- "required": false,
3010
- "description": "The account id being used to get users. If no value is specified, the first account associated with the requesting user token is chosen.",
3011
- "properties": []
3012
- },
3013
- {
3014
- "name": "body",
3015
- "type": "GetUsersRequest",
3016
- "required": false,
3017
- "description": "",
3018
- "properties": [
3019
- {
3020
- "name": "userIds",
3021
- "type": "string[]",
3022
- "required": true,
3023
- "jsdoc": ""
3024
- }
3025
- ]
3026
- }
3027
- ],
3028
- "returns": "GetUsers200Response",
3029
- "returnTypeDetails": [
3030
- {
3031
- "name": "users",
3032
- "type": "any",
3033
- "required": true,
3034
- "jsdoc": "A list of users found in an account with the given criterias"
3035
- },
3036
- {
3037
- "name": "metadata",
3038
- "type": "object",
3039
- "required": true,
3040
- "jsdoc": "Additional request information"
3041
- }
3042
- ],
3043
- "docLink": "https://developer.quickbase.com/operation/getUsers"
3044
- },
3045
- {
3046
- "name": "denyUsers",
3047
- "summary": "Deny users",
3048
- "method": "PUT",
3049
- "path": "/users/deny",
3050
- "parameters": [
3051
- {
3052
- "name": "accountId",
3053
- "type": "number",
3054
- "required": false,
3055
- "description": "The account id being used to deny users. If no value is specified, the first account associated with the requesting user token is chosen.",
3056
- "properties": []
3057
- },
3058
- {
3059
- "name": "body",
3060
- "type": "DenyUsersRequest",
3061
- "required": false,
3062
- "description": "",
3063
- "properties": [
3064
- {
3065
- "name": "userIds",
3066
- "type": "string[]",
3067
- "required": true,
3068
- "jsdoc": ""
3069
- }
3070
- ]
3071
- }
3072
- ],
3073
- "returns": "DenyUsers200Response",
3074
- "returnTypeDetails": [
3075
- {
3076
- "name": "failure",
3077
- "type": "any",
3078
- "required": true,
3079
- "jsdoc": "A list of users that couldn't be denied. This also includes the ID's of users that are not valid."
3080
- },
3081
- {
3082
- "name": "success",
3083
- "type": "any",
3084
- "required": true,
3085
- "jsdoc": "A list of users that have successfully been denied."
3086
- }
3087
- ],
3088
- "docLink": "https://developer.quickbase.com/operation/denyUsers"
3089
- },
3090
- {
3091
- "name": "denyUsersAndGroups",
3092
- "summary": "Deny and remove users from groups",
3093
- "method": "PUT",
3094
- "path": "/users/deny/{shouldDeleteFromGroups}",
3095
- "parameters": [
3096
- {
3097
- "name": "accountId",
3098
- "type": "number",
3099
- "required": false,
3100
- "description": "The account id being used to deny users. If no value is specified, the first account associated with the requesting user token is chosen.",
3101
- "properties": []
3102
- },
3103
- {
3104
- "name": "shouldDeleteFromGroups",
3105
- "type": "boolean",
3106
- "required": true,
3107
- "description": "Specifies if the users should also be removed from all groups.",
3108
- "properties": []
3109
- },
3110
- {
3111
- "name": "body",
3112
- "type": "DenyUsersAndGroupsRequest",
3113
- "required": false,
3114
- "description": "",
3115
- "properties": [
3116
- {
3117
- "name": "userIds",
3118
- "type": "string[]",
3119
- "required": true,
3120
- "jsdoc": ""
3121
- }
3122
- ]
3123
- }
3124
- ],
3125
- "returns": "DenyUsersAndGroups200Response",
3126
- "returnTypeDetails": [
3127
- {
3128
- "name": "failure",
3129
- "type": "any",
3130
- "required": true,
3131
- "jsdoc": "A list of users that couldn't be denied. This also includes the ID's of users that are not valid."
3132
- },
3133
- {
3134
- "name": "success",
3135
- "type": "any",
3136
- "required": true,
3137
- "jsdoc": "A list of users that have successfully been denied."
3138
- }
3139
- ],
3140
- "docLink": "https://developer.quickbase.com/operation/denyUsersAndGroups"
3141
- },
3142
- {
3143
- "name": "undenyUsers",
3144
- "summary": "Undeny users",
3145
- "method": "PUT",
3146
- "path": "/users/undeny",
3147
- "parameters": [
3148
- {
3149
- "name": "accountId",
3150
- "type": "number",
3151
- "required": false,
3152
- "description": "The account id being used to undeny users. If no value is specified, the first account associated with the requesting user token is chosen.",
3153
- "properties": []
3154
- },
3155
- {
3156
- "name": "body",
3157
- "type": "UndenyUsersRequest",
3158
- "required": false,
3159
- "description": "",
3160
- "properties": [
3161
- {
3162
- "name": "userIds",
3163
- "type": "string[]",
3164
- "required": true,
3165
- "jsdoc": ""
3166
- }
3167
- ]
3168
- }
3169
- ],
3170
- "returns": "UndenyUsers200Response",
3171
- "returnTypeDetails": [
3172
- {
3173
- "name": "failure",
3174
- "type": "any",
3175
- "required": true,
3176
- "jsdoc": "A list of users that couldn't be undenied. This also includes the ID's of users that are not valid."
3177
- },
3178
- {
3179
- "name": "success",
3180
- "type": "any",
3181
- "required": true,
3182
- "jsdoc": "A list of users that have successfully been undenied."
3183
- }
3184
- ],
3185
- "docLink": "https://developer.quickbase.com/operation/undenyUsers"
3186
- },
3187
- {
3188
- "name": "addMembersToGroup",
3189
- "summary": "Add members",
3190
- "method": "POST",
3191
- "path": "/groups/{gid}/members",
3192
- "parameters": [
3193
- {
3194
- "name": "gid",
3195
- "type": "number",
3196
- "required": true,
3197
- "description": "This is the ID of the group being modified.",
3198
- "properties": []
3199
- },
3200
- {
3201
- "name": "body",
3202
- "type": "AddMembersToGroupRequest",
3203
- "required": false,
3204
- "description": "",
3205
- "properties": [
3206
- {
3207
- "name": "userIds",
3208
- "type": "string[]",
3209
- "required": true,
3210
- "jsdoc": ""
3211
- }
3212
- ]
3213
- }
3214
- ],
3215
- "returns": "AddMembersToGroup200Response",
3216
- "returnTypeDetails": [
3217
- {
3218
- "name": "failure",
3219
- "type": "any",
3220
- "required": true,
3221
- "jsdoc": "A list of users that couldn’t be added to the group. This includes a list of IDs that represent invalid users and users who have already been added to the group."
3222
- },
3223
- {
3224
- "name": "success",
3225
- "type": "any",
3226
- "required": true,
3227
- "jsdoc": "A list of users that have been added to the group successfully."
3228
- }
3229
- ],
3230
- "docLink": "https://developer.quickbase.com/operation/addMembersToGroup"
3231
- },
3232
- {
3233
- "name": "removeMembersFromGroup",
3234
- "summary": "Remove members",
3235
- "method": "DELETE",
3236
- "path": "/groups/{gid}/members",
3237
- "parameters": [
3238
- {
3239
- "name": "gid",
3240
- "type": "number",
3241
- "required": true,
3242
- "description": "This is the ID of the group being modified.",
3243
- "properties": []
3244
- },
3245
- {
3246
- "name": "body",
3247
- "type": "RemoveMembersFromGroupRequest",
3248
- "required": false,
3249
- "description": "",
3250
- "properties": [
3251
- {
3252
- "name": "userIds",
3253
- "type": "string[]",
3254
- "required": true,
3255
- "jsdoc": ""
3256
- }
3257
- ]
3258
- }
3259
- ],
3260
- "returns": "RemoveMembersFromGroup200Response",
3261
- "returnTypeDetails": [
3262
- {
3263
- "name": "failure",
3264
- "type": "any",
3265
- "required": true,
3266
- "jsdoc": "A list of users that couldn’t be removed from the group. This includes a list of IDs that represent invalid users."
3267
- },
3268
- {
3269
- "name": "success",
3270
- "type": "any",
3271
- "required": true,
3272
- "jsdoc": "A list of users that have been removed from the group successfully."
3273
- }
3274
- ],
3275
- "docLink": "https://developer.quickbase.com/operation/removeMembersFromGroup"
3276
- },
3277
- {
3278
- "name": "addManagersToGroup",
3279
- "summary": "Add managers",
3280
- "method": "POST",
3281
- "path": "/groups/{gid}/managers",
3282
- "parameters": [
3283
- {
3284
- "name": "gid",
3285
- "type": "number",
3286
- "required": true,
3287
- "description": "This is the ID of the group being modified.",
3288
- "properties": []
3289
- },
3290
- {
3291
- "name": "body",
3292
- "type": "AddManagersToGroupRequest",
3293
- "required": false,
3294
- "description": "",
3295
- "properties": [
3296
- {
3297
- "name": "userIds",
3298
- "type": "string[]",
3299
- "required": true,
3300
- "jsdoc": ""
3301
- }
3302
- ]
3303
- }
3304
- ],
3305
- "returns": "AddManagersToGroup200Response",
3306
- "returnTypeDetails": [
3307
- {
3308
- "name": "failure",
3309
- "type": "any",
3310
- "required": true,
3311
- "jsdoc": "A list of users that couldn’t be added to the group. This includes a list of IDs that represent invalid users and users who have already been added to the group."
3312
- },
3313
- {
3314
- "name": "success",
3315
- "type": "any",
3316
- "required": true,
3317
- "jsdoc": "A list of users that have been added to the group successfully."
3318
- }
3319
- ],
3320
- "docLink": "https://developer.quickbase.com/operation/addManagersToGroup"
3321
- },
3322
- {
3323
- "name": "removeManagersFromGroup",
3324
- "summary": "Remove managers",
3325
- "method": "DELETE",
3326
- "path": "/groups/{gid}/managers",
3327
- "parameters": [
3328
- {
3329
- "name": "gid",
3330
- "type": "number",
3331
- "required": true,
3332
- "description": "This is the ID of the group being modified.",
3333
- "properties": []
3334
- },
3335
- {
3336
- "name": "body",
3337
- "type": "RemoveManagersFromGroupRequest",
3338
- "required": false,
3339
- "description": "",
3340
- "properties": [
3341
- {
3342
- "name": "userIds",
3343
- "type": "string[]",
3344
- "required": true,
3345
- "jsdoc": ""
3346
- }
3347
- ]
3348
- }
3349
- ],
3350
- "returns": "RemoveManagersFromGroup200Response",
3351
- "returnTypeDetails": [
3352
- {
3353
- "name": "failure",
3354
- "type": "any",
3355
- "required": true,
3356
- "jsdoc": "A list of users that couldn’t be removed from the group. This includes a list of IDs that represent invalid users."
3357
- },
3358
- {
3359
- "name": "success",
3360
- "type": "any",
3361
- "required": true,
3362
- "jsdoc": "A list of users that have been removed from the group successfully."
3363
- }
3364
- ],
3365
- "docLink": "https://developer.quickbase.com/operation/removeManagersFromGroup"
3366
- },
3367
- {
3368
- "name": "addSubgroupsToGroup",
3369
- "summary": "Add child groups",
3370
- "method": "POST",
3371
- "path": "/groups/{gid}/subgroups",
3372
- "parameters": [
3373
- {
3374
- "name": "gid",
3375
- "type": "number",
3376
- "required": true,
3377
- "description": "This is the ID of the group being modified.",
3378
- "properties": []
3379
- },
3380
- {
3381
- "name": "body",
3382
- "type": "AddSubgroupsToGroupRequest",
3383
- "required": false,
3384
- "description": "",
3385
- "properties": [
3386
- {
3387
- "name": "userIds",
3388
- "type": "string[]",
3389
- "required": true,
3390
- "jsdoc": ""
3391
- }
3392
- ]
3393
- }
3394
- ],
3395
- "returns": "AddSubgroupsToGroup200Response",
3396
- "returnTypeDetails": [
3397
- {
3398
- "name": "failure",
3399
- "type": "any",
3400
- "required": true,
3401
- "jsdoc": "A list of child groups that couldn’t be added to the group. This includes a list of IDs that represent invalid groups and groups that have already been added to the group."
3402
- },
3403
- {
3404
- "name": "success",
3405
- "type": "any",
3406
- "required": true,
3407
- "jsdoc": "A list of child groups that have been added to the group successfully."
3408
- }
3409
- ],
3410
- "docLink": "https://developer.quickbase.com/operation/addSubgroupsToGroup"
3411
- },
3412
- {
3413
- "name": "removeSubgroupsFromGroup",
3414
- "summary": "Remove child groups",
3415
- "method": "DELETE",
3416
- "path": "/groups/{gid}/subgroups",
3417
- "parameters": [
3418
- {
3419
- "name": "gid",
3420
- "type": "number",
3421
- "required": true,
3422
- "description": "This is the ID of the group being modified.",
3423
- "properties": []
3424
- },
3425
- {
3426
- "name": "body",
3427
- "type": "RemoveSubgroupsFromGroupRequest",
3428
- "required": false,
3429
- "description": "",
3430
- "properties": [
3431
- {
3432
- "name": "userIds",
3433
- "type": "string[]",
3434
- "required": true,
3435
- "jsdoc": ""
3436
- }
3437
- ]
3438
- }
3439
- ],
3440
- "returns": "RemoveSubgroupsFromGroup200Response",
3441
- "returnTypeDetails": [
3442
- {
3443
- "name": "failure",
3444
- "type": "any",
3445
- "required": true,
3446
- "jsdoc": "A list of child groups that couldn’t be removed from the group. This includes a list of IDs that represent invalid groups."
3447
- },
3448
- {
3449
- "name": "success",
3450
- "type": "any",
3451
- "required": true,
3452
- "jsdoc": "A list of child groups that have been removed from the group successfully."
3453
- }
3454
- ],
3455
- "docLink": "https://developer.quickbase.com/operation/removeSubgroupsFromGroup"
3456
- },
3457
- {
3458
- "name": "audit",
3459
- "summary": "Get audit logs",
3460
- "method": "POST",
3461
- "path": "/audit",
3462
- "parameters": [
3463
- {
3464
- "name": "body",
3465
- "type": "{ nextToken?: string; numRows?: number; queryId?: string; date?: string; topics?: string[] }",
3466
- "required": false,
3467
- "description": "",
3468
- "properties": []
3469
- }
3470
- ],
3471
- "returns": "Audit200Response",
3472
- "returnTypeDetails": [
3473
- {
3474
- "name": "queryId",
3475
- "type": "string",
3476
- "required": true,
3477
- "jsdoc": "Query id of the requested audit log."
3478
- },
3479
- {
3480
- "name": "events",
3481
- "type": "any",
3482
- "required": false,
3483
- "jsdoc": "All events of the audit log."
3484
- },
3485
- {
3486
- "name": "nextToken",
3487
- "type": "string",
3488
- "required": false,
3489
- "jsdoc": "Token to fetch the next 1000 logs."
3490
- }
3491
- ],
3492
- "docLink": "https://developer.quickbase.com/operation/audit"
3493
- },
3494
- {
3495
- "name": "platformAnalyticReads",
3496
- "summary": "Get read summaries",
3497
- "method": "GET",
3498
- "path": "/analytics/reads",
3499
- "parameters": [
3500
- {
3501
- "name": "day",
3502
- "type": "string",
3503
- "required": false,
3504
- "description": "The date for which read summaries need to be fetched. This must be date-time only, as YYYY-MM-DD, and a valid date in the past.",
3505
- "properties": []
3506
- }
3507
- ],
3508
- "returns": "PlatformAnalyticReads200Response",
3509
- "returnTypeDetails": [
3510
- {
3511
- "name": "date",
3512
- "type": "string",
3513
- "required": true,
3514
- "jsdoc": "The date of the requested summary."
3515
- },
3516
- {
3517
- "name": "reads",
3518
- "type": "object",
3519
- "required": true,
3520
- "jsdoc": "Total reads for the specified date."
3521
- }
3522
- ],
3523
- "docLink": "https://developer.quickbase.com/operation/platformAnalyticReads"
3524
- },
3525
- {
3526
- "name": "platformAnalyticEventSummaries",
3527
- "summary": "Get event summaries",
3528
- "method": "POST",
3529
- "path": "/analytics/events/summaries",
3530
- "parameters": [
3531
- {
3532
- "name": "accountId",
3533
- "type": "number",
3534
- "required": false,
3535
- "description": "The ID of the account to query. If no value is specified, the first account matching the provided domain is chosen.",
3536
- "properties": []
3537
- },
3538
- {
3539
- "name": "body",
3540
- "type": "{ start?: string; end?: string; groupBy?: string; nextToken?: string; where?: { id?: string; type?: string }[] }",
3541
- "required": false,
3542
- "description": "",
3543
- "properties": []
3544
- }
3545
- ],
3546
- "returns": "PlatformAnalyticEventSummaries200Response",
3547
- "returnTypeDetails": [
3548
- {
3549
- "name": "accountId",
3550
- "type": "string",
3551
- "required": true,
3552
- "jsdoc": "The ID of the account the events are associated with."
3553
- },
3554
- {
3555
- "name": "start",
3556
- "type": "string",
3557
- "required": true,
3558
- "jsdoc": "The start date and time of the requested summaries in ISO 8601 time format."
3559
- },
3560
- {
3561
- "name": "end",
3562
- "type": "string",
3563
- "required": true,
3564
- "jsdoc": "The end date and time of the requested summaries in ISO 8601 time format."
3565
- },
3566
- {
3567
- "name": "groupBy",
3568
- "type": "string",
3569
- "required": true,
3570
- "jsdoc": "How the events should be grouped."
3571
- },
3572
- {
3573
- "name": "where",
3574
- "type": "any",
3575
- "required": true,
3576
- "jsdoc": ""
3577
- },
3578
- {
3579
- "name": "results",
3580
- "type": "any",
3581
- "required": true,
3582
- "jsdoc": "An array of objects that contains Application/User information and an events object with summaries by event type."
3583
- },
3584
- {
3585
- "name": "metadata",
3586
- "type": "object",
3587
- "required": false,
3588
- "jsdoc": "Additional information about the results that may be helpful."
3589
- },
3590
- {
3591
- "name": "totals",
3592
- "type": "object",
3593
- "required": false,
3594
- "jsdoc": "Totals by billing category for all queried events."
3595
- }
3596
- ],
3597
- "docLink": "https://developer.quickbase.com/operation/platformAnalyticEventSummaries"
3598
- },
3599
- {
3600
- "name": "exportSolution",
3601
- "summary": "Export a solution",
3602
- "method": "GET",
3603
- "path": "/solutions/{solutionId}",
3604
- "parameters": [
3605
- {
3606
- "name": "solutionId",
3607
- "type": "string",
3608
- "required": true,
3609
- "description": "The unique identifier of a solution",
3610
- "properties": []
3611
- },
3612
- {
3613
- "name": "qBLVersion",
3614
- "type": "string",
3615
- "required": false,
3616
- "description": "The QBL version to be used for the export. If not specified the default would be used.",
3617
- "properties": []
3618
- }
3619
- ],
3620
- "returns": "ExportSolution200Response",
3621
- "returnTypeDetails": [
3622
- {
3623
- "name": "content",
3624
- "type": "string",
3625
- "required": false,
3626
- "jsdoc": ""
3627
- }
3628
- ],
3629
- "docLink": "https://developer.quickbase.com/operation/exportSolution"
3630
- },
3631
- {
3632
- "name": "updateSolution",
3633
- "summary": "Update a solution",
3634
- "method": "PUT",
3635
- "path": "/solutions/{solutionId}",
3636
- "parameters": [
3637
- {
3638
- "name": "solutionId",
3639
- "type": "string",
3640
- "required": true,
3641
- "description": "The unique identifier of a solution",
3642
- "properties": []
3643
- },
3644
- {
3645
- "name": "body",
3646
- "type": "any",
3647
- "required": false,
3648
- "description": "The QBL to be used for the update.",
3649
- "properties": []
3650
- },
3651
- {
3652
- "name": "xQBLErrorsAsSuccess",
3653
- "type": "boolean",
3654
- "required": false,
3655
- "description": "If this header is set to true, the API will return a 207 status code even if there are errors. The errors will be returned in the response body.",
3656
- "properties": []
3657
- }
3658
- ],
3659
- "returns": "UpdateSolution200Response",
3660
- "returnTypeDetails": [
3661
- {
3662
- "name": "solutionId",
3663
- "type": "string",
3664
- "required": false,
3665
- "jsdoc": ""
3666
- },
3667
- {
3668
- "name": "alias",
3669
- "type": "object",
3670
- "required": false,
3671
- "jsdoc": ""
3672
- },
3673
- {
3674
- "name": "createdResources",
3675
- "type": "any",
3676
- "required": false,
3677
- "jsdoc": ""
3678
- },
3679
- {
3680
- "name": "warnings",
3681
- "type": "any",
3682
- "required": false,
3683
- "jsdoc": ""
3684
- }
3685
- ],
3686
- "docLink": "https://developer.quickbase.com/operation/updateSolution"
3687
- },
3688
- {
3689
- "name": "createSolution",
3690
- "summary": "Create a solution",
3691
- "method": "POST",
3692
- "path": "/solutions",
3693
- "parameters": [
3694
- {
3695
- "name": "body",
3696
- "type": "any",
3697
- "required": false,
3698
- "description": "The QBL to be used for the create.",
3699
- "properties": []
3700
- },
3701
- {
3702
- "name": "xQBLErrorsAsSuccess",
3703
- "type": "boolean",
3704
- "required": false,
3705
- "description": "If this header is set to true, the API will return a 207 status code even if there are errors. The errors will be returned in the response body.",
3706
- "properties": []
3707
- }
3708
- ],
3709
- "returns": "CreateSolution200Response",
3710
- "returnTypeDetails": [
3711
- {
3712
- "name": "solutionId",
3713
- "type": "string",
3714
- "required": false,
3715
- "jsdoc": ""
3716
- },
3717
- {
3718
- "name": "alias",
3719
- "type": "object",
3720
- "required": false,
3721
- "jsdoc": ""
3722
- },
3723
- {
3724
- "name": "createdResources",
3725
- "type": "any",
3726
- "required": false,
3727
- "jsdoc": ""
3728
- },
3729
- {
3730
- "name": "warnings",
3731
- "type": "any",
3732
- "required": false,
3733
- "jsdoc": ""
3734
- }
3735
- ],
3736
- "docLink": "https://developer.quickbase.com/operation/createSolution"
3737
- },
3738
- {
3739
- "name": "exportSolutionToRecord",
3740
- "summary": "Export solution to record",
3741
- "method": "GET",
3742
- "path": "/solutions/{solutionId}/torecord",
3743
- "parameters": [
3744
- {
3745
- "name": "solutionId",
3746
- "type": "string",
3747
- "required": true,
3748
- "description": "The unique identifier of the solution.",
3749
- "properties": []
3750
- },
3751
- {
3752
- "name": "tableId",
3753
- "type": "string",
3754
- "required": true,
3755
- "description": "The unique identifier (dbid) of the table.",
3756
- "properties": []
3757
- },
3758
- {
3759
- "name": "fieldId",
3760
- "type": "number",
3761
- "required": true,
3762
- "description": "The unique identifier (fid) of the field. It needs to be a file attachment field.",
3763
- "properties": []
3764
- },
3765
- {
3766
- "name": "xQBLErrorsAsSuccess",
3767
- "type": "boolean",
3768
- "required": false,
3769
- "description": "If this header is set to true, the API will return a 207 status code even if there are errors. The errors will be returned in the response body.",
3770
- "properties": []
3771
- },
3772
- {
3773
- "name": "qBLVersion",
3774
- "type": "string",
3775
- "required": false,
3776
- "description": "The QBL version to be used for the export. If not specified the default would be used.",
3777
- "properties": []
3778
- }
3779
- ],
3780
- "returns": "ExportSolutionToRecord200Response",
3781
- "returnTypeDetails": [
3782
- {
3783
- "name": "record_id",
3784
- "type": "number",
3785
- "required": false,
3786
- "jsdoc": ""
3787
- },
3788
- {
3789
- "name": "filename",
3790
- "type": "string",
3791
- "required": false,
3792
- "jsdoc": ""
3793
- }
3794
- ],
3795
- "docLink": "https://developer.quickbase.com/operation/exportSolutionToRecord"
3796
- },
3797
- {
3798
- "name": "createSolutionFromRecord",
3799
- "summary": "Create solution from record",
3800
- "method": "GET",
3801
- "path": "/solutions/fromrecord",
3802
- "parameters": [
3803
- {
3804
- "name": "tableId",
3805
- "type": "string",
3806
- "required": true,
3807
- "description": "The unique identifier (dbid) of the table.",
3808
- "properties": []
3809
- },
3810
- {
3811
- "name": "fieldId",
3812
- "type": "number",
3813
- "required": true,
3814
- "description": "The unique identifier (fid) of the field. It needs to be a file attachment field.",
3815
- "properties": []
3816
- },
3817
- {
3818
- "name": "recordId",
3819
- "type": "number",
3820
- "required": true,
3821
- "description": "The unique identifier of the record.",
3822
- "properties": []
3823
- },
3824
- {
3825
- "name": "xQBLErrorsAsSuccess",
3826
- "type": "boolean",
3827
- "required": false,
3828
- "description": "If this header is set to true, the API will return a 207 status code even if there are errors. The errors will be returned in the response body.",
3829
- "properties": []
3830
- }
3831
- ],
3832
- "returns": "CreateSolutionFromRecord200Response",
3833
- "returnTypeDetails": [
3834
- {
3835
- "name": "solutionId",
3836
- "type": "string",
3837
- "required": false,
3838
- "jsdoc": ""
3839
- },
3840
- {
3841
- "name": "alias",
3842
- "type": "object",
3843
- "required": false,
3844
- "jsdoc": ""
3845
- },
3846
- {
3847
- "name": "createdResources",
3848
- "type": "any",
3849
- "required": false,
3850
- "jsdoc": ""
3851
- },
3852
- {
3853
- "name": "warnings",
3854
- "type": "any",
3855
- "required": false,
3856
- "jsdoc": ""
3857
- }
3858
- ],
3859
- "docLink": "https://developer.quickbase.com/operation/createSolutionFromRecord"
3860
- },
3861
- {
3862
- "name": "updateSolutionToRecord",
3863
- "summary": "Update solution from record",
3864
- "method": "GET",
3865
- "path": "/solutions/{solutionId}/fromrecord",
3866
- "parameters": [
3867
- {
3868
- "name": "solutionId",
3869
- "type": "string",
3870
- "required": true,
3871
- "description": "The unique identifier of the solution.",
3872
- "properties": []
3873
- },
3874
- {
3875
- "name": "tableId",
3876
- "type": "string",
3877
- "required": true,
3878
- "description": "The unique identifier (dbid) of the table.",
3879
- "properties": []
3880
- },
3881
- {
3882
- "name": "fieldId",
3883
- "type": "number",
3884
- "required": true,
3885
- "description": "The unique identifier (fid) of the field. It needs to be a file attachment field.",
3886
- "properties": []
3887
- },
3888
- {
3889
- "name": "recordId",
3890
- "type": "number",
3891
- "required": true,
3892
- "description": "The unique identifier of the record.",
3893
- "properties": []
3894
- },
3895
- {
3896
- "name": "xQBLErrorsAsSuccess",
3897
- "type": "boolean",
3898
- "required": false,
3899
- "description": "If this header is set to true, the API will return a 207 status code even if there are errors. The errors will be returned in the response body.",
3900
- "properties": []
3901
- }
3902
- ],
3903
- "returns": "UpdateSolutionToRecord200Response",
3904
- "returnTypeDetails": [
3905
- {
3906
- "name": "solutionId",
3907
- "type": "string",
3908
- "required": false,
3909
- "jsdoc": ""
3910
- },
3911
- {
3912
- "name": "alias",
3913
- "type": "object",
3914
- "required": false,
3915
- "jsdoc": ""
3916
- },
3917
- {
3918
- "name": "resources",
3919
- "type": "any",
3920
- "required": false,
3921
- "jsdoc": ""
3922
- },
3923
- {
3924
- "name": "warnings",
3925
- "type": "any",
3926
- "required": false,
3927
- "jsdoc": ""
3928
- }
3929
- ],
3930
- "docLink": "https://developer.quickbase.com/operation/updateSolutionToRecord"
3931
- },
3932
- {
3933
- "name": "changesetSolution",
3934
- "summary": "List solution changes",
3935
- "method": "PUT",
3936
- "path": "/solutions/{solutionId}/changeset",
3937
- "parameters": [
3938
- {
3939
- "name": "solutionId",
3940
- "type": "string",
3941
- "required": true,
3942
- "description": "The unique identifier of the solution.",
3943
- "properties": []
3944
- },
3945
- {
3946
- "name": "body",
3947
- "type": "any",
3948
- "required": false,
3949
- "description": "The QBL to be used for the changeset.",
3950
- "properties": []
3951
- },
3952
- {
3953
- "name": "xQBLErrorsAsSuccess",
3954
- "type": "boolean",
3955
- "required": false,
3956
- "description": "If this header is set to true, the API will return a 207 status code even if there are errors. The errors will be returned in the response body.",
3957
- "properties": []
3958
- }
3959
- ],
3960
- "returns": "ChangesetSolution200Response",
3961
- "returnTypeDetails": [
3962
- {
3963
- "name": "id",
3964
- "type": "string",
3965
- "required": false,
3966
- "jsdoc": ""
3967
- },
3968
- {
3969
- "name": "changes",
3970
- "type": "any",
3971
- "required": false,
3972
- "jsdoc": ""
3973
- }
3974
- ],
3975
- "docLink": "https://developer.quickbase.com/operation/changesetSolution"
3976
- },
3977
- {
3978
- "name": "changesetSolutionFromRecord",
3979
- "summary": "List solution changes from record",
3980
- "method": "GET",
3981
- "path": "/solutions/{solutionId}/changeset/fromrecord",
3982
- "parameters": [
3983
- {
3984
- "name": "solutionId",
3985
- "type": "string",
3986
- "required": true,
3987
- "description": "The unique identifier of the solution.",
3988
- "properties": []
3989
- },
3990
- {
3991
- "name": "tableId",
3992
- "type": "string",
3993
- "required": true,
3994
- "description": "The unique identifier (dbid) of the table.",
3995
- "properties": []
3996
- },
3997
- {
3998
- "name": "fieldId",
3999
- "type": "number",
4000
- "required": true,
4001
- "description": "The unique identifier (fid) of the field. It needs to be a file attachment field.",
4002
- "properties": []
4003
- },
4004
- {
4005
- "name": "recordId",
4006
- "type": "number",
4007
- "required": true,
4008
- "description": "The unique identifier of the record.",
4009
- "properties": []
4010
- },
4011
- {
4012
- "name": "xQBLErrorsAsSuccess",
4013
- "type": "boolean",
4014
- "required": false,
4015
- "description": "If this header is set to true, the API will return a 207 status code even if there are errors. The errors will be returned in the response body.",
4016
- "properties": []
4017
- }
4018
- ],
4019
- "returns": "ChangesetSolutionFromRecord200Response",
4020
- "returnTypeDetails": [
4021
- {
4022
- "name": "id",
4023
- "type": "string",
4024
- "required": false,
4025
- "jsdoc": ""
4026
- },
4027
- {
4028
- "name": "changes",
4029
- "type": "any",
4030
- "required": false,
4031
- "jsdoc": ""
4032
- }
4033
- ],
4034
- "docLink": "https://developer.quickbase.com/operation/changesetSolutionFromRecord"
4035
- },
4036
- {
4037
- "name": "generateDocument",
4038
- "summary": "Generate a document",
4039
- "method": "GET",
4040
- "path": "/docTemplates/{templateId}/generate",
4041
- "parameters": [
4042
- {
4043
- "name": "templateId",
4044
- "type": "number",
4045
- "required": true,
4046
- "description": "This is the ID of document template.",
4047
- "properties": []
4048
- },
4049
- {
4050
- "name": "tableId",
4051
- "type": "string",
4052
- "required": true,
4053
- "description": "The unique identifier of the table.",
4054
- "properties": []
4055
- },
4056
- {
4057
- "name": "recordId",
4058
- "type": "number",
4059
- "required": false,
4060
- "description": "The ID of the record",
4061
- "properties": []
4062
- },
4063
- {
4064
- "name": "filename",
4065
- "type": "string",
4066
- "required": true,
4067
- "description": "File name for the downloaded file",
4068
- "properties": []
4069
- },
4070
- {
4071
- "name": "accept",
4072
- "type": "string",
4073
- "required": false,
4074
- "description": "The content-type of the response. application/json will return a JSON payload with a base64 encoded file. application/octet-stream will download the file directly.",
4075
- "properties": []
4076
- },
4077
- {
4078
- "name": "format",
4079
- "type": "string",
4080
- "required": false,
4081
- "description": "The format of the file that is returned. Default is \"pdf\".",
4082
- "properties": []
4083
- },
4084
- {
4085
- "name": "margin",
4086
- "type": "string",
4087
- "required": false,
4088
- "description": "Margin formatted as top right bottom left, separated by spaces. Add to override the value set in the template builder.",
4089
- "properties": []
4090
- },
4091
- {
4092
- "name": "unit",
4093
- "type": "string",
4094
- "required": false,
4095
- "description": "Unit of measurement for the margin. Default is \"in\". Add to override the value set in the template builder.",
4096
- "properties": []
4097
- },
4098
- {
4099
- "name": "pageSize",
4100
- "type": "string",
4101
- "required": false,
4102
- "description": "Page size. Default is \"A4\". Add to override the value set in the template builder.",
4103
- "properties": []
4104
- },
4105
- {
4106
- "name": "orientation",
4107
- "type": "string",
4108
- "required": false,
4109
- "description": "Page orientation. Default is \"portrait\". Add to override the value set in the template builder.",
4110
- "properties": []
4111
- },
4112
- {
4113
- "name": "realm",
4114
- "type": "string",
4115
- "required": false,
4116
- "description": "Your Quickbase domain, for example demo.quickbase.com",
4117
- "properties": []
4118
- }
4119
- ],
4120
- "returns": "GenerateDocument200Response",
4121
- "returnTypeDetails": [
4122
- {
4123
- "name": "fileName",
4124
- "type": "string",
4125
- "required": false,
4126
- "jsdoc": "The file name."
4127
- },
4128
- {
4129
- "name": "data",
4130
- "type": "string",
4131
- "required": false,
4132
- "jsdoc": "Base64 encoded file content."
4133
- },
4134
- {
4135
- "name": "contentType",
4136
- "type": "string",
4137
- "required": false,
4138
- "jsdoc": "The document content type."
4139
- }
4140
- ],
4141
- "docLink": "https://developer.quickbase.com/operation/generateDocument"
4142
- }
4143
- ]