REST API ファイルAPI
最終更新日 2015-9-1

バイナリオブジェクトを検索する(メタ情報部)

バイナリオブジェクトのメタ情報部を検索します。

基本仕様

HTTPメソッド

メソッドは GET を利用します。

エンドポイント

  • オブジェクトIDを指定し検索する

/v1/bin/{データストアID}/{アプリID}/{コレクションID}/{オブジェクトID}

リクエスト

ヘッダ

X-APPIARIES-TOKEN アクセストークンを指定します(*1)

クエリ

クエリ名 備考
access_token アクセストークン(*1)
proc get もしくは count 省略する場合 get がデフォルト。count は特殊で、検索結果のオブジェクト数を取得する
sel オブジェクトのフィールド名をカンマ区切りで複数記述可能 取得対象とするフィールド
excpt オブジェクトのフィールド名をカンマ区切りで複数記述可能 取得除外対象とするフィールド
oonly true もしくは false (デフォルトはfalse) trueの場合取得結果の中でオブジェクトのみを取得する

(*1) ~ いずれかの方式で指定。

レスポンス

レスポンスヘッダ

Content-Type application/json

HTTPステータス

ステータスコード 内容
200 成功
400 取得範囲不適切、検索条件不適切、取得対象/取得除外対象とするパラメータを両方指定、ソートキー不適切など。
401 トークン未指定。認証失敗。
403 アプリにアクセスする権限がない。(コレクションに create 権限がない。コレクションに格納可能なオブジェクトが”バイナリ”ではない。)
404 コレクション未作成
500 予期せぬエラー発生

コンテント

1. 1件のバイナリメタ情報(オブジェクトID指定)の場合

バイナリメタ情報

フィールド名 内容
_id オブジェクトID
_filename バイナリファイル名
_type コンテントタイプ
_length データ長(byte)
_uri バイナリ取得用エンドポイント
_length バイナリデータ

2. 複数件のバイナリメタ情報の場合

フィールド名 内容
_total オブジェクト結果総件数
_objs 取得したオブジェクト一覧、バイナリメタ情報の配列。
_start 一覧取得したオブジェクトの第一要素を総件数から見た場合の位置
_end 一覧取得したオブジェクトの最終要素を総件数から見た場合の位置
_prev 一覧取得したオブジェクトの前にオブジェクトが存在するか
_next 一覧取得したオブジェクトの後ろにオブジェクトが存在するか

レスポンスサンプル