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

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

共通ドキュメント

ロール検索

ロール検索APIについて

クエリ条件に合致した指定クラスのオブジェクトの情報取得を行います。
クエリ条件を指定しない場合は全件取得となります。

基本仕様

  • APIパス
    • 全件検索:/roles
    • 指定検索:/roles?where=
  • メソッド:GET

リクエストヘッダー

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

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

リクエストコンテント

説明 パラメータ名 データ型 必須 バリデーション
オブジェクトID objectId 文字列
ロール名 roleName 文字列
登録日時 createDate 日付
更新日時 updateDate 日付

HTTPステータス

ステータスコード 説明
200 検索完了

レスポンスヘッダー

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

レスポンスコンテント

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

リクエストサンプル

curl -X GET -G \
 -H "X-NCMB-Application-Key:549116a86b0ebbec4832d4086a56f36c82a5d64bc6528fa5e6220be76db5ef45" \
 -H "X-NCMB-Timestamp:2013-09-10T02:44:35.452Z" \
 -H "X-NCMB-Signature: oo+KhO+0vUmPD7fB1nH+oxEaPP/9XXn/EjoE8QXhpig=" \
 -H "Content-Type: application/json" \
 --data-urlencode 'where={"roleName":"testRole"}' \
 https://mb.api.cloud.nifty.com/2013-09-01/roles

レスポンスサンプル

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

{
  "results":[
    {
      "objectId":"oc8bJVuEWmKgNydn",
      "roleName":"testRole",
      "belongRole":null,
      "belongUser":null,
      "createDate":"2013-08-12T14:49:51.485Z",
      "updateDate":"2013-08-12T14:49:51.485Z",
      "acl":{
        "*":{
          "read":true,
          "write":true
        }
      }
    }
  ]
}

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

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

ページの先頭へ