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

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

共通ドキュメント

ファイル検索

ファイル検索APIについて

クエリ条件に合致したファイルの情報取得を行います。
クエリ条件を指定しない場合は全件取得となります。

基本仕様

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

リクエストヘッダー

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

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

リクエストコンテント

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

パラメータ名 説明 データ型 必須
fileName ファイル名 文字列
mimeType MIME-TYPE 文字列
fileSize ファイルサイズ(バイト単位) 整数値
createDate 作成日時 日付
updateDate 更新日時 日付

HTTPステータス

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

レスポンスヘッダー

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

レスポンスコンテント

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

説明 パラメータ名 データ型
ファイル名 fileName 文字列
MIME-TYPE mimeType 文字列
サイズ fileSize 整数値
作成日時 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: tNdfPWg0lK8/DfKUHnaEk3AO+lmgmZXWtuUeZ/NnbrY=" \
 -H "Content-Type: application/json" \
 --data-urlencode 'where={"fileName":"ttl_mb.png"}' \
 https://mb.api.cloud.nifty.com/2013-09-01/files

レスポンスサンプル

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

{
  "results":[
    {
      "fileName":"ttl_mb.png",
      "mimeType":"application/octet-stream",
      "fileSize":6325,
      "createDate":"2013-09-24T00:44:49.245Z",
      "updateDate":"2013-09-24T00:44:49.245Z",
      "acl":{
        "*":{
          "write":true,
          "read":true
        },
        "AAA":{
          "write":true,
          "read":true
        }
      }
    }
  ]
}

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

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

ページの先頭へ