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/fields.json DELETED
@@ -1,3869 +0,0 @@
1
- {
2
- "swagger": "2.0",
3
- "info": {
4
- "title": "Quick Base API",
5
- "version": "1.0.0"
6
- },
7
- "paths": {
8
- "/fields": {
9
- "get": {
10
- "description": "Gets the properties for all fields in a specific table. The properties for each field are the same as in Get field.",
11
- "summary": "Get fields for a table",
12
- "operationId": "getFields",
13
- "consumes": [
14
- "application/json"
15
- ],
16
- "produces": [
17
- "application/json"
18
- ],
19
- "parameters": [
20
- {
21
- "name": "tableId",
22
- "in": "query",
23
- "required": true,
24
- "description": "The unique identifier (dbid) of the table.",
25
- "type": "string"
26
- },
27
- {
28
- "name": "includeFieldPerms",
29
- "in": "query",
30
- "required": false,
31
- "description": "Set to 'true' if you'd like to get back the custom permissions for the field(s).",
32
- "type": "boolean"
33
- },
34
- {
35
- "name": "QB-Realm-Hostname",
36
- "in": "header",
37
- "required": true,
38
- "description": "Your Quickbase domain, for example demo.quickbase.com",
39
- "type": "string"
40
- },
41
- {
42
- "name": "User-Agent",
43
- "in": "header",
44
- "required": false,
45
- "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.",
46
- "type": "string"
47
- },
48
- {
49
- "name": "Authorization",
50
- "in": "header",
51
- "required": true,
52
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
53
- "type": "string"
54
- }
55
- ],
56
- "responses": {
57
- "200": {
58
- "description": "Success",
59
- "x-amf-mediaType": "application/json",
60
- "schema": {
61
- "example": [
62
- {
63
- "id": 1,
64
- "label": "Field1",
65
- "fieldType": "text",
66
- "noWrap": false,
67
- "bold": false,
68
- "required": false,
69
- "appearsByDefault": false,
70
- "findEnabled": false,
71
- "unique": false,
72
- "doesDataCopy": false,
73
- "fieldHelp": "field help",
74
- "audited": false,
75
- "properties": {
76
- "primaryKey": false,
77
- "foreignKey": false,
78
- "numLines": 1,
79
- "maxLength": 0,
80
- "appendOnly": false,
81
- "allowHTML": false,
82
- "allowMentions": false,
83
- "sortAsGiven": false,
84
- "carryChoices": true,
85
- "allowNewChoices": false,
86
- "formula": "",
87
- "defaultValue": ""
88
- },
89
- "permissions": [
90
- {
91
- "permissionType": "View",
92
- "role": "Viewer",
93
- "roleId": 10
94
- },
95
- {
96
- "permissionType": "None",
97
- "role": "Participant",
98
- "roleId": 11
99
- },
100
- {
101
- "permissionType": "Modify",
102
- "role": "Administrator",
103
- "roleId": 12
104
- }
105
- ]
106
- },
107
- {
108
- "id": 2,
109
- "label": "Numeric Field",
110
- "fieldType": "numeric",
111
- "appearsByDefault": true,
112
- "audited": false,
113
- "bold": false,
114
- "fieldHelp": "This is a numeric field",
115
- "findEnabled": false,
116
- "addToForms": true,
117
- "properties": {
118
- "numberFormat": 3,
119
- "decimalPlaces": 2,
120
- "doesAverage": true,
121
- "doesTotal": true,
122
- "blankIsZero": true
123
- },
124
- "permissions": [
125
- {
126
- "role": "Viewer",
127
- "permissionType": "View",
128
- "roleId": 10
129
- },
130
- {
131
- "role": "Participant",
132
- "permissionType": "Modify",
133
- "roleId": 11
134
- },
135
- {
136
- "role": "Administrator",
137
- "permissionType": "Modify",
138
- "roleId": 12
139
- }
140
- ]
141
- }
142
- ],
143
- "type": "array",
144
- "items": {
145
- "example": {
146
- "id": 123,
147
- "label": "Field1",
148
- "fieldType": "text",
149
- "mode": "",
150
- "noWrap": false,
151
- "bold": false,
152
- "required": false,
153
- "appearsByDefault": false,
154
- "findEnabled": false,
155
- "unique": false,
156
- "doesDataCopy": false,
157
- "fieldHelp": "field help",
158
- "audited": false,
159
- "properties": {
160
- "primaryKey": false,
161
- "foreignKey": false,
162
- "numLines": 1,
163
- "maxLength": 0,
164
- "appendOnly": false,
165
- "allowHTML": false,
166
- "allowMentions": false,
167
- "sortAsGiven": false,
168
- "carryChoices": true,
169
- "allowNewChoices": false,
170
- "formula": "",
171
- "defaultValue": ""
172
- },
173
- "permissions": [
174
- {
175
- "permissionType": "View",
176
- "role": "Viewer",
177
- "roleId": 10
178
- },
179
- {
180
- "permissionType": "None",
181
- "role": "Participant",
182
- "roleId": 11
183
- },
184
- {
185
- "permissionType": "Modify",
186
- "role": "Administrator",
187
- "roleId": 12
188
- }
189
- ]
190
- },
191
- "type": "object",
192
- "additionalProperties": true,
193
- "required": [
194
- "id"
195
- ],
196
- "properties": {
197
- "id": {
198
- "description": "The id of the field, unique to this table.",
199
- "type": "integer",
200
- "format": "int64"
201
- },
202
- "fieldType": {
203
- "description": "The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html).",
204
- "type": "string"
205
- },
206
- "mode": {
207
- "description": "For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank.",
208
- "type": "string"
209
- },
210
- "label": {
211
- "description": "The label (name) of the field.",
212
- "type": "string"
213
- },
214
- "noWrap": {
215
- "description": "Indicates if the field is configured to not wrap when displayed in the product.",
216
- "type": "boolean"
217
- },
218
- "bold": {
219
- "description": "Indicates if the field is configured to display in bold in the product.",
220
- "type": "boolean"
221
- },
222
- "required": {
223
- "description": "Indicates if the field is marked required.",
224
- "type": "boolean"
225
- },
226
- "appearsByDefault": {
227
- "description": "Indicates if the field is marked as a default in reports.",
228
- "type": "boolean"
229
- },
230
- "findEnabled": {
231
- "description": "Indicates if the field is marked as searchable.",
232
- "type": "boolean"
233
- },
234
- "unique": {
235
- "description": "Indicates if the field is marked unique.",
236
- "type": "boolean"
237
- },
238
- "doesDataCopy": {
239
- "description": "Indicates if the field data will copy when a user copies the record.",
240
- "type": "boolean"
241
- },
242
- "fieldHelp": {
243
- "description": "The configured help text shown to users within the product.",
244
- "type": "string"
245
- },
246
- "audited": {
247
- "description": "Indicates if the field is being tracked as part of Quickbase Audit Logs.",
248
- "type": "boolean"
249
- },
250
- "properties": {
251
- "description": "Additional properties for the field. Please see [Field type details](../fieldInfo) page for more details on the properties for each field type.",
252
- "type": "object",
253
- "additionalProperties": true,
254
- "properties": {
255
- "allowMentions": {
256
- "description": "If someone can @mention users in the rich text field to generate an email notification.",
257
- "type": "boolean"
258
- },
259
- "comments": {
260
- "description": "The comments entered on the field properties by an administrator.",
261
- "type": "string"
262
- },
263
- "doesTotal": {
264
- "description": "Whether this field totals in reports within the product.",
265
- "type": "boolean"
266
- },
267
- "autoSave": {
268
- "description": "Whether the link field will auto save.",
269
- "type": "boolean"
270
- },
271
- "defaultValueLuid": {
272
- "description": "Default user id value.",
273
- "type": "integer"
274
- },
275
- "useI18NFormat": {
276
- "description": "Whether phone numbers should be in E.164 standard international format.",
277
- "type": "boolean"
278
- },
279
- "maxVersions": {
280
- "description": "The maximum number of versions configured for a file attachment.",
281
- "type": "integer"
282
- },
283
- "carryChoices": {
284
- "description": "Whether the field should carry its multiple choice fields when copied.",
285
- "type": "boolean"
286
- },
287
- "format": {
288
- "description": "The format to display time.",
289
- "type": "integer"
290
- },
291
- "maxLength": {
292
- "description": "The maximum number of characters allowed for entry in Quickbase for this field.",
293
- "type": "integer"
294
- },
295
- "linkText": {
296
- "description": "The configured text value that replaces the URL that users see within the product.",
297
- "type": "string"
298
- },
299
- "parentFieldId": {
300
- "description": "The id of the parent composite field, when applicable.",
301
- "type": "integer"
302
- },
303
- "displayTimezone": {
304
- "description": "Indicates whether to display the timezone within the product.",
305
- "type": "boolean"
306
- },
307
- "summaryTargetFieldId": {
308
- "description": "The id of the field that is used to aggregate values from the child, when applicable. This displays 0 if the summary function doesn’t require a field selection (like count).",
309
- "type": "integer"
310
- },
311
- "allowNewChoices": {
312
- "description": "Indicates if users can add new choices to a selection list.",
313
- "type": "boolean"
314
- },
315
- "masterChoiceFieldId": {
316
- "description": "The id of the field that is the reference in the relationship.",
317
- "type": "integer"
318
- },
319
- "defaultToday": {
320
- "description": "Indicates if the field value is defaulted today for new records.",
321
- "type": "boolean"
322
- },
323
- "units": {
324
- "description": "The units label.",
325
- "type": "string"
326
- },
327
- "lookupTargetFieldId": {
328
- "description": "The id of the field that is the target on the master table for this lookup.",
329
- "type": "integer"
330
- },
331
- "summaryFunction": {
332
- "description": "The summary accumulation function type.",
333
- "enum": [
334
- "AVG",
335
- "SUM",
336
- "MAX",
337
- "MIN",
338
- "STD-DEV",
339
- "COUNT",
340
- "COMBINED-TEXT",
341
- "COMBINED-USER",
342
- "DISTINCT-COUNT"
343
- ],
344
- "type": "string"
345
- },
346
- "sourceFieldId": {
347
- "description": "The id of the source field.",
348
- "type": "integer"
349
- },
350
- "masterTableTag": {
351
- "description": "The table alias for the master table in the relationship this field is part of.",
352
- "type": "string"
353
- },
354
- "doesAverage": {
355
- "description": "Whether this field averages in reports within the product.",
356
- "type": "boolean"
357
- },
358
- "formula": {
359
- "description": "The formula of the field as configured in Quickbase.",
360
- "type": "string"
361
- },
362
- "decimalPlaces": {
363
- "description": "The number of decimal places displayed in the product for this field.",
364
- "type": "integer"
365
- },
366
- "defaultCountryCode": {
367
- "description": "Controls the default country shown on international phone widgets on forms. Country code should be entered in the ISO 3166-1 alpha-2 format.",
368
- "type": "string"
369
- },
370
- "seeVersions": {
371
- "description": "Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.",
372
- "type": "boolean"
373
- },
374
- "displayMonth": {
375
- "description": "How to display months.",
376
- "type": "string"
377
- },
378
- "numLines": {
379
- "description": "The number of lines shown in Quickbase for this text field.",
380
- "type": "integer"
381
- },
382
- "displayEmail": {
383
- "description": "How the email is displayed.",
384
- "type": "string"
385
- },
386
- "defaultKind": {
387
- "description": "The user default type.",
388
- "type": "string"
389
- },
390
- "coverText": {
391
- "description": "An alternate user friendly text that can be used to display a link in the browser.",
392
- "type": "string"
393
- },
394
- "currencySymbol": {
395
- "description": "The current symbol used when displaying field values within the product.",
396
- "type": "string"
397
- },
398
- "masterChoiceTableId": {
399
- "description": "The id of the table that is the master in this relationship.",
400
- "type": "string"
401
- },
402
- "targetFieldId": {
403
- "description": "The id of the target field.",
404
- "type": "integer"
405
- },
406
- "displayUser": {
407
- "description": "The configured option for how users display within the product.",
408
- "type": "string"
409
- },
410
- "blankIsZero": {
411
- "description": "Whether a blank value is treated the same as 0 in calculations within the product.",
412
- "type": "boolean"
413
- },
414
- "exact": {
415
- "description": "Whether an exact match is required for a report link.",
416
- "type": "boolean"
417
- },
418
- "startField": {
419
- "description": "The start field id.",
420
- "type": "integer"
421
- },
422
- "defaultDomain": {
423
- "description": "Default email domain.",
424
- "type": "string"
425
- },
426
- "defaultValue": {
427
- "description": "The default value configured for a field when a new record is added.",
428
- "type": "string"
429
- },
430
- "choicesLuid": {
431
- "description": "List of user choices.",
432
- "type": "array"
433
- },
434
- "abbreviate": {
435
- "description": "Don't show the URL protocol when showing the URL.",
436
- "type": "boolean"
437
- },
438
- "xmlTag": {
439
- "description": "The field's xml tag.",
440
- "type": "string"
441
- },
442
- "targetTableName": {
443
- "description": "The field's target table name.",
444
- "type": "string"
445
- },
446
- "numberFormat": {
447
- "description": "The format used for displaying numeric values in the product (decimal, separators, digit group).",
448
- "type": "integer"
449
- },
450
- "appearsAs": {
451
- "description": "The link text, if empty, the url will be used as link text.",
452
- "type": "string"
453
- },
454
- "width": {
455
- "description": "The field's html input width in the product.",
456
- "type": "integer"
457
- },
458
- "currencyFormat": {
459
- "description": "The currency format used when displaying field values within the product.",
460
- "enum": [
461
- "left",
462
- "right",
463
- "middle"
464
- ],
465
- "type": "string"
466
- },
467
- "foreignKey": {
468
- "description": "Indicates if the field is a foreign key (or reference field) in a relationship.",
469
- "type": "boolean"
470
- },
471
- "displayDayOfWeek": {
472
- "description": "Indicates whether to display the day of the week within the product.",
473
- "type": "boolean"
474
- },
475
- "summaryReferenceFieldId": {
476
- "description": "The id of the field that is the reference in the relationship for this summary.",
477
- "type": "integer",
478
- "format": "int64"
479
- },
480
- "commaStart": {
481
- "description": "The number of digits before commas display in the product, when applicable.",
482
- "type": "integer"
483
- },
484
- "choices": {
485
- "description": "An array of entries that exist for a field that offers choices to the user.",
486
- "type": "array",
487
- "items": {
488
- "type": "string"
489
- }
490
- },
491
- "targetTableId": {
492
- "description": "The id of the target table.",
493
- "type": "string"
494
- },
495
- "displayRelative": {
496
- "description": "Whether to display time as relative.",
497
- "type": "boolean"
498
- },
499
- "compositeFields": {
500
- "description": "An array of the fields that make up a composite field (e.g., address).",
501
- "type": "array"
502
- },
503
- "displayCheckboxAsText": {
504
- "description": "Indicates whether the checkbox values will be shown as text in reports.",
505
- "type": "boolean"
506
- },
507
- "versionMode": {
508
- "description": "Version modes for files. Keep all versions vs keep last version.",
509
- "enum": [
510
- "keepallversions",
511
- "keeplastversions"
512
- ],
513
- "type": "string"
514
- },
515
- "displayTime": {
516
- "description": "Indicates whether to display the time, in addition to the date.",
517
- "type": "boolean"
518
- },
519
- "durationField": {
520
- "description": "The duration field id.",
521
- "type": "integer"
522
- },
523
- "snapFieldId": {
524
- "description": "The id of the field that is used to snapshot values from, when applicable.",
525
- "type": "integer"
526
- },
527
- "hours24": {
528
- "description": "Indicates whether or not to display time in the 24-hour format within the product.",
529
- "type": "boolean"
530
- },
531
- "sortAlpha": {
532
- "description": "Whether to sort alphabetically, default sort is by record ID.",
533
- "type": "boolean"
534
- },
535
- "sortAsGiven": {
536
- "description": "Indicates if the listed entries sort as entered vs alphabetically.",
537
- "type": "boolean"
538
- },
539
- "hasExtension": {
540
- "description": "Whether this field has a phone extension.",
541
- "type": "boolean"
542
- },
543
- "workWeek": {
544
- "description": "The work week type.",
545
- "type": "integer"
546
- },
547
- "useNewWindow": {
548
- "description": "Indicates if the URL should open a new window when a user clicks it within the product.",
549
- "type": "boolean"
550
- },
551
- "appendOnly": {
552
- "description": "Whether this field is append only.",
553
- "type": "boolean"
554
- },
555
- "displayAsLink": {
556
- "description": "Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.",
557
- "type": "boolean"
558
- },
559
- "allowHTML": {
560
- "description": "Whether this field allows html.",
561
- "type": "boolean"
562
- },
563
- "lookupReferenceFieldId": {
564
- "description": "The id of the field that is the reference in the relationship for this lookup.",
565
- "type": "integer"
566
- }
567
- }
568
- },
569
- "permissions": {
570
- "description": "Field Permissions for different roles.",
571
- "type": "array",
572
- "items": {
573
- "type": "object",
574
- "additionalProperties": false,
575
- "properties": {
576
- "role": {
577
- "description": "The role associated with a given permission for the field",
578
- "type": "string"
579
- },
580
- "permissionType": {
581
- "description": "The permission given to the role for this field",
582
- "type": "string"
583
- },
584
- "roleId": {
585
- "description": "The Id of the given role",
586
- "type": "integer"
587
- }
588
- }
589
- }
590
- }
591
- }
592
- }
593
- }
594
- }
595
- },
596
- "tags": [
597
- "Fields"
598
- ]
599
- },
600
- "post": {
601
- "description": "Creates a field within a table, including the custom permissions of that field.",
602
- "summary": "Create a field",
603
- "operationId": "createField",
604
- "consumes": [
605
- "application/json"
606
- ],
607
- "produces": [
608
- "application/json"
609
- ],
610
- "parameters": [
611
- {
612
- "name": "tableId",
613
- "in": "query",
614
- "required": true,
615
- "description": "The unique identifier of the table.",
616
- "type": "string"
617
- },
618
- {
619
- "name": "QB-Realm-Hostname",
620
- "in": "header",
621
- "required": true,
622
- "description": "Your Quickbase domain, for example demo.quickbase.com",
623
- "type": "string"
624
- },
625
- {
626
- "name": "User-Agent",
627
- "in": "header",
628
- "required": false,
629
- "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.",
630
- "type": "string"
631
- },
632
- {
633
- "name": "Authorization",
634
- "in": "header",
635
- "required": true,
636
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
637
- "type": "string"
638
- },
639
- {
640
- "name": "generated",
641
- "in": "body",
642
- "schema": {
643
- "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.",
644
- "example": {
645
- "label": "Field1",
646
- "fieldType": "text",
647
- "noWrap": false,
648
- "bold": false,
649
- "appearsByDefault": false,
650
- "findEnabled": false,
651
- "fieldHelp": "field help",
652
- "addToForms": true,
653
- "properties": {
654
- "maxLength": 0,
655
- "appendOnly": false,
656
- "sortAsGiven": false
657
- },
658
- "permissions": [
659
- {
660
- "role": "Viewer",
661
- "permissionType": "View",
662
- "roleId": 10
663
- },
664
- {
665
- "role": "Participant",
666
- "permissionType": "None",
667
- "roleId": 11
668
- },
669
- {
670
- "role": "Administrator",
671
- "permissionType": "Modify",
672
- "roleId": 12
673
- }
674
- ]
675
- },
676
- "type": "object",
677
- "additionalProperties": false,
678
- "required": [
679
- "fieldType",
680
- "label"
681
- ],
682
- "properties": {
683
- "audited": {
684
- "description": "Indicates if the field is being tracked as part of Quickbase Audit Logs. You can only set this property to \"true\" if the app has audit logs enabled. See Enable data change logs under [Quickbase Audit Logs](https://help.quickbase.com/user-assistance/audit_logs.html). Defaults to false.",
685
- "type": "boolean"
686
- },
687
- "fieldHelp": {
688
- "description": "The configured help text shown to users within the product.",
689
- "type": "string"
690
- },
691
- "bold": {
692
- "description": "Indicates if the field is configured to display in bold in the product. Defaults to false.",
693
- "type": "boolean"
694
- },
695
- "properties": {
696
- "description": "Specific field properties.",
697
- "type": "object",
698
- "additionalProperties": false,
699
- "properties": {
700
- "allowMentions": {
701
- "description": "If someone can @mention users in the rich text field to generate an email notification.",
702
- "type": "boolean"
703
- },
704
- "comments": {
705
- "description": "The comments entered on the field properties by an administrator.",
706
- "type": "string"
707
- },
708
- "doesTotal": {
709
- "description": "Whether this field totals in reports within the product.",
710
- "type": "boolean"
711
- },
712
- "autoSave": {
713
- "description": "Whether the link field will auto save.",
714
- "type": "boolean"
715
- },
716
- "defaultValueLuid": {
717
- "description": "Default user id value.",
718
- "type": "integer"
719
- },
720
- "useI18NFormat": {
721
- "description": "Whether phone numbers should be in E.164 standard international format",
722
- "type": "boolean"
723
- },
724
- "maxVersions": {
725
- "description": "The maximum number of versions configured for a file attachment.",
726
- "type": "integer",
727
- "format": "int32",
728
- "minimum": 1
729
- },
730
- "format": {
731
- "description": "The format to display time.",
732
- "type": "integer"
733
- },
734
- "carryChoices": {
735
- "description": "Whether the field should carry its multiple choice fields when copied.",
736
- "type": "boolean"
737
- },
738
- "maxLength": {
739
- "description": "The maximum number of characters allowed for entry in Quickbase for this field.",
740
- "type": "integer"
741
- },
742
- "linkText": {
743
- "description": "The configured text value that replaces the URL that users see within the product.",
744
- "type": "string"
745
- },
746
- "parentFieldId": {
747
- "description": "The id of the parent composite field, when applicable.",
748
- "type": "integer"
749
- },
750
- "displayTimezone": {
751
- "description": "Indicates whether to display the timezone within the product.",
752
- "type": "boolean"
753
- },
754
- "allowNewChoices": {
755
- "description": "Indicates if users can add new choices to a selection list.",
756
- "type": "boolean"
757
- },
758
- "defaultToday": {
759
- "description": "Indicates if the field value is defaulted today for new records.",
760
- "type": "boolean"
761
- },
762
- "units": {
763
- "description": "The units label.",
764
- "type": "string"
765
- },
766
- "openTargetIn": {
767
- "description": "Indicates which target the URL should open in when a user clicks it within the product.",
768
- "enum": [
769
- "sameWindow",
770
- "newWindow",
771
- "popup"
772
- ],
773
- "type": "string"
774
- },
775
- "sourceFieldId": {
776
- "description": "The id of the source field.",
777
- "type": "integer"
778
- },
779
- "doesAverage": {
780
- "description": "Whether this field averages in reports within the product.",
781
- "type": "boolean"
782
- },
783
- "formula": {
784
- "description": "The formula of the field as configured in Quickbase.",
785
- "type": "string"
786
- },
787
- "decimalPlaces": {
788
- "description": "The number of decimal places displayed in the product for this field.",
789
- "type": "integer"
790
- },
791
- "defaultCountryCode": {
792
- "description": "Controls the default country shown on international phone widgets on forms. Country code should be entered in the ISO 3166-1 alpha-2 format.",
793
- "type": "string"
794
- },
795
- "displayMonth": {
796
- "description": "How to display months.",
797
- "type": "string"
798
- },
799
- "seeVersions": {
800
- "description": "Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.",
801
- "type": "boolean"
802
- },
803
- "numLines": {
804
- "description": "The number of lines shown in Quickbase for this text field.",
805
- "type": "integer"
806
- },
807
- "defaultKind": {
808
- "description": "The user default type.",
809
- "type": "string"
810
- },
811
- "displayEmail": {
812
- "description": "How the email is displayed.",
813
- "type": "string"
814
- },
815
- "coverText": {
816
- "description": "An alternate user friendly text that can be used to display a link in the browser.",
817
- "type": "string"
818
- },
819
- "currencySymbol": {
820
- "description": "The current symbol used when displaying field values within the product.",
821
- "type": "string"
822
- },
823
- "targetFieldId": {
824
- "description": "The id of the target field.",
825
- "type": "integer"
826
- },
827
- "displayUser": {
828
- "description": "The configured option for how users display within the product.",
829
- "type": "string"
830
- },
831
- "blankIsZero": {
832
- "description": "Whether a blank value is treated the same as 0 in calculations within the product.",
833
- "type": "boolean"
834
- },
835
- "exact": {
836
- "description": "Whether an exact match is required for a report link.",
837
- "type": "boolean"
838
- },
839
- "defaultDomain": {
840
- "description": "Default email domain.",
841
- "type": "string"
842
- },
843
- "defaultValue": {
844
- "description": "The default value configured for a field when a new record is added.",
845
- "type": "string"
846
- },
847
- "abbreviate": {
848
- "description": "Don't show the URL protocol when showing the URL.",
849
- "type": "boolean"
850
- },
851
- "numberFormat": {
852
- "description": "The format used for displaying numeric values in the product (decimal, separators, digit group).",
853
- "type": "integer"
854
- },
855
- "targetTableName": {
856
- "description": "The field's target table name.",
857
- "type": "string"
858
- },
859
- "appearsAs": {
860
- "description": "The link text, if empty, the url will be used as link text.",
861
- "type": "string"
862
- },
863
- "width": {
864
- "description": "The field's html input width in the product.",
865
- "type": "integer"
866
- },
867
- "currencyFormat": {
868
- "description": "The currency format used when displaying field values within the product.",
869
- "enum": [
870
- "left",
871
- "right",
872
- "middle"
873
- ],
874
- "type": "string"
875
- },
876
- "displayDayOfWeek": {
877
- "description": "Indicates whether to display the day of the week within the product.",
878
- "type": "boolean"
879
- },
880
- "commaStart": {
881
- "description": "The number of digits before commas display in the product, when applicable.",
882
- "type": "integer"
883
- },
884
- "choices": {
885
- "description": "An array of entries that exist for a field that offers choices to the user. Note that these choices refer to the valid values of any records added in the future. You are allowed to remove values from the list of choices even if there are existing records with those values in this field. They will be displayed in red when users look at the data in the browser but there is no other effect. While updating a field with this property, the old choices are removed and replaced by the new choices.",
886
- "type": "array",
887
- "items": {
888
- "type": "string"
889
- }
890
- },
891
- "targetTableId": {
892
- "description": "The id of the target table.",
893
- "type": "string"
894
- },
895
- "displayRelative": {
896
- "description": "Whether to display time as relative.",
897
- "type": "boolean"
898
- },
899
- "compositeFields": {
900
- "description": "An array of the fields that make up a composite field (e.g., address).",
901
- "type": "array"
902
- },
903
- "displayCheckboxAsText": {
904
- "description": "Indicates whether the checkbox values will be shown as text in reports.",
905
- "type": "boolean"
906
- },
907
- "displayTime": {
908
- "description": "Indicates whether to display the time, in addition to the date.",
909
- "type": "boolean"
910
- },
911
- "versionMode": {
912
- "description": "Version modes for files. Keep all versions vs keep last version.",
913
- "enum": [
914
- "keepallversions",
915
- "keeplastversions"
916
- ],
917
- "type": "string"
918
- },
919
- "snapFieldId": {
920
- "description": "The id of the field that is used to snapshot values from, when applicable.",
921
- "type": "integer"
922
- },
923
- "hours24": {
924
- "description": "Indicates whether or not to display time in the 24-hour format within the product.",
925
- "type": "boolean"
926
- },
927
- "sortAlpha": {
928
- "description": "Whether to sort alphabetically, default sort is by record ID.",
929
- "type": "boolean"
930
- },
931
- "sortAsGiven": {
932
- "description": "Indicates if the listed entries sort as entered vs alphabetically.",
933
- "type": "boolean"
934
- },
935
- "hasExtension": {
936
- "description": "Whether this field has a phone extension.",
937
- "type": "boolean"
938
- },
939
- "useNewWindow": {
940
- "description": "Indicates if the file should open a new window when a user clicks it within the product.",
941
- "type": "boolean"
942
- },
943
- "appendOnly": {
944
- "description": "Whether this field is append only.",
945
- "type": "boolean"
946
- },
947
- "displayAsLink": {
948
- "description": "Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.",
949
- "type": "boolean"
950
- }
951
- }
952
- },
953
- "appearsByDefault": {
954
- "description": "Indicates if the field is marked as a default in reports. Defaults to true.",
955
- "type": "boolean"
956
- },
957
- "fieldType": {
958
- "description": "The [field types](https://help.quickbase.com/user-assistance/field_types.html), click on any of the field type links for more info.",
959
- "enum": [
960
- "text",
961
- "text-multiple-choice",
962
- "text-multi-line",
963
- "rich-text",
964
- "numeric",
965
- "currency",
966
- "rating",
967
- "percent",
968
- "multitext",
969
- "email",
970
- "url",
971
- "duration",
972
- "date",
973
- "datetime",
974
- "timestamp",
975
- "timeofday",
976
- "checkbox",
977
- "user",
978
- "multiuser",
979
- "address",
980
- "phone",
981
- "file"
982
- ],
983
- "type": "string"
984
- },
985
- "permissions": {
986
- "description": "Field Permissions for different roles.",
987
- "type": "array",
988
- "items": {
989
- "type": "object",
990
- "additionalProperties": false,
991
- "properties": {
992
- "role": {
993
- "description": "The role associated with a given permission for the field",
994
- "type": "string"
995
- },
996
- "permissionType": {
997
- "description": "The permission given to the role for this field",
998
- "type": "string"
999
- },
1000
- "roleId": {
1001
- "description": "The Id of the given role",
1002
- "type": "integer"
1003
- }
1004
- }
1005
- }
1006
- },
1007
- "addToForms": {
1008
- "description": "Whether the field you are adding should appear on forms. Defaults to false.",
1009
- "type": "boolean"
1010
- },
1011
- "label": {
1012
- "description": "The label (name) of the field.",
1013
- "type": "string"
1014
- },
1015
- "findEnabled": {
1016
- "description": "Indicates if the field is marked as searchable. Defaults to true.",
1017
- "type": "boolean"
1018
- },
1019
- "noWrap": {
1020
- "description": "Indicates if the field is configured to not wrap when displayed in the product. Defaults to false.",
1021
- "type": "boolean"
1022
- }
1023
- }
1024
- }
1025
- }
1026
- ],
1027
- "responses": {
1028
- "200": {
1029
- "description": "Success",
1030
- "x-amf-mediaType": "application/json",
1031
- "schema": {
1032
- "example": {
1033
- "id": 123,
1034
- "label": "Field1",
1035
- "fieldType": "text",
1036
- "mode": "",
1037
- "noWrap": false,
1038
- "bold": false,
1039
- "required": false,
1040
- "appearsByDefault": false,
1041
- "findEnabled": false,
1042
- "unique": false,
1043
- "doesDataCopy": false,
1044
- "fieldHelp": "field help",
1045
- "audited": false,
1046
- "properties": {
1047
- "primaryKey": false,
1048
- "foreignKey": false,
1049
- "numLines": 1,
1050
- "maxLength": 0,
1051
- "appendOnly": false,
1052
- "allowHTML": false,
1053
- "allowMentions": false,
1054
- "sortAsGiven": false,
1055
- "carryChoices": true,
1056
- "allowNewChoices": false,
1057
- "formula": "",
1058
- "defaultValue": ""
1059
- },
1060
- "permissions": [
1061
- {
1062
- "permissionType": "View",
1063
- "role": "Viewer",
1064
- "roleId": 10
1065
- },
1066
- {
1067
- "permissionType": "None",
1068
- "role": "Participant",
1069
- "roleId": 11
1070
- },
1071
- {
1072
- "permissionType": "Modify",
1073
- "role": "Administrator",
1074
- "roleId": 12
1075
- }
1076
- ]
1077
- },
1078
- "type": "object",
1079
- "additionalProperties": true,
1080
- "required": [
1081
- "id"
1082
- ],
1083
- "properties": {
1084
- "id": {
1085
- "description": "The id of the field, unique to this table.",
1086
- "type": "integer",
1087
- "format": "int64"
1088
- },
1089
- "fieldType": {
1090
- "description": "The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html).",
1091
- "type": "string"
1092
- },
1093
- "mode": {
1094
- "description": "For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank.",
1095
- "type": "string"
1096
- },
1097
- "label": {
1098
- "description": "The label (name) of the field.",
1099
- "type": "string"
1100
- },
1101
- "noWrap": {
1102
- "description": "Indicates if the field is configured to not wrap when displayed in the product.",
1103
- "type": "boolean"
1104
- },
1105
- "bold": {
1106
- "description": "Indicates if the field is configured to display in bold in the product.",
1107
- "type": "boolean"
1108
- },
1109
- "required": {
1110
- "description": "Indicates if the field is marked required.",
1111
- "type": "boolean"
1112
- },
1113
- "appearsByDefault": {
1114
- "description": "Indicates if the field is marked as a default in reports.",
1115
- "type": "boolean"
1116
- },
1117
- "findEnabled": {
1118
- "description": "Indicates if the field is marked as searchable.",
1119
- "type": "boolean"
1120
- },
1121
- "unique": {
1122
- "description": "Indicates if the field is marked unique.",
1123
- "type": "boolean"
1124
- },
1125
- "doesDataCopy": {
1126
- "description": "Indicates if the field data will copy when a user copies the record.",
1127
- "type": "boolean"
1128
- },
1129
- "fieldHelp": {
1130
- "description": "The configured help text shown to users within the product.",
1131
- "type": "string"
1132
- },
1133
- "audited": {
1134
- "description": "Indicates if the field is being tracked as part of Quickbase Audit Logs.",
1135
- "type": "boolean"
1136
- },
1137
- "properties": {
1138
- "description": "Additional properties for the field. Please see [Field type details](../fieldInfo) page for more details on the properties for each field type.",
1139
- "type": "object",
1140
- "additionalProperties": true,
1141
- "properties": {
1142
- "allowMentions": {
1143
- "description": "If someone can @mention users in the rich text field to generate an email notification.",
1144
- "type": "boolean"
1145
- },
1146
- "comments": {
1147
- "description": "The comments entered on the field properties by an administrator.",
1148
- "type": "string"
1149
- },
1150
- "doesTotal": {
1151
- "description": "Whether this field totals in reports within the product.",
1152
- "type": "boolean"
1153
- },
1154
- "autoSave": {
1155
- "description": "Whether the link field will auto save.",
1156
- "type": "boolean"
1157
- },
1158
- "defaultValueLuid": {
1159
- "description": "Default user id value.",
1160
- "type": "integer"
1161
- },
1162
- "useI18NFormat": {
1163
- "description": "Whether phone numbers should be in E.164 standard international format.",
1164
- "type": "boolean"
1165
- },
1166
- "maxVersions": {
1167
- "description": "The maximum number of versions configured for a file attachment.",
1168
- "type": "integer"
1169
- },
1170
- "carryChoices": {
1171
- "description": "Whether the field should carry its multiple choice fields when copied.",
1172
- "type": "boolean"
1173
- },
1174
- "format": {
1175
- "description": "The format to display time.",
1176
- "type": "integer"
1177
- },
1178
- "maxLength": {
1179
- "description": "The maximum number of characters allowed for entry in Quickbase for this field.",
1180
- "type": "integer"
1181
- },
1182
- "linkText": {
1183
- "description": "The configured text value that replaces the URL that users see within the product.",
1184
- "type": "string"
1185
- },
1186
- "parentFieldId": {
1187
- "description": "The id of the parent composite field, when applicable.",
1188
- "type": "integer"
1189
- },
1190
- "displayTimezone": {
1191
- "description": "Indicates whether to display the timezone within the product.",
1192
- "type": "boolean"
1193
- },
1194
- "summaryTargetFieldId": {
1195
- "description": "The id of the field that is used to aggregate values from the child, when applicable. This displays 0 if the summary function doesn’t require a field selection (like count).",
1196
- "type": "integer"
1197
- },
1198
- "allowNewChoices": {
1199
- "description": "Indicates if users can add new choices to a selection list.",
1200
- "type": "boolean"
1201
- },
1202
- "masterChoiceFieldId": {
1203
- "description": "The id of the field that is the reference in the relationship.",
1204
- "type": "integer"
1205
- },
1206
- "defaultToday": {
1207
- "description": "Indicates if the field value is defaulted today for new records.",
1208
- "type": "boolean"
1209
- },
1210
- "units": {
1211
- "description": "The units label.",
1212
- "type": "string"
1213
- },
1214
- "lookupTargetFieldId": {
1215
- "description": "The id of the field that is the target on the master table for this lookup.",
1216
- "type": "integer"
1217
- },
1218
- "summaryFunction": {
1219
- "description": "The summary accumulation function type.",
1220
- "enum": [
1221
- "AVG",
1222
- "SUM",
1223
- "MAX",
1224
- "MIN",
1225
- "STD-DEV",
1226
- "COUNT",
1227
- "COMBINED-TEXT",
1228
- "COMBINED-USER",
1229
- "DISTINCT-COUNT"
1230
- ],
1231
- "type": "string"
1232
- },
1233
- "sourceFieldId": {
1234
- "description": "The id of the source field.",
1235
- "type": "integer"
1236
- },
1237
- "masterTableTag": {
1238
- "description": "The table alias for the master table in the relationship this field is part of.",
1239
- "type": "string"
1240
- },
1241
- "doesAverage": {
1242
- "description": "Whether this field averages in reports within the product.",
1243
- "type": "boolean"
1244
- },
1245
- "formula": {
1246
- "description": "The formula of the field as configured in Quickbase.",
1247
- "type": "string"
1248
- },
1249
- "decimalPlaces": {
1250
- "description": "The number of decimal places displayed in the product for this field.",
1251
- "type": "integer"
1252
- },
1253
- "defaultCountryCode": {
1254
- "description": "Controls the default country shown on international phone widgets on forms. Country code should be entered in the ISO 3166-1 alpha-2 format.",
1255
- "type": "string"
1256
- },
1257
- "seeVersions": {
1258
- "description": "Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.",
1259
- "type": "boolean"
1260
- },
1261
- "displayMonth": {
1262
- "description": "How to display months.",
1263
- "type": "string"
1264
- },
1265
- "numLines": {
1266
- "description": "The number of lines shown in Quickbase for this text field.",
1267
- "type": "integer"
1268
- },
1269
- "displayEmail": {
1270
- "description": "How the email is displayed.",
1271
- "type": "string"
1272
- },
1273
- "defaultKind": {
1274
- "description": "The user default type.",
1275
- "type": "string"
1276
- },
1277
- "coverText": {
1278
- "description": "An alternate user friendly text that can be used to display a link in the browser.",
1279
- "type": "string"
1280
- },
1281
- "currencySymbol": {
1282
- "description": "The current symbol used when displaying field values within the product.",
1283
- "type": "string"
1284
- },
1285
- "masterChoiceTableId": {
1286
- "description": "The id of the table that is the master in this relationship.",
1287
- "type": "string"
1288
- },
1289
- "targetFieldId": {
1290
- "description": "The id of the target field.",
1291
- "type": "integer"
1292
- },
1293
- "displayUser": {
1294
- "description": "The configured option for how users display within the product.",
1295
- "type": "string"
1296
- },
1297
- "blankIsZero": {
1298
- "description": "Whether a blank value is treated the same as 0 in calculations within the product.",
1299
- "type": "boolean"
1300
- },
1301
- "exact": {
1302
- "description": "Whether an exact match is required for a report link.",
1303
- "type": "boolean"
1304
- },
1305
- "startField": {
1306
- "description": "The start field id.",
1307
- "type": "integer"
1308
- },
1309
- "defaultDomain": {
1310
- "description": "Default email domain.",
1311
- "type": "string"
1312
- },
1313
- "defaultValue": {
1314
- "description": "The default value configured for a field when a new record is added.",
1315
- "type": "string"
1316
- },
1317
- "choicesLuid": {
1318
- "description": "List of user choices.",
1319
- "type": "array"
1320
- },
1321
- "abbreviate": {
1322
- "description": "Don't show the URL protocol when showing the URL.",
1323
- "type": "boolean"
1324
- },
1325
- "xmlTag": {
1326
- "description": "The field's xml tag.",
1327
- "type": "string"
1328
- },
1329
- "targetTableName": {
1330
- "description": "The field's target table name.",
1331
- "type": "string"
1332
- },
1333
- "numberFormat": {
1334
- "description": "The format used for displaying numeric values in the product (decimal, separators, digit group).",
1335
- "type": "integer"
1336
- },
1337
- "appearsAs": {
1338
- "description": "The link text, if empty, the url will be used as link text.",
1339
- "type": "string"
1340
- },
1341
- "width": {
1342
- "description": "The field's html input width in the product.",
1343
- "type": "integer"
1344
- },
1345
- "currencyFormat": {
1346
- "description": "The currency format used when displaying field values within the product.",
1347
- "enum": [
1348
- "left",
1349
- "right",
1350
- "middle"
1351
- ],
1352
- "type": "string"
1353
- },
1354
- "foreignKey": {
1355
- "description": "Indicates if the field is a foreign key (or reference field) in a relationship.",
1356
- "type": "boolean"
1357
- },
1358
- "displayDayOfWeek": {
1359
- "description": "Indicates whether to display the day of the week within the product.",
1360
- "type": "boolean"
1361
- },
1362
- "summaryReferenceFieldId": {
1363
- "description": "The id of the field that is the reference in the relationship for this summary.",
1364
- "type": "integer",
1365
- "format": "int64"
1366
- },
1367
- "commaStart": {
1368
- "description": "The number of digits before commas display in the product, when applicable.",
1369
- "type": "integer"
1370
- },
1371
- "choices": {
1372
- "description": "An array of entries that exist for a field that offers choices to the user.",
1373
- "type": "array",
1374
- "items": {
1375
- "type": "string"
1376
- }
1377
- },
1378
- "targetTableId": {
1379
- "description": "The id of the target table.",
1380
- "type": "string"
1381
- },
1382
- "displayRelative": {
1383
- "description": "Whether to display time as relative.",
1384
- "type": "boolean"
1385
- },
1386
- "compositeFields": {
1387
- "description": "An array of the fields that make up a composite field (e.g., address).",
1388
- "type": "array"
1389
- },
1390
- "displayCheckboxAsText": {
1391
- "description": "Indicates whether the checkbox values will be shown as text in reports.",
1392
- "type": "boolean"
1393
- },
1394
- "versionMode": {
1395
- "description": "Version modes for files. Keep all versions vs keep last version.",
1396
- "enum": [
1397
- "keepallversions",
1398
- "keeplastversions"
1399
- ],
1400
- "type": "string"
1401
- },
1402
- "displayTime": {
1403
- "description": "Indicates whether to display the time, in addition to the date.",
1404
- "type": "boolean"
1405
- },
1406
- "durationField": {
1407
- "description": "The duration field id.",
1408
- "type": "integer"
1409
- },
1410
- "snapFieldId": {
1411
- "description": "The id of the field that is used to snapshot values from, when applicable.",
1412
- "type": "integer"
1413
- },
1414
- "hours24": {
1415
- "description": "Indicates whether or not to display time in the 24-hour format within the product.",
1416
- "type": "boolean"
1417
- },
1418
- "sortAlpha": {
1419
- "description": "Whether to sort alphabetically, default sort is by record ID.",
1420
- "type": "boolean"
1421
- },
1422
- "sortAsGiven": {
1423
- "description": "Indicates if the listed entries sort as entered vs alphabetically.",
1424
- "type": "boolean"
1425
- },
1426
- "hasExtension": {
1427
- "description": "Whether this field has a phone extension.",
1428
- "type": "boolean"
1429
- },
1430
- "workWeek": {
1431
- "description": "The work week type.",
1432
- "type": "integer"
1433
- },
1434
- "useNewWindow": {
1435
- "description": "Indicates if the URL should open a new window when a user clicks it within the product.",
1436
- "type": "boolean"
1437
- },
1438
- "appendOnly": {
1439
- "description": "Whether this field is append only.",
1440
- "type": "boolean"
1441
- },
1442
- "displayAsLink": {
1443
- "description": "Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.",
1444
- "type": "boolean"
1445
- },
1446
- "allowHTML": {
1447
- "description": "Whether this field allows html.",
1448
- "type": "boolean"
1449
- },
1450
- "lookupReferenceFieldId": {
1451
- "description": "The id of the field that is the reference in the relationship for this lookup.",
1452
- "type": "integer"
1453
- }
1454
- }
1455
- },
1456
- "permissions": {
1457
- "description": "Field Permissions for different roles.",
1458
- "type": "array",
1459
- "items": {
1460
- "type": "object",
1461
- "additionalProperties": false,
1462
- "properties": {
1463
- "role": {
1464
- "description": "The role associated with a given permission for the field",
1465
- "type": "string"
1466
- },
1467
- "permissionType": {
1468
- "description": "The permission given to the role for this field",
1469
- "type": "string"
1470
- },
1471
- "roleId": {
1472
- "description": "The Id of the given role",
1473
- "type": "integer"
1474
- }
1475
- }
1476
- }
1477
- }
1478
- }
1479
- }
1480
- }
1481
- },
1482
- "tags": [
1483
- "Fields"
1484
- ]
1485
- },
1486
- "delete": {
1487
- "description": "Deletes one or many fields in a table, based on field id. This will also permanently delete any data or calculations in that field.",
1488
- "summary": "Delete field(s)",
1489
- "operationId": "deleteFields",
1490
- "consumes": [
1491
- "application/json"
1492
- ],
1493
- "produces": [
1494
- "application/json"
1495
- ],
1496
- "parameters": [
1497
- {
1498
- "name": "tableId",
1499
- "in": "query",
1500
- "required": true,
1501
- "description": "The unique identifier of the table.",
1502
- "type": "string"
1503
- },
1504
- {
1505
- "name": "QB-Realm-Hostname",
1506
- "in": "header",
1507
- "required": true,
1508
- "description": "Your Quickbase domain, for example demo.quickbase.com",
1509
- "type": "string"
1510
- },
1511
- {
1512
- "name": "User-Agent",
1513
- "in": "header",
1514
- "required": false,
1515
- "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.",
1516
- "type": "string"
1517
- },
1518
- {
1519
- "name": "Authorization",
1520
- "in": "header",
1521
- "required": true,
1522
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
1523
- "type": "string"
1524
- },
1525
- {
1526
- "name": "generated",
1527
- "in": "body",
1528
- "schema": {
1529
- "example": {
1530
- "fieldIds": [
1531
- 6,
1532
- 7,
1533
- 8
1534
- ]
1535
- },
1536
- "type": "object",
1537
- "additionalProperties": true,
1538
- "required": [
1539
- "fieldIds"
1540
- ],
1541
- "properties": {
1542
- "fieldIds": {
1543
- "description": "List of field ids to be deleted.",
1544
- "type": "array",
1545
- "items": {
1546
- "type": "integer"
1547
- }
1548
- }
1549
- }
1550
- }
1551
- }
1552
- ],
1553
- "responses": {
1554
- "200": {
1555
- "description": "Success",
1556
- "x-amf-mediaType": "application/json",
1557
- "schema": {
1558
- "example": {
1559
- "deletedFieldIds": [
1560
- 6,
1561
- 8
1562
- ],
1563
- "errors": [
1564
- "Error found with fid: 7"
1565
- ]
1566
- },
1567
- "type": "object",
1568
- "additionalProperties": true,
1569
- "required": [
1570
- "deletedFieldIds",
1571
- "errors"
1572
- ],
1573
- "properties": {
1574
- "deletedFieldIds": {
1575
- "description": "List of field ids to were deleted.",
1576
- "type": "array",
1577
- "items": {
1578
- "type": "integer"
1579
- }
1580
- },
1581
- "errors": {
1582
- "description": "List of errors found.",
1583
- "type": "array",
1584
- "items": {
1585
- "type": "string"
1586
- }
1587
- }
1588
- }
1589
- }
1590
- }
1591
- },
1592
- "tags": [
1593
- "Fields"
1594
- ]
1595
- }
1596
- },
1597
- "/fields/{fieldId}": {
1598
- "get": {
1599
- "description": "Gets the properties of an individual field, based on field id. \nProperties present on all field types are returned at the top level. Properties unique to a specific type of field are returned under the 'properties' attribute. Please see [Field types page](../fieldInfo) for more details on the properties for each field type.",
1600
- "summary": "Get field",
1601
- "operationId": "getField",
1602
- "consumes": [
1603
- "application/json"
1604
- ],
1605
- "produces": [
1606
- "application/json"
1607
- ],
1608
- "parameters": [
1609
- {
1610
- "name": "tableId",
1611
- "in": "query",
1612
- "required": true,
1613
- "description": "The unique identifier (dbid) of the table.",
1614
- "type": "string"
1615
- },
1616
- {
1617
- "name": "includeFieldPerms",
1618
- "in": "query",
1619
- "required": false,
1620
- "description": "Set to 'true' if you'd like to get back the custom permissions for the field(s).",
1621
- "type": "boolean"
1622
- },
1623
- {
1624
- "name": "fieldId",
1625
- "in": "path",
1626
- "required": true,
1627
- "description": "The unique identifier (fid) of the field.",
1628
- "type": "integer"
1629
- },
1630
- {
1631
- "name": "QB-Realm-Hostname",
1632
- "in": "header",
1633
- "required": true,
1634
- "description": "Your Quickbase domain, for example demo.quickbase.com",
1635
- "type": "string"
1636
- },
1637
- {
1638
- "name": "User-Agent",
1639
- "in": "header",
1640
- "required": false,
1641
- "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.",
1642
- "type": "string"
1643
- },
1644
- {
1645
- "name": "Authorization",
1646
- "in": "header",
1647
- "required": true,
1648
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
1649
- "type": "string"
1650
- }
1651
- ],
1652
- "responses": {
1653
- "200": {
1654
- "description": "Success",
1655
- "x-amf-mediaType": "application/json",
1656
- "schema": {
1657
- "example": {
1658
- "id": 123,
1659
- "label": "Field1",
1660
- "fieldType": "text",
1661
- "mode": "",
1662
- "noWrap": false,
1663
- "bold": false,
1664
- "required": false,
1665
- "appearsByDefault": false,
1666
- "findEnabled": false,
1667
- "unique": false,
1668
- "doesDataCopy": false,
1669
- "fieldHelp": "field help",
1670
- "audited": false,
1671
- "properties": {
1672
- "primaryKey": false,
1673
- "foreignKey": false,
1674
- "numLines": 1,
1675
- "maxLength": 0,
1676
- "appendOnly": false,
1677
- "allowHTML": false,
1678
- "allowMentions": false,
1679
- "sortAsGiven": false,
1680
- "carryChoices": true,
1681
- "allowNewChoices": false,
1682
- "formula": "",
1683
- "defaultValue": ""
1684
- },
1685
- "permissions": [
1686
- {
1687
- "permissionType": "View",
1688
- "role": "Viewer",
1689
- "roleId": 10
1690
- },
1691
- {
1692
- "permissionType": "None",
1693
- "role": "Participant",
1694
- "roleId": 11
1695
- },
1696
- {
1697
- "permissionType": "Modify",
1698
- "role": "Administrator",
1699
- "roleId": 12
1700
- }
1701
- ]
1702
- },
1703
- "type": "object",
1704
- "additionalProperties": true,
1705
- "required": [
1706
- "id"
1707
- ],
1708
- "properties": {
1709
- "id": {
1710
- "description": "The id of the field, unique to this table.",
1711
- "type": "integer",
1712
- "format": "int64"
1713
- },
1714
- "fieldType": {
1715
- "description": "The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html).",
1716
- "type": "string"
1717
- },
1718
- "mode": {
1719
- "description": "For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank.",
1720
- "type": "string"
1721
- },
1722
- "label": {
1723
- "description": "The label (name) of the field.",
1724
- "type": "string"
1725
- },
1726
- "noWrap": {
1727
- "description": "Indicates if the field is configured to not wrap when displayed in the product.",
1728
- "type": "boolean"
1729
- },
1730
- "bold": {
1731
- "description": "Indicates if the field is configured to display in bold in the product.",
1732
- "type": "boolean"
1733
- },
1734
- "required": {
1735
- "description": "Indicates if the field is marked required.",
1736
- "type": "boolean"
1737
- },
1738
- "appearsByDefault": {
1739
- "description": "Indicates if the field is marked as a default in reports.",
1740
- "type": "boolean"
1741
- },
1742
- "findEnabled": {
1743
- "description": "Indicates if the field is marked as searchable.",
1744
- "type": "boolean"
1745
- },
1746
- "unique": {
1747
- "description": "Indicates if the field is marked unique.",
1748
- "type": "boolean"
1749
- },
1750
- "doesDataCopy": {
1751
- "description": "Indicates if the field data will copy when a user copies the record.",
1752
- "type": "boolean"
1753
- },
1754
- "fieldHelp": {
1755
- "description": "The configured help text shown to users within the product.",
1756
- "type": "string"
1757
- },
1758
- "audited": {
1759
- "description": "Indicates if the field is being tracked as part of Quickbase Audit Logs.",
1760
- "type": "boolean"
1761
- },
1762
- "properties": {
1763
- "description": "Additional properties for the field. Please see [Field type details](../fieldInfo) page for more details on the properties for each field type.",
1764
- "type": "object",
1765
- "additionalProperties": true,
1766
- "properties": {
1767
- "allowMentions": {
1768
- "description": "If someone can @mention users in the rich text field to generate an email notification.",
1769
- "type": "boolean"
1770
- },
1771
- "comments": {
1772
- "description": "The comments entered on the field properties by an administrator.",
1773
- "type": "string"
1774
- },
1775
- "doesTotal": {
1776
- "description": "Whether this field totals in reports within the product.",
1777
- "type": "boolean"
1778
- },
1779
- "autoSave": {
1780
- "description": "Whether the link field will auto save.",
1781
- "type": "boolean"
1782
- },
1783
- "defaultValueLuid": {
1784
- "description": "Default user id value.",
1785
- "type": "integer"
1786
- },
1787
- "useI18NFormat": {
1788
- "description": "Whether phone numbers should be in E.164 standard international format.",
1789
- "type": "boolean"
1790
- },
1791
- "maxVersions": {
1792
- "description": "The maximum number of versions configured for a file attachment.",
1793
- "type": "integer"
1794
- },
1795
- "carryChoices": {
1796
- "description": "Whether the field should carry its multiple choice fields when copied.",
1797
- "type": "boolean"
1798
- },
1799
- "format": {
1800
- "description": "The format to display time.",
1801
- "type": "integer"
1802
- },
1803
- "maxLength": {
1804
- "description": "The maximum number of characters allowed for entry in Quickbase for this field.",
1805
- "type": "integer"
1806
- },
1807
- "linkText": {
1808
- "description": "The configured text value that replaces the URL that users see within the product.",
1809
- "type": "string"
1810
- },
1811
- "parentFieldId": {
1812
- "description": "The id of the parent composite field, when applicable.",
1813
- "type": "integer"
1814
- },
1815
- "displayTimezone": {
1816
- "description": "Indicates whether to display the timezone within the product.",
1817
- "type": "boolean"
1818
- },
1819
- "summaryTargetFieldId": {
1820
- "description": "The id of the field that is used to aggregate values from the child, when applicable. This displays 0 if the summary function doesn’t require a field selection (like count).",
1821
- "type": "integer"
1822
- },
1823
- "allowNewChoices": {
1824
- "description": "Indicates if users can add new choices to a selection list.",
1825
- "type": "boolean"
1826
- },
1827
- "masterChoiceFieldId": {
1828
- "description": "The id of the field that is the reference in the relationship.",
1829
- "type": "integer"
1830
- },
1831
- "defaultToday": {
1832
- "description": "Indicates if the field value is defaulted today for new records.",
1833
- "type": "boolean"
1834
- },
1835
- "units": {
1836
- "description": "The units label.",
1837
- "type": "string"
1838
- },
1839
- "lookupTargetFieldId": {
1840
- "description": "The id of the field that is the target on the master table for this lookup.",
1841
- "type": "integer"
1842
- },
1843
- "summaryFunction": {
1844
- "description": "The summary accumulation function type.",
1845
- "enum": [
1846
- "AVG",
1847
- "SUM",
1848
- "MAX",
1849
- "MIN",
1850
- "STD-DEV",
1851
- "COUNT",
1852
- "COMBINED-TEXT",
1853
- "COMBINED-USER",
1854
- "DISTINCT-COUNT"
1855
- ],
1856
- "type": "string"
1857
- },
1858
- "sourceFieldId": {
1859
- "description": "The id of the source field.",
1860
- "type": "integer"
1861
- },
1862
- "masterTableTag": {
1863
- "description": "The table alias for the master table in the relationship this field is part of.",
1864
- "type": "string"
1865
- },
1866
- "doesAverage": {
1867
- "description": "Whether this field averages in reports within the product.",
1868
- "type": "boolean"
1869
- },
1870
- "formula": {
1871
- "description": "The formula of the field as configured in Quickbase.",
1872
- "type": "string"
1873
- },
1874
- "decimalPlaces": {
1875
- "description": "The number of decimal places displayed in the product for this field.",
1876
- "type": "integer"
1877
- },
1878
- "defaultCountryCode": {
1879
- "description": "Controls the default country shown on international phone widgets on forms. Country code should be entered in the ISO 3166-1 alpha-2 format.",
1880
- "type": "string"
1881
- },
1882
- "seeVersions": {
1883
- "description": "Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.",
1884
- "type": "boolean"
1885
- },
1886
- "displayMonth": {
1887
- "description": "How to display months.",
1888
- "type": "string"
1889
- },
1890
- "numLines": {
1891
- "description": "The number of lines shown in Quickbase for this text field.",
1892
- "type": "integer"
1893
- },
1894
- "displayEmail": {
1895
- "description": "How the email is displayed.",
1896
- "type": "string"
1897
- },
1898
- "defaultKind": {
1899
- "description": "The user default type.",
1900
- "type": "string"
1901
- },
1902
- "coverText": {
1903
- "description": "An alternate user friendly text that can be used to display a link in the browser.",
1904
- "type": "string"
1905
- },
1906
- "currencySymbol": {
1907
- "description": "The current symbol used when displaying field values within the product.",
1908
- "type": "string"
1909
- },
1910
- "masterChoiceTableId": {
1911
- "description": "The id of the table that is the master in this relationship.",
1912
- "type": "string"
1913
- },
1914
- "targetFieldId": {
1915
- "description": "The id of the target field.",
1916
- "type": "integer"
1917
- },
1918
- "displayUser": {
1919
- "description": "The configured option for how users display within the product.",
1920
- "type": "string"
1921
- },
1922
- "blankIsZero": {
1923
- "description": "Whether a blank value is treated the same as 0 in calculations within the product.",
1924
- "type": "boolean"
1925
- },
1926
- "exact": {
1927
- "description": "Whether an exact match is required for a report link.",
1928
- "type": "boolean"
1929
- },
1930
- "startField": {
1931
- "description": "The start field id.",
1932
- "type": "integer"
1933
- },
1934
- "defaultDomain": {
1935
- "description": "Default email domain.",
1936
- "type": "string"
1937
- },
1938
- "defaultValue": {
1939
- "description": "The default value configured for a field when a new record is added.",
1940
- "type": "string"
1941
- },
1942
- "choicesLuid": {
1943
- "description": "List of user choices.",
1944
- "type": "array"
1945
- },
1946
- "abbreviate": {
1947
- "description": "Don't show the URL protocol when showing the URL.",
1948
- "type": "boolean"
1949
- },
1950
- "xmlTag": {
1951
- "description": "The field's xml tag.",
1952
- "type": "string"
1953
- },
1954
- "targetTableName": {
1955
- "description": "The field's target table name.",
1956
- "type": "string"
1957
- },
1958
- "numberFormat": {
1959
- "description": "The format used for displaying numeric values in the product (decimal, separators, digit group).",
1960
- "type": "integer"
1961
- },
1962
- "appearsAs": {
1963
- "description": "The link text, if empty, the url will be used as link text.",
1964
- "type": "string"
1965
- },
1966
- "width": {
1967
- "description": "The field's html input width in the product.",
1968
- "type": "integer"
1969
- },
1970
- "currencyFormat": {
1971
- "description": "The currency format used when displaying field values within the product.",
1972
- "enum": [
1973
- "left",
1974
- "right",
1975
- "middle"
1976
- ],
1977
- "type": "string"
1978
- },
1979
- "foreignKey": {
1980
- "description": "Indicates if the field is a foreign key (or reference field) in a relationship.",
1981
- "type": "boolean"
1982
- },
1983
- "displayDayOfWeek": {
1984
- "description": "Indicates whether to display the day of the week within the product.",
1985
- "type": "boolean"
1986
- },
1987
- "summaryReferenceFieldId": {
1988
- "description": "The id of the field that is the reference in the relationship for this summary.",
1989
- "type": "integer",
1990
- "format": "int64"
1991
- },
1992
- "commaStart": {
1993
- "description": "The number of digits before commas display in the product, when applicable.",
1994
- "type": "integer"
1995
- },
1996
- "choices": {
1997
- "description": "An array of entries that exist for a field that offers choices to the user.",
1998
- "type": "array",
1999
- "items": {
2000
- "type": "string"
2001
- }
2002
- },
2003
- "targetTableId": {
2004
- "description": "The id of the target table.",
2005
- "type": "string"
2006
- },
2007
- "displayRelative": {
2008
- "description": "Whether to display time as relative.",
2009
- "type": "boolean"
2010
- },
2011
- "compositeFields": {
2012
- "description": "An array of the fields that make up a composite field (e.g., address).",
2013
- "type": "array"
2014
- },
2015
- "displayCheckboxAsText": {
2016
- "description": "Indicates whether the checkbox values will be shown as text in reports.",
2017
- "type": "boolean"
2018
- },
2019
- "versionMode": {
2020
- "description": "Version modes for files. Keep all versions vs keep last version.",
2021
- "enum": [
2022
- "keepallversions",
2023
- "keeplastversions"
2024
- ],
2025
- "type": "string"
2026
- },
2027
- "displayTime": {
2028
- "description": "Indicates whether to display the time, in addition to the date.",
2029
- "type": "boolean"
2030
- },
2031
- "durationField": {
2032
- "description": "The duration field id.",
2033
- "type": "integer"
2034
- },
2035
- "snapFieldId": {
2036
- "description": "The id of the field that is used to snapshot values from, when applicable.",
2037
- "type": "integer"
2038
- },
2039
- "hours24": {
2040
- "description": "Indicates whether or not to display time in the 24-hour format within the product.",
2041
- "type": "boolean"
2042
- },
2043
- "sortAlpha": {
2044
- "description": "Whether to sort alphabetically, default sort is by record ID.",
2045
- "type": "boolean"
2046
- },
2047
- "sortAsGiven": {
2048
- "description": "Indicates if the listed entries sort as entered vs alphabetically.",
2049
- "type": "boolean"
2050
- },
2051
- "hasExtension": {
2052
- "description": "Whether this field has a phone extension.",
2053
- "type": "boolean"
2054
- },
2055
- "workWeek": {
2056
- "description": "The work week type.",
2057
- "type": "integer"
2058
- },
2059
- "useNewWindow": {
2060
- "description": "Indicates if the URL should open a new window when a user clicks it within the product.",
2061
- "type": "boolean"
2062
- },
2063
- "appendOnly": {
2064
- "description": "Whether this field is append only.",
2065
- "type": "boolean"
2066
- },
2067
- "displayAsLink": {
2068
- "description": "Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.",
2069
- "type": "boolean"
2070
- },
2071
- "allowHTML": {
2072
- "description": "Whether this field allows html.",
2073
- "type": "boolean"
2074
- },
2075
- "lookupReferenceFieldId": {
2076
- "description": "The id of the field that is the reference in the relationship for this lookup.",
2077
- "type": "integer"
2078
- }
2079
- }
2080
- },
2081
- "permissions": {
2082
- "description": "Field Permissions for different roles.",
2083
- "type": "array",
2084
- "items": {
2085
- "type": "object",
2086
- "additionalProperties": false,
2087
- "properties": {
2088
- "role": {
2089
- "description": "The role associated with a given permission for the field",
2090
- "type": "string"
2091
- },
2092
- "permissionType": {
2093
- "description": "The permission given to the role for this field",
2094
- "type": "string"
2095
- },
2096
- "roleId": {
2097
- "description": "The Id of the given role",
2098
- "type": "integer"
2099
- }
2100
- }
2101
- }
2102
- }
2103
- }
2104
- }
2105
- }
2106
- },
2107
- "tags": [
2108
- "Fields"
2109
- ]
2110
- },
2111
- "post": {
2112
- "description": "Updates the properties and custom permissions of a field. The attempt to update certain properties might cause existing data to no longer obey the field’s new properties and may be rejected. See the descriptions of required, unique, and choices, below, for specific situations. Any properties of the field that you do not specify in the request body will remain unchanged.",
2113
- "summary": "Update a field",
2114
- "operationId": "updateField",
2115
- "consumes": [
2116
- "application/json"
2117
- ],
2118
- "produces": [
2119
- "application/json"
2120
- ],
2121
- "parameters": [
2122
- {
2123
- "name": "tableId",
2124
- "in": "query",
2125
- "required": true,
2126
- "description": "The unique identifier of the table.",
2127
- "type": "string"
2128
- },
2129
- {
2130
- "name": "fieldId",
2131
- "in": "path",
2132
- "required": true,
2133
- "description": "The unique identifier (fid) of the field.",
2134
- "type": "integer"
2135
- },
2136
- {
2137
- "name": "QB-Realm-Hostname",
2138
- "in": "header",
2139
- "required": true,
2140
- "description": "Your Quickbase domain, for example demo.quickbase.com",
2141
- "type": "string"
2142
- },
2143
- {
2144
- "name": "User-Agent",
2145
- "in": "header",
2146
- "required": false,
2147
- "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.",
2148
- "type": "string"
2149
- },
2150
- {
2151
- "name": "Authorization",
2152
- "in": "header",
2153
- "required": true,
2154
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
2155
- "type": "string"
2156
- },
2157
- {
2158
- "name": "generated",
2159
- "in": "body",
2160
- "schema": {
2161
- "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.",
2162
- "example": {
2163
- "label": "Field1",
2164
- "noWrap": false,
2165
- "bold": false,
2166
- "required": true,
2167
- "appearsByDefault": false,
2168
- "findEnabled": false,
2169
- "unique": true,
2170
- "fieldHelp": "field help",
2171
- "addToForms": true,
2172
- "properties": {
2173
- "numLines": 1,
2174
- "maxLength": 0,
2175
- "appendOnly": false,
2176
- "sortAsGiven": false
2177
- },
2178
- "permissions": [
2179
- {
2180
- "role": "Viewer",
2181
- "permissionType": "View",
2182
- "roleId": 10
2183
- },
2184
- {
2185
- "role": "Participant",
2186
- "permissionType": "None",
2187
- "roleId": 11
2188
- },
2189
- {
2190
- "role": "Administrator",
2191
- "permissionType": "Modify",
2192
- "roleId": 12
2193
- }
2194
- ]
2195
- },
2196
- "type": "object",
2197
- "additionalProperties": false,
2198
- "properties": {
2199
- "audited": {
2200
- "description": "Indicates if the field is being tracked as part of Quickbase Audit Logs. You can only set this property to \"true\" if the app has audit logs enabled. See Enable data change logs under [Quickbase Audit Logs](https://help.quickbase.com/user-assistance/audit_logs.html).",
2201
- "type": "boolean"
2202
- },
2203
- "fieldHelp": {
2204
- "description": "The configured help text shown to users within the product.",
2205
- "type": "string"
2206
- },
2207
- "bold": {
2208
- "description": "Indicates if the field is configured to display in bold in the product.",
2209
- "type": "boolean"
2210
- },
2211
- "required": {
2212
- "description": "Indicates if the field is required (i.e. if every record must have a non-null value in this field). If you attempt to change a field from not-required to required, and the table currently contains records that have null values in that field, you will get an error indicating that there are null values of the field. In this case you need to find and update those records with null values of the field before changing the field to required.",
2213
- "type": "boolean"
2214
- },
2215
- "properties": {
2216
- "description": "Specific field properties.",
2217
- "type": "object",
2218
- "additionalProperties": false,
2219
- "properties": {
2220
- "allowMentions": {
2221
- "description": "If someone can @mention users in the rich text field to generate an email notification.",
2222
- "type": "boolean"
2223
- },
2224
- "comments": {
2225
- "description": "The comments entered on the field properties by an administrator.",
2226
- "type": "string"
2227
- },
2228
- "doesTotal": {
2229
- "description": "Whether this field totals in reports within the product.",
2230
- "type": "boolean"
2231
- },
2232
- "autoSave": {
2233
- "description": "Whether the link field will auto save.",
2234
- "type": "boolean"
2235
- },
2236
- "defaultValueLuid": {
2237
- "description": "Default user id value.",
2238
- "type": "integer"
2239
- },
2240
- "useI18NFormat": {
2241
- "description": "Whether phone numbers should be in E.164 standard international format",
2242
- "type": "boolean"
2243
- },
2244
- "maxVersions": {
2245
- "description": "The maximum number of versions configured for a file attachment.",
2246
- "type": "integer",
2247
- "format": "int32",
2248
- "minimum": 1
2249
- },
2250
- "format": {
2251
- "description": "The format to display time.",
2252
- "type": "integer"
2253
- },
2254
- "carryChoices": {
2255
- "description": "Whether the field should carry its multiple choice fields when copied.",
2256
- "type": "boolean"
2257
- },
2258
- "maxLength": {
2259
- "description": "The maximum number of characters allowed for entry in Quickbase for this field.",
2260
- "type": "integer"
2261
- },
2262
- "linkText": {
2263
- "description": "The configured text value that replaces the URL that users see within the product.",
2264
- "type": "string"
2265
- },
2266
- "parentFieldId": {
2267
- "description": "The id of the parent composite field, when applicable.",
2268
- "type": "integer"
2269
- },
2270
- "displayTimezone": {
2271
- "description": "Indicates whether to display the timezone within the product.",
2272
- "type": "boolean"
2273
- },
2274
- "summaryTargetFieldId": {
2275
- "description": "The id of the field that is used to aggregate values from the child, when applicable. This displays 0 if the summary function doesn’t require a field selection (like count).",
2276
- "type": "integer"
2277
- },
2278
- "allowNewChoices": {
2279
- "description": "Indicates if users can add new choices to a selection list.",
2280
- "type": "boolean"
2281
- },
2282
- "defaultToday": {
2283
- "description": "Indicates if the field value is defaulted today for new records.",
2284
- "type": "boolean"
2285
- },
2286
- "units": {
2287
- "description": "The units label.",
2288
- "type": "string"
2289
- },
2290
- "openTargetIn": {
2291
- "description": "Indicates which target the URL should open in when a user clicks it within the product.",
2292
- "enum": [
2293
- "sameWindow",
2294
- "newWindow",
2295
- "popup"
2296
- ],
2297
- "type": "string"
2298
- },
2299
- "lookupTargetFieldId": {
2300
- "description": "The id of the field that is the target on the parent table for this lookup.",
2301
- "type": "integer"
2302
- },
2303
- "summaryFunction": {
2304
- "description": "The accumulation type for the summary field.",
2305
- "enum": [
2306
- "AVG",
2307
- "SUM",
2308
- "MAX",
2309
- "MIN",
2310
- "STD-DEV",
2311
- "COUNT",
2312
- "COMBINED-TEXT",
2313
- "COMBINED-USER",
2314
- "DISTINCT-COUNT"
2315
- ],
2316
- "type": "string"
2317
- },
2318
- "sourceFieldId": {
2319
- "description": "The id of the source field.",
2320
- "type": "integer"
2321
- },
2322
- "doesAverage": {
2323
- "description": "Whether this field averages in reports within the product.",
2324
- "type": "boolean"
2325
- },
2326
- "formula": {
2327
- "description": "The formula of the field as configured in Quickbase.",
2328
- "type": "string"
2329
- },
2330
- "decimalPlaces": {
2331
- "description": "The number of decimal places displayed in the product for this field.",
2332
- "type": "integer"
2333
- },
2334
- "defaultCountryCode": {
2335
- "description": "Controls the default country shown on international phone widgets on forms. Country code should be entered in the ISO 3166-1 alpha-2 format.",
2336
- "type": "string"
2337
- },
2338
- "displayMonth": {
2339
- "description": "How to display months.",
2340
- "type": "string"
2341
- },
2342
- "seeVersions": {
2343
- "description": "Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.",
2344
- "type": "boolean"
2345
- },
2346
- "numLines": {
2347
- "description": "The number of lines shown in Quickbase for this text field.",
2348
- "type": "integer"
2349
- },
2350
- "defaultKind": {
2351
- "description": "The user default type.",
2352
- "type": "string"
2353
- },
2354
- "displayEmail": {
2355
- "description": "How the email is displayed.",
2356
- "type": "string"
2357
- },
2358
- "coverText": {
2359
- "description": "An alternate user friendly text that can be used to display a link in the browser.",
2360
- "type": "string"
2361
- },
2362
- "currencySymbol": {
2363
- "description": "The current symbol used when displaying field values within the product.",
2364
- "type": "string"
2365
- },
2366
- "summaryQuery": {
2367
- "description": "The summary query.",
2368
- "type": "string"
2369
- },
2370
- "targetFieldId": {
2371
- "description": "The id of the target field.",
2372
- "type": "integer"
2373
- },
2374
- "displayUser": {
2375
- "description": "The configured option for how users display within the product.",
2376
- "type": "string"
2377
- },
2378
- "blankIsZero": {
2379
- "description": "Whether a blank value is treated the same as 0 in calculations within the product.",
2380
- "type": "boolean"
2381
- },
2382
- "exact": {
2383
- "description": "Whether an exact match is required for a report link.",
2384
- "type": "boolean"
2385
- },
2386
- "defaultDomain": {
2387
- "description": "Default email domain.",
2388
- "type": "string"
2389
- },
2390
- "defaultValue": {
2391
- "description": "The default value configured for a field when a new record is added.",
2392
- "type": "string"
2393
- },
2394
- "abbreviate": {
2395
- "description": "Don't show the URL protocol when showing the URL.",
2396
- "type": "boolean"
2397
- },
2398
- "numberFormat": {
2399
- "description": "The format used for displaying numeric values in the product (decimal, separators, digit group).",
2400
- "type": "integer"
2401
- },
2402
- "targetTableName": {
2403
- "description": "The field's target table name.",
2404
- "type": "string"
2405
- },
2406
- "appearsAs": {
2407
- "description": "The link text, if empty, the url will be used as link text.",
2408
- "type": "string"
2409
- },
2410
- "width": {
2411
- "description": "The field's html input width in the product.",
2412
- "type": "integer"
2413
- },
2414
- "currencyFormat": {
2415
- "description": "The currency format used when displaying field values within the product.",
2416
- "enum": [
2417
- "left",
2418
- "right",
2419
- "middle"
2420
- ],
2421
- "type": "string"
2422
- },
2423
- "displayDayOfWeek": {
2424
- "description": "Indicates whether to display the day of the week within the product.",
2425
- "type": "boolean"
2426
- },
2427
- "summaryReferenceFieldId": {
2428
- "description": "The id of the field that is the reference in the relationship for this summary.",
2429
- "type": "integer"
2430
- },
2431
- "commaStart": {
2432
- "description": "The number of digits before commas display in the product, when applicable.",
2433
- "type": "integer"
2434
- },
2435
- "choices": {
2436
- "description": "An array of entries that exist for a field that offers choices to the user. Note that these choices refer to the valid values of any records added in the future. You are allowed to remove values from the list of choices even if there are existing records with those values in this field. They will be displayed in red when users look at the data in the browser but there is no other effect. While updating a field with this property, the old choices are removed and replaced by the new choices.",
2437
- "type": "array",
2438
- "items": {
2439
- "type": "string"
2440
- }
2441
- },
2442
- "targetTableId": {
2443
- "description": "The id of the target table.",
2444
- "type": "string"
2445
- },
2446
- "displayRelative": {
2447
- "description": "Whether to display time as relative.",
2448
- "type": "boolean"
2449
- },
2450
- "compositeFields": {
2451
- "description": "An array of the fields that make up a composite field (e.g., address).",
2452
- "type": "array"
2453
- },
2454
- "displayCheckboxAsText": {
2455
- "description": "Indicates whether the checkbox values will be shown as text in reports.",
2456
- "type": "boolean"
2457
- },
2458
- "summaryTableId": {
2459
- "description": "The table the summary field references fields from.",
2460
- "type": "string"
2461
- },
2462
- "displayTime": {
2463
- "description": "Indicates whether to display the time, in addition to the date.",
2464
- "type": "boolean"
2465
- },
2466
- "versionMode": {
2467
- "description": "Version modes for files. Keep all versions vs keep last version.",
2468
- "enum": [
2469
- "keepallversions",
2470
- "keeplastversions"
2471
- ],
2472
- "type": "string"
2473
- },
2474
- "snapFieldId": {
2475
- "description": "The id of the field that is used to snapshot values from, when applicable.",
2476
- "type": "integer"
2477
- },
2478
- "hours24": {
2479
- "description": "Indicates whether or not to display time in the 24-hour format within the product.",
2480
- "type": "boolean"
2481
- },
2482
- "sortAlpha": {
2483
- "description": "Whether to sort alphabetically, default sort is by record ID.",
2484
- "type": "boolean"
2485
- },
2486
- "sortAsGiven": {
2487
- "description": "Indicates if the listed entries sort as entered vs alphabetically.",
2488
- "type": "boolean"
2489
- },
2490
- "hasExtension": {
2491
- "description": "Whether this field has a phone extension.",
2492
- "type": "boolean"
2493
- },
2494
- "useNewWindow": {
2495
- "description": "Indicates if the file should open a new window when a user clicks it within the product.",
2496
- "type": "boolean"
2497
- },
2498
- "appendOnly": {
2499
- "description": "Whether this field is append only.",
2500
- "type": "boolean"
2501
- },
2502
- "displayAsLink": {
2503
- "description": "Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.",
2504
- "type": "boolean"
2505
- },
2506
- "lookupReferenceFieldId": {
2507
- "description": "The id of the field that is the reference in the relationship for this lookup.",
2508
- "type": "integer"
2509
- }
2510
- }
2511
- },
2512
- "appearsByDefault": {
2513
- "description": "Indicates if the field is marked as a default in reports.",
2514
- "type": "boolean"
2515
- },
2516
- "unique": {
2517
- "description": "Indicates if every record in the table must contain a unique value of this field. If you attempt to change a field from not-unique to unique, and the table currently contains records with the same value of this field, you will get an error. In this case you need to find and update those records with duplicate values of the field before changing the field to unique.",
2518
- "type": "boolean"
2519
- },
2520
- "permissions": {
2521
- "description": "Field Permissions for different roles.",
2522
- "type": "array",
2523
- "items": {
2524
- "type": "object",
2525
- "additionalProperties": false,
2526
- "properties": {
2527
- "role": {
2528
- "description": "The role associated with a given permission for the field",
2529
- "type": "string"
2530
- },
2531
- "permissionType": {
2532
- "description": "The permission given to the role for this field",
2533
- "type": "string"
2534
- },
2535
- "roleId": {
2536
- "description": "The Id of the given role",
2537
- "type": "integer"
2538
- }
2539
- }
2540
- }
2541
- },
2542
- "addToForms": {
2543
- "description": "Whether the field you are adding should appear on forms.",
2544
- "type": "boolean"
2545
- },
2546
- "label": {
2547
- "description": "The label (name) of the field.",
2548
- "type": "string"
2549
- },
2550
- "findEnabled": {
2551
- "description": "Indicates if the field is marked as searchable.",
2552
- "type": "boolean"
2553
- },
2554
- "noWrap": {
2555
- "description": "Indicates if the field is configured to not wrap when displayed in the product.",
2556
- "type": "boolean"
2557
- }
2558
- }
2559
- }
2560
- }
2561
- ],
2562
- "responses": {
2563
- "200": {
2564
- "description": "Success",
2565
- "x-amf-mediaType": "application/json",
2566
- "schema": {
2567
- "example": {
2568
- "id": 123,
2569
- "label": "Field1",
2570
- "fieldType": "text",
2571
- "mode": "",
2572
- "noWrap": false,
2573
- "bold": false,
2574
- "required": false,
2575
- "appearsByDefault": false,
2576
- "findEnabled": false,
2577
- "unique": false,
2578
- "doesDataCopy": false,
2579
- "fieldHelp": "field help",
2580
- "audited": false,
2581
- "properties": {
2582
- "primaryKey": false,
2583
- "foreignKey": false,
2584
- "numLines": 1,
2585
- "maxLength": 0,
2586
- "appendOnly": false,
2587
- "allowHTML": false,
2588
- "allowMentions": false,
2589
- "sortAsGiven": false,
2590
- "carryChoices": true,
2591
- "allowNewChoices": false,
2592
- "formula": "",
2593
- "defaultValue": ""
2594
- },
2595
- "permissions": [
2596
- {
2597
- "permissionType": "View",
2598
- "role": "Viewer",
2599
- "roleId": 10
2600
- },
2601
- {
2602
- "permissionType": "None",
2603
- "role": "Participant",
2604
- "roleId": 11
2605
- },
2606
- {
2607
- "permissionType": "Modify",
2608
- "role": "Administrator",
2609
- "roleId": 12
2610
- }
2611
- ]
2612
- },
2613
- "type": "object",
2614
- "additionalProperties": true,
2615
- "required": [
2616
- "id"
2617
- ],
2618
- "properties": {
2619
- "id": {
2620
- "description": "The id of the field, unique to this table.",
2621
- "type": "integer",
2622
- "format": "int64"
2623
- },
2624
- "fieldType": {
2625
- "description": "The type of field, as described [here](https://help.quickbase.com/user-assistance/field_types.html).",
2626
- "type": "string"
2627
- },
2628
- "mode": {
2629
- "description": "For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank.",
2630
- "type": "string"
2631
- },
2632
- "label": {
2633
- "description": "The label (name) of the field.",
2634
- "type": "string"
2635
- },
2636
- "noWrap": {
2637
- "description": "Indicates if the field is configured to not wrap when displayed in the product.",
2638
- "type": "boolean"
2639
- },
2640
- "bold": {
2641
- "description": "Indicates if the field is configured to display in bold in the product.",
2642
- "type": "boolean"
2643
- },
2644
- "required": {
2645
- "description": "Indicates if the field is marked required.",
2646
- "type": "boolean"
2647
- },
2648
- "appearsByDefault": {
2649
- "description": "Indicates if the field is marked as a default in reports.",
2650
- "type": "boolean"
2651
- },
2652
- "findEnabled": {
2653
- "description": "Indicates if the field is marked as searchable.",
2654
- "type": "boolean"
2655
- },
2656
- "unique": {
2657
- "description": "Indicates if the field is marked unique.",
2658
- "type": "boolean"
2659
- },
2660
- "doesDataCopy": {
2661
- "description": "Indicates if the field data will copy when a user copies the record.",
2662
- "type": "boolean"
2663
- },
2664
- "fieldHelp": {
2665
- "description": "The configured help text shown to users within the product.",
2666
- "type": "string"
2667
- },
2668
- "audited": {
2669
- "description": "Indicates if the field is being tracked as part of Quickbase Audit Logs.",
2670
- "type": "boolean"
2671
- },
2672
- "properties": {
2673
- "description": "Additional properties for the field. Please see [Field type details](../fieldInfo) page for more details on the properties for each field type.",
2674
- "type": "object",
2675
- "additionalProperties": true,
2676
- "properties": {
2677
- "allowMentions": {
2678
- "description": "If someone can @mention users in the rich text field to generate an email notification.",
2679
- "type": "boolean"
2680
- },
2681
- "comments": {
2682
- "description": "The comments entered on the field properties by an administrator.",
2683
- "type": "string"
2684
- },
2685
- "doesTotal": {
2686
- "description": "Whether this field totals in reports within the product.",
2687
- "type": "boolean"
2688
- },
2689
- "autoSave": {
2690
- "description": "Whether the link field will auto save.",
2691
- "type": "boolean"
2692
- },
2693
- "defaultValueLuid": {
2694
- "description": "Default user id value.",
2695
- "type": "integer"
2696
- },
2697
- "useI18NFormat": {
2698
- "description": "Whether phone numbers should be in E.164 standard international format.",
2699
- "type": "boolean"
2700
- },
2701
- "maxVersions": {
2702
- "description": "The maximum number of versions configured for a file attachment.",
2703
- "type": "integer"
2704
- },
2705
- "carryChoices": {
2706
- "description": "Whether the field should carry its multiple choice fields when copied.",
2707
- "type": "boolean"
2708
- },
2709
- "format": {
2710
- "description": "The format to display time.",
2711
- "type": "integer"
2712
- },
2713
- "maxLength": {
2714
- "description": "The maximum number of characters allowed for entry in Quickbase for this field.",
2715
- "type": "integer"
2716
- },
2717
- "linkText": {
2718
- "description": "The configured text value that replaces the URL that users see within the product.",
2719
- "type": "string"
2720
- },
2721
- "parentFieldId": {
2722
- "description": "The id of the parent composite field, when applicable.",
2723
- "type": "integer"
2724
- },
2725
- "displayTimezone": {
2726
- "description": "Indicates whether to display the timezone within the product.",
2727
- "type": "boolean"
2728
- },
2729
- "summaryTargetFieldId": {
2730
- "description": "The id of the field that is used to aggregate values from the child, when applicable. This displays 0 if the summary function doesn’t require a field selection (like count).",
2731
- "type": "integer"
2732
- },
2733
- "allowNewChoices": {
2734
- "description": "Indicates if users can add new choices to a selection list.",
2735
- "type": "boolean"
2736
- },
2737
- "masterChoiceFieldId": {
2738
- "description": "The id of the field that is the reference in the relationship.",
2739
- "type": "integer"
2740
- },
2741
- "defaultToday": {
2742
- "description": "Indicates if the field value is defaulted today for new records.",
2743
- "type": "boolean"
2744
- },
2745
- "units": {
2746
- "description": "The units label.",
2747
- "type": "string"
2748
- },
2749
- "lookupTargetFieldId": {
2750
- "description": "The id of the field that is the target on the master table for this lookup.",
2751
- "type": "integer"
2752
- },
2753
- "summaryFunction": {
2754
- "description": "The summary accumulation function type.",
2755
- "enum": [
2756
- "AVG",
2757
- "SUM",
2758
- "MAX",
2759
- "MIN",
2760
- "STD-DEV",
2761
- "COUNT",
2762
- "COMBINED-TEXT",
2763
- "COMBINED-USER",
2764
- "DISTINCT-COUNT"
2765
- ],
2766
- "type": "string"
2767
- },
2768
- "sourceFieldId": {
2769
- "description": "The id of the source field.",
2770
- "type": "integer"
2771
- },
2772
- "masterTableTag": {
2773
- "description": "The table alias for the master table in the relationship this field is part of.",
2774
- "type": "string"
2775
- },
2776
- "doesAverage": {
2777
- "description": "Whether this field averages in reports within the product.",
2778
- "type": "boolean"
2779
- },
2780
- "formula": {
2781
- "description": "The formula of the field as configured in Quickbase.",
2782
- "type": "string"
2783
- },
2784
- "decimalPlaces": {
2785
- "description": "The number of decimal places displayed in the product for this field.",
2786
- "type": "integer"
2787
- },
2788
- "defaultCountryCode": {
2789
- "description": "Controls the default country shown on international phone widgets on forms. Country code should be entered in the ISO 3166-1 alpha-2 format.",
2790
- "type": "string"
2791
- },
2792
- "seeVersions": {
2793
- "description": "Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.",
2794
- "type": "boolean"
2795
- },
2796
- "displayMonth": {
2797
- "description": "How to display months.",
2798
- "type": "string"
2799
- },
2800
- "numLines": {
2801
- "description": "The number of lines shown in Quickbase for this text field.",
2802
- "type": "integer"
2803
- },
2804
- "displayEmail": {
2805
- "description": "How the email is displayed.",
2806
- "type": "string"
2807
- },
2808
- "defaultKind": {
2809
- "description": "The user default type.",
2810
- "type": "string"
2811
- },
2812
- "coverText": {
2813
- "description": "An alternate user friendly text that can be used to display a link in the browser.",
2814
- "type": "string"
2815
- },
2816
- "currencySymbol": {
2817
- "description": "The current symbol used when displaying field values within the product.",
2818
- "type": "string"
2819
- },
2820
- "masterChoiceTableId": {
2821
- "description": "The id of the table that is the master in this relationship.",
2822
- "type": "string"
2823
- },
2824
- "targetFieldId": {
2825
- "description": "The id of the target field.",
2826
- "type": "integer"
2827
- },
2828
- "displayUser": {
2829
- "description": "The configured option for how users display within the product.",
2830
- "type": "string"
2831
- },
2832
- "blankIsZero": {
2833
- "description": "Whether a blank value is treated the same as 0 in calculations within the product.",
2834
- "type": "boolean"
2835
- },
2836
- "exact": {
2837
- "description": "Whether an exact match is required for a report link.",
2838
- "type": "boolean"
2839
- },
2840
- "startField": {
2841
- "description": "The start field id.",
2842
- "type": "integer"
2843
- },
2844
- "defaultDomain": {
2845
- "description": "Default email domain.",
2846
- "type": "string"
2847
- },
2848
- "defaultValue": {
2849
- "description": "The default value configured for a field when a new record is added.",
2850
- "type": "string"
2851
- },
2852
- "choicesLuid": {
2853
- "description": "List of user choices.",
2854
- "type": "array"
2855
- },
2856
- "abbreviate": {
2857
- "description": "Don't show the URL protocol when showing the URL.",
2858
- "type": "boolean"
2859
- },
2860
- "xmlTag": {
2861
- "description": "The field's xml tag.",
2862
- "type": "string"
2863
- },
2864
- "targetTableName": {
2865
- "description": "The field's target table name.",
2866
- "type": "string"
2867
- },
2868
- "numberFormat": {
2869
- "description": "The format used for displaying numeric values in the product (decimal, separators, digit group).",
2870
- "type": "integer"
2871
- },
2872
- "appearsAs": {
2873
- "description": "The link text, if empty, the url will be used as link text.",
2874
- "type": "string"
2875
- },
2876
- "width": {
2877
- "description": "The field's html input width in the product.",
2878
- "type": "integer"
2879
- },
2880
- "currencyFormat": {
2881
- "description": "The currency format used when displaying field values within the product.",
2882
- "enum": [
2883
- "left",
2884
- "right",
2885
- "middle"
2886
- ],
2887
- "type": "string"
2888
- },
2889
- "foreignKey": {
2890
- "description": "Indicates if the field is a foreign key (or reference field) in a relationship.",
2891
- "type": "boolean"
2892
- },
2893
- "displayDayOfWeek": {
2894
- "description": "Indicates whether to display the day of the week within the product.",
2895
- "type": "boolean"
2896
- },
2897
- "summaryReferenceFieldId": {
2898
- "description": "The id of the field that is the reference in the relationship for this summary.",
2899
- "type": "integer",
2900
- "format": "int64"
2901
- },
2902
- "commaStart": {
2903
- "description": "The number of digits before commas display in the product, when applicable.",
2904
- "type": "integer"
2905
- },
2906
- "choices": {
2907
- "description": "An array of entries that exist for a field that offers choices to the user.",
2908
- "type": "array",
2909
- "items": {
2910
- "type": "string"
2911
- }
2912
- },
2913
- "targetTableId": {
2914
- "description": "The id of the target table.",
2915
- "type": "string"
2916
- },
2917
- "displayRelative": {
2918
- "description": "Whether to display time as relative.",
2919
- "type": "boolean"
2920
- },
2921
- "compositeFields": {
2922
- "description": "An array of the fields that make up a composite field (e.g., address).",
2923
- "type": "array"
2924
- },
2925
- "displayCheckboxAsText": {
2926
- "description": "Indicates whether the checkbox values will be shown as text in reports.",
2927
- "type": "boolean"
2928
- },
2929
- "versionMode": {
2930
- "description": "Version modes for files. Keep all versions vs keep last version.",
2931
- "enum": [
2932
- "keepallversions",
2933
- "keeplastversions"
2934
- ],
2935
- "type": "string"
2936
- },
2937
- "displayTime": {
2938
- "description": "Indicates whether to display the time, in addition to the date.",
2939
- "type": "boolean"
2940
- },
2941
- "durationField": {
2942
- "description": "The duration field id.",
2943
- "type": "integer"
2944
- },
2945
- "snapFieldId": {
2946
- "description": "The id of the field that is used to snapshot values from, when applicable.",
2947
- "type": "integer"
2948
- },
2949
- "hours24": {
2950
- "description": "Indicates whether or not to display time in the 24-hour format within the product.",
2951
- "type": "boolean"
2952
- },
2953
- "sortAlpha": {
2954
- "description": "Whether to sort alphabetically, default sort is by record ID.",
2955
- "type": "boolean"
2956
- },
2957
- "sortAsGiven": {
2958
- "description": "Indicates if the listed entries sort as entered vs alphabetically.",
2959
- "type": "boolean"
2960
- },
2961
- "hasExtension": {
2962
- "description": "Whether this field has a phone extension.",
2963
- "type": "boolean"
2964
- },
2965
- "workWeek": {
2966
- "description": "The work week type.",
2967
- "type": "integer"
2968
- },
2969
- "useNewWindow": {
2970
- "description": "Indicates if the URL should open a new window when a user clicks it within the product.",
2971
- "type": "boolean"
2972
- },
2973
- "appendOnly": {
2974
- "description": "Whether this field is append only.",
2975
- "type": "boolean"
2976
- },
2977
- "displayAsLink": {
2978
- "description": "Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.",
2979
- "type": "boolean"
2980
- },
2981
- "allowHTML": {
2982
- "description": "Whether this field allows html.",
2983
- "type": "boolean"
2984
- },
2985
- "lookupReferenceFieldId": {
2986
- "description": "The id of the field that is the reference in the relationship for this lookup.",
2987
- "type": "integer"
2988
- }
2989
- }
2990
- },
2991
- "permissions": {
2992
- "description": "Field Permissions for different roles.",
2993
- "type": "array",
2994
- "items": {
2995
- "type": "object",
2996
- "additionalProperties": false,
2997
- "properties": {
2998
- "role": {
2999
- "description": "The role associated with a given permission for the field",
3000
- "type": "string"
3001
- },
3002
- "permissionType": {
3003
- "description": "The permission given to the role for this field",
3004
- "type": "string"
3005
- },
3006
- "roleId": {
3007
- "description": "The Id of the given role",
3008
- "type": "integer"
3009
- }
3010
- }
3011
- }
3012
- }
3013
- }
3014
- }
3015
- }
3016
- },
3017
- "tags": [
3018
- "Fields"
3019
- ]
3020
- }
3021
- },
3022
- "/fields/usage": {
3023
- "get": {
3024
- "description": "Get all the field usage statistics for a table. This is a summary of the information that can be found in the usage table of field properties.",
3025
- "summary": "Get usage for all fields",
3026
- "operationId": "getFieldsUsage",
3027
- "consumes": [
3028
- "application/json"
3029
- ],
3030
- "produces": [
3031
- "application/json"
3032
- ],
3033
- "parameters": [
3034
- {
3035
- "name": "tableId",
3036
- "in": "query",
3037
- "required": true,
3038
- "description": "The unique identifier (dbid) of the table.",
3039
- "type": "string"
3040
- },
3041
- {
3042
- "name": "skip",
3043
- "in": "query",
3044
- "required": false,
3045
- "description": "The number of fields to skip from the list.",
3046
- "type": "integer"
3047
- },
3048
- {
3049
- "name": "top",
3050
- "in": "query",
3051
- "required": false,
3052
- "description": "The maximum number of fields to return.",
3053
- "type": "integer"
3054
- },
3055
- {
3056
- "name": "QB-Realm-Hostname",
3057
- "in": "header",
3058
- "required": true,
3059
- "description": "Your Quickbase domain, for example demo.quickbase.com",
3060
- "type": "string"
3061
- },
3062
- {
3063
- "name": "User-Agent",
3064
- "in": "header",
3065
- "required": false,
3066
- "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.",
3067
- "type": "string"
3068
- },
3069
- {
3070
- "name": "Authorization",
3071
- "in": "header",
3072
- "required": true,
3073
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
3074
- "type": "string"
3075
- }
3076
- ],
3077
- "responses": {
3078
- "200": {
3079
- "description": "Success",
3080
- "x-amf-mediaType": "application/json",
3081
- "schema": {
3082
- "example": [
3083
- {
3084
- "field": {
3085
- "id": 6,
3086
- "name": "name",
3087
- "type": "Text"
3088
- },
3089
- "usage": {
3090
- "actions": {
3091
- "count": 0
3092
- },
3093
- "appHomePages": {
3094
- "count": 0
3095
- },
3096
- "dashboards": {
3097
- "count": 2
3098
- },
3099
- "defaultReports": {
3100
- "count": 1
3101
- },
3102
- "exactForms": {
3103
- "count": 0
3104
- },
3105
- "fields": {
3106
- "count": 0
3107
- },
3108
- "forms": {
3109
- "count": 1
3110
- },
3111
- "notifications": {
3112
- "count": 0
3113
- },
3114
- "personalReports": {
3115
- "count": 0
3116
- },
3117
- "pipelines": {
3118
- "count": 1
3119
- },
3120
- "relationships": {
3121
- "count": 0
3122
- },
3123
- "reminders": {
3124
- "count": 0
3125
- },
3126
- "reports": {
3127
- "count": 2
3128
- },
3129
- "roles": {
3130
- "count": 2
3131
- },
3132
- "tableImports": {
3133
- "count": 3
3134
- },
3135
- "tableRules": {
3136
- "count": 1
3137
- },
3138
- "webhooks": {
3139
- "count": 0
3140
- }
3141
- }
3142
- }
3143
- ],
3144
- "type": "array",
3145
- "items": {
3146
- "type": "object",
3147
- "additionalProperties": true,
3148
- "required": [
3149
- "field",
3150
- "usage"
3151
- ],
3152
- "properties": {
3153
- "field": {
3154
- "description": "Basic information about the field.",
3155
- "type": "object",
3156
- "additionalProperties": true,
3157
- "required": [
3158
- "name",
3159
- "id",
3160
- "type"
3161
- ],
3162
- "properties": {
3163
- "name": {
3164
- "description": "Field name.",
3165
- "type": "string"
3166
- },
3167
- "id": {
3168
- "description": "Field id.",
3169
- "type": "integer"
3170
- },
3171
- "type": {
3172
- "description": "Field type.",
3173
- "type": "string"
3174
- }
3175
- }
3176
- },
3177
- "usage": {
3178
- "description": "Usage Information about the field.",
3179
- "type": "object",
3180
- "additionalProperties": true,
3181
- "required": [
3182
- "actions",
3183
- "appHomePages",
3184
- "dashboards",
3185
- "defaultReports",
3186
- "exactForms",
3187
- "fields",
3188
- "forms",
3189
- "notifications",
3190
- "personalReports",
3191
- "pipelines",
3192
- "relationships",
3193
- "reminders",
3194
- "reports",
3195
- "roles",
3196
- "tableImports",
3197
- "tableRules",
3198
- "webhooks"
3199
- ],
3200
- "properties": {
3201
- "actions": {
3202
- "description": "The number of quickbase actions where the given field is referenced.",
3203
- "type": "object",
3204
- "additionalProperties": true,
3205
- "required": [
3206
- "count"
3207
- ],
3208
- "properties": {
3209
- "count": {
3210
- "description": "the number of times a field has been used for the given item.",
3211
- "type": "integer"
3212
- }
3213
- }
3214
- },
3215
- "appHomePages": {
3216
- "description": "The number of app home pages where the given field is referenced.",
3217
- "type": "object",
3218
- "additionalProperties": true,
3219
- "required": [
3220
- "count"
3221
- ],
3222
- "properties": {
3223
- "count": {
3224
- "description": "the number of times a field has been used for the given item.",
3225
- "type": "integer"
3226
- }
3227
- }
3228
- },
3229
- "dashboards": {
3230
- "required": [
3231
- "count"
3232
- ],
3233
- "type": "object",
3234
- "properties": {
3235
- "count": {
3236
- "type": "integer",
3237
- "description": "the number of times a field has been used for the given item."
3238
- }
3239
- },
3240
- "description": "The number of dashboards where the given field is referenced."
3241
- },
3242
- "defaultReports": {
3243
- "description": "The number of default reports where the given field is referenced.",
3244
- "type": "object",
3245
- "additionalProperties": true,
3246
- "required": [
3247
- "count"
3248
- ],
3249
- "properties": {
3250
- "count": {
3251
- "description": "the number of times a field has been used for the given item.",
3252
- "type": "integer"
3253
- }
3254
- }
3255
- },
3256
- "exactForms": {
3257
- "description": "The number of exact forms where the given field is referenced.",
3258
- "type": "object",
3259
- "additionalProperties": true,
3260
- "required": [
3261
- "count"
3262
- ],
3263
- "properties": {
3264
- "count": {
3265
- "description": "the number of times a field has been used for the given item.",
3266
- "type": "integer"
3267
- }
3268
- }
3269
- },
3270
- "fields": {
3271
- "description": "The number of fields where the given field is referenced.",
3272
- "type": "object",
3273
- "additionalProperties": true,
3274
- "required": [
3275
- "count"
3276
- ],
3277
- "properties": {
3278
- "count": {
3279
- "description": "the number of times a field has been used for the given item.",
3280
- "type": "integer"
3281
- }
3282
- }
3283
- },
3284
- "forms": {
3285
- "description": "The number of forms where the given field is referenced.",
3286
- "type": "object",
3287
- "additionalProperties": true,
3288
- "required": [
3289
- "count"
3290
- ],
3291
- "properties": {
3292
- "count": {
3293
- "description": "the number of times a field has been used for the given item.",
3294
- "type": "integer"
3295
- }
3296
- }
3297
- },
3298
- "notifications": {
3299
- "description": "The number of notifications where the given field is referenced.",
3300
- "type": "object",
3301
- "additionalProperties": true,
3302
- "required": [
3303
- "count"
3304
- ],
3305
- "properties": {
3306
- "count": {
3307
- "description": "the number of times a field has been used for the given item.",
3308
- "type": "integer"
3309
- }
3310
- }
3311
- },
3312
- "personalReports": {
3313
- "description": "The number of personal reports where the given field is referenced.",
3314
- "type": "object",
3315
- "additionalProperties": true,
3316
- "required": [
3317
- "count"
3318
- ],
3319
- "properties": {
3320
- "count": {
3321
- "description": "the number of times a field has been used for the given item.",
3322
- "type": "integer"
3323
- }
3324
- }
3325
- },
3326
- "pipelines": {
3327
- "required": [
3328
- "count"
3329
- ],
3330
- "type": "object",
3331
- "additionalProperties": true,
3332
- "properties": {
3333
- "count": {
3334
- "type": "integer",
3335
- "description": "the number of times a field has been used for the given item."
3336
- }
3337
- },
3338
- "description": "The number of pipelines where the given field is referenced."
3339
- },
3340
- "relationships": {
3341
- "description": "The number of relationships where the given field is referenced.",
3342
- "type": "object",
3343
- "additionalProperties": true,
3344
- "required": [
3345
- "count"
3346
- ],
3347
- "properties": {
3348
- "count": {
3349
- "description": "the number of times a field has been used for the given item.",
3350
- "type": "integer"
3351
- }
3352
- }
3353
- },
3354
- "reminders": {
3355
- "description": "The number of reminders where the given field is referenced.",
3356
- "type": "object",
3357
- "additionalProperties": true,
3358
- "required": [
3359
- "count"
3360
- ],
3361
- "properties": {
3362
- "count": {
3363
- "description": "the number of times a field has been used for the given item.",
3364
- "type": "integer"
3365
- }
3366
- }
3367
- },
3368
- "reports": {
3369
- "description": "The number of reports where the given field is referenced.",
3370
- "type": "object",
3371
- "additionalProperties": true,
3372
- "required": [
3373
- "count"
3374
- ],
3375
- "properties": {
3376
- "count": {
3377
- "description": "the number of times a field has been used for the given item.",
3378
- "type": "integer"
3379
- }
3380
- }
3381
- },
3382
- "roles": {
3383
- "description": "The number of roles where the given field is referenced.",
3384
- "type": "object",
3385
- "additionalProperties": true,
3386
- "required": [
3387
- "count"
3388
- ],
3389
- "properties": {
3390
- "count": {
3391
- "description": "the number of times a field has been used for the given item.",
3392
- "type": "integer"
3393
- }
3394
- }
3395
- },
3396
- "tableImports": {
3397
- "required": [
3398
- "count"
3399
- ],
3400
- "type": "object",
3401
- "properties": {
3402
- "count": {
3403
- "type": "integer",
3404
- "description": "the number of times a field has been used for the given item."
3405
- }
3406
- },
3407
- "description": "The number of table imports where the given field is referenced."
3408
- },
3409
- "tableRules": {
3410
- "required": [
3411
- "count"
3412
- ],
3413
- "type": "object",
3414
- "properties": {
3415
- "count": {
3416
- "type": "integer",
3417
- "description": "the number of times a field has been used for the given item."
3418
- }
3419
- },
3420
- "description": "The number of table rules where the given field is referenced."
3421
- },
3422
- "webhooks": {
3423
- "description": "The number of webhooks where the given field is referenced.",
3424
- "type": "object",
3425
- "additionalProperties": true,
3426
- "required": [
3427
- "count"
3428
- ],
3429
- "properties": {
3430
- "count": {
3431
- "description": "the number of times a field has been used for the given item.",
3432
- "type": "integer"
3433
- }
3434
- }
3435
- }
3436
- }
3437
- }
3438
- }
3439
- }
3440
- }
3441
- }
3442
- },
3443
- "tags": [
3444
- "Fields"
3445
- ]
3446
- }
3447
- },
3448
- "/fields/usage/{fieldId}": {
3449
- "get": {
3450
- "description": "Get a single fields usage statistics. This is a summary of the information that can be found in the usage table of field properties.",
3451
- "summary": "Get usage for a field",
3452
- "operationId": "getFieldUsage",
3453
- "consumes": [
3454
- "application/json"
3455
- ],
3456
- "produces": [
3457
- "application/json"
3458
- ],
3459
- "parameters": [
3460
- {
3461
- "name": "tableId",
3462
- "in": "query",
3463
- "required": true,
3464
- "description": "The unique identifier (dbid) of the table.",
3465
- "type": "string"
3466
- },
3467
- {
3468
- "name": "fieldId",
3469
- "in": "path",
3470
- "required": true,
3471
- "description": "The unique identifier (fid) of the field.",
3472
- "type": "integer"
3473
- },
3474
- {
3475
- "name": "QB-Realm-Hostname",
3476
- "in": "header",
3477
- "required": true,
3478
- "description": "Your Quickbase domain, for example demo.quickbase.com",
3479
- "type": "string"
3480
- },
3481
- {
3482
- "name": "User-Agent",
3483
- "in": "header",
3484
- "required": false,
3485
- "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.",
3486
- "type": "string"
3487
- },
3488
- {
3489
- "name": "Authorization",
3490
- "in": "header",
3491
- "required": true,
3492
- "description": "The Quickbase authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).",
3493
- "type": "string"
3494
- }
3495
- ],
3496
- "responses": {
3497
- "200": {
3498
- "description": "Success",
3499
- "x-amf-mediaType": "application/json",
3500
- "schema": {
3501
- "example": [
3502
- {
3503
- "field": {
3504
- "id": 6,
3505
- "name": "name",
3506
- "type": "Text"
3507
- },
3508
- "usage": {
3509
- "actions": {
3510
- "count": 0
3511
- },
3512
- "appHomePages": {
3513
- "count": 0
3514
- },
3515
- "dashboards": {
3516
- "count": 2
3517
- },
3518
- "defaultReports": {
3519
- "count": 1
3520
- },
3521
- "exactForms": {
3522
- "count": 0
3523
- },
3524
- "fields": {
3525
- "count": 0
3526
- },
3527
- "forms": {
3528
- "count": 1
3529
- },
3530
- "notifications": {
3531
- "count": 0
3532
- },
3533
- "personalReports": {
3534
- "count": 0
3535
- },
3536
- "pipelines": {
3537
- "count": 1
3538
- },
3539
- "relationships": {
3540
- "count": 0
3541
- },
3542
- "reminders": {
3543
- "count": 0
3544
- },
3545
- "reports": {
3546
- "count": 2
3547
- },
3548
- "roles": {
3549
- "count": 2
3550
- },
3551
- "tableImports": {
3552
- "count": 2
3553
- },
3554
- "tableRules": {
3555
- "count": 1
3556
- },
3557
- "webhooks": {
3558
- "count": 0
3559
- }
3560
- }
3561
- }
3562
- ],
3563
- "type": "array",
3564
- "items": {
3565
- "type": "object",
3566
- "additionalProperties": true,
3567
- "required": [
3568
- "field",
3569
- "usage"
3570
- ],
3571
- "properties": {
3572
- "field": {
3573
- "description": "Basic information about the field.",
3574
- "type": "object",
3575
- "additionalProperties": true,
3576
- "required": [
3577
- "name",
3578
- "id",
3579
- "type"
3580
- ],
3581
- "properties": {
3582
- "name": {
3583
- "description": "Field name.",
3584
- "type": "string"
3585
- },
3586
- "id": {
3587
- "description": "Field id.",
3588
- "type": "integer"
3589
- },
3590
- "type": {
3591
- "description": "Field type.",
3592
- "type": "string"
3593
- }
3594
- }
3595
- },
3596
- "usage": {
3597
- "description": "Usage Information about the field.",
3598
- "type": "object",
3599
- "additionalProperties": true,
3600
- "required": [
3601
- "actions",
3602
- "appHomePages",
3603
- "dashboards",
3604
- "defaultReports",
3605
- "exactForms",
3606
- "fields",
3607
- "forms",
3608
- "notifications",
3609
- "personalReports",
3610
- "pipelines",
3611
- "relationships",
3612
- "reminders",
3613
- "reports",
3614
- "roles",
3615
- "tableImports",
3616
- "tableRules",
3617
- "webhooks"
3618
- ],
3619
- "properties": {
3620
- "actions": {
3621
- "description": "The number of quickbase actions where the given field is referenced.",
3622
- "type": "object",
3623
- "additionalProperties": true,
3624
- "required": [
3625
- "count"
3626
- ],
3627
- "properties": {
3628
- "count": {
3629
- "description": "the number of times a field has been used for the given item.",
3630
- "type": "integer"
3631
- }
3632
- }
3633
- },
3634
- "appHomePages": {
3635
- "description": "The number of app home pages where the given field is referenced.",
3636
- "type": "object",
3637
- "additionalProperties": true,
3638
- "required": [
3639
- "count"
3640
- ],
3641
- "properties": {
3642
- "count": {
3643
- "description": "the number of times a field has been used for the given item.",
3644
- "type": "integer"
3645
- }
3646
- }
3647
- },
3648
- "dashboards": {
3649
- "required": [
3650
- "count"
3651
- ],
3652
- "type": "object",
3653
- "properties": {
3654
- "count": {
3655
- "type": "integer",
3656
- "description": "the number of times a field has been used for the given item."
3657
- }
3658
- },
3659
- "description": "The number of dashboards where the given field is referenced."
3660
- },
3661
- "defaultReports": {
3662
- "description": "The number of default reports where the given field is referenced.",
3663
- "type": "object",
3664
- "additionalProperties": true,
3665
- "required": [
3666
- "count"
3667
- ],
3668
- "properties": {
3669
- "count": {
3670
- "description": "the number of times a field has been used for the given item.",
3671
- "type": "integer"
3672
- }
3673
- }
3674
- },
3675
- "exactForms": {
3676
- "description": "The number of exact forms where the given field is referenced.",
3677
- "type": "object",
3678
- "additionalProperties": true,
3679
- "required": [
3680
- "count"
3681
- ],
3682
- "properties": {
3683
- "count": {
3684
- "description": "the number of times a field has been used for the given item.",
3685
- "type": "integer"
3686
- }
3687
- }
3688
- },
3689
- "fields": {
3690
- "description": "The number of fields where the given field is referenced.",
3691
- "type": "object",
3692
- "additionalProperties": true,
3693
- "required": [
3694
- "count"
3695
- ],
3696
- "properties": {
3697
- "count": {
3698
- "description": "the number of times a field has been used for the given item.",
3699
- "type": "integer"
3700
- }
3701
- }
3702
- },
3703
- "forms": {
3704
- "description": "The number of forms where the given field is referenced.",
3705
- "type": "object",
3706
- "additionalProperties": true,
3707
- "required": [
3708
- "count"
3709
- ],
3710
- "properties": {
3711
- "count": {
3712
- "description": "the number of times a field has been used for the given item.",
3713
- "type": "integer"
3714
- }
3715
- }
3716
- },
3717
- "notifications": {
3718
- "description": "The number of notifications where the given field is referenced.",
3719
- "type": "object",
3720
- "additionalProperties": true,
3721
- "required": [
3722
- "count"
3723
- ],
3724
- "properties": {
3725
- "count": {
3726
- "description": "the number of times a field has been used for the given item.",
3727
- "type": "integer"
3728
- }
3729
- }
3730
- },
3731
- "personalReports": {
3732
- "description": "The number of personal reports where the given field is referenced.",
3733
- "type": "object",
3734
- "additionalProperties": true,
3735
- "required": [
3736
- "count"
3737
- ],
3738
- "properties": {
3739
- "count": {
3740
- "description": "the number of times a field has been used for the given item.",
3741
- "type": "integer"
3742
- }
3743
- }
3744
- },
3745
- "pipelines": {
3746
- "required": [
3747
- "count"
3748
- ],
3749
- "type": "object",
3750
- "additionalProperties": true,
3751
- "properties": {
3752
- "count": {
3753
- "type": "integer",
3754
- "description": "the number of times a field has been used for the given item."
3755
- }
3756
- },
3757
- "description": "The number of pipelines where the given field is referenced."
3758
- },
3759
- "relationships": {
3760
- "description": "The number of relationships where the given field is referenced.",
3761
- "type": "object",
3762
- "additionalProperties": true,
3763
- "required": [
3764
- "count"
3765
- ],
3766
- "properties": {
3767
- "count": {
3768
- "description": "the number of times a field has been used for the given item.",
3769
- "type": "integer"
3770
- }
3771
- }
3772
- },
3773
- "reminders": {
3774
- "description": "The number of reminders where the given field is referenced.",
3775
- "type": "object",
3776
- "additionalProperties": true,
3777
- "required": [
3778
- "count"
3779
- ],
3780
- "properties": {
3781
- "count": {
3782
- "description": "the number of times a field has been used for the given item.",
3783
- "type": "integer"
3784
- }
3785
- }
3786
- },
3787
- "reports": {
3788
- "description": "The number of reports where the given field is referenced.",
3789
- "type": "object",
3790
- "additionalProperties": true,
3791
- "required": [
3792
- "count"
3793
- ],
3794
- "properties": {
3795
- "count": {
3796
- "description": "the number of times a field has been used for the given item.",
3797
- "type": "integer"
3798
- }
3799
- }
3800
- },
3801
- "roles": {
3802
- "description": "The number of roles where the given field is referenced.",
3803
- "type": "object",
3804
- "additionalProperties": true,
3805
- "required": [
3806
- "count"
3807
- ],
3808
- "properties": {
3809
- "count": {
3810
- "description": "the number of times a field has been used for the given item.",
3811
- "type": "integer"
3812
- }
3813
- }
3814
- },
3815
- "tableImports": {
3816
- "required": [
3817
- "count"
3818
- ],
3819
- "type": "object",
3820
- "properties": {
3821
- "count": {
3822
- "type": "integer",
3823
- "description": "the number of times a field has been used for the given item."
3824
- }
3825
- },
3826
- "description": "The number of table imports where the given field is referenced."
3827
- },
3828
- "tableRules": {
3829
- "required": [
3830
- "count"
3831
- ],
3832
- "type": "object",
3833
- "properties": {
3834
- "count": {
3835
- "type": "integer",
3836
- "description": "the number of times a field has been used for the given item."
3837
- }
3838
- },
3839
- "description": "The number of table rules where the given field is referenced."
3840
- },
3841
- "webhooks": {
3842
- "description": "The number of webhooks where the given field is referenced.",
3843
- "type": "object",
3844
- "additionalProperties": true,
3845
- "required": [
3846
- "count"
3847
- ],
3848
- "properties": {
3849
- "count": {
3850
- "description": "the number of times a field has been used for the given item.",
3851
- "type": "integer"
3852
- }
3853
- }
3854
- }
3855
- }
3856
- }
3857
- }
3858
- }
3859
- }
3860
- }
3861
- },
3862
- "tags": [
3863
- "Fields"
3864
- ]
3865
- }
3866
- }
3867
- },
3868
- "definitions": {}
3869
- }