このページでは、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	kintone で利用可能なコメントをクエリします。
FieldPermissions	kintone の利用可能なフィールドのアクセス権の設定を更新およびクエリします。
FormFields	kintone のフォームフィールドを作成、更新、削除、クエリします。
FormLayout	kintone で利用可能なフォームのレイアウトを更新およびクエリします。
GeneralNotifications	kintone で利用可能なアプリの条件通知の設定を更新およびクエリします。
GeneralSettings	kintone の一般設定を更新およびクエリします。
GraphSettings	kintone の利用可能なグラフの設定を更新およびクエリします。
PerRecordNotifications	kintone の利用可能なレコードの条件通知の設定を更新およびクエリします。
ProcessManagement	kintone のプロセス管理を更新およびクエリします。
RecordPermissions	kintone の利用可能なレコードのアクセス権の設定を更新およびクエリします。
ReminderNotifications	kintone の利用可能なリマインダーの条件通知を更新およびクエリします。
SampleApp	サンプルアプリ：顧客管理（営業支援パック）
SampleApp_Table	サンプルアプリ：顧客管理（営業支援パック）明細テーブル
Space	kintone の利用可能なスペースを更新、削除、クエリします。
SpaceMembers	kintone の利用可能なスペースのメンバーを更新およびクエリします。
Views	kintone で利用可能な一覧の設定を更新およびクエリします。

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		アクションID。
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	False に設定することで、運用環境のアプリのアクション設定の詳細を取得することができます。デフォルト値はtrue です。
Actions	String	Update の実行にのみ使用されます。

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	False に設定することで、運用環境のアプリのアクセス権の設定の詳細を取得することができます。デフォルト値はtrue です。
Rights	String	Update の実行にのみ使用されます。

kintone で利用可能なコメントをクエリします。

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		コメントID。
AppId [KEY]	Integer	False		アプリID。
RecordId [KEY]	Integer	False		レコードID。
Text	String	False		改行コードを含むコメント。
CreatorCode	String	True		コメント作成者のユーザーコード（ログイン名）。
CreatorName	String	True		コメント作成者のユーザー名（表示名）。
CreatedAt	Datetime	True		コメントの作成日時。
MentionsAggregate	String	False		メンションされたユーザーの情報を含む配列。

kintone の利用可能なフィールドのアクセス権の設定を更新およびクエリします。

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	False に設定することで、運用環境のアプリのFieldPermissions の詳細を取得することができます。デフォルト値はtrue です。
Rights	String	Update の実行にのみ使用されます。

kintone のフォームフィールドを作成、更新、削除、クエリします。

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		フィールドのリンクの種類。
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	False に設定することで、運用環境のアプリのフォームフィールドの詳細を取得することができます。デフォルト値はtrue です。
Properties	String	Insert またはUpdate の実行にのみ使用されます。

kintone で利用可能なフォームのレイアウトを更新およびクエリします。

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	False に設定することで、運用環境のアプリのフォームのレイアウトの詳細を取得することができます。デフォルト値はtrue です。
Layout	String	Insert またはUpdate の実行にのみ使用されます。

kintone で利用可能なアプリの条件通知の設定を更新およびクエリします。

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	False に設定することで、運用環境のアプリのGeneralNotifications の詳細を取得することができます。デフォルト値はtrue です。
Notifications	String	Update の実行にのみ使用されます。

kintone の一般設定を更新およびクエリします。

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		アイコンの種類：FILE、PRESET。
IconFile	String	False		アップロードされたアイコンファイルのデータを含むオブジェクト。
Name	String	False		アプリ名。
Description	String	False		アプリの説明。HTML 形式で出力されます。
Theme	String	False		デザインテーマ。
Revision	String	True		アプリの設定のリビジョン番号。
TitleFieldSelectionMode	String	False		レコードのタイトルとして利用するフィールドの選択方法：AUTO、MANUAL。
TitleFieldCode	String	False		レコードのタイトルとして利用するフィールドのフィールドコード。
EnableBulkDeletion	Boolean	False		レコード一括削除を有効にするかどうか。
EnableComments	Boolean	False		レコードのコメント機能を有効にするかどうか。
EnableDuplicateRecord	Boolean	False		「レコードを再利用する」機能を有効にするかどうか。
EnableThumbnails	Boolean	False		サムネイルを表示するかどうか。
FirstMonthOfFiscalYear	Integer	False		第一四半期の開始月。1から12までの整数が返ります。
NumberPrecisionDecimalPlaces	Integer	False		小数部の桁数。0から10までの整数が返ります。
NumberPrecisionDigits	Integer	False		全体の桁数。
NumberPrecisionRoundingMode	String	False		数値の丸めかた：HALF_EVEN、UP、DOWN。
EnableInlineRecordEditing	Boolean	False		レコード一覧でのインライン編集を有効にするかどうか。

Pseudo-Columns

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

Name	Type	Description
Lang	String	取得する名称の言語。
IsPreview	Boolean	False に設定することで、運用環境のアプリの一般設定の詳細を取得することができます。デフォルト値はtrue です。

kintone の利用可能なグラフの設定を更新およびクエリします。

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		グラフID。
Index	String	False		グラフの並び順。0 から始まります。
Name	String	False		グラフ名。64 文字以下で指定します。lang を指定した場合は、API を実行するユーザーの表示言語の名称が返ります。
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	False に設定することで、運用環境のアプリのグラフの設定の詳細を取得することができます。デフォルト値はtrue です。
Reports	String	Update の実行にのみ使用されます。

kintone の利用可能なレコードの条件通知の設定を更新およびクエリします。

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		通知内容。
Targets	String	False		通知先の対象の一覧。
Revision	String	True		アプリの設定のリビジョン番号。

Pseudo-Columns

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

Name	Type	Description
Lang	String	取得する名称の言語。
IsPreview	Boolean	False に設定することで、運用環境のアプリのPerRecordNotifications の詳細を取得することができます。デフォルト値はtrue です。
Notifications	String	Update の実行にのみ使用されます。

kintone のプロセス管理を更新およびクエリします。

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		アクションの情報の一覧。並び順はGUI と同じです。プロセス管理を一度も設定していないアプリの場合は「null」が返ります。
Revision	String	True		アプリの設定のリビジョン番号。
Name	String	False		ステータス名。
Index	String	False		ステータスの順番。昇順で並べ替えられます。
AssigneeType	String	False		ステータスの作業者のタイプ。
AssigneeEntities	String	False		ステータスの作業者の一覧。並び順はGUI と同じです。

Pseudo-Columns

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

Name	Type	Description
Lang	String	取得する名称の言語。
IsPreview	Boolean	False に設定することで、運用環境のアプリのProcess Management の詳細を取得することができます。デフォルト値はtrue です。
States	String	Update の実行にのみ使用されます。

kintone の利用可能なレコードのアクセス権の設定を更新およびクエリします。

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	False に設定することで、運用環境のアプリのRecordPermissions の詳細を取得することができます。デフォルト値はtrue です。
Rights	String	Update の実行にのみ使用されます。

kintone の利用可能なリマインダーの条件通知を更新およびクエリします。

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		リマインダーの条件通知で通知される内容。
TimingCode [KEY]	String	False		通知のタイミングの基準日時となるフィールドのフィールドコード。
TimingDaysLater	Integer	False		基準日時notifications[].timing.code date/datetime から何日前または何日後に通知するか。基準日時より前に通知する場合は、負の整数が返ります。
TimingHoursLater	Integer	False		基準日時notifications[].timing.code datetime に timing.daysLater を足した日時から、何時間後または何時間前に通知するか。
TimingTime	String	False		基準日時にtiming.daysLater を足した日付から、いつ通知するか。このパラメータは、notifications[].timing.code パラメータに日付フィールドを設定しているか、notifications[].timing.code に日時を表すフィールドを指定し「絶対時刻を指定」が設定されている場合に返されます。
Targets	String	False		リマインダーの通知先の対象の一覧。
Revision	String	True		アプリの設定のリビジョン番号。
Timezone	String	False		リマインドする時刻のタイムゾーン。「リマインド時刻のタイムゾーン」ドロップダウンオプションを反映します。リマインダーの条件通知を一度も設定していないアプリでは「null」が返ります。

Pseudo-Columns

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

Name	Type	Description
Lang	String	取得する名称の言語。
IsPreview	Boolean	False に設定することで、運用環境のアプリのReminder Notifications の詳細を取得することができます。デフォルト値はtrue です。
Notifications	String	Update の実行にのみ使用されます。

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

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		スペースID。
Name	String	False		スペース名。
DefaultThread	String	False		スペースが作成されたときに初期作成されたスレッドのスレッドID。
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）。スペース本文のHTML が空の場合null が返ります。ただし、一度でも本文を設定したことがあるスペースの場合、画面上では何も表示されていなくても、HTML タグのみが設定されている可能性があります。その場合、それらの文字列が返ります。
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	スペースのテンプレートID。新しいスペースを作成する際に必須です。
Members	String	スペースのメンバーの情報の一覧。新しいスペースを作成する際に必須です。少なくとも1人のスペース管理者を指定する必要があります。使用停止中のユーザーおよび削除したユーザーは指定できません。

kintone の利用可能なスペースのメンバーを更新およびクエリします。

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		スペースID。
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人のスペース管理者を指定する必要があります。使用停止中のユーザーおよび削除したユーザーは指定できません。

kintone で利用可能な一覧の設定を更新およびクエリします。

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		一覧のID。
AppId	Integer	False		kintone アプリケーションのアプリID。
Index	String	False		一覧の表示順（昇順）。
Name	String	False		一覧名。
Title	String	False		タイトルとして使用するフィールドのフィールドコード。一覧の表示形式が「CALENDAR」の場合に返ります。
Type	String	False		一覧の表示形式。 使用できる値は次のとおりです。LIST, CALENDAR, CUSTOM
BuiltinType	String	False		一覧名が「（作業者が自分）」の場合のみ出力されるプロパティ。「ASSIGNEE」が返ります。
Date	String	False		日付として使用するフィールドのフィールドコード。一覧の表示形式が「CALENDAR」の場合に返ります。
Fields	String	False		表示するフィールドのフィールドコードの一覧。
FilterCond	String	False		レコードの絞り込み条件。クエリ形式で表されます。
Html	String	False		カスタマイズに使用するHTML の内容。一覧の表示形式が「CUSTOM」の場合に返ります。
Pager	Boolean	False		ページネーションを表示するかどうか。一覧の表示形式が「CUSTOM」の場合に返ります。
Device	String	False		一覧を表示する範囲。
Sort	String	False		レコードのソート条件。クエリ形式で表されます。
Revision	String	True		アプリの設定のリビジョン番号。

Pseudo-Columns

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

Name	Type	Description
Lang	String	取得する名称の言語。
IsPreview	Boolean	False に設定することで、運用環境のアプリのViews の詳細を取得することができます。デフォルト値はtrue です。
Views	String	Update の実行にのみ使用されます。

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

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

CData Cloud - Kintone ビュー

Name	Description
ActionSettingsEntities	kintone で利用可能なアクション設定のアクションを利用するメンバーの一覧をクエリします。
ActionSettingsMappings	kintone で利用可能なアクション設定のフィールドの関連付けの一覧をクエリします。
Apps	kintone で利用可能なアプリをクエリします。
FieldPermissionsEntities	kintone のフィールドのアクセス権の設定の対象をクエリします。
FormLayoutFields	kintone で利用可能なフォームのレイアウトの行に含まれるフィールドの一覧をクエリします。
PerRecordNotificationsTargets	kintone のレコードの条件通知先の対象をクエリします。
ProcessManagementActions	kintone のプロセス管理のアクションの情報の一覧をクエリします。
RecordPermissionsEntities	kintone の利用可能なレコードのアクセス権の設定の対象をクエリします。
ReminderNotificationsTargets	kintone の利用可能なリマインダーの条件通知先の対象の一覧をクエリします。

kintone で利用可能なアクション設定のアクションを利用するメンバーの一覧をクエリします。

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		アクションID。
Code	String		アクションが許可されているエンティティのコード。ゲストユーザーの場合、ログイン名の頭に「guest/」が付きます。
Type	String		アクションが許可されているエンティティの種類。 使用できる値は次のとおりです。USER, GROUP, ORGANIZATION
Revision	String		アプリの設定のリビジョン番号。

Pseudo-Columns

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

Name	Type	Description
Lang	String		取得する名称の言語。
IsPreview	Boolean		False に設定することで、運用環境のアプリのアクション設定の詳細を取得することができます。デフォルト値はtrue です。

kintone で利用可能なアクション設定のフィールドの関連付けの一覧をクエリします。

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		アクションID。
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		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		アプリの名前。ローカライズの設定が使われている場合、このカラムはこのAPI を使用しているkintone ユーザーの言語設定に従ってローカライズされた名前を返します。
Description	String		アプリの説明。ローカライズの設定が使われている場合、このカラムはこのAPI を使用しているkintone ユーザーの言語設定に従ってローカライズされたアプリの説明を返します。
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。

kintone のフィールドのアクセス権の設定の対象をクエリします。

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		アプリケーションのアプリID。
Code [KEY]	String		アクセス権を設定するフィールドコード。
EntityType	String		アクセス権の設定対象の種類。
EntityCode	String		アクセス権の設定対象のコード。
Accessibility	String		フィールドに対して可能な操作。 使用できる値は次のとおりです。READ, WRITE, NONE
IncludeSubs	Boolean		設定を下位組織に継承するかどうか。

Pseudo-Columns

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

Name	Type	Description
IsPreview	Boolean		False に設定することで、運用環境のアプリのFieldPermissions の詳細を取得することができます。デフォルト値はtrue です。

kintone で利用可能なフォームのレイアウトの行に含まれるフィールドの一覧をクエリします。

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	String		ラベル名。ラベルフィールドでのみ出力されます。
Width	String		ピクセル単位でのフィールドの横幅。
Height	String		フィールド名を含めた、ピクセル単位でのフィールドの縦幅。
InnerHeight	String		フィールド名を除いた、ピクセル単位でのフィールドの縦幅。

Pseudo-Columns

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

Name	Type	Description
IsPreview	Boolean		False に設定することで、運用環境のアプリのフォームのレイアウトの詳細を取得することができます。デフォルト値はtrue です。

kintone のレコードの条件通知先の対象をクエリします。

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		False に設定することで、運用環境のアプリのPerRecord Notifications Targets の詳細を取得することができます。デフォルト値はtrue です。

kintone のプロセス管理のアクションの情報の一覧をクエリします。

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		False に設定することで、運用環境のアプリのProcess Management Actions の詳細を取得することができます。デフォルト値はtrue です。

kintone の利用可能なレコードのアクセス権の設定の対象をクエリします。

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		False に設定することで、運用環境のアプリのRecord Permissions Entities の詳細を取得することができます。デフォルト値はtrue です。

kintone の利用可能なリマインダーの条件通知先の対象の一覧をクエリします。

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		アプリケーションのアプリID。
TimingCode [KEY]	String		通知のタイミングの基準日時となるフィールドのフィールドコード。
EntityType	String		リマインダーの通知先の対象の種類。
EntityCode	String		リマインダーの通知先の対象のコード。
IncludeSubs	Boolean		設定を下位組織に継承するかどうか。entity.type が「ORGANIZATION」か、「FIELD_ENTITY」で組織選択フィールドが指定されている場合のみ「false」が返ります。

Pseudo-Columns

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

Name	Type	Description
Lang	String		取得する名称の言語。
IsPreview	Boolean		False に設定することで、運用環境のアプリのReminder Notifications Targets の詳細を取得することができます。デフォルト値はtrue です。

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

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

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

Name	Description
AddGuests	kintone にゲストユーザーを追加します。この場合、ゲストユーザーはゲストスペースに所属せず、招待メールも送信されません。ゲストユーザーをゲストスペースに関連付けるには、AddGuestsToSpace ストアドプロシージャを使用します。このAPI はkintone システム管理者のみが使用できます。
AddGuestsToSpace	ゲストスペースにゲストユーザーを追加します。このAPI はスペース管理者のみが使用できます。
AddThreadComment	スペースのスレッドにコメントを投稿します。
AppsDeployStatus	アプリの展開ステータスを取得します。
CreateApp	アプリを作成します。
DeleteGuests	ゲストユーザーをkintone から削除します。このAPI はkintone システム管理者のみが使用できます。
DeployApps	アプリをデプロイします。
UpdateAssignees	アサイニーを更新します。
UpdateStatus	アプリのレコードのステータスを更新します。
UpdateThread	スペースのスレッドを更新します。

kintone にゲストユーザーを追加します。この場合、ゲストユーザーはゲストスペースに所属せず、招待メールも送信されません。ゲストユーザーをゲストスペースに関連付けるには、AddGuestsToSpace ストアドプロシージャを使用します。このAPI は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、ja、en、zh です。指定がない場合、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	ゲストの集計。

Result Set Columns

Name	Type	Description
Success	String	この値は、操作が成功したかどうかをboolean で示します。

ゲストスペースにゲストユーザーを追加します。このAPI はスペース管理者のみが使用できます。

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

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 で示します。

アプリの展開ステータスを取得します。

Input

Name	Type	Required	Description
AppIds	String	True	アプリのID。ID のカンマ区切りリストの場合もあります。
GuestSpaceId	String	False	このパラメータは、ゲストスペース内のアプリで使用します。接続文字列にプロパティGuestSpaceId が指定されている場合は、このパラメータを追加しないでください。

Result Set Columns

Name	Type	Description
AppId	String	アプリのID。
Status	String	アプリのステータス。

アプリを作成します。

Input

Name	Type	Required	Description
Name	String	True	アプリケーションの名前を64文字未満で指定します。
Space	String	False	スペースのID。接続文字列にプロパティGuestSpaceId が設定されている場合は、このパラメータを指定しないでください。
ThreadId	String	False	スレッドのID。これはSpace パラメータ、または接続プロパティ内のGuestSpaceId が指定されている場合は、必須です。
IsGuestSpace	Boolean	False	これは、Space パラメータが通常のスペースかゲストスペースかを示すboolean 値です。true に設定するとゲストスペースとして作成します。 デフォルト値はfalseです。

Result Set Columns

Name	Type	Description
AppId	String	アプリのID。
Revision	String	アプリの改訂。
Success	String	処理が成功したかどうかを示すboolean。

ゲストユーザーをkintone から削除します。このAPI はkintone システム管理者のみが使用できます。

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

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

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

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

Input

Name	Type	Required	Description
Guests	String	True	削除するゲストユーザーのメールアドレスの一覧。最大で100 件のゲストを削除できます。

Result Set Columns

Name	Type	Description
Success	String	この値は、操作が成功したかどうかをboolean で示します。

アプリをデプロイします。

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

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

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

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

Input

Name	Type	Required	Description
AppId#	String	True	アプリ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	アプリ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ずつ増加します。これは、アクションの実行およびステータスの更新の2つのオペレーションが実行されるためです。

アプリのレコードのステータスを更新します。

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

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

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

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

Input

Name	Type	Required	Description
AppId	String	True	アプリID。
RecordId#	String	True	レコードID。
Action#	String	True	実行したいアクションの名前。アクションの複数トランザクションの適用にローカリゼーション機能が使われている場合は、API を実行するユーザーの言語設定でアクション名を指定します。
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ずつ増加します。これは、アクションの実行およびステータスの更新の2つのオペレーションが実行されるためです。

スペースのスレッドを更新します。

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

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

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

Input

Name	Type	Required	Description
ThreadId	Integer	True	スレッドID。スレッドID はスレッドのURL で確認できます。
Name	String	False	新しいスレッド名。1文字から128文字まで指定できます。省略すると、スレッド名は更新されません。シングルスレッドスペースのスレッドは、スレッド名が存在しないので更新できません。
Body	String	False	スレッドの本文。

Result Set Columns

Name	Type	Description
Success	String	この値は、操作が成功したかどうかをboolean で示します。

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

ビュー

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

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

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

CData Cloud - Kintone ビュー

Name	Description
UserDepartments	Gets information of Departments that a User belongs to, and Job Title information related to the Department.
UserGroups	Gets information of Groups that a User belongs to.
Users	Gets information of users.

Gets information of Departments that a User belongs to, and Job Title information related to the Department.

Select

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

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

SELECT * FROM UserDepartments where UserCode = 'loginname';

Columns

Name	Type	References	Description
OrganizationId [KEY]	Long		The ID of the Department.
TitleId [KEY]	Long		The ID of the Job Title.
OrganizationCode	String		The Code of the Department.
OrganizationName	String		The display name of the Department.
OrganizationLocalName	String		The localized name of the Department.
OrganizationLocalNameLocale	String		The locale of the localized name of the Department.
OrganizationParentCode	String		The code of the Parent Department. null, if the parent is the Root.
OrganizationDescription	String		The description of the Department.
TitleCode	String		The code of the Job Title.
TitleName	String		The name of the Job Title.
TitleDescription	String		The description of the Job Title.

Pseudo-Columns

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

Name	Type	Description
UserCode	String		The log in name of the User.

Gets information of Groups that a User belongs to.

Select

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

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

SELECT * FROM UserGroups where UserCode = 'loginname';

Columns

Name	Type	References	Description
GroupId [KEY]	Long		The ID of the Group.
GroupCode	String		The code of the Group.
GroupName	String		The display name of the Group.
GroupDescription	String		The description of the Group.

Pseudo-Columns

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

Name	Type	Description
UserCode	String		The log in name of the User.

Gets information of users.

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		The user ID.
Code	String		The log in name of the User.
CreatedTime	Datetime		The created datetime of the User.
UpdatedTime	Datetime		The updated datetime of the User.
Valid	Boolean		If the Status of the user is Active or not.
Name	String		The display name of the User.
SurName	String		The last name of the User.
GivenName	String		The first name of the User.
SurNameReading	String		The phonetic reading of the Last name.
GivenNameReading	String		The phonetic reading of the First name.
LocalName	String		The localized display name of the User.
LocalNameLocale	String		The locale of the localized display name of the User.
Timezone	String		The time zone ID of the user's set time zone.
Locale	String		The language setting of the user.
Description	String		The About Me section of the user's profile.
Phone	String		The phone number of the User.
MobilePhone	String		The mobile phone number of the User.
ExtensionNumber	String		The extension number of the User.
Email	String		The Email address of the User.
SkypeID	String		The Skype ID of the User.
Url	String		The URL section of the user's profile.
EmployeeNumber	String		The Employee Number of the User.
BirthDate	Datetime		The Birthday of the User.
JoinDate	Datetime		The Hire Date of the User.
PrimaryOrganization	Integer		The Department ID of the Priority Department of the User. Set to null if there is no Priority Department.
SortOrder	Integer		The Display Order priority of the User.
CustomItemValues	String		A list of pairs of Custom Field Names and Custom Field Codes.

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

スキーマテーブル

以下のテーブルは、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 の動的テーブル識別子。
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 の動的テーブル識別子。
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 がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください：

*=*