データファイル一覧取得APIを実装したい

データファイル一覧取得APIとは

本APIの概要

データファイル一覧取得APIとは、貴社の基幹システム/アプリケーションとb→dashを繋ぐことでb→dash管理画面上の複数のデータファイルの情報を一覧で取得することができるAPIです。

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

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

b→dash管理画面と同等の操作

データファイル一覧取得APIで一覧取得できるデータファイルの情報は、以下のb→dash管理画面（「データファイル一覧画面」）で確認できる「データファイル名」「ステータス」「最終更新日時」と、各データファイル詳細画面のURLから確認できる「データファイルID」の4項目になります。

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

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

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

事前準備

データファイルの取込設定

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

データファイルの取込設定を行っていないデータファイルは本APIではありませんので、データファイルの取込設定がまだ完了していない場合は「データファイルの取込方法」をご参照の上、設定を完了させてください。

共通仕様

データファイル一覧取得APIでは、b→dash APIの共通仕様も参照する必要があります。共通仕様の詳細については「b→dash APIの共通仕様を知りたい」をご参照ください。

データファイル一覧取得APIの仕様

処理フロー図

データファイル一覧取得リクエスト

〇データファイル一覧取得APIのURI

〇リクエスト形式

GET https://api.smart-bdash.com/api/v1/datafilesGET 

データファイル一覧取得レスポンス

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

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

【レスポンスボディサンプル】

{ 
  "result": { 
    "code": 200, 
    "datafiles": [ 
      { 
        "id": "10001", 
        "name": "データファイルＡ", 
        "status": 1, 
        "lastmodified": "2022/06/30 07:00:00" 
      }, 
      { 
        "id": "10002", 
        "name": "データファイルＢ", 
        "status": 2, 
        "lastmodified": "2021/12/31 23:59:59" 
      } 
    ] 
  } 
}