API Reference
Complete reference for the sovity EDC UI API
API Reference
The sovity EDC API Wrapper provides a simplified, type-safe interface for managing your EDC Connector. This documentation covers the UI API endpoints for asset management, catalog discovery, contract negotiations, and data transfers.
Base URL
All API requests should be made to your connector instance:
https://api.your-connector-instance.prod.truzztbox.eu/api/managementReplace this with your actual connector URL.
Authentication
All requests require an API key passed in the X-Api-Key header:
curl -X GET "https://api.your-connector-instance.prod.truzztbox.eu/api/management/wrapper/ui/pages/dashboard-page" \
-H "X-Api-Key: your-api-key"API Categories
Dashboard and Configuration
Get connector status, KPIs, and configuration information.
| Endpoint | Description |
|---|---|
GET /wrapper/ui/pages/dashboard-page | Connector overview with statistics and KPIs |
GET /wrapper/ui/config | UI feature flags and settings |
GET /wrapper/ui/build-info | Build version information |
Asset Management
Create and manage data assets that can be shared through the data space.
| Endpoint | Description |
|---|---|
GET /wrapper/ui/pages/asset-page | List all assets |
POST /wrapper/ui/pages/asset-page/assets | Create a new asset |
PUT /wrapper/ui/pages/asset-page/assets/{assetId} | Update an asset |
DELETE /wrapper/ui/pages/asset-page/assets/{assetId} | Delete an asset |
GET /wrapper/ui/pages/data-offer-page/validate-asset-id/{assetId} | Check if asset ID is available |
Policy Management
Define access and usage policies using ODRL expressions.
| Endpoint | Description |
|---|---|
GET /wrapper/ui/pages/policy-page | List all policy definitions |
POST /wrapper/ui/v2/pages/policy-page/policy-definitions | Create a policy (recommended) |
POST /wrapper/ui/pages/policy-page/policy-definitions | Create a policy (deprecated) |
DELETE /wrapper/ui/pages/policy-page/policy-definitions/{policyId} | Delete a policy |
GET /wrapper/ui/pages/data-offer-page/validate-policy-id/{policyId} | Check if policy ID is available |
Contract Definitions
Link assets to policies to make them available in the catalog.
| Endpoint | Description |
|---|---|
GET /wrapper/ui/pages/contract-definition-page | List all contract definitions |
POST /wrapper/ui/pages/contract-definition-page/contract-definitions | Create a contract definition |
DELETE /wrapper/ui/pages/contract-definition-page/contract-definitions/{id} | Delete a contract definition |
GET /wrapper/ui/pages/data-offer-page/validate-contract-definition-id/{id} | Check if ID is available |
Quick Data Offer Creation
Create an asset, policy, and contract definition in a single call.
| Endpoint | Description |
|---|---|
POST /wrapper/ui/pages/create-data-offer | Create complete data offer |
Catalog and Discovery
Browse data offers from other connectors in the data space.
| Endpoint | Description |
|---|---|
GET /wrapper/ui/pages/catalog-page/data-offers | Fetch data offers from a connector |
Contract Negotiations
Negotiate access to data offers from other connectors.
| Endpoint | Description |
|---|---|
POST /wrapper/ui/pages/catalog-page/contract-negotiations | Initiate a contract negotiation |
GET /wrapper/ui/pages/catalog-page/contract-negotiations/{id} | Get negotiation status |
Contract Agreements
Manage established contracts between connectors.
| Endpoint | Description |
|---|---|
POST /wrapper/ui/pages/contract-agreement-page | List contract agreements (with optional filter) |
GET /wrapper/ui/pages/contract-agreement-page/{id} | Get a specific agreement |
POST /wrapper/ui/pages/content-agreement-page/{id}/terminate | Terminate an agreement |
Transfer Processes
Execute data transfers based on contract agreements.
| Endpoint | Description |
|---|---|
POST /wrapper/ui/pages/contract-agreement-page/transfers | Initiate a transfer |
POST /wrapper/ui/pages/contract-agreement-page/transfers/custom | Initiate a custom transfer |
GET /wrapper/ui/pages/transfer-history-page | View transfer history |
GET /wrapper/ui/pages/transfer-history-page/transfer-processes/{id}/asset | Get transfer's asset |
Response Format
All successful responses return JSON. Common response types include:
IdResponseDto
Returned when creating or modifying resources:
{
"id": "resource-id",
"lastUpdatedDate": "2024-01-15T10:30:00Z"
}Error Responses
Errors are returned with appropriate HTTP status codes and error details in the response body.