Adding Monetization Properties

The PISTIS metadata schema is formally defined using SHACL (Shapes Constraint Language) shapes, which provide structure definitions. For monetization property, you can add monetization to your dataset by including its property, such as sellerId, purchaseOffer or investmentOffer, in your payload. Please refer to PISTIS SHACL shapes to see the complete properties.

Dataset With a Purchase Offer

This is an example of creating a dataset with monetization that includes a purchaseOffer.

Turtle
POST https://pistis-market.eu/srv/repo/catalogues/<catalog-id>/datasets
Content-Type: text/turtle
X-API-Key: <api-key>

@prefix dcat:                <http://www.w3.org/ns/dcat#> .
@prefix dct:                 <http://purl.org/dc/terms/> .
@prefix xsd:                 <http://www.w3.org/2001/XMLSchema#> .
@prefix odrl:                <http://www.w3.org/ns/odrl/2/> .
@prefix vcard:               <http://www.w3.org/2006/vcard/ns#> .
@prefix foaf:                <http://xmlns.com/foaf/0.1/> .
@prefix skos:                <http://www.w3.org/2004/02/skos/core#> .
@prefix pst:                 <https://www.pistis-project.eu/ns/voc#> .

<https://pistis-market.eu/set/data/test-dataset>
    a                   dcat:Dataset ;
    dct:description     "Description of a Dataset"@en ;
    dct:title           "Title of a Dataset"@en ;
    dcat:keyword        "Engagement"@en, "Volunteerism"@en, "Stakeholders"@en, "Universities"@en, "Trends"@en   ;
    dct:publisher       [ a     foaf:Organization ;
                                foaf:mbox <mailto:email@publisher.eu> ;
                                foaf:name "Publisher Limited" ; ] ;
    dcat:theme          <http://publications.europa.eu/resource/authority/data-theme/EDUC> ;
    dct:language        <http://publications.europa.eu/resource/authority/language/ENG> ;
    dct:issued          "2023-05-25T00:00:00"^^xsd:dateTime ;
    dct:modified        "2023-05-25T00:00:00"^^xsd:dateTime ;
    dcat:distribution   <https://pistis-market.eu/set/distribution/1> ;
    pst:monetization    <https://pistis-market.eu/set/monetization/1> .

<https://pistis-market.eu/set/distribution/1>
    a              dcat:Distribution ;
    dct:title      "Name of the actual File" ;
    dct:license    [
                        dct:identifier "SUB-LI" ;
                        dct:title "Subscription License" ;
                        skos:prefLabel "Subscription License" ;
                        skos:exactMatch <https://subscriptionlicense.com>
                   ] ;
    dct:format     <http://publications.europa.eu/resource/authority/file-type/CSV> ;
    dcat:byteSize  "1288490189"^^xsd:nonNegativeInteger ;
    dcat:accessURL <http://factory-storage/test-document_company2> .
    
<https://pistis-market.eu/set/monetization/1>
    a                   pst:MonetizationMethod ;
    pst:sellerId        "15e2c4d2-bbea-4119-b3ef-65494f16fa9a" ;
    pst:purchaseOffer   <https://pistis-market.eu/set/purchaseOffer/1> .

<https://pistis-market.eu/set/purchaseOffer/1>
    a                           pst:PurchaseOffer ;
    pst:price                   10 ;
    pst:additionalRenewalTerms  "Additional terms" ;
    pst:contractBreachDays      50 ;
    pst:free                    false ;
    pst:spatialAvailability     "Albania, Algeria" ;
    pst:expirationDate                "2025-12-31T00:00:00"^^xsd:dateTime ;
    pst:type                    "one-off" .
JSON-LD
POST https://pistis-market.eu/srv/repo/catalogues/<catalog-id>/datasets
Content-Type: application/ld+json
X-API-Key: <api-key>

{
    "@context": {
        "dcat": "http://www.w3.org/ns/dcat#",
        "xsd": "http://www.w3.org/2001/XMLSchema#",
        "vcard": "http://www.w3.org/2006/vcard/ns#",
        "foaf": "http://xmlns.com/foaf/0.1/",
        "skos": "http://www.w3.org/2004/02/skos/core#",
        "dcterms": "http://purl.org/dc/terms/",
        "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
        "odrl": "http://www.w3.org/ns/odrl/2/",
        "pst": "https://www.pistis-project.eu/ns/voc#"
    },
    "@graph": [{
            "@id": "_:g0",
            "@type": "foaf:Organization",
            "foaf:mbox": {
                "@id": "mailto:email@publisher.eu"
            },
            "foaf:name": "Publisher Limited"
        },
        {
            "@id": "_:g1",
            "dcterms:identifier": "SUB-LI",
            "dcterms:title": "Subscription License",
            "skos:exactMatch": {
                "@id": "https://subscriptionlicense.com"
            },
            "skos:prefLabel": "Subscription License"
        },
        {
            "@id": "https://pistis-market.eu/set/data/test-dataset",
            "@type": "dcat:Dataset",
            "dcterms:description": {
                "@language": "en",
                "@value": "Description of a Dataset"
            },
            "dcterms:issued": {
                "@type": "xsd:dateTime",
                "@value": "2023-05-25T00:00:00"
            },
            "dcterms:language": {
                "@id": "http://publications.europa.eu/resource/authority/language/ENG"
            },
            "dcterms:modified": {
                "@type": "xsd:dateTime",
                "@value": "2023-05-25T00:00:00"
            },
            "dcterms:publisher": {
                "@id": "_:g0"
            },
            "dcterms:title": {
                "@language": "en",
                "@value": "Title of a Dataset"
            },
            "dcat:distribution": {
                "@id": "https://pistis-market.eu/set/distribution/1"
            },
            "pst:monetization" {
                "@id": "https://pistis-market.eu/set/monetization/1"
            },
            "dcat:keyword": [{
                    "@language": "en",
                    "@value": "Engagement"
                },
                {
                    "@language": "en",
                    "@value": "Volunteerism"
                },
                {
                    "@language": "en",
                    "@value": "Stakeholders"
                },
                {
                    "@language": "en",
                    "@value": "Universities"
                },
                {
                    "@language": "en",
                    "@value": "Trends"
                }
            ],
            "dcat:theme": {
                "@id": "http://publications.europa.eu/resource/authority/data-theme/EDUC"
            }
        },
        {
            "@id": "https://pistis-market.eu/set/distribution/1",
            "@type": "dcat:Distribution",
            "dcterms:format": {
                "@id": "http://publications.europa.eu/resource/authority/file-type/CSV"
            },
            "dcterms:license": {
                "@id": "_:g1"
            },
            "dcterms:title": "Name of the actual File",
            "dcat:accessURL": {
                "@id": "http://factory-storage/test-document_company2"
            },
            "dcat:byteSize": {
                "@type": "xsd:nonNegativeInteger",
                "@value": "1288490189"
            }
        },
        {
            "@id": "https://pistis-market.eu/set/monetization/1",
            "@type": "pst:MonetizationMethod",
            "pst:sellerId": {
                "@value": "15e2c4d2-bbea-4119-b3ef-65494f16fa9a"
            },
            "pst:purchaseOffer": {
                "@id": "https://pistis-market.eu/set/purchaseOffer/1"
            }
        },
        {
            "@id": "https://pistis-market.eu/set/purchaseOffer/1",
            "@type": "pst:PurchaseOffer",
            "pst:price": {
                "@type": "xsd:nonNegativeInteger",
                "@value": "10"
            },
            "pst:additionalRenewalTerms": {
                "@value": "Additional terms"
            },
            "pst:free": {
                "@value": false
            },
            "pst:spatialAvailability": {
                "@value": "Albania, Algeria"
            },
            "pst:expirationDate": {
                "@type": "xsd:dateTime",
                "@value": "2028-07-29T00:00:00"
            },
            "pst:type": {
                "@value": "one-off"
            }
        }
    ]
}

Dataset With an Investment Offer

This is an example of creating a dataset with monetization that includes an investmentOffer.

Turtle
POST https://pistis-market.eu/srv/repo/catalogues/<catalog-id>/datasets
Content-Type: text/turtle
X-API-Key: <api-key>

@prefix dcat:                <http://www.w3.org/ns/dcat#> .
@prefix dct:                 <http://purl.org/dc/terms/> .
@prefix xsd:                 <http://www.w3.org/2001/XMLSchema#> .
@prefix odrl:                <http://www.w3.org/ns/odrl/2/> .
@prefix vcard:               <http://www.w3.org/2006/vcard/ns#> .
@prefix foaf:                <http://xmlns.com/foaf/0.1/> .
@prefix skos:                <http://www.w3.org/2004/02/skos/core#> .
@prefix pst:                 <https://www.pistis-project.eu/ns/voc#> .

<https://pistis-market.eu/set/data/test-dataset>
    a                   dcat:Dataset ;
    dct:description     "Description of a Dataset"@en ;
    dct:title           "Title of a Dataset"@en ;
    dcat:keyword        "Engagement"@en, "Volunteerism"@en, "Stakeholders"@en, "Universities"@en, "Trends"@en   ;
    dct:publisher       [ a     foaf:Organization ;
                                foaf:mbox <mailto:email@publisher.eu> ;
                                foaf:name "Publisher Limited" ; ] ;
    dcat:theme          <http://publications.europa.eu/resource/authority/data-theme/EDUC> ;
    dct:language        <http://publications.europa.eu/resource/authority/language/ENG> ;
    dct:issued          "2023-05-25T00:00:00"^^xsd:dateTime ;
    dct:modified        "2023-05-25T00:00:00"^^xsd:dateTime ;
    dcat:distribution   <https://pistis-market.eu/set/distribution/1> ;
    pst:monetization    <https://pistis-market.eu/set/monetization/1> .

<https://pistis-market.eu/set/distribution/1>
    a              dcat:Distribution ;
    dct:title      "Name of the actual File" ;
    dct:license    [
                        dct:identifier "SUB-LI" ;
                        dct:title "Subscription License" ;
                        skos:prefLabel "Subscription License" ;
                        skos:exactMatch <https://subscriptionlicense.com>
                   ] ;
    dct:format     <http://publications.europa.eu/resource/authority/file-type/CSV> ;
    dcat:byteSize  "1288490189"^^xsd:nonNegativeInteger ;
    dcat:accessURL <http://factory-storage/test-document_company2> .
    
<https://pistis-market.eu/set/monetization/1>
    a                   pst:MonetizationMethod ;
    pst:sellerId        "15e2c4d2-bbea-4119-b3ef-65494f16fa9a" ;
    pst:investmentOffer <https://pistis-market.eu/set/investmentOffer/1> .

<https://pistis-market.eu/set/investmentOffer/1>
    a                       pst:InvestmentOffer ;
    pst:price               10 ;
    pst:termDate            "2025-12-31T00:00:00"^^xsd:dateTime ;
    pst:percentageOffer     49 ;
    pst:totalShares         1000 ;
    pst:maxShares           100 ;
    pst:status              true .
JSON-LD
POST https://pistis-market.eu/srv/repo/catalogues/<catalog-id>/datasets
Content-Type: application/ld+json
X-API-Key: <api-key>

{
    "@context": {
        "dcat": "http://www.w3.org/ns/dcat#",
        "xsd": "http://www.w3.org/2001/XMLSchema#",
        "vcard": "http://www.w3.org/2006/vcard/ns#",
        "foaf": "http://xmlns.com/foaf/0.1/",
        "skos": "http://www.w3.org/2004/02/skos/core#",
        "dcterms": "http://purl.org/dc/terms/",
        "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
        "odrl": "http://www.w3.org/ns/odrl/2/",
        "pst": "https://www.pistis-project.eu/ns/voc#"
    },
    "@graph": [{
            "@id": "_:g0",
            "@type": "foaf:Organization",
            "foaf:mbox": {
                "@id": "mailto:email@publisher.eu"
            },
            "foaf:name": "Publisher Limited"
        },
        {
            "@id": "_:g1",
            "dcterms:identifier": "SUB-LI",
            "dcterms:title": "Subscription License",
            "skos:exactMatch": {
                "@id": "https://subscriptionlicense.com"
            },
            "skos:prefLabel": "Subscription License"
        },
        {
            "@id": "https://pistis-market.eu/set/data/test-dataset",
            "@type": "dcat:Dataset",
            "dcterms:description": {
                "@language": "en",
                "@value": "Description of a Dataset"
            },
            "dcterms:issued": {
                "@type": "xsd:dateTime",
                "@value": "2023-05-25T00:00:00"
            },
            "dcterms:language": {
                "@id": "http://publications.europa.eu/resource/authority/language/ENG"
            },
            "dcterms:modified": {
                "@type": "xsd:dateTime",
                "@value": "2023-05-25T00:00:00"
            },
            "dcterms:publisher": {
                "@id": "_:g0"
            },
            "dcterms:title": {
                "@language": "en",
                "@value": "Title of a Dataset"
            },
            "dcat:distribution": {
                "@id": "https://pistis-market.eu/set/distribution/1"
            },
            "pst:monetization" {
                "@id": "https://pistis-market.eu/set/monetization/1"
            },
            "dcat:keyword": [{
                    "@language": "en",
                    "@value": "Engagement"
                },
                {
                    "@language": "en",
                    "@value": "Volunteerism"
                },
                {
                    "@language": "en",
                    "@value": "Stakeholders"
                },
                {
                    "@language": "en",
                    "@value": "Universities"
                },
                {
                    "@language": "en",
                    "@value": "Trends"
                }
            ],
            "dcat:theme": {
                "@id": "http://publications.europa.eu/resource/authority/data-theme/EDUC"
            }
        },
        {
            "@id": "https://pistis-market.eu/set/distribution/1",
            "@type": "dcat:Distribution",
            "dcterms:format": {
                "@id": "http://publications.europa.eu/resource/authority/file-type/CSV"
            },
            "dcterms:license": {
                "@id": "_:g1"
            },
            "dcterms:title": "Name of the actual File",
            "dcat:accessURL": {
                "@id": "http://factory-storage/test-document_company2"
            },
            "dcat:byteSize": {
                "@type": "xsd:nonNegativeInteger",
                "@value": "1288490189"
            }
        },
        {
            "@id": "https://pistis-market.eu/set/monetization/1",
            "@type": "pst:MonetizationMethod",
            "pst:sellerId": {
                "@value": "15e2c4d2-bbea-4119-b3ef-65494f16fa9a"
            },
            "pst:investmentOffer": {
                "@id": "https://pistis-market.eu/set/investmentOffer/1"
            }
        },
        {
            "@id": "https://pistis-market.eu/set/investmentOffer/1",
            "@type": "pst:InvestmentOffer",
            "pst:price": {
                "@type": "xsd:nonNegativeInteger",
                "@value": "10"
            },
            "pst:termDate": {
                "@type": "xsd:dateTime",
                "@value": "2028-07-29T00:00:00"
            },
            "pst:percentageOffer": {
                "@type": "xsd:nonNegativeInteger",
                "@value": "49"
            },
            "pst:totalShares": {
                "@type": "xsd:nonNegativeInteger",
                "@value": "1000"
            },
            "pst:maxShares": {
                "@type": "xsd:nonNegativeInteger",
                "@value": "100"
            },
            "pst:status": {
                "@value": true
            }
        }
    ]
}

Dataset With Both Purchase Offer and Investment Offer

If needed, you can also have both purchaseOffer and investmentOffer in the same dataset by adding them in your payload.

Turtle
POST https://pistis-market.eu/srv/repo/catalogues/<catalog-id>/datasets
Content-Type: text/turtle
X-API-Key: <api-key>

@prefix dcat:                <http://www.w3.org/ns/dcat#> .
@prefix dct:                 <http://purl.org/dc/terms/> .
@prefix xsd:                 <http://www.w3.org/2001/XMLSchema#> .
@prefix odrl:                <http://www.w3.org/ns/odrl/2/> .
@prefix vcard:               <http://www.w3.org/2006/vcard/ns#> .
@prefix foaf:                <http://xmlns.com/foaf/0.1/> .
@prefix skos:                <http://www.w3.org/2004/02/skos/core#> .
@prefix pst:                 <https://www.pistis-project.eu/ns/voc#> .

<https://pistis-market.eu/set/data/test-dataset>
    a                   dcat:Dataset ;
    dct:description     "Description of a Dataset"@en ;
    dct:title           "Title of a Dataset"@en ;
    dcat:keyword        "Engagement"@en, "Volunteerism"@en, "Stakeholders"@en, "Universities"@en, "Trends"@en   ;
    dct:publisher       [ a     foaf:Organization ;
                                foaf:mbox <mailto:email@publisher.eu> ;
                                foaf:name "Publisher Limited" ; ] ;
    dcat:theme          <http://publications.europa.eu/resource/authority/data-theme/EDUC> ;
    dct:language        <http://publications.europa.eu/resource/authority/language/ENG> ;
    dct:issued          "2023-05-25T00:00:00"^^xsd:dateTime ;
    dct:modified        "2023-05-25T00:00:00"^^xsd:dateTime ;
    dcat:distribution   <https://pistis-market.eu/set/distribution/1> ;
    pst:monetization    <https://pistis-market.eu/set/monetization/1> .

<https://pistis-market.eu/set/distribution/1>
    a              dcat:Distribution ;
    <your-distribution-properties> .
    
<https://pistis-market.eu/set/monetization/1>
    a                   pst:MonetizationMethod ;
    pst:sellerId        "15e2c4d2-bbea-4119-b3ef-65494f16fa9a" ;
    pst:purchaseOffer   <https://pistis-market.eu/set/purchaseOffer/1> ;
    pst:investmentOffer <https://pistis-market.eu/set/investmentOffer/1> .

<https://pistis-market.eu/set/purchaseOffer/1>
    a                           pst:PurchaseOffer ;
    <your-purchaseOffer-properties> .

<https://pistis-market.eu/set/investmentOffer/1>
    a                           pst:InvestmentOffer ;
    <your-investmentOffer-properties> .