Get transfer details by process ID

GET 
/api/management/transfers/:processId

Get transfer details by process ID

Request

Path Parameters

processId stringrequired

Process ID

Responses

200

application/json

Schema

Schema

localIdstringrequired
remoteIdstring
rolestringrequired
remoteAddressstringrequired
remotePartystringrequired
statestringrequired

process

object

required

@typestringrequired

dspace:providerPidstringrequired

dspace:consumerPidstringrequired

dspace:agreementIdstringrequired

dspace:statestringrequired
agreementIdstringrequired
formatstring
modifiedDatedate-timerequired

dataAddress

object

required

@typestringrequired

dspace:endpointTypestringrequired

dspace:endpointstringrequired

dspace:endpointProperties

object[]

required

Array [

@typestringrequired

dspace:namestringrequired

dspace:valuestringrequired

]

dataPlaneTransfer

object

required

acceptedbooleanrequired

identifierstringrequired

dataAddress

object

@typestringrequired

dspace:endpointTypestringrequired

dspace:endpointstringrequired

dspace:endpointProperties

object[]

required

Array [

@typestringrequired

dspace:namestringrequired

dspace:valuestringrequired

]

callbackAddressstring

dataPlaneIdentifierstringrequired

endpointTypestringrequired

events

object

required

timedate-timerequired

statestringrequired

localMessagestringrequired

codestringrequired

reason

object

@valuestringrequired

@languagestringrequired

typestringrequired

Example (from schema)

{
  "localId": "string",
  "remoteId": "string",
  "role": "string",
  "remoteAddress": "string",
  "remoteParty": "string",
  "state": "string",
  "process": {
    "@type": "string",
    "dspace:providerPid": "string",
    "dspace:consumerPid": "string",
    "dspace:agreementId": "string",
    "dspace:state": "string"
  },
  "agreementId": "string",
  "format": "string",
  "modifiedDate": "2024-07-29T15:51:28.071Z",
  "dataAddress": {
    "@type": "string",
    "dspace:endpointType": "string",
    "dspace:endpoint": "string",
    "dspace:endpointProperties": [
      {
        "@type": "string",
        "dspace:name": "string",
        "dspace:value": "string"
      }
    ]
  },
  "dataPlaneTransfer": {
    "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",
    "dataPlaneIdentifier": "string",
    "endpointType": "string"
  },
  "events": {
    "time": "2024-07-29T15:51:28.071Z",
    "state": "string",
    "localMessage": "string",
    "code": "string",
    "reason": {
      "@value": "string",
      "@language": "string"
    },
    "type": "string"
  }
}