Service-Provenance.html


<!DOCTYPE HTML>
<html lang="" >
    <head>
        <meta charset="UTF-8">
        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
        <title>Provenance Service · GitBook</title>
        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
        <meta name="description" content="">
        <meta name="generator" content="GitBook 3.2.3">
        
        
    <link rel="stylesheet" href="gitbook/style.css">

    
                <link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-git-author/style.css">
                
            
    <meta name="HandheldFriendly" content="true"/>
    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
    <meta name="apple-mobile-web-app-capable" content="yes">
    <meta name="apple-mobile-web-app-status-bar-style" content="black">
    <link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
    <link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">

    
    <link rel="next" href="Examples-Provenance-Service.html" />
    
    
    <link rel="prev" href="MessageBroker-RabbitMQ.html" />
    

    </head>
    <body>
        
<div class="book">
    <div class="book-summary">
        
            
<div id="book-search-input" role="search">
    <input type="text" placeholder="Type to search" />
</div>

            
                <nav role="navigation">
                

<ul class="summary">
    
    
        <li class="header">ATTX Project</li>
        
        
        <li class="chapter " data-level="1.1" data-path="./">
            
                <a href="./">
            
                    
                    ATTX Project
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.2" >
            
                <span>
            
                    
                    Applications and Use Cases
            
                </span>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.2.1" data-path="Use-case-Infrastructures-and-publications.html">
            
                <a href="Use-case-Infrastructures-and-publications.html">
            
                    
                    UC1 - Infrastructure and Publications
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.2.2" data-path="Use-case-Jyvaskyla.html">
            
                <a href="Use-case-Jyvaskyla.html">
            
                    
                    UC2 - Parallel Publication Dashboard
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.2.3" data-path="Use-case-Metax.html">
            
                <a href="Use-case-Metax.html">
            
                    
                    UC3 - Metax
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.2.4" data-path="Use-case-Mildred.html">
            
                <a href="Use-case-Mildred.html">
            
                    
                    UC4 - Mildred
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.3" data-path="ATTX-Architecture-Overview.html">
            
                <a href="ATTX-Architecture-Overview.html">
            
                    
                    ATTX Architecture Overview
            
                </a>
            

        </li>
    

        <li class="header">Getting Started</li>
        
        
        <li class="chapter " data-level="2.1" data-path="ATTX-Broker-Deployment.html">
            
                <a href="ATTX-Broker-Deployment.html">
            
                    
                    ATTX Broker Deployment
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="2.1.1" >
            
                <span>
            
                    
                    Run on Single Machine PC/Mac/VM
            
                </span>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="2.1.1.1" data-path="Building-Docker-application-stacks-in-Swarm-Mode.html">
            
                <a href="Building-Docker-application-stacks-in-Swarm-Mode.html">
            
                    
                    Building Swarm Mode on a PC/Mac
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="2.1.1.2" data-path="Running-the-ATTX-containerised-application-stack-in-your-own-PC-or-Mac.html">
            
                <a href="Running-the-ATTX-containerised-application-stack-in-your-own-PC-or-Mac.html">
            
                    
                    Running the ATTX Stack on a PC/Mac
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="2.1.2" >
            
                <span>
            
                    
                    Run on Distributed/Cloud
            
                </span>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="2.1.2.1" data-path="Provisioning-ATTX-Components-on-CSC-Open-Stack-cPouta.html">
            
                <a href="Provisioning-ATTX-Components-on-CSC-Open-Stack-cPouta.html">
            
                    
                    Provisioning ATTX Components on CSC Open Stack (cPouta)
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="2.1.2.2" data-path="Deploying-ATTX-Components-on-Docker-Swarm.html">
            
                <a href="Deploying-ATTX-Components-on-Docker-Swarm.html">
            
                    
                    Deploying ATTX Components on Docker Swarm
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="2.1.2.3" data-path="Shared-NFS-Swarm-Cloud.html">
            
                <a href="Shared-NFS-Swarm-Cloud.html">
            
                    
                    Setting-up a shared NFS filesystem in Docker Swarm running in CSC cPouta
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="2.1.2.4" data-path="Applying-Rolling-Updates-to-services-in-Docker-Swarm.html">
            
                <a href="Applying-Rolling-Updates-to-services-in-Docker-Swarm.html">
            
                    
                    Applying Rolling Updates to Services in Docker Swarm
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="2.1.3" data-path="Deploying-ATTX-SB-on-Kontena.html">
            
                <a href="Deploying-ATTX-SB-on-Kontena.html">
            
                    
                    Deploying ATTX Broker on Kontena
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    

        <li class="header">Core Components</li>
        
        
        <li class="chapter " data-level="3.1" data-path="ATTX-Component-Workflow.html">
            
                <a href="ATTX-Component-Workflow.html">
            
                    
                    Workflow Component
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="3.1.1" data-path="ETL-Artifacts.html">
            
                <a href="ETL-Artifacts.html">
            
                    
                    ETL Artifacts
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="3.1.2" data-path="Unified-Views-plugins.html">
            
                <a href="Unified-Views-plugins.html">
            
                    
                    UnifiedViews Plugins
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="3.1.3" data-path="Service-UVProvenance.html">
            
                <a href="Service-UVProvenance.html">
            
                    
                    UVProvovenance Service
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="3.2" data-path="ATTX-Component-Graph.html">
            
                <a href="ATTX-Component-Graph.html">
            
                    
                    Graph Component
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="3.2.1" data-path="Service-Graph-Manager.html">
            
                <a href="Service-Graph-Manager.html">
            
                    
                    Graph Manager Service
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="3.2.1.1" data-path="Examples-Graph-Manager-Service.html">
            
                <a href="Examples-Graph-Manager-Service.html">
            
                    
                    Graph Manager Message Examples
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="3.2.2" data-path="Graph-Store.html">
            
                <a href="Graph-Store.html">
            
                    
                    Graph Store
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="3.2.2.1" data-path="ATTX-Data-Model.html">
            
                <a href="ATTX-Data-Model.html">
            
                    
                    Ontology/Data model
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="3.2.3" data-path="Linking-Strategies.html">
            
                <a href="Linking-Strategies.html">
            
                    
                    Linking Strategies
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="3.3" data-path="ATTX-Component-Distribution.html">
            
                <a href="ATTX-Component-Distribution.html">
            
                    
                    Distribution Component
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="3.3.1" data-path="ElasticSearch-with-Siren.html">
            
                <a href="ElasticSearch-with-Siren.html">
            
                    
                    ElasticSearch 1.3 with Siren
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="3.3.2" data-path="ElasticSearch-5.html">
            
                <a href="ElasticSearch-5.html">
            
                    
                    ElasticSearch 5.x
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="3.3.3" data-path="Dissemination-Workflow.html">
            
                <a href="Dissemination-Workflow.html">
            
                    
                    How Dissemination worflows work
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="3.4" data-path="ATTX-Component-ServiceDiscovery.html">
            
                <a href="ATTX-Component-ServiceDiscovery.html">
            
                    
                    Service Discovery
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="3.4.1" data-path="Consul-ServiceDiscovery-Implementation.html">
            
                <a href="Consul-ServiceDiscovery-Implementation.html">
            
                    
                    Consul Service Discovery Implementation
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="3.4.2" data-path="Consul-for-Service-Discovery-on-Docker-Swarm.html">
            
                <a href="Consul-for-Service-Discovery-on-Docker-Swarm.html">
            
                    
                    Consul for Service Discovery on Docker Swarm
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="3.5" data-path="ATTX-Component-MessageBroker.html">
            
                <a href="ATTX-Component-MessageBroker.html">
            
                    
                    Message Broker
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="3.5.1" data-path="MessageBroker-ActiveMQ.html">
            
                <a href="MessageBroker-ActiveMQ.html">
            
                    
                    ActiveMQ Message Broker
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="3.5.2" data-path="MessageBroker-RabbitMQ.html">
            
                <a href="MessageBroker-RabbitMQ.html">
            
                    
                    RabbitMQ Message Broker
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    

        <li class="header">Broker Services</li>
        
        
        <li class="chapter active" data-level="4.1" data-path="Service-Provenance.html">
            
                <a href="Service-Provenance.html">
            
                    
                    Provenance Service
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="4.1.1" data-path="Examples-Provenance-Service.html">
            
                <a href="Examples-Provenance-Service.html">
            
                    
                    Provenance Messages Examples
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="4.2" data-path="Service-RML.html">
            
                <a href="Service-RML.html">
            
                    
                    RML Service
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="4.2.1" data-path="Examples-RML-Service.html">
            
                <a href="Examples-RML-Service.html">
            
                    
                    RML Messages Examples
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="4.3" data-path="Service-Indexing.html">
            
                <a href="Service-Indexing.html">
            
                    
                    Indexing Service
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="4.3.1" data-path="Examples-Indexing-Service.html">
            
                <a href="Examples-Indexing-Service.html">
            
                    
                    Indexing Messages Examples
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="4.4" data-path="Service-Graph-Framing.html">
            
                <a href="Service-Graph-Framing.html">
            
                    
                    Graph Framing Service
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="4.4.1" data-path="Examples-Graph-Framing-Service.html">
            
                <a href="Examples-Graph-Framing-Service.html">
            
                    
                    Graph Framing Messages Examples
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="4.5" data-path="Service-Validation.html">
            
                <a href="Service-Validation.html">
            
                    
                    Validation Service
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="4.5.1" data-path="Examples-Validation-Service.html">
            
                <a href="Examples-Validation-Service.html">
            
                    
                    Validation Examples
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="4.6" data-path="Service-Ontology.html">
            
                <a href="Service-Ontology.html">
            
                    
                    Ontology Service
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="4.6.1" data-path="Examples-Ontology-Service.html">
            
                <a href="Examples-Ontology-Service.html">
            
                    
                    Ontology Examples
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    

        <li class="header">User Guide</li>
        
        
        <li class="chapter " data-level="5.1" data-path="User-Guide-Administrator.html">
            
                <a href="User-Guide-Administrator.html">
            
                    
                    Data Administrator's User guide
            
                </a>
            

        </li>
    

        <li class="header">Development Guidelines</li>
        
        
        <li class="chapter " data-level="6.1" data-path="ATTX-Development-Environment.html">
            
                <a href="ATTX-Development-Environment.html">
            
                    
                    ATTX Development Environment
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="6.2" data-path="Feature-roadmap.html">
            
                <a href="Feature-roadmap.html">
            
                    
                    Feature Roadmap
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="6.3" data-path="Release-Plan.html">
            
                <a href="Release-Plan.html">
            
                    
                    Release Plan
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="6.4" data-path="CI-CD-Enviroment.html">
            
                <a href="CI-CD-Enviroment.html">
            
                    
                    CI/CD Enviroment
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="6.4.1" data-path="Jenkins-CI.html">
            
                <a href="Jenkins-CI.html">
            
                    
                    Jenkins CI
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="6.4.2" data-path="Build-Environment-Setup.html">
            
                <a href="Build-Environment-Setup.html">
            
                    
                    Build Environment Setup
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="6.4.3" data-path="Containerized-testing.html">
            
                <a href="Containerized-testing.html">
            
                    
                    Containerized Testing
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    

        <li class="header">Reports & Contributions</li>
        
        
        <li class="chapter " data-level="7.1" >
            
                <span>
            
                    
                    Reports
            
                </span>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="7.1.1" data-path="CSC-cPouta-Cloud-Services-Report.html">
            
                <a href="CSC-cPouta-Cloud-Services-Report.html">
            
                    
                    CSC cPouta Cloud Services Report
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="7.1.2" data-path="Building-with-Gradle.html">
            
                <a href="Building-with-Gradle.html">
            
                    
                    Building with (Py)Gradle
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="7.1.3" data-path="Messaging-Brokers-Solutions.html">
            
                <a href="Messaging-Brokers-Solutions.html">
            
                    
                    Messaging Brokers Solutions Overview
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="7.1.4" data-path="Service-Discovery-Solutions.html">
            
                <a href="Service-Discovery-Solutions.html">
            
                    
                    Service Discovery Solutions Overview
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="7.1.5" data-path="Workflow-Management-Tools.html">
            
                <a href="Workflow-Management-Tools.html">
            
                    
                    Workflow Management Tools Overview
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="7.1.6" data-path="Solutions-API-Gateway.html">
            
                <a href="Solutions-API-Gateway.html">
            
                    
                    API Gateway Solutions Overview
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="7.2" >
            
                <span>
            
                    
                    Presentations
            
                </span>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="7.2.1" data-path="Presentation-ELAG-2017.html">
            
                <a href="Presentation-ELAG-2017.html">
            
                    
                    ELAG2017
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="7.2.2" data-path="Presentation-OSFair-2017.html">
            
                <a href="Presentation-OSFair-2017.html">
            
                    
                    OSFair2017
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="7.2.3" data-path="Presentation-SWIB-2017.html">
            
                <a href="Presentation-SWIB-2017.html">
            
                    
                    SWIB2017
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="7.2.4" data-path="Presentation-ISWC-2017.html">
            
                <a href="Presentation-ISWC-2017.html">
            
                    
                    ISWC2017
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="7.3" data-path="Open-Contributions.html">
            
                <a href="Open-Contributions.html">
            
                    
                    Open Source Contributions
            
                </a>
            

        </li>
    

        <li class="divider"></li>
        
        
        <li class="chapter " data-level="8.1" >
            
                <a target="_blank" href="https://www.helsinki.fi/en/projects/attx-2016">
            
                    
                    ATTX website
            
                </a>
            

        </li>
    

    <li class="divider"></li>

    <li>
        <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
            Published with GitBook
        </a>
    </li>
</ul>


                </nav>
            
        
    </div>

    <div class="book-body">
        
            <div class="body-inner">
                
                    
<div class="book-header" role="navigation">
    

    <!-- Title -->
    <h1>
        <i class="fa fa-circle-o-notch fa-spin"></i>
        <a href="." >Provenance Service</a>
    </h1>
</div>


                    <div class="page-wrapper" tabindex="-1" role="main">
                        <div class="page-inner">
                            
<div id="book-search-results">
    <div class="search-noresults">
    
                                <section class="normal markdown-section">
                                
                                <div class="git-author-container git-author-top"><div class="modified">Current page last modified at: 07-Dec-2017 11:39:31</div></div><h1 id="provenance-service">Provenance Service</h1>
<p>Github repository: <a href="https://github.com/ATTX-project/provenance-service" target="_blank">https://github.com/ATTX-project/provenance-service</a></p>
<p>Considering a Microservices oriented system we identify two means of introducing a Provenance system in such a system:</p>
<ul>
<li><strong>Explicit Provenance</strong> Making all services of that system provenance aware - meaning each service will have to send messages to the Provenance Services that contain provenance related information;</li>
<li><strong>Implicit Provenance</strong> Enable the system to capture in the communication between distinct services provenance related information and distribute it to the Provenance Service.</li>
</ul>
<h3 id="table-of-contents">Table of Contents</h3>
<!-- TOC START min:1 max:3 link:true update:true -->
<ul>
<li><a href="#overview">Overview</a></li>
<li><a href="#building-provenance-service">Building Provenance Service</a><ul>
<li><a href="#graph-store-connection">Graph Store Connection</a></li>
<li><a href="#message-broker-connection">Message Broker Connection</a></li>
</ul>
</li>
<li><a href="#environment-variables">Environment Variables</a></li>
<li><a href="#service-api-endpoints">Service API Endpoints</a><ul>
<li><a href="#health-endpoint">health Endpoint</a></li>
<li><a href="#graph-endpoint">graph Endpoint</a></li>
<li><a href="#prov-endpoint">prov Endpoint</a></li>
</ul>
</li>
<li><a href="#requestresponse-documents">Request/response documents</a></li>
</ul>
<!-- TOC END -->
<h2 id="overview">Overview</h2>
<p>The Provenance Service REST API has the following endpoints:</p>
<ul>
<li><code>graph</code> - managing interaction with the Graph Store and retrieving statistics about it (e.g. list of named graphs, number of queries);</li>
<li><code>prov</code> - endpoint for registering provenance information directly;</li>
<li><code>index</code> - index provenance information in Elasticsearch;</li>
<li><code>status</code> - status of a provenance job with a specific ID;</li>
<li><code>health</code> - checks if the application is running.</li>
</ul>
<p>Current version: <code>0.2</code> (URL for the endpoint should take into consideration for the API <code>http://host:7030/version/endpoint</code>)</p>
<h2 id="building-provenance-service">Building Provenance Service</h2>
<p>In order to work with the service start with:</p>
<ul>
<li><a href="https://github.com/ATTX-project/provenance-service" target="_blank">Provenance Service source</a> - contains information on building both the project and the  Docker image and testing from the source code;</li>
<li>short tutorial on <a href="Building-with-Gradle.html">Gradle</a>.</li>
</ul>
<h3 id="graph-store-connection">Graph Store Connection</h3>
<p>The Provenance service requires a connection with the <a href="Graph-Store.html">Graph Store</a>.
A graph store connection is required in order to:</p>
<ul>
<li>perform operations on the graph data stored such as update and replace;</li>
<li>query and retrieve graph data.</li>
</ul>
<h3 id="message-broker-connection">Message Broker Connection</h3>
<p>Provenance Service needs <a href="MessageBroker-RabbitMQ.html">RabbitMQ Message Broker</a> in order to communicate with other services that want to register provenance information in the Graph Store.</p>
<h3 id="elasticsearch-connection">Elasticsearch Connection</h3>
<p>In order to index provenance data into Elasticsearch, we require both the <a href="Service-Graph-Framing.html">Graph Framing Service</a> and the <a href="Service-Indexing.html">Indexing Service</a>. The parameters for these services as as follows:</p>
<ul>
<li>alias: <code>attx</code>;</li>
<li>document type: name graph in Graph Store e.g. if the named graph is <code>http://data.hulib.helsinki.fi/prov_workflow1_activity6</code> the document type is <code>workflow1_activity6</code>.</li>
</ul>
<p>Provenance JSON-LD frame:</p>
<pre><code class="lang-json">{
  <span class="hljs-string">&quot;@type&quot;</span>: <span class="hljs-string">&quot;http://www.w3.org/ns/prov#Activity&quot;</span>,
  <span class="hljs-string">&quot;http://www.w3.org/ns/prov#qualifiedAssociation&quot;</span>: {
    <span class="hljs-string">&quot;@explicit&quot;</span>: <span class="hljs-string">&quot;true&quot;</span>,
    <span class="hljs-string">&quot;http://www.w3.org/ns/prov#hadPlan&quot;</span>: {
      <span class="hljs-string">&quot;@explicit&quot;</span>: <span class="hljs-literal">true</span>,
      <span class="hljs-string">&quot;http://www.w3.org/2000/01/rdf-schema#label&quot;</span>: <span class="hljs-string">&quot;&quot;</span>
    }
  },
  <span class="hljs-string">&quot;http://www.w3.org/ns/prov#qualifiedCommunication&quot;</span>: {
    <span class="hljs-string">&quot;@explicit&quot;</span>: <span class="hljs-string">&quot;true&quot;</span>,
    <span class="hljs-string">&quot;http://www.w3.org/ns/prov#activity&quot;</span>: <span class="hljs-string">&quot;&quot;</span>
  },
  <span class="hljs-string">&quot;http://www.w3.org/ns/prov#qualifiedGeneration&quot;</span>: {
    <span class="hljs-string">&quot;@explicit&quot;</span>: <span class="hljs-string">&quot;true&quot;</span>,
    <span class="hljs-string">&quot;http://www.w3.org/ns/prov#entity&quot;</span>: <span class="hljs-string">&quot;&quot;</span>
  },
  <span class="hljs-string">&quot;http://www.w3.org/ns/prov#qualifiedUsage&quot;</span>: {
    <span class="hljs-string">&quot;@explicit&quot;</span>: <span class="hljs-string">&quot;true&quot;</span>,
    <span class="hljs-string">&quot;http://www.w3.org/ns/prov#entity&quot;</span>: <span class="hljs-string">&quot;&quot;</span>
  }
}
</code></pre>
<h2 id="environment-variables">Environment Variables</h2>
<ul>
<li><code>MHOST</code> - container name or address for the MessageBroker-RabbitMQ database (defaults to <code>localhost</code>);</li>
<li><code>MUSER</code> - user name for MessageBroker (defaults to <code>user</code>);</li>
<li><code>MQUEUE</code> - provenance queue in the MessageBroker (defaults to <code>provenance.inbox</code>);</li>
<li><code>FRAMEQUEUE</code>- Graph Framing queue in the MessageBroker (defaults to <code>attx.ldframe.inbox</code>);</li>
<li><code>INDEXQUEUE</code>- Elasticsearch Indexing queue in the MessageBroker (defaults to <code>attx.indexing.inbox</code>);</li>
<li><code>MKEY</code> - password for MessageBroker (defaults to <code>password</code>);</li>
<li><code>GHOST</code> - Graph Store container name or address (defaults to <code>localhost</code>);</li>
<li><code>GPORT</code> - Graph Store port (defaults to <code>3030</code>);</li>
<li><code>GKEY</code> - Graph Store password (defaults to <code>pw123</code>);</li>
<li><code>DS</code> - Graph Store working dataset (defaults to <code>ds</code>);</li>
<li><code>FRAMEHOST</code> - container name for Graph Framing Service (defaults to <code>localhost</code>);</li>
<li><code>FRAMEVER</code> - version of the Graph Framing Service API (defaults to <code>0.2</code>);</li>
<li><code>FRAMEPORT</code> - port for the Graph Framing Service (defaults to <code>4303</code>);</li>
<li><code>INDEXHOST</code>- container name for the Elasticsearch Indexing Service (defaults to <code>localhost</code>);</li>
<li><code>INDEXVER</code> - version of the Elasticsearch Indexing Service API (defaults to <code>0.2</code>);</li>
<li><code>INDEXPORT</code> - port for the Elasticsearch Indexing Service (defaults to <code>4304</code>);</li>
<li><code>QTIME</code> - variable to set up the timer for publisher (defaults to 9 minutes and input must be integer).</li>
</ul>
<h2 id="service-api-endpoints">Service API Endpoints</h2>
<h3 id="health-endpoint">health Endpoint</h3>
<ul>
<li><code>health</code> GET API:<ul>
<li>simple: <a href="http://localhost:7030/health" target="_blank">http://localhost:7030/health</a> reponds with <code>200</code> in order for other applications to know the service is running.</li>
</ul>
</li>
</ul>
<h3 id="graph-endpoint">graph Endpoint</h3>
<ul>
<li><p><code>graph/query</code></p>
<ul>
<li><p>Request:</p>
<pre><code class="lang-json">{
<span class="hljs-string">&quot;namedGraph&quot;</span>: <span class="hljs-string">&quot;default&quot;</span>,
<span class="hljs-string">&quot;query&quot;</span>: <span class="hljs-string">&quot;SELECT ?subject ?predicate ?object WHERE { ?subject ?predicate ?object} LIMIT 25&quot;</span>
}
</code></pre>
</li>
</ul>
</li>
<li><code>graph/update</code> POST API:<ul>
<li>Request:<pre><code class="lang-json">{
<span class="hljs-string">&quot;namedGraph&quot;</span>: <span class="hljs-string">&quot;http://data.hulib.helsinki.fi/attx/strategy&quot;</span>,
<span class="hljs-string">&quot;triples&quot;</span>: <span class="hljs-string">&quot;&lt;http://example/egbook3&gt; &lt;http://purl.org/dc/elements/1.1/title&gt;  \&quot;This is an example title\&quot;.&quot;</span>
}
</code></pre>
</li>
</ul>
</li>
<li><code>graph?uri={graphURI}</code></li>
<li><code>graph/list</code> GET API</li>
<li><code>graph/statistics</code> GET API</li>
</ul>
<h3 id="prov-endpoint">prov Endpoint</h3>
<ul>
<li><code>prov</code> POST API - register provenance message. The response is a status of a task if the message was processed along with a task ID</li>
<li><code>status/task/{task_id}</code> GET API - retrieved the processed provenance with a given task ID</li>
</ul>
<h2 id="requestresponse-documents">Request/response documents</h2>
<p>See <a href="Examples-Provenance-Service.html">Provenance examples</a></p>

                                
                                </section>
                            
    </div>
    <div class="search-results">
        <div class="has-results">
            
            <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
            <ul class="search-results-list"></ul>
            
        </div>
        <div class="no-results">
            
            <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
            
        </div>
    </div>
</div>

                        </div>
                    </div>
                
            </div>

            
                <a href="MessageBroker-RabbitMQ.html" class="navigation navigation-prev " aria-label="Previous page: RabbitMQ Message Broker">
                    <i class="fa fa-angle-left"></i>
                </a>
                
                
                <a href="Examples-Provenance-Service.html" class="navigation navigation-next " aria-label="Next page: Provenance Messages Examples">
                    <i class="fa fa-angle-right"></i>
                </a>
                
            
    </div>

    <script>
        var gitbook = gitbook || [];
        gitbook.push(function() {
            gitbook.page.hasChanged({"page":{"title":"Provenance Service","level":"4.1","depth":1,"next":{"title":"Provenance Messages Examples","level":"4.1.1","depth":2,"path":"Examples-Provenance-Service.md","ref":"Examples-Provenance-Service.md","articles":[]},"previous":{"title":"RabbitMQ Message Broker","level":"3.5.2","depth":2,"path":"MessageBroker-RabbitMQ.md","ref":"MessageBroker-RabbitMQ.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":["highlight","fontsettings","search","git-author","gitversion","copy-code-button"],"pluginsConfig":{"gitversion":{},"git-author":{"position":"top","modifyTpl":"Current page last modified at: {timeStamp}","createTpl":false,"timeStampFormat":"DD-MMM-YYYY HH:mm:ss"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"family":"sans","size":2,"theme":"white"},"fontSettings":{"size":1},"highlight":{},"copy-code-button":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"Service-Provenance.md","mtime":"2018-07-10T08:39:38.258Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-07-12T07:02:52.974Z"},"basePath":".","book":{"language":""}});
        });
    </script>
</div>

        
    <script src="gitbook/gitbook.js"></script>
    <script src="gitbook/theme.js"></script>
    
        
        <script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-search/search.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-copy-code-button/toggle.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
        
    
    </body>
</html>