Skip to main content

5.1.1.1

Data sharing: Data sharing request - Request data transfer

Test: Coverage test: assess that the API is available and test that a data sharing request is properly covered:

  • Initiate a data sharing
  • Retrieve data sharing information and status
  • Receive data sharing request outcome condition
  • Retrieve data sharing information of past data sharing actions.

The system ranks higher if the API is secured and implements common methods, like REST.

note

The description of Test 5.1.1.1 was extracted from this page in the GitHub repository.
This file was last modified at 2025-06-02 13:59:01 UTC.

Information​

  • Phase 1

  • Minimal? Yes

  • Related KPIs:

    • Functional suitability: [Functional completeness] The system provides a documented, programmatic interface (API) to initiate and manage a data transfer.

  • Evaluation Criteria:

RequirementMeasured KPI (0-4)
Initiate a data sharing-
Retrieve data sharing information and status-
Receive data sharing request outcome condition-
Retrieve data sharing information of past data sharing actions.-

Overall Score = (Score_Initiate + Score_Retrieve_Status + Score_Request_Outcome + Score_Past_Actions) / 4

Results​

note

The results for Test 5.1.1.1 for EDC+VC were extracted from this page in the GitHub repository.
This file was last modified at 2025-06-02 13:59:01 UTC.

Environment​

  • The test utilizes the EDC MVD commit 8da0c4e.
  • EDC version 0.8.2-SNAPSHOT
  • The test is executed in an Ubuntu environment using IntelliJ.

Tested quality metric and method​

The quality metric for this test is based on the criteria outlined in iso27001_kpis_subkpis.xlsx. In Phase 1, the focus is on the Functional Suitability metric. For detailed information, please refer to the Comparative criteria (checklists, ...) section in the test description.

Expected Output​

The test aims to provide a comprehensive evaluation of the following aspects:

  • Assess the Availability of the API: Ensure that the API is accessible and functional.
  • Test Data Sharing Requests: Verify that data sharing requests are correctly processed, covering these steps:
    • Initiating a data sharing request.
    • Retrieving information and status of the data sharing request.
    • Receiving the outcome of the data sharing request, including conditions.
    • Accessing information on past data sharing activities. The system will score higher if the API is secured and utilizes standard methods, such as REST.

Results​

Assessment​

EDC version 0.8.2-SNAPSHOT offers the following management API endpoints for managing data transfer processes:

  • POST /v3/transferprocesses: Initiates a data transfer with specified parameters.
  • POST /v3/transferprocesses/request: Returns all transfer processes that match a given query.
  • GET /v3/transferprocesses/{id}: Retrieves a transfer process using the specified ID.
  • POST /v3/transferprocesses/{id}/deprovision: Requests the deprovisioning of resources related to a transfer process.
  • POST /v3/transferprocesses/{id}/resume: Requests the resumption of a suspended transfer process.
  • GET /v3/transferprocesses/{id}/state: Retrieves the state of a transfer process using the specified ID.
  • POST /v3/transferprocesses/{id}/suspend: Requests the suspension of a transfer process.
  • POST /v3/transferprocesses/{id}/terminate: Requests the termination of a transfer process.

These endpoints, included in the EDC MVD commit 8da0c4e, are secured using the EDC implementation of Token-Based Authentication Service. This service secures connector APIs and is configured with the key EDC_API_AUTH_KEY. EDC also provides an AuthenticationService to integrate authentication protection into the APIs. Additionally, out-of-the-box extensions for authentication are available from EDC here.

Measured results​

As demonstrated above, all the following aspects of the transfer API coverage are fulfilled:

RequirementMeasured KPI
Initiate a data sharing4
Retrieve data sharing information and status3
Receive data sharing request outcome condition3
Retrieve data sharing information of past data sharing actions.3

Overall Calculation: (4+3+3+3)/4 = 3.25 Functional Suitability Quality Metric Score: 3.25

Notes​

EDC is a pluggable ecosystem primarily targeting Java/Kotlin developers. Some extensions are available on the market for plug-and-play, but for certain specific use cases, developers need to create their own extensions.