Skip to main content
Version: Next

TransferStartMessageSchema

@typestringrequired
Example: dspace:TransferStartMessage
dspace:providerPidstringrequired
Example: provider-pid-789
dspace:consumerPidstringrequired
Example: consumer-pid-123
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
  • ]
  • TransferStartMessageSchema
    {
    "@type": "dspace:TransferStartMessage",
    "dspace:providerPid": "provider-pid-789",
    "dspace:consumerPid": "consumer-pid-123",
    "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"
    }
    ]
    }
    }