Transfer-History

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 the Transfer History Page

Responses

default

default response

application/json

get

/wrapper/ui/pages/transfer-history-page

HTTPcURLJavaScriptPython

GET /api/management/wrapper/ui/pages/transfer-history-page HTTP/1.1
Host: my-connector
Accept: */*

default

default response

{
  "transferEntries": [
    {
      "transferProcessId": "text",
      "createdDate": "2025-12-19T13:57:48.789Z",
      "lastUpdatedDate": "2025-12-19T13:57:48.789Z",
      "transferType": "text",
      "state": {
        "name": "text",
        "code": 1,
        "simplifiedState": "RUNNING"
      },
      "contractAgreementId": "text",
      "direction": "CONSUMING",
      "counterPartyConnectorEndpoint": "text",
      "counterPartyParticipantId": "text",
      "assetName": "text",
      "assetId": "text",
      "errorMessage": "text",
      "isEdrConsumable": true
    }
  ]
}

---

get

Queries a transfer process' asset

Path parameters

transferProcessIdstringRequired

Responses

default

default response

application/json

get

/wrapper/ui/pages/transfer-history-page/transfer-processes/{transferProcessId}/asset

HTTPcURLJavaScriptPython

GET /api/management/wrapper/ui/pages/transfer-history-page/transfer-processes/{transferProcessId}/asset HTTP/1.1
Host: my-connector
Accept: */*

default

default response

{
  "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-12-19",
  "temporalCoverageToInclusive": "2025-12-19",
  "sphinxFields": {
    "patientCount": "text",
    "birthYearMin": "text",
    "birthYearMax": "text",
    "administrativeGender": "text",
    "bodyHeightMin": "text",
    "bodyHeightMax": "text",
    "diagnosisPrimary": "text",
    "diagnosisSecondary": "text",
    "encounterStart": "text",
    "encounterEnd": "text",
    "medicationCount": "text",
    "dosageCount": "text",
    "clinicalSpecialty": "text"
  },
  "assetJsonLd": "text",
  "customJsonAsString": "text",
  "customJsonLdAsString": "text",
  "privateCustomJsonAsString": "text",
  "privateCustomJsonLdAsString": "text"
}