next

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

概要

AccountのNavigation Property経由でRoleを登録する

必要な権限

auth

制限事項

  • リクエストヘッダのContent-Typeは全てapplication/jsonとして扱う
  • リクエストボディはJSON形式のみ受け付ける
  • レスポンスヘッダのContent-Typeはapplication/jsonのみをサポートし、レスポンスボディはJSON形式とする
  • $formatクエリオプションにatom または xmlを指定した場合、エラーとはならないが、レスポンスボディのデータの保証はない

リクエスト

リクエストURL

RoleへのnavigationProperty

{CellURL}__ctl/Account(Name='{AccountName}')/_Role

または、

{CellURL}__ctl/Account('{AccountName}')/_Role

メソッド

POST

リクエストクエリ

クエリ名概要有効値必須備考
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で取得したトークン
Content-Typeリクエストボディの形式を指定するapplication/json×省略時は[application/json]として扱う
Acceptレスポンスボディの形式を指定するapplication/json×省略時は[application/json]として扱う

リクエストボディ

Roleを登録する場合

項目名概要有効値必須備考
Nameアカウント名文字種:半角英数字と左記半角記号（-_!$*=^`{|}~.@）
ただし、先頭文字に半角記号は指定不可		○

リクエストサンプル

{
  "Name": "account1"  
}

レスポンス

ステータスコード

201

レスポンスヘッダ

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

レスポンスボディ

項目名概要備考
d
d / results
d / results / __published作成日
d / results / __updated更新日
d / results / __metadata
d / results / __metadata / etagETag値
d / results / __metadata / uri作成したリソースへのURL
d / results / __metadata / typeEntityType
d / results / NameRole名
d / results / _Box.Name関係対象のBox名

Accountを登録した場合

Account固有レスポンスボディ

オブジェクト項目名Data Type備考
{2}NamestringAccount名
{2}Cellstringnull
{2}Typestringbasic
{3}TypestringCellCtl.Account

レスポンスサンプル

{
  "d": {
    "results": {
      "Name": "account1",
      "__published": "/Date(1349355810698)/",
      "Cell": null,
      "__updated": "/Date(1349355810698)/",
      "Type": "basic",
      "__metadata": {
        "etag": "1-1349355810698",
        "type": "CellCtl.Account",
        "uri": "https://cell1.unit1.example/__ctl/Account('account1')"
      }
    }
  }
}

エラーメッセージ一覧

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

cURLサンプル

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