API (dataClass)

📄️ dataClass

エンティティやセンティティセレクション、またはクラス関数を利用するにあたって、RESTリクエスト内にデータクラス名を直接使用することができます。

クエリの結果を、JSONオブジェクトではなく配列 (コレクション) として返します。

RESTリクエストに含まれる操作をトランザクション内で処理します。エラーがなかった場合、トランザクションは受け入れられます。それ以外の場合、トランザクションはキャンセルされます。

データクラスから取得する属性を選択するのに使います (例: Company(1)?$attributes=name,city、 Company(1)?$attributes=employees.lastname あるいは Employee?$attributes=employer.name)。

ドキュメントを BLOB として保存するには "true" を渡します ($expand= も渡す必要があります)

指定した属性を対象に計算をおこないます (例 Employee/objectAtt.property1/?$compute=sum)。

指定した属性について、重複しない値のコレクションを取得します (例: Company/name?$filter="name=a*"&$distinct=true)

$method=entityset を使ってエンティティセットを作成すると、それを後で再利用することができます。

画像属性に保存されているピクチャーを展開します (例: Employee(1)/photo?$imageformat=best&$expand=photo) または保存するために BLOB属性を展開します。

データクラスまたはメソッドが返すデータをフィルターします (例: $filter="firstName!='' AND salary>30000")

画像取得の際に使用する画像形式を指定します (例: $imageformat=png)

ペシミスティック・ロック機構を使ってエンティティをロック/アンロックします。

このパラメーターは、返されたエンティティまたはエンティティセレクションに対して実行する処理を指定するのに使います。

指定した属性と並べ替え順に基づいて、返されたデータを並べ替えます (例: $orderby="lastName desc, salary asc")

4D Server によって実際に実行されたクエリを返します (例: $querypath=true)

4D Server に渡したクエリを返します (例: $queryplan=true)

エンティティセット作成時に、$filter に定義したフィルターを保存します (例: $savedfilter="")

エンティティセット作成時に、$orderby に定義した並べ替え情報を保存します (例: $savedorderby="")

エンティティセレクション内で、この数値によって指定されたエンティティから処理を開始します (例: $skip=10)

4D Server のキャッシュにエンティティセットが保存される時間 (秒単位) を指定します (例: $timeout=1800)

返されるエンティティの数を制限します (例: $top=50)

画像のバージョン番号