Skip to main content
Version: Next

TransferDto

idstringrequired
Example: 123e4567-e89b-12d3-a456-426614174000
rolestringrequired

Possible values: [provider, consumer]

Example: provider
processIdstringrequired
Example: process-001
remotePartystringrequired
Example: remote-system
secretstring
Example: secret-key
datasetIdstring
Example: urn:uuid:123e4567-e89b-12d3-a456-426614174000
statestringrequired

Possible values: [REQUESTED, STARTED, TERMINATED, COMPLETED, SUSPENDED]

Example: REQUESTED
request object
@typestringrequired
Example: TransferRequestMessage
consumerPidstringrequired
Example: consumer-pid-123
agreementIdstringrequired
Example: agreement-id-456
formatstringrequired
Example: application/json
dataAddress object
@typestringrequired
Example: DataAddress
endpointTypestringrequired
Example: http
endpointstringrequired
Example: https://api.example.com
endpointProperties object[]
  • Array [
    • @typestringrequired
    Example: EndpointProperty
    namestringrequired
    Example: endpointName
    valuestringrequired
    Example: endpointValue
  • ]
    • callbackAddressstringrequired
    Example: https://callback.example.com
    response object
    acceptedbooleanrequired
    Example: true
    identifierstringrequired
    Example: req-identifier
    dataAddress object
    endpointstringrequired
    Example: http://data-plane-endpoint
    properties object[]required
  • Array [
    • namestringrequired
    Example: propertyName
    valuestringrequired
    Example: propertyValue
  • ]
    • callbackAddressstring
    Example: http://callback-address
    dataAddress object
    @typestringrequired
    Example: DataAddress
    endpointTypestringrequired
    Example: http
    endpointstringrequired
    Example: https://api.example.com
    endpointProperties object[]
  • Array [
    • @typestringrequired
    Example: EndpointProperty
    namestringrequired
    Example: endpointName
    valuestringrequired
    Example: endpointValue
  • ]
    • createdDatestring<date-time>required
    Example: 2023-01-01T00:00:00.000Z
    modifiedDatestring<date-time>required
    Example: 2023-01-02T00:00:00.000Z
    deletedDatestring<date-time>required
    Example: 2023-01-03T00:00:00.000Z
    TransferDto
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "role": "provider",
      "processId": "process-001",
      "remoteParty": "remote-system",
      "secret": "secret-key",
      "datasetId": "urn:uuid:123e4567-e89b-12d3-a456-426614174000",
      "state": "REQUESTED",
      "request": {},
      "response": {},
      "dataAddress": {},
      "createdDate": "2023-01-01T00:00:00.000Z",
      "modifiedDate": "2023-01-02T00:00:00.000Z",
      "deletedDate": "2023-01-03T00:00:00.000Z"
    }