次の方法で共有


Quickbase (独立発行者)

Quickbase は、あらゆる技術的バックグラウンドを持つ問題解決者が協力して、安全かつ持続的にアプリケーションのエコシステムを作成できるようにすることで、ビジネスチームと IT チームを結びつけるアプリケーション開発プラットフォームです。 Quickbase は、1 つの共通プラットフォームで大規模な市民による開発を可能にすることにより、企業が独自のプロセスの継続的なイノベーションを加速するのに役立ちます。

このコネクタは、次の製品および地域で利用可能です。

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Troy Taylor
[URL] https://www.hitachisolutions.com
メール ttaylor@hitachisolutions.com
Connector Metadata
発行者 Troy Taylor、Hitachi Solutions
Web サイト https://www.quickbase.com/
プライバシー ポリシー https://www.quickbase.com/privacy
カテゴリ 生産性;IT オペレーション

接続の作成

コネクタは、次の認証タイプをサポートしています。

既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

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

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

名前 タイプ 説明 必須
領域のホスト名 string 領域のホスト名を指定します。 True
認可 securestring 「QB-USER-TOKEN yourToken」 形式のユーザー トークン。 True

調整制限

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

アクション

DBID の一時トークンの取得

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

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

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

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

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

アプリ イベントを取得

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

アプリのコピー

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

アプリのテーブルを取得

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

アプリの作成

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

アプリの削除

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

アプリの更新

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

アプリを取得

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

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

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

テーブルの作成

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

テーブルの削除

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

テーブルの更新

特定のテーブルの主要なプロパティを更新します。 リクエスト本文で指定しないテーブルのプロパティは変更されません。

テーブルを取得

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

データに対するクエリ

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

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

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

フィールドの削除

フィールド id に基づいて、テーブル内の 1 つ以上のフィールドを削除します。また、そのフィールドのデータまたは計算も完全に削除されます。

フィールドの更新

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

フィールドを作成

そのフィールドのカスタムのアクセス許可を含む、テーブル内のフィールドを作成します。

フィールドを取得

フィールド id に基づいて、個々のフィールドのプロパティを取得します。
すべてのフィール ドタイプに存在するプロパティは、トップ レベルで返されます。 特定のフィールド タイプに固有のプロパティは、'properties' 属性の下に返されます。 各フィールド タイプのプロパティの詳細については、フィールド タイプ ページ を参照してください。

ユーザー トークンの削除

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

ユーザー トークンの複製

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

ユーザー トークンの非アクティブ化

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

リレーションシップの作成

検索フィールドと概要フィールドと同様に、テーブルのリレーションシップを作成します。 リレーションシップは、同じアプリ内のテーブルに対してのみ作成できます。

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

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

リレーションシップの更新

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

レコードの削除

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

レコードの挿入および/または更新

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

レポートの実行

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

レポートを取得

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

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

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

添付ファイルのダウンロード

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

添付ファイルの削除

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

計算式の実行

API 呼び出しにより計算式を実行できます。 カスタム コードでこのメソッドを使用して、レコードに個別のフィールドがない計算式の値を取得します。

DBID の一時トークンの取得

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

パラメーター

名前 キー 必須 説明
App Token
QB-App-Token string

Quickbase アプリ トークン

DBID
dbid True string

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

戻り値

getTempTokenDBIDResponse
getTempTokenDBIDResponse

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

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

パラメーター

名前 キー 必須 説明
Table ID
tableId True string

テーブルの一意識別子。

戻り値

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

識別子。

Name
name string

名前。

Type
type string

タイプ。

Description
description string

説明。

Owner ID
ownerId string

所有者の識別子。

Used Last
usedLast string

最後に使用したとき。

Used Count
usedCount integer

使用された数。

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

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

パラメーター

名前 キー 必須 説明
Skip
skip integer

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

Table ID
tableId True string

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

戻り値

Get Relationships Response
getRelationshipsResponse

アプリ イベントを取得

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

パラメーター

名前 キー 必須 説明
App ID
appId True string

アプリの一意識別子。

戻り値

名前 パス 説明
array of object
Type
type string

タイプ。

Email
owner.email string

所有者のメール アドレス。

ID
owner.id string

所有者の識別子。

Name
owner.name string

所有者名。

User Name
owner.userName string

所有者のユーザー名。

Is Active
isActive boolean

アクティブかどうか。

Table ID
tableId string

テーブルの識別子。

Name
name string

名前。

URL
url string

URL アドレス。

アプリのコピー

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

パラメーター

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

新しくコピーしたアプリの名前

description
description string

新しくコピーしたアプリの説明

assignUserToken
assignUserToken boolean

このリクエストを行うために使用されたユーザー トークンを新しいアプリに追加するかどうか

excludeFiles
excludeFiles boolean

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

keepData
keepData boolean

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

usersAndRoles
usersAndRoles boolean

true の場合、ユーザーは割り当てられたロールとともにコピーされます。 false の場合、ユーザーとロールはコピーされますが、ロールは割り当てられません

App ID
appId True string

アプリの一意識別子。

戻り値

Copy App Response
copyAppResponse

アプリのテーブルを取得

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

パラメーター

名前 キー 必須 説明
App ID
appId True string

アプリの一意識別子

戻り値

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

名前。

Created
created string

作成日。

Updated
updated string

更新時。

Alias
alias string

別名。

Description
description string

説明。

ID
id string

識別子。

Next Record ID
nextRecordId integer

次のレコードの識別子。

Next Field ID
nextFieldId integer

次のフィールドの識別子。

Default Sort Field ID
defaultSortFieldId integer

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

Default Sort Order
defaultSortOrder string

既定の並べ替え順。

Key Field ID
keyFieldId integer

キー フィールドの識別子。

Single Record Name
singleRecordName string

1 つのレコード名。

Plural Record Name
pluralRecordName string

複数のレコード名。

Size Limit
sizeLimit string

サイズの制限。

Space Used
spaceUsed string

使用済みスペース。

Space Remaining
spaceRemaining string

残りのスペース。

アプリの作成

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

パラメーター

名前 キー 必須 説明
assignToken
assignToken boolean

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

name
name True string

変数の名前。

value
value True string

変数の値。

name
name True string

アプリ名。 dbid 値が異なるため、同じ領域に同じ名前の複数のアプリを作成できます。 この作業には十分注意してください。

description
description string

アプリの説明。 このプロパティを省略すると、アプリの説明は空白になります。

戻り値

Create App Response
createAppResponse

アプリの削除

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

パラメーター

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

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

App ID
appId True string

アプリの一意識別子。

戻り値

Delete App Response
deleteAppResponse

アプリの更新

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

パラメーター

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

変数の名前。

value
value True string

変数の値。

name
name string

アプリの名前。

description
description string

アプリの説明。

App ID
appId True string

アプリの一意識別子。

戻り値

Update App Response
updateAppResponse

アプリを取得

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

パラメーター

名前 キー 必須 説明
App ID
appId True string

アプリの一意識別子。

戻り値

Get App Response
getAppResponse

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

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

パラメーター

名前 キー 必須 説明
Table ID
tableId True string

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

Include Field Permissions
includeFieldPerms boolean

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

戻り値

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

識別子。

Label
label string

ラベル。

Field Type
fieldType string

フィールド タイプ。

No Wrap
noWrap boolean

折り返しがないかどうか。

Bold
bold boolean

太字かどうか。

Required
required boolean

必須かどうか。

Appears By Default
appearsByDefault boolean

既定で表示されるかどうか。

Find Enabled
findEnabled boolean

検索が有効かどうか。

Unique
unique boolean

固有であるかどうか。

Does Data Copy
doesDataCopy boolean

データをコピーするかどうか。

Field Help
fieldHelp string

フィールド ヘルプ。

Audited
audited boolean

監査済みかどうか。

Primary Key
properties.primaryKey boolean

主キーかどうか。

Foreign Key
properties.foreignKey boolean

外部キーかどうか。

Num Lines
properties.numLines integer

行数。

Max Length
properties.maxLength integer

最大長。

Append Only
properties.appendOnly boolean

追加専用かどうか。

allowHTML
properties.allowHTML boolean

HTML を許可するかどうか。

Sort As Given
properties.sortAsGiven boolean

指定されたとおりに並べ替えるかどうか。

Carry Choices
properties.carryChoices boolean

選択肢を持つかどうか。

Allow New Choices
properties.allowNewChoices boolean

新しい選択肢を許可するかどうか。

Formula
properties.formula string

計算式。

Default Value
properties.defaultValue string

既定値。

Number Format
properties.numberFormat integer

数値の表示形式。

Decimal Places
properties.decimalPlaces integer

小数点以下の桁数。

Does Average
properties.doesAverage boolean

平均化するかどうか。

Does Total
properties.doesTotal boolean

合計するかどうか。

Blank Is Zero
properties.blankIsZero boolean

空白が 0 かどうか。

Permissions
permissions array of object
Permission Type
permissions.permissionType string

アクセス許可の種類。

Role
permissions.role string

ロール。

Role ID
permissions.roleId integer

ロールの識別子。

Add To Forms
addToForms boolean

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

テーブルの作成

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

パラメーター

名前 キー 必須 説明
App ID
appId True string

アプリの一意識別子

name
name True string

テーブルの名前。

pluralRecordName
pluralRecordName string

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

singleRecordName
singleRecordName string

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

description
description string

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

戻り値

Create Table Response
createTableResponse

テーブルの削除

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

パラメーター

名前 キー 必須 説明
App ID
appId True string

アプリの一意識別子

Table ID
tableId True string

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

戻り値

Delete Table Response
deleteTableResponse

テーブルの更新

特定のテーブルの主要なプロパティを更新します。 リクエスト本文で指定しないテーブルのプロパティは変更されません。

パラメーター

名前 キー 必須 説明
App ID
appId True string

アプリの一意識別子

name
name string

テーブルの名前。

pluralRecordName
pluralRecordName string

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

singleRecordName
singleRecordName string

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

description
description string

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

Table ID
tableId True string

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

戻り値

Update Table Response
updateTableResponse

テーブルを取得

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

パラメーター

名前 キー 必須 説明
App ID
appId True string

アプリの一意識別子

Table ID
tableId True string

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

戻り値

Get Table Response
getTableResponse

データに対するクエリ

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

パラメーター

名前 キー 必須 説明
skip
skip integer

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

compareWithAppLocalTime
compareWithAppLocalTime boolean

アプリケーションの現地時間に関して日時フィールドに対してクエリを実行するかどうか。 クエリは既定で UTC 時間で実行されます。

top
top integer

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

where
where string

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

fieldId
fieldId integer

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

Grouping
grouping string

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

sortBy
sortBy object

既定では、クエリは指定された並べ替えフィールドによって並べ替えられます。指定がない場合は、既定の並べ替えになります。 返されるデータの順序が重要でない場合に並べ替えを回避するには、false に設定します。 並べ替えせずにデータを返すと、パフォーマンスを向上させることができます。

select
select object
送信元
from True string

テーブルの識別子。

戻り値

Run Query Response
runQueryResponse

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

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

パラメーター

名前 キー 必須 説明
Table ID
tableId True string

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

Field ID
fieldId True integer

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

戻り値

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

識別子。

Name
field.name string

名前。

Type
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

カウント。

フィールドの削除

フィールド id に基づいて、テーブル内の 1 つ以上のフィールドを削除します。また、そのフィールドのデータまたは計算も完全に削除されます。

パラメーター

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

テーブルの一意識別子。

fieldIds
fieldIds True array of integer

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

戻り値

Delete Fields Response
deleteFieldsResponse

フィールドの更新

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

パラメーター

名前 キー 必須 説明
Table ID
tableId True string

テーブルの一意識別子。

audited
audited boolean

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

fieldHelp
fieldHelp string

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

bold
bold boolean

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

required
required boolean

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

comments
comments string

管理者によってフィールド プロパティに入力されたコメント。

doesTotal
doesTotal boolean

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

autoSave
autoSave boolean

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

defaultValueLuid
defaultValueLuid integer

既定のユーザ id 値。

maxVersions
maxVersions integer

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

format
format integer

時刻を表示するための形式。

carryChoices
carryChoices boolean

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

maxLength
maxLength integer

このフィールドに Quickbase で入力できる最大文字数。

linkText
linkText string

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

parentFieldId
parentFieldId integer

該当する場合、親複合フィールドの id。

displayTimezone
displayTimezone boolean

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

summaryTargetFieldId
summaryTargetFieldId integer

該当する場合、子から値を集計するために使用されるフィールドの id。 集計関数がフィールド選択 (カウントなど) を必要としない場合、0 を表示します。

allowNewChoices
allowNewChoices boolean

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

defaultToday
defaultToday boolean

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

units
units string

ユニット ラベル。

lookupTargetFieldId
lookupTargetFieldId integer

この検索の親テーブル上でターゲットとなるフィールドの id。

SummaryFunction3
summaryFunction string

概要フィールドの累計型。

sourceFieldId
sourceFieldId integer

ソース フィールドの id。

doesAverage
doesAverage boolean

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

formula
formula string

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

decimalPlaces
decimalPlaces integer

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

displayMonth
displayMonth string

月の表示方法。

seeVersions
seeVersions boolean

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

numLines
numLines integer

このテキスト フィールドの Quickbase に表示される行数。

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
exact boolean

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

defaultDomain
defaultDomain string

既定のメール ドメイン。

defaultValue
defaultValue string

新しいレコードが追加されたときにフィールドに設定される既定値。

abbreviate
abbreviate boolean

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

numberFormat
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
unique boolean

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

role
role string

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

permissionType
permissionType string

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

roleId
roleId integer

指定されたロールの Id

addToForms
addToForms boolean

追加するフィールドをフォームに表示するかどうか。

label
label string

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

findEnabled
findEnabled boolean

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

noWrap
noWrap boolean

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

Field ID
fieldId True integer

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

戻り値

Update Field Response
updateFieldResponse

フィールドを作成

そのフィールドのカスタムのアクセス許可を含む、テーブル内のフィールドを作成します。

パラメーター

名前 キー 必須 説明
Table ID
tableId True string

テーブルの一意識別子。

audited
audited boolean

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

fieldHelp
fieldHelp string

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

bold
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
maxLength integer

このフィールドに Quickbase で入力できる最大文字数。

linkText
linkText string

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

parentFieldId
parentFieldId integer

該当する場合、親複合フィールドの id。

displayTimezone
displayTimezone boolean

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

allowNewChoices
allowNewChoices boolean

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

defaultToday
defaultToday boolean

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

units
units string

ユニット ラベル。

sourceFieldId
sourceFieldId integer

ソース フィールドの id。

doesAverage
doesAverage boolean

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

formula
formula string

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

decimalPlaces
decimalPlaces integer

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

displayMonth
displayMonth string

月の表示方法。

seeVersions
seeVersions boolean

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

numLines
numLines integer

このテキスト フィールドの Quickbase に表示される行数。

defaultKind
defaultKind string

ユーザーの既定のタイプ。

displayEmail
displayEmail string

メールの表示方法。

coverText
coverText string

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

currencySymbol
currencySymbol string

製品内でフィールド値を表示するときに使用される現在の記号。

targetFieldId
targetFieldId integer

ターゲット フィールド の id。

displayUser
displayUser string

製品内でのユーザーの表示方法に関する構成オプション。

blankIsZero
blankIsZero boolean

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

exact
exact boolean

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

defaultDomain
defaultDomain string

既定のメール ドメイン。

defaultValue
defaultValue string

新しいレコードが追加されたときにフィールドに設定される既定値。

abbreviate
abbreviate boolean

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

numberFormat
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
role string

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

permissionType
permissionType string

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

roleId
roleId integer

指定されたロールの Id

addToForms
addToForms boolean

追加するフィールドをフォームに表示するかどうか。

label
label True string

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

findEnabled
findEnabled boolean

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

noWrap
noWrap boolean

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

戻り値

Create Field Response
createFieldResponse

フィールドを取得

フィールド id に基づいて、個々のフィールドのプロパティを取得します。
すべてのフィール ドタイプに存在するプロパティは、トップ レベルで返されます。 特定のフィールド タイプに固有のプロパティは、'properties' 属性の下に返されます。 各フィールド タイプのプロパティの詳細については、フィールド タイプ ページ を参照してください。

パラメーター

名前 キー 必須 説明
Table ID
tableId True string

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

Include Field Permissions
includeFieldPerms boolean

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

Field ID
fieldId True integer

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

戻り値

Get Field Response
getFieldResponse

ユーザー トークンの削除

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

戻り値

Delete User Token Response
deleteUserTokenResponse

ユーザー トークンの複製

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

パラメーター

名前 キー 必須 説明
name
name string

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

description
description string

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

戻り値

Clone User Token Response
cloneUserTokenResponse

ユーザー トークンの非アクティブ化

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

戻り値

名前 パス 説明
id
id integer

id

リレーションシップの作成

検索フィールドと概要フィールドと同様に、テーブルのリレーションシップを作成します。 リレーションシップは、同じアプリ内のテーブルに対してのみ作成できます。

パラメーター

名前 キー 必須 説明
summaryFid
summaryFid double

集計対象のフィールド id。

label
label string

概要フィールドのラベル。

AccumulationType
accumulationType True string

概要フィールドの累計型。

where
where string

返すレコードを決定する Quickbase クエリ言語を使用するフィルター。

lookupFieldIds
lookupFieldIds array of integer

子テーブルの検索フィールドになる、親テーブルのフィールド ID の配列。

parentTableId
parentTableId True string

リレーションシップの親テーブル id。

label
label string

外部キー フィールドのラベル。

Table ID
tableId True string

テーブルの一意識別子 (DBID)。 これが子テーブルです。

戻り値

Create Relationship Response
createRelationshipResponse

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

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

パラメーター

名前 キー 必須 説明
Table ID
tableId True string

テーブルの一意識別子 (DBID)。 これが子テーブルです。

Relationship ID
relationshipId True double

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

戻り値

Delete Relationship Response
deleteRelationshipResponse

リレーションシップの更新

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

パラメーター

名前 キー 必須 説明
summaryFid
summaryFid double

集計対象のフィールド id。

label
label string

概要フィールドのラベル。

AccumulationType
accumulationType True string

概要フィールドの累計型。

where
where string

返すレコードを決定する Quickbase クエリ言語を使用するフィルター。

lookupFieldIds
lookupFieldIds array of integer

子テーブルで検索フィールドになる、親テーブルでのフィールド ID の配列。

テーブル ID
tableId True string

テーブルの一意識別子 (DBID)。 これが子テーブルです。

Relationship ID
relationshipId True double

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

戻り値

Update Relationship Response
updateRelationshipResponse

レコードの削除

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

パラメーター

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

テーブルの一意識別子。

where
where True string

レコードを削除するためのフィルター。 すべてのレコードを削除するには、すべてのレコードを含むフィルターを指定します。例えば {3.GT.0} の場合、3 は Record ID フィールドの ID です。

戻り値

Delete Records Response
deleteRecordsResponse

レコードの挿入および/または更新

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

パラメーター

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

テーブルの識別子。

データ
data object
mergeFieldId
mergeFieldId integer

マージ フィールド id。

fieldsToReturn
fieldsToReturn array of integer

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

戻り値

追加、更新、または変更されていないレコードの詳細を含む正常な応答。 以下の例では、テーブルには以前、1 から 10 までの ID を持つ 10 個のレコードがありました。 ユーザーは、レコード 1 の値を更新し、2 つの新しいレコードを追加する upsert を投稿し、すべて成功します。

Upsert Response
upsertResponse

レポートの実行

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

パラメーター

名前 キー 必須 説明
Table ID
tableId True string

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

Skip
skip integer

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

Top
top integer

返されるレコードの最大数。 既定の Quickbase 改ページを上書きして、結果を増減できます。 ここで要求された値が動的最大値を超えた場合、結果のサブセットが返され、残りは後続の API 呼び出しで収集できます。

object
Report ID
reportId True string

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

戻り値

Run Report Response
runReportResponse

レポートを取得

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

パラメーター

名前 キー 必須 説明
Table ID
tableId True string

テーブルの一意識別子。

Report ID
reportId True string

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

戻り値

Get Report Response
getReportResponse

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

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

パラメーター

名前 キー 必須 説明
Table ID
tableId True string

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

Skip
skip integer

一覧からスキップするフィールドの数。

Top
top integer

返すフィールドの最大数。

戻り値

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

識別子。

Name
field.name string

名前。

Type
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

カウント。

添付ファイルのダウンロード

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

パラメーター

名前 キー 必須 説明
Table ID
tableId True string

テーブルの一意識別子。

Record ID
recordId True integer

レコードの一意識別子。

Field ID
fieldId True integer

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

Version Number
versionNumber True integer

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

戻り値

response
string

添付ファイルの削除

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

パラメーター

名前 キー 必須 説明
Table ID
tableId True string

テーブルの一意識別子。

Record ID
recordId True integer

レコードの一意識別子。

Field ID
fieldId True integer

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

Version Number
versionNumber True integer

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

戻り値

Delete File Response
deleteFileResponse

計算式の実行

API 呼び出しにより計算式を実行できます。 カスタム コードでこのメソッドを使用して、レコードに個別のフィールドがない計算式の値を取得します。

パラメーター

名前 キー 必須 説明
formula
formula True string

実行する計算式。 これは有効な Quickbase 式である必要があります。

rid
rid integer

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

from
from True string

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

戻り値

Run Formula Response
runFormulaResponse

定義

createAppResponse

名前 パス 説明
name
name string

アプリ名。 dbid 値が異なるため、同じ領域に同じ名前の複数のアプリを作成できます。 この作業には十分注意してください。

description
description string

アプリの説明。 このプロパティを省略すると、アプリの説明は空白になります。

created
created string

ISO 8601 時間の表示形式 YYYY-MM-DDThh:mm:ss.sssZ (UTC タイム ゾーン) でのアプリの作成日時。

updated
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

アプリにインターネット上のすべてのユーザーへのアクセスが含まれているかどうかを示します。 インターネット上のすべてのユーザー (EOTI) とのアプリの共有 を参照してください。

variables
variables array of Variable1

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

dataClassification
dataClassification string

アプリケーションに割り当てられたデータ分類ラベル。 データ分類がオンになっていない場合、これは返されません。 データ分類がオンになっていても、アプリケーションにラベルが付いていない場合は、“None" を返します。 データ分類ラベルは、Realm Administrator for Platform+ プランで管理者コンソールに追加できます。

Variable1

名前 パス 説明
name
name string

変数名。

value
value string

変数の値。

getAppResponse

名前 パス 説明
name
name string

アプリ名。 dbid 値が異なるため、同じ領域に同じ名前の複数のアプリを作成できます。 この作業には十分注意してください。

description
description string

アプリの説明。 このプロパティを省略すると、アプリの説明は空白になります。

created
created string

ISO 8601 時間の表示形式 YYYY-MM-DDThh:mm:ss.sssZ (UTC タイム ゾーン) でのアプリの作成日時。

updated
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

アプリにインターネット上のすべてのユーザーへのアクセスが含まれているかどうかを示します。 インターネット上のすべてのユーザー (EOTI) とのアプリの共有 を参照してください。

variables
variables array of Variable1

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

dataClassification
dataClassification string

アプリケーションに割り当てられたデータ分類ラベル。 データ分類がオンになっていない場合、これは返されません。 データ分類がオンになっていても、アプリケーションにラベルが付いていない場合は、“None" を返します。 データ分類ラベルは、Realm Administrator for Platform+ プランで管理者コンソールに追加できます。

updateAppResponse

名前 パス 説明
name
name string

アプリ名。 dbid 値が異なるため、同じ領域に同じ名前の複数のアプリを作成できます。 この作業には十分注意してください。

description
description string

アプリの説明。 このプロパティを省略すると、アプリの説明は空白になります。

created
created string

ISO 8601 時間の表示形式 YYYY-MM-DDThh:mm:ss.sssZ (UTC タイム ゾーン) でのアプリの作成日時。

updated
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

アプリにインターネット上のすべてのユーザーへのアクセスが含まれているかどうかを示します。 インターネット上のすべてのユーザー (EOTI) とのアプリの共有 を参照してください。

variables
variables array of Variable1

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

dataClassification
dataClassification string

アプリケーションに割り当てられたデータ分類ラベル。 データ分類がオンになっていない場合、これは返されません。 データ分類がオンになっていても、アプリケーションにラベルが付いていない場合は、“None" を返します。 データ分類ラベルは、Realm Administrator for Platform+ プランで管理者コンソールに追加できます。

deleteAppResponse

名前 パス 説明
deletedAppId
deletedAppId string

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

copyAppResponse

名前 パス 説明
name
name string

アプリ名。 dbid 値が異なるため、同じ領域に同じ名前の複数のアプリを作成できます。 この作業には十分注意してください。

description
description string

アプリの説明

created
created string

ISO 8601 時間の表示形式 YYYY-MM-DDThh:mm:ss.sssZ (UTC タイム ゾーン) でのアプリの作成日時。

updated
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

アプリにインターネット上のすべてのユーザーへのアクセスが含まれているかどうかを示します。 インターネット上のすべてのユーザー (EOTI) とのアプリの共有 を参照してください。

variables
variables array of Variable1

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

ancestorId
ancestorId string

このアプリのコピー元のアプリの id

dataClassification
dataClassification string

アプリケーションに割り当てられたデータ分類ラベル。 データ分類がオンになっていない場合、これは返されません。 データ分類がオンになっていても、アプリケーションにラベルが付いていない場合は、“None" を返します。 データ分類ラベルは、Realm Administrator for Platform+ プランで管理者コンソールに追加できます。

createTableResponse

名前 パス 説明
name
name string

テーブルの名前。

id
id string

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

alias
alias string

テーブルに対して自動的に作成されたテーブルの別名。

description
description string

アプリケーション管理者によって構成されたテーブルの説明。

created
created string

テーブルが作成された日時 (ISO 8601 時間の表示形式 YYYY-MM-DDThh:mm:ss.sssZ (UTC タイム ゾーン))。

updated
updated string

テーブル スキーマまたはデータが最終更新された日時 (ISO 8601 時間の表示形式 YYYY-MM-DDThh:mm:ss.sssZ (UTC タイム ゾーン))。

nextRecordId
nextRecordId integer

API 呼び出しが実行されたときに決定された、次のレコードが作成されるときに使用される増分 Record ID。

nextFieldId
nextFieldId integer

API 呼び出しが実行されたときに決定された、次のフィールドが作成されるときに使用される増分 Field ID。

defaultSortFieldId
defaultSortFieldId integer

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

DefaultSortOrder
defaultSortOrder DefaultSortOrder

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

keyFieldId
keyFieldId integer

このテーブルのキーとして構成されているフィールドの id で、通常は Quickbase Record ID です。

singleRecordName
singleRecordName string

ビルダーが構成したテーブルの単数名詞。

pluralRecordName
pluralRecordName string

ビルダーが構成したテーブルの複数名詞。

sizeLimit
sizeLimit string

テーブルのサイズ制限。

spaceUsed
spaceUsed string

テーブルによって現在使用されているスペースの量。

spaceRemaining
spaceRemaining string

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

DefaultSortOrder

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

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

DefaultSortOrder
string

getTableResponse

名前 パス 説明
name
name string

テーブルの名前。

id
id string

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

alias
alias string

テーブルに対して自動的に作成されたテーブルの別名。

description
description string

アプリケーション管理者によって構成されたテーブルの説明。

created
created string

テーブルが作成された日時 (ISO 8601 時間の表示形式 YYYY-MM-DDThh:mm:ss.sssZ (UTC タイム ゾーン))。

updated
updated string

テーブル スキーマまたはデータが最終更新された日時 (ISO 8601 時間の表示形式 YYYY-MM-DDThh:mm:ss.sssZ (UTC タイム ゾーン))。

nextRecordId
nextRecordId integer

API 呼び出しが実行されたときに決定された、次のレコードが作成されるときに使用される増分 Record ID。

nextFieldId
nextFieldId integer

API 呼び出しが実行されたときに決定された、次のフィールドが作成されるときに使用される増分 Field ID。

defaultSortFieldId
defaultSortFieldId integer

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

DefaultSortOrder
defaultSortOrder DefaultSortOrder

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

keyFieldId
keyFieldId integer

このテーブルのキーとして構成されているフィールドの id で、通常は Quickbase Record ID です。

singleRecordName
singleRecordName string

ビルダーが構成したテーブルの単数名詞。

pluralRecordName
pluralRecordName string

ビルダーが構成したテーブルの複数名詞。

sizeLimit
sizeLimit string

テーブルのサイズ制限。

spaceUsed
spaceUsed string

テーブルによって現在使用されているスペースの量。

spaceRemaining
spaceRemaining string

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

updateTableResponse

名前 パス 説明
name
name string

テーブルの名前。

id
id string

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

alias
alias string

テーブルに対して自動的に作成されたテーブルの別名。

description
description string

アプリケーション管理者によって構成されたテーブルの説明。

created
created string

テーブルが作成された日時 (ISO 8601 時間の表示形式 YYYY-MM-DDThh:mm:ss.sssZ (UTC タイム ゾーン))。

updated
updated string

テーブル スキーマまたはデータが最終更新された日時 (ISO 8601 時間の表示形式 YYYY-MM-DDThh:mm:ss.sssZ (UTC タイム ゾーン))。

nextRecordId
nextRecordId integer

API 呼び出しが実行されたときに決定された、次のレコードが作成されるときに使用される増分 Record ID。

nextFieldId
nextFieldId integer

API 呼び出しが実行されたときに決定された、次のフィールドが作成されるときに使用される増分 Field ID。

defaultSortFieldId
defaultSortFieldId integer

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

DefaultSortOrder
defaultSortOrder DefaultSortOrder

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

keyFieldId
keyFieldId integer

このテーブルのキーとして構成されているフィールドの id で、通常は Quickbase Record ID です。

singleRecordName
singleRecordName string

ビルダーが構成したテーブルの単数名詞。

pluralRecordName
pluralRecordName string

ビルダーが構成したテーブルの複数名詞。

sizeLimit
sizeLimit string

テーブルのサイズ制限。

spaceUsed
spaceUsed string

テーブルによって現在使用されているスペースの量。

spaceRemaining
spaceRemaining string

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

deleteTableResponse

名前 パス 説明
deletedTableId
deletedTableId string

削除されたテーブル id。

getRelationshipsResponse

名前 パス 説明
relationships
relationships array of Relationship

テーブル内のリレーションシップ。

Metadata
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

Field id。

label
label string

Field label。

type
type string

Field type。

LookupField

名前 パス 説明
id
id integer

Field id。

label
label string

Field label。

type
type string

Field type。

SummaryField

名前 パス 説明
id
id integer

Field id。

label
label string

Field label。

type
type string

Field type。

Metadata

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

名前 パス 説明
skip
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

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

名前 パス 説明
tableId
tableId string

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

filter
filter string

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

formulaFields
formulaFields array of FormulaField

計算式フィールド。

FormulaField

名前 パス 説明
id
id integer

式フィールドの識別子。

label
label string

式フィールド ラベル。

FieldType
fieldType FieldType

結果として得られる式の値タイプ。

formula
formula string

式テキスト。

decimalPrecision
decimalPrecision integer

数式の場合、数値の精度。

FieldType

結果として得られる式の値タイプ。

結果として得られる式の値タイプ。

FieldType
string

getReportResponse

名前 パス 説明
id
id string

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

name
name string

レポートの構成名。

type
type string

Quickbase のレポートのタイプ (グラフなど)。

description
description string

構成されたレポートの説明。

ownerId
ownerId integer

オプションで、個人用レポートにのみ表示されます。 レポート 所有者のユーザー ID。

Query
query Query

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

properties
properties object

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

usedLast
usedLast string

レポートが最後に使用された時刻。

usedCount
usedCount integer

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

runReportResponse

名前 パス 説明
fields
fields array of Field

レポートに表示される各フィールドの限定されたメタデータを含むオブジェクトの配列。 これは、フィールドの種類と ID に依存するロジックの構築に役立ちます。

data
data array of object

レポートの種類に応じて、レコード データまたは集計値のいずれかを表すオブジェクトの配列。

items
data object
Metadata1
metadata Metadata1

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

Field

名前 パス 説明
id
id integer

Field id。

label
label string

Field label。

type
type string

Field type。

labelOverride
labelOverride string

レポートにあるフィールドの列見出しラベルの上書き。

Metadata1

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

名前 パス 説明
skip
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
maxLength integer

このフィールドに Quickbase で入力できる最大文字数。

linkText
linkText string

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

parentFieldId
parentFieldId integer

該当する場合、親複合フィールドの id。

displayTimezone
displayTimezone boolean

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

summaryTargetFieldId
summaryTargetFieldId integer

該当する場合、子から値を集計するために使用されるフィールドの id。 集計関数がフィールド選択 (カウントなど) を必要としない場合、0 を表示します。

allowNewChoices
allowNewChoices boolean

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

masterChoiceFieldId
masterChoiceFieldId integer

リレーションシップで参照となるフィールドの id。

defaultToday
defaultToday boolean

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

units
units string

ユニット ラベル。

lookupTargetFieldId
lookupTargetFieldId integer

この検索のマスター テーブル上でターゲットとなるフィールドの id。

SummaryFunction
summaryFunction SummaryFunction

サマリー累計関数型。

sourceFieldId
sourceFieldId integer

ソース フィールドの id。

masterTableTag
masterTableTag string

このフィールドが含まれるリレーションシップのマスター テーブルのテーブルの別名。

doesAverage
doesAverage boolean

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

formula
formula string

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

decimalPlaces
decimalPlaces integer

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

seeVersions
seeVersions boolean

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

displayMonth
displayMonth string

月の表示方法。

numLines
numLines integer

このテキスト フィールドの Quickbase に表示される行数。

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
exact boolean

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

startField
startField integer

開始フィールド id。

defaultDomain
defaultDomain string

既定のメール ドメイン。

defaultValue
defaultValue string

新しいレコードが追加されたときにフィールドに設定される既定値。

choicesLuid
choicesLuid array of object

ユーザー選択の一覧。

items
choicesLuid object
abbreviate
abbreviate boolean

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

xmlTag
xmlTag string

フィールドの xml タグ。

targetTableName
targetTableName string

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

numberFormat
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

複合フィールドを構成するフィールドの配列 (アドレスなど)。

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
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

Permission

名前 パス 説明
role
role string

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

permissionType
permissionType string

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

roleId
roleId integer

指定されたロールの Id

createFieldResponse

名前 パス 説明
id
id integer

このテーブルに固有のフィールドの id。

fieldType
fieldType string

ここ で説明されているフィールドの種類。

mode
mode string

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

label
label string

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

noWrap
noWrap boolean

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

bold
bold boolean

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

required
required boolean

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

appearsByDefault
appearsByDefault boolean

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

findEnabled
findEnabled boolean

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

unique
unique boolean

フィールドが固有とマークされているかどうかを示します。

doesDataCopy
doesDataCopy boolean

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

fieldHelp
fieldHelp string

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

audited
audited boolean

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

Properties1
properties Properties1

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

permissions
permissions array of Permission

異なるロールのフィールド アクセス許可。

deleteFieldsResponse

名前 パス 説明
deletedFieldIds
deletedFieldIds array of integer

削除したフィールド id の一覧。

errors
errors array of string

検出されたエラーの一覧。

getFieldResponse

名前 パス 説明
id
id integer

このテーブルに固有のフィールドの id。

fieldType
fieldType string

ここ で説明されているフィールドの種類。

mode
mode string

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

label
label string

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

noWrap
noWrap boolean

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

bold
bold boolean

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

required
required boolean

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

appearsByDefault
appearsByDefault boolean

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

findEnabled
findEnabled boolean

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

unique
unique boolean

フィールドが固有とマークされているかどうかを示します。

doesDataCopy
doesDataCopy boolean

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

fieldHelp
fieldHelp string

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

audited
audited boolean

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

Properties1
properties Properties1

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

permissions
permissions array of Permission

異なるロールのフィールド アクセス許可。

updateFieldResponse

名前 パス 説明
id
id integer

このテーブルに固有のフィールドの id。

fieldType
fieldType string

ここ で説明されているフィールドの種類。

mode
mode string

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

label
label string

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

noWrap
noWrap boolean

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

bold
bold boolean

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

required
required boolean

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

appearsByDefault
appearsByDefault boolean

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

findEnabled
findEnabled boolean

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

unique
unique boolean

フィールドが固有とマークされているかどうかを示します。

doesDataCopy
doesDataCopy boolean

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

fieldHelp
fieldHelp string

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

audited
audited boolean

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

Properties1
properties Properties1

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

permissions
permissions array of Permission

異なるロールのフィールド アクセス許可。

runFormulaResponse

名前 パス 説明
result
result string

式の実行結果。

upsertResponse

追加、更新、または変更されていないレコードの詳細を含む正常な応答。 以下の例では、テーブルには以前、1 から 10 までの ID を持つ 10 個のレコードがありました。 ユーザーは、レコード 1 の値を更新し、2 つの新しいレコードを追加する upsert を投稿し、すべて成功します。

名前 パス 説明
Metadata2
metadata Metadata2

作成済みレコード、更新済みレコード、参照されたが未変更のレコード、および処理中にエラーが発生したレコードに関する情報。

data
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
data array of object

レポートの種類に応じて、レコード データまたは集計値のいずれかを表すオブジェクトの配列。

items
data object
Metadata1
metadata Metadata1

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

Fields2

名前 パス 説明
id
id integer

Field id。

label
label string

Field label。

type
type string

Field type。

getTempTokenDBIDResponse

名前 パス 説明
temporaryAuthorization
temporaryAuthorization string

一時的な認可トークン。

cloneUserTokenResponse

名前 パス 説明
active
active boolean

ユーザー トークンがアクティブかどうか。

apps
apps array of App

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

lastUsed
lastUsed string

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

description
description string

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

id
id integer

ユーザー トークン id。

name
name string

ユーザー トークンの名前。

token
token string

ユーザー トークンの値。

App

名前 パス 説明
id
id string

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

name
name string

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

deleteUserTokenResponse

名前 パス 説明
id
id integer

ユーザー トークン id。

deleteFileResponse

名前 パス 説明
versionNumber
versionNumber integer

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

fileName
fileName string

削除されたバージョンに関連付けられているファイルの名前。

uploaded
uploaded string

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

Creator
creator Creator

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

Creator

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

名前 パス 説明
name
name string

ユーザーの氏名。

id
id string

ユーザー Id。

email
email string

ユーザー メール。

userName
userName string

ユーザー プロパティで更新されたユーザー名。 オプションで、ユーザー メールと同じでない場合に表示されます。

string

これは基本的なデータ型 '文字列' です。