Get a Bundle

Bundleの参照先アセットを指定してデータを読み込むAPIです。このAPIによって、アセットを探す手間を省き、より簡単にデータを取得することができます。NewtQueryによって特定の条件を満たすデータを取得します。

Path Parameters
bundleId string — REQUIRED Bundleで一意の識別子(ID)です。bundleIdはバージョン間で共通です。
version string — REQUIRED Bundleのバージョンです。データセットやソースコードの履歴を管理します。
refName string — REQUIRED Bundleに紐づけられている参照先アセットの名前です。references.nameかreferences.slugを指定できます。

Query Parameters
apikey string NewtZeroのアカウントで発行されるAPIキーです。headerで渡す場合は不要です。

Request Body — REQUIRED NewtQueryに合致したデータをNoSQLデータベースもしくはファイルストレージから取得し、JSON形式もしくはバイナリで返します。
collection string Mongoのコレクションに対応しています。コレクションまたはアセットは必ず指定してください。
primaryKey string データのプライマリキーを指定してください。
limit number データを取得する件数を指定できます。
skip number データを取得する際に、取得したいデータの開始位置を指定できます。
order object ソートクエリです。mongoDBのorderクエリと互換性があります。
search object mongoのaggregationのマッチクエリ形式で検索条件を指定できます。リレーショナルされたデータに対しては検索がかけられない代わりに速度が高速になります。リレーショナルされたデータに検索条件を指定したい場合は代わりにmatchパラメータを使用してください。
match object mongoのaggregationのマッチクエリ形式で検索条件を指定できます。リレーショナルの紐付け操作後に検索がかかるため複雑な検索を行えますが速度が遅くなる可能性があります。
shape object shapeの中には[取りたいフィールド]:"any"と指定することで任意のフィールドを取得します。あるいは"any"の代わりにnewtQueryを指定できます。このときprimaryKeyの代わりにrelationKeyフィールドを追加します。これによってprimaryKeyとマッチするデータがリレーショナルに紐づけられます。shapeはdbType=streamGateの場合に必須であり、有効です。
path string 取得したいファイルのパスを指定します。metadata=trueの場合、そのパスの配下のファイル、ディレクトリのパスを取得します。pathはdbType=fileGateの場合にのみ必須であり、有効です。

Responses
200 NewtQueryに合致したデータをNoSQLデータベースもしくはファイルストレージから取得し、JSON形式もしくはバイナリで返します。
401 headerまたはqueryにAPIキーを送信していない場合に認証エラーとして返します。
404 Bundleが見つからない場合、もしくはBundleの参照先アセットが見つからない場合に404エラーとして返します。
500 無効なクエリを送信した場合またはNoSQLデータベース側でエラーが発生した場合に500エラーを返します。