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.

---

get

Collect all data for 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-04-06",
      "temporalCoverageToInclusive": "2025-04-06",
      "assetJsonLd": "text",
      "customJsonAsString": "text",
      "customJsonLdAsString": "text",
      "privateCustomJsonAsString": "text",
      "privateCustomJsonLdAsString": "text"
    }
  ]
}

default response

---

put

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

Path parameters

assetIdstringrequired

Body

Type-safe data offer metadata for editing an asset as supported by the sovity product landscape. Contains extension points.

dataSourceOverrideOrNullobjectoptional

Data Source

titlestringoptional

Asset Title

languagestringoptional

Asset Language

descriptionstringoptional

Asset Description

publisherHomepagestringoptional

Asset Homepage

licenseUrlstringoptional

License URL

versionstringoptional

Version

keywordsstring[]optional

Asset Keywords

mediaTypestringoptional

Asset MediaType

landingPageUrlstringoptional

Landing Page URL

dataCategorystringoptional

Data Category

dataSubcategorystringoptional

Data Subcategory

dataModelstringoptional

Data Model

geoReferenceMethodstringoptional

Geo-Reference Method

transportModestringoptional

Transport Mode

sovereignLegalNamestringoptional

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

geoLocationstringoptional

Geo location

nutsLocationsstring[]optional

Locations by NUTS standard which divides countries into administrative divisions

dataSampleUrlsstring[]optional

Data sample URLs

referenceFileUrlsstring[]optional

Reference file/schema URLs

referenceFilesDescriptionstringoptional

Additional information on reference files/schemas

conditionsForUsestringoptional

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

dataUpdateFrequencystringoptional

Data update frequency

temporalCoverageFromstring · dateoptional

Temporal coverage start date

temporalCoverageToInclusivestring · dateoptional

Temporal coverage end date (inclusive)

customJsonAsStringstringoptional

Contains serialized custom properties in the JSON format.

customJsonLdAsStringstringoptional

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.

privateCustomJsonAsStringstringoptional

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

privateCustomJsonLdAsStringstringoptional

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": "HTTP_DATA",
      "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": true,
        "enablePathParameterization": true,
        "enableQueryParameterization": true,
        "enableBodyParameterization": true
      },
      "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-04-06",
    "temporalCoverageToInclusive": "2025-04-06",
    "customJsonAsString": "text",
    "customJsonLdAsString": "text",
    "privateCustomJsonAsString": "text",
    "privateCustomJsonLdAsString": "text"
  }'

default

default

{
  "id": "text",
  "lastUpdatedDate": "2025-04-06T13:09:19.789Z"
}

default response

---

post

Create a new Asset

Body

Type-safe data offer metadata for creating an asset as supported by the sovity product landscape. Contains extension points.

dataSourceobjectrequired

Data Source

idstringrequired

Asset Id

titlestringoptional

Asset Title

languagestringoptional

Asset Language

descriptionstringoptional

Asset Description

publisherHomepagestringoptional

Asset Homepage

licenseUrlstringoptional

License URL

versionstringoptional

Version

keywordsstring[]optional

Asset Keywords

mediaTypestringoptional

Asset MediaType

landingPageUrlstringoptional

Landing Page URL

dataCategorystringoptional

Data Category

dataSubcategorystringoptional

Data Subcategory

dataModelstringoptional

Data Model

geoReferenceMethodstringoptional

Geo-Reference Method

transportModestringoptional

Transport Mode

sovereignLegalNamestringoptional

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

geoLocationstringoptional

Geo location

nutsLocationsstring[]optional

Locations by NUTS standard which divides countries into administrative divisions

dataSampleUrlsstring[]optional

Data sample URLs

referenceFileUrlsstring[]optional

Reference file/schema URLs

referenceFilesDescriptionstringoptional

Additional information on reference files/schemas

conditionsForUsestringoptional

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

dataUpdateFrequencystringoptional

Data update frequency

temporalCoverageFromstring · dateoptional

Temporal coverage start date

temporalCoverageToInclusivestring · dateoptional

Temporal coverage end date (inclusive)

customJsonAsStringstringoptional

Contains serialized custom properties in the JSON format.

customJsonLdAsStringstringoptional

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.

privateCustomJsonAsStringstringoptional

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

privateCustomJsonLdAsStringstringoptional

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": "HTTP_DATA",
      "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": true,
        "enablePathParameterization": true,
        "enableQueryParameterization": true,
        "enableBodyParameterization": true
      },
      "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-04-06",
    "temporalCoverageToInclusive": "2025-04-06",
    "customJsonAsString": "text",
    "customJsonLdAsString": "text",
    "privateCustomJsonAsString": "text",
    "privateCustomJsonLdAsString": "text"
  }'

default

default

{
  "id": "text",
  "lastUpdatedDate": "2025-04-06T13:09:19.789Z"
}

default response

---

delete

Delete an Asset

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-04-06T13:09:19.789Z"
}

default response