kintoneのREST APIをコールするためのクラス
REST APIについてはサイボウズ公式のドキュメント参照
REST APIについてはサイボウズ公式のドキュメント参照
Inheritance Hierarchy
kintoneDotNET.APIkintoneAPI
Namespace: kintoneDotNET.API
Assembly: kintoneDotNET (in kintoneDotNET.dll) Version: 1.0.4.0 (1.0.4.0)
Syntax
The kintoneAPI type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| kintoneAPI |
アプリケーションIDを指定し、APIの生成を行う
|
Methods
| Name | Description | |
|---|---|---|
| BulkCreateT |
レコード登録を行う(複数件)
| |
| BulkDeleteT |
レコードの削除を行う(複数件)
| |
| BulkSaveT |
レコードの保存処理(複数件)
| |
| BulkUpdateT |
レコードの更新を行う(複数件)
| |
| CreateT |
レコード登録を行う(単一)
| |
| DeleteT |
レコードの削除を行う(単一)
| |
| DownloadFile |
ファイルのダウンロードを行う
| |
| Equals | 指定した Object が、現在の Object と等しいかどうかを判断します。 (Inherited from Object.) | |
| Finalize | Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Inherited from Object.) | |
| FindT(String) |
レコードの検索を行う ※このメソッドは、kintoneのレコード数上限までしか取得を行いません。全件取得する場合はFindAllを使用してください | |
| FindT(kintoneQueryT) | ||
| FindAllT(String) | ||
| FindAllT(kintoneQueryT) |
API上限値を超えたレコードの検索を行う ※並列でリクエストを投げ取得を行うため、order等の指定は考慮されない。データ取得後LINQ等で並び替えを行う必要あり | |
| GetHashCode | 特定の型のハッシュ関数として機能します。 (Inherited from Object.) | |
| GetType | 現在のインスタンスの Type を取得します。 (Inherited from Object.) | |
| MemberwiseClone | 現在の Object の簡易コピーを作成します。 (Inherited from Object.) | |
| SaveT |
レコードの保存処理(単一) モデル上 isKey = True と設定された項目をキーとし、一致するキーがある場合はUpdate、なければCreateを行う | |
| SetIndexToModelT | ||
| SetIndexToModelsT |
受け取ったオブジェクトとキーが一致するレコードをkintoneから検索し、idをセットする
| |
| ToString | 現在の Object を表す String を返します。 (Inherited from Object.) | |
| UpdateT |
レコードの更新を行う(単一)
| |
| UploadFile(ReadOnlyCollectionHttpPostedFile) |
ファイルのアップロードを行う(複数件)
| |
| UploadFile(ReadOnlyCollectionHttpPostedFileBase) |
ファイルのアップロードを行う(複数件) kintone上、複数ファイルをアップロードしてもキーは単一になる。このためアップロードに使用したキーとファイルダウンロードのキーは異なるので注意 | |
| UploadFile(HttpPostedFile) |
ファイルのアップロードを行う(単一) | |
| UploadFile(HttpPostedFileBase) |
ファイルのアップロードを行う(単一) HttpPostedFileは非常に特殊な型でWeb上でファイルアップロードを行っている以外の場合は使用しにくいため、上位クラスのHttpPostedFileBaseを引数にとるメソッドを用意 |
Fields
| Name | Description | |
|---|---|---|
| KINTONE_API_FORMAT | ||
| KINTONE_EXE_LIMIT |
kintone APIの更新上限値 現在100だが、kintoneAPIの上限値が変更されれば要修正 | |
| KINTONE_HOST | ||
| KINTONE_PORT | ||
| KINTONE_REC_LIMIT |
kintone APIの読み込み上限値 現在100だが、kintoneAPIの上限値が変更されれば要修正 | |
| RECORD_LIMIT |
本APIで扱うレコードの最大値(余りに大きい件数の処理を途中で止めるための措置)
|
Properties
| Name | Description | |
|---|---|---|
| ApiEncoding |
送受信時のエンコード
| |
| AppId |
アクセス先アプリケーションのID。コンストラクタで指定
| |
| ExecuteLimit |
レコード更新件数の上限を設定する。設定がない場合、APIの上限値が設定される | |
| Host |
kintoneのアクセス先。"xxx.cybozu.com"というようなアドレスで表現される(xxxはDomain)
| |
| ReadLimit |
レコードの読み取り上限を設定する。設定がない場合、APIの上限値が設定される 上限値については、レコード取得の「クエリで条件を指定する」を参照 |
Remarks
See Also