Skip to content

transfer_process.md

Latest commit

 

History

History
136 lines (111 loc) · 3.11 KB

transfer_process.md

File metadata and controls

136 lines (111 loc) · 3.11 KB
Raw

Transfer Process

The transfer process manages the actual data transfer between provider and consumer.

Initiate Transfer Process

PULL Flow

POST /v4/transferprocesses
Content-Type: application/json

{
  "@context": "https://w3id.org/mobility-dataspace/connector/management/v1",
  "@type": "TransferRequest",
  "protocol": "dataspace-protocol-http:2025-1",
  "counterPartyAddress": "https://provider.dataspaces.think-it.io/api/dsp/2025-1",
  "contractId": "contract-id",
  "transferType": "HttpData-PULL"
}

PUSH Flow

POST /v4/transferprocesses
Content-Type: application/json

{
  "@context": "https://w3id.org/mobility-dataspace/connector/management/v1",
  "@type": "TransferRequest",
  "protocol": "dataspace-protocol-http:2025-1",
  "counterPartyAddress": "https://provider.dataspaces.think-it.io/api/dsp/2025-1",
  "contractId": "contract-id",
  "transferType": "HttpData-PUSH",
  "dataDestination": {
    "@type": "DataAddress",
    "type": "HttpData",
    "baseUrl": "https://example.com"
  }
}

S3 PUSH Flow

POST /v4/transferprocesses
Content-Type: application/json

{
  "@context": "https://w3id.org/mobility-dataspace/connector/management/v1",
  "@type": "TransferRequest",
  "protocol": "dataspace-protocol-http:2025-1",
  "counterPartyAddress": "https://provider.dataspaces.think-it.io/api/dsp/2025-1",
  "contractId": "contract-id",
  "transferType": "AmazonS3-PUSH",
  "dataDestination": {
    "@type": "DataAddress",
    "type": "AmazonS3",
    "region": "us-east-1",
    "bucketName": "my-bucket",
    "keyName": "my-file.json"
  }
}

Azure Blob PUSH Flow

POST /v4/transferprocesses
Content-Type: application/json

{
  "@context": "https://w3id.org/mobility-dataspace/connector/management/v1",
  "@type": "TransferRequest",
  "protocol": "dataspace-protocol-http:2025-1",
  "counterPartyAddress": "https://provider.dataspaces.think-it.io/api/dsp/2025-1",
  "contractId": "contract-id",
  "transferType": "AzureStorage-PUSH",
  "dataDestination": {
    "@type": "DataAddress",
    "type": "AzureStorage",
    "account": "myaccount",
    "container": "mycontainer",
    "blobName": "my-file.json"
  }
}

Kafka PULL Flow

POST /v4/transferprocesses
Content-Type: application/json

{
  "@context": "https://w3id.org/mobility-dataspace/connector/management/v1",
  "@type": "TransferRequest",
  "protocol": "dataspace-protocol-http:2025-1",
  "counterPartyAddress": "https://provider.dataspaces.think-it.io/api/dsp/2025-1",
  "contractId": "contract-id",
  "transferType": "Kafka-PULL"
}

Suspend Transfer Process

POST /v4/transferprocesses/{id}/suspend
Content-Type: application/json

{
  "@context": "https://w3id.org/mobility-dataspace/connector/management/v1",
  "@type": "SuspendTransfer",
  "reason": "Suspension reason"
}

Resume Transfer Process

POST /v4/transferprocesses/{id}/resume

Terminate Transfer Process

POST /v4/transferprocesses/{id}/terminate
Content-Type: application/json

{
  "@context": "https://w3id.org/mobility-dataspace/connector/management/v1",
  "@type": "TerminateTransfer",
  "reason": "Termination reason"
}