DataflowDto

idstringrequired

Example: urn:uuid:dataflow-1

transferProcessIdstringrequired

Example: urn:uuid:provider:transfer-1

dataPlaneIdstringrequired

Example: urn:uuid:dp-1

datasetIdstring

Example: urn:uuid:dataset-1

statestringrequired

Possible values: [INITIALIZED, PREPARING, PREPARED, STARTING, STARTED, SUSPENDED, COMPLETED, TERMINATED]

Example: STARTED

dataAddress object

endpointstringrequired

Example: http://data-plane-endpoint

properties object[]required

Array [

namestringrequired

Example: propertyName

valuestringrequired

Example: propertyValue

]

DataflowDto

{
  "id": "urn:uuid:dataflow-1",
  "transferProcessId": "urn:uuid:provider:transfer-1",
  "dataPlaneId": "urn:uuid:dp-1",
  "datasetId": "urn:uuid:dataset-1",
  "state": "STARTED",
  "dataAddress": {
    "endpoint": "http://data-plane-endpoint",
    "properties": [
      {
        "name": "propertyName",
        "value": "propertyValue"
      }
    ]
  }
}