Skip to content

Using Provenance Function

This document has been machine translated.

Provenance Web API is an API for using provenance functions as a Web API.

Execution steps

The Provenance Web API uses JSON-RPC v2.0.

To execute the Provenance Web API using JSON-RPC, POST the request data (string) written in JSON format to the URL of the web service endpoint provided by EvWH.

API Key

To use this API, you need an API key and a secret key. Please apply to your system administrator to obtain them.

When sending an HTTP request, you need to send the following key names in the HTTP header section.

  • API key: APIKey
  • Secret key：Secret

Endpoint

The endpoint of this API is https://pf.xdata.nict.jp/api/v1/provenance/jsonrpc.

Session

In this system, a series of processes are bundled and managed in a "session". A user first starts a session with begin_session(), and then processes data aggregation, conversion, and so on. To make the result persistent, commit the session. When the processing is finished, end the session with end_session(). If the session is terminated without committing, the data generated during the process will be lost.

What is DDC?

In this system, a table and a view that stores calculation and generation results are identified by DDC.

Naming convention of DDC ID

In this system, you can use two kinds of formats when referring to a ddcid: longformat and short format.

  • The long format is a unique identifier in the system and is expressed in the format ddc:<name>_<timestamp>.
  • Example: ddc:domingo_fujisawa_1581208615.64964
  • The name part can be specified by the user when generating the ddcid, but an error will occur if there is a duplicate.
  • The shortformat is a contraction and is expressed in the form ddc:<name>.
  • Example: ddc:domingo_fujisawa
  • Since short format is not unique, it should be thought of as an alias to long format rather than an identifier. when the API is called with short format, it will look for a ddcid in the session whose short_form contains that name. If more than one is found, the last one created (the one with the largest created_at) is chosen. If there is a ddcid with the same short_form in another session, it will not be referenced.

API List