Skip to content

Provenance API - Overview

Note

This document has been machine translated.

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

Execution Procedure

The Provenance API uses JSON-RPC v2.0.

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

Endpoint.

https://<api-server-endpoint>/api/v1/provenance/jsonrpc

Sessions

In this system, a series of processes are managed by bundling them in a “session”. The user first starts a session begin_session() and then performs data aggregation, conversion, and other processing. To persist the result of processing, the user commits the session with commit(). When processing is finished, end the session with end_session(). If the session is terminated without commit, data generated in 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 for DDC ID

In this system, two types of format can be used to refer to a ddcid: longformat and short format.

  • The long format is a unique identifier in the system and is expressed in the form 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 be generated if there are duplicates.
  • 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 considered an alias for long format rather than an identifier. short format is called in the API, it looks for a ddcid in the session that contains the name in short_form. If more than one is found, the last one created (with the largest CREATED_AT) is chosen. If there is another ddcid with the same short_form in another session, it is not referenced.