Skip to main content
Version: Next

TransferRequestMessageSchema

@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
    TransferRequestMessageSchema
    {
    "@type": "dspace:TransferRequestMessage",
    "dspace:consumerPid": "consumer-pid-123",
    "dspace:agreementId": "agreement-id-456",
    "dct:format": "application/json",
    "dspace:dataAddress": {
    "@type": "dspace:DataAddress",
    "dspace:endpointType": "http",
    "dspace:endpoint": "https://api.example.com",
    "dspace:endpointProperties": [
    {
    "@type": "dspace:EndpointProperty",
    "dspace:name": "name",
    "dspace:value": "value"
    }
    ]
    },
    "dspace:callbackAddress": "https://callback.example.com"
    }