サーバー構築不要!スマートフォンアプリ向けの新クラウド

トップ >ドキュメント >REST API リファレンス:ロール取得

共通ドキュメント

ロール取得

ロール取得APIについて

指定したロールを取得し、所属する子ロールや会員を表示します。

基本仕様

  • APIパス:/roles/オブジェクトID
  • メソッド:GET

リクエストヘッダー

シグネチャやAPIキーなどの詳細は「共通フォーマット」を参照してください。

フィールド名 内容
Content-Type application/json

リクエストコンテント

なし

HTTPステータス

ステータスコード 説明
200 取得完了

レスポンスヘッダー

フィールド名
Content-Type application/json

レスポンスコンテント

パラメータ名 説明 データ型 備考
objectId オブジェクトID 文字列
roleName ロール名 文字列
belongRole 所属するロール オブジェクト
belongUser 所属する会員 オブジェクト
acl ACL オブジェクト
createDate 登録日時 日付
updateDate 更新日時 日付

所属するロールがある場合は「"belongUser":{"__type":"Relation","className":"user"}」を返却します。
所属する会員がいる場合は「"belongRole":{"__type":"Relation","className":"role"}」を返却します。
子ロールやロールに所属している会員の取得は、ロール検索や会員検索時に$relatedToオペランドを利用することで取得できます。

子ロールを取得するクエリの指定
roles?where={"$relatedTo":{"object":{"__type":"Pointer","className":"role","objectId":"Z4266ErZMCLCUi4L"},"key":"belongRole"}}

所属している会員を取得するクエリの指定
users?where={"$relatedTo":{"object":{"__type":"Pointer","className":"role","objectId":"Z4266ErZMCLCUi4L"},"key":"belongUser"}}

リクエストサンプル

curl  -v -X GET -G  \
 -H "X-NCMB-Apps-Session-Token:Lbl1oCK8gLpyOawBOnbIFdpOx" \
 -H "X-NCMB-Application-Key: 578ebb84b9036498858ce0aad14ed0b5a662a102ccca34f0033ff20a1f200786" \
 -H "X-NCMB-Timestamp: 2013-08-14T15:46:25.543" \
 -H "X-NCMB-Signature: dXamZfAouVYNreb2RtJrJ5SKDqgm1A5FLrdJtWaANr4=" \
 -H "Content-Type: application/json" \
 https://mb.api.cloud.nifty.com/2013-09-01/roles/qHcDdjIlTusGBS0l

レスポンスサンプル

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
  "objectId":"qHcDdjIlTusGBS0l",
  "roleName":"role_test1",
  "belongRole":null,
  "belongUser":null,
  "createDate":"2013-08-30T05:04:19.045Z",
  "updateDate":"2013-08-30T05:04:19.045Z",
  "acl":{
    "*":{
      "read":true,
      "write":true
    }
  }
}

お探しの内容が見つからなかった場合はユーザーコミュニティ もご活用ください。(回答保証はいたしかねます)
なお、 Expertプラン以上のお客様はテクニカルサポートにてご質問を承らせて頂きます。

推奨画面サイズ1024×768px以上

ページの先頭へ