1.7.21

EntityのNavigation Property経由での他オブジェクト登録

概要

ユーザデータのEntityをNavigation Property経由で作成します。

必要な権限

write

制限事項

  • リクエストヘッダのContent-Typeは全てapplication/jsonとして扱う
  • リクエストボディはJSON形式のみ受け付ける
  • レスポンスヘッダのContent-Typeはapplication/jsonのみをサポートし、レスポンスボディはJSON形式とする
  • $formatクエリオプションにatom または xmlを指定した場合、エラーとはならないが、レスポンスボディのデータの保証はない
  • ユーザデータ制限事項
    • Edm.DateTime型のプロパティの有効範囲のチェックが適切に行われない
    • Edm.DateTime型の配列は未サポート
    • Edm.DateTime型のプロパティにSYSUTCDATETIME()を指定した場合、設定されるシステム時間が異なる場合がある
      • リクエストボディでの設定時とDefaultValueでの設定時（__published、__updatedは後者のタイミング）
    • 1つのEntityTypeに対して作成出来るのは、DynamicProperty・DeclaredProperty・ComplexTypeProperty合わせて400個まで

リクエスト

リクエストURL

{CellURL}{BoxName}/{ODataCollecitonName}/{EntityTypeName}('{EntityID}')
/{NavigationPropertyName}
パス概要
{CellName}Cell名
{BoxName}Box名
{ODataCollecitonName}コレクション名
{EntityTypeName}EntityType名
{EntityID}EntityのID
{NavigationPropertyName}NavigationProperty名

指定できるNavigationProperty名は、EntitySetと以下の関連を持つものに限る。

FromTo
0 .. 11
0 .. 1*
11
1*
**

メソッド

POST

リクエストクエリ

共通リクエストクエリ

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

リクエストヘッダ

ヘッダ名概要有効値必須備考
AuthorizationOAuth2.0形式で、認証情報を指定するBearer {AccessToken}×※認証トークンは認証トークン取得APIで取得したトークン
テスト未実施
Acceptレスポンスボディの形式を指定するapplication/json×省略時は[application/json]として扱う
未対応
Content-Typeリクエストボディの形式を指定するapplication/json×省略時は[application/json]として扱う
未対応

リクエストボディ

項目名概要有効値必須備考
__idEntityのID桁数：1～400
文字列		×指定しない場合ユニークなIDが割り当てられます
  • __id以外に動的なユーザデータを登録することが可能
    • 文字列のみ設定可能
    • 数値、真偽値、nullを指定した場合は、文字列として扱われる
    • Hash値の指定は不可
    • 最大で400個のユーザデータを指定可能
    • _published、_updatedは、予約語であるためリクエストボディの指定は不可

リクエストサンプル

{"__id": "100-1_20101108-111352093","animalId": "100-1","name": "episode","startedAt":
"2010-11-08","episodeType": "care","endedAt": "","outcome": "治療中"}

レスポンス

ステータスコード

201

レスポンスヘッダ

項目名概要備考
Content-Type返却されるデータの形式
Location作成したEntityのリソースURL正常にEntityが作成できた場合のみ返却する
DataServiceVersionODataのバージョン情報正常にEntityが作成できた場合のみ返却する
ETagリソースのバージョン情報正常にEntityが作成できた場合のみ返却する

レスポンスボディ

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

オブジェクト名前（キー）型値
ルートdobjectオブジェクト{1}
{1}resultsarrayオブジェクト{2}の配列
{2}__metadataobjectオブジェクト{3}
{3}uristring作成したリソースへのURL
{3}etagstringEtag値
{3}typestringEntityType名
{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クエリでの取得結果件数

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

エラーメッセージ一覧

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

レスポンスサンプル

{
  "d": {
    "results": {
      "__metadata": {
        "uri": "https://cell1.unit1.example/box1/odata-collection1/entity-type1
('100-1_20101108-111352093')",
        "etag": "W/\"1-1487929403469\"",
        "type": "UserData.entity-type1"
      },
      "__id": "100-1_20101108-111352093",
      "__published": "/Date(1487929403469)/",
      "__updated": "/Date(1487929403469)/",
      "PetName": null,
      "navigation-property1": {
        "__deferred": {
          "uri": "https://cell1.unit1.example/box1/odata-collection1/entity-type1
('100-1_20101108-111352093')/navigation-property1"
        }
      }
    }
  }
}

cURLサンプル

curl "https://cell1.unit1.example/box1/odata-collection1/entity-type1('{100-1_20101108-111352093}')\
/navigation-property1" -X POST -i -H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H \
'Accept: application/json' -d '{"__id": "100-1_20101108-111352093"}'
← Entityと他オブジェクトとのリンク一覧取得EntityのNavigation Property経由での他オブジェクト一覧取得 →