Transfer-Processes

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.

---

Initiates a data transfer with the given parameters. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. This may take a long time, so clients must poll the /{id}/state endpoint to track the state.

post

/v2/transferprocesses

Body

@contextobjectrequired

@typestring

Example: https://w3id.org/edc/v0.0.1/ns/TransferRequest

assetIdstringrequired

callbackAddressesobject[]

Example: null

connectorAddressstringDeprecated

please use counterPartyAddress instead

connectorIdstringDeprecated

Provider connector id is stored in the contract agreement

contractIdstringrequired

counterPartyAddressstringrequired

dataDestinationobject

privatePropertiesobject

protocolstringrequired

transferTypestringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//v2/transferprocesses' \
  --header 'Content-Type: application/json' \
  --data '{
    "@context": {
      "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
    },
    "@type": "https://w3id.org/edc/v0.0.1/ns/TransferRequest",
    "protocol": "dataspace-protocol-http",
    "counterPartyAddress": "http://provider-address",
    "contractId": "contract-id",
    "assetId": "asset-id",
    "transferType": "transferType",
    "dataDestination": {
      "type": "data-destination-type"
    },
    "privateProperties": {
      "private-key": "private-value"
    },
    "callbackAddresses": [
      {
        "transactional": false,
        "uri": "http://callback/url",
        "events": [
          "contract.negotiation",
          "transfer.process"
        ],
        "authKey": "auth-key",
        "authCodeId": "auth-code-id"
      }
    ]
  }'

200

400

200

{
  "@context": {
    "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
  },
  "@id": "id-value",
  "createdAt": 1688465655
}

The transfer was successfully initiated. Returns the transfer process ID and created timestamp

---

Returns all transfer process according to a query

post

/v2/transferprocesses/request

Body

@typestring

Example: https://w3id.org/edc/v0.0.1/ns/QuerySpec

filterExpressionobject[]

Example: {"@context":{"@vocab":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"Criterion","operandLeft":"fieldName","operator":"=","operandRight":"some value"}

limitinteger · int32

offsetinteger · int32

sortFieldstring

sortOrderstring · enum

Options: ASC, DESC

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//v2/transferprocesses/request' \
  --header 'Content-Type: application/json' \
  --data '{
    "@context": {
      "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
    },
    "@type": "QuerySpec",
    "offset": 5,
    "limit": 10,
    "sortOrder": "DESC",
    "sortField": "fieldName",
    "filterExpression": []
  }'

200

400

200

No body

The transfer processes matching the query

---

Gets an transfer process with the given ID

get

/v2/transferprocesses/{id}

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//v2/transferprocesses/{id}'

200

400

404

200

{
  "@context": {
    "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
  },
  "@type": "https://w3id.org/edc/v0.0.1/ns/TransferProcess",
  "@id": "process-id",
  "correlationId": "correlation-id",
  "type": "PROVIDER",
  "state": "STARTED",
  "stateTimestamp": 1688465655,
  "assetId": "asset-id",
  "contractId": "contractId",
  "dataDestination": {
    "type": "data-destination-type"
  },
  "privateProperties": {
    "private-key": "private-value"
  },
  "errorDetail": "eventual-error-detail",
  "createdAt": 1688465655,
  "callbackAddresses": [
    {
      "transactional": false,
      "uri": "http://callback/url",
      "events": [
        "contract.negotiation",
        "transfer.process"
      ],
      "authKey": "auth-key",
      "authCodeId": "auth-code-id"
    }
  ]
}

The transfer process

---

Requests the deprovisioning of resources associated with a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. This may take a long time, so clients must poll the /{id}/state endpoint to track the state.

post

/v2/transferprocesses/{id}/deprovision

Path parameters

idstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//v2/transferprocesses/{id}/deprovision'

204

400

404

204

No body

Request to deprovision the transfer process was successfully received

---

Gets the state of a transfer process with the given ID

get

/v2/transferprocesses/{id}/state

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//v2/transferprocesses/{id}/state'

200

400

404

200

{
  "@context": {
    "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
  },
  "@type": "https://w3id.org/edc/v0.0.1/ns/TransferState",
  "state": "STARTED"
}

The transfer process's state

---

Requests the termination of a transfer process. Due to the asynchronous nature of transfers, a successful response only indicates that the request was successfully received. This may take a long time, so clients must poll the /{id}/state endpoint to track the state.

post

/v2/transferprocesses/{id}/terminate

Path parameters

idstringrequired

Body

@typestring

Example: https://w3id.org/edc/v0.0.1/ns/TerminateTransfer

statestring

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//v2/transferprocesses/{id}/terminate' \
  --header 'Content-Type: application/json' \
  --data '{
    "@context": {
      "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
    },
    "@type": "https://w3id.org/edc/v0.0.1/ns/TerminateTransfer",
    "reason": "a reason to terminate"
  }'

204

400

404

409

204

No body

Request to terminate the transfer process was successfully received