データファイル更新APIを実装したい

データファイル更新APIとは

本APIの概要

データファイル更新APIとは、貴社の基幹システム/アプリケーションとb→dashを繋ぐことでb→dash管理画面を介さずにデータファイル更新を行うことができるAPIです。

貴社の基幹システム/アプリケーションに連携したデータファイル更新を行いたい場合は、本API仕様書をご参照のもと貴社開発環境に実装してください。

本APIで更新できるb→dash管理画面上のデータ

b→dash管理画面上の更新結果確認方法

データファイル更新APIは、貴社の基幹システム/アプリケーションのリクエストによりデータパレットアプリのデータファイル更新機能を起動させることでb→dash上のデータファイルを更新します。

データファイル更新APIを利用した結果は以下のb→dash管理画面（「データファイル一覧画面」「データファイル詳細画面」）で確認することができます。

データファイル一覧画面の例

データファイル詳細画面の例

API利用にあたっての前提事項

事前準備

データファイル更新APIを利用する事前準備として、b→dash管理画面上で更新したいデータファイルの「取込設定」を完了させておく必要があります。

更新したいデータファイルが「新規で取り込むデータファイル」で、取込設定がまだ完了していない場合は「データファイルの取込方法」をご参照の上、設定を完了させてください。

更新したいデータファイルが「取込済みデータファイル」で、取込設定をもう一度見直したい場合は「データファイルの取込履歴の確認方法」と「データファイルの取込履歴の編集方法」をご参照の上、設定を完了させてください。

共通仕様

データファイル更新APIでは、b→dash APIの共通仕様も参照する必要があります。
『リクエスト上限数』や『全体サイズ上限』といった共通仕様の詳細については、「b→dash APIの共通仕様を知りたい」をご参照ください。

データファイル更新APIの仕様

処理フロー図

データファイル更新APIの処理フロー図は以下になります。
※グレーアウトしているAPIはデータファイル更新APIと関連する別b→dash API(データファイル更新結果取得API)です

データファイル更新リクエスト

データファイル更新APIのURIにURIパラメータを指定してデータ連携をリクエストするリクエストURIを準備します

〇データファイル更新APIのURI

〇URIパラメータ

【リクエストURIサンプル】

https://api.smart-bdash.com/api/v1/datafiles/191

json形式のファイル(拡張子：.json)にリクエストボディパラメータを指定して、データファイルの更新内容を送信するためのリクエストボディを準備します

〇リクエストボディパラメータ

【リクエストボディサンプル（JSONの配列の場合）】

{
  "action_type": 0,
  "data_type": "json",
  "data": [
    {"COLUMN_1": "aaa", "COLUMN_2": "bbb"},
    {"COLUMN_1": "ccc", "COLUMN_2": "ddd"}
  ]
}

※上記コードは以下の条件の場合のサンプルとなります
data_type：json

【リクエストボディサンプル（二次元配列の場合）】

{ 
  "action_type": 0, 
  "data_type": "array", 
  "data": [ 
    ["COLUMN_1", "COLUMN_2"], 
    ["aaa", "bbb"], 
    ["ccc", "ddd"] 
  ] 
} 

※上記コードは以下の条件の場合のサンプルとなります
data_type：array

準備したリクエストURI/リクエストボディと、下記のリクエストヘッダパラメータを用いて、貴社Webアプリから「POST」リクエスト形式でデータファイル更新のリクエストをします

〇リクエスト形式

〇リクエストヘッダパラメータ

【リクエストコードサンプル】

POST https://sandbox-api.bdash.works/api/v1/datafiles/191

データファイル更新受付レスポンス

リクエストの送信に成功すると、下記のレスポンス形式でデータファイル更新APIからレスポンスが返されます

〇レスポンスボディパラメータ

〇リクエストエラー発生時のエラーメッセージ詳細

【レスポンスボディサンプル（成功レスポンス（202））】

{
  "result": {
  "code": 202,
  "process_code": "9924502028"
 }
}