Assets

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.

---

Collect all data for Asset Page

get

/wrapper/ui/pages/asset-page

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://my-connector/api/management/wrapper/ui/pages/asset-page'

default

default

{
  "assets": [
    {
      "dataSourceAvailability": "LIVE",
      "assetId": "text",
      "connectorEndpoint": "text",
      "participantId": "text",
      "title": "text",
      "creatorOrganizationName": "text",
      "onRequestContactEmail": "[e-mail]",
      "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,
      "dataCategory": "text",
      "dataSubcategory": "text",
      "dataModel": "text",
      "geoReferenceMethod": "text",
      "transportMode": "text",
      "sovereignLegalName": "text",
      "geoLocation": "text",
      "nutsLocations": [
        "text"
      ],
      "dataSampleUrls": [
        "text"
      ],
      "referenceFileUrls": [
        "text"
      ],
      "referenceFilesDescription": "text",
      "conditionsForUse": "text",
      "dataUpdateFrequency": "text",
      "temporalCoverageFrom": "2025-03-14",
      "temporalCoverageToInclusive": "2025-03-14",
      "assetJsonLd": "text",
      "customJsonAsString": "text",
      "customJsonLdAsString": "text",
      "privateCustomJsonAsString": "text",
      "privateCustomJsonLdAsString": "text"
    }
  ]
}

default response

---

Updates an Asset's metadata and optionally also the data source.

put

/wrapper/ui/pages/asset-page/assets/{assetId}

Path parameters

assetIdstringrequired

Body

dataSourceOverrideOrNullobject

Data Source

titlestring

Asset Title

languagestring

Asset Language

descriptionstring

Asset Description

publisherHomepagestring

Asset Homepage

licenseUrlstring

License URL

versionstring

Version

keywordsstring[]

Asset Keywords

mediaTypestring

Asset MediaType

landingPageUrlstring

Landing Page URL

dataCategorystring

Data Category

dataSubcategorystring

Data Subcategory

dataModelstring

Data Model

geoReferenceMethodstring

Geo-Reference Method

transportModestring

Transport Mode

sovereignLegalNamestring

The sovereign is distinct from the publisher by being the legal owner of the data.

geoLocationstring

Geo location

nutsLocationsstring[]

Locations by NUTS standard which divides countries into administrative divisions

dataSampleUrlsstring[]

Data sample URLs

referenceFileUrlsstring[]

Reference file/schema URLs

referenceFilesDescriptionstring

Additional information on reference files/schemas

conditionsForUsestring

Instructions for use that are not legally relevant e.g. information on how to cite the dataset in papers

dataUpdateFrequencystring

Data update frequency

temporalCoverageFromstring · date

Temporal coverage start date

temporalCoverageToInclusivestring · date

Temporal coverage end date (inclusive)

customJsonAsStringstring

Contains serialized custom properties in the JSON format.

customJsonLdAsStringstring

Contains serialized custom properties in the JSON LD format. Contrary to the customJsonAsString field, this string must represent a JSON LD object and will be affected by JSON LD compaction and expansion. Due to a technical limitation, the properties can't be booleans.

privateCustomJsonAsStringstring

Same as customJsonAsString but the data will be stored in the private properties.

privateCustomJsonLdAsStringstring

Same as customJsonLdAsString but the data will be stored in the private properties. The same limitations apply.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://my-connector/api/management/wrapper/ui/pages/asset-page/assets/{assetId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "dataSourceOverrideOrNull": {
      "type": "CUSTOM",
      "httpData": {
        "method": "GET",
        "baseUrl": "https://my-app.my-org.com/api/edc-data-offer/v1",
        "queryString": "search=example&limit=10",
        "authHeaderName": "Authorization",
        "authHeaderValue": {
          "secretName": "myApiAuthKey",
          "rawValue": "<auth key here>"
        },
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enableMethodParameterization": "false",
        "enablePathParameterization": "false",
        "enableQueryParameterization": "false",
        "enableBodyParameterization": "false"
      },
      "onRequest": {
        "contactEmail": "[e-mail]",
        "contactPreferredEmailSubject": "Department XYZ Data Offer Request - My Product, My API"
      },
      "customProperties": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "title": "text",
    "language": "text",
    "description": "text",
    "publisherHomepage": "text",
    "licenseUrl": "text",
    "version": "text",
    "keywords": [
      "text"
    ],
    "mediaType": "text",
    "landingPageUrl": "text",
    "dataCategory": "text",
    "dataSubcategory": "text",
    "dataModel": "text",
    "geoReferenceMethod": "text",
    "transportMode": "text",
    "sovereignLegalName": "text",
    "geoLocation": "text",
    "nutsLocations": [
      "text"
    ],
    "dataSampleUrls": [
      "text"
    ],
    "referenceFileUrls": [
      "text"
    ],
    "referenceFilesDescription": "text",
    "conditionsForUse": "text",
    "dataUpdateFrequency": "text",
    "temporalCoverageFrom": "2025-03-14",
    "temporalCoverageToInclusive": "2025-03-14",
    "customJsonAsString": "text",
    "customJsonLdAsString": "text",
    "privateCustomJsonAsString": "text",
    "privateCustomJsonLdAsString": "text"
  }'

default

default

{
  "id": "text",
  "lastUpdatedDate": "2025-03-14T14:15:47.171Z"
}

default response

---

Create a new Asset

post

/wrapper/ui/pages/asset-page/assets

Body

dataSourceobjectrequired

Data Source

idstringrequired

Asset Id

titlestring

Asset Title

languagestring

Asset Language

descriptionstring

Asset Description

publisherHomepagestring

Asset Homepage

licenseUrlstring

License URL

versionstring

Version

keywordsstring[]

Asset Keywords

mediaTypestring

Asset MediaType

landingPageUrlstring

Landing Page URL

dataCategorystring

Data Category

dataSubcategorystring

Data Subcategory

dataModelstring

Data Model

geoReferenceMethodstring

Geo-Reference Method

transportModestring

Transport Mode

sovereignLegalNamestring

The sovereign is distinct from the publisher by being the legal owner of the data.

geoLocationstring

Geo location

nutsLocationsstring[]

Locations by NUTS standard which divides countries into administrative divisions

dataSampleUrlsstring[]

Data sample URLs

referenceFileUrlsstring[]

Reference file/schema URLs

referenceFilesDescriptionstring

Additional information on reference files/schemas

conditionsForUsestring

Instructions for use that are not legally relevant e.g. information on how to cite the dataset in papers

dataUpdateFrequencystring

Data update frequency

temporalCoverageFromstring · date

Temporal coverage start date

temporalCoverageToInclusivestring · date

Temporal coverage end date (inclusive)

customJsonAsStringstring

Contains serialized custom properties in the JSON format.

customJsonLdAsStringstring

Contains serialized custom properties in the JSON LD format. Contrary to the customJsonAsString field, this string must represent a JSON LD object and will be affected by JSON LD compaction and expansion. Due to a technical limitation, the properties can't be booleans.

privateCustomJsonAsStringstring

Same as customJsonAsString but the data will be stored in the private properties.

privateCustomJsonLdAsStringstring

Same as customJsonLdAsString but the data will be stored in the private properties. The same limitations apply.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://my-connector/api/management/wrapper/ui/pages/asset-page/assets' \
  --header 'Content-Type: application/json' \
  --data '{
    "dataSource": {
      "type": "CUSTOM",
      "httpData": {
        "method": "GET",
        "baseUrl": "https://my-app.my-org.com/api/edc-data-offer/v1",
        "queryString": "search=example&limit=10",
        "authHeaderName": "Authorization",
        "authHeaderValue": {
          "secretName": "myApiAuthKey",
          "rawValue": "<auth key here>"
        },
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "enableMethodParameterization": "false",
        "enablePathParameterization": "false",
        "enableQueryParameterization": "false",
        "enableBodyParameterization": "false"
      },
      "onRequest": {
        "contactEmail": "[e-mail]",
        "contactPreferredEmailSubject": "Department XYZ Data Offer Request - My Product, My API"
      },
      "customProperties": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "id": "text",
    "title": "text",
    "language": "text",
    "description": "text",
    "publisherHomepage": "text",
    "licenseUrl": "text",
    "version": "text",
    "keywords": [
      "text"
    ],
    "mediaType": "text",
    "landingPageUrl": "text",
    "dataCategory": "text",
    "dataSubcategory": "text",
    "dataModel": "text",
    "geoReferenceMethod": "text",
    "transportMode": "text",
    "sovereignLegalName": "text",
    "geoLocation": "text",
    "nutsLocations": [
      "text"
    ],
    "dataSampleUrls": [
      "text"
    ],
    "referenceFileUrls": [
      "text"
    ],
    "referenceFilesDescription": "text",
    "conditionsForUse": "text",
    "dataUpdateFrequency": "text",
    "temporalCoverageFrom": "2025-03-14",
    "temporalCoverageToInclusive": "2025-03-14",
    "customJsonAsString": "text",
    "customJsonLdAsString": "text",
    "privateCustomJsonAsString": "text",
    "privateCustomJsonLdAsString": "text"
  }'

default

default

{
  "id": "text",
  "lastUpdatedDate": "2025-03-14T14:15:47.171Z"
}

default response

---

Delete an Asset

delete

/wrapper/ui/pages/asset-page/assets/{assetId}

Path parameters

assetIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://my-connector/api/management/wrapper/ui/pages/asset-page/assets/{assetId}'

default

default

{
  "id": "text",
  "lastUpdatedDate": "2025-03-14T14:15:47.171Z"
}

default response