1.7.21

Boxと他オブジェクトとのリンク

概要

Boxに$linksで指定したODataリソースを紐付ける
以下のODataリソースと紐付けることができる

  • Role
  • Relation
  • Rule

必要な権限

紐付け先必要な権限
Rolebox
auth
Relationbox
social
Rulebox
rule

制限事項

  • リクエストヘッダのAcceptは無視される
  • リクエストヘッダのContent-Typeは全てapplication/jsonとして扱う
  • リクエストボディはJSON形式のみ受け付ける
  • レスポンスヘッダのContent-Typeはapplication/jsonのみをサポートし、レスポンスボディはJSON形式とする
  • $formatクエリオプションは無視される

リクエスト

リクエストURL

Roleとの紐付け

{CellURL}__ctl/Box(Name='{BoxName}',Schema='{SchemaURL}')/$links/_Role

または、

{CellURL}__ctl/Box(Name='{BoxName}')/$links/_Role

または、

{CellURL}__ctl/Box('{BoxName}')/$links/_Role

Relationとの紐付け

{CellURL}__ctl/Box(Name='{BoxName}',Schema='{SchemaURL}')/$links/_Relation

または、

{CellURL}__ctl/Box(Name='{BoxName}')/$links/_Relation

または、

{CellURL}__ctl/Box('{BoxName}')/$links/_Relation

Ruleとの紐付け

{CellURL}__ctl/Box(Name='{BoxName}',Schema='{SchemaURL}')/$links/_Rule

または、

{CellURL}__ctl/Box(Name='{BoxName}')/$links/_Rule

または、

{CellURL}__ctl/Box('{BoxName}')/$links/_Rule

※ Schemaパラメタを省略した場合は、nullが指定されたものとする

メソッド

POST

リクエストクエリ

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

リクエストヘッダ

ヘッダ名概要有効値必須備考
X-HTTP-Method-Overrideメソッドオーバーライド機能任意×POSTメソッドでリクエスト時にこの値を指定すると、指定した値がメソッドとして使用されます。
X-Overrideヘッダオーバライド機能${上書きするヘッダ名}:${値}override} $: $ {value}×通常のHTTPヘッダの値を上書きします。複数のヘッダを上書きする場合はX-Overrideヘッダを複数指定します。
X-Personium-RequestKeyイベントログに出力するRequestKeyフィールドの値半角英数、-(半角ハイフン)と_(半角アンダーバー)
最大128文字		×指定がない場合は、UUIDの独自短縮表現として${4桁}_${18桁}の形式のBase64url文字列を自動採番
AuthorizationOAuth2.0形式で、認証情報を指定するBearer {AccessToken}×※認証トークンは認証トークン取得APIで取得したトークン
Content-Typeリクエストボディの形式を指定するapplication/json×省略時は[application/json]として扱う
Acceptレスポンスボディの形式を指定するapplication/json×省略時は[application/json]として扱う

リクエストボディ

Format

JSON

項目名概要有効値必須備考
uri紐付けるODataリソースのURI桁数：1～1024
URIの形式に従う
scheme：http / https / urn		○

リクエストサンプル

{"uri":"https://cell1.unit1.example/__ctl/Role(Name='role1')"}

レスポンス

ステータスコード

204

レスポンスヘッダ

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

レスポンスボディ

なし

エラーメッセージ一覧

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

cURLサンプル

curl "https://cell1.unit1.example/__ctl/Box('box1')/\$links/_Role" -X POST -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json' \
-d "{\"uri\":\"https://cell1.unit1.example/__ctl/Role(Name='role1')\"}"
← Box削除Boxと他オブジェクトとのリンク解除 →