LogoLogo
EDCDSPortalDAPS
CE 11.0.0
CE 11.0.0
  • Welcome
  • Key Concepts
  • FAQ
  • Frontend
    • Walkthrough
    • Dashboard
    • Providing
      • 1. Create Data Offer
      • 2. Create Asset
      • 3. Create Policy
      • 4. Create Contract Definition
    • Consuming
      • 1. Finding Offers
      • 2. Initiating Transfers (HttpData-Push)
      • 3. Transfer History
    • Contract Termination
  • Backend
    • Postman
    • API-Wrapper vs Management-API
    • API-Wrapper
      • Java Client Library
    • Management-API
      • Secrets API
      • Contract Definition: Multiple Assets
      • QuerySpec
      • Health Check APIs
      • Policy: Business Partner Groups
      • Policy: Unrestricted
    • Data Transfer
      • HttpData-Pull (Parameterized)
      • AWS S3 Transfer
      • Source: Audit Headers
      • Source/Sink: OAuth2/API-Key
  • Community Edition Deployment
    • Overview
    • Local Demo
    • Production
  • Customer Links
    • Glossary
    • sovity Hub
    • Service Desk
Powered by GitBook
LogoLogo

sovity

  • Homepage
  • About us
  • GitHub
  • LinkedIn

Information

  • Contact
  • Imprint
  • Privacy Policy

© by sovity GmbH

On this page
  • Initiating a Data Transfer (HttpData-Push)
  • Supported Data Sink Types

Was this helpful?

Edit on GitHub
  1. Frontend
  2. Consuming

2. Initiating Transfers (HttpData-Push)

Last updated 2 months ago

Was this helpful?

When using the Connector UI, only a HttpData-Push can be triggered, not an HttpData-Pull. For an HttpData-Pull, the Management-API of the connector must be used instead.

To transfer the data to your desired data sink, navigate to the Contracts page. This page displays all your contract agreements, including both consuming and providing contract agreements. You can easily distinguish between them by the arrow next to the Contract Agreement (Up = providing, Down = consuming). You can inspect data on your contract agreements, such as the counterpart Connector.

Initiating a Data Transfer (HttpData-Push)

  1. Selecting a Contract Agreement

    • Click on a consuming contract agreement to open a pop-up window displaying details of the contract agreement.

  1. Defining Data Sink Properties

    • Click on Transfer to define your data sink properties.

Supported Data Sink Types

There are three data sink types supported:

  1. REST-API Endpoint

  2. Custom Datasink Config (JSON)

  3. Custom Transfer Process Request (JSON)

1. Transfer to a REST-API Endpoint

To transfer data to a REST-API endpoint, select an HTTP method and provide the URL of the data sink. You can also add additional headers, such as for authentication.

2. Transfer Data to a Custom Datasink Config (JSON)

For more advanced data-sink endpoints not directly supported by the UI, you can enter your data-sink properties in JSON format.

Example:

JSON
{
  "properties": {
    "type": "HttpData",
    "baseUrl": "https://webhook.site/86b9b7e6-eb27-4c5f-b7e5-336d5f157f15"
  }
}

Here, "type": "HttpData" indicates that the EDC will interpret the destination as a REST-API. The baseUrl is the endpoint receiving the data.

3. Transfer Data via Custom Transfer Process Request (JSON)

For passing parameters to the providing Connector or detailed configuration of EDC transfer processes, use the Custom Transfer Process Request (JSON) option.

Example:

JSON
{
  "protocol": "ids-multipart",
  "assetId": "this-will-be-overriden-by-the-ui",
  "contractId": "this-will-be-overriden-by-the-ui",
  "dataDestination": {
    "properties": {
      "type": "HttpData",
      "baseUrl": "https://my-data-sink/",
      "method": "POST"
    }
  },
  "properties": {
    "pathSegments": "12345/some-resource/6890",
    "queryParams": "a=b&c=d"
  },
  "transferType": {
    "contentType": "application/octet-stream",
    "isFinite": true
  },
  "managedResources": false,
  "connectorAddress": "this-will-be-overriden-by-the-ui",
  "connectorId": "consumer"
}

Note that this option requires providing the data sink and may include fields for the transfer process request, if enabled by the provider. This is useful for specific cases, such as transferring files to blobs.

Click on Initiate Transfer to send the asset to the desired data sink.

It is important to know that a data transfer can fail for a variety of reasons. This may be due to a misconfiguration of the data-source as well as the data-sink or unfulfilled contract policies set by the Provider, as contract policies are also evaluated at the time a transfer is initiated.

Contract Agreement
Initiating data transfer
Datasink properties
Custom Datasink Configuration