EDC

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
default
default response
application/json
get
GET /api/management/wrapper/ui/pages/asset-page HTTP/1.1
Host: my-connector
Accept: */*
default

default response

{
  "assets": [
    {
      "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"
    }
  ]
}
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.

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

dataModelstringOptional

Data Model

sovereignLegalNamestringOptional

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

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
default
default response
application/json
put
PUT /api/management/wrapper/ui/pages/asset-page/assets/{assetId} HTTP/1.1
Host: my-connector
Content-Type: application/json
Accept: */*
Content-Length: 1254

{
  "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": "[email protected]",
      "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",
  "dataModel": "text",
  "sovereignLegalName": "text",
  "dataSampleUrls": [
    "text"
  ],
  "referenceFileUrls": [
    "text"
  ],
  "referenceFilesDescription": "text",
  "conditionsForUse": "text",
  "dataUpdateFrequency": "text",
  "temporalCoverageFrom": "2025-07-03",
  "temporalCoverageToInclusive": "2025-07-03",
  "customJsonAsString": "text",
  "customJsonLdAsString": "text",
  "privateCustomJsonAsString": "text",
  "privateCustomJsonLdAsString": "text"
}
default

default response

{
  "id": "text",
  "lastUpdatedDate": "2025-07-03T10:55:42.588Z"
}
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.

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

dataModelstringOptional

Data Model

sovereignLegalNamestringOptional

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

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
default
default response
application/json
post
POST /api/management/wrapper/ui/pages/asset-page/assets HTTP/1.1
Host: my-connector
Content-Type: application/json
Accept: */*
Content-Length: 1252

{
  "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": "[email protected]",
      "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",
  "dataModel": "text",
  "sovereignLegalName": "text",
  "dataSampleUrls": [
    "text"
  ],
  "referenceFileUrls": [
    "text"
  ],
  "referenceFilesDescription": "text",
  "conditionsForUse": "text",
  "dataUpdateFrequency": "text",
  "temporalCoverageFrom": "2025-07-03",
  "temporalCoverageToInclusive": "2025-07-03",
  "customJsonAsString": "text",
  "customJsonLdAsString": "text",
  "privateCustomJsonAsString": "text",
  "privateCustomJsonLdAsString": "text"
}
default

default response

{
  "id": "text",
  "lastUpdatedDate": "2025-07-03T10:55:42.588Z"
}
delete

Delete an Asset

Path parameters
assetIdstringRequired
Responses
default
default response
application/json
delete
DELETE /api/management/wrapper/ui/pages/asset-page/assets/{assetId} HTTP/1.1
Host: my-connector
Accept: */*
default

default response

{
  "id": "text",
  "lastUpdatedDate": "2025-07-03T10:55:42.588Z"
}

Last updated

Was this helpful?