The PROMS Server API

Endpoints

Name Description Access
Instance viewer Accesses a single object from the provenance database

/instance?_uri={uri}

uri (mandatory): the URI of an object in the provenance database, URL encoded
Register viewer Accesses a register of a single class of object from the provenance database

/register?_uri={uri}

uri (mandatory): the URI of a class of object in the provenance database, URL encoded
Register viewer, class name Accesses a register of a single one class of object from the provenance database using the class name, not the full URI of the class

/register/{class_name}/

class_names available are:
  • Activity
  • Agent
  • Entity
  • Person
  • Report
  • ReportingSystem
SPARQL endpoint Provides a read-only SPARQL 1.1 endpoint for the provenance database

/function/sparql

See the SPARQL endpoint itself for documentation of use
Lodge a ReportingSystem Manually register a ReportingSystem for which Reports can then be sent to this PROMS Server instance

/function/lodge-reportingsystem

Create a ReportingSystem Manually create a PROMS ReportingSystem using a web form

/function/create-reportingsystem

Lodge Report POST a Report to this PROMS Server instance

/function/lodge-report

Must be an HTTP POST request containing a valid PROMS Report for a registered ReportingSystem in one of the following RDF mimetypes: 'text/turtle', 'application/rdf+xml', 'application/rdf+json', 'application/json', 'text/ntriples', 'text/nt', 'text/n3'
Create a Report Manually create a PROMS Report to download or send to this PROMS Server instance using a web form

/function/create-report

Lodge Pingback POST a PROV-AQ or a PROMS Pingback to this PROMS Server instance

/function/lodge-pingback

PROV-AQ messages

Must use:

Where {RESOURCE_URI} is the URI of the resource the pingback is sent for. Given that PROV-AQ specifies that a PROV-AQ poingback should be sent to the resource's URI, a redirect from {RESOURCE_URI} --> /function/lodge-pingback?resource_uri={RESOURCE_URI} seems appropriate to implement in front of PROMS Server.

PROMS messages

Must use:

PROMS Pingback messages contain the resource information in their body therefore no query string arguments should be supplied.