メインコンテンツまでスキップ

Bundle DataGate

Bundleの参照先アセットを指定してデータを書き込むAPIです。このAPIによって、アセットを探す手間を省き、より簡単にデータを保存することができます。保存データはJSON系式、バイナリ形式に対応しており、データのフォーマットに応じてそれぞれNoSQLデータベース、ファイルストレージに保存されます。

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

アセットに保存するデータです。データは保存するアセットのDBTypeに応じてJSON形式もしくはバイナリ形式で送信してください。

any json
Responses
200

データの書き込みに成功たことを示します。JSON形式はNoSQLデータベースに、バイナリ形式のデータはファイルストレージに保存します。JSON形式のデータは、RawData, TxnData, TopDataで書き込みに成功したデータのそれぞれ発行されるハッシュ値を返します。

400

データが無効な場合に400エラーを返します。例えば、送信データにprimaryKeyが無い場合にエラーを返します。

401

headerまたはqueryにAPIキーを送信していない場合に認証エラーとして返します。

404

Bundleが見つからない場合、もしくはBundleの参照先アセットが見つからない場合に404エラーとして返します。

500

無効なクエリを送信した場合またはNoSQLデータベース側でエラーが発生した場合に500エラーを返します。