Skip to content

Provenance Web API

Provenance Web API は、プロベナンスの機能をWeb APIとして利用するためのAPIです。

実行手順

Provenance Web APIでは JSON-RPC v2.0 を利用します。

JSON-RPC を用いてProvenance Web APIを実行するには、 JSON 形式で記述した リクエストデータ（文字列）を EvWH が提供するウェブサービスのエンドポイントの URL に POST してください。

APIキー

当APIの利用にはAPIキーと秘密鍵が必要です。システムの管理者に申請して取得してください。

HTTPリクエスト送信時のHTTPヘッダ部に、それぞれ下記のヘッダ名で送信する必要があります。

  • APIキー：APIKey
  • 秘密鍵：Secret

エンドポイント

当APIのエンドポイントは https://pf.xdata.nict.jp/api/v1/provenance/jsonrpc となります。

セッション

本システムでは、一連の処理を「セッション」で束ねて管理します。ユーザはまずセッションを開始begin_session()し、データの集約や変換等の処理を行います。処理結果を永続化するにはコミットcommit()します。処理が終わったらセッションを終了end_session()します。コミットせずに終了した場合、途中で生成されたデータは失われます。

DDCとは

本システムでは、計算結果や生成結果を保存する一つのテーブル及びビューを DDC で識別します。

DDC IDの命名規則

本システムでは，ddcidを参照する際にlongformat と short format の二種類を用いることができます。

  • long format はシステム内で一意な識別子で、ddc:<name>_<timestamp> という形式で表現されます。
  • 例: ddc:domingo_fujisawa_1581208615.64964
  • nameの部分はddcidを生成する際にユーザが指定できますが、重複があった場合にはエラーになります。
  • shortformatは短縮形で，ddc:<name> という形式で表現されます.
  • 例: ddc:domingo_fujisawa
  • short format は一意ではないため，識別子というよりは long format に対する別名と考えるべきです。short formatでAPIが呼びだされた場合、セッション内の ddcid で short_form にその名前を含むものを探します。複数見つかった場合には最後に作成されたもの(created_at が最大のもの)を選びます。別のセッションに同じ short_form を持つ ddcid があっても参照しません。

API 一覧