next

Entity一覧取得

概要

OData サービスコレクション内に定義された特定のEntityセットからEntity一覧を取得します。

必要な権限

read

制限事項

  • Edm.DateTime型の配列は未サポート
  • Edm.DateTime型のプロパティにSYSUTCDATETIME()を指定した場合、設定されるシステム時間が異なる場合がある
    • リクエストボディでの設定時とDefaultValueでの設定時（__published、__updatedは後者のタイミング）
  • 1つのEntityTypeに対して作成出来るのは、DynamicProperty・DeclaredProperty・ComplexTypeProperty合わせて400個まで

リクエスト

リクエストURL

{CellURL}{BoxName}/{ODataCollecitonName}/{EntityTypeName}
パス概要
{CellName}Cell名
{BoxName}Box名
{ODataCollecitonName}コレクション名
{EntityTypeName}EntityType名

メソッド

GET

リクエストクエリ

以下のクエリパラメタが利用可能です。

クエリ名概要有効値必須備考
p_cookie_peerクッキー認証値認証時にサーバから返却されたクッキー認証値×Authorizationヘッダの指定が無い場合のみ有効
クッキーの認証情報を利用する場合に指定する

$select クエリ

$expand クエリ

$format クエリ

$filter クエリ

$inlinecount クエリ

$orderby クエリ

$top クエリ

$skip クエリ

全文検索(q)クエリ

リクエストヘッダ

共通リクエストヘッダ

ヘッダ名概要有効値必須備考
X-HTTP-Method-Overrideメソッドオーバーライド機能任意×POSTメソッドでリクエスト時にこの値を指定すると、指定した値がメソッドとして使用される
X-Overrideヘッダオーバライド機能${上書きするヘッダ名}:${値}×通常のHTTPヘッダの値を上書きします。複数のヘッダを上書きする場合はX-Overrideヘッダを複数指定する
X-Personium-RequestKeyイベントログに出力するRequestKeyフィールドの値半角英数、-(半角ハイフン)と_(半角アンダーバー)
最大128文字		×指定がない場合は、UUIDの独自短縮表現として${4桁}_${18桁}の形式のBase64url文字列を自動採番

OData共通リクエストヘッダ

ヘッダ名概要有効値必須備考
AuthorizationOAuth2.0形式で、認証情報を指定するBearer {AccessToken}×※認証トークンは認証トークン取得APIで取得したトークン

OData取得リクエストヘッダ

ヘッダ名概要有効値必須備考
Acceptレスポンスボディの形式を指定するapplication/json×省略時は[application/json]として扱う
If-None-MatchETagの値を指定し、変更がない場合は304、変更されている場合は最新リソースを返却する×ETagに一致しないEntityを取得する場合に指定
未対応

レスポンス

ステータスコード

200

レスポンスヘッダ

ヘッダ名概要備考
Content-Type返却されるデータの形式
DataServiceVersionODataProtocolのバージョン情報正常にユーザデータが取得できた場合のみ返却する

レスポンスボディ

レスポンスはJSONオブジェクトで、オブジェクト（サブオブジェクト）に定義されるキー(名前)と型、並びに値の対応は以下のとおりです。

オブジェクト名前（キー）型値
ルートdobjectオブジェクト{1}
{1}resultsarrayオブジェクト{2}の配列
{2}__metadataobjectオブジェクト{3}
{3}uristring作成したリソースへのURL
{3}etagstringEtag値
{3}typestringUserData.{EntityTypeName}
{2}__idstringEntityのID(__id)
{2}__publishedstring作成日(UNIX時間)
{2}__updatedstring更新日(UNIX時間)
{2}_{NP名}stringオブジェクト{4}
Linkが結ばれている場合のみ返却される。{NP名}:NavigationPropert名
{4}__deferredobjectオブジェクト{5}
{5}uristring関係を結んでいるリソースのuri
テスト未実施
{1}__countstring$inlinecountクエリでの取得結果件数

上記以外にスキーマ設定した項目、または登録時に指定した動的な項目を返却

数値の扱い

小数値（Edm.Single型）

  • JSON形式でUserODataを取得する場合の取り扱いは以下の通り
    • 10.0等の小数部が0となる値は、整数値として返却する

数値（Edm.Double型）

※PersoniumでのDouble型の扱いは、JavaのDoubleの仕様に従います

  • JSON形式でUserODataを取得する場合の取り扱いは以下の通り
    • 10.0等の小数部が0となる値は、整数値として返却する
  • 返却される値について
    • 登録時の入力値が倍精度以上の精度を持った数である場合、倍精度に丸められてデータ登録を行う
      • 内部的には浮動小数点数として管理されるが、出力時には情報落ちの起こらない範囲で固定小数点数表現に変換して出力する
        出力された固定小数点数を入力に用いた場合、その入力数ともとの数との同一性は保証される

エラーメッセージ一覧

エラーメッセージ一覧を参照

レスポンスサンプル

{
  "d": {
    "results": [
      {
        "__metadata": {
          "uri": "https://cell1.unit1.example/box1/odata-collection1/entity-type1
('100-1_20101108-111352093')",
          "etag": "W/\"1-1487662179733\"",
          "type": "UserData.entity-type1"
        },
        "__id": "100-1_20101108-111352093",
        "__published": "/Date(1487662179733)/",
        "__updated": "/Date(1487662179733)/",
        "PetName": null,
        "animalId": "100-1",
        "endedAt": "",
        "episodeType": "care",
        "name": "episode",
        "outcome": "治療中",
        "startedAt": "2010-11-08"
      },
      {
        "__metadata": {
          "uri": "https://cell1.unit1.example/box1/odata-collection1/entity-type1
('100-1_20101108-111352093')",
          "etag": "W/\"1-1487664427226\"",
          "type": "UserData.entity-type1"
        },
        "__id": "100-1_20101108-111352093",
        "__published": "/Date(1487664427226)/",
        "__updated": "/Date(1487664427226)/",
        "PetName": null
      }
    ]
  }
}

cURLサンプル

curl "https://cell1.unit1.example/box1/collection1/entity-type1" -X GET -i -H \
'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json'
← Entity取得Entity更新 →