kintoneAPI ClasskintoneDotNETHelp
kintoneのREST APIをコールするためのクラス
REST APIについてはサイボウズ公式のドキュメント参照
Inheritance Hierarchy

SystemObject
  kintoneDotNET.APIkintoneAPI

Namespace: kintoneDotNET.API
Assembly: kintoneDotNET (in kintoneDotNET.dll) Version: 1.0.4.0 (1.0.4.0)
Syntax

public class kintoneAPI

The kintoneAPI type exposes the following members.

Constructors

  NameDescription
Public methodkintoneAPI
アプリケーションIDを指定し、APIの生成を行う
Top
Methods

  NameDescription
Public methodBulkCreateT
レコード登録を行う(複数件)
Public methodBulkDeleteT
レコードの削除を行う(複数件)
Public methodBulkSaveT
レコードの保存処理(複数件)
Public methodBulkUpdateT
レコードの更新を行う(複数件)
Public methodCreateT
レコード登録を行う(単一)
Public methodDeleteT
レコードの削除を行う(単一)
Public methodStatic memberDownloadFile
ファイルのダウンロードを行う
Public methodEquals
指定した Object が、現在の Object と等しいかどうかを判断します。
(Inherited from Object.)
Protected methodFinalize
Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。
(Inherited from Object.)
Public methodFindT(String)
レコードの検索を行う
※このメソッドは、kintoneのレコード数上限までしか取得を行いません。全件取得する場合はFindAllを使用してください
Public methodFindT(kintoneQueryT)
Public methodFindAllT(String)
Public methodFindAllT(kintoneQueryT)
API上限値を超えたレコードの検索を行う
※並列でリクエストを投げ取得を行うため、order等の指定は考慮されない。データ取得後LINQ等で並び替えを行う必要あり
Public methodGetHashCode
特定の型のハッシュ関数として機能します。
(Inherited from Object.)
Public methodGetType
現在のインスタンスの Type を取得します。
(Inherited from Object.)
Protected methodMemberwiseClone
現在の Object の簡易コピーを作成します。
(Inherited from Object.)
Public methodSaveT
レコードの保存処理(単一)
モデル上 isKey = True と設定された項目をキーとし、一致するキーがある場合はUpdate、なければCreateを行う
Public methodSetIndexToModelT
Public methodSetIndexToModelsT
受け取ったオブジェクトとキーが一致するレコードをkintoneから検索し、idをセットする
Public methodToString
現在の Object を表す String を返します。
(Inherited from Object.)
Public methodUpdateT
レコードの更新を行う(単一)
Public methodStatic memberUploadFile(ReadOnlyCollectionHttpPostedFile)
ファイルのアップロードを行う(複数件)
Public methodStatic memberUploadFile(ReadOnlyCollectionHttpPostedFileBase)
ファイルのアップロードを行う(複数件)
kintone上、複数ファイルをアップロードしてもキーは単一になる。このためアップロードに使用したキーとファイルダウンロードのキーは異なるので注意
Public methodStatic memberUploadFile(HttpPostedFile)
ファイルのアップロードを行う(単一)
Public methodStatic memberUploadFile(HttpPostedFileBase)
ファイルのアップロードを行う(単一)
HttpPostedFileは非常に特殊な型でWeb上でファイルアップロードを行っている以外の場合は使用しにくいため、上位クラスのHttpPostedFileBaseを引数にとるメソッドを用意
Top
Fields

  NameDescription
Protected fieldStatic memberKINTONE_API_FORMAT
Public fieldStatic memberKINTONE_EXE_LIMIT
kintone APIの更新上限値
現在100だが、kintoneAPIの上限値が変更されれば要修正
Protected fieldStatic memberKINTONE_HOST
Protected fieldStatic memberKINTONE_PORT
Public fieldStatic memberKINTONE_REC_LIMIT
kintone APIの読み込み上限値
現在100だが、kintoneAPIの上限値が変更されれば要修正
Public fieldStatic memberRECORD_LIMIT
本APIで扱うレコードの最大値(余りに大きい件数の処理を途中で止めるための措置)
Top
Properties

  NameDescription
Public propertyStatic memberApiEncoding
送受信時のエンコード
Public propertyAppId
アクセス先アプリケーションのID。コンストラクタで指定
Public propertyStatic memberExecuteLimit
レコード更新件数の上限を設定する。設定がない場合、APIの上限値が設定される
Public propertyStatic memberHost
kintoneのアクセス先。"xxx.cybozu.com"というようなアドレスで表現される(xxxはDomain)
Public propertyStatic memberReadLimit
レコードの読み取り上限を設定する。設定がない場合、APIの上限値が設定される
上限値については、レコード取得の「クエリで条件を指定する」を参照
Top
Remarks

ジェネリクスクラスにするとSharedで使用できなくなるデメリットが大きいため、あくまでメソッド単位に留める
See Also

Reference