Catalog

This section provides an overview of all available APIs that adhere to the OpenAPI specification. All APIs are loaded from the OpenAPI specification file: Link. Please note that the API base-paths may differ depending on the connector, the specific API base-path can be seen in the UI dashboard.


Deprecated
post

Fetch a connector's data offers

Body

Catalog query parameters

connectorEndpointstringRequired

Target EDC DSP endpoint URL. Can contain a queryParam 'participantId', which is provided by default in the Connector Endpoint in the EDC UI.

participantIdstringOptional

Target EDC Participant ID. It is required if the connector endpoint does not contain the queryParam 'participantId'.

limitinteger · int32Optional

Limit the number of results

offsetinteger · int32Optional

Offset for returned results, e.g. start at result 2

Responses
default
default response
application/json
post
POST /api/management/wrapper/use-case-api/catalog HTTP/1.1
Host: my-connector
Content-Type: application/json
Accept: */*
default

default response

[
  {
    "endpoint": "text",
    "participantId": "text",
    "asset": {
      "dataSourceAvailability": "LIVE",
      "assetId": "text",
      "connectorEndpoint": "text",
      "participantId": "text",
      "title": "text",
      "creatorOrganizationName": "text",
      "onRequestContactEmail": "[email protected]",
      "onRequestContactEmailSubject": "Department XYZ Data Offer Request - My Product, My API",
      "language": "text",
      "description": "text",
      "descriptionShortText": "text",
      "isOwnConnector": true,
      "publisherHomepage": "text",
      "licenseUrl": "text",
      "version": "text",
      "keywords": [
        "text"
      ],
      "mediaType": "text",
      "landingPageUrl": "text",
      "httpDatasourceHintsProxyMethod": true,
      "httpDatasourceHintsProxyPath": true,
      "httpDatasourceHintsProxyQueryParams": true,
      "httpDatasourceHintsProxyBody": true,
      "dataModel": "text",
      "sovereignLegalName": "text",
      "dataSampleUrls": [
        "text"
      ],
      "referenceFileUrls": [
        "text"
      ],
      "referenceFilesDescription": "text",
      "conditionsForUse": "text",
      "dataUpdateFrequency": "text",
      "temporalCoverageFrom": "2025-07-03",
      "temporalCoverageToInclusive": "2025-07-03",
      "assetJsonLd": "text",
      "customJsonAsString": "text",
      "customJsonLdAsString": "text",
      "privateCustomJsonAsString": "text",
      "privateCustomJsonLdAsString": "text"
    },
    "contractOffers": [
      {
        "contractOfferId": "text",
        "policy": {
          "policyJsonLd": "text",
          "expression": {
            "type": "EMPTY",
            "expressions": "[Circular Reference]",
            "constraint": {
              "left": "text",
              "operator": "EQ",
              "right": {
                "type": "STRING",
                "value": "text",
                "valueList": [
                  "text"
                ]
              }
            }
          },
          "errors": [
            "text"
          ]
        }
      }
    ]
  }
]

get

Fetch a connector's data offers

Query parameters
participantIdstringOptional
connectorEndpointstringOptional
Responses
default
default response
application/json
get
GET /api/management/wrapper/ui/pages/catalog-page/data-offers HTTP/1.1
Host: my-connector
Accept: */*
default

default response

[
  {
    "endpoint": "text",
    "participantId": "text",
    "asset": {
      "dataSourceAvailability": "LIVE",
      "assetId": "text",
      "connectorEndpoint": "text",
      "participantId": "text",
      "title": "text",
      "creatorOrganizationName": "text",
      "onRequestContactEmail": "[email protected]",
      "onRequestContactEmailSubject": "Department XYZ Data Offer Request - My Product, My API",
      "language": "text",
      "description": "text",
      "descriptionShortText": "text",
      "isOwnConnector": true,
      "publisherHomepage": "text",
      "licenseUrl": "text",
      "version": "text",
      "keywords": [
        "text"
      ],
      "mediaType": "text",
      "landingPageUrl": "text",
      "httpDatasourceHintsProxyMethod": true,
      "httpDatasourceHintsProxyPath": true,
      "httpDatasourceHintsProxyQueryParams": true,
      "httpDatasourceHintsProxyBody": true,
      "dataModel": "text",
      "sovereignLegalName": "text",
      "dataSampleUrls": [
        "text"
      ],
      "referenceFileUrls": [
        "text"
      ],
      "referenceFilesDescription": "text",
      "conditionsForUse": "text",
      "dataUpdateFrequency": "text",
      "temporalCoverageFrom": "2025-07-03",
      "temporalCoverageToInclusive": "2025-07-03",
      "assetJsonLd": "text",
      "customJsonAsString": "text",
      "customJsonLdAsString": "text",
      "privateCustomJsonAsString": "text",
      "privateCustomJsonLdAsString": "text"
    },
    "contractOffers": [
      {
        "contractOfferId": "text",
        "policy": {
          "policyJsonLd": "text",
          "expression": {
            "type": "EMPTY",
            "expressions": "[Circular Reference]",
            "constraint": {
              "left": "text",
              "operator": "EQ",
              "right": {
                "type": "STRING",
                "value": "text",
                "valueList": [
                  "text"
                ]
              }
            }
          },
          "errors": [
            "text"
          ]
        }
      }
    ]
  }
]

Last updated

Was this helpful?