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

ファイルAPIリファレンス

ファイルAPIについて説明します

ファイルAPI

ファイルAPIへのアクセスには全てSSLを用い、ドメインは、https://api-datastore.appiaries.comを指定します。

相対パスのプレフィクス v1 はAPI バージョンを表しています。

ファイルAPI で登録するオブジェクトはJSONオブジェクトで登録されるメタ情報部(各フィールドについてはこちら)と、ファイルなどのバイナリで構成されます。

アクセストークンを利用する場合は下記2パターンのいずれかで指定してください。

  • ヘッダに指定する “X-APPIARIES-TOKEN: <アクセストークン>”
  • クエリに指定する “access_token=<アクセストークン>”

ファイルAPI 機能一覧

実現する操作 HTTP メソッド API パス
バイナリオブジェクトを登録する POST /v1/bin/{データストアID}/{アプリID}/{コレクションID}/
バイナリオブジェクトを置き換え登録する PUT /v1/bin/{データストアID}/{アプリID}/{コレクションID}/{オブジェクトID}
バイナリオブジェクトを更新する PATCHまたはPOST /v1/bin/{データストアID}/{アプリID}/{コレクションID}/{オブジェクトID}

/v1/bin/{データストアID}/{アプリID}/{コレクションID}/{オブジェクトID}/{フィールド名}
バイナリオブジェクトを削除する DELETE または POST /v1/bin/{データストアID}/{アプリID}/{コレクションID}/{オブジェクトID}
/v1/bin/{データストアID}/{アプリID}/{コレクションID}/{オブジェクトID}/{フィールド名}
バイナリオブジェクトを検索する(メタ情報部) GET /v1/bin/{データストアID}/{アプリID}/{コレクションID}/{オブジェクトID}
/v1/bin/{データストアID}/{アプリID}/{コレクションID}/{オブジェクトID}/{フィールド名}
/v1/bin/{データストアID}/{アプリID}/{コレクションID}/{抽出範囲}{検索条件}
バイナリオブジェクトを検索する(バイナリ) GET /v1/bin/{データストアID}/{アプリID}/{コレクションID}/{オブジェクトID}/_bin

オブジェクトメタ情報部フィールド

フィールド名 内容
_id オブジェクトID
_type ファイルのコンテントタイプ
_filename ファイル名
_tags タグ( お客様が自由に設定できる項目 )の配列
_uri バイナリ取得用エンドポイント
_length バイナリデータ