Quickbase（獨立出版商）
Quickbase 是一個應用程序開發平台，它通過使任何技術背景的問題解決者能夠共同工作，安全、可靠和可持續地創建應用程序生態系統，將業務和 IT 團隊聯合起來。 Quickbase 通過在一個通用平台上實現大規模公民發展，幫助企業加速獨特流程的持續創新。
此連接器適用於以下產品和區域：
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域， 但下列區域除外： - Azure Government 區域 - Azure 中國區域 - 美國國防部 （DoD） |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| Power Automate（自動化服務） | 進階 | 除下列區域外的所有 Power Automate 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| 連絡人 | |
|---|---|
| 名稱 | 特洛伊·泰勒 |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | Troy Taylor，日立解決方案 |
| 網站 | https://www.quickbase.com/ |
| 隱私策略 | https://www.quickbase.com/privacy |
| 類別 | 生產力;IT 營運 |
正在建立連線
連接器支援下列驗證類型：
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用：所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 領域主機名稱 | 字串 | 指定網域範圍主機名稱的名稱。 | 對 |
| Authorization | securestring | 使用者權杖，格式為「QB-USER-TOKEN yourToken」。 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 下載附件 |
下載檔案附件，檔案附件內容以 base64 格式編碼。 API 回應會傳回標頭中的 |
| 停用使用者權杖 |
停用已驗證的使用者權杖。 完成此操作後，必須在使用者介面中重新啟用使用者權杖。 |
| 刪除使用者權杖 |
刪除已驗證的使用者權杖。 這是不可逆的。 |
| 刪除應用程式 |
刪除整個應用程式，包括所有資料表和資料。 |
| 刪除欄位 |
根據欄位 ID 刪除表格中的一或多個欄位。這也會永久刪除該欄位中的任何資料或計算。 |
| 刪除記錄 |
根據查詢刪除資料表中的記錄。 或者，可以刪除表格中的所有記錄。 |
| 刪除資料表 |
刪除應用程式中的特定資料表，包括其中的所有資料。 |
| 刪除關聯性 |
使用此端點可刪除整個關係，包括所有查閱和摘要欄位。 關係中的參考欄位不會被刪除。 |
| 刪除附件 |
刪除一個檔案附件版本。 如果適用，您可以從 /records 和 /reports 端點擷取檔案的中繼資料。 使用這些端點來取得刪除檔案版本所需的資訊。 |
| 取得 DBID 的暫存權杖 |
使用此端點來取得暫存授權權杖，其範圍限定為應用程式或資料表。 然後，您可以使用此權杖進行其他 API 呼叫 （請參閱 授權）。 此權杖會在 5 分鐘後到期。 |
| 取得報告 |
取得個別報表的結構描述 （屬性）。 |
| 取得應用程式 |
傳回應用程式的主要屬性，包括應用程式變數。 |
| 取得應用程式事件 |
獲取可根據此應用程序中的數據或用戶操作觸發的事件列表，包括：電子郵件通知、提醒、訂閱、QB 操作、Webhook、記錄更改觸發的自動化（不包括計劃）。 |
| 取得應用程式的表格 |
取得特定應用程式中存在之所有資料表的清單。 每個資料表的屬性都與 Get 資料表中傳回的內容相同。 |
| 取得所有欄位的使用量 |
取得資料表的所有欄位使用統計資料。 這是可以在欄位屬性的使用方式表格中找到的資訊摘要。 |
| 取得所有表格報告 |
取得資料表所有報表的結構描述 （屬性）。 如果執行 API 的使用者是應用程式管理員，則 API 也會傳回所有具有擁有者使用者 ID 的個人報告。 |
| 取得所有關聯性 |
取得特定資料表的所有關聯性及其定義的清單。 會針對指定應用程式內關係的父端和子端提供詳細資料。 針對跨應用程式關係傳回有限的詳細資料。 |
| 取得欄位 |
根據欄位識別碼取得個別欄位的屬性。 |
| 取得欄位使用情形 |
取得單一欄位使用統計資料。 這是可以在欄位屬性的使用方式表格中找到的資訊摘要。 |
| 取得資料表的欄位 |
取得特定資料表中所有欄位的屬性。 每個欄位的屬性與 Get 欄位中的屬性相同。 |
| 取得餐桌 |
取得屬於應用程式一部分的個別資料表的屬性。 |
| 執行公式 |
允許透過 API 呼叫執行公式。 在自訂程式碼中使用此方法，以取得記錄上沒有離散欄位的公式值。 |
| 執行報表 |
根據識別碼執行報表，並傳回與其相關聯的基礎資料。 資料的格式會因報表類型而異。 著重於記錄層級資料 （資料表、行事曆等） 的報表會傳回個別記錄。 彙總報告（摘要、圖表）將返回報告中配置的摘要資訊。 不會傳回 UI 特定的元素，例如總計、平均值和視覺效果。 根據每筆記錄的近似大小，以智慧型分頁傳回資料。 中繼資料物件將包含必要的資訊，以逐一查看回應並收集更多資料。 |
| 建立一個關係 |
在表格以及查詢/摘要欄位中建立關係。 只能為相同應用程式內的資料表建立關聯性。 |
| 建立應用程式 |
在帳戶中建立應用程式。 您必須在相應帳戶中擁有應用程式建立權限。 可以使用此 API 設定主要屬性和應用程式變數。 |
| 建立數據表 |
在應用程式中建立資料表。 |
| 建立欄位 |
在表格中建立欄位，包括該欄位的自訂權限。 |
| 插入和或更新記錄 |
在表格中插入和/或更新記錄。 在此單一 API 呼叫中，可以提交插入和更新。 更新可以使用資料表上的索引鍵欄位，或任何其他支援的唯一欄位。 請參閱欄位 型別頁面 ，以取得有關每個欄位型別應如何格式化的詳細資訊。 此作業容許累加式處理成功的記錄，即使某些記錄失敗也一樣。 |
| 更新應用程式 |
更新特定應用程式的主要內容和/或應用程式變數。 您未在要求本文中指定的應用程式的任何屬性都會保持不變。 |
| 更新數據表 |
更新特定資料表的主要內容。 您未在要求內文中指定的表格的任何屬性將保持不變。 |
| 更新欄位 |
更新欄位的屬性和自訂權限。 嘗試更新某些內容可能會導致現有資料不再服從欄位的新內容，並可能被拒絕。 如需特定情況，請參閱下方必要、唯一和選擇的說明。 您未在要求本文中指定的欄位的任何屬性都會保持不變。 |
| 更新關聯性 |
使用此端點可將查閱欄位和摘要欄位新增至現有關係。 更新關聯性不會刪除現有的查閱/摘要欄位。 |
| 查詢資料 |
以 Quickbase 查詢語言傳入查詢。 根據每筆記錄的近似大小，傳回具有 智慧分頁 的記錄資料。 中繼資料物件將包含必要的資訊，以逐一查看回應並收集更多資料。 |
| 複製使用者權杖 |
複製已驗證的使用者權杖。 與該權杖相關聯的所有應用程式都會自動與新權杖相關聯。 |
| 複製應用程式 |
複製指定的應用程式。 新應用程式將具有與原始應用程式相同的結構描述。 有關其他複製選項，請參閱下文。 |
下載附件
下載檔案附件，檔案附件內容以 base64 格式編碼。 API 回應會傳回標頭中的 Content-Disposition 檔案名稱。 如果適用，您可以從 /records 和 /reports 端點擷取檔案的中繼資料。 使用這些端點來取得擷取檔案所需的資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼。 |
|
記錄識別碼
|
recordId | True | integer |
記錄的唯一識別碼。 |
|
欄位識別碼
|
fieldId | True | integer |
欄位的唯一識別碼。 |
|
版本號碼
|
versionNumber | True | integer |
檔案附件版本號碼。 |
傳回
- response
- string
停用使用者權杖
停用已驗證的使用者權杖。 完成此操作後，必須在使用者介面中重新啟用使用者權杖。
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
識別碼 |
刪除使用者權杖
刪除應用程式
刪除整個應用程式，包括所有資料表和資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名稱
|
name | True | string |
為了確認應用程序刪除，我們要求提供應用程序名稱。 |
|
App ID
|
appId | True | string |
應用程式的唯一識別碼。 |
傳回
- 刪除應用程式回應
- deleteAppResponse
刪除欄位
根據欄位 ID 刪除表格中的一或多個欄位。這也會永久刪除該欄位中的任何資料或計算。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼。 |
|
欄位標識碼
|
fieldIds | True | array of integer |
要刪除的欄位識別碼清單。 |
傳回
- 刪除欄位回應
- deleteFieldsResponse
刪除記錄
根據查詢刪除資料表中的記錄。 或者，可以刪除表格中的所有記錄。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
從
|
from | True | string |
資料表的唯一識別碼。 |
|
where
|
where | True | string |
刪除記錄的篩選器。 若要刪除所有記錄，請指定將包含所有記錄的篩選器，例如 {3.GT.0}，其中 3 是 [記錄識別碼] 欄位的識別碼。 |
傳回
- 刪除記錄回應
- deleteRecordsResponse
刪除資料表
刪除應用程式中的特定資料表，包括其中的所有資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
應用程式的唯一識別碼 |
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼 （DBID）。 |
傳回
- 刪除資料表回應
- deleteTableResponse
刪除關聯性
使用此端點可刪除整個關係，包括所有查閱和摘要欄位。 關係中的參考欄位不會被刪除。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼 （DBID）。 這將是子表。 |
|
關係識別碼
|
relationshipId | True | double |
關係識別碼。 這是子資料表上參考欄位的欄位識別碼。 |
傳回
- 刪除關係回應
- deleteRelationshipResponse
刪除附件
刪除一個檔案附件版本。 如果適用，您可以從 /records 和 /reports 端點擷取檔案的中繼資料。 使用這些端點來取得刪除檔案版本所需的資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼。 |
|
記錄識別碼
|
recordId | True | integer |
記錄的唯一識別碼。 |
|
欄位識別碼
|
fieldId | True | integer |
欄位的唯一識別碼。 |
|
版本號碼
|
versionNumber | True | integer |
檔案附件版本號碼。 |
傳回
- 刪除檔案回應
- deleteFileResponse
取得 DBID 的暫存權杖
使用此端點來取得暫存授權權杖，其範圍限定為應用程式或資料表。 然後，您可以使用此權杖進行其他 API 呼叫 （請參閱 授權）。 此權杖會在 5 分鐘後到期。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
應用程式權杖
|
QB-App-Token | string |
您的 Quickbase 應用程式權杖 |
|
|
DBID
|
dbid | True | string |
應用程式或資料表的唯一識別碼。 |
傳回
- getTempTokenDBIDResponse
- getTempTokenDBIDResponse
取得報告
取得個別報表的結構描述 （屬性）。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼。 |
|
報表識別碼
|
reportId | True | string |
報表的識別碼，對資料表來說是唯一的。 |
傳回
- 取得報告回應
- getReportResponse
取得應用程式
傳回應用程式的主要屬性，包括應用程式變數。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
應用程式的唯一識別碼。 |
傳回
- 取得應用程式回應
- getAppResponse
取得應用程式事件
獲取可根據此應用程序中的數據或用戶操作觸發的事件列表，包括：電子郵件通知、提醒、訂閱、QB 操作、Webhook、記錄更改觸發的自動化（不包括計劃）。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
應用程式的唯一識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
類型
|
type | string |
型別。 |
|
Email
|
owner.email | string |
擁有者的電子郵件地址。 |
|
ID
|
owner.id | string |
擁有者的識別碼。 |
|
名稱
|
owner.name | string |
業主的姓名。 |
|
使用者名
|
owner.userName | string |
擁有者的使用者名稱。 |
|
處於活動狀態
|
isActive | boolean |
是否處於活動狀態。 |
|
表格 ID
|
tableId | string |
資料表的識別碼。 |
|
名稱
|
name | string |
名稱。 |
|
URL
|
url | string |
URL 位址。 |
取得應用程式的表格
取得特定應用程式中存在之所有資料表的清單。 每個資料表的屬性都與 Get 資料表中傳回的內容相同。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
應用程式的唯一識別碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
名稱
|
name | string |
名稱。 |
|
已建立
|
created | string |
建立時。 |
|
Updated
|
updated | string |
更新時。 |
|
Alias
|
alias | string |
別名。 |
|
Description
|
description | string |
描述。 |
|
ID
|
id | string |
識別碼。 |
|
下一個記錄識別碼
|
nextRecordId | integer |
下一筆記錄的識別碼。 |
|
下一個欄位識別碼
|
nextFieldId | integer |
下一個欄位的識別碼。 |
|
預設排序欄位ID
|
defaultSortFieldId | integer |
預設排序欄位的識別碼。 |
|
預設排序順序
|
defaultSortOrder | string |
預設排序順序。 |
|
索引鍵欄位識別碼
|
keyFieldId | integer |
索引鍵欄位的識別碼。 |
|
單一記錄名稱
|
singleRecordName | string |
單一記錄名稱。 |
|
複數記錄名稱
|
pluralRecordName | string |
複數記錄名稱。 |
|
尺寸限制
|
sizeLimit | string |
大小限制。 |
|
使用的空間
|
spaceUsed | string |
使用過的空間。 |
|
剩餘空間
|
spaceRemaining | string |
剩餘空間。 |
取得所有欄位的使用量
取得資料表的所有欄位使用統計資料。 這是可以在欄位屬性的使用方式表格中找到的資訊摘要。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼 （DBID）。 |
|
跳過
|
skip | integer |
要從清單中略過的欄位數目。 |
|
|
前幾個
|
top | integer |
要傳回的欄位數目上限。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID
|
field.id | integer |
識別碼。 |
|
名稱
|
field.name | string |
名稱。 |
|
類型
|
field.type | string |
型別。 |
|
Count
|
usage.actions.count | integer |
計數。 |
|
Count
|
usage.appHomePages.count | integer |
計數。 |
|
Count
|
usage.defaultReports.count | integer |
計數。 |
|
Count
|
usage.exactForms.count | integer |
計數。 |
|
Count
|
usage.fields.count | integer |
計數。 |
|
Count
|
usage.forms.count | integer |
計數。 |
|
Count
|
usage.notifications.count | integer |
計數。 |
|
Count
|
usage.personalReports.count | integer |
計數。 |
|
Count
|
usage.relationships.count | integer |
計數。 |
|
Count
|
usage.reminders.count | integer |
計數。 |
|
Count
|
usage.reports.count | integer |
計數。 |
|
Count
|
usage.roles.count | integer |
計數。 |
|
Count
|
usage.webhooks.count | integer |
計數。 |
取得所有表格報告
取得資料表所有報表的結構描述 （屬性）。 如果執行 API 的使用者是應用程式管理員，則 API 也會傳回所有具有擁有者使用者 ID 的個人報告。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID
|
id | string |
識別碼。 |
|
名稱
|
name | string |
名稱。 |
|
類型
|
type | string |
型別。 |
|
Description
|
description | string |
描述。 |
|
負責人識別碼
|
ownerId | string |
擁有者的識別碼。 |
|
最後使用過
|
usedLast | string |
最後使用時。 |
|
已使用計數
|
usedCount | integer |
已使用的計數。 |
取得所有關聯性
取得特定資料表的所有關聯性及其定義的清單。 會針對指定應用程式內關係的父端和子端提供詳細資料。 針對跨應用程式關係傳回有限的詳細資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
跳過
|
skip | integer |
要略過的關係數目。 |
|
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼 （DBID）。 |
傳回
- 取得關係回應
- getRelationshipsResponse
取得欄位
根據欄位識別碼取得個別欄位的屬性。
所有欄位類型上存在的屬性都會在最上層傳回。 特定欄位型別的唯一屬性會在「properties」屬性下傳回。 請參閱 欄位類型頁面 ，以取得每個欄位類型屬性的詳細資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼 （DBID）。 |
|
包含欄位權限
|
includeFieldPerms | boolean |
如果您想要取回欄位的自訂權限，請設定為「true」。 |
|
|
欄位識別碼
|
fieldId | True | integer |
欄位的唯一識別碼 （FID）。 |
傳回
- 取得現場回應
- getFieldResponse
取得欄位使用情形
取得單一欄位使用統計資料。 這是可以在欄位屬性的使用方式表格中找到的資訊摘要。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼 （DBID）。 |
|
欄位識別碼
|
fieldId | True | integer |
欄位的唯一識別碼 （FID）。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID
|
field.id | integer |
識別碼。 |
|
名稱
|
field.name | string |
名稱。 |
|
類型
|
field.type | string |
型別。 |
|
Count
|
usage.actions.count | integer |
計數。 |
|
Count
|
usage.appHomePages.count | integer |
計數。 |
|
Count
|
usage.defaultReports.count | integer |
計數。 |
|
Count
|
usage.exactForms.count | integer |
計數。 |
|
Count
|
usage.fields.count | integer |
計數。 |
|
Count
|
usage.forms.count | integer |
計數。 |
|
Count
|
usage.notifications.count | integer |
計數。 |
|
Count
|
usage.personalReports.count | integer |
計數。 |
|
Count
|
usage.relationships.count | integer |
計數。 |
|
Count
|
usage.reminders.count | integer |
計數。 |
|
Count
|
usage.reports.count | integer |
計數。 |
|
Count
|
usage.roles.count | integer |
計數。 |
|
Count
|
usage.webhooks.count | integer |
計數。 |
取得資料表的欄位
取得特定資料表中所有欄位的屬性。 每個欄位的屬性與 Get 欄位中的屬性相同。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼 （DBID）。 |
|
包含欄位權限
|
includeFieldPerms | boolean |
如果您想要取回欄位的自訂權限，請設定為「true」。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID
|
id | integer |
識別碼。 |
|
標籤
|
label | string |
標籤。 |
|
欄位類型
|
fieldType | string |
欄位類型。 |
|
無包裝
|
noWrap | boolean |
是否沒有包裝。 |
|
Bold
|
bold | boolean |
無論大膽。 |
|
為必填項目
|
required | boolean |
是否需要。 |
|
預設顯示
|
appearsByDefault | boolean |
是否預設顯示。 |
|
尋找已啟用
|
findEnabled | boolean |
是否啟用尋找。 |
|
唯一
|
unique | boolean |
是否獨一無二。 |
|
資料是否複製
|
doesDataCopy | boolean |
資料是否複製。 |
|
現場幫助
|
fieldHelp | string |
現場幫助。 |
|
經審核
|
audited | boolean |
是否經過審計。 |
|
主索引鍵
|
properties.primaryKey | boolean |
是否為主鍵。 |
|
外鍵
|
properties.foreignKey | boolean |
是否為外鍵。 |
|
行數
|
properties.numLines | integer |
行數。 |
|
最大長度
|
properties.maxLength | integer |
長度上限。 |
|
僅附加
|
properties.appendOnly | boolean |
是否僅附加。 |
|
允許HTML
|
properties.allowHTML | boolean |
是否允許 HTML。 |
|
按給定排序
|
properties.sortAsGiven | boolean |
是否按照給定的方式排序。 |
|
攜帶選擇
|
properties.carryChoices | boolean |
是否攜帶選擇。 |
|
允許新的選擇
|
properties.allowNewChoices | boolean |
是否允許新的選擇。 |
|
Formula
|
properties.formula | string |
公式。 |
|
預設值
|
properties.defaultValue | string |
預設值。 |
|
號碼格式
|
properties.numberFormat | integer |
數字格式。 |
|
小數位數
|
properties.decimalPlaces | integer |
小數點後位數。 |
|
平均值
|
properties.doesAverage | boolean |
是否平均。 |
|
總計
|
properties.doesTotal | boolean |
是否總計。 |
|
空白為零
|
properties.blankIsZero | boolean |
空白是否為零。 |
|
權限
|
permissions | array of object | |
|
權限類型
|
permissions.permissionType | string |
權限類型。 |
|
Role
|
permissions.role | string |
角色。 |
|
角色 ID
|
permissions.roleId | integer |
角色的識別碼。 |
|
新增至表單
|
addToForms | boolean |
是否要新增至表單。 |
取得餐桌
取得屬於應用程式一部分的個別資料表的屬性。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
應用程式的唯一識別碼 |
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼 （DBID）。 |
傳回
- 取得表格回應
- getTableResponse
執行公式
允許透過 API 呼叫執行公式。 在自訂程式碼中使用此方法，以取得記錄上沒有離散欄位的公式值。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
公式
|
formula | True | string |
要運行的公式。 這必須是有效的 Quickbase 公式。 |
|
擺脫
|
rid | integer |
要執行公式的記錄識別碼。 僅適用於在記錄內容中執行的公式。 例如，公式 User（） 不需要記錄 ID。 |
|
|
從
|
from | True | string |
表格的唯一識別碼 （dbid）。 |
傳回
- 執行公式回應
- runFormulaResponse
執行報表
根據識別碼執行報表，並傳回與其相關聯的基礎資料。 資料的格式會因報表類型而異。 著重於記錄層級資料 （資料表、行事曆等） 的報表會傳回個別記錄。 彙總報告（摘要、圖表）將返回報告中配置的摘要資訊。 不會傳回 UI 特定的元素，例如總計、平均值和視覺效果。 根據每筆記錄的近似大小，以智慧型分頁傳回資料。 中繼資料物件將包含必要的資訊，以逐一查看回應並收集更多資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
表格 ID
|
tableId | True | string |
報表資料表的識別碼。 |
|
跳過
|
skip | integer |
要略過的記錄數。 您可以在對一組結果進行分頁時設定此值。 |
|
|
前幾個
|
top | integer |
要傳回的記錄數目上限。 您可以覆寫預設的 Quickbase 分頁，以取得更多或更少的結果。 如果您在此處請求的值超過動態最大值，我們將傳回結果的子集，其餘的可以在後續的 API 呼叫中收集。 |
|
|
|
object | |||
|
報表識別碼
|
reportId | True | string |
報表的識別碼，對資料表來說是唯一的。 |
傳回
- 執行報告回應
- runReportResponse
建立一個關係
在表格以及查詢/摘要欄位中建立關係。 只能為相同應用程式內的資料表建立關聯性。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
總結Fid
|
summaryFid | double |
要摘要的欄位識別碼。 |
|
|
標籤
|
label | string |
摘要欄位的標籤。 |
|
|
累積類型
|
accumulationType | True | string |
摘要欄位的累積類型。 |
|
where
|
where | string |
篩選器，使用 Quickbase 查詢語言，決定要傳回的記錄。 |
|
|
lookupFieldIds
|
lookupFieldIds | array of integer |
父資料表中的欄位識別碼陣列，將成為子資料表中的查閱欄位。 |
|
|
parentTableId
|
parentTableId | True | string |
關係的父資料表識別碼。 |
|
標籤
|
label | string |
外部索引鍵欄位的標籤。 |
|
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼 （DBID）。 這將是子表。 |
傳回
- 建立關係回應
- createRelationshipResponse
建立應用程式
在帳戶中建立應用程式。 您必須在相應帳戶中擁有應用程式建立權限。 可以使用此 API 設定主要屬性和應用程式變數。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
assignToken
|
assignToken | boolean |
如果您想要將應用程式指派給您用來建立應用程式的使用者權杖，請設定為 true。 默認值為 false。 |
|
|
名稱
|
name | True | string |
變數的名稱。 |
|
value
|
value | True | string |
變數的值。 |
|
名稱
|
name | True | string |
應用程式名稱。 您可以在相同的領域中建立多個具有相同名稱的應用程式，因為它們將具有不同的 dbid 值。 我們敦促您在這樣做時要小心。 |
|
說明
|
description | string |
應用程式的描述。 如果省略此屬性，應用程式描述將為空白。 |
傳回
- 建立應用程式回應
- createAppResponse
建立數據表
在應用程式中建立資料表。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
應用程式的唯一識別碼 |
|
名稱
|
name | True | string |
表格的名稱。 |
|
複數記錄名稱
|
pluralRecordName | string |
表格中記錄的複數名詞。 如果未傳遞此值，則預設值為「記錄」。 |
|
|
單一記錄名稱
|
singleRecordName | string |
表格中記錄的單數名詞。 如果未傳遞此值，則預設值為「Record」。 |
|
|
說明
|
description | string |
表格的描述。 如果未傳遞此值，則預設值為空白。 |
傳回
- 建立表格回應
- createTableResponse
建立欄位
在表格中建立欄位，包括該欄位的自訂權限。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼。 |
|
經審計
|
audited | boolean |
指出欄位是否作為 Quickbase 稽核記錄的一部分進行追蹤。 只有在應用程式已啟用稽核記錄時，您才能將此屬性設定為 “true”。 請參閱 Quickbase 稽核記錄下的啟用資料變更記錄。 |
|
|
欄位幫助
|
fieldHelp | string |
在產品內向使用者顯示的已設定說明文字。 |
|
|
bold
|
bold | boolean |
指出欄位是否配置為在產品中以粗體顯示。 |
|
|
註解
|
comments | string |
管理員在欄位內容上輸入的註解。 |
|
|
does總計
|
doesTotal | boolean |
此欄位是否在產品內的報表中總計。 |
|
|
自動儲存
|
autoSave | boolean |
連結欄位是否會自動儲存。 |
|
|
defaultValueLuid
|
defaultValueLuid | integer |
預設使用者 ID 值。 |
|
|
最大版本
|
maxVersions | integer |
為檔案附件設定的版本數目上限。 |
|
|
format
|
format | integer |
顯示時間的格式。 |
|
|
攜帶選擇
|
carryChoices | boolean |
複製時，欄位是否應攜帶其多項選擇欄位。 |
|
|
最大長度
|
maxLength | integer |
此欄位在 Quickbase 中允許輸入的字元數上限。 |
|
|
連結文字
|
linkText | string |
已設定的文字值，取代使用者在產品中看到的URL。 |
|
|
parentFieldId
|
parentFieldId | integer |
父複合欄位的識別碼 （如果適用）。 |
|
|
顯示時區
|
displayTimezone | boolean |
指出是否要在產品內顯示時區。 |
|
|
允許新選擇
|
allowNewChoices | boolean |
指出使用者是否可以將新選擇新增至選取清單。 |
|
|
預設今天
|
defaultToday | boolean |
指出欄位值是否預設為新記錄的預設值。 |
|
|
單位
|
units | string |
單位標籤。 |
|
|
來源欄位標識符
|
sourceFieldId | integer |
來源欄位的 ID。 |
|
|
做平均
|
doesAverage | boolean |
此欄位是否為產品內報告中的平均值。 |
|
|
公式
|
formula | string |
在 Quickbase 中設定的欄位公式。 |
|
|
小數點位數
|
decimalPlaces | integer |
此欄位的產品中顯示的小數位數。 |
|
|
顯示月
|
displayMonth | string |
如何顯示月份。 |
|
|
參見版本
|
seeVersions | boolean |
指出使用者是否可以看到產品內檔案附件的其他版本 （除了最新版本之外）。 |
|
|
數字行
|
numLines | integer |
此文字欄位在 Quickbase 中顯示的行數。 |
|
|
預設種類
|
defaultKind | string |
使用者預設類型。 |
|
|
顯示電子郵件
|
displayEmail | string |
電子郵件的顯示方式。 |
|
|
封面文字
|
coverText | string |
可用來在瀏覽器中顯示連結的替代使用者易記文字。 |
|
|
貨幣符號
|
currencySymbol | string |
在產品內顯示欄位值時使用的目前符號。 |
|
|
targetFieldId
|
targetFieldId | integer |
目標欄位的 ID。 |
|
|
顯示用戶
|
displayUser | string |
使用者在產品內顯示方式的已設定選項。 |
|
|
空白為零
|
blankIsZero | boolean |
在產品內的計算中，空白值是否被視為 0。 |
|
|
確切
|
exact | boolean |
報表連結是否需要完全相符。 |
|
|
預設網域
|
defaultDomain | string |
預設電子郵件網域。 |
|
|
defaultValue
|
defaultValue | string |
新增記錄時為欄位設定的預設值。 |
|
|
縮短
|
abbreviate | boolean |
顯示 URL 時，請勿顯示 URL 通訊協定。 |
|
|
數字格式
|
numberFormat | integer |
用來在產品中顯示數值的格式 （小數、分隔符號、數字群組）。 |
|
|
targetTableName
|
targetTableName | string |
欄位的目標資料表名稱。 |
|
|
出現為
|
appearsAs | string |
連結文字，如果為空，則會使用網址作為連結文字。 |
|
|
寬度
|
width | integer |
產品中欄位的 html 輸入寬度。 |
|
|
貨幣格式
|
currencyFormat | string |
在產品內顯示欄位值時使用的貨幣格式。 |
|
|
顯示影像
|
displayImages | boolean |
指出是否會針對產品內表單和報表上的檔案附件顯示影像。 |
|
|
顯示星期幾
|
displayDayOfWeek | boolean |
指出是否要在產品內顯示星期幾。 |
|
|
逗號開始
|
commaStart | integer |
產品中逗號前的位數 （如果適用）。 |
|
|
選擇
|
choices | array of string |
為使用者提供選擇的欄位存在的項目陣列。 請注意，這些選擇是指未來新增的任何記錄的有效值。 您可以從選擇清單中移除值，即使此欄位中有具有這些值的現有記錄。 當使用者在瀏覽器中查看資料時，它們將顯示為紅色，但沒有其他效果。 使用此內容更新欄位時，會移除舊選項並由新選項取代。 |
|
|
targetTableId
|
targetTableId | string |
目標資料表的識別碼。 |
|
|
displayRelative
|
displayRelative | boolean |
是否將時間顯示為相對時間。 |
|
|
複合欄位
|
compositeFields | object | ||
|
顯示時間
|
displayTime | boolean |
指出是否要顯示日期以外的時間。 |
|
|
版本模式
|
versionMode | string |
檔案的版本模式。 保留所有版本與保留最後一個版本。 |
|
|
snapFieldId
|
snapFieldId | integer |
用來快照值的欄位 ID （如果適用）。 |
|
|
小時24
|
hours24 | boolean |
指示是否在產品內以 24 小時格式顯示時間。 |
|
|
排序阿爾法
|
sortAlpha | boolean |
是否依字母順序排序，預設排序是依記錄識別碼。 |
|
|
排序如給予
|
sortAsGiven | boolean |
指出列出的項目是按輸入排序還是按字母順序排序。 |
|
|
has擴展
|
hasExtension | boolean |
此欄位是否有電話分機。 |
|
|
使用新視窗
|
useNewWindow | boolean |
指出當使用者在產品中按一下 URL 時，URL 是否應開啟新視窗。 |
|
|
appendOnly
|
appendOnly | boolean |
此欄位是否僅附加。 |
|
|
displayAsLink
|
displayAsLink | boolean |
指出屬於關係一部分的欄位是否應顯示為產品內父記錄的超連結。 |
|
|
appearsByDefault
|
appearsByDefault | boolean |
指出欄位是否在報表中標示為預設值。 |
|
|
欄位類型2
|
fieldType | True | string |
欄位類型，按一下任何欄位類型連結以取得更多資訊。 |
|
角色
|
role | string |
與欄位的指定許可權相關聯的角色 |
|
|
許可類型
|
permissionType | string |
授予此欄位角色的權限 |
|
|
角色ID
|
roleId | integer |
指定角色的 ID |
|
|
addToForms
|
addToForms | boolean |
您要新增的欄位是否應顯示在表單上。 |
|
|
標籤
|
label | True | string |
欄位的標籤 （名稱）。 |
|
find已啟用
|
findEnabled | boolean |
指出欄位是否標示為可搜尋。 |
|
|
無包裝
|
noWrap | boolean |
指出欄位是否設定為在產品中顯示時不換行。 |
傳回
- 建立欄位回應
- createFieldResponse
插入和或更新記錄
在表格中插入和/或更新記錄。 在此單一 API 呼叫中，可以提交插入和更新。 更新可以使用資料表上的索引鍵欄位，或任何其他支援的唯一欄位。 請參閱欄位 型別頁面 ，以取得有關每個欄位型別應如何格式化的詳細資訊。 此作業容許累加式處理成功的記錄，即使某些記錄失敗也一樣。
便條： 此端點支援 10MB 的承載大小上限。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
至
|
to | True | string |
資料表識別碼。 |
|
資料
|
data | object | ||
|
mergeFieldId
|
mergeFieldId | integer |
合併欄位識別碼。 |
|
|
欄位到返回
|
fieldsToReturn | array of integer |
指定欄位識別碼陣列，以傳回任何更新或新增記錄的資料。 如果要求任何欄位 ID，則一律會傳回記錄 ID （FID 3）。 |
傳回
成功的回應，包括有關已添加、更新或未更改的記錄的詳細信息。 在下列範例中，資料表先前有十筆 ID 從 1 到 10 的記錄。 使用者張貼更新插入，以更新記錄 1 的值，並新增兩筆新記錄，全部成功。
- 更新插入回應
- upsertResponse
更新應用程式
更新特定應用程式的主要內容和/或應用程式變數。 您未在要求本文中指定的應用程式的任何屬性都會保持不變。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名稱
|
name | True | string |
變數的名稱。 |
|
value
|
value | True | string |
變數的值。 |
|
名稱
|
name | string |
應用程式的名稱。 |
|
|
說明
|
description | string |
應用程式的描述。 |
|
|
App ID
|
appId | True | string |
應用程式的唯一識別碼。 |
傳回
- 更新應用程式回應
- updateAppResponse
更新數據表
更新特定資料表的主要內容。 您未在要求內文中指定的表格的任何屬性將保持不變。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
App ID
|
appId | True | string |
應用程式的唯一識別碼 |
|
名稱
|
name | string |
表格的名稱。 |
|
|
複數記錄名稱
|
pluralRecordName | string |
表格中記錄的複數名詞。 如果未傳遞此值，則預設值為「記錄」。 |
|
|
單一記錄名稱
|
singleRecordName | string |
表格中記錄的單數名詞。 如果未傳遞此值，則預設值為「Record」。 |
|
|
說明
|
description | string |
表格的描述。 如果未傳遞此值，則預設值為空白。 |
|
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼 （DBID）。 |
傳回
- 更新表格回應
- updateTableResponse
更新欄位
更新欄位的屬性和自訂權限。 嘗試更新某些內容可能會導致現有資料不再服從欄位的新內容，並可能被拒絕。 如需特定情況，請參閱下方必要、唯一和選擇的說明。 您未在要求本文中指定的欄位的任何屬性都會保持不變。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼。 |
|
經審計
|
audited | boolean |
指出欄位是否作為 Quickbase 稽核記錄的一部分進行追蹤。 只有在應用程式已啟用稽核記錄時，您才能將此屬性設定為 “true”。 請參閱 Quickbase 稽核記錄下的啟用資料變更記錄。 |
|
|
欄位幫助
|
fieldHelp | string |
在產品內向使用者顯示的已設定說明文字。 |
|
|
bold
|
bold | boolean |
指出欄位是否配置為在產品中以粗體顯示。 |
|
|
required
|
required | boolean |
指出欄位是否為必要欄位 （亦即，如果每筆記錄在此欄位中都必須具有非空值）。 如果您嘗試將欄位從非必要變更為必要，且資料表目前包含該欄位中具有空值的記錄，則會收到錯誤，指出該欄位有空值。 在此情況下，您必須先尋找並更新那些欄位值為空值的記錄，然後再將欄位變更為必要。 |
|
|
註解
|
comments | string |
管理員在欄位內容上輸入的註解。 |
|
|
does總計
|
doesTotal | boolean |
此欄位是否在產品內的報表中總計。 |
|
|
自動儲存
|
autoSave | boolean |
連結欄位是否會自動儲存。 |
|
|
defaultValueLuid
|
defaultValueLuid | integer |
預設使用者 ID 值。 |
|
|
最大版本
|
maxVersions | integer |
為檔案附件設定的版本數目上限。 |
|
|
format
|
format | integer |
顯示時間的格式。 |
|
|
攜帶選擇
|
carryChoices | boolean |
複製時，欄位是否應攜帶其多項選擇欄位。 |
|
|
最大長度
|
maxLength | integer |
此欄位在 Quickbase 中允許輸入的字元數上限。 |
|
|
連結文字
|
linkText | string |
已設定的文字值，取代使用者在產品中看到的URL。 |
|
|
parentFieldId
|
parentFieldId | integer |
父複合欄位的識別碼 （如果適用）。 |
|
|
顯示時區
|
displayTimezone | boolean |
指出是否要在產品內顯示時區。 |
|
|
summaryTargetFieldId
|
summaryTargetFieldId | integer |
用來彙總子系值的欄位識別碼 （如果適用）。 如果摘要函數不需要欄位選取 （例如計數），則會顯示 0。 |
|
|
允許新選擇
|
allowNewChoices | boolean |
指出使用者是否可以將新選擇新增至選取清單。 |
|
|
預設今天
|
defaultToday | boolean |
指出欄位值是否預設為新記錄的預設值。 |
|
|
單位
|
units | string |
單位標籤。 |
|
|
lookupTargetFieldId
|
lookupTargetFieldId | integer |
此查閱的父資料表上目標的欄位識別碼。 |
|
|
摘要功能3
|
summaryFunction | string |
摘要欄位的累積類型。 |
|
|
來源欄位標識符
|
sourceFieldId | integer |
來源欄位的 ID。 |
|
|
做平均
|
doesAverage | boolean |
此欄位是否為產品內報告中的平均值。 |
|
|
公式
|
formula | string |
在 Quickbase 中設定的欄位公式。 |
|
|
小數點位數
|
decimalPlaces | integer |
此欄位的產品中顯示的小數位數。 |
|
|
顯示月
|
displayMonth | string |
如何顯示月份。 |
|
|
參見版本
|
seeVersions | boolean |
指出使用者是否可以看到產品內檔案附件的其他版本 （除了最新版本之外）。 |
|
|
數字行
|
numLines | integer |
此文字欄位在 Quickbase 中顯示的行數。 |
|
|
預設種類
|
defaultKind | string |
使用者預設類型。 |
|
|
顯示電子郵件
|
displayEmail | string |
電子郵件的顯示方式。 |
|
|
封面文字
|
coverText | string |
可用來在瀏覽器中顯示連結的替代使用者易記文字。 |
|
|
貨幣符號
|
currencySymbol | string |
在產品內顯示欄位值時使用的目前符號。 |
|
|
summary查詢
|
summaryQuery | string |
摘要查詢。 |
|
|
targetFieldId
|
targetFieldId | integer |
目標欄位的 ID。 |
|
|
顯示用戶
|
displayUser | string |
使用者在產品內顯示方式的已設定選項。 |
|
|
空白為零
|
blankIsZero | boolean |
在產品內的計算中，空白值是否被視為 0。 |
|
|
確切
|
exact | boolean |
報表連結是否需要完全相符。 |
|
|
預設網域
|
defaultDomain | string |
預設電子郵件網域。 |
|
|
defaultValue
|
defaultValue | string |
新增記錄時為欄位設定的預設值。 |
|
|
縮短
|
abbreviate | boolean |
顯示 URL 時，請勿顯示 URL 通訊協定。 |
|
|
數字格式
|
numberFormat | integer |
用來在產品中顯示數值的格式 （小數、分隔符號、數字群組）。 |
|
|
targetTableName
|
targetTableName | string |
欄位的目標資料表名稱。 |
|
|
出現為
|
appearsAs | string |
連結文字，如果為空，則會使用網址作為連結文字。 |
|
|
寬度
|
width | integer |
產品中欄位的 html 輸入寬度。 |
|
|
貨幣格式
|
currencyFormat | string |
在產品內顯示欄位值時使用的貨幣格式。 |
|
|
顯示影像
|
displayImages | boolean |
指出是否會針對產品內表單和報表上的檔案附件顯示影像。 |
|
|
顯示星期幾
|
displayDayOfWeek | boolean |
指出是否要在產品內顯示星期幾。 |
|
|
summaryReferenceFieldId
|
summaryReferenceFieldId | integer |
此摘要關係中參考的欄位 ID。 |
|
|
逗號開始
|
commaStart | integer |
產品中逗號前的位數 （如果適用）。 |
|
|
選擇
|
choices | array of string |
為使用者提供選擇的欄位存在的項目陣列。 請注意，這些選擇是指未來新增的任何記錄的有效值。 您可以從選擇清單中移除值，即使此欄位中有具有這些值的現有記錄。 當使用者在瀏覽器中查看資料時，它們將顯示為紅色，但沒有其他效果。 使用此內容更新欄位時，會移除舊選項並由新選項取代。 |
|
|
targetTableId
|
targetTableId | string |
目標資料表的識別碼。 |
|
|
displayRelative
|
displayRelative | boolean |
是否將時間顯示為相對時間。 |
|
|
複合欄位
|
compositeFields | object | ||
|
summaryTableId
|
summaryTableId | string |
摘要欄位參考欄位的表格。 |
|
|
顯示時間
|
displayTime | boolean |
指出是否要顯示日期以外的時間。 |
|
|
版本模式
|
versionMode | string |
檔案的版本模式。 保留所有版本與保留最後一個版本。 |
|
|
snapFieldId
|
snapFieldId | integer |
用來快照值的欄位 ID （如果適用）。 |
|
|
小時24
|
hours24 | boolean |
指示是否在產品內以 24 小時格式顯示時間。 |
|
|
排序阿爾法
|
sortAlpha | boolean |
是否依字母順序排序，預設排序是依記錄識別碼。 |
|
|
排序如給予
|
sortAsGiven | boolean |
指出列出的項目是按輸入排序還是按字母順序排序。 |
|
|
has擴展
|
hasExtension | boolean |
此欄位是否有電話分機。 |
|
|
使用新視窗
|
useNewWindow | boolean |
指出當使用者在產品中按一下 URL 時，URL 是否應開啟新視窗。 |
|
|
appendOnly
|
appendOnly | boolean |
此欄位是否僅附加。 |
|
|
displayAsLink
|
displayAsLink | boolean |
指出屬於關係一部分的欄位是否應顯示為產品內父記錄的超連結。 |
|
|
lookupReferenceFieldId
|
lookupReferenceFieldId | integer |
此查詢關係中參考的欄位 ID。 |
|
|
appearsByDefault
|
appearsByDefault | boolean |
指出欄位是否在報表中標示為預設值。 |
|
|
獨特
|
unique | boolean |
指出表格中的每筆記錄是否必須包含此欄位的唯一值。 如果您嘗試將欄位從非唯一變更為唯一，且資料表目前包含此欄位值相同的記錄，則會收到錯誤。 在此情況下，您需要先尋找並更新那些具有重複欄位值的記錄，然後再將欄位變更為唯一。 |
|
|
角色
|
role | string |
與欄位的指定許可權相關聯的角色 |
|
|
許可類型
|
permissionType | string |
授予此欄位角色的權限 |
|
|
角色ID
|
roleId | integer |
指定角色的 ID |
|
|
addToForms
|
addToForms | boolean |
您要新增的欄位是否應顯示在表單上。 |
|
|
標籤
|
label | string |
欄位的標籤 （名稱）。 |
|
|
find已啟用
|
findEnabled | boolean |
指出欄位是否標示為可搜尋。 |
|
|
無包裝
|
noWrap | boolean |
指出欄位是否設定為在產品中顯示時不換行。 |
|
|
欄位識別碼
|
fieldId | True | integer |
欄位的唯一識別碼 （FID）。 |
傳回
- 更新欄位回應
- updateFieldResponse
更新關聯性
使用此端點可將查閱欄位和摘要欄位新增至現有關係。 更新關聯性不會刪除現有的查閱/摘要欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
總結Fid
|
summaryFid | double |
要摘要的欄位識別碼。 |
|
|
標籤
|
label | string |
摘要欄位的標籤。 |
|
|
累積類型
|
accumulationType | True | string |
摘要欄位的累積類型。 |
|
where
|
where | string |
篩選器，使用 Quickbase 查詢語言，決定要傳回的記錄。 |
|
|
lookupFieldIds
|
lookupFieldIds | array of integer |
父資料表上的欄位識別碼陣列，將成為子資料表上的查閱欄位。 |
|
|
表格 ID
|
tableId | True | string |
資料表的唯一識別碼 （DBID）。 這將是子表。 |
|
關係識別碼
|
relationshipId | True | double |
關係識別碼。 這是子資料表上參考欄位的欄位識別碼。 |
傳回
- 更新關係回應
- updateRelationshipResponse
查詢資料
以 Quickbase 查詢語言傳入查詢。 根據每筆記錄的近似大小，傳回具有 智慧分頁 的記錄資料。 中繼資料物件將包含必要的資訊，以逐一查看回應並收集更多資料。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
略過
|
skip | integer |
要略過的記錄數。 |
|
|
比較WithAppLocalTime
|
compareWithAppLocalTime | boolean |
是否要針對應用程式本機時間的日期時間欄位執行查詢。 依預設，查詢會以 UTC 時間執行。 |
|
|
top
|
top | integer |
要顯示的記錄數目上限。 |
|
|
where
|
where | string |
篩選器，使用 Quickbase 查詢語言，決定要傳回的記錄。 如果省略此參數，查詢將傳回所有記錄。 |
|
|
欄位標識碼
|
fieldId | integer |
資料表中欄位的唯一識別碼。 |
|
|
Grouping
|
grouping | string |
根據遞增順序 （ASC）、遞減順序 （DESC） 或相等值 （equal-values） 進行分組 |
|
|
排序依據
|
sortBy | object |
依預設，查詢會依指定的排序欄位排序，如果查詢未提供任何排序，則會依預設排序。 設定為 false 以避免在傳回資料的順序不重要時進行排序。 傳回資料而不排序可以提高效能。 |
|
|
select
|
select | object | ||
|
從
|
from | True | string |
資料表識別碼。 |
傳回
- 執行查詢回應
- runQueryResponse
複製使用者權杖
複製已驗證的使用者權杖。 與該權杖相關聯的所有應用程式都會自動與新權杖相關聯。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名稱
|
name | string |
複製使用者權杖的新名稱。 |
|
|
說明
|
description | string |
複製使用者權杖的說明。 |
傳回
- 複製使用者權杖回應
- cloneUserTokenResponse
複製應用程式
複製指定的應用程式。 新應用程式將具有與原始應用程式相同的結構描述。 有關其他複製選項，請參閱下文。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名稱
|
name | True | string |
新複製的應用程式名稱 |
|
說明
|
description | string |
新複製的應用程式的說明 |
|
|
assignUserToken
|
assignUserToken | boolean |
是否要將用來提出此要求的使用者權杖新增至新應用程式 |
|
|
exclude檔案
|
excludeFiles | boolean |
如果keepData為true，則是否也複製檔案附件。 如果 keepData 為 false，則會忽略此屬性 |
|
|
keepData
|
keepData | boolean |
是否要將應用程式的資料與結構描述一起複製 |
|
|
使用者和角色
|
usersAndRoles | boolean |
如果為true，則會複製使用者及其指派的角色。 如果為false，則會複製使用者和角色，但不會指派角色 |
|
|
App ID
|
appId | True | string |
應用程式的唯一識別碼。 |
傳回
- 複製應用程式回應
- copyAppResponse
定義
createApp回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
應用程式名稱。 您可以在相同的領域中建立多個具有相同名稱的應用程式，因為它們將具有不同的 dbid 值。 我們敦促您在這樣做時要小心。 |
|
說明
|
description | string |
應用程式的描述。 如果省略此屬性，應用程式描述將為空白。 |
|
創建
|
created | string |
應用程式的建立時間和日期，採用 ISO 8601 時間格式 YYYY-MM-DDThh：mm：ss.sssZ （UTC 時區）。 |
|
更新
|
updated | string |
應用程式上次更新的時間和日期，採用 ISO 8601 時間格式 YYYY-MM-DDThh：mm：ss.sssZ （UTC 時區）。 |
|
dateFormat
|
dateFormat | string |
在此應用程式中顯示日期值時使用的格式說明。 請注意，這是僅限瀏覽器的引數 — 請參閱API指南中的 欄位型別詳細資料 頁面，以瞭解如何在API呼叫中傳回時間值。 請參閱關於 本地化日期 以設定 App 的日期格式。 |
|
timeZone
|
timeZone | string |
在此應用程式中顯示時間值時使用的時區說明。 請注意，這是僅限瀏覽器的參數 - 請參閱入口網站中的 欄位類型詳細資料 頁面，以瞭解如何在 API 呼叫中傳回時間值。 請參閱 設定應用程式和帳戶的時區 ，以設定應用程式的時區。 |
|
識別碼
|
id | string |
此應用程式的唯一識別碼。 |
|
有EveryoneOnTheInternet
|
hasEveryoneOnTheInternet | boolean |
指出應用程式是否包含網際網路上的每個人存取。 請參閱：與 網際網路上的所有人共享 App（EOTI）。 |
|
variables
|
variables | array of Variable1 |
應用程式變數。 請參閱 關於應用程式變數 |
|
資料分類
|
dataClassification | string |
指派給應用程式的資料分類標籤。 如果未開啟「資料分類」，則不會傳回此值。 如果已開啟資料分類，但未標記應用程式，我們會傳回「無」。 資料分類標籤可由 Realm 管理員在 Platform+ 方案的 Admin Console 中新增。 |
變數1
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
變數名稱。 |
|
value
|
value | string |
可變值。 |
getApp回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
應用程式名稱。 您可以在相同的領域中建立多個具有相同名稱的應用程式，因為它們將具有不同的 dbid 值。 我們敦促您在這樣做時要小心。 |
|
說明
|
description | string |
應用程式的描述。 如果省略此屬性，應用程式描述將為空白。 |
|
創建
|
created | string |
應用程式的建立時間和日期，採用 ISO 8601 時間格式 YYYY-MM-DDThh：mm：ss.sssZ （UTC 時區）。 |
|
更新
|
updated | string |
應用程式上次更新的時間和日期，採用 ISO 8601 時間格式 YYYY-MM-DDThh：mm：ss.sssZ （UTC 時區）。 |
|
dateFormat
|
dateFormat | string |
在此應用程式中顯示日期值時使用的格式說明。 請注意，這是僅限瀏覽器的引數 — 請參閱API指南中的 欄位型別詳細資料 頁面，以瞭解如何在API呼叫中傳回時間值。 請參閱關於 本地化日期 以設定 App 的日期格式。 |
|
timeZone
|
timeZone | string |
在此應用程式中顯示時間值時使用的時區說明。 請注意，這是僅限瀏覽器的參數 - 請參閱入口網站中的 欄位類型詳細資料 頁面，以瞭解如何在 API 呼叫中傳回時間值。 請參閱 設定應用程式和帳戶的時區 ，以設定應用程式的時區。 |
|
識別碼
|
id | string |
此應用程式的唯一識別碼。 |
|
有EveryoneOnTheInternet
|
hasEveryoneOnTheInternet | boolean |
指出應用程式是否包含網際網路上的每個人存取。 請參閱：與 網際網路上的所有人共享 App（EOTI）。 |
|
variables
|
variables | array of Variable1 |
應用程式變數。 請參閱 關於應用程式變數 |
|
資料分類
|
dataClassification | string |
指派給應用程式的資料分類標籤。 如果未開啟「資料分類」，則不會傳回此值。 如果已開啟資料分類，但未標記應用程式，我們會傳回「無」。 資料分類標籤可由 Realm 管理員在 Platform+ 方案的 Admin Console 中新增。 |
updateApp回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
應用程式名稱。 您可以在相同的領域中建立多個具有相同名稱的應用程式，因為它們將具有不同的 dbid 值。 我們敦促您在這樣做時要小心。 |
|
說明
|
description | string |
應用程式的描述。 如果省略此屬性，應用程式描述將為空白。 |
|
創建
|
created | string |
應用程式的建立時間和日期，採用 ISO 8601 時間格式 YYYY-MM-DDThh：mm：ss.sssZ （UTC 時區）。 |
|
更新
|
updated | string |
應用程式上次更新的時間和日期，採用 ISO 8601 時間格式 YYYY-MM-DDThh：mm：ss.sssZ （UTC 時區）。 |
|
dateFormat
|
dateFormat | string |
在此應用程式中顯示日期值時使用的格式說明。 請注意，這是僅限瀏覽器的引數 — 請參閱API指南中的 欄位型別詳細資料 頁面，以瞭解如何在API呼叫中傳回時間值。 請參閱關於 本地化日期 以設定 App 的日期格式。 |
|
timeZone
|
timeZone | string |
在此應用程式中顯示時間值時使用的時區說明。 請注意，這是僅限瀏覽器的參數 - 請參閱入口網站中的 欄位類型詳細資料 頁面，以瞭解如何在 API 呼叫中傳回時間值。 請參閱 設定應用程式和帳戶的時區 ，以設定應用程式的時區。 |
|
識別碼
|
id | string |
此應用程式的唯一識別碼。 |
|
有EveryoneOnTheInternet
|
hasEveryoneOnTheInternet | boolean |
指出應用程式是否包含網際網路上的每個人存取。 請參閱：與 網際網路上的所有人共享 App（EOTI）。 |
|
variables
|
variables | array of Variable1 |
應用程式變數。 請參閱 關於應用程式變數 |
|
資料分類
|
dataClassification | string |
指派給應用程式的資料分類標籤。 如果未開啟「資料分類」，則不會傳回此值。 如果已開啟資料分類，但未標記應用程式，我們會傳回「無」。 資料分類標籤可由 Realm 管理員在 Platform+ 方案的 Admin Console 中新增。 |
deleteApp回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
deletedAppId
|
deletedAppId | string |
已刪除應用程式的 ID。 |
copyApp回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
應用程式名稱。 您可以在相同的領域中建立多個具有相同名稱的應用程式，因為它們將具有不同的 dbid 值。 我們敦促您在這樣做時要小心。 |
|
說明
|
description | string |
應用程式的說明 |
|
創建
|
created | string |
應用程式的建立時間和日期，採用 ISO 8601 時間格式 YYYY-MM-DDThh：mm：ss.sssZ （UTC 時區）。 |
|
更新
|
updated | string |
應用程式上次更新的時間和日期，採用 ISO 8601 時間格式 YYYY-MM-DDThh：mm：ss.sssZ （UTC 時區）。 |
|
dateFormat
|
dateFormat | string |
在此應用程式中顯示日期值時使用的格式說明。 請注意，這是僅限瀏覽器的引數 — 請參閱API指南中的 欄位型別詳細資料 頁面，以瞭解如何在API呼叫中傳回時間值。 請參閱關於 本地化日期 以設定 App 的日期格式。 |
|
timeZone
|
timeZone | string |
在此應用程式中顯示時間值時使用的時區說明。 請注意，這是僅限瀏覽器的參數 - 請參閱入口網站中的 欄位類型詳細資料 頁面，以瞭解如何在 API 呼叫中傳回時間值。 請參閱 設定應用程式和帳戶的時區 ，以設定應用程式的時區。 |
|
識別碼
|
id | string |
此應用程式的唯一識別碼。 |
|
有EveryoneOnTheInternet
|
hasEveryoneOnTheInternet | boolean |
指出應用程式是否包含網際網路上的每個人存取。 請參閱：與 網際網路上的所有人共享 App（EOTI）。 |
|
variables
|
variables | array of Variable1 |
應用程式變數。 請參閱 關於應用程式變數 |
|
祖先識別碼
|
ancestorId | string |
複製此應用程式的應用程式識別碼 |
|
資料分類
|
dataClassification | string |
指派給應用程式的資料分類標籤。 如果未開啟「資料分類」，則不會傳回此值。 如果已開啟資料分類，但未標記應用程式，我們會傳回「無」。 資料分類標籤可由 Realm 管理員在 Platform+ 方案的 Admin Console 中新增。 |
createTable回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
數據表的名稱。 |
|
識別碼
|
id | string |
表格的唯一識別碼 （dbid）。 |
|
別名
|
alias | string |
表格自動建立的資料表別名。 |
|
說明
|
description | string |
表格的說明，由應用程式管理員設定。 |
|
創建
|
created | string |
建立表格的時間和日期，採用 ISO 8601 時間格式 YYYY-MM-DDThh：mm：ss.sssZ （UTC 時區）。 |
|
更新
|
updated | string |
上次更新資料表結構描述或資料的時間和日期，採用 ISO 8601 時間格式 YYYY-MM-DDThh：mm：ss.sssZ （UTC 時區）。 |
|
下一個記錄標識符
|
nextRecordId | integer |
建立下一筆記錄時將使用的增量記錄 ID，如執行 API 呼叫時所決定的。 |
|
nextFieldId
|
nextFieldId | integer |
建立下一個欄位時將使用的增量欄位ID，如執行API呼叫時所決定。 |
|
defaultSortFieldId
|
defaultSortFieldId | integer |
針對預設排序設定的欄位 ID。 |
|
預設排序順序
|
defaultSortOrder | DefaultSortOrder |
表格上預設排序順序的組態。 |
|
keyFieldId
|
keyFieldId | integer |
設定為此資料表上索引鍵的欄位 ID，通常是 Quickbase 記錄 ID。 |
|
單一記錄名稱
|
singleRecordName | string |
建置器配置的表格單數名詞。 |
|
複數記錄名稱
|
pluralRecordName | string |
表格的建置器配置複數名詞。 |
|
大小限制
|
sizeLimit | string |
表格的大小限制。 |
|
空間使用過
|
spaceUsed | string |
資料表目前使用的空間量。 |
|
空間剩餘
|
spaceRemaining | string |
資料表使用的剩餘空間量。 |
預設排序順序
getTable回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
數據表的名稱。 |
|
識別碼
|
id | string |
表格的唯一識別碼 （dbid）。 |
|
別名
|
alias | string |
表格自動建立的資料表別名。 |
|
說明
|
description | string |
表格的說明，由應用程式管理員設定。 |
|
創建
|
created | string |
建立表格的時間和日期，採用 ISO 8601 時間格式 YYYY-MM-DDThh：mm：ss.sssZ （UTC 時區）。 |
|
更新
|
updated | string |
上次更新資料表結構描述或資料的時間和日期，採用 ISO 8601 時間格式 YYYY-MM-DDThh：mm：ss.sssZ （UTC 時區）。 |
|
下一個記錄標識符
|
nextRecordId | integer |
建立下一筆記錄時將使用的增量記錄 ID，如執行 API 呼叫時所決定的。 |
|
nextFieldId
|
nextFieldId | integer |
建立下一個欄位時將使用的增量欄位ID，如執行API呼叫時所決定。 |
|
defaultSortFieldId
|
defaultSortFieldId | integer |
針對預設排序設定的欄位 ID。 |
|
預設排序順序
|
defaultSortOrder | DefaultSortOrder |
表格上預設排序順序的組態。 |
|
keyFieldId
|
keyFieldId | integer |
設定為此資料表上索引鍵的欄位 ID，通常是 Quickbase 記錄 ID。 |
|
單一記錄名稱
|
singleRecordName | string |
建置器配置的表格單數名詞。 |
|
複數記錄名稱
|
pluralRecordName | string |
表格的建置器配置複數名詞。 |
|
大小限制
|
sizeLimit | string |
表格的大小限制。 |
|
空間使用過
|
spaceUsed | string |
資料表目前使用的空間量。 |
|
空間剩餘
|
spaceRemaining | string |
資料表使用的剩餘空間量。 |
updateTable回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
數據表的名稱。 |
|
識別碼
|
id | string |
表格的唯一識別碼 （dbid）。 |
|
別名
|
alias | string |
表格自動建立的資料表別名。 |
|
說明
|
description | string |
表格的說明，由應用程式管理員設定。 |
|
創建
|
created | string |
建立表格的時間和日期，採用 ISO 8601 時間格式 YYYY-MM-DDThh：mm：ss.sssZ （UTC 時區）。 |
|
更新
|
updated | string |
上次更新資料表結構描述或資料的時間和日期，採用 ISO 8601 時間格式 YYYY-MM-DDThh：mm：ss.sssZ （UTC 時區）。 |
|
下一個記錄標識符
|
nextRecordId | integer |
建立下一筆記錄時將使用的增量記錄 ID，如執行 API 呼叫時所決定的。 |
|
nextFieldId
|
nextFieldId | integer |
建立下一個欄位時將使用的增量欄位ID，如執行API呼叫時所決定。 |
|
defaultSortFieldId
|
defaultSortFieldId | integer |
針對預設排序設定的欄位 ID。 |
|
預設排序順序
|
defaultSortOrder | DefaultSortOrder |
表格上預設排序順序的組態。 |
|
keyFieldId
|
keyFieldId | integer |
設定為此資料表上索引鍵的欄位 ID，通常是 Quickbase 記錄 ID。 |
|
單一記錄名稱
|
singleRecordName | string |
建置器配置的表格單數名詞。 |
|
複數記錄名稱
|
pluralRecordName | string |
表格的建置器配置複數名詞。 |
|
大小限制
|
sizeLimit | string |
表格的大小限制。 |
|
空間使用過
|
spaceUsed | string |
資料表目前使用的空間量。 |
|
空間剩餘
|
spaceRemaining | string |
資料表使用的剩餘空間量。 |
deleteTable回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
刪除的 TableId
|
deletedTableId | string |
已刪除的資料表識別碼。 |
getRelationships回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
關係
|
relationships | array of Relationship |
表格中的關聯性。 |
|
後設資料
|
metadata | Metadata |
有關可能有幫助的結果的其他信息。 |
Relationship
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
關聯性 ID （外部索引鍵欄位 ID）。 |
|
parentTableId
|
parentTableId | string |
關係的父資料表識別碼。 |
|
childTableId
|
childTableId | string |
關聯性的子資料表識別碼。 |
|
ForeignKey欄位
|
foreignKeyField | ForeignKeyField |
外部索引鍵欄位資訊。 |
|
是跨應用
|
isCrossApp | boolean |
這是否是跨應用關係。 |
|
lookupFields
|
lookupFields | array of LookupField |
查閱欄位陣列。 |
|
summary欄位
|
summaryFields | array of SummaryField |
摘要欄位陣列。 |
ForeignKey欄位
外部索引鍵欄位資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
欄位識別碼。 |
|
標籤
|
label | string |
欄位標籤。 |
|
型別
|
type | string |
欄位類型。 |
LookupField
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
欄位識別碼。 |
|
標籤
|
label | string |
欄位標籤。 |
|
型別
|
type | string |
欄位類型。 |
Summary欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
欄位識別碼。 |
|
標籤
|
label | string |
欄位標籤。 |
|
型別
|
type | string |
欄位類型。 |
後設資料
有關可能有幫助的結果的其他信息。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
略過
|
skip | integer |
要略過的關係數目。 |
|
總關係
|
totalRelationships | integer |
關係總數。 |
|
numRelationships
|
numRelationships | integer |
目前回應物件中的關係數目。 |
createRelationship回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
關聯性 ID （外部索引鍵欄位 ID）。 |
|
parentTableId
|
parentTableId | string |
關係的父資料表識別碼。 |
|
childTableId
|
childTableId | string |
關聯性的子資料表識別碼。 |
|
ForeignKey欄位
|
foreignKeyField | ForeignKeyField |
外部索引鍵欄位資訊。 |
|
是跨應用
|
isCrossApp | boolean |
這是否是跨應用關係。 |
|
lookupFields
|
lookupFields | array of LookupField |
查閱欄位陣列。 |
|
summary欄位
|
summaryFields | array of SummaryField |
摘要欄位陣列。 |
updateRelationship回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
關聯性 ID （外部索引鍵欄位 ID）。 |
|
parentTableId
|
parentTableId | string |
關係的父資料表識別碼。 |
|
childTableId
|
childTableId | string |
關聯性的子資料表識別碼。 |
|
ForeignKey欄位
|
foreignKeyField | ForeignKeyField |
外部索引鍵欄位資訊。 |
|
是跨應用
|
isCrossApp | boolean |
這是否是跨應用關係。 |
|
lookupFields
|
lookupFields | array of LookupField |
查閱欄位陣列。 |
|
summary欄位
|
summaryFields | array of SummaryField |
摘要欄位陣列。 |
deleteRelationship回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
關係標識碼
|
relationshipId | integer |
關聯性識別碼。 |
Query
在 Quickbase 中設定的查詢定義，在執行報表時執行。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
tableId
|
tableId | string |
報表的資料表識別碼。 |
|
篩選
|
filter | string |
用於查詢資料的篩選器。 |
|
公式欄位
|
formulaFields | array of FormulaField |
計算公式欄位。 |
公式欄位
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
公式欄位識別碼。 |
|
標籤
|
label | string |
公式欄位標籤。 |
|
欄位類型
|
fieldType | FieldType |
產生的公式值類型。 |
|
公式
|
formula | string |
公式文字。 |
|
十進制精確度
|
decimalPrecision | integer |
對於數值公式，數字精度。 |
欄位類型
getReport回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
報表的識別碼，對資料表來說是唯一的。 |
|
名稱
|
name | string |
報告的已設定名稱。 |
|
型別
|
type | string |
Quickbase 中的報告類型 （例如圖表）。 |
|
說明
|
description | string |
報告的已配置描述。 |
|
擁有者ID
|
ownerId | integer |
可選，僅針對個人報告顯示。 報表擁有者的使用者 ID。 |
|
Query
|
query | Query |
在 Quickbase 中設定的查詢定義，在執行報表時執行。 |
|
properties
|
properties | object |
報表類型特定的屬性清單。 若要查看每個報告類型內容的詳細描述，請參閱 報告類型。 |
|
used最後
|
usedLast | string |
上次使用報告的時刻。 |
|
已使用計數
|
usedCount | integer |
報告已使用的次數。 |
runReport回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
fields
|
fields | array of Field |
物件陣列，其中包含報告中顯示之每個欄位的有限中繼資料。 這有助於建置相依於欄位類型和 ID 的邏輯。 |
|
資料
|
data | array of object |
代表記錄資料或摘要值的物件陣列，視報告類型而定。 |
|
items
|
data | object | |
|
中繼資料1
|
metadata | Metadata1 |
有關可能有幫助的結果的其他信息。 如果您指定要略過的結果數量少於可用結果的數量，或 API 自動傳回的結果較少，則可能需要分頁。 numRecords 可以與 totalRecords 進行比較，以判斷是否需要進一步分頁。 |
領域
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
欄位識別碼。 |
|
標籤
|
label | string |
欄位標籤。 |
|
型別
|
type | string |
欄位類型。 |
|
labelOverride
|
labelOverride | string |
報表中欄位的欄標題標籤覆寫。 |
中繼資料1
有關可能有幫助的結果的其他信息。 如果您指定要略過的結果數量少於可用結果的數量，或 API 自動傳回的結果較少，則可能需要分頁。 numRecords 可以與 totalRecords 進行比較，以判斷是否需要進一步分頁。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
略過
|
skip | integer |
要略過的記錄數 |
|
數字欄位
|
numFields | integer |
目前回應物件中每筆記錄中的欄位數 |
|
top
|
top | integer |
如果存在，則呼叫者要求的記錄數目上限 |
|
總記錄
|
totalRecords | integer |
結果集中的記錄總數 |
|
數字記錄
|
numRecords | integer |
目前回應物件中的記錄數 |
屬性1
欄位的其他屬性。 請參閱 欄位型別詳細資料頁面 ，以取得每個欄位型別屬性的詳細資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
註解
|
comments | string |
管理員在欄位內容上輸入的註解。 |
|
does總計
|
doesTotal | boolean |
此欄位是否在產品內的報表中總計。 |
|
自動儲存
|
autoSave | boolean |
連結欄位是否會自動儲存。 |
|
defaultValueLuid
|
defaultValueLuid | integer |
預設使用者 ID 值。 |
|
最大版本
|
maxVersions | integer |
為檔案附件設定的版本數目上限。 |
|
攜帶選擇
|
carryChoices | boolean |
複製時，欄位是否應攜帶其多項選擇欄位。 |
|
format
|
format | integer |
顯示時間的格式。 |
|
最大長度
|
maxLength | integer |
此欄位在 Quickbase 中允許輸入的字元數上限。 |
|
連結文字
|
linkText | string |
已設定的文字值，取代使用者在產品中看到的URL。 |
|
parentFieldId
|
parentFieldId | integer |
父複合欄位的識別碼 （如果適用）。 |
|
顯示時區
|
displayTimezone | boolean |
指出是否要在產品內顯示時區。 |
|
summaryTargetFieldId
|
summaryTargetFieldId | integer |
用來彙總子系值的欄位識別碼 （如果適用）。 如果摘要函數不需要欄位選取 （例如計數），則會顯示 0。 |
|
允許新選擇
|
allowNewChoices | boolean |
指出使用者是否可以將新選擇新增至選取清單。 |
|
masterChoiceFieldId
|
masterChoiceFieldId | integer |
作為關係中參考的欄位 ID。 |
|
預設今天
|
defaultToday | boolean |
指出欄位值是否預設為新記錄的預設值。 |
|
單位
|
units | string |
單位標籤。 |
|
lookupTargetFieldId
|
lookupTargetFieldId | integer |
此查閱之主要資料表上目標的欄位 ID。 |
|
摘要函數
|
summaryFunction | SummaryFunction |
摘要累積函數類型。 |
|
來源欄位標識符
|
sourceFieldId | integer |
來源欄位的 ID。 |
|
masterTableTag
|
masterTableTag | string |
此欄位所屬關係中主要資料表的資料表別名。 |
|
做平均
|
doesAverage | boolean |
此欄位是否為產品內報告中的平均值。 |
|
公式
|
formula | string |
在 Quickbase 中設定的欄位公式。 |
|
小數點位數
|
decimalPlaces | integer |
此欄位的產品中顯示的小數位數。 |
|
參見版本
|
seeVersions | boolean |
指出使用者是否可以看到產品內檔案附件的其他版本 （除了最新版本之外）。 |
|
顯示月
|
displayMonth | string |
如何顯示月份。 |
|
數字行
|
numLines | integer |
此文字欄位在 Quickbase 中顯示的行數。 |
|
顯示電子郵件
|
displayEmail | string |
電子郵件的顯示方式。 |
|
預設種類
|
defaultKind | string |
使用者預設類型。 |
|
封面文字
|
coverText | string |
可用來在瀏覽器中顯示連結的替代使用者易記文字。 |
|
貨幣符號
|
currencySymbol | string |
在產品內顯示欄位值時使用的目前符號。 |
|
masterChoiceTableId
|
masterChoiceTableId | integer |
此關係中主要資料表的 ID。 |
|
targetFieldId
|
targetFieldId | integer |
目標欄位的 ID。 |
|
顯示用戶
|
displayUser | string |
使用者在產品內顯示方式的已設定選項。 |
|
空白為零
|
blankIsZero | boolean |
在產品內的計算中，空白值是否被視為 0。 |
|
確切
|
exact | boolean |
報表連結是否需要完全相符。 |
|
開始欄位
|
startField | integer |
起始欄位 ID。 |
|
預設網域
|
defaultDomain | string |
預設電子郵件網域。 |
|
defaultValue
|
defaultValue | string |
新增記錄時為欄位設定的預設值。 |
|
選擇Luid
|
choicesLuid | array of object |
使用者選擇清單。 |
|
items
|
choicesLuid | object | |
|
縮短
|
abbreviate | boolean |
顯示 URL 時，請勿顯示 URL 通訊協定。 |
|
xml標籤
|
xmlTag | string |
欄位的 xml 標籤。 |
|
targetTableName
|
targetTableName | string |
欄位的目標資料表名稱。 |
|
數字格式
|
numberFormat | integer |
用來在產品中顯示數值的格式 （小數、分隔符號、數字群組）。 |
|
出現為
|
appearsAs | string |
連結文字，如果為空，則會使用網址作為連結文字。 |
|
寬度
|
width | integer |
產品中欄位的 html 輸入寬度。 |
|
貨幣格式
|
currencyFormat | CurrencyFormat |
在產品內顯示欄位值時使用的貨幣格式。 |
|
顯示影像
|
displayImages | boolean |
指出是否會針對產品內表單和報表上的檔案附件顯示影像。 |
|
foreignKey
|
foreignKey | boolean |
指出欄位是否為關聯性中的外部索引鍵 （或參考欄位）。 |
|
顯示星期幾
|
displayDayOfWeek | boolean |
指出是否要在產品內顯示星期幾。 |
|
summaryReferenceFieldId
|
summaryReferenceFieldId | integer |
此摘要關係中參考的欄位 ID。 |
|
逗號開始
|
commaStart | integer |
產品中逗號前的位數 （如果適用）。 |
|
選擇
|
choices | array of string |
為使用者提供選擇的欄位存在的項目陣列。 |
|
targetTableId
|
targetTableId | string |
目標資料表的識別碼。 |
|
displayRelative
|
displayRelative | boolean |
是否將時間顯示為相對時間。 |
|
複合欄位
|
compositeFields | array of object |
構成複合欄位的欄位陣列 （例如，位址）。 |
|
items
|
compositeFields | object | |
|
版本模式
|
versionMode | VersionMode |
檔案的版本模式。 保留所有版本與保留最後一個版本。 |
|
顯示時間
|
displayTime | boolean |
指出是否要顯示日期以外的時間。 |
|
duration欄位
|
durationField | integer |
持續時間欄位 ID。 |
|
snapFieldId
|
snapFieldId | integer |
用來快照值的欄位 ID （如果適用）。 |
|
小時24
|
hours24 | boolean |
指示是否在產品內以 24 小時格式顯示時間。 |
|
排序阿爾法
|
sortAlpha | boolean |
是否依字母順序排序，預設排序是依記錄識別碼。 |
|
排序如給予
|
sortAsGiven | boolean |
指出列出的項目是按輸入排序還是按字母順序排序。 |
|
has擴展
|
hasExtension | boolean |
此欄位是否有電話分機。 |
|
工作週
|
workWeek | integer |
工作週類型。 |
|
使用新視窗
|
useNewWindow | boolean |
指出當使用者在產品中按一下 URL 時，URL 是否應開啟新視窗。 |
|
appendOnly
|
appendOnly | boolean |
此欄位是否僅附加。 |
|
displayAsLink
|
displayAsLink | boolean |
指出屬於關係一部分的欄位是否應顯示為產品內父記錄的超連結。 |
|
允許HTML
|
allowHTML | boolean |
此欄位是否允許 html. |
|
lookupReferenceFieldId
|
lookupReferenceFieldId | integer |
此查詢關係中參考的欄位 ID。 |
摘要函數
貨幣格式
版本模式
權限
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
角色
|
role | string |
與欄位的指定許可權相關聯的角色 |
|
許可類型
|
permissionType | string |
授予此欄位角色的權限 |
|
角色ID
|
roleId | integer |
指定角色的 ID |
createField回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
欄位的識別碼，此資料表獨有。 |
|
fieldType
|
fieldType | string |
欄位類型，如此 處所述。 |
|
mode
|
mode | string |
對於衍生欄位，這將是「查找」、「摘要」或「公式」，以指示衍生欄位的類型。 對於非衍生欄位，這將是空白的。 |
|
標籤
|
label | string |
欄位的標籤 （名稱）。 |
|
無包裝
|
noWrap | boolean |
指出欄位是否設定為在產品中顯示時不換行。 |
|
bold
|
bold | boolean |
指出欄位是否配置為在產品中以粗體顯示。 |
|
required
|
required | boolean |
指出欄位是否標示為必要。 |
|
appearsByDefault
|
appearsByDefault | boolean |
指出欄位是否在報表中標示為預設值。 |
|
find已啟用
|
findEnabled | boolean |
指出欄位是否標示為可搜尋。 |
|
獨特
|
unique | boolean |
指出欄位是否標示為唯一。 |
|
doesDataCopy
|
doesDataCopy | boolean |
指出使用者複製記錄時是否會複製欄位資料。 |
|
欄位幫助
|
fieldHelp | string |
在產品內向使用者顯示的已設定說明文字。 |
|
經審計
|
audited | boolean |
指出欄位是否作為 Quickbase 稽核記錄的一部分進行追蹤。 |
|
屬性1
|
properties | Properties1 |
欄位的其他屬性。 請參閱 欄位型別詳細資料頁面 ，以取得每個欄位型別屬性的詳細資訊。 |
|
使用權限
|
permissions | array of Permission |
不同角色的欄位權限。 |
deleteFields回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
deletedFieldIds
|
deletedFieldIds | array of integer |
已刪除要刪除的欄位 ID 清單。 |
|
錯誤
|
errors | array of string |
找到的錯誤清單。 |
getField回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
欄位的識別碼，此資料表獨有。 |
|
fieldType
|
fieldType | string |
欄位類型，如此 處所述。 |
|
mode
|
mode | string |
對於衍生欄位，這將是「查找」、「摘要」或「公式」，以指示衍生欄位的類型。 對於非衍生欄位，這將是空白的。 |
|
標籤
|
label | string |
欄位的標籤 （名稱）。 |
|
無包裝
|
noWrap | boolean |
指出欄位是否設定為在產品中顯示時不換行。 |
|
bold
|
bold | boolean |
指出欄位是否配置為在產品中以粗體顯示。 |
|
required
|
required | boolean |
指出欄位是否標示為必要。 |
|
appearsByDefault
|
appearsByDefault | boolean |
指出欄位是否在報表中標示為預設值。 |
|
find已啟用
|
findEnabled | boolean |
指出欄位是否標示為可搜尋。 |
|
獨特
|
unique | boolean |
指出欄位是否標示為唯一。 |
|
doesDataCopy
|
doesDataCopy | boolean |
指出使用者複製記錄時是否會複製欄位資料。 |
|
欄位幫助
|
fieldHelp | string |
在產品內向使用者顯示的已設定說明文字。 |
|
經審計
|
audited | boolean |
指出欄位是否作為 Quickbase 稽核記錄的一部分進行追蹤。 |
|
屬性1
|
properties | Properties1 |
欄位的其他屬性。 請參閱 欄位型別詳細資料頁面 ，以取得每個欄位型別屬性的詳細資訊。 |
|
使用權限
|
permissions | array of Permission |
不同角色的欄位權限。 |
updateField回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
欄位的識別碼，此資料表獨有。 |
|
fieldType
|
fieldType | string |
欄位類型，如此 處所述。 |
|
mode
|
mode | string |
對於衍生欄位，這將是「查找」、「摘要」或「公式」，以指示衍生欄位的類型。 對於非衍生欄位，這將是空白的。 |
|
標籤
|
label | string |
欄位的標籤 （名稱）。 |
|
無包裝
|
noWrap | boolean |
指出欄位是否設定為在產品中顯示時不換行。 |
|
bold
|
bold | boolean |
指出欄位是否配置為在產品中以粗體顯示。 |
|
required
|
required | boolean |
指出欄位是否標示為必要。 |
|
appearsByDefault
|
appearsByDefault | boolean |
指出欄位是否在報表中標示為預設值。 |
|
find已啟用
|
findEnabled | boolean |
指出欄位是否標示為可搜尋。 |
|
獨特
|
unique | boolean |
指出欄位是否標示為唯一。 |
|
doesDataCopy
|
doesDataCopy | boolean |
指出使用者複製記錄時是否會複製欄位資料。 |
|
欄位幫助
|
fieldHelp | string |
在產品內向使用者顯示的已設定說明文字。 |
|
經審計
|
audited | boolean |
指出欄位是否作為 Quickbase 稽核記錄的一部分進行追蹤。 |
|
屬性1
|
properties | Properties1 |
欄位的其他屬性。 請參閱 欄位型別詳細資料頁面 ，以取得每個欄位型別屬性的詳細資訊。 |
|
使用權限
|
permissions | array of Permission |
不同角色的欄位權限。 |
runFormulaResponse
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
結果
|
result | string |
公式執行結果。 |
更新插入回應
成功的回應，包括有關已添加、更新或未更改的記錄的詳細信息。 在下列範例中，資料表先前有十筆 ID 從 1 到 10 的記錄。 使用者張貼更新插入，以更新記錄 1 的值，並新增兩筆新記錄，全部成功。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
中繼資料2
|
metadata | Metadata2 |
有關已建立記錄、更新記錄、參考但未變更的記錄，以及處理時發生任何錯誤的記錄的資訊。 |
|
資料
|
data | array of object |
預期傳回的資料。 |
|
items
|
data | object |
中繼資料2
有關已建立記錄、更新記錄、參考但未變更的記錄，以及處理時發生任何錯誤的記錄的資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
createdRecordIds
|
createdRecordIds | array of integer |
包含已建立記錄識別碼的陣列。 |
|
lineErrors
|
lineErrors | object |
只有在記錄失敗的情況下才會傳回此值。 它是處理送入資料時發生的錯誤集合，導致無法處理記錄。 每個物件都有一個索引鍵，代表原始承載中記錄的序號（從 1 開始）。 值是發生的錯誤清單。 |
|
unchangedRecordIds
|
unchangedRecordIds | array of integer |
包含未變更記錄標識碼的陣列。 |
|
updatedRecordIds
|
updatedRecordIds | array of integer |
包含更新記錄識別碼的陣列。 |
|
已處理的記錄總數
|
totalNumberOfRecordsProcessed | integer |
已處理的記錄數。 包括成功和失敗的記錄更新。 |
deleteRecords回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
數字已刪除
|
numberDeleted | integer |
已刪除的記錄數目。 |
runQuery回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
fields
|
fields | array of Fields2 |
物件陣列，其中包含報告中顯示之每個欄位的有限中繼資料。 這有助於建置相依於欄位類型和 ID 的邏輯。 |
|
資料
|
data | array of object |
代表記錄資料或摘要值的物件陣列，視報告類型而定。 |
|
items
|
data | object | |
|
中繼資料1
|
metadata | Metadata1 |
有關可能有幫助的結果的其他信息。 如果您指定要略過的結果數量少於可用結果的數量，或 API 自動傳回的結果較少，則可能需要分頁。 numRecords 可以與 totalRecords 進行比較，以判斷是否需要進一步分頁。 |
欄位2
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
欄位識別碼。 |
|
標籤
|
label | string |
欄位標籤。 |
|
型別
|
type | string |
欄位類型。 |
getTempTokenDBIDResponse
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
暫時授權
|
temporaryAuthorization | string |
暫時授權權杖。 |
cloneUserToken回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
活動中
|
active | boolean |
使用者權杖是否處於作用中狀態。 |
|
apps
|
apps | array of App |
此使用者權杖指派給的應用程式清單。 |
|
最後使用
|
lastUsed | string |
上次使用此使用者權杖的日期，採用 ISO 8601 時間格式 YYYY-MM-DDThh：mm：ss.sssZ （UTC 時區）。 |
|
說明
|
description | string |
使用者權杖描述。 |
|
識別碼
|
id | integer |
使用者權杖 ID。 |
|
名稱
|
name | string |
使用者權杖名稱。 |
|
Token
|
token | string |
使用者權杖值。 |
應用程式
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
此應用程式的唯一識別碼。 |
|
名稱
|
name | string |
應用程式的名稱。 |
deleteUserToken回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
使用者權杖 ID。 |
deleteFile回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
版本編號
|
versionNumber | integer |
已刪除版本的數目。 |
|
fileName
|
fileName | string |
與已刪除版本相關聯的檔案名稱。 |
|
已上傳
|
uploaded | string |
最初上傳版本的時間戳記。 |
|
Creator
|
creator | Creator |
上傳版本的使用者。 |
Creator
上傳版本的使用者。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
使用者全名。 |
|
識別碼
|
id | string |
使用者 ID。 |
|
電子郵件
|
string |
使用者電子郵件。 |
|
|
使用者名稱
|
userName | string |
使用者名稱，如使用者屬性中更新的。 選用，如果與使用者電子郵件不同，則會顯示。 |
字串
這是基本資料類型「string」。