quickbase-js 0.1.0-beta.13 → 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 (167) hide show
  1. package/README.md +1 -1
  2. package/dist/esm/quickbase.d.ts +2 -1
  3. package/package.json +9 -4
  4. package/CHANGELOG.md +0 -239
  5. package/build-common.js +0 -131
  6. package/build-esm.js +0 -71
  7. package/build-umd.js +0 -69
  8. package/docs/.vitepress/cache/deps/@theme_index.js +0 -275
  9. package/docs/.vitepress/cache/deps/@theme_index.js.map +0 -7
  10. package/docs/.vitepress/cache/deps/_metadata.json +0 -40
  11. package/docs/.vitepress/cache/deps/chunk-5A67QEFC.js +0 -12542
  12. package/docs/.vitepress/cache/deps/chunk-5A67QEFC.js.map +0 -7
  13. package/docs/.vitepress/cache/deps/chunk-7D4P4MMP.js +0 -9719
  14. package/docs/.vitepress/cache/deps/chunk-7D4P4MMP.js.map +0 -7
  15. package/docs/.vitepress/cache/deps/package.json +0 -3
  16. package/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js +0 -4504
  17. package/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js.map +0 -7
  18. package/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js +0 -583
  19. package/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js.map +0 -7
  20. package/docs/.vitepress/cache/deps/vue.js +0 -343
  21. package/docs/.vitepress/cache/deps/vue.js.map +0 -7
  22. package/docs/.vitepress/config.mts +0 -26
  23. package/docs/api-examples.md +0 -49
  24. package/docs/index.md +0 -59
  25. package/docs/markdown-examples.md +0 -85
  26. package/docs-data/api-docs.json +0 -4143
  27. package/examples/quicbase-jsCDN.html +0 -36
  28. package/examples/react.js +0 -48
  29. package/examples/vanillajs.html +0 -47
  30. package/index.md +0 -25
  31. package/open-api/fix-spec-main.ts +0 -133
  32. package/open-api/generate-unified-interface.ts +0 -104
  33. package/open-api/generateDocsJson.ts +0 -24
  34. package/open-api/output/quickbase-fixed.json +0 -11191
  35. package/open-api/post-process-generated.ts +0 -226
  36. package/open-api/regenerate-client.ts +0 -117
  37. package/open-api/schema/enhance-general.ts +0 -111
  38. package/open-api/schema/fix-arrays.ts +0 -68
  39. package/open-api/schema/tags/apps.ts +0 -90
  40. package/open-api/schema/tags/fields.ts +0 -471
  41. package/open-api/schema/tags/groups.ts +0 -51
  42. package/open-api/schema/tags/index.ts +0 -66
  43. package/open-api/schema/tags/records.ts +0 -115
  44. package/open-api/schema/tags/tables.ts +0 -211
  45. package/open-api/schema/tags/users.ts +0 -47
  46. package/open-api/types/spec.ts +0 -42
  47. package/open-api/utils/common.ts +0 -29
  48. package/open-api/utils/generateJsDoc.ts +0 -74
  49. package/open-api/utils/infer-schema.ts +0 -40
  50. package/open-api/utils/naming.ts +0 -10
  51. package/open-api/utils/sharedUtils.ts +0 -352
  52. package/playwright.config.ts +0 -37
  53. package/rollup.config.js +0 -114
  54. package/specs/QuickBase_RESTful_API_2025-03-04T06_22_39.725Z.json +0 -46878
  55. package/specs/split/apps.json +0 -1315
  56. package/specs/split/auth.json +0 -191
  57. package/specs/split/fields.json +0 -3869
  58. package/specs/split/records.json +0 -754
  59. package/specs/split/reports.json +0 -619
  60. package/specs/split/tables.json +0 -1605
  61. package/src/BurstAwareThrottleBucket.ts +0 -57
  62. package/src/FlowThrottleBucket.ts +0 -47
  63. package/src/RateLimitError.ts +0 -12
  64. package/src/RateThrottleBucket.ts +0 -5
  65. package/src/Semaphore.ts +0 -33
  66. package/src/authorizationStrategy.ts +0 -321
  67. package/src/generated-unified/QuickbaseClient.ts +0 -1135
  68. package/src/generated-unified/missing-types-report.json +0 -3
  69. package/src/index.ts +0 -1
  70. package/src/invokeMethod.ts +0 -290
  71. package/src/pagination.ts +0 -429
  72. package/src/quickbaseClient.ts +0 -227
  73. package/src/rateLimiter.ts +0 -30
  74. package/src/tokenCache.ts +0 -39
  75. package/src/utils.ts +0 -50
  76. package/tests/playwright/qb/auth/cacheSwitching.test.ts +0 -159
  77. package/tests/playwright/qb/auth/fetchTempToken401.test.ts +0 -219
  78. package/tests/playwright/qb/auth/getAppWithTempToken.test.ts +0 -162
  79. package/tests/playwright/qb/auth/getAppWithTempTokenConcurrency.test.ts +0 -208
  80. package/tests/playwright/qb/auth/getAppWithUserToken.test.ts +0 -153
  81. package/tests/playwright/qb/auth/getTempToken.test.ts +0 -152
  82. package/tests/playwright/qb/auth/tempTokenPrefetch.test.ts +0 -179
  83. package/tests/playwright/qb/auth/tempTokenRenewal.test.ts +0 -133
  84. package/tests/setup.ts +0 -53
  85. package/tests/vitest/qb/apps/copyApp.test.ts +0 -76
  86. package/tests/vitest/qb/apps/createApp.test.ts +0 -64
  87. package/tests/vitest/qb/apps/deleteApp.test.ts +0 -76
  88. package/tests/vitest/qb/apps/getApp.test.ts +0 -44
  89. package/tests/vitest/qb/apps/getAppEvents.test.ts +0 -67
  90. package/tests/vitest/qb/apps/updateApp.test.ts +0 -58
  91. package/tests/vitest/qb/auth/mockQuickbaseServer.ts +0 -60
  92. package/tests/vitest/qb/auth/retryUserToken401.test.ts +0 -73
  93. package/tests/vitest/qb/auth/ssoTokenConcurrency.test.ts +0 -68
  94. package/tests/vitest/qb/auth/ssoTokenIntegrationWithServer.test.ts +0 -65
  95. package/tests/vitest/qb/auth/userTokenConcurrency.test.ts +0 -63
  96. package/tests/vitest/qb/fields/createField.test.ts +0 -77
  97. package/tests/vitest/qb/fields/deleteFields.test.ts +0 -83
  98. package/tests/vitest/qb/fields/getField.test.ts +0 -85
  99. package/tests/vitest/qb/fields/getFieldUsage.test.ts +0 -82
  100. package/tests/vitest/qb/fields/getFields.test.ts +0 -232
  101. package/tests/vitest/qb/fields/getFieldsUsage.test.ts +0 -77
  102. package/tests/vitest/qb/fields/updateField.test.ts +0 -93
  103. package/tests/vitest/qb/formulas/runFormula.test.ts +0 -96
  104. package/tests/vitest/qb/index.ts +0 -29
  105. package/tests/vitest/qb/quickbase-js/BurstAwareThrottleBucket.test.ts +0 -125
  106. package/tests/vitest/qb/quickbase-js/FlowBucket.test.ts +0 -77
  107. package/tests/vitest/qb/quickbase-js/paginationSkip.test.ts +0 -111
  108. package/tests/vitest/qb/records/deleteRecords.test.ts +0 -110
  109. package/tests/vitest/qb/records/runQuery.test.ts +0 -145
  110. package/tests/vitest/qb/records/upsert.test.ts +0 -102
  111. package/tests/vitest/qb/tables/createRelationship.test.ts +0 -102
  112. package/tests/vitest/qb/tables/createTable.test.ts +0 -55
  113. package/tests/vitest/qb/tables/deleteRelationship.test.ts +0 -143
  114. package/tests/vitest/qb/tables/deleteTable.test.ts +0 -50
  115. package/tests/vitest/qb/tables/getAppTables.test.ts +0 -46
  116. package/tests/vitest/qb/tables/getRelationships.test.ts +0 -80
  117. package/tests/vitest/qb/tables/getTable.test.ts +0 -26
  118. package/tests/vitest/qb/tables/updateRelationship.test.ts +0 -250
  119. package/tests/vitest/qb/tables/updateTable.test.ts +0 -48
  120. package/tests/vitest/unit/apps/copyApp.test.ts +0 -581
  121. package/tests/vitest/unit/apps/createApp.test.ts +0 -186
  122. package/tests/vitest/unit/apps/deleteApp.test.ts +0 -216
  123. package/tests/vitest/unit/apps/getApp.test.ts +0 -128
  124. package/tests/vitest/unit/apps/getAppConcurrency.test.ts +0 -151
  125. package/tests/vitest/unit/apps/getAppEvents.test.ts +0 -193
  126. package/tests/vitest/unit/apps/updateApp.test.ts +0 -412
  127. package/tests/vitest/unit/auth/fetchTempToken401.test.ts +0 -81
  128. package/tests/vitest/unit/auth/getTempToken.test.ts +0 -119
  129. package/tests/vitest/unit/auth/retryTempToken401.test.ts +0 -95
  130. package/tests/vitest/unit/auth/retryTempTokenMaxRetries.test.ts +0 -206
  131. package/tests/vitest/unit/auth/retryUserToken401.test.ts +0 -66
  132. package/tests/vitest/unit/auth/ssoTokenRefresh.test.ts +0 -325
  133. package/tests/vitest/unit/auth/userTokenConcurrency.test.ts +0 -62
  134. package/tests/vitest/unit/fields/createField.test.ts +0 -451
  135. package/tests/vitest/unit/fields/deleteFields.test.ts +0 -141
  136. package/tests/vitest/unit/fields/getField.test.ts +0 -189
  137. package/tests/vitest/unit/fields/getFieldUsage.test.ts +0 -180
  138. package/tests/vitest/unit/fields/getFields.test.ts +0 -122
  139. package/tests/vitest/unit/fields/getFieldsUsage.test.ts +0 -160
  140. package/tests/vitest/unit/fields/updateField.test.ts +0 -285
  141. package/tests/vitest/unit/formulas/runFormula.test.ts +0 -205
  142. package/tests/vitest/unit/index.ts +0 -34
  143. package/tests/vitest/unit/quickbase-js/BurstAwareThrottleBucket.test.ts +0 -108
  144. package/tests/vitest/unit/quickbase-js/FlowBucket.test.ts +0 -101
  145. package/tests/vitest/unit/quickbase-js/pagination.test.ts +0 -251
  146. package/tests/vitest/unit/quickbase-js/quickbaseClientHttpMethods.test.ts +0 -141
  147. package/tests/vitest/unit/quickbase-js/rateLimit.test.ts +0 -191
  148. package/tests/vitest/unit/quickbase-js/tokenLifespan.test.ts +0 -204
  149. package/tests/vitest/unit/records/deleteRecords.test.ts +0 -112
  150. package/tests/vitest/unit/records/runQuery.test.ts +0 -101
  151. package/tests/vitest/unit/records/upsert.test.ts +0 -234
  152. package/tests/vitest/unit/tables/createRelationship.test.ts +0 -212
  153. package/tests/vitest/unit/tables/createTable.test.ts +0 -70
  154. package/tests/vitest/unit/tables/deleteRelationship.test.ts +0 -97
  155. package/tests/vitest/unit/tables/deleteTable.test.ts +0 -77
  156. package/tests/vitest/unit/tables/getAppTables.test.ts +0 -85
  157. package/tests/vitest/unit/tables/getRelationships.test.ts +0 -259
  158. package/tests/vitest/unit/tables/getTable.test.ts +0 -233
  159. package/tests/vitest/unit/tables/updateRelationship.test.ts +0 -307
  160. package/tests/vitest/unit/tables/updateTable.test.ts +0 -80
  161. package/tools/log-gen.ts +0 -251
  162. package/tools/log-gen.yaml +0 -4829
  163. package/tools/openapi-jars/openapi-generator-cli-7.12.0.jar +0 -0
  164. package/tsconfig.build.json +0 -17
  165. package/tsconfig.json +0 -32
  166. package/versionrc.json +0 -9
  167. package/vitest.config.ts +0 -27
package/specs/split/apps.json DELETED
@@ -1,1315 +0,0 @@
1
- {
2
- "swagger": "2.0",
3
- "info": {
4
- "title": "Quick Base API",
5
- "version": "1.0.0"
6
- },
7
- "paths": {
8
- "/apps": {
9
- "post": {
10
- "description": "Creates an application in an account. You must have application creation rights in the respective account. Main properties and application variables can be set with this API.",
11
- "summary": "Create an app",
12
- "operationId": "createApp",
13
- "consumes": [
14
- "application/json"
15
- ],
16
- "produces": [
17
- "application/json"
18
- ],
19
- "parameters": [
20
- {
21
- "name": "QB-Realm-Hostname",
22
- "in": "header",
23
- "required": true,
24
- "description": "Your Quickbase domain, for example demo.quickbase.com",
25
- "type": "string"
26
- },
27
- {
28
- "name": "User-Agent",
29
- "in": "header",
30
- "required": false,
31
- "description": "Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting.",
32
- "type": "string"
33
- },
34
- {
35
- "name": "Authorization",
36
- "in": "header",
37
- "required": true,
38
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
39
- "type": "string"
40
- },
41
- {
42
- "name": "generated",
43
- "in": "body",
44
- "schema": {
45
- "description": "The example below shows all the properties that can be set with this request. Additional properties that you can see, with the corresponding GET request, cannot be set through this API. See individual property descriptions below for details on how to set or change each.",
46
- "example": {
47
- "value": {
48
- "name": "My App",
49
- "description": "My first app",
50
- "assignToken": true,
51
- "securityProperties": {
52
- "allowClone": false,
53
- "allowExport": false,
54
- "enableAppTokens": false,
55
- "hideFromPublic": false,
56
- "mustBeRealmApproved": true,
57
- "useIPFilter": true
58
- },
59
- "variables": [
60
- {
61
- "name": "Variable1",
62
- "value": "Value1"
63
- }
64
- ]
65
- }
66
- },
67
- "type": "object",
68
- "additionalProperties": false,
69
- "required": [
70
- "name"
71
- ],
72
- "properties": {
73
- "assignToken": {
74
- "description": "Set to true if you would like to assign the app to the user token you used to create the application. The default is false.",
75
- "example": false,
76
- "type": "boolean"
77
- },
78
- "variables": {
79
- "description": "The app variables. A maximum of 10 variables can be inserted at a time. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)",
80
- "type": "array",
81
- "items": {
82
- "type": "object",
83
- "additionalProperties": false,
84
- "required": [
85
- "name",
86
- "value"
87
- ],
88
- "properties": {
89
- "name": {
90
- "description": "The name for the variable.",
91
- "type": "string"
92
- },
93
- "value": {
94
- "description": "The value for the variable.",
95
- "type": "string"
96
- }
97
- }
98
- }
99
- },
100
- "name": {
101
- "description": "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.",
102
- "type": "string"
103
- },
104
- "securityProperties": {
105
- "description": "Application security properties.",
106
- "type": "object",
107
- "additionalProperties": false,
108
- "properties": {
109
- "hideFromPublic": {
110
- "description": "Hide from public application searches",
111
- "type": "boolean"
112
- },
113
- "mustBeRealmApproved": {
114
- "description": "Only \"approved\" users may access this application",
115
- "type": "boolean"
116
- },
117
- "allowClone": {
118
- "description": "Allow users who are not administrators to copy",
119
- "type": "boolean"
120
- },
121
- "useIPFilter": {
122
- "description": "Only users logging in from \"approved\" IP addresses may access this application",
123
- "type": "boolean"
124
- },
125
- "allowExport": {
126
- "description": "Allow users who are not administrators to export data",
127
- "type": "boolean"
128
- },
129
- "enableAppTokens": {
130
- "description": "Require Application Tokens",
131
- "type": "boolean"
132
- }
133
- }
134
- },
135
- "description": {
136
- "description": "The description for the app. If this property is left out, the app description will be blank.",
137
- "type": "string"
138
- }
139
- }
140
- }
141
- }
142
- ],
143
- "responses": {
144
- "200": {
145
- "description": "Success",
146
- "x-amf-mediaType": "application/json",
147
- "schema": {
148
- "x-amf-examples": {
149
- "Simple Application": {
150
- "created": "2020-03-27T18:34:12Z",
151
- "dateFormat": "MM-DD-YYYY",
152
- "description": "My testing app",
153
- "hasEveryoneOnTheInternet": true,
154
- "id": "bpqe82s1",
155
- "memoryInfo": {
156
- "estMemory": 1,
157
- "estMemoryInclDependentApps": 2
158
- },
159
- "name": "Testing App",
160
- "securityProperties": {
161
- "allowClone": false,
162
- "allowExport": false,
163
- "enableAppTokens": false,
164
- "hideFromPublic": false,
165
- "mustBeRealmApproved": true,
166
- "useIPFilter": true
167
- },
168
- "timeZone": "(UTC-08:00) Pacific Time (US & Canada)",
169
- "updated": "2020-04-03T19:12:20Z",
170
- "dataClassification": "Confidential"
171
- },
172
- "Application with defined variables": {
173
- "description": "This examples shows the response of an application that contains one or more variables.",
174
- "value": {
175
- "created": "2020-03-27T18:34:12Z",
176
- "dateFormat": "MM-DD-YYYY",
177
- "description": "My testing app",
178
- "hasEveryoneOnTheInternet": true,
179
- "id": "bpqe82s1",
180
- "memoryInfo": {
181
- "estMemory": 1,
182
- "estMemoryInclDependentApps": 2
183
- },
184
- "name": "Testing App",
185
- "securityProperties": {
186
- "allowClone": false,
187
- "allowExport": false,
188
- "enableAppTokens": false,
189
- "hideFromPublic": false,
190
- "mustBeRealmApproved": true,
191
- "useIPFilter": true
192
- },
193
- "timeZone": "(UTC-08:00) Pacific Time (US & Canada)",
194
- "variables": [
195
- {
196
- "name": "Project End Date",
197
- "value": "7-16-2025"
198
- },
199
- {
200
- "name": "Project Manager Email",
201
- "value": "p.diaz@company.com"
202
- }
203
- ],
204
- "updated": "2020-04-03T19:12:20Z"
205
- }
206
- }
207
- },
208
- "type": "object",
209
- "additionalProperties": true,
210
- "required": [
211
- "name"
212
- ],
213
- "properties": {
214
- "name": {
215
- "description": "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.",
216
- "type": "string"
217
- },
218
- "description": {
219
- "description": "The description for the app. If this property is left out, the app description will be blank.",
220
- "type": "string"
221
- },
222
- "created": {
223
- "description": "The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).",
224
- "type": "string"
225
- },
226
- "updated": {
227
- "description": "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).",
228
- "type": "string"
229
- },
230
- "dateFormat": {
231
- "description": "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.",
232
- "type": "string"
233
- },
234
- "timeZone": {
235
- "description": "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.",
236
- "type": "string"
237
- },
238
- "memoryInfo": {
239
- "type": "object",
240
- "description": "Application memory info",
241
- "additionalProperties": false,
242
- "properties": {
243
- "estMemory": {
244
- "type": "number",
245
- "description": "The estimated memory of this application in gigabytes"
246
- },
247
- "estMemoryInclDependentApps": {
248
- "type": "number",
249
- "description": "The estimated memory of this application and all dependent applications in gigabytes"
250
- }
251
- }
252
- },
253
- "id": {
254
- "description": "The unique identifier for this application.",
255
- "type": "string"
256
- },
257
- "hasEveryoneOnTheInternet": {
258
- "description": "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)",
259
- "type": "boolean"
260
- },
261
- "variables": {
262
- "description": "The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)",
263
- "type": "array",
264
- "items": {
265
- "type": "object",
266
- "additionalProperties": true,
267
- "properties": {
268
- "name": {
269
- "description": "Variable name.",
270
- "type": "string"
271
- },
272
- "value": {
273
- "description": "Variable value.",
274
- "type": "string"
275
- }
276
- }
277
- }
278
- },
279
- "dataClassification": {
280
- "description": "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.",
281
- "type": "string"
282
- },
283
- "securityProperties": {
284
- "description": "Security properties of the application",
285
- "type": "object",
286
- "additionalProperties": true,
287
- "properties": {
288
- "allowClone": {
289
- "description": "Allow users who are not administrators to copy",
290
- "type": "boolean"
291
- },
292
- "allowExport": {
293
- "description": "Allow users who are not administrators to export data",
294
- "type": "boolean"
295
- },
296
- "hideFromPublic": {
297
- "description": "Hide from public application searches",
298
- "type": "boolean"
299
- },
300
- "enableAppTokens": {
301
- "description": "Require Application Tokens",
302
- "type": "boolean"
303
- },
304
- "useIPFilter": {
305
- "description": "Only users logging in from \"approved\" IP addresses may access this application",
306
- "type": "boolean"
307
- },
308
- "mustBeRealmApproved": {
309
- "description": "Only \"approved\" users may access this application",
310
- "type": "boolean"
311
- }
312
- }
313
- }
314
- }
315
- }
316
- }
317
- },
318
- "tags": [
319
- "Apps"
320
- ]
321
- }
322
- },
323
- "/apps/{appId}": {
324
- "get": {
325
- "description": "Returns the main properties of an application, including application variables.",
326
- "summary": "Get an app",
327
- "operationId": "getApp",
328
- "consumes": [
329
- "application/json"
330
- ],
331
- "produces": [
332
- "application/json"
333
- ],
334
- "parameters": [
335
- {
336
- "name": "appId",
337
- "in": "path",
338
- "required": true,
339
- "description": "The unique identifier of an app",
340
- "type": "string"
341
- },
342
- {
343
- "name": "QB-Realm-Hostname",
344
- "in": "header",
345
- "required": true,
346
- "description": "Your Quickbase domain, for example demo.quickbase.com",
347
- "type": "string"
348
- },
349
- {
350
- "name": "User-Agent",
351
- "in": "header",
352
- "required": false,
353
- "description": "Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting.",
354
- "type": "string"
355
- },
356
- {
357
- "name": "Authorization",
358
- "in": "header",
359
- "required": true,
360
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
361
- "type": "string"
362
- }
363
- ],
364
- "responses": {
365
- "200": {
366
- "description": "Success",
367
- "x-amf-mediaType": "application/json",
368
- "schema": {
369
- "x-amf-examples": {
370
- "Simple Application": {
371
- "ancestorId": "bqhskthaq",
372
- "created": "2020-03-27T18:34:12Z",
373
- "dateFormat": "MM-DD-YYYY",
374
- "description": "My testing app",
375
- "hasEveryoneOnTheInternet": true,
376
- "memoryInfo": {
377
- "estMemory": 1,
378
- "estMemoryInclDependentApps": 2
379
- },
380
- "id": "bpqe82s1",
381
- "name": "Testing App",
382
- "securityProperties": {
383
- "allowClone": false,
384
- "allowExport": false,
385
- "enableAppTokens": false,
386
- "hideFromPublic": false,
387
- "mustBeRealmApproved": true,
388
- "useIPFilter": true
389
- },
390
- "timeZone": "(UTC-08:00) Pacific Time (US & Canada)",
391
- "updated": "2020-04-03T19:12:20Z",
392
- "dataClassification": "Confidential"
393
- },
394
- "Application with defined variables": {
395
- "description": "This examples shows the response of an application that contains one or more variables.",
396
- "value": {
397
- "ancestorId": "bqhskthaq",
398
- "created": "2020-03-27T18:34:12Z",
399
- "dateFormat": "MM-DD-YYYY",
400
- "description": "My testing app",
401
- "hasEveryoneOnTheInternet": true,
402
- "id": "bpqe82s1",
403
- "memoryInfo": {
404
- "estMemory": 1,
405
- "estMemoryInclDependentApps": 2
406
- },
407
- "name": "Testing App",
408
- "securityProperties": {
409
- "allowClone": false,
410
- "allowExport": false,
411
- "enableAppTokens": false,
412
- "hideFromPublic": false,
413
- "mustBeRealmApproved": true,
414
- "useIPFilter": true
415
- },
416
- "timeZone": "(UTC-08:00) Pacific Time (US & Canada)",
417
- "variables": [
418
- {
419
- "name": "Project End Date",
420
- "value": "7-16-2025"
421
- },
422
- {
423
- "name": "Project Manager Email",
424
- "value": "p.diaz@company.com"
425
- }
426
- ],
427
- "updated": "2020-04-03T19:12:20Z"
428
- }
429
- }
430
- },
431
- "type": "object",
432
- "additionalProperties": true,
433
- "required": [
434
- "name"
435
- ],
436
- "properties": {
437
- "ancestorId": {
438
- "description": "The id of the app from which this app was copied",
439
- "type": "string"
440
- },
441
- "name": {
442
- "description": "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.",
443
- "type": "string"
444
- },
445
- "description": {
446
- "description": "The description for the app. If this property is left out, the app description will be blank.",
447
- "type": "string"
448
- },
449
- "created": {
450
- "description": "The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).",
451
- "type": "string"
452
- },
453
- "updated": {
454
- "description": "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).",
455
- "type": "string"
456
- },
457
- "dateFormat": {
458
- "description": "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.",
459
- "type": "string"
460
- },
461
- "timeZone": {
462
- "description": "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.",
463
- "type": "string"
464
- },
465
- "memoryInfo": {
466
- "type": "object",
467
- "description": "Application memory info",
468
- "additionalProperties": false,
469
- "properties": {
470
- "estMemory": {
471
- "type": "number",
472
- "description": "The estimated memory of this application in gigabytes"
473
- },
474
- "estMemoryInclDependentApps": {
475
- "type": "number",
476
- "description": "The estimated memory of this application and all dependent applications in gigabytes"
477
- }
478
- }
479
- },
480
- "id": {
481
- "description": "The unique identifier for this application.",
482
- "type": "string"
483
- },
484
- "hasEveryoneOnTheInternet": {
485
- "description": "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)",
486
- "type": "boolean"
487
- },
488
- "variables": {
489
- "description": "The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)",
490
- "type": "array",
491
- "items": {
492
- "type": "object",
493
- "additionalProperties": true,
494
- "properties": {
495
- "name": {
496
- "description": "Variable name.",
497
- "type": "string"
498
- },
499
- "value": {
500
- "description": "Variable value.",
501
- "type": "string"
502
- }
503
- }
504
- }
505
- },
506
- "dataClassification": {
507
- "description": "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.",
508
- "type": "string"
509
- },
510
- "securityProperties": {
511
- "description": "Security properties of the application",
512
- "type": "object",
513
- "additionalProperties": true,
514
- "properties": {
515
- "allowClone": {
516
- "description": "Allow users who are not administrators to copy",
517
- "type": "boolean"
518
- },
519
- "allowExport": {
520
- "description": "Allow users who are not administrators to export data",
521
- "type": "boolean"
522
- },
523
- "hideFromPublic": {
524
- "description": "Hide from public application searches",
525
- "type": "boolean"
526
- },
527
- "enableAppTokens": {
528
- "description": "Require Application Tokens",
529
- "type": "boolean"
530
- },
531
- "useIPFilter": {
532
- "description": "Only users logging in from \"approved\" IP addresses may access this application",
533
- "type": "boolean"
534
- },
535
- "mustBeRealmApproved": {
536
- "description": "Only \"approved\" users may access this application",
537
- "type": "boolean"
538
- }
539
- }
540
- }
541
- }
542
- }
543
- }
544
- },
545
- "tags": [
546
- "Apps"
547
- ]
548
- },
549
- "post": {
550
- "description": "Updates the main properties and/or application variables for a specific application. Any properties of the app that you do not specify in the request body will remain unchanged.",
551
- "summary": "Update an app",
552
- "operationId": "updateApp",
553
- "consumes": [
554
- "application/json"
555
- ],
556
- "produces": [
557
- "application/json"
558
- ],
559
- "parameters": [
560
- {
561
- "name": "appId",
562
- "in": "path",
563
- "required": true,
564
- "description": "The unique identifier of an app",
565
- "type": "string"
566
- },
567
- {
568
- "name": "QB-Realm-Hostname",
569
- "in": "header",
570
- "required": true,
571
- "description": "Your Quickbase domain, for example demo.quickbase.com",
572
- "type": "string"
573
- },
574
- {
575
- "name": "User-Agent",
576
- "in": "header",
577
- "required": false,
578
- "description": "Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting.",
579
- "type": "string"
580
- },
581
- {
582
- "name": "Authorization",
583
- "in": "header",
584
- "required": true,
585
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
586
- "type": "string"
587
- },
588
- {
589
- "name": "generated",
590
- "in": "body",
591
- "schema": {
592
- "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. See individual property descriptions below for details on how to set or change each.",
593
- "example": {
594
- "value": {
595
- "name": "My App",
596
- "description": "My first app",
597
- "variables": [
598
- {
599
- "name": "Variable1",
600
- "value": "Value1"
601
- }
602
- ]
603
- }
604
- },
605
- "type": "object",
606
- "additionalProperties": false,
607
- "properties": {
608
- "variables": {
609
- "description": "The app variables. A maximum of 10 variables can be updated at a time. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)",
610
- "type": "array",
611
- "items": {
612
- "type": "object",
613
- "additionalProperties": false,
614
- "required": [
615
- "name",
616
- "value"
617
- ],
618
- "properties": {
619
- "name": {
620
- "description": "The name for the variable.",
621
- "type": "string"
622
- },
623
- "value": {
624
- "description": "The value for the variable.",
625
- "type": "string"
626
- }
627
- }
628
- }
629
- },
630
- "name": {
631
- "description": "The name for the app.",
632
- "type": "string"
633
- },
634
- "securityProperties": {
635
- "description": "Security properties of the application",
636
- "type": "object",
637
- "additionalProperties": false,
638
- "properties": {
639
- "hideFromPublic": {
640
- "description": "Hide from public application searches",
641
- "type": "boolean"
642
- },
643
- "mustBeRealmApproved": {
644
- "description": "Only \"approved\" users may access this application",
645
- "type": "boolean"
646
- },
647
- "allowClone": {
648
- "description": "Allow users who are not administrators to copy",
649
- "type": "boolean"
650
- },
651
- "useIPFilter": {
652
- "description": "Only users logging in from \"approved\" IP addresses may access this application",
653
- "type": "boolean"
654
- },
655
- "allowExport": {
656
- "description": "Allow users who are not administrators to export data",
657
- "type": "boolean"
658
- },
659
- "enableAppTokens": {
660
- "description": "Require Application Tokens",
661
- "type": "boolean"
662
- }
663
- }
664
- },
665
- "description": {
666
- "description": "The description for the app.",
667
- "type": "string"
668
- }
669
- }
670
- }
671
- }
672
- ],
673
- "responses": {
674
- "200": {
675
- "description": "Success",
676
- "x-amf-mediaType": "application/json",
677
- "schema": {
678
- "x-amf-examples": {
679
- "Simple Application": {
680
- "ancestorId": "bqhskthaq",
681
- "created": "2020-03-27T18:34:12Z",
682
- "dateFormat": "MM-DD-YYYY",
683
- "description": "My testing app",
684
- "hasEveryoneOnTheInternet": true,
685
- "memoryInfo": {
686
- "estMemory": 1,
687
- "estMemoryInclDependentApps": 2
688
- },
689
- "id": "bpqe82s1",
690
- "name": "Testing App",
691
- "securityProperties": {
692
- "allowClone": false,
693
- "allowExport": false,
694
- "enableAppTokens": false,
695
- "hideFromPublic": false,
696
- "mustBeRealmApproved": true,
697
- "useIPFilter": true
698
- },
699
- "timeZone": "(UTC-08:00) Pacific Time (US & Canada)",
700
- "updated": "2020-04-03T19:12:20Z",
701
- "dataClassification": "Confidential"
702
- },
703
- "Application with defined variables": {
704
- "description": "This examples shows the response of an application that contains one or more variables.",
705
- "value": {
706
- "ancestorId": "bqhskthaq",
707
- "created": "2020-03-27T18:34:12Z",
708
- "dateFormat": "MM-DD-YYYY",
709
- "description": "My testing app",
710
- "hasEveryoneOnTheInternet": true,
711
- "id": "bpqe82s1",
712
- "memoryInfo": {
713
- "estMemory": 1,
714
- "estMemoryInclDependentApps": 2
715
- },
716
- "name": "Testing App",
717
- "securityProperties": {
718
- "allowClone": false,
719
- "allowExport": false,
720
- "enableAppTokens": false,
721
- "hideFromPublic": false,
722
- "mustBeRealmApproved": true,
723
- "useIPFilter": true
724
- },
725
- "timeZone": "(UTC-08:00) Pacific Time (US & Canada)",
726
- "variables": [
727
- {
728
- "name": "Project End Date",
729
- "value": "7-16-2025"
730
- },
731
- {
732
- "name": "Project Manager Email",
733
- "value": "p.diaz@company.com"
734
- }
735
- ],
736
- "updated": "2020-04-03T19:12:20Z"
737
- }
738
- }
739
- },
740
- "type": "object",
741
- "additionalProperties": true,
742
- "required": [
743
- "name"
744
- ],
745
- "properties": {
746
- "ancestorId": {
747
- "description": "The id of the app from which this app was copied",
748
- "type": "string"
749
- },
750
- "name": {
751
- "description": "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.",
752
- "type": "string"
753
- },
754
- "description": {
755
- "description": "The description for the app. If this property is left out, the app description will be blank.",
756
- "type": "string"
757
- },
758
- "created": {
759
- "description": "The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).",
760
- "type": "string"
761
- },
762
- "updated": {
763
- "description": "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).",
764
- "type": "string"
765
- },
766
- "dateFormat": {
767
- "description": "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.",
768
- "type": "string"
769
- },
770
- "timeZone": {
771
- "description": "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.",
772
- "type": "string"
773
- },
774
- "memoryInfo": {
775
- "description": "Application memory info",
776
- "type": "object",
777
- "additionalProperties": false,
778
- "properties": {
779
- "estMemory": {
780
- "type": "number",
781
- "description": "The estimated memory of this application in gigabytes"
782
- },
783
- "estMemoryInclDependentApps": {
784
- "type": "number",
785
- "description": "The estimated memory of this application and all dependent applications in gigabytes"
786
- }
787
- }
788
- },
789
- "id": {
790
- "description": "The unique identifier for this application.",
791
- "type": "string"
792
- },
793
- "hasEveryoneOnTheInternet": {
794
- "description": "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)",
795
- "type": "boolean"
796
- },
797
- "variables": {
798
- "description": "The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)",
799
- "type": "array",
800
- "items": {
801
- "type": "object",
802
- "additionalProperties": true,
803
- "properties": {
804
- "name": {
805
- "description": "Variable name.",
806
- "type": "string"
807
- },
808
- "value": {
809
- "description": "Variable value.",
810
- "type": "string"
811
- }
812
- }
813
- }
814
- },
815
- "dataClassification": {
816
- "description": "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.",
817
- "type": "string"
818
- },
819
- "securityProperties": {
820
- "description": "Security properties of the application",
821
- "type": "object",
822
- "additionalProperties": true,
823
- "properties": {
824
- "allowClone": {
825
- "description": "Allow users who are not administrators to copy",
826
- "type": "boolean"
827
- },
828
- "allowExport": {
829
- "description": "Allow users who are not administrators to export data",
830
- "type": "boolean"
831
- },
832
- "hideFromPublic": {
833
- "description": "Hide from public application searches",
834
- "type": "boolean"
835
- },
836
- "enableAppTokens": {
837
- "description": "Require Application Tokens",
838
- "type": "boolean"
839
- },
840
- "useIPFilter": {
841
- "description": "Only users logging in from \"approved\" IP addresses may access this application",
842
- "type": "boolean"
843
- },
844
- "mustBeRealmApproved": {
845
- "description": "Only \"approved\" users may access this application",
846
- "type": "boolean"
847
- }
848
- }
849
- }
850
- }
851
- }
852
- }
853
- },
854
- "tags": [
855
- "Apps"
856
- ]
857
- },
858
- "delete": {
859
- "description": "Deletes an entire application, including all of the tables and data.",
860
- "summary": "Delete an app",
861
- "operationId": "deleteApp",
862
- "consumes": [
863
- "application/json"
864
- ],
865
- "produces": [
866
- "application/json"
867
- ],
868
- "parameters": [
869
- {
870
- "name": "appId",
871
- "in": "path",
872
- "required": true,
873
- "description": "The unique identifier of an app",
874
- "type": "string"
875
- },
876
- {
877
- "name": "QB-Realm-Hostname",
878
- "in": "header",
879
- "required": true,
880
- "description": "Your Quickbase domain, for example demo.quickbase.com",
881
- "type": "string"
882
- },
883
- {
884
- "name": "User-Agent",
885
- "in": "header",
886
- "required": false,
887
- "description": "Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting.",
888
- "type": "string"
889
- },
890
- {
891
- "name": "Authorization",
892
- "in": "header",
893
- "required": true,
894
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
895
- "type": "string"
896
- },
897
- {
898
- "name": "generated",
899
- "in": "body",
900
- "schema": {
901
- "example": {
902
- "name": "Name of an application to delete"
903
- },
904
- "type": "object",
905
- "additionalProperties": false,
906
- "required": [
907
- "name"
908
- ],
909
- "properties": {
910
- "name": {
911
- "description": "To confirm application deletion we ask for application name.",
912
- "type": "string"
913
- }
914
- }
915
- }
916
- }
917
- ],
918
- "responses": {
919
- "200": {
920
- "description": "Success",
921
- "x-amf-mediaType": "application/json",
922
- "schema": {
923
- "example": {
924
- "deletedAppId": "bqhskthaq"
925
- },
926
- "type": "object",
927
- "additionalProperties": true,
928
- "properties": {
929
- "deletedAppId": {
930
- "description": "An ID of deleted application.",
931
- "type": "string"
932
- }
933
- }
934
- }
935
- }
936
- },
937
- "tags": [
938
- "Apps"
939
- ]
940
- }
941
- },
942
- "/apps/{appId}/events": {
943
- "get": {
944
- "description": "Get a list of events that can be triggered based on data or user actions in this application, includes: Email notification, Reminders, Subscriptions, QB Actions, Webhooks, record change triggered Automations (does not include scheduled).",
945
- "summary": "Get app events",
946
- "operationId": "getAppEvents",
947
- "consumes": [
948
- "application/json"
949
- ],
950
- "produces": [
951
- "application/json"
952
- ],
953
- "parameters": [
954
- {
955
- "name": "appId",
956
- "in": "path",
957
- "required": true,
958
- "description": "The unique identifier of an app",
959
- "type": "string"
960
- },
961
- {
962
- "name": "QB-Realm-Hostname",
963
- "in": "header",
964
- "required": true,
965
- "description": "Your Quickbase domain, for example demo.quickbase.com",
966
- "type": "string"
967
- },
968
- {
969
- "name": "User-Agent",
970
- "in": "header",
971
- "required": false,
972
- "description": "Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting.",
973
- "type": "string"
974
- },
975
- {
976
- "name": "Authorization",
977
- "in": "header",
978
- "required": true,
979
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
980
- "type": "string"
981
- }
982
- ],
983
- "responses": {
984
- "200": {
985
- "description": "Success",
986
- "x-amf-mediaType": "application/json",
987
- "schema": {
988
- "example": [
989
- {
990
- "type": "qb-action",
991
- "owner": {
992
- "email": "jsmith@quickbase.com",
993
- "id": "123456.ab1s",
994
- "name": "Juliet Smith",
995
- "userName": "jsmith"
996
- },
997
- "isActive": true,
998
- "tableId": "bqwriv8bw",
999
- "name": "Quick Base Action"
1000
- },
1001
- {
1002
- "type": "webhook",
1003
- "owner": {
1004
- "email": "tanderson@quickbase.com",
1005
- "id": "654321.ab1s",
1006
- "name": "Thomas A. Anderson",
1007
- "userName": "tanderson"
1008
- },
1009
- "isActive": false,
1010
- "tableId": "bqwriv8bw",
1011
- "name": "Webhook"
1012
- },
1013
- {
1014
- "type": "email-notification",
1015
- "owner": {
1016
- "email": "jsmith@quickbase.com",
1017
- "id": "123456.ab1s",
1018
- "name": "Juliet Smith",
1019
- "userName": "jsmith"
1020
- },
1021
- "isActive": false,
1022
- "tableId": "bqwriv8bw",
1023
- "name": "Notification"
1024
- },
1025
- {
1026
- "type": "subscription",
1027
- "owner": {
1028
- "email": "tanderson@quickbase.com",
1029
- "id": "654321.ab1s",
1030
- "name": "Thomas A. Anderson",
1031
- "userName": "tanderson"
1032
- },
1033
- "isActive": true,
1034
- "tableId": "bqwriv8bw",
1035
- "name": "Subscription"
1036
- },
1037
- {
1038
- "type": "reminder",
1039
- "owner": {
1040
- "email": "jsmith@quickbase.com",
1041
- "id": "123456.ab1s",
1042
- "name": "Juliet Smith",
1043
- "userName": "jsmith"
1044
- },
1045
- "isActive": true,
1046
- "tableId": "bqwriv8bw",
1047
- "name": "Reminder"
1048
- },
1049
- {
1050
- "type": "automation",
1051
- "owner": {
1052
- "email": "tanderson@quickbase.com",
1053
- "id": "654321.ab1s",
1054
- "name": "Thomas A. Anderson",
1055
- "userName": "tanderson"
1056
- },
1057
- "isActive": true,
1058
- "tableId": "bqwriv8bw",
1059
- "url": "https://realm.quickbase.com/ui/automation/qb/db/bqwria893/automations/70eecab9-634f-42d9-9037-9340a1a9e8ce"
1060
- }
1061
- ],
1062
- "type": "array",
1063
- "items": {
1064
- "type": "object",
1065
- "additionalProperties": true,
1066
- "properties": {
1067
- "isActive": {
1068
- "description": "Indication of whether current event is active.",
1069
- "type": "boolean"
1070
- },
1071
- "type": {
1072
- "description": "Type of an event.",
1073
- "enum": [
1074
- "webhook",
1075
- "qb-action",
1076
- "email-notification",
1077
- "subscription",
1078
- "reminder",
1079
- "automation"
1080
- ],
1081
- "type": "string"
1082
- },
1083
- "name": {
1084
- "description": "The name of the event. This property is not returned for automations.",
1085
- "type": "string"
1086
- },
1087
- "url": {
1088
- "description": "The url to automation that can be accessed from the browser. Only returned for automations.",
1089
- "type": "string"
1090
- },
1091
- "owner": {
1092
- "description": "The user that owns the event.",
1093
- "type": "object",
1094
- "additionalProperties": true,
1095
- "properties": {
1096
- "name": {
1097
- "description": "User full name.",
1098
- "type": "string"
1099
- },
1100
- "id": {
1101
- "description": "User Id.",
1102
- "type": "string"
1103
- },
1104
- "email": {
1105
- "description": "User email.",
1106
- "type": "string"
1107
- },
1108
- "userName": {
1109
- "description": "User Name as updated in user properties. Optional, appears if not the same as user email.",
1110
- "type": "string"
1111
- }
1112
- }
1113
- },
1114
- "tableId": {
1115
- "description": "The unique identifier of the table to which event belongs to.",
1116
- "type": "string"
1117
- }
1118
- }
1119
- }
1120
- }
1121
- }
1122
- },
1123
- "tags": [
1124
- "Apps"
1125
- ]
1126
- }
1127
- },
1128
- "/apps/{appId}/copy": {
1129
- "post": {
1130
- "description": "Copies the specified application. The new application will have the same schema as the original. See below for additional copy options.",
1131
- "summary": "Copy an app",
1132
- "operationId": "copyApp",
1133
- "consumes": [
1134
- "application/json"
1135
- ],
1136
- "produces": [
1137
- "application/json"
1138
- ],
1139
- "parameters": [
1140
- {
1141
- "name": "appId",
1142
- "in": "path",
1143
- "required": true,
1144
- "description": "The unique identifier of an app",
1145
- "type": "string"
1146
- },
1147
- {
1148
- "name": "QB-Realm-Hostname",
1149
- "in": "header",
1150
- "required": true,
1151
- "description": "Your Quickbase domain, for example demo.quickbase.com",
1152
- "type": "string"
1153
- },
1154
- {
1155
- "name": "User-Agent",
1156
- "in": "header",
1157
- "required": false,
1158
- "description": "Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting.",
1159
- "type": "string"
1160
- },
1161
- {
1162
- "name": "Authorization",
1163
- "in": "header",
1164
- "required": true,
1165
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
1166
- "type": "string"
1167
- },
1168
- {
1169
- "name": "generated",
1170
- "in": "body",
1171
- "schema": {
1172
- "example": {
1173
- "name": "my copied app",
1174
- "description": "copied from my original app",
1175
- "properties": {
1176
- "keepData": false,
1177
- "excludeFiles": true,
1178
- "usersAndRoles": false,
1179
- "assignUserToken": true
1180
- }
1181
- },
1182
- "type": "object",
1183
- "additionalProperties": false,
1184
- "required": [
1185
- "name"
1186
- ],
1187
- "properties": {
1188
- "name": {
1189
- "description": "The name of the newly copied app",
1190
- "type": "string"
1191
- },
1192
- "description": {
1193
- "description": "The description of the newly copied app",
1194
- "type": "string"
1195
- },
1196
- "properties": {
1197
- "description": "The configuration properties for performing the app copy",
1198
- "type": "object",
1199
- "additionalProperties": false,
1200
- "properties": {
1201
- "assignUserToken": {
1202
- "description": "Whether to add the user token used to make this request to the new app",
1203
- "type": "boolean"
1204
- },
1205
- "excludeFiles": {
1206
- "description": "If keepData is true, whether to copy the file attachments as well. If keepData is false, this property is ignored",
1207
- "type": "boolean"
1208
- },
1209
- "keepData": {
1210
- "description": "Whether to copy the app's data along with the schema",
1211
- "type": "boolean"
1212
- },
1213
- "usersAndRoles": {
1214
- "description": "If true, users will be copied along with their assigned roles. If false, users and roles will be copied but roles will not be assigned",
1215
- "type": "boolean"
1216
- }
1217
- }
1218
- }
1219
- }
1220
- }
1221
- }
1222
- ],
1223
- "responses": {
1224
- "200": {
1225
- "description": "Success",
1226
- "x-amf-mediaType": "application/json",
1227
- "schema": {
1228
- "example": {
1229
- "ancestorId": "bqhskthaq",
1230
- "created": "2020-03-27T18:34:12Z",
1231
- "dateFormat": "MM-DD-YYYY",
1232
- "description": "My testing app",
1233
- "hasEveryoneOnTheInternet": true,
1234
- "id": "bpqe82s1",
1235
- "name": "Testing App",
1236
- "timeZone": "(UTC-08:00) Pacific Time (US & Canada)",
1237
- "updated": "2020-04-03T19:12:20Z",
1238
- "dataClassification": "None"
1239
- },
1240
- "type": "object",
1241
- "additionalProperties": true,
1242
- "required": [
1243
- "name"
1244
- ],
1245
- "properties": {
1246
- "name": {
1247
- "description": "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.",
1248
- "type": "string"
1249
- },
1250
- "description": {
1251
- "description": "The description for the app",
1252
- "type": "string"
1253
- },
1254
- "created": {
1255
- "description": "The time and date the app was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).",
1256
- "type": "string"
1257
- },
1258
- "updated": {
1259
- "description": "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).",
1260
- "type": "string"
1261
- },
1262
- "dateFormat": {
1263
- "description": "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.",
1264
- "type": "string"
1265
- },
1266
- "timeZone": {
1267
- "description": "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.",
1268
- "type": "string"
1269
- },
1270
- "id": {
1271
- "description": "The unique identifier for this application.",
1272
- "type": "string"
1273
- },
1274
- "hasEveryoneOnTheInternet": {
1275
- "description": "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)",
1276
- "type": "boolean"
1277
- },
1278
- "variables": {
1279
- "description": "The app variables. See [About Application Variables](https://help.quickbase.com/user-assistance/variables.html)",
1280
- "type": "array",
1281
- "items": {
1282
- "type": "object",
1283
- "additionalProperties": true,
1284
- "properties": {
1285
- "name": {
1286
- "description": "Variable name.",
1287
- "type": "string"
1288
- },
1289
- "value": {
1290
- "description": "Variable value.",
1291
- "type": "string"
1292
- }
1293
- }
1294
- }
1295
- },
1296
- "ancestorId": {
1297
- "description": "The id of the app from which this app was copied",
1298
- "type": "string"
1299
- },
1300
- "dataClassification": {
1301
- "description": "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.",
1302
- "type": "string"
1303
- }
1304
- }
1305
- }
1306
- }
1307
- },
1308
- "tags": [
1309
- "Apps"
1310
- ]
1311
- }
1312
- }
1313
- },
1314
- "definitions": {}
1315
- }