REST-API

Capturer API

POST capturer/process-event

Allows to send an event to SimProv for processing.

See Building a Provenance Capturer

Web API

GET /provenance-data

Returns the provenance graph for the webinterface in the Cytoscape JSON format.

Query Parameters:

  • showReducedGraph – true if the reduced graph shall be displayed in the web interface; false otherwise

  • reduceTransitive – true if the transitive closure of the graph shall be computered; false otherwise

  • hideNodes – true if nodes that are markd as hidden shall be removed from the graph; false otherwise

  • splitAgents – true if agents shall be split in the graph; false otherwise

GET /node-data

Returns the node data in JSON.

Query Parameters:

  • id – The id of the node

  • reducedGraph – true if the node information shall be collected from the reduced graph

POST /update-entity

Updates the node data of an entity.

Request JSON Object:

  • id – The id of the node

  • changes – Object with keys are the names of the attributes and the value are the new values

POST /update-activity

Updates the dependencies of an activity.

Request JSON Object:

  • id – The id of the node

  • changes – Object with keys are the source ids and values are the target ids

POST /check-dependency-froms-cycle

Checks whether the new dependencies form a circle

Request JSON Object:

  • node – The id of the node

  • changes – Object with keys are the source ids and values are the target ids

Response JSON Object:

  • result – True if depedencies form a cycle, False otherwise

GET /event-log

Returns all collected events in JSON.

GET /error-log
GET Returns all collected errors in JSON.
GET /graph-style

Returns all the graph style for rendering the provenance graph in JSON.

GET /graph-events

Allows to download a file with all events.

GET /graph-json

Allows to download a file with all provenance information formatted in PROV-JSON.

Query Parameters:

  • showReducedGraph – true if the reduced graph shall be exported, false otherwise

  • reduceTransitive – true if the transitive closure of the graph shall be computered; false otherwise

  • hideNodes – true if nodes that are markd as hidden shall be removed from the graph; false otherwise

  • splitAgents – true if agents shall be split in the graph; false otherwise

GET /graph-dot

Allows to download a DOT file containing the provenance graph.

Query Parameters:

  • showReducedGraph – true if the reduced graph shall be exported, false otherwise

  • reduceTransitive – true if the transitive closure of the graph shall be computered; false otherwise

  • hideNodes – true if nodes that are markd as hidden shall be removed from the graph; false otherwise

  • splitAgents – true if agents shall be split in the graph; false otherwise