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

データファイル更新結果取得APIとは

本APIの概要

データファイル更新結果取得APIとは、「データファイル更新API」にて起動されたデータファイル更新処理の結果を返すAPIです。

貴社の基幹システム/アプリケーションが「データファイル更新API」または「一括データファイル更新API」を実装しており、データファイル更新処理の結果をAPIで取得したい場合は、本API仕様書をご参照のもと貴社開発環境に実装してください。

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

事前準備

データファイル更新結果取得APIを利用する事前準備として、本APIのリクエストを行う前に(一括)データファイル更新APIによってデータファイル更新リクエストが送信されており、データファイル更新リクエストに対してエラーステータスが返されていない必要があります。

データファイル更新リクエストを行っていない状態、あるいはエラーステータスが返されている状態で本APIを起動すると正常なデータ更新処理結果を出力できないためご注意ください。

共通仕様

データファイル更新結果取得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/data_import/9924502028/result

〇リクエスト形式

GET https://api.smart-bdash.com/api/v1/data_import/9924502028/result

データファイル更新処理結果取得レスポンス

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

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

〇取込エラー発生時のステータス/エラーメッセージ詳細

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

【レスポンスボディサンプル（リクエスト成功（code：「200」）/
データファイル更新処理中の場合）】

{ 
  "result": { 
    "code": "200", 
    "data_import_result": { 
      "status": "processing", 
      "errors": [] 
    }
  }
}

【レスポンスボディサンプル（リクエスト成功（code：「200」）/
データファイル取込設定が「[取込エラー時]エラーが含まれる行を削除する」場合）】

{ 
  "result": { 
    "code": "200", 
    "data_import_result": { 
      "status": "ok_skip", 
      "errors": [
        {
          "message": "Data import process succeeded. But 10 records has skipped because contained any errores."
        }
      ] 
    }
  }
}