Request Transfer

POST 
/api/transfers/request/:role

Requests a transfer from control plane to data plane.

Request

Path Parameters

role stringrequired

Query Parameters

processId stringrequired

Header Parameters

x-remote-party stringrequired
x-dataset-id stringrequired

application/json

Body

required

@typestringrequired
dspace:consumerPidstringrequired
dspace:agreementIdstringrequired
dct:formatstringrequired

dspace:dataAddress

object

@typestringrequired

dspace:endpointTypestringrequired

dspace:endpointstringrequired

dspace:endpointProperties

object[]

required

Array [

@typestringrequired

dspace:namestringrequired

dspace:valuestringrequired

]

dspace:callbackAddressstringrequired

Responses

200

application/json

Schema

Schema

acceptedbooleanrequired
identifierstringrequired

dataAddress

object

@typestringrequired

dspace:endpointTypestringrequired

dspace:endpointstringrequired

dspace:endpointProperties

object[]

required

Array [

@typestringrequired

dspace:namestringrequired

dspace:valuestringrequired

]

callbackAddressstring

Example (from schema)

{
  "accepted": true,
  "identifier": "string",
  "dataAddress": {
    "@type": "string",
    "dspace:endpointType": "string",
    "dspace:endpoint": "string",
    "dspace:endpointProperties": [
      {
        "@type": "string",
        "dspace:name": "string",
        "dspace:value": "string"
      }
    ]
  },
  "callbackAddress": "string"
}

403

Forbidden

application/json

Schema

Schema

namestringrequired
statusstringrequired
codenumberrequired
messageobject
errorstring

Example (from schema)

{
  "name": "string",
  "status": "string",
  "code": 0,
  "message": {},
  "error": "string"
}