next

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

概要

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

必要な権限

  • Roleを取得する場合
    box-read,auth-read
  • Relationを取得する場合
    box-read,social-read
  • Ruleを取得する場合
    box-read,rule-read

制限事項

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

リクエスト

リクエストURL

RoleへのnavigationProperty

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

または、

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

または、

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

RelationへのnavigationProperty

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

または、

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

または、

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

RuleへのnavigationProperty

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

または、

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

または、

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

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

メソッド

GET

リクエストクエリ

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

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

$select クエリ

$expand クエリ

$format クエリ

$filter クエリ

$inlinecount クエリ

$orderby クエリ

$top クエリ

$skip クエリ

全文検索(q)クエリ

リクエストヘッダ

ヘッダ名概要有効値必須備考
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で取得したトークン
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}__metadataobjectオブジェクト{3}
{3}uristring作成したリソースへのURL
{3}etagstringEtag値
{2}__publishedstring作成日(UNIX時間)
{2}__updatedstring更新日(UNIX時間)
{1}__countstring$inlinecountクエリでの取得結果件数

Relationを取得した場合

オブジェクト項目名Data Type備考
{3}typestringCellCtl.Relation
{2}NamestringRelation名
{2}_Box.Namestring関係対象のBox名

エラーメッセージ一覧

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

レスポンスサンプル

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

cURLサンプル

Roleを取得する場合

curl "https://cell1.unit1.example/__ctl/Box('box1')/_Role" -X GET -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json'

Relationを取得する場合

curl "https://cell1.unit1.example/__ctl/Box('box1')/_Relation" -X GET -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json'

Ruleを取得する場合

curl "https://cell1.unit1.example/__ctl/Box('box1')/_Rule" -X GET -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json'
← BoxのNavigation Property経由での他オブジェクト登録メッセージ送信 →