1.7.21

ComplexTypeProperty更新

概要

既存のComplexTypeProperty情報を更新する

必要な権限

alter-schema

制限事項

  • リクエストヘッダのContent-Typeは全てapplication/jsonとして扱う
  • リクエストボディはJSON形式のみ受け付ける
  • レスポンスヘッダのContent-Typeはapplication/jsonのみをサポートし、レスポンスボディはJSON形式とする
  • $formatクエリオプションにatom または xmlを指定した場合、エラーとはならないが、レスポンスボディのデータの保証はない

リクエスト

リクエストURL

{CellURL}{BoxName}/{OdataCollecitonPath}/$metadata/ComplexTypeProperty('ComplexTypeProperty')

メソッド

PUT

リクエストクエリ

共通リクエストクエリ

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

OData 共通リクエストクエリ

なし

リクエストヘッダ

共通リクエストヘッダ

ヘッダ名概要有効値必須備考
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更新リクエストヘッダ

ヘッダ名概要有効値必須備考
Content-Typeリクエストボディの形式を指定するapplication/json×省略時は[application/json]として扱う
Acceptレスポンスボディの形式を指定するapplication/json×省略時は[application/json]として扱う
If-Match対象ETag値を指定するETag値×省略時は[*]として扱う

リクエストボディ

Format

JSON

項目名概要有効値必須備考
NameComplexTypeProperty名桁数：1～128
文字種:半角英数字と-(半角ハイフン)と(半角アンダーバー)
ただし、先頭文字に-(半角ハイフン)と(半角アンダーバー)は指定不可		○

リクエストサンプル

{"Name":"complex-type-property2"}

レスポンス

ステータスコード

204

レスポンスヘッダ

なし

レスポンスボディ

なし

エラーメッセージ一覧

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

cURLサンプル

curl "https://cell1.unit1.example/box1/odata-collection1/\$metadata/ComplexTypeProperty\
('complex-type-property1')" -X PUT -i -H 'If-Match: *' \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json' \
-d '{"Name":"complex-type-property2"}'
← ComplexTypeProperty一覧取得ComplexTypeProperty削除 →