REST API リファレンス

共通ドキュメント

配信端末検索

配信端末検索APIについて

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

基本仕様

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

リクエストヘッダー

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

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

リクエストコンテント

クエリの検索対象となるフィールドは、以下の通りです。

説明 パラメータ名 データ型 必須
オブジェクトID objectId 文字列
アプリケーション名 applicationName 文字列
アプリケーションバージョン appVersion 文字列
バッジ badge 数値
チャネル channels 配列
デバイストークン deviceToken 文字列
デバイスの種類 deviceType 文字列
SDKバージョン sdkVersion 文字列
タイムゾーン timeZone 文字列
登録日時 createDate 日付
更新日時 updateDate 日付
追加フィールド - -

HTTPステータス

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

レスポンスヘッダー

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

レスポンスコンテント

検索結果は、{"results":[{(オブジェクト情報1)},{(オブジェクト情報2)},{}…]}の配列で返却されます。
以下では、オブジェクト情報を記載しています。

説明 パラメータ名 データ型
オブジェクトID objectId 文字列
アプリケーション名 applicationName 文字列
アプリケーションバージョン appVersion 文字列
バッジ badge 数値
チャネル channels 配列
デバイストークン deviceToken 文字列
デバイスの種類 deviceType 文字列
SDKバージョン sdkVersion 文字列
タイムゾーン timeZone 文字列
登録日時 createDate 日付
更新日時 updateDate 日付
ACL acl オブジェクト
追加フィールド - -

リクエストサンプル

curl -X GET -G \
 -H "X-NCMB-Application-Key:549116a86b0ebbec4832d4086a56f36c82a5d64bc6528fa5e6220be76db5ef45" \
 -H "X-NCMB-Timestamp:2013-09-10T02:44:35.452Z" \
 -H "X-NCMB-Signature: oGZiALZ8Y8uOUDLr6rL34no7oH+vKSvnxocYCltyRtM=" \
 -H "Content-Type: application/json" \
 --data-urlencode 'where={"deviceType":"ios"}' \
 https://mbaas.api.nifcloud.com/2013-09-01/installations

レスポンスサンプル

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

{
  "results":[
    {
      "objectId":"gCI3ZJrEMvYBAMEL",
      "applicationName":"test",
      "appVersion":"1",
      "badge":1,
      "channels":null,
      "deviceToken":"test",
      "deviceType":"ios",
      "sdkVersion":null,
      "timeZone":null,
      "createDate":"2013-08-12T14:48:32.348Z",
      "updateDate":"2013-09-21T04:02:13.472Z",
      "acl":{
        "*":{
          "read":true,
          "write":true
        }
      }
    }
  ]
}