Get transfer by ID

GET 
/api/management/transfers/:id

Get transfer by ID

Request

Path Parameters

id stringrequired

Transfer identifier

Responses

200

application/json

Schema

Schema

idstringrequired
rolestringrequired
processIdstringrequired
remotePartystringrequired
secretstringrequired
statestringrequired

request

object

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

response

object

required

acceptedbooleanrequired

identifierstringrequired

dataAddress

object

@typestringrequired

dspace:endpointTypestringrequired

dspace:endpointstringrequired

dspace:endpointProperties

object[]

required

Array [

@typestringrequired

dspace:namestringrequired

dspace:valuestringrequired

]

callbackAddressstring

dataAddress

object

required

@typestringrequired

dspace:endpointTypestringrequired

dspace:endpointstringrequired

dspace:endpointProperties

object[]

required

Array [

@typestringrequired

dspace:namestringrequired

dspace:valuestringrequired

]

createdDatedate-timerequired
modifiedDatedate-timerequired
deletedDatedate-timerequired

Example (from schema)

{
  "id": "string",
  "role": "string",
  "processId": "string",
  "remoteParty": "string",
  "secret": "string",
  "state": "string",
  "request": {
    "@type": "string",
    "dspace:consumerPid": "string",
    "dspace:agreementId": "string",
    "dct:format": "string",
    "dspace:dataAddress": {
      "@type": "string",
      "dspace:endpointType": "string",
      "dspace:endpoint": "string",
      "dspace:endpointProperties": [
        {
          "@type": "string",
          "dspace:name": "string",
          "dspace:value": "string"
        }
      ]
    },
    "dspace:callbackAddress": "string"
  },
  "response": {
    "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"
  },
  "dataAddress": {
    "@type": "string",
    "dspace:endpointType": "string",
    "dspace:endpoint": "string",
    "dspace:endpointProperties": [
      {
        "@type": "string",
        "dspace:name": "string",
        "dspace:value": "string"
      }
    ]
  },
  "createdDate": "2024-07-29T15:51:28.071Z",
  "modifiedDate": "2024-07-29T15:51:28.071Z",
  "deletedDate": "2024-07-29T15:51:28.071Z"
}

403

Forbidden

application/json

Schema

Schema

namestringrequired
statusstringrequired
codenumberrequired
messageobject
errorstring

Example (from schema)

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