Data Fetcher

アセットからデータを取得するAPIです。JSON形式・ファイルデータの両方に対応しています。dbTypeを指定することによってNoSQLデータベースかファイルストレージからデータを取得することができます。BodyにNewtQueryを記述することによって取得するデータを選択することができます。

Query Parameters
dbType string — REQUIRED アセットのdbTypeを指定してください。streamGateがNoSQLデータベースから、fileGateはファイルストレージからデータを取得します。
newtQuery boolean — REQUIRED データベースから特定の条件に一致するデータを取得するためのクエリです。newtQueryでは、データを取得するコレクション、アセットを指定し、ソート、フィルタリング、集計に対応しています。POSTを使用する際はfalseと指定してnewtQueryはbodyに記載します。
count string 取得するデータの件数を取得します。
metadata boolean ファイルの取得時にのみ使用できます。trueの場合、ファイルのバイナリデータではなく、その配下にあるファイルのパスを返します。
recursive boolean ファイルの取得時かつmetadata=trueの場合にのみ使用できます。そのディレクトリの配下にあるファイルのパスを再起的に返します。

Header Parameters
Authorization string — REQUIRED NewtZeroのアカウントで発行されるAPIキーです。

Request Body — REQUIRED newtQuery
asset string[] アセットのタグを指定して取得先のアセットを指定します。コレクションがTopData, TxnData, RawDataの場合に使用できます。コレクションまたはアセットは必ず指定してください。
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 dbTypeに応じてJSON形式もしくはバイナリ形式のNewtQueryの条件に合致したデータを返します。
400 dbTypeが指定されていない、もしくはbodyが空の場合に発生します。
401 APIキーが指定されていないか間違っている、もしくはNewtQueryで指定したアセットの読み込み権限がない場合に発生します。
500 NoSQLデータベース、もしくはファイルストレージ側でエラーが発生した場合に500エラーを返します。