next

Entity部分更新

概要

ユーザデータのEntityを部分更新します

必要な権限

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})}
パス概要
{CellName}Cell名
{BoxName}Box名
{ODataCollecitonName}コレクション名
{EntityTypeName}EntityType名
{EntityID}更新するEntityのID

メソッド

MERGE

リクエストクエリ

共通リクエストクエリ

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

リクエストヘッダ

共通リクエストヘッダ

ヘッダ名概要有効値必須備考
X-Personium-VersionAPIの実行バージョン有効なバージョン×指定がない場合、最新のAPIバージョンが指定される
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更新リクエストヘッダ

ヘッダ名概要有効値必須備考
Contents-TypeOAuth2.0形式で、認証情報を指定するapplication/json×省略時は[application/json]として扱う
Acceptレスポンスボディの形式を指定するapplication/json×省略時は[application/json]として扱う
If-Match対象ETag値を指定するETag値×省略時は[*]として扱う

リクエストボディ

プロパティ

スキーマ定義済みのプロパティと動的（スキーマ未定義）プロパティ、合わせて最大で400個のプロパティを設定可能
上記にはComplexTypeで定義されているプロパティ数を含む

スキーマ定義済みのプロパティ

項目名概要有効値必須備考
EntityTypeに紐づくPropertyユーザ定義項目デフォルト値 PropertyのDefaultValueに基づくPropertyのNullableに基づく
##### 動的（スキーマ未定義）プロパティ |データ型|有効値| |:--|:--| |文字列|桁数：0～51200 byte
文字種: 文字列の値に制御コードを使用した場合、取得時にエスケープした状態で返却する
「\」を使用する場合、「\\\」で指定する必要がある
文字列型のプロパティに整数値、小数値、真偽値、日付型の値を設定した場合、文字列型に変換して登録される| |整数値|-2147483648 ～ 2147483647| |小数値|整数部分の桁数：1～5桁
小数部分の桁数：1～5桁| |真偽値|true / false / null(nullを指定した場合はfalseとして扱う)| |日付|/Date(【long型の時刻】)/の形式で文字列で指定する
【long型の時刻】の有効値は、-6847804800000(1753-01-01T00:00:00.000Z)～253402300799999(9999-12-31T23:59:59.999Z)
また、予約語として以下を指定可能
SYSUTCDATETIME()：サーバ時間| スキーマ定義を行わなくても動的にプロパティを設定することが可能 登録可能なデータ型は「文字列」「数値」「真偽値」「null」のみ設定可能 #### 動的プロパティのkeyの有効値 |データ型|有効値| |:--|:--| |文字列|桁数：1～128 :
文字種:半角英数字と-(半角ハイフン)と_(半角アンダーバー)
_ただし、先頭文字に-(半角ハイフン)と_(半角アンダーバー)は指定不可
_published、_updatedは、予約語であるためリクエストボディの指定は不可| #### 動的プロパティのvalueの有効値 スキーマ定義済みプロパティのvalueの有効値と同様 配列、連想配列は指定不可 * リクエストボディに__idを指定した場合、無視される - 存在しないプロパティを指定した場合、そのプロパティは追加プロパティとして更新される - 指定されていない項目の更新は行わない(元の値を維持する)

※下記は未実装で現状指定しない項目はDefaultValueの値となる

  • ComplexType内の項目を指定した場合、指定した項目のみ更新される
    • 指定されていない項目の更新は行わない(元の値を維持する)

レスポンス

ステータスコード

204

レスポンスヘッダ

ODataレスポンスヘッダ

ヘッダ名概要備考
ETagリソースのバージョン情報
DataServiceVersionODataのバージョン

レスポンスボディ

なし

エラーメッセージ一覧

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

cURLサンプル

curl "https://cell1.unit1.example/box1/odata-collection1/entity-type1\
('100-1_20101108-111352093')" -X MERGE -i -H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json' \
-d '{"name": "episode","outcome": "治療後"}'
← Entity更新Entity削除 →