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
package/specs/split/tables.json DELETED
@@ -1,1605 +0,0 @@
1
- {
2
- "swagger": "2.0",
3
- "info": {
4
- "title": "Quick Base API",
5
- "version": "1.0.0"
6
- },
7
- "paths": {
8
- "/tables": {
9
- "post": {
10
- "description": "Creates a table in an application.",
11
- "summary": "Create a table",
12
- "operationId": "createTable",
13
- "consumes": [
14
- "application/json"
15
- ],
16
- "produces": [
17
- "application/json"
18
- ],
19
- "parameters": [
20
- {
21
- "name": "appId",
22
- "in": "query",
23
- "required": true,
24
- "description": "The unique identifier of an app",
25
- "type": "string"
26
- },
27
- {
28
- "name": "QB-Realm-Hostname",
29
- "in": "header",
30
- "required": true,
31
- "description": "Your Quickbase domain, for example demo.quickbase.com",
32
- "type": "string"
33
- },
34
- {
35
- "name": "User-Agent",
36
- "in": "header",
37
- "required": false,
38
- "description": "This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.",
39
- "type": "string"
40
- },
41
- {
42
- "name": "Authorization",
43
- "in": "header",
44
- "required": true,
45
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
46
- "type": "string"
47
- },
48
- {
49
- "name": "generated",
50
- "in": "body",
51
- "schema": {
52
- "description": "The example below shows all the properties that can be changed with this request. Additional properties that you can see with the corresponding GET request cannot be set through this API.",
53
- "example": {
54
- "name": "My table",
55
- "description": "my first table",
56
- "singleRecordName": "record",
57
- "pluralRecordName": "records"
58
- },
59
- "type": "object",
60
- "additionalProperties": true,
61
- "required": [
62
- "name"
63
- ],
64
- "properties": {
65
- "name": {
66
- "description": "The name for the table.",
67
- "type": "string",
68
- "minLength": 1
69
- },
70
- "pluralRecordName": {
71
- "description": "The plural noun for records in the table. If this value is not passed the default value is 'Records'.",
72
- "type": "string"
73
- },
74
- "singleRecordName": {
75
- "description": "The singular noun for records in the table. If this value is not passed the default value is 'Record'.",
76
- "type": "string"
77
- },
78
- "description": {
79
- "description": "The description for the table. If this value is not passed the default value is blank.",
80
- "type": "string"
81
- }
82
- }
83
- }
84
- }
85
- ],
86
- "responses": {
87
- "200": {
88
- "description": "Success",
89
- "x-amf-mediaType": "application/json",
90
- "schema": {
91
- "example": {
92
- "name": "Example Table",
93
- "created": "2020-03-27T18:34:40Z",
94
- "updated": "2020-04-03T19:12:40Z",
95
- "alias": "_dbid_example_table",
96
- "description": "Table as an example.",
97
- "id": "bpqe82s0",
98
- "nextRecordId": 1,
99
- "nextFieldId": 1,
100
- "defaultSortFieldId": 2,
101
- "defaultSortOrder": "ASC",
102
- "keyFieldId": 3,
103
- "singleRecordName": "Example Record",
104
- "pluralRecordName": "Example Records",
105
- "sizeLimit": "150 MB",
106
- "spaceUsed": "17 MB",
107
- "spaceRemaining": "133 MB"
108
- },
109
- "type": "object",
110
- "additionalProperties": true,
111
- "properties": {
112
- "name": {
113
- "description": "The name of the table.",
114
- "type": "string"
115
- },
116
- "id": {
117
- "description": "The unique identifier (dbid) of the table.",
118
- "type": "string"
119
- },
120
- "alias": {
121
- "description": "The automatically-created table alias for the table.",
122
- "type": "string"
123
- },
124
- "description": {
125
- "description": "The description of the table, as configured by an application administrator.",
126
- "type": "string"
127
- },
128
- "created": {
129
- "description": "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).",
130
- "type": "string"
131
- },
132
- "updated": {
133
- "description": "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).",
134
- "type": "string"
135
- },
136
- "nextRecordId": {
137
- "description": "The incremental Record ID that will be used when the next record is created, as determined when the API call was ran.",
138
- "type": "integer"
139
- },
140
- "nextFieldId": {
141
- "description": "The incremental Field ID that will be used when the next field is created, as determined when the API call was ran.",
142
- "type": "integer"
143
- },
144
- "defaultSortFieldId": {
145
- "description": "The id of the field that is configured for default sorting.",
146
- "type": "integer"
147
- },
148
- "defaultSortOrder": {
149
- "description": "The configuration of the default sort order on the table.",
150
- "enum": [
151
- "ASC",
152
- "DESC"
153
- ],
154
- "type": "string"
155
- },
156
- "keyFieldId": {
157
- "description": "The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID.",
158
- "type": "integer"
159
- },
160
- "singleRecordName": {
161
- "description": "The builder-configured singular noun of the table.",
162
- "type": "string"
163
- },
164
- "pluralRecordName": {
165
- "description": "The builder-configured plural noun of the table.",
166
- "type": "string"
167
- },
168
- "sizeLimit": {
169
- "description": "The size limit for the table.",
170
- "type": "string"
171
- },
172
- "spaceUsed": {
173
- "description": "The amount of space currently being used by the table.",
174
- "type": "string"
175
- },
176
- "spaceRemaining": {
177
- "description": "The amount of space remaining for use by the table.",
178
- "type": "string"
179
- }
180
- }
181
- }
182
- }
183
- },
184
- "tags": [
185
- "Tables"
186
- ]
187
- },
188
- "get": {
189
- "description": "Gets a list of all the tables that exist in a specific application. The properties for each table are the same as what is returned in Get table.",
190
- "operationId": "getAppTables",
191
- "summary": "Get tables for an app",
192
- "consumes": [
193
- "application/json"
194
- ],
195
- "produces": [
196
- "application/json"
197
- ],
198
- "parameters": [
199
- {
200
- "name": "appId",
201
- "in": "query",
202
- "required": true,
203
- "description": "The unique identifier of an app",
204
- "type": "string"
205
- },
206
- {
207
- "name": "QB-Realm-Hostname",
208
- "in": "header",
209
- "required": true,
210
- "description": "Your Quickbase domain, for example demo.quickbase.com",
211
- "type": "string"
212
- },
213
- {
214
- "name": "User-Agent",
215
- "in": "header",
216
- "required": false,
217
- "description": "This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.",
218
- "type": "string"
219
- },
220
- {
221
- "name": "Authorization",
222
- "in": "header",
223
- "required": true,
224
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
225
- "type": "string"
226
- }
227
- ],
228
- "responses": {
229
- "200": {
230
- "description": "Success",
231
- "x-amf-mediaType": "application/json",
232
- "schema": {
233
- "example": [
234
- {
235
- "name": "Example Table #0",
236
- "created": "2020-03-27T18:34:40Z",
237
- "updated": "2020-04-03T19:12:40Z",
238
- "alias": "_dbid_example_table_#0",
239
- "description": "Table zero as an example.",
240
- "id": "bpqe82s1",
241
- "nextRecordId": 1,
242
- "nextFieldId": 1,
243
- "defaultSortFieldId": 2,
244
- "defaultSortOrder": "ASC",
245
- "keyFieldId": 3,
246
- "singleRecordName": "Example Record",
247
- "pluralRecordName": "Example Records",
248
- "sizeLimit": "150 MB",
249
- "spaceUsed": "17 MB",
250
- "spaceRemaining": "133 MB"
251
- },
252
- {
253
- "name": "Example Table #2",
254
- "created": "2020-03-27T18:34:40Z",
255
- "updated": "2020-04-03T19:12:40Z",
256
- "alias": "_dbid_example_table_#2",
257
- "description": "Table two as an example.",
258
- "id": "bpqe82z1",
259
- "nextRecordId": 10,
260
- "nextFieldId": 111,
261
- "defaultSortFieldId": 12,
262
- "defaultSortOrder": "DESC",
263
- "keyFieldId": 33,
264
- "singleRecordName": "Another Record",
265
- "pluralRecordName": "More Records",
266
- "sizeLimit": "150 MB",
267
- "spaceUsed": "22 MB",
268
- "spaceRemaining": "128 MB"
269
- }
270
- ],
271
- "type": "array",
272
- "items": {
273
- "example": {
274
- "name": "Example Table",
275
- "created": "2020-03-27T18:34:40Z",
276
- "updated": "2020-04-03T19:12:40Z",
277
- "alias": "_dbid_example_table",
278
- "description": "Table as an example.",
279
- "id": "bpqe82s0",
280
- "nextRecordId": 1,
281
- "nextFieldId": 1,
282
- "defaultSortFieldId": 2,
283
- "defaultSortOrder": "ASC",
284
- "keyFieldId": 3,
285
- "singleRecordName": "Example Record",
286
- "pluralRecordName": "Example Records",
287
- "sizeLimit": "150 MB",
288
- "spaceUsed": "17 MB",
289
- "spaceRemaining": "133 MB"
290
- },
291
- "type": "object",
292
- "additionalProperties": true,
293
- "properties": {
294
- "name": {
295
- "description": "The name of the table.",
296
- "type": "string"
297
- },
298
- "id": {
299
- "description": "The unique identifier (dbid) of the table.",
300
- "type": "string"
301
- },
302
- "alias": {
303
- "description": "The automatically-created table alias for the table.",
304
- "type": "string"
305
- },
306
- "description": {
307
- "description": "The description of the table, as configured by an application administrator.",
308
- "type": "string"
309
- },
310
- "created": {
311
- "description": "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).",
312
- "type": "string"
313
- },
314
- "updated": {
315
- "description": "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).",
316
- "type": "string"
317
- },
318
- "nextRecordId": {
319
- "description": "The incremental Record ID that will be used when the next record is created, as determined when the API call was ran.",
320
- "type": "integer"
321
- },
322
- "nextFieldId": {
323
- "description": "The incremental Field ID that will be used when the next field is created, as determined when the API call was ran.",
324
- "type": "integer"
325
- },
326
- "defaultSortFieldId": {
327
- "description": "The id of the field that is configured for default sorting.",
328
- "type": "integer"
329
- },
330
- "defaultSortOrder": {
331
- "description": "The configuration of the default sort order on the table.",
332
- "enum": [
333
- "ASC",
334
- "DESC"
335
- ],
336
- "type": "string"
337
- },
338
- "keyFieldId": {
339
- "description": "The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID.",
340
- "type": "integer"
341
- },
342
- "singleRecordName": {
343
- "description": "The builder-configured singular noun of the table.",
344
- "type": "string"
345
- },
346
- "pluralRecordName": {
347
- "description": "The builder-configured plural noun of the table.",
348
- "type": "string"
349
- },
350
- "sizeLimit": {
351
- "description": "The size limit for the table.",
352
- "type": "string"
353
- },
354
- "spaceUsed": {
355
- "description": "The amount of space currently being used by the table.",
356
- "type": "string"
357
- },
358
- "spaceRemaining": {
359
- "description": "The amount of space remaining for use by the table.",
360
- "type": "string"
361
- }
362
- }
363
- }
364
- }
365
- }
366
- },
367
- "tags": [
368
- "Tables"
369
- ]
370
- }
371
- },
372
- "/tables/{tableId}": {
373
- "get": {
374
- "description": "Gets the properties of an individual table that is part of an application.",
375
- "operationId": "getTable",
376
- "summary": "Get a table",
377
- "consumes": [
378
- "application/json"
379
- ],
380
- "produces": [
381
- "application/json"
382
- ],
383
- "parameters": [
384
- {
385
- "name": "appId",
386
- "in": "query",
387
- "required": true,
388
- "description": "The unique identifier of an app",
389
- "type": "string"
390
- },
391
- {
392
- "name": "tableId",
393
- "in": "path",
394
- "required": true,
395
- "description": "The unique identifier (dbid) of the table.",
396
- "type": "string"
397
- },
398
- {
399
- "name": "QB-Realm-Hostname",
400
- "in": "header",
401
- "required": true,
402
- "description": "Your Quickbase domain, for example demo.quickbase.com",
403
- "type": "string"
404
- },
405
- {
406
- "name": "User-Agent",
407
- "in": "header",
408
- "required": false,
409
- "description": "This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.",
410
- "type": "string"
411
- },
412
- {
413
- "name": "Authorization",
414
- "in": "header",
415
- "required": true,
416
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
417
- "type": "string"
418
- }
419
- ],
420
- "responses": {
421
- "200": {
422
- "description": "Success",
423
- "x-amf-mediaType": "application/json",
424
- "schema": {
425
- "example": {
426
- "name": "Example Table",
427
- "created": "2020-03-27T18:34:40Z",
428
- "updated": "2020-04-03T19:12:40Z",
429
- "alias": "_dbid_example_table",
430
- "description": "Table as an example.",
431
- "id": "bpqe82s0",
432
- "nextRecordId": 1,
433
- "nextFieldId": 1,
434
- "defaultSortFieldId": 2,
435
- "defaultSortOrder": "ASC",
436
- "keyFieldId": 3,
437
- "singleRecordName": "Example Record",
438
- "pluralRecordName": "Example Records",
439
- "sizeLimit": "150 MB",
440
- "spaceUsed": "17 MB",
441
- "spaceRemaining": "133 MB"
442
- },
443
- "type": "object",
444
- "additionalProperties": true,
445
- "properties": {
446
- "name": {
447
- "description": "The name of the table.",
448
- "type": "string"
449
- },
450
- "id": {
451
- "description": "The unique identifier (dbid) of the table.",
452
- "type": "string"
453
- },
454
- "alias": {
455
- "description": "The automatically-created table alias for the table.",
456
- "type": "string"
457
- },
458
- "description": {
459
- "description": "The description of the table, as configured by an application administrator.",
460
- "type": "string"
461
- },
462
- "created": {
463
- "description": "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).",
464
- "type": "string"
465
- },
466
- "updated": {
467
- "description": "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).",
468
- "type": "string"
469
- },
470
- "nextRecordId": {
471
- "description": "The incremental Record ID that will be used when the next record is created, as determined when the API call was ran.",
472
- "type": "integer"
473
- },
474
- "nextFieldId": {
475
- "description": "The incremental Field ID that will be used when the next field is created, as determined when the API call was ran.",
476
- "type": "integer"
477
- },
478
- "defaultSortFieldId": {
479
- "description": "The id of the field that is configured for default sorting.",
480
- "type": "integer"
481
- },
482
- "defaultSortOrder": {
483
- "description": "The configuration of the default sort order on the table.",
484
- "enum": [
485
- "ASC",
486
- "DESC"
487
- ],
488
- "type": "string"
489
- },
490
- "keyFieldId": {
491
- "description": "The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID.",
492
- "type": "integer"
493
- },
494
- "singleRecordName": {
495
- "description": "The builder-configured singular noun of the table.",
496
- "type": "string"
497
- },
498
- "pluralRecordName": {
499
- "description": "The builder-configured plural noun of the table.",
500
- "type": "string"
501
- },
502
- "sizeLimit": {
503
- "description": "The size limit for the table.",
504
- "type": "string"
505
- },
506
- "spaceUsed": {
507
- "description": "The amount of space currently being used by the table.",
508
- "type": "string"
509
- },
510
- "spaceRemaining": {
511
- "description": "The amount of space remaining for use by the table.",
512
- "type": "string"
513
- }
514
- }
515
- }
516
- }
517
- },
518
- "tags": [
519
- "Tables"
520
- ]
521
- },
522
- "post": {
523
- "description": "Updates the main properties of a specific table. Any properties of the table that you do not specify in the request body will remain unchanged.",
524
- "summary": "Update a table",
525
- "operationId": "updateTable",
526
- "consumes": [
527
- "application/json"
528
- ],
529
- "produces": [
530
- "application/json"
531
- ],
532
- "parameters": [
533
- {
534
- "name": "appId",
535
- "in": "query",
536
- "required": true,
537
- "description": "The unique identifier of an app",
538
- "type": "string"
539
- },
540
- {
541
- "name": "tableId",
542
- "in": "path",
543
- "required": true,
544
- "description": "The unique identifier (dbid) of the table.",
545
- "type": "string"
546
- },
547
- {
548
- "name": "QB-Realm-Hostname",
549
- "in": "header",
550
- "required": true,
551
- "description": "Your Quickbase domain, for example demo.quickbase.com",
552
- "type": "string"
553
- },
554
- {
555
- "name": "User-Agent",
556
- "in": "header",
557
- "required": false,
558
- "description": "This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.",
559
- "type": "string"
560
- },
561
- {
562
- "name": "Authorization",
563
- "in": "header",
564
- "required": true,
565
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
566
- "type": "string"
567
- },
568
- {
569
- "name": "generated",
570
- "in": "body",
571
- "schema": {
572
- "description": "The example below shows all the properties that can be changed with this request. Additional properties that you can see with the corresponding GET request cannot be set through this API.",
573
- "example": {
574
- "name": "My table",
575
- "description": "my first table",
576
- "singleRecordName": "record",
577
- "pluralRecordName": "records"
578
- },
579
- "type": "object",
580
- "additionalProperties": true,
581
- "properties": {
582
- "name": {
583
- "description": "The name for the table.",
584
- "type": "string"
585
- },
586
- "pluralRecordName": {
587
- "description": "The plural noun for records in the table. If this value is not passed the default value is 'Records'.",
588
- "type": "string"
589
- },
590
- "singleRecordName": {
591
- "description": "The singular noun for records in the table. If this value is not passed the default value is 'Record'.",
592
- "type": "string"
593
- },
594
- "description": {
595
- "description": "The description for the table. If this value is not passed the default value is blank.",
596
- "type": "string"
597
- }
598
- }
599
- }
600
- }
601
- ],
602
- "responses": {
603
- "200": {
604
- "description": "Success",
605
- "x-amf-mediaType": "application/json",
606
- "schema": {
607
- "example": {
608
- "name": "Example Table",
609
- "created": "2020-03-27T18:34:40Z",
610
- "updated": "2020-04-03T19:12:40Z",
611
- "alias": "_dbid_example_table",
612
- "description": "Table as an example.",
613
- "id": "bpqe82s0",
614
- "nextRecordId": 1,
615
- "nextFieldId": 1,
616
- "defaultSortFieldId": 2,
617
- "defaultSortOrder": "ASC",
618
- "keyFieldId": 3,
619
- "singleRecordName": "Example Record",
620
- "pluralRecordName": "Example Records",
621
- "sizeLimit": "150 MB",
622
- "spaceUsed": "17 MB",
623
- "spaceRemaining": "133 MB"
624
- },
625
- "type": "object",
626
- "additionalProperties": true,
627
- "properties": {
628
- "name": {
629
- "description": "The name of the table.",
630
- "type": "string"
631
- },
632
- "id": {
633
- "description": "The unique identifier (dbid) of the table.",
634
- "type": "string"
635
- },
636
- "alias": {
637
- "description": "The automatically-created table alias for the table.",
638
- "type": "string"
639
- },
640
- "description": {
641
- "description": "The description of the table, as configured by an application administrator.",
642
- "type": "string"
643
- },
644
- "created": {
645
- "description": "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).",
646
- "type": "string"
647
- },
648
- "updated": {
649
- "description": "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).",
650
- "type": "string"
651
- },
652
- "nextRecordId": {
653
- "description": "The incremental Record ID that will be used when the next record is created, as determined when the API call was ran.",
654
- "type": "integer"
655
- },
656
- "nextFieldId": {
657
- "description": "The incremental Field ID that will be used when the next field is created, as determined when the API call was ran.",
658
- "type": "integer"
659
- },
660
- "defaultSortFieldId": {
661
- "description": "The id of the field that is configured for default sorting.",
662
- "type": "integer"
663
- },
664
- "defaultSortOrder": {
665
- "description": "The configuration of the default sort order on the table.",
666
- "enum": [
667
- "ASC",
668
- "DESC"
669
- ],
670
- "type": "string"
671
- },
672
- "keyFieldId": {
673
- "description": "The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID.",
674
- "type": "integer"
675
- },
676
- "singleRecordName": {
677
- "description": "The builder-configured singular noun of the table.",
678
- "type": "string"
679
- },
680
- "pluralRecordName": {
681
- "description": "The builder-configured plural noun of the table.",
682
- "type": "string"
683
- },
684
- "sizeLimit": {
685
- "description": "The size limit for the table.",
686
- "type": "string"
687
- },
688
- "spaceUsed": {
689
- "description": "The amount of space currently being used by the table.",
690
- "type": "string"
691
- },
692
- "spaceRemaining": {
693
- "description": "The amount of space remaining for use by the table.",
694
- "type": "string"
695
- }
696
- }
697
- }
698
- }
699
- },
700
- "tags": [
701
- "Tables"
702
- ]
703
- },
704
- "delete": {
705
- "description": "Deletes a specific table in an application, including all of the data within it.",
706
- "operationId": "deleteTable",
707
- "summary": "Delete a table",
708
- "consumes": [
709
- "application/json"
710
- ],
711
- "produces": [
712
- "application/json"
713
- ],
714
- "parameters": [
715
- {
716
- "name": "appId",
717
- "in": "query",
718
- "required": true,
719
- "description": "The unique identifier of an app",
720
- "type": "string"
721
- },
722
- {
723
- "name": "tableId",
724
- "in": "path",
725
- "required": true,
726
- "description": "The unique identifier (dbid) of the table.",
727
- "type": "string"
728
- },
729
- {
730
- "name": "QB-Realm-Hostname",
731
- "in": "header",
732
- "required": true,
733
- "description": "Your Quickbase domain, for example demo.quickbase.com",
734
- "type": "string"
735
- },
736
- {
737
- "name": "User-Agent",
738
- "in": "header",
739
- "required": false,
740
- "description": "This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.",
741
- "type": "string"
742
- },
743
- {
744
- "name": "Authorization",
745
- "in": "header",
746
- "required": true,
747
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
748
- "type": "string"
749
- }
750
- ],
751
- "responses": {
752
- "200": {
753
- "description": "Success",
754
- "x-amf-mediaType": "application/json",
755
- "schema": {
756
- "example": {
757
- "deletedTableId": "bck7gp3q2"
758
- },
759
- "type": "object",
760
- "additionalProperties": true,
761
- "properties": {
762
- "deletedTableId": {
763
- "description": "The deleted table id.",
764
- "type": "string"
765
- }
766
- }
767
- }
768
- }
769
- },
770
- "tags": [
771
- "Tables"
772
- ]
773
- }
774
- },
775
- "/tables/{tableId}/relationships": {
776
- "get": {
777
- "description": "Get a list of all relationships, and their definitions, for a specific table. Details are provided for the child side of relationships within a given application. Limited details are returned for cross-application relationships.",
778
- "operationId": "getRelationships",
779
- "summary": "Get all relationships",
780
- "consumes": [
781
- "application/json"
782
- ],
783
- "produces": [
784
- "application/json"
785
- ],
786
- "parameters": [
787
- {
788
- "name": "skip",
789
- "in": "query",
790
- "required": false,
791
- "description": "The number of relationships to skip.",
792
- "type": "integer"
793
- },
794
- {
795
- "name": "tableId",
796
- "in": "path",
797
- "required": true,
798
- "description": "The unique identifier (dbid) of the child table.",
799
- "type": "string"
800
- },
801
- {
802
- "name": "QB-Realm-Hostname",
803
- "in": "header",
804
- "required": true,
805
- "description": "Your Quickbase domain, for example demo.quickbase.com",
806
- "type": "string"
807
- },
808
- {
809
- "name": "User-Agent",
810
- "in": "header",
811
- "required": false,
812
- "description": "This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.",
813
- "type": "string"
814
- },
815
- {
816
- "name": "Authorization",
817
- "in": "header",
818
- "required": true,
819
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
820
- "type": "string"
821
- }
822
- ],
823
- "responses": {
824
- "200": {
825
- "description": "Success",
826
- "x-amf-mediaType": "application/json",
827
- "schema": {
828
- "example": {
829
- "metadata": {
830
- "numRelationships": 1,
831
- "skip": 0,
832
- "totalRelationships": 1
833
- },
834
- "relationships": [
835
- {
836
- "childTableId": "bqqjnwsuy",
837
- "foreignKeyField": {
838
- "id": 6,
839
- "label": "Related record",
840
- "type": "numeric"
841
- },
842
- "id": 6,
843
- "isCrossApp": false,
844
- "lookupFields": [
845
- {
846
- "id": 3,
847
- "label": "Name",
848
- "type": "text"
849
- }
850
- ],
851
- "parentTableId": "bck7gp3q2",
852
- "summaryFields": [
853
- {
854
- "id": 8,
855
- "label": "my summary field",
856
- "type": "numeric"
857
- }
858
- ]
859
- }
860
- ]
861
- },
862
- "type": "object",
863
- "additionalProperties": true,
864
- "required": [
865
- "relationships"
866
- ],
867
- "properties": {
868
- "relationships": {
869
- "description": "The relationships in a table.",
870
- "type": "array",
871
- "items": {
872
- "example": {
873
- "id": 6,
874
- "foreignKeyField": {
875
- "id": 6,
876
- "label": "Related record",
877
- "type": "numeric"
878
- },
879
- "lookupFields": [
880
- {
881
- "id": 7,
882
- "label": "record - text field",
883
- "type": "text"
884
- }
885
- ],
886
- "isCrossApp": false,
887
- "parentTableId": "bck7gp3q2",
888
- "childTableId": "bck7gp3q3",
889
- "summaryFields": [
890
- {
891
- "id": 8,
892
- "label": "Summary of Record ID#2",
893
- "type": "numeric"
894
- }
895
- ]
896
- },
897
- "type": "object",
898
- "additionalProperties": true,
899
- "required": [
900
- "id",
901
- "parentTableId",
902
- "childTableId",
903
- "isCrossApp"
904
- ],
905
- "properties": {
906
- "id": {
907
- "description": "The relationship id (foreign key field id).",
908
- "type": "integer"
909
- },
910
- "parentTableId": {
911
- "description": "The parent table id of the relationship.",
912
- "type": "string"
913
- },
914
- "childTableId": {
915
- "description": "The child table id of the relationship.",
916
- "type": "string"
917
- },
918
- "foreignKeyField": {
919
- "description": "The foreign key field information.",
920
- "type": "object",
921
- "additionalProperties": true,
922
- "properties": {
923
- "id": {
924
- "description": "Field id.",
925
- "type": "integer"
926
- },
927
- "label": {
928
- "description": "Field label.",
929
- "type": "string"
930
- },
931
- "type": {
932
- "description": "Field type.",
933
- "type": "string"
934
- }
935
- }
936
- },
937
- "isCrossApp": {
938
- "description": "Whether this is a cross-app relationship.",
939
- "type": "boolean"
940
- },
941
- "lookupFields": {
942
- "description": "The lookup fields array.",
943
- "type": "array",
944
- "items": {
945
- "type": "object",
946
- "additionalProperties": true,
947
- "properties": {
948
- "id": {
949
- "description": "Field id.",
950
- "type": "integer"
951
- },
952
- "label": {
953
- "description": "Field label.",
954
- "type": "string"
955
- },
956
- "type": {
957
- "description": "Field type.",
958
- "type": "string"
959
- }
960
- }
961
- }
962
- },
963
- "summaryFields": {
964
- "description": "The summary fields array.",
965
- "type": "array",
966
- "items": {
967
- "type": "object",
968
- "additionalProperties": true,
969
- "properties": {
970
- "id": {
971
- "description": "Field id.",
972
- "type": "integer"
973
- },
974
- "label": {
975
- "description": "Field label.",
976
- "type": "string"
977
- },
978
- "type": {
979
- "description": "Field type.",
980
- "type": "string"
981
- }
982
- }
983
- }
984
- }
985
- }
986
- }
987
- },
988
- "metadata": {
989
- "description": "Additional information about the results that may be helpful.",
990
- "type": "object",
991
- "additionalProperties": true,
992
- "properties": {
993
- "skip": {
994
- "description": "The number of relationships to skip.",
995
- "type": "integer"
996
- },
997
- "totalRelationships": {
998
- "description": "The total number of relationships.",
999
- "type": "integer"
1000
- },
1001
- "numRelationships": {
1002
- "description": "The number of relationships in the current response object.",
1003
- "type": "integer"
1004
- }
1005
- }
1006
- }
1007
- }
1008
- }
1009
- }
1010
- },
1011
- "tags": [
1012
- "Tables"
1013
- ]
1014
- }
1015
- },
1016
- "/tables/{tableId}/relationship": {
1017
- "post": {
1018
- "description": "Creates a relationship in a table as well as lookup/summary fields. Relationships can only be created for tables within the same app.",
1019
- "summary": "Create a relationship",
1020
- "operationId": "createRelationship",
1021
- "consumes": [
1022
- "application/json"
1023
- ],
1024
- "produces": [
1025
- "application/json"
1026
- ],
1027
- "parameters": [
1028
- {
1029
- "name": "tableId",
1030
- "in": "path",
1031
- "required": true,
1032
- "description": "The unique identifier (dbid) of the table. This will be the child table.",
1033
- "type": "string"
1034
- },
1035
- {
1036
- "name": "QB-Realm-Hostname",
1037
- "in": "header",
1038
- "required": true,
1039
- "description": "Your Quickbase domain, for example demo.quickbase.com",
1040
- "type": "string"
1041
- },
1042
- {
1043
- "name": "User-Agent",
1044
- "in": "header",
1045
- "required": false,
1046
- "description": "This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.",
1047
- "type": "string"
1048
- },
1049
- {
1050
- "name": "Authorization",
1051
- "in": "header",
1052
- "required": true,
1053
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
1054
- "type": "string"
1055
- },
1056
- {
1057
- "name": "generated",
1058
- "in": "body",
1059
- "schema": {
1060
- "example": {
1061
- "parentTableId": "bck7gp3q2",
1062
- "foreignKeyField": {
1063
- "label": "my relationship field"
1064
- },
1065
- "lookupFieldIds": [
1066
- 1,
1067
- 2,
1068
- 3
1069
- ],
1070
- "summaryFields": [
1071
- {
1072
- "summaryFid": 3,
1073
- "label": "my first summary field",
1074
- "accumulationType": "AVG",
1075
- "where": "{'3'.EX.1}"
1076
- },
1077
- {
1078
- "summaryFid": 4,
1079
- "label": "my second summary field",
1080
- "accumulationType": "SUM"
1081
- }
1082
- ]
1083
- },
1084
- "type": "object",
1085
- "additionalProperties": false,
1086
- "required": [
1087
- "parentTableId"
1088
- ],
1089
- "properties": {
1090
- "summaryFields": {
1091
- "description": "Array of summary field objects which will turn into summary fields in the parent table. When you specify the 'COUNT' accumulation type, you have to specify 0 as the summaryFid (or not set it in the request). 'DISTINCT-COUNT' requires that summaryFid be set to an actual fid.",
1092
- "type": "array",
1093
- "items": {
1094
- "type": "object",
1095
- "additionalProperties": true,
1096
- "required": [
1097
- "accumulationType"
1098
- ],
1099
- "properties": {
1100
- "summaryFid": {
1101
- "description": "The field id to summarize.",
1102
- "type": "number"
1103
- },
1104
- "label": {
1105
- "description": "The label for the summary field.",
1106
- "type": "string"
1107
- },
1108
- "accumulationType": {
1109
- "description": "The accumulation type for the summary field.",
1110
- "enum": [
1111
- "AVG",
1112
- "SUM",
1113
- "MAX",
1114
- "MIN",
1115
- "STD-DEV",
1116
- "COUNT",
1117
- "COMBINED-TEXT",
1118
- "COMBINED-USER",
1119
- "DISTINCT-COUNT"
1120
- ],
1121
- "type": "string"
1122
- },
1123
- "where": {
1124
- "description": "The filter, using the Quickbase query language, which determines the records to return.",
1125
- "type": "string"
1126
- }
1127
- }
1128
- }
1129
- },
1130
- "lookupFieldIds": {
1131
- "description": "Array of field ids in the parent table that will become lookup fields in the child table.",
1132
- "type": "array",
1133
- "items": {
1134
- "type": "integer"
1135
- }
1136
- },
1137
- "parentTableId": {
1138
- "description": "The parent table id for the relationship.",
1139
- "type": "string"
1140
- },
1141
- "foreignKeyField": {
1142
- "description": "This property is optional. If it is not provided, the foreign key field will be created with the label ‘Related <record>’, where <record> is the name of a record in the parent table.",
1143
- "type": "object",
1144
- "additionalProperties": true,
1145
- "properties": {
1146
- "label": {
1147
- "description": "The label for the foreign key field.",
1148
- "type": "string"
1149
- }
1150
- }
1151
- }
1152
- }
1153
- }
1154
- }
1155
- ],
1156
- "responses": {
1157
- "200": {
1158
- "description": "Success",
1159
- "x-amf-mediaType": "application/json",
1160
- "schema": {
1161
- "example": {
1162
- "id": 6,
1163
- "foreignKeyField": {
1164
- "id": 6,
1165
- "label": "Related record",
1166
- "type": "numeric"
1167
- },
1168
- "lookupFields": [
1169
- {
1170
- "id": 7,
1171
- "label": "record - text field",
1172
- "type": "text"
1173
- }
1174
- ],
1175
- "isCrossApp": false,
1176
- "parentTableId": "bck7gp3q2",
1177
- "childTableId": "bck7gp3q3",
1178
- "summaryFields": [
1179
- {
1180
- "id": 8,
1181
- "label": "Summary of Record ID#2",
1182
- "type": "numeric"
1183
- }
1184
- ]
1185
- },
1186
- "type": "object",
1187
- "additionalProperties": true,
1188
- "required": [
1189
- "id",
1190
- "parentTableId",
1191
- "childTableId",
1192
- "isCrossApp"
1193
- ],
1194
- "properties": {
1195
- "id": {
1196
- "description": "The relationship id (foreign key field id).",
1197
- "type": "integer"
1198
- },
1199
- "parentTableId": {
1200
- "description": "The parent table id of the relationship.",
1201
- "type": "string"
1202
- },
1203
- "childTableId": {
1204
- "description": "The child table id of the relationship.",
1205
- "type": "string"
1206
- },
1207
- "foreignKeyField": {
1208
- "description": "The foreign key field information.",
1209
- "type": "object",
1210
- "additionalProperties": true,
1211
- "properties": {
1212
- "id": {
1213
- "description": "Field id.",
1214
- "type": "integer"
1215
- },
1216
- "label": {
1217
- "description": "Field label.",
1218
- "type": "string"
1219
- },
1220
- "type": {
1221
- "description": "Field type.",
1222
- "type": "string"
1223
- }
1224
- }
1225
- },
1226
- "isCrossApp": {
1227
- "description": "Whether this is a cross-app relationship.",
1228
- "type": "boolean"
1229
- },
1230
- "lookupFields": {
1231
- "description": "The lookup fields array.",
1232
- "type": "array",
1233
- "items": {
1234
- "type": "object",
1235
- "additionalProperties": true,
1236
- "properties": {
1237
- "id": {
1238
- "description": "Field id.",
1239
- "type": "integer"
1240
- },
1241
- "label": {
1242
- "description": "Field label.",
1243
- "type": "string"
1244
- },
1245
- "type": {
1246
- "description": "Field type.",
1247
- "type": "string"
1248
- }
1249
- }
1250
- }
1251
- },
1252
- "summaryFields": {
1253
- "description": "The summary fields array.",
1254
- "type": "array",
1255
- "items": {
1256
- "type": "object",
1257
- "additionalProperties": true,
1258
- "properties": {
1259
- "id": {
1260
- "description": "Field id.",
1261
- "type": "integer"
1262
- },
1263
- "label": {
1264
- "description": "Field label.",
1265
- "type": "string"
1266
- },
1267
- "type": {
1268
- "description": "Field type.",
1269
- "type": "string"
1270
- }
1271
- }
1272
- }
1273
- }
1274
- }
1275
- }
1276
- }
1277
- },
1278
- "tags": [
1279
- "Tables"
1280
- ]
1281
- }
1282
- },
1283
- "/tables/{tableId}/relationship/{relationshipId}": {
1284
- "post": {
1285
- "description": "Use this endpoint to add lookup fields and summary fields to an existing relationship. Updating a relationship will not delete existing lookup/summary fields.",
1286
- "summary": "Update a relationship",
1287
- "operationId": "updateRelationship",
1288
- "consumes": [
1289
- "application/json"
1290
- ],
1291
- "produces": [
1292
- "application/json"
1293
- ],
1294
- "parameters": [
1295
- {
1296
- "name": "tableId",
1297
- "in": "path",
1298
- "required": true,
1299
- "description": "The unique identifier (dbid) of the table. This will be the child table.",
1300
- "type": "string"
1301
- },
1302
- {
1303
- "name": "relationshipId",
1304
- "in": "path",
1305
- "required": true,
1306
- "description": "The relationship id. This is the field id of the reference field on the child table.",
1307
- "type": "number"
1308
- },
1309
- {
1310
- "name": "QB-Realm-Hostname",
1311
- "in": "header",
1312
- "required": true,
1313
- "description": "Your Quickbase domain, for example demo.quickbase.com",
1314
- "type": "string"
1315
- },
1316
- {
1317
- "name": "User-Agent",
1318
- "in": "header",
1319
- "required": false,
1320
- "description": "This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.",
1321
- "type": "string"
1322
- },
1323
- {
1324
- "name": "Authorization",
1325
- "in": "header",
1326
- "required": true,
1327
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
1328
- "type": "string"
1329
- },
1330
- {
1331
- "name": "generated",
1332
- "in": "body",
1333
- "schema": {
1334
- "example": {
1335
- "lookupFieldIds": [
1336
- 4,
1337
- 5,
1338
- 6
1339
- ],
1340
- "summaryFields": [
1341
- {
1342
- "summaryFid": 3,
1343
- "label": "my summary field",
1344
- "accumulationType": "COUNT",
1345
- "where": "{'3'.EX.1}"
1346
- }
1347
- ]
1348
- },
1349
- "type": "object",
1350
- "additionalProperties": false,
1351
- "properties": {
1352
- "summaryFields": {
1353
- "description": "An array of objects, each representing a configuration of one field from the child table, that will become summary fields on the parent table. When you specify the 'COUNT' accumulation type, you have to specify 0 as the summaryFid (or not set it in the request). 'DISTINCT-COUNT' requires that summaryFid be set to an actual fid.",
1354
- "type": "array",
1355
- "items": {
1356
- "type": "object",
1357
- "additionalProperties": true,
1358
- "required": [
1359
- "accumulationType"
1360
- ],
1361
- "properties": {
1362
- "summaryFid": {
1363
- "description": "The field id to summarize.",
1364
- "type": "number"
1365
- },
1366
- "label": {
1367
- "description": "The label for the summary field.",
1368
- "type": "string"
1369
- },
1370
- "accumulationType": {
1371
- "description": "The accumulation type for the summary field.",
1372
- "enum": [
1373
- "AVG",
1374
- "SUM",
1375
- "MAX",
1376
- "MIN",
1377
- "STD-DEV",
1378
- "COUNT",
1379
- "COMBINED-TEXT",
1380
- "COMBINED-USER",
1381
- "DISTINCT-COUNT"
1382
- ],
1383
- "type": "string"
1384
- },
1385
- "where": {
1386
- "description": "The filter, using the Quickbase query language, which determines the records to return.",
1387
- "type": "string"
1388
- }
1389
- }
1390
- }
1391
- },
1392
- "lookupFieldIds": {
1393
- "description": "An array of field ids on the parent table that will become lookup fields on the child table.",
1394
- "type": "array",
1395
- "items": {
1396
- "type": "integer"
1397
- }
1398
- }
1399
- }
1400
- }
1401
- }
1402
- ],
1403
- "responses": {
1404
- "200": {
1405
- "description": "Success",
1406
- "x-amf-mediaType": "application/json",
1407
- "schema": {
1408
- "example": {
1409
- "id": 6,
1410
- "foreignKeyField": {
1411
- "id": 6,
1412
- "label": "Related record",
1413
- "type": "numeric"
1414
- },
1415
- "lookupFields": [
1416
- {
1417
- "id": 7,
1418
- "label": "record - text field",
1419
- "type": "text"
1420
- }
1421
- ],
1422
- "isCrossApp": false,
1423
- "parentTableId": "bck7gp3q2",
1424
- "childTableId": "bck7gp3q3",
1425
- "summaryFields": [
1426
- {
1427
- "id": 8,
1428
- "label": "Summary of Record ID#2",
1429
- "type": "numeric"
1430
- }
1431
- ]
1432
- },
1433
- "type": "object",
1434
- "additionalProperties": true,
1435
- "required": [
1436
- "id",
1437
- "parentTableId",
1438
- "childTableId",
1439
- "isCrossApp"
1440
- ],
1441
- "properties": {
1442
- "id": {
1443
- "description": "The relationship id (foreign key field id).",
1444
- "type": "integer"
1445
- },
1446
- "parentTableId": {
1447
- "description": "The parent table id of the relationship.",
1448
- "type": "string"
1449
- },
1450
- "childTableId": {
1451
- "description": "The child table id of the relationship.",
1452
- "type": "string"
1453
- },
1454
- "foreignKeyField": {
1455
- "description": "The foreign key field information.",
1456
- "type": "object",
1457
- "additionalProperties": true,
1458
- "properties": {
1459
- "id": {
1460
- "description": "Field id.",
1461
- "type": "integer"
1462
- },
1463
- "label": {
1464
- "description": "Field label.",
1465
- "type": "string"
1466
- },
1467
- "type": {
1468
- "description": "Field type.",
1469
- "type": "string"
1470
- }
1471
- }
1472
- },
1473
- "isCrossApp": {
1474
- "description": "Whether this is a cross-app relationship.",
1475
- "type": "boolean"
1476
- },
1477
- "lookupFields": {
1478
- "description": "The lookup fields array.",
1479
- "type": "array",
1480
- "items": {
1481
- "type": "object",
1482
- "additionalProperties": true,
1483
- "properties": {
1484
- "id": {
1485
- "description": "Field id.",
1486
- "type": "integer"
1487
- },
1488
- "label": {
1489
- "description": "Field label.",
1490
- "type": "string"
1491
- },
1492
- "type": {
1493
- "description": "Field type.",
1494
- "type": "string"
1495
- }
1496
- }
1497
- }
1498
- },
1499
- "summaryFields": {
1500
- "description": "The summary fields array.",
1501
- "type": "array",
1502
- "items": {
1503
- "type": "object",
1504
- "additionalProperties": true,
1505
- "properties": {
1506
- "id": {
1507
- "description": "Field id.",
1508
- "type": "integer"
1509
- },
1510
- "label": {
1511
- "description": "Field label.",
1512
- "type": "string"
1513
- },
1514
- "type": {
1515
- "description": "Field type.",
1516
- "type": "string"
1517
- }
1518
- }
1519
- }
1520
- }
1521
- }
1522
- }
1523
- }
1524
- },
1525
- "tags": [
1526
- "Tables"
1527
- ]
1528
- },
1529
- "delete": {
1530
- "description": "Use this endpoint to delete an entire relationship, including all lookup and summary fields. The reference field in the relationship will not be deleted.",
1531
- "summary": "Delete a relationship",
1532
- "operationId": "deleteRelationship",
1533
- "consumes": [
1534
- "application/json"
1535
- ],
1536
- "produces": [
1537
- "application/json"
1538
- ],
1539
- "parameters": [
1540
- {
1541
- "name": "tableId",
1542
- "in": "path",
1543
- "required": true,
1544
- "description": "The unique identifier (dbid) of the table. This will be the child table.",
1545
- "type": "string"
1546
- },
1547
- {
1548
- "name": "relationshipId",
1549
- "in": "path",
1550
- "required": true,
1551
- "description": "The relationship id. This is the field id of the reference field on the child table.",
1552
- "type": "number"
1553
- },
1554
- {
1555
- "name": "QB-Realm-Hostname",
1556
- "in": "header",
1557
- "required": true,
1558
- "description": "Your Quickbase domain, for example demo.quickbase.com",
1559
- "type": "string"
1560
- },
1561
- {
1562
- "name": "User-Agent",
1563
- "in": "header",
1564
- "required": false,
1565
- "description": "This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.",
1566
- "type": "string"
1567
- },
1568
- {
1569
- "name": "Authorization",
1570
- "in": "header",
1571
- "required": true,
1572
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
1573
- "type": "string"
1574
- }
1575
- ],
1576
- "responses": {
1577
- "200": {
1578
- "description": "Success",
1579
- "x-amf-mediaType": "application/json",
1580
- "schema": {
1581
- "example": {
1582
- "relationshipId": 6
1583
- },
1584
- "type": "object",
1585
- "additionalProperties": true,
1586
- "required": [
1587
- "relationshipId"
1588
- ],
1589
- "properties": {
1590
- "relationshipId": {
1591
- "description": "The relationship id.",
1592
- "type": "integer"
1593
- }
1594
- }
1595
- }
1596
- }
1597
- },
1598
- "tags": [
1599
- "Tables"
1600
- ]
1601
- }
1602
- }
1603
- },
1604
- "definitions": {}
1605
- }