ExtRoleのNavigation Property経由での他オブジェクト一覧取得

概要

Cell制御オブジェクトをNavigation Property経由で取得する

必要な権限

Roleを取得する場合
auth-read
Relationを取得する場合
social-read

制限事項

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

リクエスト

リクエストURL

RoleへのnavigationProperty

{CellURL}__ctl/ExtRole(ExtRole='https%3A%2F%2F{CellName}.{UnitFQDN}%2F__role%2F__%2F{RoleName}',
_Relation.Name='{RelationName},_Relation._Box.Name='{BoxName}')/_Role

RelationへのnavigationProperty

{CellURL}__ctl/ExtRole(ExtRole='https%3A%2F%2F{CellName}.{UnitFQDN}%2F__role%2F__%2F{RoleName}',
_Relation.Name='{RelationName},_Relation._Box.Name='{BoxName}')/_Relation

※ _Relation._Box.Nameパラメタを省略した場合は、nullが指定されたものとする
※ ExtRoleのNavProp経由登録APIではRoleの登録のみ有効

メソッド

GET

リクエストクエリ

クエリ名	概要	有効値	必須	備考
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文字列を自動採番
Authorization	OAuth2.0形式で、認証情報を指定する	Bearer {AccessToken}	×	※認証トークンは認証トークン取得APIで取得したトークン
Accept	レスポンスボディの形式を指定する	application/json	×	省略時は[application/json]として扱う

リクエストボディ

なし

レスポンス

ステータスコード

200

レスポンスヘッダ

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

レスポンスボディ

オブジェクト	項目名	Data Type	備考
ルート	d	object	オブジェクト{1}
{1}	results	array	オブジェクト{2}の配列
{2}	__metadata	object	オブジェクト{3}
{3}	uri	string	作成したリソースへのURL
{3}	etag	string	Etag値
{2}	__published	string	作成日(UNIX時間)
{2}	__updated	string	更新日(UNIX時間)
{1}	__count	string	$inlinecountクエリでの取得結果件数

Roleを取得した場合

オブジェクト	項目名	Data Type	備考
{3}	type	string	CellCtl. Role
{2}	Name	string	Role名
{2}	_Box.Name	string	関係対象のBox名

エラーメッセージ一覧

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

レスポンスサンプル

{
  "d": {
    "results": [
      {
        "__metadata": {
          "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')",
          "etag": "W/\"1-1486950269621\"",
          "type": "CellCtl.Role"
        },
        "Name": "role1",
        "_Box.Name": "box1",
        "__published": "/Date(1486950269621)/",
        "__updated": "/Date(1486950269621)/",
        "_Box": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')/_Box"
          }
        },
        "_Account": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')/_Account"
          }
        },
        "_ExtCell": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')/_ExtCell"
          }
        },
        "_ExtRole": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')/_ExtRole"
          }
        },
        "_Relation": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')/_Relation"
          }
        }
      }
    ]
  }
}

cURLサンプル

RoleのnavigationProperty経由一覧

curl "https://cell1.unit1.example/__ctl/ExtRole(ExtRole='https%3A%2F%2Fcell2.unit1.example%2F\
__role%2F__%2Frole1',_Relation.Name='relation1',_Relation._Box.Name='box1')/_Role" -X GET -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json'