次の方法で共有

Quickbase (独立した発行元)

Quickbase は、技術的背景の問題ソルバーが連携して、アプリケーションのエコシステムを安全かつ安全かつ持続可能に作成できるようにすることで、ビジネスチームと IT チームを結び付けるアプリケーション開発プラットフォームです。 クイックベースは、一般的なプラットフォーム全体で市民開発を大規模に可能にすることで、企業が独自のプロセスの継続的なイノベーションを促進するのに役立ちます。

このコネクタは、次の製品とリージョンで使用できます。

サービス クラス リージョン
コピロット スタジオ Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
ロジック アプリ Standard 次を除くすべての Logic Apps リージョン :
     - Azure Government リージョン
     - Azure China リージョン
     - 米国国防総省 (DoD)
Power Apps Premium 次を除くすべての Power Apps リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
Power Automate Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
お問い合わせ
名前 トロイ・テイラー
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
コネクタ メタデータ
Publisher トロイ・テイラー、日立ソリューションズ
Web サイト https://www.quickbase.com/
プライバシー ポリシー https://www.quickbase.com/privacy
カテゴリ 生産性;IT 運用

接続を作成する

コネクタでは、次の認証の種類がサポートされています。
デフォルト 接続を作成するためのパラメーター。 すべてのリージョン 共有不可

デフォルト

適用対象: すべてのリージョン

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前 タイプ Description 必須
領域のホスト名 文字列 領域ホスト名の名前を指定します。 正しい
Authorization securestring "QB-USER-TOKEN yourToken" という形式のユーザー トークン。 正しい

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

Andor 更新レコードを挿入する

テーブルにレコードを挿入または更新します。 この単一の API 呼び出しでは、挿入と更新を送信できます。 更新では、テーブルのキー フィールド、またはサポートされている他の一意のフィールドを使用できます。 各 フィールド型 の書式設定方法の詳細については、「フィールドの種類」ページを参照してください。 この操作により、一部のレコードが失敗した場合でも、正常なレコードの増分処理が可能になります。
手記： このエンドポイントでは、最大ペイロード サイズ 10 MB がサポートされています。
DBID の一時トークンを取得する

このエンドポイントを使用して、アプリまたはテーブルのいずれかにスコープを設定した一時的な承認トークンを取得します。 その後、このトークンを使用して他の API 呼び出しを行うことができます ( 承認を参照)。 このトークンは 5 分で期限切れになります。
すべてのテーブル レポートを取得する

テーブルのすべてのレポートのスキーマ (プロパティ) を取得します。 API を実行しているユーザーがアプリケーション管理者である場合、API は所有者のユーザー ID を持つすべての個人用レポートも返します。
すべてのフィールドの使用状況を取得する

テーブルのすべてのフィールド使用状況統計を取得します。 これは、フィールド プロパティの使用状況テーブルに記載されている情報の概要です。
すべてのリレーションシップを取得する

特定のテーブルのすべてのリレーションシップとその定義の一覧を取得します。 詳細は、特定のアプリケーション内のリレーションシップの親側と子側の両方に対して提供されます。 アプリケーション間のリレーションシップでは、制限付きの詳細が返されます。
アプリ イベントを取得する

このアプリケーションのデータまたはユーザー アクションに基づいてトリガーできるイベントの一覧を取得します。電子メール通知、アラーム、サブスクリプション、QB アクション、Webhook、レコード変更によってトリガーされるオートメーション (スケジュールは含まれません)。
アプリのテーブルを取得する

特定のアプリケーションに存在するすべてのテーブルの一覧を取得します。 各テーブルのプロパティは、Get テーブルで返されるプロパティと同じです。
アプリの入手

アプリケーション変数を含む、アプリケーションのメイン プロパティを返します。
アプリをコピーする

指定したアプリケーションをコピーします。 新しいアプリケーションのスキーマは元のアプリケーションと同じです。 その他のコピー オプションについては、以下を参照してください。
アプリを作成する

アカウントにアプリケーションを作成します。 それぞれのアカウントにアプリケーションの作成権限が必要です。 この API では、主なプロパティとアプリケーション変数を設定できます。
アプリを削除する

すべてのテーブルとデータを含む、アプリケーション全体を削除します。
アプリを更新する

特定のアプリケーションのメイン プロパティやアプリケーション変数を更新します。 要求本文で指定しないアプリのプロパティは変更されません。
テーブルのフィールドを取得する

特定のテーブル内のすべてのフィールドのプロパティを取得します。 各フィールドのプロパティは、Get フィールドと同じです。
テーブルの作成

アプリケーションにテーブルを作成します。
テーブルを削除する

アプリケーション内のすべてのデータを含む、アプリケーション内の特定のテーブルを削除します。
テーブルを取得する

アプリケーションの一部である個々のテーブルのプロパティを取得します。
テーブルを更新する

特定のテーブルのメイン プロパティを更新します。 要求本文で指定しないテーブルのプロパティは変更されません。
データのクエリ

Quickbase クエリ言語でクエリを渡します。 各レコードのおおよそのサイズに基づいて 、インテリジェントな改ページ位置 を持つレコード データを返します。 メタデータ オブジェクトには、応答を反復処理し、より多くのデータを収集するために必要な情報が含まれます。
フィールドの使用状況を取得する

1 つのフィールドの使用状況の統計情報を取得します。 これは、フィールド プロパティの使用状況テーブルに記載されている情報の概要です。
フィールドの取得

フィールド ID に基づいて、個々のフィールドのプロパティを取得します。
すべてのフィールド型に存在するプロパティは、最上位レベルで返されます。 特定の種類のフィールドに固有のプロパティは、'properties' 属性の下に返されます。 各 フィールドの種類 のプロパティの詳細については、「フィールドの種類」ページを参照してください。
フィールドを作成する

テーブル内に、そのフィールドのユーザー設定の権限を含むフィールドを作成します。
フィールドを削除する

フィールド ID に基づいて、テーブル内の 1 つまたは複数のフィールドを削除します。これにより、そのフィールド内のデータや計算も完全に削除されます。
フィールドを更新する

フィールドのプロパティとユーザー設定のアクセス許可を更新します。 特定のプロパティを更新しようとすると、既存のデータがフィールドの新しいプロパティに従わなくなり、拒否される可能性があります。 特定の状況については、以下の必須、一意、および選択肢の説明を参照してください。 要求本文で指定しないフィールドのプロパティは変更されません。
ユーザー トークンを削除する

認証されたユーザー トークンを削除します。 これは元に戻すことはできません。
ユーザー トークンを複製する

認証されたユーザー トークンを複製します。 そのトークンに関連付けられているすべてのアプリケーションは、新しいトークンに自動的に関連付けられます。
ユーザー トークンを非アクティブ化する

認証されたユーザー トークンを非アクティブ化します。 これが完了したら、ユーザー トークンをユーザー インターフェイスで再アクティブ化する必要があります。
リレーションシップの削除

このエンドポイントを使用して、すべてのルックアップ フィールドとサマリー フィールドを含むリレーションシップ全体を削除します。 リレーションシップの参照フィールドは削除されません。
リレーションシップを作成する

テーブルとルックアップ/サマリー フィールドにリレーションシップを作成します。 リレーションシップは、同じアプリ内のテーブルに対してのみ作成できます。
リレーションシップを更新する

このエンドポイントを使用して、ルックアップ フィールドとサマリー フィールドを既存のリレーションシップに追加します。 リレーションシップを更新すると、既存のルックアップ/サマリー フィールドは削除されません。
レコードを削除する

クエリに基づいてテーブル内のレコードを削除します。 または、テーブル内のすべてのレコードを削除できます。
レポートを取得する

個々のレポートのスキーマ (プロパティ) を取得します。
レポートを実行する

ID に基づいてレポートを実行し、それに関連付けられている基になるデータを返します。 データの形式は、レポートの種類によって異なります。 レコード レベルのデータ (テーブル、カレンダーなど) に焦点を当てたレポートは、個々のレコードを返します。 集計レポート (概要、グラフ) は、レポートで構成されている概要情報を返します。 合計、平均、視覚化など、UI 固有の要素は返されません。 各レコードのおおよそのサイズに基づいて、インテリジェントな改ページ位置を持つデータを返します。 メタデータ オブジェクトには、応答を反復処理し、より多くのデータを収集するために必要な情報が含まれます。
数式を実行する

API 呼び出しを介した数式の実行を許可します。 レコードに不連続フィールドがない数式の値を取得するには、カスタム コードでこのメソッドを使用します。
添付ファイルをダウンロードする

添付ファイルをダウンロードし、添付ファイルの内容を base64 形式でエンコードします。 API 応答は、 Content-Disposition ヘッダー内のファイル名を返します。 ファイルに関するメタデータは、/records および /reports エンドポイントから取得できます (該当する場合)。 これらのエンドポイントを使用して、ファイルをフェッチするために必要な情報を取得します。
添付ファイルを削除する

1 つの添付ファイル バージョンを削除します。 ファイルに関するメタデータは、/records および /reports エンドポイントから取得できます (該当する場合)。 これらのエンドポイントを使用して、ファイル バージョンを削除するために必要な情報を取得します。

Andor 更新レコードを挿入する

操作 ID:
UpsertRecords

テーブルにレコードを挿入または更新します。 この単一の API 呼び出しでは、挿入と更新を送信できます。 更新では、テーブルのキー フィールド、またはサポートされている他の一意のフィールドを使用できます。 各 フィールド型 の書式設定方法の詳細については、「フィールドの種類」ページを参照してください。 この操作により、一部のレコードが失敗した場合でも、正常なレコードの増分処理が可能になります。
手記： このエンドポイントでは、最大ペイロード サイズ 10 MB がサポートされています。

パラメーター

名前 キー 必須 型 説明
送信先
 to True string

テーブル識別子。
データ
 data object
mergeFieldId
 mergeFieldId integer

差し込み印刷フィールド ID。
fieldsToReturn
 fieldsToReturn array of integer

更新または追加されたレコードのデータを返すフィールド ID の配列を指定します。 フィールド ID が要求された場合、レコード ID (FID 3) は常に返されます。

戻り値

追加、更新、または変更されていないレコードの詳細を含む正常な応答。 次の例では、テーブルには以前、ID が 1 ~ 10 のレコードが 10 個ありました。 ユーザーは、レコード 1 の値を更新し、2 つの新しいレコードをすべて正常に追加するアップサートを投稿します。

Upsert Response
upsertResponse

DBID の一時トークンを取得する

操作 ID:
GetTempTokenDBID

このエンドポイントを使用して、アプリまたはテーブルのいずれかにスコープを設定した一時的な承認トークンを取得します。 その後、このトークンを使用して他の API 呼び出しを行うことができます ( 承認を参照)。 このトークンは 5 分で期限切れになります。

パラメーター

名前 キー 必須 型 説明
アプリ トークン
 QB-App-Token string

Quickbase アプリ トークン
DBID
 dbid True string

アプリまたはテーブルの一意識別子。

戻り値

getTempTokenDBIDResponse
getTempTokenDBIDResponse

すべてのテーブル レポートを取得する

操作 ID:
GetTableReports

テーブルのすべてのレポートのスキーマ (プロパティ) を取得します。 API を実行しているユーザーがアプリケーション管理者である場合、API は所有者のユーザー ID を持つすべての個人用レポートも返します。

パラメーター

名前 キー 必須 型 説明
テーブル ID
 tableId True string

テーブルの一意識別子。

戻り値

名前 パス 型 説明
array of object
ID
 id string

識別子。
名前
 name string

名前。
タイプ
 type string

型。
Description
 description string

説明。
所有者 ID
 ownerId string

所有者の識別子。
最後に使用
 usedLast string

最後に使用した場合。
使用済み数
 usedCount integer

使用された数。

すべてのフィールドの使用状況を取得する

操作 ID:
GetFieldsUsage

テーブルのすべてのフィールド使用状況統計を取得します。 これは、フィールド プロパティの使用状況テーブルに記載されている情報の概要です。

パラメーター

名前 キー 必須 型 説明
テーブル ID
 tableId True string

テーブルの一意識別子 (DBID)。
スキップ
 skip integer

リストからスキップするフィールドの数。
上
 top integer

返されるフィールドの最大数。

戻り値

名前 パス 型 説明
array of object
ID
 field.id integer

識別子。
名前
 field.name string

名前。
タイプ
 field.type string

型。
数える
 usage.actions.count integer

カウント。
数える
 usage.appHomePages.count integer

カウント。
数える
 usage.defaultReports.count integer

カウント。
数える
 usage.exactForms.count integer

カウント。
数える
 usage.fields.count integer

カウント。
数える
 usage.forms.count integer

カウント。
数える
 usage.notifications.count integer

カウント。
数える
 usage.personalReports.count integer

カウント。
数える
 usage.relationships.count integer

カウント。
数える
 usage.reminders.count integer

カウント。
数える
 usage.reports.count integer

カウント。
数える
 usage.roles.count integer

カウント。
数える
 usage.webhooks.count integer

カウント。

すべてのリレーションシップを取得する

操作 ID:
GetRelationships

特定のテーブルのすべてのリレーションシップとその定義の一覧を取得します。 詳細は、特定のアプリケーション内のリレーションシップの親側と子側の両方に対して提供されます。 アプリケーション間のリレーションシップでは、制限付きの詳細が返されます。

パラメーター

名前 キー 必須 型 説明
スキップ
 skip integer

スキップするリレーションシップの数。
テーブル ID
 tableId True string

テーブルの一意識別子 (DBID)。

戻り値

リレーションシップの取得応答
getRelationshipsResponse

アプリ イベントを取得する

操作 ID:
GetAppEvents

このアプリケーションのデータまたはユーザー アクションに基づいてトリガーできるイベントの一覧を取得します。電子メール通知、アラーム、サブスクリプション、QB アクション、Webhook、レコード変更によってトリガーされるオートメーション (スケジュールは含まれません)。

パラメーター

名前 キー 必須 型 説明
アプリ ID
 appId True string

アプリの一意識別子。

戻り値

名前 パス 型 説明
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 アドレス。

アプリのテーブルを取得する

操作 ID:
GetAppTables

特定のアプリケーションに存在するすべてのテーブルの一覧を取得します。 各テーブルのプロパティは、Get テーブルで返されるプロパティと同じです。

パラメーター

名前 キー 必須 型 説明
アプリ ID
 appId True string

アプリの一意識別子

戻り値

名前 パス 型 説明
array of object
名前
 name string

名前。
作成済み
 created string

作成時。
Updated
 updated string

更新された場合。
エイリアス
 alias string

エイリアス。
Description
 description string

説明。
ID
 id string

識別子。
次のレコード ID
 nextRecordId integer

次のレコードの識別子。
次のフィールド ID
 nextFieldId integer

次のフィールドの識別子。
既定の並べ替えフィールド ID
 defaultSortFieldId integer

既定の並べ替えフィールドの識別子。
既定の並べ替え順序
 defaultSortOrder string

既定の並べ替え順序。
キー フィールド ID
 keyFieldId integer

キー フィールドの識別子。
単一レコード名
 singleRecordName string

1 つのレコード名。
複数形のレコード名
 pluralRecordName string

複数形のレコード名。
サイズ制限
 sizeLimit string

サイズ制限。
使用済み領域
 spaceUsed string

使用済み領域。
残りの領域
 spaceRemaining string

残りの領域。

アプリの入手

操作 ID:
GetApp

アプリケーション変数を含む、アプリケーションのメイン プロパティを返します。

パラメーター

名前 キー 必須 型 説明
アプリ ID
 appId True string

アプリの一意識別子。

戻り値

アプリの応答を取得する
getAppResponse

アプリをコピーする

操作 ID:
CopyApp

指定したアプリケーションをコピーします。 新しいアプリケーションのスキーマは元のアプリケーションと同じです。 その他のコピー オプションについては、以下を参照してください。

パラメーター

名前 キー 必須 型 説明
名前
 name True string

新しくコピーしたアプリの名前
説明
 description string

新しくコピーされたアプリの説明
assignUserToken
 assignUserToken boolean

この要求を行うために使用するユーザー トークンを新しいアプリに追加するかどうか
excludeFiles
 excludeFiles boolean

keepData が true の場合、添付ファイルもコピーするかどうか。 keepData が false の場合、このプロパティは無視されます
keepData
 keepData boolean

スキーマと共にアプリのデータをコピーするかどうか
usersAndRoles
 usersAndRoles boolean

true の場合、ユーザーは割り当てられたロールと共にコピーされます。 false の場合、ユーザーとロールはコピーされますが、ロールは割り当てされません
アプリ ID
 appId True string

アプリの一意識別子。

戻り値

アプリの応答のコピー
copyAppResponse

アプリを作成する

操作 ID:
CreateApp

アカウントにアプリケーションを作成します。 それぞれのアカウントにアプリケーションの作成権限が必要です。 この API では、主なプロパティとアプリケーション変数を設定できます。

パラメーター

名前 キー 必須 型 説明
assignToken
 assignToken boolean

アプリケーションの作成に使用したユーザー トークンにアプリを割り当てる場合は、true に設定します。 既定値は false です。
名前
 name True string

変数の名前。
value
 value True string

変数の値。
名前
 name True string

アプリ名。 dbid 値が異なるため、同じ領域に同じ名前の複数のアプリを作成できます。 これを行うことに注意することをお勧めします。
説明
 description string

アプリの説明。 このプロパティが省略されている場合、アプリの説明は空白になります。

戻り値

アプリの応答を作成する
createAppResponse

アプリを削除する

操作 ID:
DeleteApp

すべてのテーブルとデータを含む、アプリケーション全体を削除します。

パラメーター

名前 キー 必須 型 説明
名前
 name True string

アプリケーションの削除を確認するために、アプリケーション名を要求します。
アプリ ID
 appId True string

アプリの一意識別子。

戻り値

アプリの応答を削除する
deleteAppResponse

アプリを更新する

操作 ID:
UpdateApp

特定のアプリケーションのメイン プロパティやアプリケーション変数を更新します。 要求本文で指定しないアプリのプロパティは変更されません。

パラメーター

名前 キー 必須 型 説明
名前
 name True string

変数の名前。
value
 value True string

変数の値。
名前
 name string

アプリの名前。
説明
 description string

アプリの説明。
アプリ ID
 appId True string

アプリの一意識別子。

戻り値

アプリの応答を更新する
updateAppResponse

テーブルのフィールドを取得する

操作 ID:
GetFields

特定のテーブル内のすべてのフィールドのプロパティを取得します。 各フィールドのプロパティは、Get フィールドと同じです。

パラメーター

名前 キー 必須 型 説明
テーブル ID
 tableId True string

テーブルの一意識別子 (DBID)。
フィールド権限を含める
 includeFieldPerms boolean

フィールドのカスタムアクセス許可を取得する場合は、'true' に設定します。

戻り値

名前 パス 型 説明
array of object
ID
 id integer

識別子。
ラベル
 label string

ラベル。
フィールドの型
 fieldType string

フィールドの種類。
折り返しなし
 noWrap boolean

折り返しがないかどうか。
太字
 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

追加のみかどうか。
allowHTML
 properties.allowHTML boolean

HTML を許可するかどうか。
指定された並べ替え
 properties.sortAsGiven boolean

指定したとおりに並べ替えるかどうか。
選択肢を運ぶ
 properties.carryChoices boolean

選択肢を運ぶかどうか。
新しい選択肢を許可する
 properties.allowNewChoices boolean

新しい選択肢を許可するかどうか。
計算式
 properties.formula string

数式。
デフォルト値
 properties.defaultValue string

既定値。
数値の形式
 properties.numberFormat integer

数値の形式。
小数点
 properties.decimalPlaces integer

小数点以下の桁数。
平均を行う
 properties.doesAverage boolean

平均を行うかどうか。
合計は行います
 properties.doesTotal boolean

合計を行うかどうか。
空白は 0 です
 properties.blankIsZero boolean

空白が 0 かどうかを指定します。
Permissions
 permissions array of object
アクセス許可の種類
 permissions.permissionType string

アクセス許可の種類。
Role
 permissions.role string

ロール。
ロール ID
 permissions.roleId integer

ロールの識別子。
フォームに追加
 addToForms boolean

フォームに追加するかどうか。

テーブルの作成

操作 ID:
CreateTable

アプリケーションにテーブルを作成します。

パラメーター

名前 キー 必須 型 説明
アプリ ID
 appId True string

アプリの一意識別子
名前
 name True string

テーブルの名前。
pluralRecordName
 pluralRecordName string

テーブル内のレコードの複数形の名詞。 この値が渡されない場合、既定値は 'Records' です。
singleRecordName
 singleRecordName string

テーブル内のレコードの単数名詞。 この値が渡されない場合、既定値は 'Record' です。
説明
 description string

テーブルの説明。 この値が渡されない場合、既定値は空白になります。

戻り値

テーブル応答の作成
createTableResponse

テーブルを削除する

操作 ID:
DeleteTable

アプリケーション内のすべてのデータを含む、アプリケーション内の特定のテーブルを削除します。

パラメーター

名前 キー 必須 型 説明
アプリ ID
 appId True string

アプリの一意識別子
テーブル ID
 tableId True string

テーブルの一意識別子 (DBID)。

戻り値

テーブルの削除の応答
deleteTableResponse

テーブルを取得する

操作 ID:
GetTable

アプリケーションの一部である個々のテーブルのプロパティを取得します。

パラメーター

名前 キー 必須 型 説明
アプリ ID
 appId True string

アプリの一意識別子
テーブル ID
 tableId True string

テーブルの一意識別子 (DBID)。

戻り値

テーブルの応答を取得する
getTableResponse

テーブルを更新する

操作 ID:
UpdateTable

特定のテーブルのメイン プロパティを更新します。 要求本文で指定しないテーブルのプロパティは変更されません。

パラメーター

名前 キー 必須 型 説明
アプリ ID
 appId True string

アプリの一意識別子
名前
 name string

テーブルの名前。
pluralRecordName
 pluralRecordName string

テーブル内のレコードの複数形の名詞。 この値が渡されない場合、既定値は 'Records' です。
singleRecordName
 singleRecordName string

テーブル内のレコードの単数名詞。 この値が渡されない場合、既定値は 'Record' です。
説明
 description string

テーブルの説明。 この値が渡されない場合、既定値は空白になります。
テーブル ID
 tableId True string

テーブルの一意識別子 (DBID)。

戻り値

テーブルの更新応答
updateTableResponse

データのクエリ

操作 ID:
RunQuery

Quickbase クエリ言語でクエリを渡します。 各レコードのおおよそのサイズに基づいて 、インテリジェントな改ページ位置 を持つレコード データを返します。 メタデータ オブジェクトには、応答を反復処理し、より多くのデータを収集するために必要な情報が含まれます。

パラメーター

名前 キー 必須 型 説明
スキップ
 skip integer

スキップするレコードの数。
compareWithAppLocalTime
 compareWithAppLocalTime boolean

アプリケーションのローカル時刻に関して、日付/時刻フィールドに対してクエリを実行するかどうかを指定します。 既定では、クエリは UTC 時刻で実行されます。
top
 top integer

表示するレコードの最大数。
where
 where string

返されるレコードを決定する Quickbase クエリ言語を使用するフィルター。 このパラメーターを省略すると、クエリはすべてのレコードを返します。
fieldId
 fieldId integer

テーブル内のフィールドの一意識別子。
Grouping
 grouping string

昇順 (ASC)、降順 (DESC) または等しい値 (等しい値) に基づいてグループ化する
sortBy
 sortBy object

既定では、クエリは、指定された並べ替えフィールドまたは既定の並べ替えによって並べ替えられます (クエリに何も指定されていない場合)。 返されるデータの順序が重要でない場合に並べ替えを回避するには、false に設定します。 並べ替えを行わずにデータを返す場合、パフォーマンスが向上します。
select
 select object
from
 from True string

テーブル識別子。

戻り値

クエリ応答の実行
runQueryResponse

フィールドの使用状況を取得する

操作 ID:
GetFieldUsage

1 つのフィールドの使用状況の統計情報を取得します。 これは、フィールド プロパティの使用状況テーブルに記載されている情報の概要です。

パラメーター

名前 キー 必須 型 説明
テーブル ID
 tableId True string

テーブルの一意識別子 (DBID)。
フィールド ID
 fieldId True integer

フィールドの一意識別子 (FID)。

戻り値

名前 パス 型 説明
array of object
ID
 field.id integer

識別子。
名前
 field.name string

名前。
タイプ
 field.type string

型。
数える
 usage.actions.count integer

カウント。
数える
 usage.appHomePages.count integer

カウント。
数える
 usage.defaultReports.count integer

カウント。
数える
 usage.exactForms.count integer

カウント。
数える
 usage.fields.count integer

カウント。
数える
 usage.forms.count integer

カウント。
数える
 usage.notifications.count integer

カウント。
数える
 usage.personalReports.count integer

カウント。
数える
 usage.relationships.count integer

カウント。
数える
 usage.reminders.count integer

カウント。
数える
 usage.reports.count integer

カウント。
数える
 usage.roles.count integer

カウント。
数える
 usage.webhooks.count integer

カウント。

フィールドの取得

操作 ID:
GetField

フィールド ID に基づいて、個々のフィールドのプロパティを取得します。
すべてのフィールド型に存在するプロパティは、最上位レベルで返されます。 特定の種類のフィールドに固有のプロパティは、'properties' 属性の下に返されます。 各 フィールドの種類 のプロパティの詳細については、「フィールドの種類」ページを参照してください。

パラメーター

名前 キー 必須 型 説明
テーブル ID
 tableId True string

テーブルの一意識別子 (DBID)。
フィールド権限を含める
 includeFieldPerms boolean

フィールドのカスタムアクセス許可を取得する場合は、'true' に設定します。
フィールド ID
 fieldId True integer

フィールドの一意識別子 (FID)。

戻り値

フィールドの応答を取得する
getFieldResponse

フィールドを作成する

操作 ID:
CreateField

テーブル内に、そのフィールドのユーザー設定の権限を含むフィールドを作成します。

パラメーター

名前 キー 必須 型 説明
テーブル ID
 tableId True string

テーブルの一意識別子。
監査
 audited boolean

フィールドが Quickbase 監査ログの一部として追跡されているかどうかを示します。 このプロパティを "true" に設定できるのは、アプリで監査ログが有効になっている場合のみです。 クイックベース監査ログのデータ変更ログを有効にするを参照してください。
fieldHelp
 fieldHelp string

製品内のユーザーに表示される、構成済みのヘルプ テキスト。
太字
 bold boolean

フィールドが製品に太字で表示されるように構成されているかどうかを示します。
comments
 comments string

管理者がフィールド プロパティに入力したコメント。
doesTotal
 doesTotal boolean

このフィールドが製品内のレポートに合計されるかどうか。
autoSave
 autoSave boolean

リンク フィールドが自動的に保存されるかどうか。
defaultValueLuid
 defaultValueLuid integer

既定のユーザー ID 値。
maxVersions
 maxVersions integer

添付ファイル用に構成されたバージョンの最大数。
format
 format integer

時刻を表示する形式。
carryChoices
 carryChoices boolean

コピー時にフィールドに複数の選択肢フィールドを含めるかどうか。
最大長さ
 maxLength integer

このフィールドのクイックベースでの入力に使用できる最大文字数。
linkText
 linkText string

ユーザーが製品内で表示する URL を置き換える、構成済みのテキスト値。
parentFieldId
 parentFieldId integer

親複合フィールドの ID (該当する場合)。
displayTimezone
 displayTimezone boolean

製品内のタイムゾーンを表示するかどうかを示します。
allowNewChoices
 allowNewChoices boolean

ユーザーが選択リストに新しい選択肢を追加できるかどうかを示します。
defaultToday
 defaultToday boolean

新しいレコードに対してフィールド値が今日既定値に設定されているかどうかを示します。
単位
 units string

単位ラベル。
sourceFieldId
 sourceFieldId integer

ソース フィールドの ID。
doesAverage
 doesAverage boolean

このフィールドが製品内のレポートで平均化されるかどうか。
数式
 formula string

Quickbase で構成されたフィールドの数式。
decimalPlaces
 decimalPlaces integer

このフィールドの製品に表示される小数点以下の桁数。
displayMonth
 displayMonth string

月を表示する方法。
seeVersions
 seeVersions boolean

ユーザーが製品内の添付ファイルの最新バージョン以外の他のバージョンを表示できるかどうかを示します。
numLines
 numLines integer

このテキスト フィールドのクイックベースに表示される行数。
defaultKind
 defaultKind string

ユーザーの既定の種類。
displayEmail
 displayEmail string

電子メールの表示方法。
coverText
 coverText string

ブラウザーにリンクを表示するために使用できる、ユーザーフレンドリな代替テキスト。
currencySymbol
 currencySymbol string

製品内のフィールド値を表示するときに使用される現在のシンボル。
targetFieldId
 targetFieldId integer

ターゲット フィールドの ID。
displayUser
 displayUser string

ユーザーが製品内でどのように表示されるかを示す構成済みオプション。
blankIsZero
 blankIsZero boolean

空白値が製品内の計算で 0 と同じように扱われるかどうか。
正確
 exact boolean

レポート リンクに完全一致が必要かどうか。
defaultDomain
 defaultDomain string

既定の電子メール ドメイン。
defaultValue
 defaultValue string

新しいレコードが追加されたときにフィールドに対して構成される既定値。
略す
 abbreviate boolean

URL を表示するときに URL プロトコルを表示しないでください。
数値フォーマット
 numberFormat integer

製品の数値を表示するために使用される形式 (小数点、区切り記号、数字グループ)。
targetTableName
 targetTableName string

フィールドのターゲット テーブル名。
appearsAs
 appearsAs string

リンク テキスト (空の場合) は、URL がリンク テキストとして使用されます。
width
 width integer

製品のフィールドの html 入力幅。
CurrencyFormat
 currencyFormat string

製品内のフィールド値を表示するときに使用される通貨形式。
displayImages
 displayImages boolean

製品内のフォームとレポートの添付ファイルに画像を表示するかどうかを示します。
displayDayOfWeek
 displayDayOfWeek boolean

製品内の曜日を表示するかどうかを示します。
commaStart
 commaStart integer

該当する場合は、製品にコンマの前に表示される桁数。
choices
 choices array of string

ユーザーに選択肢を提供するフィールドに存在するエントリの配列。 これらの選択肢は、今後追加されるすべてのレコードの有効な値を参照します。 このフィールドにこれらの値を含む既存のレコードがある場合でも、選択肢の一覧から値を削除できます。 ユーザーがブラウザーでデータを見ると赤で表示されますが、他の効果はありません。 このプロパティを使用してフィールドを更新すると、古い選択肢が削除され、新しい選択肢に置き換えられます。
targetTableId
 targetTableId string

ターゲット テーブルの ID。
displayRelative
 displayRelative boolean

時間を相対として表示するかどうかを指定します。
compositeFields
 compositeFields object
displayTime
 displayTime boolean

日付に加えて、時刻を表示するかどうかを示します。
VersionMode
 versionMode string

ファイルのバージョン モード。 すべてのバージョンを保持し、最後のバージョンを保持します。
snapFieldId
 snapFieldId integer

値のスナップショット作成に使用されるフィールドの ID (該当する場合)。
hours24
 hours24 boolean

製品内の 24 時間形式で時刻を表示するかどうかを示します。
sortAlpha
 sortAlpha boolean

アルファベット順に並べ替えるかどうか、既定の並べ替えはレコード ID によって行われます。
sortAsGiven
 sortAsGiven boolean

一覧表示されたエントリが、入力されたエントリとアルファベット順に並べ替えられるかどうかを示します。
hasExtension
 hasExtension boolean

このフィールドに電話番号の拡張子があるかどうか。
useNewWindow
 useNewWindow boolean

ユーザーが製品内でクリックしたときに URL が新しいウィンドウを開く必要があるかどうかを示します。
appendOnly
 appendOnly boolean

このフィールドが追加のみかどうか。
displayAsLink
 displayAsLink boolean

リレーションシップの一部であるフィールドを、製品内の親レコードへのハイパーリンクとして表示するかどうかを示します。
appearsByDefault
 appearsByDefault boolean

レポートでフィールドが既定値としてマークされているかどうかを示します。
FieldType2
 fieldType True string

フィールドタイプは、フィールドタイプリンクをクリックして詳細を確認します。
ロール
 role string

フィールドの特定のアクセス許可に関連付けられているロール
permissionType
 permissionType string

このフィールドのロールに与えられたアクセス許可
役割ID
 roleId integer

指定されたロールの ID
addToForms
 addToForms boolean

追加するフィールドがフォームに表示されるかどうか。
ラベル
 label True string

フィールドのラベル (名前)。
findEnabled
 findEnabled boolean

フィールドが検索可能としてマークされているかどうかを示します。
noWrap
 noWrap boolean

製品に表示されるときに、フィールドが折り返されないように構成されているかどうかを示します。

戻り値

フィールド応答の作成
createFieldResponse

フィールドを削除する

操作 ID:
DeleteFields

フィールド ID に基づいて、テーブル内の 1 つまたは複数のフィールドを削除します。これにより、そのフィールド内のデータや計算も完全に削除されます。

パラメーター

名前 キー 必須 型 説明
テーブル ID
 tableId True string

テーブルの一意識別子。
fieldIds
 fieldIds True array of integer

削除するフィールド ID の一覧。

戻り値

フィールドの削除応答
deleteFieldsResponse

フィールドを更新する

操作 ID:
UpdateField

フィールドのプロパティとユーザー設定のアクセス許可を更新します。 特定のプロパティを更新しようとすると、既存のデータがフィールドの新しいプロパティに従わなくなり、拒否される可能性があります。 特定の状況については、以下の必須、一意、および選択肢の説明を参照してください。 要求本文で指定しないフィールドのプロパティは変更されません。

パラメーター

名前 キー 必須 型 説明
テーブル ID
 tableId True string

テーブルの一意識別子。
監査
 audited boolean

フィールドが Quickbase 監査ログの一部として追跡されているかどうかを示します。 このプロパティを "true" に設定できるのは、アプリで監査ログが有効になっている場合のみです。 クイックベース監査ログのデータ変更ログを有効にするを参照してください。
fieldHelp
 fieldHelp string

製品内のユーザーに表示される、構成済みのヘルプ テキスト。
太字
 bold boolean

フィールドが製品に太字で表示されるように構成されているかどうかを示します。
required
 required boolean

フィールドが必要かどうかを示します (つまり、すべてのレコードがこのフィールドに null 以外の値を持つ必要がある場合)。 フィールドを不要から必須に変更しようとして、テーブルに現在、そのフィールドに null 値を持つレコードが含まれている場合は、フィールドに null 値があることを示すエラーが表示されます。 この場合、フィールドを必須に変更する前に、フィールドの null 値でこれらのレコードを検索して更新する必要があります。
comments
 comments string

管理者がフィールド プロパティに入力したコメント。
doesTotal
 doesTotal boolean

このフィールドが製品内のレポートに合計されるかどうか。
autoSave
 autoSave boolean

リンク フィールドが自動的に保存されるかどうか。
defaultValueLuid
 defaultValueLuid integer

既定のユーザー ID 値。
maxVersions
 maxVersions integer

添付ファイル用に構成されたバージョンの最大数。
format
 format integer

時刻を表示する形式。
carryChoices
 carryChoices boolean

コピー時にフィールドに複数の選択肢フィールドを含めるかどうか。
最大長さ
 maxLength integer

このフィールドのクイックベースでの入力に使用できる最大文字数。
linkText
 linkText string

ユーザーが製品内で表示する URL を置き換える、構成済みのテキスト値。
parentFieldId
 parentFieldId integer

親複合フィールドの ID (該当する場合)。
displayTimezone
 displayTimezone boolean

製品内のタイムゾーンを表示するかどうかを示します。
summaryTargetFieldId
 summaryTargetFieldId integer

該当する場合は、子からの値を集計するために使用されるフィールドの ID。 集計関数にフィールドの選択 (count など) が必要ない場合は、0 が表示されます。
allowNewChoices
 allowNewChoices boolean

ユーザーが選択リストに新しい選択肢を追加できるかどうかを示します。
defaultToday
 defaultToday boolean

新しいレコードに対してフィールド値が今日既定値に設定されているかどうかを示します。
単位
 units string

単位ラベル。
lookupTargetFieldId
 lookupTargetFieldId integer

この参照の親テーブルのターゲットであるフィールドの ID。
SummaryFunction3
 summaryFunction string

集計フィールドの累積型。
sourceFieldId
 sourceFieldId integer

ソース フィールドの ID。
doesAverage
 doesAverage boolean

このフィールドが製品内のレポートで平均化されるかどうか。
数式
 formula string

Quickbase で構成されたフィールドの数式。
decimalPlaces
 decimalPlaces integer

このフィールドの製品に表示される小数点以下の桁数。
displayMonth
 displayMonth string

月を表示する方法。
seeVersions
 seeVersions boolean

ユーザーが製品内の添付ファイルの最新バージョン以外の他のバージョンを表示できるかどうかを示します。
numLines
 numLines integer

このテキスト フィールドのクイックベースに表示される行数。
defaultKind
 defaultKind string

ユーザーの既定の種類。
displayEmail
 displayEmail string

電子メールの表示方法。
coverText
 coverText string

ブラウザーにリンクを表示するために使用できる、ユーザーフレンドリな代替テキスト。
currencySymbol
 currencySymbol string

製品内のフィールド値を表示するときに使用される現在のシンボル。
summaryQuery
 summaryQuery string

概要クエリ。
targetFieldId
 targetFieldId integer

ターゲット フィールドの ID。
displayUser
 displayUser string

ユーザーが製品内でどのように表示されるかを示す構成済みオプション。
blankIsZero
 blankIsZero boolean

空白値が製品内の計算で 0 と同じように扱われるかどうか。
正確
 exact boolean

レポート リンクに完全一致が必要かどうか。
defaultDomain
 defaultDomain string

既定の電子メール ドメイン。
defaultValue
 defaultValue string

新しいレコードが追加されたときにフィールドに対して構成される既定値。
略す
 abbreviate boolean

URL を表示するときに URL プロトコルを表示しないでください。
数値フォーマット
 numberFormat integer

製品の数値を表示するために使用される形式 (小数点、区切り記号、数字グループ)。
targetTableName
 targetTableName string

フィールドのターゲット テーブル名。
appearsAs
 appearsAs string

リンク テキスト (空の場合) は、URL がリンク テキストとして使用されます。
width
 width integer

製品のフィールドの html 入力幅。
CurrencyFormat
 currencyFormat string

製品内のフィールド値を表示するときに使用される通貨形式。
displayImages
 displayImages boolean

製品内のフォームとレポートの添付ファイルに画像を表示するかどうかを示します。
displayDayOfWeek
 displayDayOfWeek boolean

製品内の曜日を表示するかどうかを示します。
summaryReferenceFieldId
 summaryReferenceFieldId integer

この概要のリレーションシップ内の参照であるフィールドの ID。
commaStart
 commaStart integer

該当する場合は、製品にコンマの前に表示される桁数。
choices
 choices array of string

ユーザーに選択肢を提供するフィールドに存在するエントリの配列。 これらの選択肢は、今後追加されるすべてのレコードの有効な値を参照します。 このフィールドにこれらの値を含む既存のレコードがある場合でも、選択肢の一覧から値を削除できます。 ユーザーがブラウザーでデータを見ると赤で表示されますが、他の効果はありません。 このプロパティを使用してフィールドを更新すると、古い選択肢が削除され、新しい選択肢に置き換えられます。
targetTableId
 targetTableId string

ターゲット テーブルの ID。
displayRelative
 displayRelative boolean

時間を相対として表示するかどうかを指定します。
compositeFields
 compositeFields object
summaryTableId
 summaryTableId string

集計フィールドがフィールドを参照するテーブル。
displayTime
 displayTime boolean

日付に加えて、時刻を表示するかどうかを示します。
VersionMode
 versionMode string

ファイルのバージョン モード。 すべてのバージョンを保持し、最後のバージョンを保持します。
snapFieldId
 snapFieldId integer

値のスナップショット作成に使用されるフィールドの ID (該当する場合)。
hours24
 hours24 boolean

製品内の 24 時間形式で時刻を表示するかどうかを示します。
sortAlpha
 sortAlpha boolean

アルファベット順に並べ替えるかどうか、既定の並べ替えはレコード ID によって行われます。
sortAsGiven
 sortAsGiven boolean

一覧表示されたエントリが、入力されたエントリとアルファベット順に並べ替えられるかどうかを示します。
hasExtension
 hasExtension boolean

このフィールドに電話番号の拡張子があるかどうか。
useNewWindow
 useNewWindow boolean

ユーザーが製品内でクリックしたときに URL が新しいウィンドウを開く必要があるかどうかを示します。
appendOnly
 appendOnly boolean

このフィールドが追加のみかどうか。
displayAsLink
 displayAsLink boolean

リレーションシップの一部であるフィールドを、製品内の親レコードへのハイパーリンクとして表示するかどうかを示します。
lookupReferenceFieldId
 lookupReferenceFieldId integer

このルックアップのリレーションシップ内の参照であるフィールドの ID。
appearsByDefault
 appearsByDefault boolean

レポートでフィールドが既定値としてマークされているかどうかを示します。
ユニーク
 unique boolean

テーブル内のすべてのレコードに、このフィールドの一意の値が含まれている必要があるかどうかを示します。 フィールドを一意でないフィールドから一意に変更しようとして、テーブルに現在このフィールドの値が同じレコードが含まれている場合は、エラーが発生します。 この場合、フィールドを一意に変更する前に、フィールドの値が重複するレコードを検索して更新する必要があります。
ロール
 role string

フィールドの特定のアクセス許可に関連付けられているロール
permissionType
 permissionType string

このフィールドのロールに与えられたアクセス許可
役割ID
 roleId integer

指定されたロールの ID
addToForms
 addToForms boolean

追加するフィールドがフォームに表示されるかどうか。
ラベル
 label string

フィールドのラベル (名前)。
findEnabled
 findEnabled boolean

フィールドが検索可能としてマークされているかどうかを示します。
noWrap
 noWrap boolean

製品に表示されるときに、フィールドが折り返されないように構成されているかどうかを示します。
フィールド ID
 fieldId True integer

フィールドの一意識別子 (FID)。

戻り値

フィールドの応答を更新する
updateFieldResponse

ユーザー トークンを削除する

操作 ID:
DeleteUserToken

認証されたユーザー トークンを削除します。 これは元に戻すことはできません。

戻り値

ユーザー トークン応答の削除
deleteUserTokenResponse

ユーザー トークンを複製する

操作 ID:
CloneUserToken

認証されたユーザー トークンを複製します。 そのトークンに関連付けられているすべてのアプリケーションは、新しいトークンに自動的に関連付けられます。

パラメーター

名前 キー 必須 型 説明
名前
 name string

複製されたユーザー トークンの新しい名前。
説明
 description string

複製されたユーザー トークンの説明。

戻り値

ユーザー トークン応答の複製
cloneUserTokenResponse

ユーザー トークンを非アクティブ化する

操作 ID:
DeactivateUserToken

認証されたユーザー トークンを非アクティブ化します。 これが完了したら、ユーザー トークンをユーザー インターフェイスで再アクティブ化する必要があります。

戻り値

名前 パス 型 説明
id
 id integer

id

リレーションシップの削除

操作 ID:
DeleteRelationship

このエンドポイントを使用して、すべてのルックアップ フィールドとサマリー フィールドを含むリレーションシップ全体を削除します。 リレーションシップの参照フィールドは削除されません。

パラメーター

名前 キー 必須 型 説明
テーブル ID
 tableId True string

テーブルの一意識別子 (DBID)。 これは子テーブルになります。
リレーションシップ ID
 relationshipId True double

リレーションシップ ID。 これは、子テーブルの参照フィールドのフィールド ID です。

戻り値

リレーションシップの削除の応答
deleteRelationshipResponse

リレーションシップを作成する

操作 ID:
CreateRelationship

テーブルとルックアップ/サマリー フィールドにリレーションシップを作成します。 リレーションシップは、同じアプリ内のテーブルに対してのみ作成できます。

パラメーター

名前 キー 必須 型 説明
summaryFid
 summaryFid double

集計するフィールド ID。
ラベル
 label string

集計フィールドのラベル。
AccumulationType
 accumulationType True string

集計フィールドの累積型。
where
 where string

返されるレコードを決定する Quickbase クエリ言語を使用するフィルター。
lookupFieldIds
 lookupFieldIds array of integer

子テーブルのルックアップ フィールドになる親テーブル内のフィールド ID の配列。
parentTableId
 parentTableId True string

リレーションシップの親テーブル ID。
ラベル
 label string

外部キー フィールドのラベル。
テーブル ID
 tableId True string

テーブルの一意識別子 (DBID)。 これは子テーブルになります。

戻り値

リレーションシップ応答の作成
createRelationshipResponse

リレーションシップを更新する

操作 ID:
UpdateRelationship

このエンドポイントを使用して、ルックアップ フィールドとサマリー フィールドを既存のリレーションシップに追加します。 リレーションシップを更新すると、既存のルックアップ/サマリー フィールドは削除されません。

パラメーター

名前 キー 必須 型 説明
summaryFid
 summaryFid double

集計するフィールド ID。
ラベル
 label string

集計フィールドのラベル。
AccumulationType
 accumulationType True string

集計フィールドの累積型。
where
 where string

返されるレコードを決定する Quickbase クエリ言語を使用するフィルター。
lookupFieldIds
 lookupFieldIds array of integer

子テーブルのルックアップ フィールドになる親テーブルのフィールド ID の配列。
テーブル ID
 tableId True string

テーブルの一意識別子 (DBID)。 これは子テーブルになります。
リレーションシップ ID
 relationshipId True double

リレーションシップ ID。 これは、子テーブルの参照フィールドのフィールド ID です。

戻り値

リレーションシップの応答を更新する
updateRelationshipResponse

レコードを削除する

操作 ID:
DeleteRecords

クエリに基づいてテーブル内のレコードを削除します。 または、テーブル内のすべてのレコードを削除できます。

パラメーター

名前 キー 必須 型 説明
from
 from True string

テーブルの一意識別子。
where
 where True string

レコードを削除するフィルター。 すべてのレコードを削除するには、すべてのレコードを含むフィルターを指定します (例: {3.GT.0} )。3 は [レコード ID] フィールドの ID です。

戻り値

レコードの削除応答
deleteRecordsResponse

レポートを取得する

操作 ID:
GetReport

個々のレポートのスキーマ (プロパティ) を取得します。

パラメーター

名前 キー 必須 型 説明
テーブル ID
 tableId True string

テーブルの一意識別子。
レポート ID
 reportId True string

テーブルに固有のレポートの識別子。

戻り値

レポートの応答を取得する
getReportResponse

レポートを実行する

操作 ID:
RunReport

ID に基づいてレポートを実行し、それに関連付けられている基になるデータを返します。 データの形式は、レポートの種類によって異なります。 レコード レベルのデータ (テーブル、カレンダーなど) に焦点を当てたレポートは、個々のレコードを返します。 集計レポート (概要、グラフ) は、レポートで構成されている概要情報を返します。 合計、平均、視覚化など、UI 固有の要素は返されません。 各レコードのおおよそのサイズに基づいて、インテリジェントな改ページ位置を持つデータを返します。 メタデータ オブジェクトには、応答を反復処理し、より多くのデータを収集するために必要な情報が含まれます。

パラメーター

名前 キー 必須 型 説明
テーブル ID
 tableId True string

レポートのテーブルの識別子。
スキップ
 skip integer

スキップするレコードの数。 この値は、一連の結果をページ分割するときに設定できます。
上
 top integer

返されるレコードの最大数。 既定のクイックベースの改ページ位置をオーバーライドして、結果を増減できます。 ここで要求した値が動的最大値を超えた場合は、結果のサブセットが返され、残りは後続の API 呼び出しで収集できます。
object
レポート ID
 reportId True string

テーブルに固有のレポートの識別子。

戻り値

レポート応答の実行
runReportResponse

数式を実行する

操作 ID:
RunFormula

API 呼び出しを介した数式の実行を許可します。 レコードに不連続フィールドがない数式の値を取得するには、カスタム コードでこのメソッドを使用します。

パラメーター

名前 キー 必須 型 説明
数式
 formula True string

実行する数式。 これは、有効なクイックベースの数式である必要があります。
rid
 rid integer

数式を実行するレコード ID。 レコードのコンテキストで実行される数式にのみ必要です。 たとえば、式 User() にはレコード ID は必要ありません。
from
 from True string

テーブルの一意識別子 (dbid)。

戻り値

数式の応答を実行する
runFormulaResponse

添付ファイルをダウンロードする

操作 ID:
DownloadFile

添付ファイルをダウンロードし、添付ファイルの内容を base64 形式でエンコードします。 API 応答は、 Content-Disposition ヘッダー内のファイル名を返します。 ファイルに関するメタデータは、/records および /reports エンドポイントから取得できます (該当する場合)。 これらのエンドポイントを使用して、ファイルをフェッチするために必要な情報を取得します。

パラメーター

名前 キー 必須 型 説明
テーブル ID
 tableId True string

テーブルの一意識別子。
レコード ID
 recordId True integer

レコードの一意識別子。
フィールド ID
 fieldId True integer

フィールドの一意識別子。
バージョン番号
 versionNumber True integer

添付ファイルのバージョン番号。

戻り値

response
string

添付ファイルを削除する

操作 ID:
DeleteFile

1 つの添付ファイル バージョンを削除します。 ファイルに関するメタデータは、/records および /reports エンドポイントから取得できます (該当する場合)。 これらのエンドポイントを使用して、ファイル バージョンを削除するために必要な情報を取得します。

パラメーター

名前 キー 必須 型 説明
テーブル ID
 tableId True string

テーブルの一意識別子。
レコード ID
 recordId True integer

レコードの一意識別子。
フィールド ID
 fieldId True integer

フィールドの一意識別子。
バージョン番号
 versionNumber True integer

添付ファイルのバージョン番号。

戻り値

ファイルの削除応答
deleteFileResponse

定義

createAppResponse

名前 パス 型 説明
名前
 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 ガイドの フィールド型の詳細 ページを参照してください。 アプリの日付形式を設定するには、「 日付のローカライズについて」 を参照してください。
timeZone
 timeZone string

このアプリで時刻値を表示するときに使用されるタイム ゾーンの説明。 これはブラウザー専用のパラメーターであることに注意してください。API 呼び出しで時刻値が返される方法については、ポータルの フィールド型の詳細 ページを参照してください。 アプリケーションのタイム ゾーンを設定するには、「アプリケーションとアカウントの両方のタイム ゾーンを設定する」を参照してください。
id
 id string

このアプリケーションの一意識別子。
hasEveryoneOnTheInternet
 hasEveryoneOnTheInternet boolean

アプリに Everyone On The Internet Access が含まれているかどうかを示します。 「インターネット上のすべてのユーザーとアプリを共有する (EOTI)」を参照してください。
variables
 variables array of Variable1

アプリ変数。 「アプリケーション変数について」を参照してください
dataClassification
 dataClassification string

アプリケーションに割り当てられたデータ分類ラベル。 データ分類が有効でない場合、これは返されません。 データ分類が有効になっていても、アプリケーションにラベルが付かない場合は、"なし" が返されます。 データ分類ラベルは、Platform+ プランの領域管理者によって管理コンソールに追加できます。

Variable1

名前 パス 型 説明
名前
 name string

変数名。
value
 value string

変数の値。

getAppResponse

名前 パス 型 説明
名前
 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 ガイドの フィールド型の詳細 ページを参照してください。 アプリの日付形式を設定するには、「 日付のローカライズについて」 を参照してください。
timeZone
 timeZone string

このアプリで時刻値を表示するときに使用されるタイム ゾーンの説明。 これはブラウザー専用のパラメーターであることに注意してください。API 呼び出しで時刻値が返される方法については、ポータルの フィールド型の詳細 ページを参照してください。 アプリケーションのタイム ゾーンを設定するには、「アプリケーションとアカウントの両方のタイム ゾーンを設定する」を参照してください。
id
 id string

このアプリケーションの一意識別子。
hasEveryoneOnTheInternet
 hasEveryoneOnTheInternet boolean

アプリに Everyone On The Internet Access が含まれているかどうかを示します。 「インターネット上のすべてのユーザーとアプリを共有する (EOTI)」を参照してください。
variables
 variables array of Variable1

アプリ変数。 「アプリケーション変数について」を参照してください
dataClassification
 dataClassification string

アプリケーションに割り当てられたデータ分類ラベル。 データ分類が有効でない場合、これは返されません。 データ分類が有効になっていても、アプリケーションにラベルが付かない場合は、"なし" が返されます。 データ分類ラベルは、Platform+ プランの領域管理者によって管理コンソールに追加できます。

updateAppResponse

名前 パス 型 説明
名前
 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 ガイドの フィールド型の詳細 ページを参照してください。 アプリの日付形式を設定するには、「 日付のローカライズについて」 を参照してください。
timeZone
 timeZone string

このアプリで時刻値を表示するときに使用されるタイム ゾーンの説明。 これはブラウザー専用のパラメーターであることに注意してください。API 呼び出しで時刻値が返される方法については、ポータルの フィールド型の詳細 ページを参照してください。 アプリケーションのタイム ゾーンを設定するには、「アプリケーションとアカウントの両方のタイム ゾーンを設定する」を参照してください。
id
 id string

このアプリケーションの一意識別子。
hasEveryoneOnTheInternet
 hasEveryoneOnTheInternet boolean

アプリに Everyone On The Internet Access が含まれているかどうかを示します。 「インターネット上のすべてのユーザーとアプリを共有する (EOTI)」を参照してください。
variables
 variables array of Variable1

アプリ変数。 「アプリケーション変数について」を参照してください
dataClassification
 dataClassification string

アプリケーションに割り当てられたデータ分類ラベル。 データ分類が有効でない場合、これは返されません。 データ分類が有効になっていても、アプリケーションにラベルが付かない場合は、"なし" が返されます。 データ分類ラベルは、Platform+ プランの領域管理者によって管理コンソールに追加できます。

deleteAppResponse

名前 パス 型 説明
deletedAppId
 deletedAppId string

削除されたアプリケーションの ID。

copyAppResponse

名前 パス 型 説明
名前
 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 ガイドの フィールド型の詳細 ページを参照してください。 アプリの日付形式を設定するには、「 日付のローカライズについて」 を参照してください。
timeZone
 timeZone string

このアプリで時刻値を表示するときに使用されるタイム ゾーンの説明。 これはブラウザー専用のパラメーターであることに注意してください。API 呼び出しで時刻値が返される方法については、ポータルの フィールド型の詳細 ページを参照してください。 アプリケーションのタイム ゾーンを設定するには、「アプリケーションとアカウントの両方のタイム ゾーンを設定する」を参照してください。
id
 id string

このアプリケーションの一意識別子。
hasEveryoneOnTheInternet
 hasEveryoneOnTheInternet boolean

アプリに Everyone On The Internet Access が含まれているかどうかを示します。 「インターネット上のすべてのユーザーとアプリを共有する (EOTI)」を参照してください。
variables
 variables array of Variable1

アプリ変数。 「アプリケーション変数について」を参照してください
ancestorId
 ancestorId string

このアプリのコピー元のアプリの ID
dataClassification
 dataClassification string

アプリケーションに割り当てられたデータ分類ラベル。 データ分類が有効でない場合、これは返されません。 データ分類が有効になっていても、アプリケーションにラベルが付かない場合は、"なし" が返されます。 データ分類ラベルは、Platform+ プランの領域管理者によって管理コンソールに追加できます。

createTableResponse

名前 パス 型 説明
名前
 name string

テーブルの名前。
id
 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
 nextRecordId integer

API 呼び出しの実行時に決定される、次のレコードの作成時に使用される増分レコード ID。
nextFieldId
 nextFieldId integer

API 呼び出しの実行時に決定される、次のフィールドの作成時に使用される増分フィールド ID。
defaultSortFieldId
 defaultSortFieldId integer

既定の並べ替えに構成されているフィールドの ID。
DefaultSortOrder
 defaultSortOrder DefaultSortOrder

テーブルの既定の並べ替え順序の構成。
keyFieldId
 keyFieldId integer

このテーブルのキーとして構成されているフィールドの ID(通常はクイックベース レコード ID)。
singleRecordName
 singleRecordName string

テーブルのビルダーで構成された単数名詞。
pluralRecordName
 pluralRecordName string

テーブルのビルダーで構成された複数形の名詞。
sizeLimit
 sizeLimit string

テーブルのサイズ制限。
spaceUsed
 spaceUsed string

テーブルで現在使用されている領域の量。
spaceRemaining
 spaceRemaining string

テーブルで使用するために残っている領域の量。

DefaultSortOrder

テーブルの既定の並べ替え順序の構成。

テーブルの既定の並べ替え順序の構成。

DefaultSortOrder
string

getTableResponse

名前 パス 型 説明
名前
 name string

テーブルの名前。
id
 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
 nextRecordId integer

API 呼び出しの実行時に決定される、次のレコードの作成時に使用される増分レコード ID。
nextFieldId
 nextFieldId integer

API 呼び出しの実行時に決定される、次のフィールドの作成時に使用される増分フィールド ID。
defaultSortFieldId
 defaultSortFieldId integer

既定の並べ替えに構成されているフィールドの ID。
DefaultSortOrder
 defaultSortOrder DefaultSortOrder

テーブルの既定の並べ替え順序の構成。
keyFieldId
 keyFieldId integer

このテーブルのキーとして構成されているフィールドの ID(通常はクイックベース レコード ID)。
singleRecordName
 singleRecordName string

テーブルのビルダーで構成された単数名詞。
pluralRecordName
 pluralRecordName string

テーブルのビルダーで構成された複数形の名詞。
sizeLimit
 sizeLimit string

テーブルのサイズ制限。
spaceUsed
 spaceUsed string

テーブルで現在使用されている領域の量。
spaceRemaining
 spaceRemaining string

テーブルで使用するために残っている領域の量。

updateTableResponse

名前 パス 型 説明
名前
 name string

テーブルの名前。
id
 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
 nextRecordId integer

API 呼び出しの実行時に決定される、次のレコードの作成時に使用される増分レコード ID。
nextFieldId
 nextFieldId integer

API 呼び出しの実行時に決定される、次のフィールドの作成時に使用される増分フィールド ID。
defaultSortFieldId
 defaultSortFieldId integer

既定の並べ替えに構成されているフィールドの ID。
DefaultSortOrder
 defaultSortOrder DefaultSortOrder

テーブルの既定の並べ替え順序の構成。
keyFieldId
 keyFieldId integer

このテーブルのキーとして構成されているフィールドの ID(通常はクイックベース レコード ID)。
singleRecordName
 singleRecordName string

テーブルのビルダーで構成された単数名詞。
pluralRecordName
 pluralRecordName string

テーブルのビルダーで構成された複数形の名詞。
sizeLimit
 sizeLimit string

テーブルのサイズ制限。
spaceUsed
 spaceUsed string

テーブルで現在使用されている領域の量。
spaceRemaining
 spaceRemaining string

テーブルで使用するために残っている領域の量。

deleteTableResponse

名前 パス 型 説明
deletedTableId
 deletedTableId string

削除されたテーブル ID。

getRelationshipsResponse

名前 パス 型 説明
関係
 relationships array of Relationship

テーブル内のリレーションシップ。
メタデータ
 metadata Metadata

役に立つ可能性がある結果に関する追加情報。

Relationship

名前 パス 型 説明
id
 id integer

リレーションシップ ID (外部キー フィールド ID)。
parentTableId
 parentTableId string

リレーションシップの親テーブル ID。
childTableId
 childTableId string

リレーションシップの子テーブル ID。
ForeignKeyField
 foreignKeyField ForeignKeyField

外部キー フィールド情報。
isCrossApp
 isCrossApp boolean

これがアプリ間の関係であるかどうか。
lookupFields
 lookupFields array of LookupField

ルックアップ フィールドの配列。
summaryFields
 summaryFields array of SummaryField

集計フィールドの配列。

ForeignKeyField

外部キー フィールド情報。

名前 パス 型 説明
id
 id integer

フィールド ID。
ラベル
 label string

フィールド ラベル。
型
 type string

フィールド型。

LookupField

名前 パス 型 説明
id
 id integer

フィールド ID。
ラベル
 label string

フィールド ラベル。
型
 type string

フィールド型。

SummaryField

名前 パス 型 説明
id
 id integer

フィールド ID。
ラベル
 label string

フィールド ラベル。
型
 type string

フィールド型。

メタデータ

役に立つ可能性がある結果に関する追加情報。

名前 パス 型 説明
スキップ
 skip integer

スキップするリレーションシップの数。
totalRelationships
 totalRelationships integer

リレーションシップの合計数。
numRelationships
 numRelationships integer

現在の応答オブジェクト内のリレーションシップの数。

createRelationshipResponse

名前 パス 型 説明
id
 id integer

リレーションシップ ID (外部キー フィールド ID)。
parentTableId
 parentTableId string

リレーションシップの親テーブル ID。
childTableId
 childTableId string

リレーションシップの子テーブル ID。
ForeignKeyField
 foreignKeyField ForeignKeyField

外部キー フィールド情報。
isCrossApp
 isCrossApp boolean

これがアプリ間の関係であるかどうか。
lookupFields
 lookupFields array of LookupField

ルックアップ フィールドの配列。
summaryFields
 summaryFields array of SummaryField

集計フィールドの配列。

updateRelationshipResponse

名前 パス 型 説明
id
 id integer

リレーションシップ ID (外部キー フィールド ID)。
parentTableId
 parentTableId string

リレーションシップの親テーブル ID。
childTableId
 childTableId string

リレーションシップの子テーブル ID。
ForeignKeyField
 foreignKeyField ForeignKeyField

外部キー フィールド情報。
isCrossApp
 isCrossApp boolean

これがアプリ間の関係であるかどうか。
lookupFields
 lookupFields array of LookupField

ルックアップ フィールドの配列。
summaryFields
 summaryFields array of SummaryField

集計フィールドの配列。

deleteRelationshipResponse

名前 パス 型 説明
relationshipId
 relationshipId integer

リレーションシップ ID。

Query

レポートの実行時に実行されるクイックベースで構成されたクエリ定義。

名前 パス 型 説明
tableId
 tableId string

レポートのテーブル識別子。
フィルタ
 filter string

データのクエリに使用されるフィルター。
formulaFields
 formulaFields array of FormulaField

計算された数式フィールド。

FormulaField

名前 パス 型 説明
id
 id integer

数式フィールド識別子。
ラベル
 label string

数式フィールドのラベル。
FieldType
 fieldType FieldType

結果の数式値の型。
数式
 formula string

数式テキスト。
decimalPrecision
 decimalPrecision integer

数値数式の場合は、数値の有効桁数を指定します。

FieldType

結果の数式値の型。

結果の数式値の型。

FieldType
string

getReportResponse

名前 パス 型 説明
id
 id string

テーブルに固有のレポートの識別子。
名前
 name string

レポートの構成済み名前。
型
 type string

クイックベースのレポートの種類 (グラフなど)。
説明
 description string

レポートの構成済みの説明。
オーナーID
 ownerId integer

省略可能。個人用レポートにのみ表示されます。 レポート所有者のユーザー ID。
Query
 query Query

レポートの実行時に実行されるクイックベースで構成されたクエリ定義。
プロパティ
 properties object

レポートの種類に固有のプロパティの一覧。 各レポートの種類のプロパティの詳細な説明については、「レポートの種類」を参照してください 。
usedLast
 usedLast string

レポートが最後に使用された瞬間。
usedCount
 usedCount integer

レポートが使用された回数。

runReportResponse

名前 パス 型 説明
fields
 fields array of Field

レポートに表示される各フィールドの限られたメタデータを含むオブジェクトの配列。 これにより、フィールドの種類と ID に依存するロジックを構築できます。
データ
 data array of object

レポートの種類に応じて、レコード データまたは集計値を表すオブジェクトの配列。
items
 data object
Metadata1
 metadata Metadata1

役に立つ可能性がある結果に関する追加情報。 スキップする結果の数を少なく指定した場合、または API が自動的に返す結果の数が少ない場合は、改ページが必要になる場合があります。 numRecords を totalRecords と比較して、さらに改ページが必要かどうかを判断できます。

フィールド

名前 パス 型 説明
id
 id integer

フィールド ID。
ラベル
 label string

フィールド ラベル。
型
 type string

フィールド型。
labelOverride
 labelOverride string

レポート内のフィールドの列見出しラベルのオーバーライド。

Metadata1

役に立つ可能性がある結果に関する追加情報。 スキップする結果の数を少なく指定した場合、または API が自動的に返す結果の数が少ない場合は、改ページが必要になる場合があります。 numRecords を totalRecords と比較して、さらに改ページが必要かどうかを判断できます。

名前 パス 型 説明
スキップ
 skip integer

スキップするレコードの数
numFields
 numFields integer

現在の応答オブジェクト内の各レコード内のフィールドの数
top
 top integer

存在する場合、呼び出し元によって要求されたレコードの最大数
totalRecords
 totalRecords integer

結果セット内のレコードの合計数
numRecords
 numRecords integer

現在の応答オブジェクト内のレコードの数

Properties1

フィールドの追加のプロパティ。 各 フィールドの種類 のプロパティの詳細については、「フィールド型の詳細」ページを参照してください。

名前 パス 型 説明
comments
 comments string

管理者がフィールド プロパティに入力したコメント。
doesTotal
 doesTotal boolean

このフィールドが製品内のレポートに合計されるかどうか。
autoSave
 autoSave boolean

リンク フィールドが自動的に保存されるかどうか。
defaultValueLuid
 defaultValueLuid integer

既定のユーザー ID 値。
maxVersions
 maxVersions integer

添付ファイル用に構成されたバージョンの最大数。
carryChoices
 carryChoices boolean

コピー時にフィールドに複数の選択肢フィールドを含めるかどうか。
format
 format integer

時刻を表示する形式。
最大長さ
 maxLength integer

このフィールドのクイックベースでの入力に使用できる最大文字数。
linkText
 linkText string

ユーザーが製品内で表示する URL を置き換える、構成済みのテキスト値。
parentFieldId
 parentFieldId integer

親複合フィールドの ID (該当する場合)。
displayTimezone
 displayTimezone boolean

製品内のタイムゾーンを表示するかどうかを示します。
summaryTargetFieldId
 summaryTargetFieldId integer

該当する場合は、子からの値を集計するために使用されるフィールドの ID。 集計関数にフィールドの選択 (count など) が必要ない場合は、0 が表示されます。
allowNewChoices
 allowNewChoices boolean

ユーザーが選択リストに新しい選択肢を追加できるかどうかを示します。
masterChoiceFieldId
 masterChoiceFieldId integer

リレーションシップ内の参照であるフィールドの ID。
defaultToday
 defaultToday boolean

新しいレコードに対してフィールド値が今日既定値に設定されているかどうかを示します。
単位
 units string

単位ラベル。
lookupTargetFieldId
 lookupTargetFieldId integer

この参照のマスター テーブルのターゲットであるフィールドの ID。
SummaryFunction
 summaryFunction SummaryFunction

集計累積関数の型。
sourceFieldId
 sourceFieldId integer

ソース フィールドの ID。
masterTableTag
 masterTableTag string

このフィールドが含まれるリレーションシップのマスター テーブルのテーブル エイリアス。
doesAverage
 doesAverage boolean

このフィールドが製品内のレポートで平均化されるかどうか。
数式
 formula string

Quickbase で構成されたフィールドの数式。
decimalPlaces
 decimalPlaces integer

このフィールドの製品に表示される小数点以下の桁数。
seeVersions
 seeVersions boolean

ユーザーが製品内の添付ファイルの最新バージョン以外の他のバージョンを表示できるかどうかを示します。
displayMonth
 displayMonth string

月を表示する方法。
numLines
 numLines integer

このテキスト フィールドのクイックベースに表示される行数。
displayEmail
 displayEmail string

電子メールの表示方法。
defaultKind
 defaultKind string

ユーザーの既定の種類。
coverText
 coverText string

ブラウザーにリンクを表示するために使用できる、ユーザーフレンドリな代替テキスト。
currencySymbol
 currencySymbol string

製品内のフィールド値を表示するときに使用される現在のシンボル。
masterChoiceTableId
 masterChoiceTableId integer

このリレーションシップのマスターテーブルの ID。
targetFieldId
 targetFieldId integer

ターゲット フィールドの ID。
displayUser
 displayUser string

ユーザーが製品内でどのように表示されるかを示す構成済みオプション。
blankIsZero
 blankIsZero boolean

空白値が製品内の計算で 0 と同じように扱われるかどうか。
正確
 exact boolean

レポート リンクに完全一致が必要かどうか。
startField
 startField integer

開始フィールド ID。
defaultDomain
 defaultDomain string

既定の電子メール ドメイン。
defaultValue
 defaultValue string

新しいレコードが追加されたときにフィールドに対して構成される既定値。
choicesLuid
 choicesLuid array of object

ユーザーの選択肢の一覧。
items
 choicesLuid object
略す
 abbreviate boolean

URL を表示するときに URL プロトコルを表示しないでください。
xmlTag
 xmlTag string

フィールドの xml タグ。
targetTableName
 targetTableName string

フィールドのターゲット テーブル名。
数値フォーマット
 numberFormat integer

製品の数値を表示するために使用される形式 (小数点、区切り記号、数字グループ)。
appearsAs
 appearsAs string

リンク テキスト (空の場合) は、URL がリンク テキストとして使用されます。
width
 width integer

製品のフィールドの html 入力幅。
CurrencyFormat
 currencyFormat CurrencyFormat

製品内のフィールド値を表示するときに使用される通貨形式。
displayImages
 displayImages boolean

製品内のフォームとレポートの添付ファイルに画像を表示するかどうかを示します。
foreignKey
 foreignKey boolean

フィールドがリレーションシップの外部キー (または参照フィールド) であるかどうかを示します。
displayDayOfWeek
 displayDayOfWeek boolean

製品内の曜日を表示するかどうかを示します。
summaryReferenceFieldId
 summaryReferenceFieldId integer

この概要のリレーションシップ内の参照であるフィールドの ID。
commaStart
 commaStart integer

該当する場合は、製品にコンマの前に表示される桁数。
choices
 choices array of string

ユーザーに選択肢を提供するフィールドに存在するエントリの配列。
targetTableId
 targetTableId string

ターゲット テーブルの ID。
displayRelative
 displayRelative boolean

時間を相対として表示するかどうかを指定します。
compositeFields
 compositeFields array of object

複合フィールドを構成するフィールドの配列 (例: address)。
items
 compositeFields object
VersionMode
 versionMode VersionMode

ファイルのバージョン モード。 すべてのバージョンを保持し、最後のバージョンを保持します。
displayTime
 displayTime boolean

日付に加えて、時刻を表示するかどうかを示します。
durationField
 durationField integer

期間フィールド ID。
snapFieldId
 snapFieldId integer

値のスナップショット作成に使用されるフィールドの ID (該当する場合)。
hours24
 hours24 boolean

製品内の 24 時間形式で時刻を表示するかどうかを示します。
sortAlpha
 sortAlpha boolean

アルファベット順に並べ替えるかどうか、既定の並べ替えはレコード ID によって行われます。
sortAsGiven
 sortAsGiven boolean

一覧表示されたエントリが、入力されたエントリとアルファベット順に並べ替えられるかどうかを示します。
hasExtension
 hasExtension boolean

このフィールドに電話番号の拡張子があるかどうか。
制
 workWeek integer

稼働日の種類。
useNewWindow
 useNewWindow boolean

ユーザーが製品内でクリックしたときに URL が新しいウィンドウを開く必要があるかどうかを示します。
appendOnly
 appendOnly boolean

このフィールドが追加のみかどうか。
displayAsLink
 displayAsLink boolean

リレーションシップの一部であるフィールドを、製品内の親レコードへのハイパーリンクとして表示するかどうかを示します。
allowHTML
 allowHTML boolean

このフィールドで html が許可されるかどうか。
lookupReferenceFieldId
 lookupReferenceFieldId integer

このルックアップのリレーションシップ内の参照であるフィールドの ID。

SummaryFunction

集計累積関数の型。

集計累積関数の型。

SummaryFunction
string

CurrencyFormat

製品内のフィールド値を表示するときに使用される通貨形式。

製品内のフィールド値を表示するときに使用される通貨形式。

CurrencyFormat
string

VersionMode

ファイルのバージョン モード。 すべてのバージョンを保持し、最後のバージョンを保持します。

ファイルのバージョン モード。 すべてのバージョンを保持し、最後のバージョンを保持します。

VersionMode
string

権限

名前 パス 型 説明
ロール
 role string

フィールドの特定のアクセス許可に関連付けられているロール
permissionType
 permissionType string

このフィールドのロールに与えられたアクセス許可
役割ID
 roleId integer

指定されたロールの ID

createFieldResponse

名前 パス 型 説明
id
 id integer

このテーブルに固有のフィールドの ID。
fieldType
 fieldType string

ここで説明するフィールドの種類。
mode
 mode string

派生フィールドの場合、派生フィールドの種類を示す 'lookup'、'summary'、または 'formula' になります。 非派生フィールドの場合、これは空白になります。
ラベル
 label string

フィールドのラベル (名前)。
noWrap
 noWrap boolean

製品に表示されるときに、フィールドが折り返されないように構成されているかどうかを示します。
太字
 bold boolean

フィールドが製品に太字で表示されるように構成されているかどうかを示します。
required
 required boolean

フィールドが必須としてマークされているかどうかを示します。
appearsByDefault
 appearsByDefault boolean

レポートでフィールドが既定値としてマークされているかどうかを示します。
findEnabled
 findEnabled boolean

フィールドが検索可能としてマークされているかどうかを示します。
ユニーク
 unique boolean

フィールドが一意としてマークされているかどうかを示します。
doesDataCopy
 doesDataCopy boolean

ユーザーがレコードをコピーするときにフィールド データがコピーされるかどうかを示します。
fieldHelp
 fieldHelp string

製品内のユーザーに表示される、構成済みのヘルプ テキスト。
監査
 audited boolean

フィールドが Quickbase 監査ログの一部として追跡されているかどうかを示します。
Properties1
 properties Properties1

フィールドの追加のプロパティ。 各 フィールドの種類 のプロパティの詳細については、「フィールド型の詳細」ページを参照してください。
アクセス許可
 permissions array of Permission

さまざまなロールのフィールド権限。

deleteFieldsResponse

名前 パス 型 説明
deletedFieldIds
 deletedFieldIds array of integer

削除されたフィールド ID の一覧。
エラー
 errors array of string

見つかったエラーの一覧。

getFieldResponse

名前 パス 型 説明
id
 id integer

このテーブルに固有のフィールドの ID。
fieldType
 fieldType string

ここで説明するフィールドの種類。
mode
 mode string

派生フィールドの場合、派生フィールドの種類を示す 'lookup'、'summary'、または 'formula' になります。 非派生フィールドの場合、これは空白になります。
ラベル
 label string

フィールドのラベル (名前)。
noWrap
 noWrap boolean

製品に表示されるときに、フィールドが折り返されないように構成されているかどうかを示します。
太字
 bold boolean

フィールドが製品に太字で表示されるように構成されているかどうかを示します。
required
 required boolean

フィールドが必須としてマークされているかどうかを示します。
appearsByDefault
 appearsByDefault boolean

レポートでフィールドが既定値としてマークされているかどうかを示します。
findEnabled
 findEnabled boolean

フィールドが検索可能としてマークされているかどうかを示します。
ユニーク
 unique boolean

フィールドが一意としてマークされているかどうかを示します。
doesDataCopy
 doesDataCopy boolean

ユーザーがレコードをコピーするときにフィールド データがコピーされるかどうかを示します。
fieldHelp
 fieldHelp string

製品内のユーザーに表示される、構成済みのヘルプ テキスト。
監査
 audited boolean

フィールドが Quickbase 監査ログの一部として追跡されているかどうかを示します。
Properties1
 properties Properties1

フィールドの追加のプロパティ。 各 フィールドの種類 のプロパティの詳細については、「フィールド型の詳細」ページを参照してください。
アクセス許可
 permissions array of Permission

さまざまなロールのフィールド権限。

updateFieldResponse

名前 パス 型 説明
id
 id integer

このテーブルに固有のフィールドの ID。
fieldType
 fieldType string

ここで説明するフィールドの種類。
mode
 mode string

派生フィールドの場合、派生フィールドの種類を示す 'lookup'、'summary'、または 'formula' になります。 非派生フィールドの場合、これは空白になります。
ラベル
 label string

フィールドのラベル (名前)。
noWrap
 noWrap boolean

製品に表示されるときに、フィールドが折り返されないように構成されているかどうかを示します。
太字
 bold boolean

フィールドが製品に太字で表示されるように構成されているかどうかを示します。
required
 required boolean

フィールドが必須としてマークされているかどうかを示します。
appearsByDefault
 appearsByDefault boolean

レポートでフィールドが既定値としてマークされているかどうかを示します。
findEnabled
 findEnabled boolean

フィールドが検索可能としてマークされているかどうかを示します。
ユニーク
 unique boolean

フィールドが一意としてマークされているかどうかを示します。
doesDataCopy
 doesDataCopy boolean

ユーザーがレコードをコピーするときにフィールド データがコピーされるかどうかを示します。
fieldHelp
 fieldHelp string

製品内のユーザーに表示される、構成済みのヘルプ テキスト。
監査
 audited boolean

フィールドが Quickbase 監査ログの一部として追跡されているかどうかを示します。
Properties1
 properties Properties1

フィールドの追加のプロパティ。 各 フィールドの種類 のプロパティの詳細については、「フィールド型の詳細」ページを参照してください。
アクセス許可
 permissions array of Permission

さまざまなロールのフィールド権限。

runFormulaResponse

名前 パス 型 説明
結果
 result string

数式の実行結果。

upsertResponse

追加、更新、または変更されていないレコードの詳細を含む正常な応答。 次の例では、テーブルには以前、ID が 1 ~ 10 のレコードが 10 個ありました。 ユーザーは、レコード 1 の値を更新し、2 つの新しいレコードをすべて正常に追加するアップサートを投稿します。

名前 パス 型 説明
Metadata2
 metadata Metadata2

作成されたレコード、更新されたレコード、参照されているが変更されていないレコード、処理中にエラーが発生したレコードに関する情報。
データ
 data array of object

返されることが予想されるデータ。
items
 data object

Metadata2

作成されたレコード、更新されたレコード、参照されているが変更されていないレコード、処理中にエラーが発生したレコードに関する情報。

名前 パス 型 説明
createdRecordIds
 createdRecordIds array of integer

作成されたレコード ID を含む配列。
lineErrors
 lineErrors object

これは、失敗したレコードの場合にのみ返されます。 これは、レコードが処理されなかった受信データを処理するときに発生したエラーのコレクションです。 各オブジェクトには、元のペイロード (1 から始まる) のレコードのシーケンス番号を表すキーがあります。 値は、発生したエラーの一覧です。
unchangedRecordIds
 unchangedRecordIds array of integer

変更されていないレコード ID を含む配列。
updatedRecordIds
 updatedRecordIds array of integer

更新されたレコード ID を含む配列。
totalNumberOfRecordsProcessed
 totalNumberOfRecordsProcessed integer

処理されたレコードの数。 成功したレコードと失敗したレコードの更新が含まれます。

deleteRecordsResponse

名前 パス 型 説明
numberDeleted
 numberDeleted integer

削除されたレコードの数。

runQueryResponse

名前 パス 型 説明
fields
 fields array of Fields2

レポートに表示される各フィールドの限られたメタデータを含むオブジェクトの配列。 これにより、フィールドの種類と ID に依存するロジックを構築できます。
データ
 data array of object

レポートの種類に応じて、レコード データまたは集計値を表すオブジェクトの配列。
items
 data object
Metadata1
 metadata Metadata1

役に立つ可能性がある結果に関する追加情報。 スキップする結果の数を少なく指定した場合、または API が自動的に返す結果の数が少ない場合は、改ページが必要になる場合があります。 numRecords を totalRecords と比較して、さらに改ページが必要かどうかを判断できます。

Fields2

名前 パス 型 説明
id
 id integer

フィールド ID。
ラベル
 label string

フィールド ラベル。
型
 type string

フィールド型。

getTempTokenDBIDResponse

名前 パス 型 説明
temporaryAuthorization
 temporaryAuthorization string

一時的な承認トークン。

cloneUserTokenResponse

名前 パス 型 説明
活動中
 active boolean

ユーザー トークンがアクティブかどうか。
apps
 apps array of App

このユーザー トークンが割り当てられているアプリの一覧。
lastUsed
 lastUsed string

このユーザー トークンが使用された最後の日付 。ISO 8601 時刻形式の YYYY-MM-DDThh:mm:ss.sssZ (UTC タイム ゾーン)。
説明
 description string

ユーザー トークンの説明。
id
 id integer

ユーザー トークン ID。
名前
 name string

ユーザー トークン名。
トークン
 token string

ユーザー トークン値。

App

名前 パス 型 説明
id
 id string

このアプリケーションの一意識別子。
名前
 name string

アプリケーションの名前。

deleteUserTokenResponse

名前 パス 型 説明
id
 id integer

ユーザー トークン ID。

deleteFileResponse

名前 パス 型 説明
versionNumber
 versionNumber integer

削除されたバージョンの数。
fileName
 fileName string

削除されたバージョンに関連付けられているファイルの名前。
アップロード
 uploaded string

バージョンが最初にアップロードされたときのタイムスタンプ。
Creator
 creator Creator

バージョンをアップロードしたユーザー。

Creator

バージョンをアップロードしたユーザー。

名前 パス 型 説明
名前
 name string

ユーザーのフル ネーム。
id
 id string

ユーザー ID。
メール
 email string

ユーザーの電子メール。
ユーザー名
 userName string

ユーザー プロパティで更新されたユーザー名。 省略可能。ユーザーの電子メールと同じでない場合に表示されます。

文字列

これは基本的なデータ型 'string' です。