TransferDetailDto

localIdstringrequired

Example: local-12345

remoteIdstring

Example: remote-98765

rolestringrequired

Example: provider

remoteAddressstringrequired

Example: http://example.com/

remotePartystringrequired

Example: party-identifier-001

statestringrequired

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

Example: REQUESTED

agreementIdstringrequired

Example: agreement-45678

formatstring

Example: application/json

modifiedDatestring<date-time>required

Example: 2023-10-01T12:34:56Z

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

]

dataPlaneTransfer 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

dataPlaneIdentifierstringrequired

Example: transfer-identifier

endpointTypestringrequired

Example: type1

events object[]required

Array [

timestring<date-time>required

Example: 2023-10-01T12:00:00Z

statestringrequired

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

Example: COMPLETED

localMessagestring

Example: The transfer completed successfully.

codestring

Example: ERR_NONE

reason object

@valuestringrequired

Example: This is a sentence.

@languagestringrequired

Example: en

typestringrequired

Possible values: [local, remote]

Example: local

]

TransferDetailDto

{
  "localId": "local-12345",
  "remoteId": "remote-98765",
  "role": "provider",
  "remoteAddress": "http://example.com/",
  "remoteParty": "party-identifier-001",
  "state": "REQUESTED",
  "agreementId": "agreement-45678",
  "format": "application/json",
  "modifiedDate": "2023-10-01T12:34:56Z",
  "dataAddress": {
    "type": "S3",
    "bucketName": "example-bucket",
    "region": "us-east-1"
  },
  "dataPlaneTransfer": {
    "transportProtocol": "HTTP",
    "endpoint": "https://data-plane.example.com/transfer"
  },
  "events": [
    {
      "time": "2023-10-01T12:00:00Z",
      "state": "STARTED",
      "localMessage": "Upload started.",
      "code": "STARTED",
      "reason": [
        {
          "language": "en",
          "value": "Transfer initiated"
        }
      ],
      "type": "local"
    }
  ]
}