next

BoxのNavigation Property経由での他オブジェクト登録

概要

以下のCell制御オブジェクトをBoxのNavigation Property経由で登録する

  • Role
  • Relation
  • Rule

必要な権限

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

制限事項

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

リクエスト

リクエスト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が指定されたものとする

メソッド

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]として扱う

リクエストボディ

Relationを登録する場合

JSON

項目名概要有効値必須備考
NameRelation名桁数：1～128
文字種:半角英数字と-(半角ハイフン)と(半角アンダーバー)と+(プラス)と:(コロン)
ただし、先頭文字に(半角アンダーバー)と:(コロン)は指定不可		○
_Box.Name関係対象のBox名桁数：1～128
文字種：半角英数字と-(半角ハイフン)と(半角アンダーバー)
ただし、先頭文字に-(半角ハイフン)と(半角アンダーバー)は指定不可
説明：Box登録APIにて登録済みのBoxのNameを指定
特定のBoxと関連付けない場合はnullを指定		×

リクエストサンプル

{
  "Name":"relation1",
  "_Box.Name":"box1"
}

レスポンス

ステータスコード

201

レスポンスヘッダ

ヘッダ名概要備考
Content-Type返却されるデータの形式
Location作成したリソースへのURL
DataServiceVersionODataのバージョン
ETagリソースのバージョン情報
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/\"2-1486953408036\"",
        "type": "CellCtl.Relation"
      },
      "Name": "relation1",
      "__published": "/Date(1486953408036)/",
      "__updated": "/Date(1486953408036)/",
      "_Box.Name": "box1"
    }
  }
}

cURLサンプル

Roleを登録する場合

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

Relationを登録する場合

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

Ruleを登録する場合

curl
"https://cell1.unit1.example/__ctl/Box('box1')/_Rule" -X POST -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json' \
-d '{"Name":"rule1","Action":"log"}'
← Boxと他オブジェクトとのリンク一覧取得BoxのNavigation Property経由での他オブジェクト一覧取得 →