Jump to

• Request
• Response

Retrieve Data Flow

get

[host-url]/dt-rest/v2/dataflows/{dataFlowId}

Returns the specified data flow.

Request

Path Parameters

• dataFlowId(required): string
  the ID of the data flow to retrieve

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

a Response object containing a data flow

Body ()

Root Schema : DataFlowBaseDTO

Type: object

Representation of a data flow.

Show Source

• dataFlowId: string
• dateCreated: string (date-time)
• dateUpdated: string (date-time)
• description: string
• name(required): string
• parentFolder: string
• projectName: string

{
    "type":"object",
    "description":"Representation of a data flow.",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "dataFlowId":{
            "type":"string"
        },
        "dateCreated":{
            "type":"string",
            "format":"date-time"
        },
        "dateUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "projectName":{
            "type":"string"
        },
        "parentFolder":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Not Found

Back to Top