Skip to main content
Version: Next

DataflowResponseDto

messageIdstringrequired
Example: b1d5f9e2-3c4b-4f7a-9c3e-2f1e5d6c7b8a
dataFlowIdstringrequired
Example: urn:uuid:dataflow-1
statestringrequired

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

Example: PREPARED
dataAddress object
@typestringrequired

Possible values: [DataAddress]

endpointTypestringrequired
endpointstring
endpointProperties object[]
  • Array [
  • @typestringrequired

    Possible values: [EndpointProperty]

    namestringrequired
    valuestringrequired
  • ]
  • errorstring
    Example: Backend unreachable
    DataflowResponseDto
    {
    "messageId": "b1d5f9e2-3c4b-4f7a-9c3e-2f1e5d6c7b8a",
    "dataFlowId": "urn:uuid:dataflow-1",
    "state": "PREPARED",
    "dataAddress": {
    "@type": "DataAddress",
    "endpointType": "string",
    "endpoint": "string",
    "endpointProperties": [
    {
    "@type": "EndpointProperty",
    "name": "string",
    "value": "string"
    }
    ]
    },
    "error": "Backend unreachable"
    }