How to consume a parametrized asset via API (MS8)

[ip312]

Provider side
I defined a parametrized asset via the frontend using the following Custom Datasource Config (JSON)

{
  "properties": {
    "type": "HttpData",
    "baseUrl": "https://api.hamburg.de",
    "proxyPath": "true",
    "proxyBody": "true",
    "proxyMethod": "true",
    "proxyQueryParams": "true"
  }
}

The asset metadata are shown below:

Consumer side

On the consumer side I was able to consume the asset via the frontend using following parameters

Now I'd like to consume the same asset via the API. According the documentation I will start a transfer using the transferprocess-POST-Endpoint on the management API using the following JSON.

@tmberthold Could you please re-check whether all parameteres are set correctly.

{
  "protocol": "ids-multipart",
  "assetId": "urn:artifact:paramasset",
  "contractId": "ParamContract:d0f2e543-ffe5-47ad-b7fd-3fd1d013e4f7",
  "dataDestination": {
    "properties": {
      "type": "HttpData",
      "assetId": "urn:artifact:paramasset", 
      "method": "POST",
      "baseUrl": "https://webhook.site/6eddc60d-e863-41c3-9f0b-2cb4045977a5"
    }
  },
  "properties": {
    "pathSegments": "/datasets/v1/verkehrslage/collections/verkehrslage/items",
    "method": "GET",
    "queryParams": "f=json&gid=708725253"
  },
  "transferType": {
    "contentType": "application/octet-stream",
    "isFinite": true
  },
  "managedResources": false,
  "connectorAddress": "https://connector-mds-test-003.prod-sovity.azure.sovity.io/control/api/v1/ids/data",
  "connectorId": "https://connector-mds-test-003.prod-sovity.azure.sovity.io/"
}

Questions:

1. Are queryParams set correctly?
2. Do we need the assetId both in the main part and in the data destination properties?
3. Do we need the "method": "POST" in the data destination properties? There are discrepancies between two documentation versions.
4. Which ConnectorId shall be used? There are Connector Id and Connector IDS Id in the connector properties.

Thank you in advance.

[tmberthold]

Hello and thanks for asking, we'll take a look at it.

[tmberthold]

For MS8 this would be the documentation to go to, the structure there should be the one valid for the MS8:
https://github.com/sovity/edc-extensions/blob/MS8/docs/getting-started/documentation/parameterized_assets.md

• the "method": "POST" according to the docs is not required, this can change with another core-edc version in the future

Did it work or were there technical problems executing the call?

[ip312]

Thank you for the answer and for the confirmation. We will test it and then report here.

[ip312]

Hi @tmberthold. After the troubleshooting session with @richardtreier we were able to find the appropriate approach (the documentation referred above seems to be outdated)
First of all another endpoint should be used: POST [CaaS base url]/control/data/wrapper/ui/pages/contract-agreement-page/transfers. The following json-request is working for us

{
   "type":"PARAMS_ONLY",
   "params":{
      "contractAgreementId":"[contract agreement id]",
      "dataSinkProperties":{
         "type":"HttpData",
         "baseUrl":"[data sink address]",
         "method":"POST"
      },
      "properties":{
         "method":"GET",
         "pathSegments":"[custom path]",
         "queryParams":"[parameters]",
      }
   }
}

We documented results in the MDS wiki

[tmberthold]

Hi Igor, glad to hear that it work's using the API-Wrapper API!