1.7.21

Relationと他オブジェクトとのリンク一覧取得

概要

Relationに紐付いたODataリソースを一覧取得する
以下のODataリソースを指定することができる

  • Box
  • ExtCell
  • ExtRole
  • Role

必要な権限

紐付け先必要な権限
Boxsocial-read
box-read
ExtCellsocial-read
ExtRolesocial-read
auth-read
Rolesocial-read
auth-read

制限事項

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

リクエスト

リクエストURL

Correlating with Box

{CellURL}__ctl/Relation(Name='{RelationName}',_Box.Name='{BoxName}')/$links/_Box

または、

{CellURL}__ctl/Relation(Name='{RelationName}')/$links/_Box

または、

{CellURL}__ctl/Relation('{RelationName}')/$links/_Box

Correlating with ExtCell

{CellURL}__ctl/Relation(Name='{RelationName}',_Box.Name='{BoxName}')/$links/_ExtCell

または、

{CellURL}__ctl/Relation(Name='{RelationName}')/$links/_ExtCell

または、

{CellURL}__ctl/Relation('{RelationName}')/$links/_ExtCell

Correlating with ExtRole

{CellURL}__ctl/Relation(Name='{RelationName}',_Box.Name='{BoxName}')/$links/_ExtRole

または、

{CellURL}__ctl/Relation(Name='{RelationName}')/$links/_ExtRole

または、

{CellURL}__ctl/Relation('{RelationName}')/$links/_ExtRole

Correlating with the role

{CellURL}__ctl/Relation(Name='{RelationName}',_Box.Name='{BoxName}')/$links/_Role

または、

{CellURL}__ctl/Relation(Name='{RelationName}')/$links/_Role

または、

{CellURL}__ctl/Relation('{RelationName}')/$links/_Role

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

メソッド

GET

リクエストクエリ

以下のクエリパラメタが利用可能です。

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

リクエストヘッダ

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

リクエストボディ

なし

レスポンス

ステータスコード

200

レスポンスヘッダ

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

レスポンスボディ

オブジェクト項目名Data Type備考
ルートdobjectオブジェクト{1}
{1}resultsarrayオブジェクト{2}の配列
{2}uristring紐付いているODataリソースへのURL

エラーメッセージ一覧

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

レスポンスサンプル

{
  "d": {
    "results": [
      {
        "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')"
      }
    ]
  }
}

cURLサンプル

curl "https://cell1.unit1.example/__ctl/Relation(Name='relation1',_Box.Name='box1')\
/\$links/_Role" -X GET -i -H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' \
-H 'Accept: application/json'
← Relationと他オブジェクトとのリンク解除RelationのNavigation Property経由での他オブジェクト登録 →