1.7.21

AssociationEndと他オブジェクトとのリンク解除

概要

AssociationEndの$links情報を削除する

必要な権限

alter-schema

制限事項

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

リクエスト

リクエストURL

{CellURL}{BoxName}/{CollectionName}/AssociationEnd(Name='{AssociationEndName}',
_EntityType.Name='{EntityTypeName}')/$links/_AssociationEnd(Name='{AssociationEndName}',
_EntityType.Name='{EntityTypeName}')

メソッド

DELETE

リクエストクエリ

なし

リクエストヘッダ

共通リクエストヘッダ

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

ヘッダ名概要有効値必須備考
If-Match対象ETag値を指定するETag値×省略時は[*]として扱う

リクエストボディ

なし

レスポンス

ステータスコード

204

レスポンスヘッダ

共通レスポンスヘッダ

ヘッダ名概要備考
Access-Control-Allow-Originクロスドメイン通信許可ヘッダ返却値は"*"固定
X-Personium-VersionAPIの実行バージョンリクエストが処理されたAPIバージョン

ODataレスポンスヘッダ

項目名概要備考
DataServiceVersionODataProtocolのバージョン情報正常にAssociationEndが作成できた場合のみ返却する
動作確認済み

レスポンスボディ

なし

エラーメッセージ一覧

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

cURLサンプル

curl "https://cell1.unit1.example/box1/odata-collection1/\$metadata/AssociationEnd\
(Name='association-end1',_EntityType.Name='entity-type1')/\$links/_AssociationEnd\
(Name='association-end2',_EntityType.Name='entity-type2')" -X DELETE -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json'
← AssociationEndと他オブジェクトとのリンク一覧取得ComplexType登録 →