DataflowStartMessageDto

messageIdstringrequired

Example: b1d5f9e2-3c4b-4f7a-9c3e-2f1e5d6c7b8a

participantIdstringrequired

The participant ID of the sender.

Example: provider-participant-id

counterPartyIdstringrequired

The participant ID of the counterparty.

Example: consumer-participant-id

dataspaceContextstringrequired

Identifier for the dataspace context when a data plane is used in multiple dataspaces.

Example: test-dataspace-context

processIdstringrequired

The transfer process ID assigned by the control plane.

Example: urn:uuid:provider:transfer-1

agreementIdstringrequired

Example: urn:uuid:agreement-1

datasetIdstringrequired

Example: urn:uuid:dataset-1

profilestringrequired

The flow transfer profile. See the DPS Transfer Profile Registry.

Example: https://w3id.org/dspace-sig/profile/http-pull

claimsobjectrequired

The DSP claims of the counterparty as verified by the control plane.

Example: {"membership":"active","sub":"subject"}

labelsstring[]

Labels representing different flavours of data flow.

metadataobject

Information used by the data plane during preparation/startup.

dataAddress object

endpointstringrequired

Example: http://data-plane-endpoint

properties object[]required

Array [

namestringrequired

Example: propertyName

valuestringrequired

Example: propertyValue

]

DataflowStartMessageDto

{
  "messageId": "b1d5f9e2-3c4b-4f7a-9c3e-2f1e5d6c7b8a",
  "participantId": "provider-participant-id",
  "counterPartyId": "consumer-participant-id",
  "dataspaceContext": "test-dataspace-context",
  "processId": "urn:uuid:provider:transfer-1",
  "agreementId": "urn:uuid:agreement-1",
  "datasetId": "urn:uuid:dataset-1",
  "profile": "https://w3id.org/dspace-sig/profile/http-pull",
  "claims": {
    "membership": "active",
    "sub": "subject"
  },
  "labels": [
    "string"
  ],
  "metadata": {},
  "dataAddress": {
    "endpoint": "http://data-plane-endpoint",
    "properties": [
      {
        "name": "propertyName",
        "value": "propertyValue"
      }
    ]
  }
}