Catalog

Last updated 4 months ago

Was this helpful?

post

Body

@contextobjectrequired

@typestringoptionalExample: https://w3id.org/edc/v0.0.1/ns/CatalogRequest

counterPartyAddressstringrequired

counterPartyIdstringoptional

protocolstringrequired

querySpecobjectoptionalExample:

{"@context":{"@vocab":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"QuerySpec","offset":5,"limit":10,"sortOrder":"DESC","sortField":"fieldName","filterExpression":[]}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//v2/catalog/request' \
  --header 'Content-Type: application/json' \
  --data '{
    "@context": {
      "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
    },
    "@type": "CatalogRequest",
    "counterPartyAddress": "http://provider-address",
    "counterPartyId": "providerId",
    "protocol": "dataspace-protocol-http",
    "querySpec": {
      "offset": 0,
      "limit": 50,
      "sortOrder": "DESC",
      "sortField": "fieldName",
      "filterExpression": []
    }
  }'

default

{
  "@id": "7df65569-8c59-4013-b1c0-fa14f6641bf2",
  "@type": "dcat:Catalog",
  "dcat:dataset": {
    "@id": "bcca61be-e82e-4da6-bfec-9716a56cef35",
    "@type": "dcat:Dataset",
    "odrl:hasPolicy": {
      "@id": "OGU0ZTMzMGMtODQ2ZS00ZWMxLThmOGQtNWQxNWM0NmI2NmY4:YmNjYTYxYmUtZTgyZS00ZGE2LWJmZWMtOTcxNmE1NmNlZjM1:NDY2ZTZhMmEtNjQ1Yy00ZGQ0LWFlZDktMjdjNGJkZTU4MDNj",
      "@type": "odrl:Set",
      "odrl:permission": {
        "odrl:target": "bcca61be-e82e-4da6-bfec-9716a56cef35",
        "odrl:action": {
          "odrl:type": "http://www.w3.org/ns/odrl/2/use"
        },
        "odrl:constraint": {
          "odrl:and": [
            {
              "odrl:leftOperand": "https://w3id.org/edc/v0.0.1/ns/inForceDate",
              "odrl:operator": {
                "@id": "odrl:gteq"
              },
              "odrl:rightOperand": "2023-07-07T07:19:58.585601395Z"
            },
            {
              "odrl:leftOperand": "https://w3id.org/edc/v0.0.1/ns/inForceDate",
              "odrl:operator": {
                "@id": "odrl:lteq"
              },
              "odrl:rightOperand": "2023-07-12T07:19:58.585601395Z"
            }
          ]
        }
      },
      "odrl:prohibition": [],
      "odrl:obligation": []
    },
    "dcat:distribution": [
      {
        "@type": "dcat:Distribution",
        "dct:format": {
          "@id": "HttpData"
        },
        "dcat:accessService": "5e839777-d93e-4785-8972-1005f51cf367"
      }
    ],
    "description": "description",
    "id": "bcca61be-e82e-4da6-bfec-9716a56cef35"
  },
  "dcat:service": {
    "@id": "5e839777-d93e-4785-8972-1005f51cf367",
    "@type": "dcat:DataService",
    "dct:terms": "connector",
    "dct:endpointUrl": "http://localhost:16806/protocol"
  },
  "dspace:participantId": "urn:connector:provider",
  "@context": {
    "@vocab": "https://w3id.org/edc/v0.0.1/ns/",
    "dct": "http://purl.org/dc/terms/",
    "edc": "https://w3id.org/edc/v0.0.1/ns/",
    "dcat": "http://www.w3.org/ns/dcat#",
    "odrl": "http://www.w3.org/ns/odrl/2/",
    "dspace": "https://w3id.org/dspace/v0.8/"
  }
}

Gets contract offers (=catalog) of a single connector