このページでは、CData Cloud でのKintone への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Kintone への接続

接続の確立 は、CData Cloud にデータベースを作成するためのKintone への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してKintone からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

Database タブで対応するアイコンを選択して、Kintone に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Kintone への接続

認証値に加えて、下記のパラメータを使いKintone に接続しデータを取得します。

• URL：アカウントのURL。
• GuestSpaceId：オプション。ゲストスペースを使用するときに設定。

Kintone REST API

Kintone REST API に接続する場合は、Schema を"Kintone" に設定します。

Kintone REST API は、以下の認証スキームをサポートしています。

• パスワード認証
• API トークン
• OAuth 認証

Kintone USER API

Kintone USER API に接続する場合は、Schema を"CybozuUser" に設定します。

Kintone USER API は、以下の認証スキームをサポートしています。

• パスワード認証

Kintone への認証

Kintone は、以下の認証メソッドをサポートしています。

パスワード認証

Kintone への認証には、以下を設定する必要があります。

• User：アカウントのユーザー名。
• Password：アカウントのパスワード。
• AuthScheme：AuthScheme をPassword に設定。

API トークン

Kintone への認証には、以下を設定する必要があります。

• APIToken：API トークン。

  API トークンを生成するには、特定のアプリにアクセスして歯車をクリックしてください。［設定］->［API トークン］に移動します。［生成する］ボタンをクリックすると、API トークンが生成されます。 APIToken をカンマ区切りで複数指定することもできます。

• AppId：アプリID。

  AppId はkintone UI ダッシュボードの［アプリ］内に並んだ特定のアプリの番号です。 AppId をカンマ区切りで複数指定することもできます。

• AuthScheme：AuthScheme をAPIToken に設定。

追加のセキュリティ

これまでに説明した認証スキームに加えて、Kintone はBasic 認証ヘッダーおよびSSL 証明書の形で追加のセキュリティを提供します。

クライアントSSL の使用

認証情報に加えて、リクエストの受け入れにSSL 証明書が必須となるようKintone を設定することができます。そのためには、次を設定してください。

• SSLClientCert：SSL 証明書の証明書を含むファイル。または、クライアント証明書のための証明書ストア名。
• SSLClientCertType：証明書の種類。
• SSLClientCertSubject：（オプション）証明書ストアで証明書を検索する際に、ストア内でこのプロパティの値を含むサブジェクトを検索します。
• SSLClientCertPassword：証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。

Basic

Basic 認証を使用しているkintone 環境では、追加のBasic 資格情報を渡す必要があります。そのためには、次を設定してください。

• BasicAuthUser：Basic ログイン名。
• BasicAuthPassword：Basic パスワード。

OAuth 認証

ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。この認証を有効にするには、すべてのOAuth フローでAuthScheme をOAuth に設定し、カスタムOAuth アプリケーションを作成する必要があります。

Note： OAuth 認証はカーソルAPI をサポートしていません。OAuth は1万行以上の取得には推奨されません。

以下のサブセクションでは、3つの一般的な認証フローでのKintone への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成 を参照してください。 Kintone で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

OAuth アクセストークンの自動リフレッシュ：

Cloud がOAuth アクセストークンを自動的にリフレッシュするようにするには：

1. はじめてデータに接続する前に、次の接続パラメータを設定します。
   • InitiateOAuth：REFRESH。
   • OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
   • OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。
   • OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークン。
   • OAuthSettingsLocation：Cloud がOAuth 値を保存する場所のパス。これは接続間で維持されます。
   • UseCursor：FALSE。
2. その後のデータ接続では、以下を設定します。
   • InitiateOAuth
   • OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ：

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

1. ExpiresIn 期間（GetOAuthAccessToken が返す）が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
2. 次の接続プロパティを設定します。
   • OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
   • OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。

3. RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
4. 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

カスタムOAuth アプリケーションの作成

ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth 認証が使用できます。Kintone はOAuth 認証標準を使用しています。これには認証ユーザーがブラウザ経由でKintone と通信する必要があります。OAuth による認証では、OAuth クライアントクレデンシャル、クライアントId、およびクライアントシークレットを使用する必要があります。

カスタムOAuth アプリケーションを登録してOAuth クライアントクレデンシャル、クライアントID、およびクライアントシークレットを取得するには：

1. cybozu.com 共通管理を開きます。
2. システム管理の下にあるOAuth をクリックします。
3. 高度な連携を設定するセクションで、OAuth クライアントの追加をクリックします。
4. OAuth クライアントの情報を入力します。
5. アプリケーションのリダイレクトエンドポイントの値を入力します。
   • デスクトップアプリケーションを作成する場合は、コールバックURL を http://localhost:33333 か任意の別のポート番号に設定してください。
   • Web アプリケーションを作成する場合は、コールバックURL をユーザーがアプリケーションを認可した後に表示したいWeb アプリケーションのページに設定してください。

6. すべての必須項目を入力したら、保存をクリックします。

追加したOAuth クライアントの鉛筆の形をした編集アイコンをクリックします。

アプリケーションの設定時に指定した情報とともに、クライアントID とクライアントシークレットが表示されます。 あとで使用するためにクライアントID およびクライアントシークレットを記録します。

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にCloud が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

Kintone REST API の使用

Kintone データモデルで利用可能なエンティティについては、Kintone データモデル を参照してください。

Kintone USER API の使用

CybozuUSER データモデルで利用可能なエンティティについては、CybozuUser データモデル を参照してください。

Cloud は、Kintone REST API をリレーショナルテーブル、ビュー、およびストアドプロシージャとしてモデル化します。

テーブル

Cloud を使用すると、アカウント内のすべてのテーブルを操作できます。テーブルスキーマは静的または動的になります。Comments テーブルには、固定カラムを持つ静的スキーマがあります。他のテーブルは動的で、メタデータの変更を反映します。接続すると、Cloud はKintone のテーブルメタデータを取得してテーブルスキーマを生成します。

静的スキーマは、容易に拡張できるスキーマファイルで定義されます。例えばデータ型を変更するなどComments 静的テーブルの動作をカスタマイズするには、スキーマファイルを編集します。スキーマファイルは、Cloud インストールフォルダのdb サブフォルダにあります。

サブテーブル

いくつかのKintone アプリでは、ユーザーは多くのレコードを含むカスタムフィールドを追加できます。Cloud はこれらのフィールドを、変更を反映する動的なサブテーブルとしてモデル化します。

ストアドプロシージャ

ストアドプロシージャはKintone のファンクションライクなインターフェースです。これらを使用して、Kintone 内の情報を検索、更新、および変更できます。 例えば、ストアドプロシージャを使用してアプリの操作を実行したりファイルで作業したりします。

ビュー

Cloud は静的なApps ビューのアプリをモデル化します。

Cloud はKintone のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Kintone テーブル

Name	Description
ActionSettings	kintone アプリ間でのレコード作成または更新を自動化するアクションルールへの完全なアクセスを提供し、管理者がクロスアプリワークフローの動作を監査または調整できるようにします。
AppPermissions	ユーザーやグループがkintoneアプリを閲覧、編集、または管理できるかどうかを制御するアプリレベルのアクセス権を管理し、セキュリティレビューとロールの維持をサポートします。
Comments	アプリのレコードに投稿されたユーザーコメントを取得し、チームがコラボレーション活動を分析したり、会話履歴を外部レポートツールにエクスポートしたりできるようにします。
FieldPermissions	個々のフィールドに対するきめ細かいアクセスルールを管理し、管理者がフィールドレベルでデータの表示制限や編集制限を適用できるようにします。
FormFields	アプリのフィールドを作成、更新、削除、およびクエリでき、アプリのデータモデルをプログラムで管理できるようにします。
FormLayout	アプリのフォームレイアウトの構造を公開し、セクション、フィールド、および要素がエンドユーザーにどのように配置されているかを確認または更新できるようにします。
GeneralNotifications	アプリのグローバル通知設定を制御し、更新、メンション、またはレコードのアクティビティについてユーザーにどのようにアラートするかを調整できるようにします。
GeneralSettings	アプリの名前、アイコン、操作動作などの高レベル設定へのアクセスを提供し、バージョン管理と設定監査をサポートします。
GraphSettings	アプリ内で定義されたグラフと分析を管理し、管理者がユーザー向けにデータがどのように可視化されるかを確認または更新できるようにします。
PerRecordNotifications	個々のレコードに紐付いた通知ルールを維持し、期限、条件、またはワークフローの変更に基づいてアラートを自動化するのに役立ちます。
ProcessManagement	レコードがステータス間をどのように移動するかを制御するワークフロールールを管理し、管理者がプロセスのステップ、遷移、および制限を管理できるようにします。
RecordPermissions	レコードを閲覧、変更、削除、または再割り当てできるユーザーを決定するレコードレベルのアクセスポリシーを定義し、コンプライアンスとセキュリティレビューをサポートします。
ReminderNotifications	時間や条件に基づいてアラートをトリガーするリマインダールールを制御し、チームが締め切りやフォローアップをより確実に追跡できるようにします。
SampleApp	サンプルアプリ：顧客管理（営業支援パック）
SampleApp_Table	サンプルアプリ：顧客管理（営業支援パック）明細テーブル
Space	チームコラボレーション、コンテンツ共有、ディスカッションスレッドに使用されるワークスペース領域であるkintoneスペースのプログラムによる管理を可能にします。
SpaceMembers	スペースのメンバーシップリストを管理し、どのユーザーがワークスペースとそのディスカッションにアクセスできるかを確認または更新できるようにします。
Views	フィルタリング、ソート、またはカスタム形式のレコードリストを定義するアプリの一覧を制御し、ユーザー向けのデータ表示の管理をサポートします。

kintone アプリ間でのレコード作成または更新を自動化するアクションルールへの完全なアクセスを提供し、管理者がクロスアプリワークフローの動作を監査または調整できるようにします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ActionSettings WHERE AppId = 6
SELECT * FROM ActionSettings WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ActionSettings WHERE AppId = 6 AND IsPreview = false

Update

ActionSettings を更新するには、Actions を集計として指定します。ActionSettings を更新するには、AppId カラムが必須です。

UPDATE ActionSettings SET Actions = '{"Action_Z":{"name":"Action_A","index":"0"}}' WHERE AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId	Integer	False		アクション設定を取得または更新する対象のkintone アプリのアプリID。
Id [KEY]	String	True		アクションの一意の識別子。特定の自動化ルールを参照または更新するために使用されます。
Index	String	False		アプリのアクションリスト内でのアクションの位置（0から始まる）。アクションが表示される順序を反映します。
Name	String	False		アクションに割り当てられた名前。通常、アプリのワークフロー内での目的を説明するために使用されます。
DestApp	String	False		アクション実行時にレコードがコピーされるコピー先アプリのアプリID。
DestCode	String	False		コピー先のアプリのアプリコード。コピー先のアプリの設定でアプリコードが設定されていない場合は、空の文字列が返されます。
Mappings	String	False		アクションのフィールドの関連付け設定を定義するオブジェクトの配列。関連付けが設定されていない場合は、空の配列が返されます。
Entities	String	False		アクションの使用を許可されているユーザー、グループ、または組織を一覧表示するオブジェクトの配列。非アクティブまたは削除されたエンティティは含まれません。
Revision	String	False		アプリ設定のリビジョン番号。更新時に設定のバージョンを追跡できます。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Lang	String	アクション設定を特定の言語で取得するためのロケールコード。
IsPreview	Boolean	アクション設定を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。
Actions	String	更新実行時に変更されたアクション設定を提供するためにのみ使用される値。

ユーザーやグループがkintoneアプリを閲覧、編集、または管理できるかどうかを制御するアプリレベルのアクセス権を管理し、セキュリティレビューとロールの維持をサポートします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM AppPermissions WHERE AppId = 6
SELECT * FROM AppPermissions WHERE AppId = 6 AND IsPreview = false

Update

AppPermissions を更新するには、Rights を集計として指定します。AppPermissions を更新するには、AppId カラムとIsPreview カラムが必須です。

UPDATE AppPermissions SET Rights = '[{"entity":{"type":"CREATOR"},"appEditable":true,"recordViewable":true,"recordAddable":true,"recordEditable":true,"recordDeletable":true,"recordImportable":true,"recordExportable":true}]' WHERE AppId = 6 AND IsPreview = true

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		アクセス権設定を取得または更新する対象のkintoneアプリのアプリID。
EntityType [KEY]	String	False		アクセス権が適用されるエンティティの種類（ユーザー、グループ、組織など）。
EntityCode	String	False		アクセス権を受け取るエンティティを識別するコード。ユーザー、グループ、または組織を照合するために使用されます。
IncludeSubs	Boolean	False		組織に付与されたアクセス権を下位組織にも適用するかどうかを示します。
AppEditable	Boolean	False		エンティティがアプリの設定にアクセスして変更することでアプリを管理できるかどうかを指定します。
RecordViewable	Boolean	False		エンティティがアプリ内のレコードを閲覧できるかどうかを指定します。
RecordAddable	Boolean	False		エンティティがアプリに新しいレコードを追加できるかどうかを指定します。
RecordEditable	Boolean	False		エンティティがアプリ内の既存のレコードを編集できるかどうかを指定します。
RecordDeletable	Boolean	False		エンティティがアプリからレコードを削除できるかどうかを指定します。
RecordImportable	Boolean	False		エンティティがファイルベースの操作を使用してアプリにレコードを読み込みできるかどうかを指定します。
RecordExportable	Boolean	False		エンティティが外部利用やバックアップのためにアプリからレコードを書き出しできるかどうかを指定します。
Revision	String	True		アプリ設定のリビジョン番号。アクセス権の変更履歴を追跡するのに役立ちます。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
IsPreview	Boolean	アクセス権設定を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。
Rights	String	更新実行時に変更されたアクセス権設定を提供するためにのみ使用される値。

アプリのレコードに投稿されたユーザーコメントを取得し、チームがコラボレーション活動を分析したり、会話履歴を外部レポートツールにエクスポートしたりできるようにします。

Select

WHERE 句ではRecordId およびAppId カラムが必須です。Cloud はKintone API を使用してこれらのカラムによる結果をフィルタリングします。また、Kintone API はId のフィルタもサポートしています。 デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Comments WHERE RecordId = 1 AND AppId = 5 AND Id = 1

Insert

INSERT ステートメントでは、AppId およびRecordId カラムが必須です。

INSERT INTO Comments (AppId, RecordId, Text, MentionsAggregate) VALUES (5, 1, 'To do', '[{"code": "Administrator","type": "USER"}]')

Delete

Comments を削除するには、RecordId、AppId、およびId を指定してDELETE ステートメントを発行します。

DELETE FROM Comments WHERE RecordId = 1 AND AppId = 5 AND Id = 1

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		コメントの識別子。アプリ内でコメントを一意に参照し、関連するアクションやメタデータにリンクするために使用されます。
AppId [KEY]	Integer	False		コメントが投稿されたレコードを含むアプリのアプリID。ディスカッションを特定のアプリケーションに関連付けるのに役立ちます。
RecordId [KEY]	Integer	False		コメントが属するレコードのレコードID。個々のデータエントリに紐付いた会話を追跡できます。
Text	Longvarchar	False		コメントの全文。書式設定や複数行入力を保持するために使用される改行コードを含みます。
CreatorCode	String	True		コメントを作成したユーザーのログイン名。監査やユーザーアクティビティの追跡をサポートします。
CreatorName	String	True		コメントを作成したユーザーの表示名。インターフェースやレポートで読みやすい作成者情報を表示するために使用されます。
CreatedAt	Datetime	True		コメントが作成された日時。ディスカッションやアクティビティ履歴の時系列参照を提供します。
MentionsAggregate	String	False		コメント内でメンションされたユーザーの詳細を含む配列。通知や対象を絞ったコミュニケーションの追跡を可能にします。

個々のフィールドに対するきめ細かいアクセスルールを管理し、管理者がフィールドレベルでデータの表示制限や編集制限を適用できるようにします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM FieldPermissions WHERE AppId = 6
SELECT * FROM FieldPermissions WHERE AppId = 6 AND IsPreview = false

Update

FieldPermissions を更新するには、Rights を集計として指定します。FieldPermissions を更新するには、AppId カラムとIsPreview カラムが必須です。

UPDATE FieldPermissions SET Rights = 'Update FieldPermissions set Rights='[{"code":"Updated_by","entities":[{"accessibility":"READ","entity":{"type":"GROUP","code":"everyone"}}]}]' WHERE AppId = 6 AND IsPreview = true

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		フィールドのアクセス権設定を取得または更新する対象のkintoneアプリのアプリID。
Code [KEY]	String	False		カスタムのアクセス権ルールが適用されている特定のフィールドを識別するフィールドコード。
Entities	String	False		フィールドレベルのアクセス権を受け取るユーザー、グループ、または組織を一覧表示する配列。アクセス権の評価方法を制御するために優先度順に並べられています。
Revision	String	True		アプリ設定のリビジョン番号。フィールドのアクセス権設定の更新を追跡するのに役立ちます。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
IsPreview	Boolean	フィールドのアクセス権の詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。
Rights	String	更新実行時に変更されたフィールドのアクセス権設定を提供するためにのみ使用される値。

アプリのフィールドを作成、更新、削除、およびクエリでき、アプリのデータモデルをプログラムで管理できるようにします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM FormFields WHERE AppId = 6
SELECT * FROM FormFields WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM FormFields WHERE AppId = 6 AND IsPreview = false

Insert

INSERT ステートメントでは、AppId、Type、Code およびLabel カラムが必須です。

INSERT INTO FormFields (AppId, Type, Code, Label) VALUES (6, 'SINGLE_LINE_TEXT', 'Text__single_line_CRUD', 'Test')

挿入は、AppId カラムとProperties カラムをjson 集計として指定することでも実行できます。

INSERT INTO FormFields (AppId, Properties) VALUES (6, '{"Text__single_line_TD":{"type":"SINGLE_LINE_TEXT","code":"Text__single_line_TD","label":"Test"}}')

Kintone API はBulk Insert もサポートしています。

INSERT INTO FormFields#TEMP (AppId, Type, Code, Label) VALUES (6, 'SINGLE_LINE_TEXT', 'Text__single_line_temp1', 'Label1')
INSERT INTO FormFields#TEMP (AppId, Type, Code, Label) VALUES (6, 'SINGLE_LINE_TEXT', 'Text__single_line_temp2', 'Label2')
INSERT INTO FormFields (AppId, Type, Code, Label) SELECT AppId, Type, Code, Label FROM FormFields#TEMP

Update

用途に応じて、FormFields を更新する方法は2通りあります。

方法1：Properties カラムを使用する更新。複数のフォームフィールドの詳細を一度に更新したい場合は、Properties カラムを使用できます。このカラムには、code、label、type などのフィールド属性を含むJSON オブジェクトを指定します。この方法では、WHERE 句にAppId カラムを含める必要があります。

UPDATE FormFields SET Properties = '{"Text__single_line_TT":{"code":"Text__single_line_PT","label":"text","type":"SINGLE_LINE_TEXT"}}' WHERE AppId = 6

方法2：個別のカラムを使用する更新。label やcode などのフィールドを、Properties カラムを使わずに個別に直接更新することもできます。ただし、この方法では1項目ずつしか更新できません。この方法では、WHERE 句にAppId カラムとCode カラムの両方を含める必要があります。

UPDATE FormFields SET label='text', code='Item_update', type='SINGLE_LINE_TEXT' where appId=444 and code='Item';

Delete

削除したいCode カラムの値をカンマ区切りで指定する必要があります。FormFields を削除するには、AppId カラムが必須です。

DELETE FROM FormFields WHERE Code = 'Text__single_line_CRUD, Text__single_line_TD' AND AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		フォームフィールド設定を取得または更新する対象のkintoneアプリのアプリID。
Code [KEY]	String	False		アプリのスキーマ内でフォームフィールドを一意に識別するフィールドコード。
Enabled	String	True		特定のフィールド機能が有効か無効かを示し、フォーム内でのフィールドの動作を制御するのに役立ちます。
Label	String	False		フォームレイアウトでフィールドに表示される表示名。
NoLabel	Boolean	False		よりクリーンまたはコンパクトなレイアウトを作成するためにフィールドのラベルを非表示にするかどうかを示します。
Type	String	False		フォームで使用されるフィールドタイプ。フィールドのデータ形式と動作を決定します。
Required	String	False		レコードを保存する前にフィールドに値が入力されている必要があるかどうかを指定します。
Unique	String	False		フィールドで重複値を禁止するかどうかを指定し、レコード間で一意性を強制します。
MaxValue	String	False		フィールドの最大値。入力の上限を制御するのに役立ちます。
MinValue	String	False		フィールドの最小値。十分な入力を確保するために使用します。
MaxLength	String	False		フィールドで許可される最大文字数。受け入れる入力のサイズを制御します。
MinLength	String	False		フィールドで必要な最小文字数。最低限の入力を強制します。
DefaultValue	String	False		フィールドに適用される初期値。複数の初期値を設定できるフィールドでは配列が返されます。
DefaultNowValue	String	False		レコード作成日時を初期値として自動的に設定するかどうかを示します。
Options	String	False		ドロップダウンやラジオボタンで使用されるラベルや値など、フィールドの選択肢を含むオブジェクト。
Align	String	False		選択肢ベースのフィールドに適用されるレイアウト配置。選択肢がユーザーにどのように表示されるかに影響します。
Expression	String	False		フィールドの値を動的に計算するために使用される計算式。
HideExpression	String	False		フォーム内でフィールドの計算式をユーザーから非表示にするかどうかを示します。
Digit	String	False		数値を表示する際に桁区切りを使用するかどうかを示します。
ThumbnailSize	String	False		画像を保存するフィールドに表示される画像サムネイルのピクセルサイズ。
Protocol	String	False		URLやリンクフィールドを開くときの動作を定義するリンクタイプ設定。
Format	String	False		計算フィールドに適用される表示形式。読みやすさのために数値や日付をフォーマットするなど。
DisplayScale	String	False		値を表示する際に数値フィールドに表示する小数点以下の桁数。
Unit	String	False		フィールドが金額を表す場合にフィールドとともに表示される単位記号。
UnitPosition	String	False		フィールドの表示における数値に対する単位記号の位置。
Entities	String	False		フィールドに割り当てられたプリセットユーザーを一覧表示する配列。デフォルトの作業者やユーザー選択の初期化によく使用されます。
ReferenceTable	String	False		関連レコード一覧フィールドの設定詳細を含むオブジェクト。リンクされたレコードの取得方法と表示方法を定義します。
LookUp	String	False		別のアプリのレコードから値を取得する方法を定義するルックアップフィールドの設定を含むオブジェクト。
OpenGroup	String	False		フォーム読み込み時にフィールドグループをデフォルトで展開するかどうかを示します。
Fields	String	False		テーブルフィールドのネストされたフィールド定義を含むオブジェクト。Properties構造と同じパラメータを使用します。
Revision	String	True		アプリ設定のリビジョン番号。フォーム設定の更新を追跡するのに役立ちます。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Lang	String	フォームフィールドデータを特定の言語で取得するためのロケールコード。
IsPreview	Boolean	フォームフィールド設定を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。
Properties	String	挿入または更新実行時に変更されたフィールド定義を提供するためにのみ使用される値。

アプリのフォームレイアウトの構造を公開し、セクション、フィールド、および要素がエンドユーザーにどのように配置されているかを確認または更新できるようにします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM FormLayout WHERE AppId = 6
SELECT * FROM FormLayout WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM FormLayout WHERE AppId = 6 AND IsPreview = false

Update

FormLayout を更新するには、Layout を集計として指定します。フォームのすべてのフィールドは集計で指定される必要があります。FormLayout を更新するには、AppId カラムが必須です。

UPDATE FormLayout SET Layout = '[{"type":"ROW","fields":[{"type":"SPACER","code":"Table_0","size":{"width":"200"}}]}]' WHERE AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		フォームレイアウト設定を取得または更新する対象のkintoneアプリのアプリID。
Fields	String	False		レイアウト行に含まれるフィールドの一覧。フォームのそのセクションに一緒に表示される要素を表します。
Type	String	False		レイアウト行のタイプ。行がどのように構造化され、そのフィールドがフォーム内でどのように配置されるかを示します。 使用できる値は次のとおりです。ROW, SUBTABLE, GROUP
Code	String	False		行に関連付けられたテーブルまたはグループフィールドのフィールドコード。行がこれらのコンテナタイプのいずれかを表す場合にのみ返されます。
Revision	String	True		アプリ設定のリビジョン番号。フォームレイアウトに加えられた変更を追跡するのに役立ちます。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
IsPreview	Boolean	フォームレイアウトの詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。
Layout	String	挿入または更新実行時に変更されたレイアウト定義を提供するためにのみ使用される値。

アプリのグローバル通知設定を制御し、更新、メンション、またはレコードのアクティビティについてユーザーにどのようにアラートするかを調整できるようにします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM GeneralNotifications WHERE AppId = 6
SELECT * FROM GeneralNotifications WHERE AppId = 6 AND IsPreview = false

Update

GeneralNotifications を更新するには、Notifications を集計として指定します。GeneralNotifications を更新するには、AppId カラムが必須です。

UPDATE GeneralNotifications SET Notifications = '[{"entity":{"type":"FIELD_ENTITY","code":"Updated_by"},"includeSubs":false,"recordAdded":false,"commentAdded":true}],"notifyToCommenter":true' WHERE AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		条件通知設定を取得または更新する対象のkintoneアプリのアプリID。
EntityType	String	False		条件通知を受け取るエンティティの種類（ユーザー、グループ、組織など）。
EntityCode [KEY]	String	False		条件通知を受け取るように設定された特定のエンティティを識別するコード。
IncludeSubs	Boolean	False		組織に割り当てられた通知ルールを下位組織にも適用するかどうかを示します。notifications[].entity.typeがORGANIZATIONまたは組織選択フィールドのFIELD_ENTITYに設定されている場合を除き、常に'false'を返します。
RecordAdded	Boolean	False		アプリに新しいレコードが追加されたときにエンティティが通知を受け取るかどうかを指定します。
RecordEdited	Boolean	False		既存のレコードが編集されたときにエンティティが通知を受け取るかどうかを指定します。
CommentAdded	Boolean	False		レコードに新しいコメントが投稿されたときにエンティティが通知を受け取るかどうかを指定します。
StatusChanged	Boolean	False		ワークフロー内でレコードのステータスが変更されたときにエンティティが通知を受け取るかどうかを指定します。
FileImported	Boolean	False		ファイルを使用してアプリにデータがインポートされたときにエンティティが通知を受け取るかどうかを指定します。
NotifyToCommenter	Boolean	False		レコードに新しいコメントが追加されたときに、そのレコードのすべてのコメント投稿者に通知するかどうかを指定します。「コメントを書き込んだユーザーは、そのレコードにコメントが書き込まれたときに通知を受信する」設定を反映します。
Revision	String	True		アプリ設定のリビジョン番号。通知ルールに加えられた変更を追跡するのに役立ちます。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
IsPreview	Boolean	条件通知の詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。
Notifications	String	更新実行時に変更された条件通知設定を提供するためにのみ使用される値。

アプリの名前、アイコン、操作動作などの高レベル設定へのアクセスを提供し、バージョン管理と設定監査をサポートします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM GeneralSettings WHERE AppId = 6
SELECT * FROM GeneralSettings WHERE AppId = 6 AND IsPreview = false

Update

更新するGeneralSetting の AppId とIconKey を指定する必要があります。

UPDATE GeneralSettings SET Name = 'UpdatedName', Description = 'Test Description', IconType = 'PRESET', IconKey = 'APP72' WHERE IconKey = 'APP72' AND AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	True		一般設定を取得または更新する対象のkintoneアプリのアプリID。
IconKey [KEY]	String	False		アプリのアイコンのキー識別子。kintoneのプリセットアイコンを使用している場合に返されます。
IconType	String	False		アプリに使用されるアイコンの種類を指定します。アイコンがPRESET（プリセット）かFILE（アップロードファイル）かを示します。
IconFile	String	False		アプリにカスタムアイコンが使用されている場合の、アップロードされたアイコンファイルのデータを含むオブジェクト。
Name	String	False		kintoneインターフェースに表示されるアプリの表示名。
Description	Longvarchar	False		アプリのHTML形式の説明。ユーザーにコンテキストや使用方法を提供するためによく使用されます。
Theme	String	False		アプリに適用されるカラーテーマ。アプリのヘッダーやインターフェースのアクセントの視覚的スタイルを制御します。
Revision	String	True		アプリ設定のリビジョン番号。アプリの設定に加えられた更新を追跡するのに役立ちます。
TitleFieldSelectionMode	String	False		レコードタイトルとなるフィールドを決定する方法。AUTO（自動選択）またはMANUAL（アプリ設計者による手動選択）を指定できます。
TitleFieldCode	String	False		MANUAL選択モードが使用されている場合に、レコードタイトルとして指定されたフィールドのフィールドコード。
EnableBulkDeletion	Boolean	False		一括削除機能を使用して、ユーザーが複数のレコードを一度に削除できるかどうかを示します。
EnableComments	Boolean	False		アプリでコメント機能が有効かどうかを示し、ユーザーがレコードにコメントを投稿できるようにします。
EnableDuplicateRecord	Boolean	False		ユーザーが既存のレコードを複製して新しいレコードをより迅速に作成できるかどうかを示します。
EnableThumbnails	Boolean	False		画像プレビューをサポートするフィールドでサムネイルを表示するかどうかを示します。
FirstMonthOfFiscalYear	Integer	False		アプリの会計年度の最初の月を指定します。月を表す数値で返されます。
NumberPrecisionDecimalPlaces	Integer	False		数値を丸める際に使用する小数点以下の桁数を指定します。
NumberPrecisionDigits	Integer	False		整数部と小数部を含む、数値に許可される合計桁数を指定します。
NumberPrecisionRoundingMode	String	False		数値に適用される丸めモード。HALF_EVEN、UP、またはDOWNをサポートします。
EnableInlineRecordEditing	Boolean	False		レコード一覧でインライン編集が有効かどうかを示し、ユーザーがレコードを開かずに直接フィールドを変更できるようにします。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Lang	String	一般設定の値を特定の言語で取得するためのロケールコード。
IsPreview	Boolean	一般設定の詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。

アプリ内で定義されたグラフと分析を管理し、管理者がユーザー向けにデータがどのように可視化されるかを確認または更新できるようにします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM GraphSettings WHERE AppId = 6
SELECT * FROM GraphSettings WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM GraphSettings WHERE AppId = 6 AND IsPreview = false

Update

GraphSettings を更新するには、Reports を集計として指定します。GraphSettings を更新するには、AppId カラムが必須です。

UPDATE GraphSettings SET Reports = '{"Graph1":{"chartType":"BAR","chartMode":"PERCENTAGE","name":"Updated_Graph_Name","index":"0","groups":[{"code":"Created_by"}]}}' WHERE AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId	Integer	False		グラフとレポート設定を取得または更新する対象のkintoneアプリのアプリID。
Id [KEY]	String	True		アプリ内のグラフ設定の一意の識別子。
Index	String	False		アプリのグラフリスト内でのグラフの位置（0から始まる）。グラフがユーザーに表示される順序を決定します。
Name	String	False		グラフの表示名。64文字以下で指定します。langパラメータが指定されている場合、リクエストされた言語で返されます。
PeriodicReport	String	False		グラフの定期レポート設定を含むオブジェクト。定期レポートが設定されていない場合は'null'が返されます。
Sorts	String	False		グラフデータの並び順を決定する「並び替え」設定を定義するオブジェクトの配列。
Aggregations	String	False		グラフ生成時に合計やカウントなど、フィールド値を集計するために使用される関数設定。
ChartMode	String	False		グラフに適用される表示モード。インターフェースでグラフがどのようにレンダリングされるかを決定します。
ChartType	String	False		グラフに選択されたグラフの種類（棒グラフ、折れ線グラフ、円グラフ、その他のサポートされている可視化形式など）。
FilterCond	String	False		クエリ文字列形式で表現されたレコードのフィルタ条件。グラフの「絞り込み」設定を反映します。
Groups	String	False		グラフでレコードをグループ化するために使用される関数設定。集計時にデータがどのように分類されるかを定義します。
Revision	String	True		アプリ設定のリビジョン番号。グラフ設定に加えられた更新を追跡するのに役立ちます。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Lang	String	グラフ設定の値を特定の言語で取得するためのロケールコード。
IsPreview	Boolean	グラフ設定の詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。
Reports	String	更新実行時に変更されたグラフレポート設定を提供するためにのみ使用される値。

個々のレコードに紐付いた通知ルールを維持し、期限、条件、またはワークフローの変更に基づいてアラートを自動化するのに役立ちます。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM PerRecordNotifications WHERE AppId = 6
SELECT * FROM PerRecordNotifications WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM PerRecordNotifications WHERE AppId = 6 AND IsPreview = false

Update

PerRecordNotifications を更新するには、Notifications を集計として指定します。PerRecordNotifications を更新するには、AppId カラムが必須です。

UPDATE PerRecordNotifications SET Notifications = '[{"filterCond":"Record_number = 18","title":"Test Title","targets":[{"entity":{"type":"FIELD_ENTITY","code":"Created_by"},"includeSubs":false}]}]' WHERE AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		レコードごとの通知設定を取得または更新する対象のkintoneアプリのアプリID。
FilterCond	String	False		クエリ文字列形式で表現されたレコードのフィルタ条件。どのレコードがレコードごとの通知をトリガーするかを定義します。
Title [KEY]	String	False		通知に使用される件名。kintoneインターフェースに表示される「通知内容」フィールドに対応します。
Targets	String	False		レコードごとの通知を受け取るユーザー、グループ、または組織を一覧表示するオブジェクトの配列。
Revision	String	True		アプリ設定のリビジョン番号。通知設定に加えられた更新を追跡するのに役立ちます。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Lang	String	レコードごとの通知データを特定の言語で取得するためのロケールコード。
IsPreview	Boolean	レコードごとの通知の詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。
Notifications	String	更新実行時に変更されたレコードごとの通知設定を提供するためにのみ使用される値。

レコードがステータス間をどのように移動するかを制御するワークフロールールを管理し、管理者がプロセスのステップ、遷移、および制限を管理できるようにします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ProcessManagement WHERE AppId = 6
SELECT * FROM ProcessManagement WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ProcessManagement WHERE AppId = 6 AND IsPreview = false

Update

ProcessManagement を更新するには、States とActions を集計として指定します。ProcessManagement を更新するには、AppId カラムが必須です。

UPDATE ProcessManagement SET Enable = true, States = '{"In progress":{"name":"In progress","index":"1","assignee":{"type":"ONE","entities":[]}},"Ready":{"name":"Ready","index":"3","assignee":{"type":"ONE","entities":[]}},"Completed":{"name":"Completed","index":"2","assignee":{"type":"ONE","entities":[]}},"Not started":{"name":"Not started","index":"0","assignee":{"type":"ONE","entities":[{"entity":{"type":"FIELD_ENTITY","code":"Created_by"},"includeSubs":false}]}}}', Actions = '[{"name":"Start","from":"Not started","to":"In progress","filterCond":""},{"name":"Complete","from":"Completed","to":"Completed","filterCond":""}]' WHERE AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		プロセス管理設定を取得または更新する対象のkintoneアプリのアプリID。
Enable	Boolean	False		アプリでプロセス管理が有効かどうかを示し、レコードが定義されたワークフローのステータスを進行するかどうかを制御します。
Actions	String	False		ユーザーインターフェースに表示される順序と同じ順序でアプリのプロセス管理アクションを含む配列。プロセス管理が一度も有効にされていない場合は'null'が返されます。
Revision	String	True		アプリ設定のリビジョン番号。プロセス管理設定に加えられた更新を追跡するのに役立ちます。
Name	String	False		現在のプロセス管理の状態に関連付けられたワークフローステータスの表示名。
Index	String	False		ワークフローステータスの昇順の表示順序。他のステータスに対する相対的な位置を決定します。
AssigneeType	String	False		ステータスに使用される作業者リストのタイプ。ワークフローのステップを処理するユーザーまたはグループの選択方法を定義します。
AssigneeEntities	String	False		ステータスに設定された作業者を一覧表示する配列。ユーザーインターフェースに表示される順序と同じ順序で返されます。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Lang	String	プロセス管理の詳細を特定の言語で取得するためのロケールコード。
IsPreview	Boolean	プロセス管理の詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。
States	String	更新実行時に変更されたプロセス管理のステータス定義を提供するためにのみ使用される値。

レコードを閲覧、変更、削除、または再割り当てできるユーザーを決定するレコードレベルのアクセスポリシーを定義し、コンプライアンスとセキュリティレビューをサポートします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM RecordPermissions WHERE AppId = 6
SELECT * FROM RecordPermissions WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM RecordPermissions WHERE AppId = 6 AND IsPreview = false

Update

RecordPermissions を更新するには、Rights を集計として指定します。RecordPermissions を更新するには、AppId カラムとIsPreview カラムが必須です。

UPDATE RecordPermissions SET Rights = '[{"filterCond":"","entities":[{"entity":{"type":"GROUP","code":"everyone"},"viewable":false,"editable":false,"deletable":false,"includeSubs":true}]}]' WHERE AppId = 6 AND IsPreview = true

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		レコードのアクセス権設定を取得または更新する対象のkintoneアプリのアプリID。
FilterCond	String	False		アクセス権ルールが適用されるレコードを決定するクエリ文字列形式のフィルター条件。
Entities	String	False		レコードレベルのアクセス権を受け取るユーザー、グループ、または組織を一覧表示する配列。アクセス権の評価方法を制御するため優先度順に並べられています。
Revision	String	False		アプリ設定のリビジョン番号。レコードのアクセス権設定の更新を追跡するのに役立ちます。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Lang	String	レコードのアクセス権の詳細を特定の言語で取得するためのロケールコード。
IsPreview	Boolean	レコードのアクセス権の詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。
Rights	String	更新実行時に変更されたレコードのアクセス権設定を提供するためにのみ使用される値。

時間や条件に基づいてアラートをトリガーするリマインダールールを制御し、チームが締め切りやフォローアップをより確実に追跡できるようにします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ReminderNotifications WHERE AppId = 6
SELECT * FROM ReminderNotifications WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ReminderNotifications WHERE AppId = 6 AND IsPreview = false

Update

ReminderNotifications を更新するには、Notifications を集計として指定します。ReminderNotifications を更新するには、AppId カラムが必須です。

UPDATE ReminderNotifications SET Notifications = '[{"timing":{"code":"Updated_datetime","daysLater":-2,"hoursLater":-5},"filterCond":"Record_number = 14","title":"Reminder: Tomorrow is the deadline.","targets":[{"entity":{"type":"FIELD_ENTITY","code":"Created_by"},"includeSubs":false}]}]' WHERE AppId = 6

Columns

Name	Type	ReadOnly	References	Description
AppId [KEY]	Integer	False		リマインダー通知設定を取得または更新する対象のkintoneアプリのアプリID。
FilterCond	String	False		リマインダー通知をトリガーするレコードを定義するクエリ文字列形式のレコードフィルター条件。
Title	String	False		リマインダー通知に使用される件名。kintoneインターフェースに表示される「通知内容」フィールドに対応します。
TimingCode [KEY]	String	False		リマインダー通知をトリガーするタイミングを決定する日付または日時フィールドのフィールドコード。
TimingDaysLater	Integer	False		タイミングフィールドの値からのオフセット日数。正の値はその日付より後にリマインダーをスケジュールし、負の値はその日付より前にスケジュールします。
TimingHoursLater	Integer	False		タイミングフィールドの日時値からのオフセット時間数。TimingDaysLaterで定義された日オフセットの後に適用されます。
TimingTime	String	False		リマインダー通知を送信する特定の時刻。タイミングフィールドが日付フィールドの場合、または時刻ベースのスケジューリングが設定されている場合に返されます。
Targets	String	False		リマインダー通知を受け取るユーザー、グループ、または組織を一覧表示するオブジェクトの配列。
Revision	String	True		アプリ設定のリビジョン番号。リマインダー通知設定の変更を追跡するのに役立ちます。
Timezone	String	False		リマインダー通知を送信するタイミングを決定するために使用されるタイムゾーン。「リマインド時刻のタイムゾーン」設定を反映し、リマインダー設定が存在しない場合はnullを返します。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Lang	String	リマインダー通知の詳細を特定の言語で取得するためのロケールコード。
IsPreview	Boolean	リマインダー通知の詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。
Notifications	String	更新実行時に変更されたリマインダー通知設定を提供するためにのみ使用される値。

サンプルアプリ：顧客管理（営業支援パック）

Columns

Name	Type	ReadOnly	References	Description
RecordId	Int	True		サンプル：レコードID
Revision	Int	True		サンプル：Revision
AppId	Int	True		サンプル：アプリID
備考	String	True		サンプル：備考
更新者 Code	String	True		サンプル：更新者 Code
更新者 Name	String	True		サンプル：更新者 Name
作成者 Code	String	True		サンプル：作成者 Code
作成者 Name	String	True		サンプル：作成者 Name
郵便番号	String	True		サンプル：郵便番号
部署名	String	True		サンプル：部署名
メールアドレス	String	True		サンプル：メールアドレス
担当者名	String	True		サンプル：担当者名
更新日時	Datetime	True		サンプル：更新日時
顧客名	String	True		サンプル：顧客名
住所	String	True		サンプル：住所
TEL	String	True		サンプル：TEL
FAX	String	True		サンプル：FAX
作成日時	Datetime	True		サンプル：作成日時

サンプルアプリ：顧客管理（営業支援パック）明細テーブル

Columns

Name	Type	ReadOnly	References	Description
顧客管理（営業支援パック）Id	Int	True		サンプル：顧客管理（営業支援パック）Id
Id	Int	True		サンプル：Id
Revision	Int	True		サンプル：Revision
AppId	Int	True		サンプル：アプリID
案件名	String	True		サンプル：案件名
確度	String	True		サンプル：確度
受注予定日	Datetime	True		サンプル：受注予定日
合計費用	Double	True		サンプル：合計費用
商談担当者 Aggregate	String	True		サンプル：商談担当者 Aggregate

チームコラボレーション、コンテンツ共有、ディスカッションスレッドに使用されるワークスペース領域であるkintoneスペースのプログラムによる管理を可能にします。

Select

WHERE 句では、Id カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Space WHERE Id = 7

Insert

INSERT ステートメントでは、SpaceTemplateID、Name、Members カラムが必須です。

INSERT INTO Space(SpaceTemplateID, Name, Members) Values(1, 'New_Space', '[{"entity":{"type":"USER","code":"[email protected]"},"isAdmin":true}]')

Update

Space を更新するには、Id カラムが必須です。

UPDATE Space SET body='Space Body' WHERE Id = 16

Delete

Space を削除するには、Id カラムが必須です。

DELETE FROM Space WHERE Id = 16

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		スペースの識別子。kintone環境全体でワークスペースを参照するために使用されます。
Name	String	False		kintoneインターフェースに表示されるスペースの表示名。
DefaultThread	String	False		スペースが最初に設定されたときに自動的に作成されたデフォルトスレッドの識別子。
IsPrivate	Boolean	False		スペースが非公開かどうかを示します。非公開の場合、明示的に割り当てられたメンバーのみに表示が制限されます。
CreatorCode	String	False		スペースを作成したユーザーのログイン名。停止ユーザーまたは削除ユーザーの場合は空の文字列が返されます。
CreatorName	String	False		スペースを作成したユーザーの表示名。停止ユーザーまたは削除ユーザーの場合は空の文字列が返されます。
ModifierCode	String	False		スペース設定を最後に更新したユーザーのログイン名。停止ユーザーまたは削除ユーザーの場合は空の文字列が返されます。
ModifierName	String	False		スペース設定を最後に更新したユーザーの表示名。停止ユーザーまたは削除ユーザーの場合は空の文字列が返されます。
MemberCount	String	False		現在スペースに所属しているメンバーの数。
CoverType	String	False		スペースのカバー画像に使用される画像の種類。プリセットかアップロードされたファイルかを示します。
CoverKey	String	False		スペースに割り当てられたカバー画像のキー識別子。
CoverUrl	String	False		スペースのヘッダーで使用されるカバー画像を指すURL。
Body	String	False		スペースの本文に表示されるHTMLコンテンツ。コンテンツが設定されていない場合はnullが返されますが、以前にコンテンツが存在した場合は保持されたタグが含まれている可能性があります。
UseMultiThread	Boolean	False		スペースがシングルスレッド構造ではなく複数のディスカッションスレッドを許可するかどうかを示します。
IsGuest	Boolean	False		スペースがゲストスペースかどうかを示します。ゲストスペースは指定されたゲストユーザーにアクセスを制限します。
FixedMember	Boolean	False		スペースのメンバーシップが固定されているかどうかを示します。固定されている場合、管理者設定以外でメンバーの追加や削除ができません。
AttachedApps	String	False		スペースのスレッドに関連付けられたアプリのリスト。まだ公開されていないアプリは含まれません。
ShowAnnouncement	Boolean	False		スペースにお知らせウィジェットが表示されるかどうかを示します。
ShowThreadList	Boolean	False		スペースにスレッドウィジェットが表示されるかどうかを示します。
ShowAppList	Boolean	False		スペースにアプリウィジェットが表示されるかどうかを示します。
ShowMemberList	Boolean	False		スペースメンバーを表示するピープルウィジェットが表示されるかどうかを示します。
ShowRelatedLinkList	Boolean	False		スペースに関連アプリとスペースウィジェットが表示されるかどうかを示します。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
SpaceTemplateID	String	新しいスペースを作成する際に使用されるスペーステンプレートの識別子。スペース作成時に必須です。
Members	String	スペースに割り当てられるユーザーのリスト。新しいスペースを作成する際に必須で、少なくとも1人のスペース管理者を含める必要があります。停止ユーザーおよび削除ユーザーは含めることができません。

スペースのメンバーシップリストを管理し、どのユーザーがワークスペースとそのディスカッションにアクセスできるかを確認または更新できるようにします。

Select

WHERE 句では、Id カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM SpaceMembers WHERE Id = 1

Update

SpaceMembers を更新するには、Members カラムを集計として指定します。SpaceMembers を更新するには、Id カラムが必須です。

UPDATE SpaceMembers SET Members='[{"entity":{"type":"USER","code":"[email protected]"},"isAdmin":true}]' WHERE Id = 1

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		メンバーシップの詳細を取得または更新する対象のスペースの識別子。
EntityCode	String	False		スペースのメンバーであるユーザー、グループ、または組織を識別するコード。
EntityType	String	False		スペースに割り当てられたエンティティの種類（ユーザー、グループ、組織など）。
IsAdmin	Boolean	False		メンバーがスペース管理者権限を持っているかどうかを示します。スペース管理者はスペース設定とメンバーシップを管理できます。
IsImplicit	Boolean	False		メンバーが個別に追加されたのではなく、グループまたは組織のメンバーシップを通じて暗黙的に追加されたかどうかを示します。
IncludeSubs	Boolean	False		組織に付与されたメンバーシップを下位組織にも適用するかどうかを示します。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Members	String	新しいスペースを作成する際に割り当てるメンバーのリスト。少なくとも1人のスペース管理者を含める必要があり、停止ユーザーおよび削除ユーザーは含めることができません。

フィルタリング、ソート、またはカスタム形式のレコードリストを定義するアプリの一覧を制御し、ユーザー向けのデータ表示の管理をサポートします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Views WHERE AppId = 6
SELECT * FROM Views WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM Views WHERE AppId = 6 AND IsPreview = false

Update

Views を更新するには、Views を集計として指定します。集計に記載されていないビュー名は削除されます。Views を更新するには、AppId カラムが必須です。

UPDATE VIEWS SET Views = '{"(Assigned to me)":{"index":0,"type":"LIST","name":"(Assigned to me)","filterCond":"Assignee in (LOGINUSER())","sort":"Record_number asc"},"subTableTest2":{"index":1,"type":"CALENDAR","name":"subTableTest","date":"Updated_datetime","filterCond":"","sort":"Record_number asc"}}' WHERE AppId = 6

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		一覧の識別子。アプリ内の特定の一覧設定を参照するために使用されます。
AppId	Integer	False		取得または更新する一覧を含むkintoneアプリのアプリID。
Index	String	False		一覧の昇順の表示順序。アプリ内の他の一覧に対する相対的な位置を決定します。
Name	String	False		kintoneインターフェースでユーザーに表示される一覧の表示名。
Title	String	False		カレンダー形式の一覧を表示する際にタイトルフィールドとして使用されるフィールドコード。カレンダー形式の一覧の場合にのみ返されます。
Type	String	False		一覧の表示形式（リスト、カレンダー、カスタマイズなど）。レコードがユーザーにどのように表示されるかを定義します。 使用できる値は次のとおりです。LIST, CALENDAR, CUSTOM
BuiltinType	String	False		一覧がカスタムでない場合に使用されている組み込み一覧の種類を示します。
Date	String	False		カレンダー形式の一覧で日付フィールドとして使用されるフィールドコード。一覧がカレンダー形式として設定されている場合にのみ返されます。
Fields	String	False		一覧のレコードリストに表示されるフィールドを決定するフィールドコードのリスト。
FilterCond	String	False		クエリ文字列として表現されるフィルター条件。一覧に表示されるレコードを定義します。
Html	String	False		カスタマイズビューをレンダリングするために使用されるHTMLコンテンツ。一覧がカスタムレイアウトとして定義されている場合にのみ返されます。
Pager	Boolean	False		一覧でページネーションが有効かどうかを示します。カスタマイズビューの場合にのみ返されます。
Device	String	False		一覧が表示されるデバイスコンテキスト（デスクトップやモバイルなど）を指定します。
Sort	String	False		クエリ文字列として表現されるソート順序。一覧内でレコードがどのように並べ替えられるかを定義します。
Revision	String	True		アプリ設定のリビジョン番号。一覧設定に対する更新を追跡するのに役立ちます。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Lang	String	一覧の詳細を特定の言語で取得するためのロケールコード。
IsPreview	Boolean	一覧の詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。
Views	String	更新実行時に変更された一覧設定を提供するためにのみ使用される値。

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Kintone ビュー

Name	Description
ActionSettingsEntities	各自動化ルールを定義する詳細なコンポーネントを返し、アクションの実行にどのフィールド、条件、およびターゲットが関与しているかを把握できるようにします。
ActionSettingsMappings	自動化ルールで使用されるフィールドの関連付けを一覧表示し、アクションがトリガーされたときにアプリ間でデータがどのように移動するかを正確に追跡できるようにします。
Apps	カタログ作成、ガバナンス、または外部システムとの連携に必要な主要なメタデータとともに、kintone環境内のすべてのアプリを返します。
FieldPermissionsEntities	フィールドレベルのアクセス権を基礎となるルールに分解し、ユーザーやグループ間で表示権限や編集権限がどのように異なるかを正確に把握できるようにします。
FormLayoutFields	アプリのフォーム内で使用される個々のレイアウト要素を返し、フィールドの配置、グループ化、およびユーザーインターフェースデザインの分析を容易にします。
PerRecordNotificationsTargets	レコードレベルの通知を受け取るユーザーとグループのリストを返し、コミュニケーションの監査とトラブルシューティングをサポートします。
ProcessManagementActions	プロセス内で利用可能なワークフローアクションを一覧表示し、アプリのワークフローで定義された遷移パスを分析またはドキュメント化するのに役立ちます。
RecordPermissionsEntities	レコードレベルのアクセス権を詳細なエンティティに分解し、ユーザー、グループ、ロールごとにアクセスルールがどのように異なるかを表示します。
ReminderNotificationsTargets	リマインダー通知に関連付けられたユーザーとグループを返し、自動フォローアップアラートを誰が受信するかを確認できるようにします。

各自動化ルールを定義する詳細なコンポーネントを返し、アクションの実行にどのフィールド、条件、およびターゲットが関与しているかを把握できるようにします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ActionSettingsEntities WHERE AppId = 6
SELECT * FROM ActionSettingsEntities WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ActionSettingsEntities WHERE AppId = 6 AND IsPreview = false

Columns

Name	Type	References	Description
AppId	Integer		アクションとエンティティの割り当てを取得する対象のkintone アプリのアプリID。
Id	String		アクションの一意の識別子。特定の自動化ルールを参照または更新するために使用されます。
Code	String		アクションが許可されているエンティティのコード。ゲストユーザーの場合、ログイン名の頭に「guest/」が付きます。
Type	String		アクションが許可されているエンティティの種類（ユーザー、グループ、組織など）。 使用できる値は次のとおりです。USER, GROUP, ORGANIZATION
Revision	String		アプリ設定のリビジョン番号。設定の変更履歴を追跡するのに役立ちます。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Lang	String		アクションとエンティティの詳細を特定の言語で取得するためのロケールコード。
IsPreview	Boolean		アクションとエンティティの詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。

自動化ルールで使用されるフィールドの関連付けを一覧表示し、アクションがトリガーされたときにアプリ間でデータがどのように移動するかを正確に追跡できるようにします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ActionSettingsMappings WHERE AppId = 6
SELECT * FROM ActionSettingsMappings WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ActionSettingsMappings WHERE AppId = 6 AND IsPreview = false

Columns

Name	Type	References	Description
AppId	Integer		アクションの関連付け詳細を取得する対象のkintone アプリのアプリID。
Id	String		アクションの一意の識別子。特定の自動化ルールを参照または更新するために使用されます。
SrcType	String		アクションのフィールドの関連付けで使用されるコピー元データの種類。アクションがフィールドまたは他のサポートされているソースからコピーするかどうかを示します。 使用できる値は次のとおりです。FIELD, RECORD_URL
SrcField	String		「フィールドの関連付け」オプションでコピー元に指定されたフィールドのフィールドコード。actions.{actionname}.mappings[].srcType の値がFIELD の場合にのみ返されます。
DestField	String		アクション実行時にコピーされた値を受け取るコピー先フィールドのフィールドコード。
Revision	String		アプリ設定のリビジョン番号。関連付け定義の設定変更を追跡するのに役立ちます。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Lang	String		関連付けの詳細を特定の言語で取得するためのロケールコード。
IsPreview	Boolean		関連付けの詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。

カタログ作成、ガバナンス、または外部システムとの連携に必要な主要なメタデータとともに、kintone環境内のすべてのアプリを返します。

Select

デフォルトでは、Cloud はKintone API を使用して以下のカラムを参照する検索条件を処理し、クライアント側でCloud 内で他のフィルタを処理します。Kintone API は、AppId、Code、およびSpaceId カラムの検索をサポートしています。これらのカラムは= およびIN 演算子のサーバー側処理をサポートしますが、Name カラムがサポートするのはLIKE 演算子のみです。例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Apps WHERE AppId IN (20, 21, 51, 56) AND Name LIKE '%To Do%'

Columns

Name	Type	References	Description
AppId [KEY]	Integer		詳細を取得する対象のkintoneアプリのアプリID。
Code	String		アプリに割り当てられたアプリコード。アプリの設定でアプリコードが設定されていない場合は空の値が返されます。
Name	String		アプリの表示名。ローカライズ設定が有効な場合、ユーザーが設定した言語で返されます。
Description	Longvarchar		アプリのテキスト説明。ローカライズ設定が有効な場合、ユーザーが設定した言語で返されます。
SpaceId	String		アプリを含むスペースのスペースID。アプリがスペース内で作成されていない場合は'null'が返されます。
ThreadId	String		アプリがスペース内で作成された場合、アプリを含むスレッドのスレッドID。アプリがスペースまたはスレッドに属していない場合は'null'が返されます。
CreatedAt	Datetime		アプリが作成された日時。
CreatorCode	String		アプリを作成したユーザーのログイン名。停止ユーザーおよび削除ユーザーの場合は値が返されません。
CreatorName	String		アプリを作成したユーザーの表示名。停止ユーザーおよび削除ユーザーの場合は値が返されません。
ModifiedAt	Datetime		アプリが最後に変更された日時。
ModifierCode	String		アプリを最後に更新したユーザーのログイン名。停止ユーザーおよび削除ユーザーの場合は値が返されません。
ModifierName	String		アプリを最後に更新したユーザーの表示名。停止ユーザーおよび削除ユーザーの場合は値が返されません。
Alias	String		アプリに定義されたエイリアス名。接続プロパティTableNameMode=AppIdを使用して一意にすることができます。
ItemUrl	String		kintone環境内でアプリにアクセスまたは参照するために使用される一意のURL。

フィールドレベルのアクセス権を基礎となるルールに分解し、ユーザーやグループ間で表示権限や編集権限がどのように異なるかを正確に把握できるようにします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM FieldPermissionsEntities WHERE AppId = 6
SELECT * FROM FieldPermissionsEntities WHERE AppId = 6 AND IsPreview = false

Columns

Name	Type	References	Description
AppId [KEY]	Integer		フィールドのアクセス権の割り当てを確認または更新する対象のkintoneアプリのアプリID。
Code [KEY]	String		詳細なエンティティレベルのアクセス権が定義されている特定のアプリフィールドを識別するフィールドコード。
EntityType	String		フィールドのアクセス権を受け取るエンティティの種類（ユーザー、グループ、組織など）。組織全体でアクセスがどのように構成されているかを把握できます。
EntityCode	String		フィールドのアクセス権が適用されるユーザー、グループ、または組織を一意に識別するコード。
Accessibility	String		エンティティに付与されるアクセス権レベル。エンティティがフィールドを閲覧できるか、編集できるか、または操作が制限されているかを示します。 使用できる値は次のとおりです。READ, WRITE, NONE
IncludeSubs	Boolean		組織に付与されたフィールドのアクセス権を下位組織にも適用するかどうかを示します。階層的なアクセス制御をサポートします。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
IsPreview	Boolean		フィールドのアクセス権の詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。

アプリのフォーム内で使用される個々のレイアウト要素を返し、フィールドの配置、グループ化、およびユーザーインターフェースデザインの分析を容易にします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM FormLayoutFields WHERE AppId = 6
SELECT * FROM FormLayoutFields WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM FormLayoutFields WHERE AppId = 6 AND IsPreview = false

Columns

Name	Type	References	Description
AppId	Integer		フォームレイアウトのフィールド詳細を取得する対象のkintoneアプリのアプリID。
Code	String		フォームレイアウト内に配置されたフィールドを一意に識別するフィールドコード。
Type	String		レイアウトで表されるフィールドのタイプ。要素の動作とフォームでのレンダリング方法を決定します。
ElementId	String		スペースフィールドに割り当てられた要素ID。レイアウト要素がスペースフィールドの場合にのみ返されます。
Label	Longvarchar		ラベルフィールドのラベルとして使用されるテキスト。要素がラベルコンポーネントを表す場合にのみ返されます。
Width	String		ピクセル単位でのフィールドの横幅。レイアウト内で要素が占める水平方向のスペースを定義します。
Height	String		フィールド名を含めた、ピクセル単位でのフィールドの縦幅の合計。
InnerHeight	String		フィールド名を除いた、ピクセル単位でのフィールドの縦幅。実際の入力または表示領域のサイズを示します。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
IsPreview	Boolean		フォームレイアウトのフィールド詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。

レコードレベルの通知を受け取るユーザーとグループのリストを返し、コミュニケーションの監査とトラブルシューティングをサポートします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM PerRecordNotificationsTargets WHERE AppId = 6
SELECT * FROM PerRecordNotificationsTargets WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM PerRecordNotificationsTargets WHERE AppId = 6 AND IsPreview = false

Columns

Name	Type	References	Description
AppId	Integer		レコードごとの通知先設定を取得する対象のkintoneアプリのアプリID。
Title	String		レコードごとの通知の件名。通知が送信される際に使用される「通知内容」テキストと一致します。
EntityType	String		レコードごとの通知を受け取るように設定されたエンティティの種類（ユーザー、グループ、組織など）。
EntityCode	String		レコードごとの通知を受け取る特定のエンティティを識別するコード。
IncludeSubs	Boolean		組織に割り当てられた通知ルールを下位組織にも適用するかどうかを示します。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Lang	String		通知先設定の値を特定の言語で取得するためのロケールコード。
IsPreview	Boolean		レコードごとの通知先の詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。

プロセス内で利用可能なワークフローアクションを一覧表示し、アプリのワークフローで定義された遷移パスを分析またはドキュメント化するのに役立ちます。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ProcessManagementActions WHERE AppId = 6
SELECT * FROM ProcessManagementActions WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ProcessManagementActions WHERE AppId = 6 AND IsPreview = false

Columns

Name	Type	References	Description
AppId	Integer		プロセス管理のアクション設定を取得する対象のkintoneアプリのアプリID。
Name	String		ワークフローアクションの名前。ユーザーがレコードをステータス間で移動させるために適用できる遷移を表します。
From	String		アクションを実行できる現在のワークフローステータスの名前。
To	String		アクション実行時にレコードが移動するワークフローステータスの名前。
FilterCond	String		レコードデータに基づいてアクションが利用可能かどうかを判定するクエリ文字列形式の条件。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Lang	String		プロセス管理のアクション詳細を特定の言語で取得するためのロケールコード。
IsPreview	Boolean		プロセス管理のアクション詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。

レコードレベルのアクセス権を詳細なエンティティに分解し、ユーザー、グループ、ロールごとにアクセスルールがどのように異なるかを表示します。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM RecordPermissionsEntities WHERE AppId = 6
SELECT * FROM RecordPermissionsEntities WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM RecordPermissionsEntities WHERE AppId = 6 AND IsPreview = false

Columns

Name	Type	References	Description
AppId	Integer		レコードのアクセス権のエンティティ割り当てを取得する対象のkintoneアプリのアプリID。
FilterCond	String		エンティティレベルのアクセス権が適用されるレコードを指定するクエリ文字列形式のフィルター条件。
EntityType	String		レコードレベルのアクセス権を受け取るエンティティの種類（ユーザー、グループ、組織など）。
EntityCode	String		レコードレベルのアクセス権が付与される特定のエンティティを識別するコード。
Viewable	Boolean		エンティティがフィルター条件に一致するレコードを閲覧する権限を持っているかどうかを示します。
Editable	Boolean		エンティティがフィルター条件に一致するレコードを編集する権限を持っているかどうかを示します。
Deletable	Boolean		エンティティがフィルター条件に一致するレコードを削除する権限を持っているかどうかを示します。
IncludeSubs	Boolean		組織に割り当てられたアクセス権を下位組織にも適用するかどうかを示します。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Lang	String		エンティティレベルのレコードのアクセス権の詳細を特定の言語で取得するためのロケールコード。
IsPreview	Boolean		レコードのアクセス権のエンティティ詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。

リマインダー通知に関連付けられたユーザーとグループを返し、自動フォローアップアラートを誰が受信するかを確認できるようにします。

Select

WHERE 句ではAppId カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ReminderNotificationsTargets WHERE AppId = 6
SELECT * FROM ReminderNotificationsTargets WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ReminderNotificationsTargets WHERE AppId = 6 AND IsPreview = false

Columns

Name	Type	References	Description
AppId [KEY]	Integer		リマインダー通知のターゲット設定を取得する対象のkintoneアプリのアプリID。
TimingCode [KEY]	String		リマインダー通知がトリガーされるタイミングを決定する日付または日時フィールドのフィールドコード。
EntityType	String		リマインダー通知を受信するよう設定されたエンティティの種類（ユーザー、グループ、組織など）。
EntityCode	String		リマインダー通知を受信する特定のエンティティを識別するコード。
IncludeSubs	Boolean		組織に割り当てられたリマインダー通知ルールを下位組織にも適用するかどうかを示します。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Lang	String		リマインダー通知のターゲット詳細を特定の言語で取得するためのロケールコード。
IsPreview	Boolean		リマインダー通知のターゲット詳細を動作テスト環境から取得するか（'true'）、運用環境から取得するか（'false'）を示します。デフォルト値は'true'です。

ストアドプロシージャはファンクションライクなインターフェースで、Kintone の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにKintone から関連するレスポンスデータを返します。

CData Cloud - Kintone ストアドプロシージャ

Name	Description
AddGuests	招待メールの送信やスペースへの自動割り当てを行わずに、外部アクセスを制御するためのゲストユーザーをkintone 環境に追加します。
AddGuestsToSpace	既存のゲストユーザーを特定のゲストスペースに割り当て、管理者が必要に応じてワークスペースレベルのアクセスを付与できるようにします。
AddThreadComment	チームのコミュニケーションと監査可能性をサポートするため、スペース内のディスカッションスレッドにコメントを追加します。
AppsDeployStatus	1つ以上のアプリの運用環境への反映ステータスを返し、最近のアプリ更新がユーザーに公開されているかどうかを追跡できるようにします。
CreateApp	指定された設定から新しいkintoneアプリを作成し、自動プロビジョニングワークフローをサポートします。
DeleteGuests	ゲストユーザーを環境から削除し、管理者がセキュリティを維持し、必要に応じて外部アクセスを取り消すことができるようにします。
DeployApps	保留中のアプリ更新をデプロイし、スキーマ変更、アクセス権、および設定を運用環境で有効にします。
UpdateAssignees	レコードに割り当てられたユーザーまたはグループを更新し、ワークフローの進行または所有権の変更をサポートします。
UpdateStatus	レコードのステータスフィールドを更新し、ワークフローステップまたはプロセスステージを進めます。
UpdateThread	スペース内の既存のディスカッションスレッドを更新し、チームが最新かつ正確なコラボレーション履歴を維持できるようにします。

招待メールの送信やスペースへの自動割り当てを行わずに、外部アクセスを制御するためのゲストユーザーをkintone 環境に追加します。

ストアドプロシージャ固有の情報

Kintone は、Exec クエリでは、大きいカラムサブセットを扱うことを許可していません。これらのカラムは、通常= 比較でのみ使用できます。 次に例を示します。

Insert into GuestsAggregate#TEMP(Name, Code, Password, Timezone) Values('Jack', '[email protected]', '#jack@123', 'America/Los_Angeles')
Insert into GuestsAggregate#TEMP(Name, Code, Password, Timezone) Values('Geeky', '[email protected]', '#geeky@321', 'America/Los_Angeles')
EXECUTE AddGuests GuestsAggregate = 'GuestsAggregate#TEMP'

ストアドプロシージャを使用する2つ目の方法は、集計自体を追加することです。

EXECUTE AddGuests GuestsAggregate = '[{"code":"[email protected]","password":"#abcd@123","timezone":"America/Los_Angeles","locale":"en","name":"John Doe","company":"Company Name","division":"Sales","callto":"skypecallto"}]'

Input

Name	Type	Required	Description
Name	String	False	ゲストユーザーに割り当てる表示名。1文字から128文字で指定します。
Code	String	False	ゲストユーザーのログイン名として使用されるメールアドレス。認証の主要な識別子として機能します。
Password	String	False	ゲストユーザーのログイン資格情報となる英数字のパスワード。アカウント作成時に必須です。
Timezone	String	False	ゲストユーザーに適用されるタイムゾーン設定。タイムスタンプの表示やスケジュール動作に使用されます。
Locale	String	False	ゲストユーザーの言語設定を指定します。使用可能な値は'auto'、'en'、'zh'、'ja'です。デフォルト値は'auto'です。
Image	String	False	ゲストユーザーのプロフィール画像。アップロードされたファイルのファイルキーを指定します。
SurNameReading	String	False	ゲストユーザーのよみがな（姓）。64文字以下で指定します。
GivenNameReading	String	False	ゲストユーザーのよみがな（名）。64文字以下で指定します。
Company	String	False	ゲストユーザーのプロフィールに表示される会社名。組織のコンテキストを提供します。
Division	String	False	ゲストユーザーのプロフィールに表示される部署名。
Phone	String	False	ゲストユーザーのプロフィールに表示される電話番号。
CallTo	String	False	コミュニケーションやコラボレーション目的でゲストユーザーに関連付けられるSkype名。
GuestsAggregate	String	False	バッチ処理用に1つ以上のゲストユーザー定義を含む集約構造。

Result Set Columns

Name	Type	Description
Success	String	操作が正常に完了したかどうかをboolean値で返します。

既存のゲストユーザーを特定のゲストスペースに割り当て、管理者が必要に応じてワークスペースレベルのアクセスを付与できるようにします。

ストアドプロシージャ固有の情報

Kintone は、Exec クエリでは、大きいカラムサブセットを扱うことを許可していません。これらのカラムは、通常= 比較でのみ使用できます。 次に例を示します。

EXECUTE AddGuestsToSpace GuestSpaceId = '6', Guests = '["[email protected]","[email protected]","[email protected]"]'

Input

Name	Type	Required	Description
GuestSpaceId	String	True	指定されたゲストユーザーを追加するゲストスペースのスペースID。
Guests	String	True	ゲストスペースへのアクセスを付与するゲストユーザーのログイン名（メールアドレス）のリスト。

Result Set Columns

Name	Type	Description
Success	String	操作が正常に完了したかどうかをboolean値で返します。

チームのコミュニケーションと監査可能性をサポートするため、スペース内のディスカッションスレッドにコメントを追加します。

ストアドプロシージャ固有の情報

Kintone は、Exec クエリでは、大きいカラムサブセットを扱うことを許可していません。これらのカラムは、通常= 比較でのみ使用できます。 次に例を示します。

EXECUTE AddThreadComment SpaceId = 8, ThreadId = 8, Text = 'Test Comment'

Input

Name	Type	Required	Description
SpaceId	Integer	True	コメントを追加するスペースのスペースID。
ThreadId	Integer	True	新しいコメントを受け取るスペース内のスレッドのスレッドID。
Text	String	False	コメントの内容。改行は「LF」で指定します。最大65,535文字まで入力可能です。Filesが設定されていない場合は必須です。
Mentions	String	False	コメント内で他のkintoneユーザーに通知するためのメンションオブジェクトの配列。
Files	String	False	添付ファイルのデータを含む配列。最大5ファイルまで指定できます。Textが設定されていない場合は必須です。

Result Set Columns

Name	Type	Description
Id	String	新しく作成されたコメントのコメントID。
Success	String	操作が正常に完了したかどうかをboolean値で返します。

1つ以上のアプリの運用環境への反映ステータスを返し、最近のアプリ更新がユーザーに公開されているかどうかを追跡できるようにします。

Input

Name	Type	Required	Description
AppIds	String	True	確認する1つ以上のアプリIDを指定します。単一の値またはカンマ区切りのIDリストを指定できます。
GuestSpaceId	String	False	アプリを含むゲストスペースを識別します。接続文字列で接続プロパティGuestSpaceIdが既に設定されている場合は省略してください。

Result Set Columns

Name	Type	Description
AppId	String	反映ステータスを報告するアプリのアプリID。
Status	String	アプリの反映ステータス。最近の更新が適用されたかどうかを示します。

指定された設定から新しいkintoneアプリを作成し、自動プロビジョニングワークフローをサポートします。

Input

Name	Type	Required	Description
Name	String	True	新しいアプリの名前を指定します。kintoneの命名要件を満たすために64文字未満で指定する必要があります。
Space	String	False	スペースのID。接続文字列で接続プロパティGuestSpaceIdが設定されている場合は、このパラメータを指定しないでください。
ThreadId	String	False	スレッドのID。Spaceパラメータまたは接続プロパティGuestSpaceIdが指定されている場合は必須です。
IsGuestSpace	Boolean	False	Spaceパラメータがゲストスペースを参照するかどうかを示します。ゲストスペースの場合は'true'、通常のスペースの場合は'false'を指定します。 デフォルト値はfalseです。

Result Set Columns

Name	Type	Description
AppId	String	新しく作成されたアプリのアプリIDを返します。
Revision	String	新しいアプリの初期設定に割り当てられたリビジョン番号を返します。
Success	String	操作が正常に完了したかどうかをboolean値で返します。

ゲストユーザーを環境から削除し、管理者がセキュリティを維持し、必要に応じて外部アクセスを取り消すことができるようにします。

ストアドプロシージャ固有の情報

Kintone は、Exec クエリでは、大きいカラムサブセットを扱うことを許可していません。これらのカラムは、通常= 比較でのみ使用できます。 次に例を示します。

ゲストを削除する場合は、ゲストの値をカンマ区切りで入力します。

EXECUTE DeleteGuests Guests = '["[email protected]","[email protected]"]'

Input

Name	Type	Required	Description
Guests	String	True	削除するゲストユーザーを識別するメールアドレスのリスト。1回の操作で最大100ユーザーまで削除できます。

Result Set Columns

Name	Type	Description
Success	String	操作が正常に完了したかどうかをboolean値で返します。

保留中のアプリ更新をデプロイし、スキーマ変更、アクセス権、および設定を運用環境で有効にします。

Note：このプロシージャは、インデックス付きパラメータを使用します。 インデックス付きパラメータは、プロシージャの入力として単一のパラメータを複数のインスタンスに提供することを容易にします。

Param# という名前の入力パラメータがあるとします。このようなインデックス付きパラメータの複数のインスタンスを入力するには、次のように実行します。

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

以下のInput テーブルでは、インデックス付きの入力パラメータは、名前の末尾に '#' 文字が付きます。

Input

Name	Type	Required	Description
AppId#	String	True	反映する1つ以上のアプリIDを指定します。単一の値またはカンマ区切りのIDリストを指定できます。
Revision#	String	False	反映するリビジョン番号を指定します。指定されたリビジョンが最新の運用設定と一致しない場合、リクエストは失敗します。
Revert	Boolean	False	保留中のアプリケーション設定の変更をキャンセルする場合は'true'に設定します。 デフォルト値はfalseです。
GuestSpaceId	String	False	アプリを含むゲストスペースを識別します。接続文字列で接続プロパティGuestSpaceIdが既に設定されている場合は指定しないでください。

Result Set Columns

Name	Type	Description
Success	String	操作が正常に完了したかどうかをboolean値で返します。

レコードに割り当てられたユーザーまたはグループを更新し、ワークフローの進行または所有権の変更をサポートします。

Input

Name	Type	Required	Description
AppId	String	True	作業者を更新するレコードを含むkintoneアプリのID。
RecordId	String	True	作業者を変更するレコードのID。
Assignees	String	True	レコードに割り当てられるユーザーを表すユーザーコードのリスト。最大100人まで指定でき、リストが空の場合は誰にも割り当てられません。
Revision	String	False	更新前のレコードのリビジョン番号。最後に取得してからレコードが変更された場合の競合を防ぐために必要です。
GuestSpaceId	String	False	レコードを含むゲストスペースを識別します。接続文字列でプロパティGuestSpaceIdが既に設定されている場合は指定しないでください。

Result Set Columns

Name	Type	Description
Success	String	操作が正常に完了したかどうかをboolean値で返します。
Revision	String	更新後のレコードのリビジョン番号。アクションの実行とステータスの更新が別々の操作としてカウントされるため、2ずつ増加します。

レコードのステータスフィールドを更新し、ワークフローステップまたはプロセスステージを進めます。

Note：このプロシージャは、インデックス付きパラメータを使用します。 インデックス付きパラメータは、プロシージャの入力として単一のパラメータを複数のインスタンスに提供することを容易にします。

Param# という名前の入力パラメータがあるとします。このようなインデックス付きパラメータの複数のインスタンスを入力するには、次のように実行します。

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

以下のInput テーブルでは、インデックス付きの入力パラメータは、名前の末尾に '#' 文字が付きます。

Input

Name	Type	Required	Description
AppId	String	True	ステータスを更新するレコードを含むkintoneアプリのアプリID。
RecordId#	String	True	アクション実行時に新しいステータスに移動するレコードのレコードID。
Action#	String	True	実行するワークフローアクションの名前。ローカライズされたアクション名が使用されている場合は、ユーザーの言語設定でのアクション名と一致する必要があります。
Assignee#	String	False	ステータス遷移完了後に次の作業者となるユーザーのログイン名。
Revision#	String	False	ステータス更新前のレコードのリビジョン番号。最後に取得してからレコードが変更されていないことを確認するために必要です。
GuestSpaceId	String	False	レコードを含むゲストスペースを識別します。接続文字列でプロパティGuestSpaceIdが既に設定されている場合は指定しないでください。

Result Set Columns

Name	Type	Description
Success	String	操作が正常に完了したかどうかをboolean値で返します。
Id	String	ステータスが更新されたレコードのレコードID。
Revision	String	更新後のレコードのリビジョン番号。アクションの実行とステータスの更新が別々の操作としてカウントされるため、2ずつ増加します。

スペース内の既存のディスカッションスレッドを更新し、チームが最新かつ正確なコラボレーション履歴を維持できるようにします。

ストアドプロシージャ固有の情報

Kintone は、Exec クエリでは、大きいカラムサブセットを扱うことを許可していません。これらのカラムは、通常= 比較でのみ使用できます。 次に例を示します。

EXECUTE UpdateThread ThreadId = 13, Name = 'Test Thread', Body = 'This is for testing'

Input

Name	Type	Required	Description
ThreadId	Integer	True	更新するスレッドの識別子。スレッドのURLから取得できます。
Name	String	False	スレッドの新しい表示名。設定すると古い名前を置き換えます。1文字から128文字で指定する必要があり、シングルスレッドのみをサポートするスペースでは使用できません。
Body	String	False	スレッド本文の更新されたHTMLまたはテキストコンテンツ。既存のスレッドの説明またはディスカッションヘッダーを置き換えます。

Result Set Columns

Name	Type	Description
Success	String	操作が正常に完了したかどうかをboolean値で返します。

Cloud はKintone USER API をリレーショナルビューとしてモデル化します。

ビュー

Cloud は、User、UserGroups、UserDepartments の情報をビューにモデル化します。

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Kintone ビュー

Name	Description
UserDepartments	Returns the departments a user belongs to along with related job title information, supporting organizational mapping and identity management.
UserGroups	Returns the groups associated with a user so you can understand their access rights and collaborative relationships across the system.
Users	Returns detailed user profile information from the Cybozu directory to support identity synchronization and permission audits.

Returns the departments a user belongs to along with related job title information, supporting organizational mapping and identity management.

Select

WHERE 句では、UserCode カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM UserDepartments where UserCode = 'loginname';

Columns

Name	Type	References	Description
OrganizationId [KEY]	Long		Unique identifier for the department, used to link department records to related organizational data.
TitleId [KEY]	Long		Unique identifier for the job title, allowing you to associate users or roles with a specific title.
OrganizationCode	String		Code assigned to the department, typically used for internal categorization or external system references.
OrganizationName	String		Primary display name of the department as it appears in the organization's directory.
OrganizationLocalName	String		Localized display name of the department for regions or languages that require a translated label.
OrganizationLocalNameLocale	String		Locale code indicating the language or region associated with the department's localized name.
OrganizationParentCode	String		Code of the department's parent unit to help model the organizational hierarchy. If the value is 'null', it indicates a root-level department.
OrganizationDescription	Longvarchar		Text description that provides additional context about the department's responsibilities or purpose.
TitleCode	String		Internal or external reference code assigned to the job title for classification or system integration.
TitleName	String		Human-readable name of the job title used in employee profiles and organizational charts.
TitleDescription	Longvarchar		Text description explaining the scope, responsibilities, or role of the job title.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
UserCode	String		Login name associated with the user, used to identify the user when querying related records.

Returns the groups associated with a user so you can understand their access rights and collaborative relationships across the system.

Select

WHERE 句では、UserCode カラムが必須です。Cloud はKintone API を使用してこのカラムによる結果をフィルタリングします。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM UserGroups where UserCode = 'loginname';

Columns

Name	Type	References	Description
GroupId [KEY]	Long		Unique identifier for the group, used to link the group to membership records and permission assignments.
GroupCode	String		Internal reference code assigned to the group for classification or integration with external systems.
GroupName	String		Display name of the group as it appears in user directories and access management tools.
GroupDescription	Longvarchar		Text description that outlines the purpose, role, or membership characteristics of the group.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
UserCode	String		Login name associated with the user, used to identify which user belongs to the group when querying relationships.

Returns detailed user profile information from the Cybozu directory to support identity synchronization and permission audits.

Select

Cloud はKintone API を使用してサポート対象のフィルタを処理します。デフォルトでは、Cloud はクライアント側でCloud 内で他のフィルタを処理します。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Users where id = 1;
SELECT * FROM Users where id in (1,2);
SELECT * FROM Users where Code = 'loginname';
SELECT * FROM Users where code in ('loginname1','loginname2');

Columns

Name	Type	References	Description
Id [KEY]	Long		Unique identifier for the user, used to reference the user across related records and organizational structures.
Code	String		Login name associated with the user, used for authentication and identifying the user in queries.
CreatedTime	Datetime		Date and time when the user account was first created, supporting audit and lifecycle tracking.
UpdatedTime	Datetime		Date and time when the user account was last modified, helping track profile updates or administrative changes.
Valid	Boolean		Indicates whether the user's status is active, allowing systems to filter out deactivated or archived accounts.
Name	String		Primary display name of the user as it appears in directories and user-facing applications.
SurName	String		Family name of the user, typically used in formal identification and directory listings.
GivenName	String		First name of the user, representing the personal portion of the user's full name.
SurNameReading	String		Phonetic reading of the user's family name, supporting pronunciation guidance in languages that require it.
GivenNameReading	String		Phonetic reading of the user's first name, helping ensure accurate pronunciation in supported locales.
LocalName	String		Localized version of the user's display name for regions or languages that require translation or adaptation.
LocalNameLocale	String		Locale code indicating the language or region associated with the user's localized display name.
Timezone	String		Identifier of the time zone configured for the user, ensuring correct scheduling and timestamp alignment.
Locale	String		Language preference set for the user, influencing UI display and formatting behavior.
Description	Longvarchar		The user's profile description or About Me text, often used to share background information or role context.
Phone	String		Primary phone number associated with the user for contact or directory purposes.
MobilePhone	String		Mobile phone number of the user, used for direct communication or multi-factor verification.
ExtensionNumber	String		Internal extension assigned to the user for office or system-based telecommunications.
Email	String		Email address of the user, serving as a primary communication channel and identifier.
SkypeID	String		Skype identifier associated with the user for messaging or online collaboration.
Url	String		Profile URL field where the user can include a personal or work-related link.
EmployeeNumber	String		Employee number assigned to the user for internal tracking, payroll, or Human Resources (HR) systems.
BirthDate	Datetime		Birth date of the user, used for administrative records or compliance requirements.
JoinDate	Datetime		Hire date of the user, supporting tenure tracking, HR records, and onboarding workflows.
PrimaryOrganization	Integer		Identifier of the user's primary department. If the value is 'null', there is no designated primary assignment.
SortOrder	Integer		Display order value used to control how the user appears in sorted lists or organizational views.
CustomItemValues	String		List of custom field name and code pairs, representing extended profile attributes defined by the organization.

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Kintone のデータベースメタデータを返します。

• sys_catalogs：利用可能なデータベースをリスト。
• sys_schemas：利用可能なスキーマをリスト。
• sys_tables：利用可能なテーブルおよびビューをリスト。
• sys_tablecolumns：利用可能なテーブルおよびビューのカラムについて説明。
• sys_procedures：利用可能なストアドプロシージャについて説明。
• sys_procedureparameters：ストアドプロシージャパラメータについて説明。
• sys_keycolumns：主キーおよび外部キーについて説明。
• sys_indexes：利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

• sys_connection_props：利用可能な接続プロパティについての情報を返す。
• sys_sqlinfo：Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリ（バッチ処理を含む）のクエリ統計を返します。

• sys_identity：バッチ処理または単一の更新に関する情報を返す。

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	データベース名。

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	データベース名。
SchemaName	String	スキーマ名。

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベース。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	テーブル名またはビュー名。
TableType	String	テーブルの種類（テーブルまたはビュー）。
Description	String	テーブルまたはビューの説明。
IsUpdateable	Boolean	テーブルが更新可能かどうか。

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Comments テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Comments' 

Columns

Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベースの名前。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	カラムを含むテーブルまたはビューの名前。
ColumnName	String	カラム名。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	カラムのストレージサイズ。
DisplaySize	Int32	指定されたカラムの通常の最大幅（文字数）。
NumericPrecision	Int32	数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	カラムのスケール（小数点以下の桁数）。
IsNullable	Boolean	カラムがNull を含められるかどうか。
Description	String	カラムの簡単な説明。
Ordinal	Int32	カラムのシーケンスナンバー。
IsAutoIncrement	String	カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn	String	生成されたカラムであるかどうか。
IsHidden	Boolean	カラムが非表示かどうか。
IsArray	Boolean	カラムが配列かどうか。
IsReadOnly	Boolean	カラムが読み取り専用かどうか。
IsKey	Boolean	sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType	String	スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベース。
SchemaName	String	ストアドプロシージャを含むスキーマ。
ProcedureName	String	ストアドプロシージャの名前。
Description	String	ストアドプロシージャの説明。
ProcedureType	String	PROCEDURE やFUNCTION などのプロシージャのタイプ。

ストアドプロシージャパラメータについて説明します。

次のクエリは、DownloadFile ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'DownloadFile' AND Direction = 1 OR Direction = 2

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'DownloadFile' AND IncludeResultColumns='True'

Columns

Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベースの名前。
SchemaName	String	ストアドプロシージャを含むスキーマの名前。
ProcedureName	String	パラメータを含むストアドプロシージャの名前。
ColumnName	String	ストアドプロシージャパラメータの名前。
Direction	Int32	パラメータのタイプに対応する整数値：input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName	String	データ型の名前。
NumericPrecision	Int32	数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ（文字数）。
Length	Int32	文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale	Int32	数値データの小数点以下の桁数。
IsNullable	Boolean	パラメータがNull を含められるかどうか。
IsRequired	Boolean	プロシージャの実行にパラメータが必要かどうか。
IsArray	Boolean	パラメータが配列かどうか。
Description	String	パラメータの説明。
Ordinal	Int32	パラメータのインデックス。
Values	String	このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams	Boolean	パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath	Boolean	パラメータがスキーマ作成操作のターゲットパスかどうか。
Default	String	何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName	String	複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided	Boolean	プロシージャがネイティブのKintone プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

Name	Type	Description
IncludeResultColumns	Boolean	出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

主キーおよび外部キーについて説明します。

次のクエリは、Comments テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Comments' 
          

Columns

Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
IsKey	Boolean	カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey	Boolean	カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前	タイプ	説明
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。
ForeignKeyType	String	外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前。
KeySeq	String	主キーのシーケンス番号。
KeyName	String	主キーの名前。

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	インデックスを含むデータベースの名前。
SchemaName	String	インデックスを含むスキーマの名前。
TableName	String	インデックスを含むテーブルの名前。
IndexName	String	インデックス名。
ColumnName	String	インデックスに関連付けられたカラムの名前。
IsUnique	Boolean	インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary	Boolean	インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type	Int16	インデックスタイプに対応する整数値：statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder	String	並べ替え順序：A が昇順、D が降順。
OrdinalPosition	Int16	インデックスのカラムのシーケンスナンバー。

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	接続プロパティ名。
ShortDescription	String	簡単な説明。
Type	String	接続プロパティのデータ型。
Default	String	明示的に設定されていない場合のデフォルト値。
Values	String	可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value	String	設定した値またはあらかじめ設定されたデフォルト。
Required	Boolean	プロパティが接続に必要かどうか。
Category	String	接続プロパティのカテゴリ。
IsSessionProperty	String	プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity	String	プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName	String	キャメルケースの短縮形の接続プロパティ名。
Ordinal	Int32	パラメータのインデックス。
CatOrdinal	Int32	パラメータカテゴリのインデックス。
Hierarchy	String	このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible	Boolean	プロパティが接続UI に表示されるかどうかを通知します。
ETC	String	プロパティに関するその他のさまざまな情報。

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前	説明	有効な値
AGGREGATE_FUNCTIONS	サポートされている集計関数。	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	COUNT 関数がサポートされているかどうか。	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	識別子をエスケープするための開始文字。	[
IDENTIFIER_QUOTE_CLOSE_CHAR	識別子をエスケープするための終了文字。	]
SUPPORTED_OPERATORS	サポートされているSQL 演算子。	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	サポートされている外部結合の種類。	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	外部結合がサポートされているかどうか。	YES, NO
SUBQUERIES	サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	サポートされている文字列関数。	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	サポートされている数値関数。	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	サポートされている日付および時刻関数。	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	レプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNS	レプリケーション中に更新判断のカラムとして使用するかどうかを、（指定された順に）チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN	識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTION	プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。	YES, NO
DIALECT	使用するSQL ダイアレクトを示します。
KEY_PROPERTIES	Uniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMAS	プロバイダー用に複数のスキームが存在するかどうかを示します。	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	プロバイダー用に複数のカタログが存在するかどうかを示します。	YES, NO
DATASYNCVERSION	このドライバーにアクセスするために必要な、CData Sync のバージョン。	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	このドライバーのCData Sync カテゴリ。	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	API で提供されている以上の、追加SQL 機能がサポートされているかどうか。	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	バッチ操作がサポートされているかどうか。	YES, NO
SQL_CAP	このドライバーでサポートされているすべてのSQL 機能。	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERY	ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。	YES, NO
PSEUDO_COLUMNS	利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS	値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	レプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTION	サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATE	レプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERY	レプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTION	サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTID	CheckCache 構文を親キーカラムに対して実行するかどうかを示します。	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	スキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name	Type	Description
NAME	String	SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE	String	サポートされるSQL またはSQL 構文の詳細。

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	データ変更処理から返された、データベース生成Id。
Batch	String	バッチの識別子。1 は単一処理。
Operation	String	バッチ内の処理の結果：INSERTED、UPDATED、またはDELETED。
Message	String	SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	製品名。
Version	String	製品のバージョン番号。
Datasource	String	製品が接続するデータソースの名前。
NodeId	String	製品がインストールされているマシンの固有識別子。
HelpURL	String	製品のヘルプドキュメントのURL。
License	String	製品のライセンス情報。（この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。）
Location	String	製品のライブラリが格納されているファイルパスの場所。
Environment	String	製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersion	String	本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategory	String	CData Sync 機能のカテゴリ（例：Source、Destination）。

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication

---

プロパティ	説明
AuthScheme	Kintone にUser / Password、APIToken、OAuth のどれで接続するか。
URL	Kintone URL。次に例を示します。 https://SUBDOMAIN_NAME.cybozu.com
Schema	使用するKintone API のバージョンを指定します。
User	認証するユーザーのユーザーID を指定します。
Password	認証するユーザーのパスワードを指定します。
BasicAuthUser	Basic 認証を使用するドメインに必要な追加のユーザー名。
BasicAuthPassword	Basic 認証を使用するドメインに必要な追加のパスワード。
AppId	認証時にAPI トークンとともに使用するアプリID。
APIToken	認証時に使用するAPI トークン。

OAuth

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecret	カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）
Scope	データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。

Logging

---

プロパティ	説明
Verbosity	ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema

---

プロパティ	説明
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous

---

プロパティ	説明
AllowSpecialCharacters	特殊文字を許容するかどうかを決定します。True の場合、特殊文字は置き換えられません。
CheckForSubtablesIn	サブテーブルを取得するKintone アプリのカンマ区切りリスト。
GuestSpaceId	クエリ結果をゲストスペースに制限します。
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
NumberMapToDouble	数値フィールドのデータ型をdecimal からdouble に変更するかどうかを決定します。
Pagesize	provider がKintone にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
SubtableIdAsLong	サブテーブルのId カラムでLong データ型を使用するかどうかを指定します。
SubtableSeparatorCharacter	tablename + char + subtable 形式のサブテーブルからテーブルを分割するために使用される文字。
TableNameMode	各AppId の動的テーブル識別子。
ThrowsKeyNotFound	更新された行がない場合に例外をスローするかどうかを指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseCodeForFieldName	フィールド名にLabel かCode のどちらを使用するかを決定します。
UseCursor	カーソルを使用してレコードを取得するかどうかを決定するboolean。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを指定します。
UseUnitForNumericField	フィールド名に単位を表示するかどうかを決定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

---

プロパティ	説明
AuthScheme	Kintone にUser / Password、APIToken、OAuth のどれで接続するか。
URL	Kintone URL。次に例を示します。 https://SUBDOMAIN_NAME.cybozu.com
Schema	使用するKintone API のバージョンを指定します。
User	認証するユーザーのユーザーID を指定します。
Password	認証するユーザーのパスワードを指定します。
BasicAuthUser	Basic 認証を使用するドメインに必要な追加のユーザー名。
BasicAuthPassword	Basic 認証を使用するドメインに必要な追加のパスワード。
AppId	認証時にAPI トークンとともに使用するアプリID。
APIToken	認証時に使用するAPI トークン。

Kintone にUser / Password、APIToken、OAuth のどれで接続するか。

Possible Values

Password, APIToken, OAuth

データ型

string

デフォルト値

"Password"

解説

• Password：パスワード認証を実行する場合に設定。
• APIToken：APIToken 認証を実行する場合に設定。
• OAuth：OAuth 2.0 認証を実行する場合に設定。

Kintone URL。次に例を示します。 https://SUBDOMAIN_NAME.cybozu.com

データ型

string

デフォルト値

""

解説

Kintone URL。次に例を示します。

https://SUBDOMAIN_NAME.cybozu.com

使用するKintone API のバージョンを指定します。

Possible Values

Kintone, CybozuUser

データ型

string

デフォルト値

"Kintone"

解説

使用するKintone のAPI バージョンを以下から選択します：

• Kintone REST API の場合は、Kintone。
• Kintone USER API の場合は、CybozuUser。

認証するユーザーのユーザーID を指定します。

データ型

string

デフォルト値

""

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

認証するユーザーのパスワードを指定します。

データ型

string

デフォルト値

""

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

Basic 認証を使用するドメインに必要な追加のユーザー名。

データ型

string

デフォルト値

""

解説

Basic 認証が有効なドメインに接続するために使用するBasic 認証のユーザー名。Basic 認証は2段階認証です。Basic 認証を使用するドメインに接続する場合は、User とPassword に加えてBasicAuthUser とBasicAuthPassword を設定します。

Basic 認証を使用するドメインに必要な追加のパスワード。

データ型

string

デフォルト値

""

解説

Basic 認証が有効なドメインに接続するために使用するBasic 認証のパスワード。Basic 認証は2段階認証です。Basic 認証を使用するドメインに接続する場合は、User とPassword に加えてBasicAuthUser とBasicAuthPassword を設定します。

認証時にAPI トークンとともに使用するアプリID。

データ型

string

デフォルト値

""

解説

AppId は、kintone UI ダッシュボードの［アプリ］の下にあるシーケンス内の特定のアプリの番号です。

AppId をカンマ区切りで複数指定することもできます。

認証時に使用するAPI トークン。

データ型

string

デフォルト値

""

解説

認証時に使用するAPI トークン。API トークンを作成するには、API トークンを作成する特定のアプリにアクセスして歯車アイコンをクリックします。［アプリの設定］->［設定］タブ->［APIトークン］に進み、［生成する］ボタンをクリックすると、API トークンが生成されます。

また、Lookup フィールドやRelated Record フィールドを含む操作の場合は、APIToken をカンマ区切りで複数指定することができます。

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecret	カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）
Scope	データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。

カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります：

• カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
• ドライバーが埋め込みOAuth 資格情報を提供しない場合。

（ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。）

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）

データ型

string

デフォルト値

""

解説

このプロパティ（アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます）は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes：

• この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
• クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。

データ型

string

デフォルト値

""

解説

スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。

InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。

InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、このプロパティまたはScope 入力を使用して、要求するスコープを変更できます。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
Verbosity	ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

---

プロパティ	説明
AllowSpecialCharacters	特殊文字を許容するかどうかを決定します。True の場合、特殊文字は置き換えられません。
CheckForSubtablesIn	サブテーブルを取得するKintone アプリのカンマ区切りリスト。
GuestSpaceId	クエリ結果をゲストスペースに制限します。
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
NumberMapToDouble	数値フィールドのデータ型をdecimal からdouble に変更するかどうかを決定します。
Pagesize	provider がKintone にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
SubtableIdAsLong	サブテーブルのId カラムでLong データ型を使用するかどうかを指定します。
SubtableSeparatorCharacter	tablename + char + subtable 形式のサブテーブルからテーブルを分割するために使用される文字。
TableNameMode	各AppId の動的テーブル識別子。
ThrowsKeyNotFound	更新された行がない場合に例外をスローするかどうかを指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseCodeForFieldName	フィールド名にLabel かCode のどちらを使用するかを決定します。
UseCursor	カーソルを使用してレコードを取得するかどうかを決定するboolean。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを指定します。
UseUnitForNumericField	フィールド名に単位を表示するかどうかを決定します。

特殊文字を許容するかどうかを決定します。True の場合、特殊文字は置き換えられません。

データ型

bool

デフォルト値

false

解説

特殊文字を許容するかどうかを決定します。True の場合、特殊文字は置き換えられません。

サブテーブルを取得するKintone アプリのカンマ区切りリスト。

データ型

string

デフォルト値

"*"

解説

すべてのKintone アプリのサブテーブルを確認するには、このフィールドを* に設定します。サブテーブルを検索しない場合は、このフィールドを'None' に設定します。Kintone サブテーブルは別々のテーブルとして公開されており、API からすべてのサブテーブルのリストを取得するのは時間がかかります。この フィールドにいくつかのアプリ名のみを指定することで、Cloud のパフォーマンスが向上します。このフィールドを* に設定して、すべてのKintone アプリのサブテーブルを確認することもできますが、アプリ数が多い場合はテーブルをリストするにははるかに時間がかかります。

クエリ結果をゲストスペースに制限します。

データ型

string

デフォルト値

""

解説

この接続プロパティは、クエリ結果を指定したゲストスペースに制限します。

GuestSpaceId は、Apps テーブルのSpaceId カラムにあるCloud で確認できます。あるいは、作成したスペースに移動するときにURL からGuestSpaceId を取得します。例えば、次のURL では、GuestSpaceId は"3" になります。

https://xlqc1.cybozu.com/k/guest/3/#/space/3/thread/3

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 （クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。）

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

数値フィールドのデータ型をdecimal からdouble に変更するかどうかを決定します。

データ型

bool

デフォルト値

false

解説

数値フィールドのデータ型をdecimal からdouble に変更するかどうかを決定します。True に設定すると、データ型がdecimal からdouble に変更されます。

provider がKintone にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。

データ型

int

デフォルト値

500

解説

クエリを処理する際、Kintone でクエリされたデータすべてを一度にリクエストする代わりに、Cloud はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。

この接続プロパティは、Cloud がページごとにリクエストする結果の最大数を決定します。

Note：大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にCloud がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。