Get all transfers

GET 
/api/management/transfers

Get all transfers

Request

Responses

200

application/json

Schema

Schema

Array [
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
statestringrequired
Possible values: [dspace:REQUESTED, dspace:STARTED, dspace:TERMINATED, dspace:COMPLETED, dspace:SUSPENDED]
Example: REQUESTED
request object
@typestringrequired
Example: dspace:TransferRequestMessage
dspace:consumerPidstringrequired
Example: consumer-pid-123
dspace:agreementIdstringrequired
Example: agreement-id-456
dct:formatstringrequired
Example: application/json
dspace:dataAddress object
@typestringrequired
Example: dspace:DataAddress
dspace:endpointTypestringrequired
Example: http
dspace:endpointstringrequired
Example: https://api.example.com
dspace:endpointProperties object[]required
Array [
@typestringrequired
Example: dspace:EndpointProperty
dspace:namestringrequired
Example: endpointName
dspace:valuestringrequired
Example: endpointValue
]
dspace: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: dspace:DataAddress
dspace:endpointTypestringrequired
Example: http
dspace:endpointstringrequired
Example: https://api.example.com
dspace:endpointProperties object[]required
Array [
@typestringrequired
Example: dspace:EndpointProperty
dspace:namestringrequired
Example: endpointName
dspace:valuestringrequired
Example: endpointValue
]
createdDatedate-timerequired
Example: 2023-01-01T00:00:00.000Z
modifiedDatedate-timerequired
Example: 2023-01-02T00:00:00.000Z
deletedDatedate-timerequired
Example: 2023-01-03T00:00:00.000Z
]

Example (auto)

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "role": "provider",
    "processId": "process-001",
    "remoteParty": "remote-system",
    "secret": "secret-key",
    "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"
  }
]

403

Forbidden

application/json

Schema

Schema

namestringrequired
Example: ResourceNotFound
statusstringrequired
Example: 404 Not Found
codenumberrequired
Example: 404
messageobject
Example: The requested resource does not exist.
errorstring
Example: Not Found

Example (auto)

{
  "name": "ResourceNotFound",
  "status": "404 Not Found",
  "code": 404,
  "message": "The requested resource does not exist.",
  "error": "Not Found"
}

Authorization: oauth2

name: oauth2type: oauth2scopes: controlplane_dataplaneflows: {
  "password": {
    "scopes": {
      "analyticsdataplane_admin": "analyticsdataplane_admin",
      "analyticsdataplane_dataplane": "analyticsdataplane_dataplane"
    }
  }
}

• curl
• http

• CURL

curl -L 'https://tsg.dataspac.es/api/management/transfers' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Request Collapse all

Auth

Bearer Token