Skip to main content
Version: Next

TransferStatusDto

localIdstringrequired
Example: local-12345
remoteIdstring
Example: remote-98765
rolestringrequired
Example: provider
remoteAddressstringrequired
Example: http://example.com/
remotePartystringrequired
Example: party-identifier-001
statestringrequired

Possible values: [dspace:REQUESTED, dspace:STARTED, dspace:TERMINATED, dspace:COMPLETED, dspace:SUSPENDED]

Example: dspace:REQUESTED
process object
@typestringrequired
Example: dspace:TransferProcess
dspace:providerPidstringrequired
Example: provider-pid-789
dspace:consumerPidstringrequired
Example: consumer-pid-123
dspace:agreementIdstringrequired
Example: agreement-id-456
dspace:statestringrequired
Example: COMPLETED
agreementIdstringrequired
Example: agreement-45678
formatstring
Example: application/json
modifiedDatedate-timerequired
Example: 2023-10-01T12:34:56Z
TransferStatusDto
{
"localId": "local-12345",
"remoteId": "remote-98765",
"role": "provider",
"remoteAddress": "http://example.com/",
"remoteParty": "party-identifier-001",
"state": "dspace:REQUESTED",
"process": {
"step": "upload",
"progress": 50
},
"agreementId": "agreement-45678",
"format": "application/json",
"modifiedDate": "2023-10-01T12:34:56Z"
}