Jump to

• Request
• Response

List Data Flows

get

[host-url]/dt-rest/v2/dataflows

Retrieves all data flows. This method supports various query parameters to filter and customize the response:

• fields: specifies the fields to include in the response (comma-separated)
• name: filters data flows by name
• parentFolder: filters data flows by parentFolder

The following examples demonstrate the supported query patterns:

• Retrieve all data flows (no filters):

  Retrieves all available data flows without any name or parent folder filtering. All default fields for these data flows will be included in the response.

  /dataflows


• Retrieve all data flows with specific fields:

  Retrieves all data flows, but the response for each data flow will only include the fields specified in the fields parameter.

  /dataflows?fields=name,dataFlowId,dateCreated,...


• Filter by name only:

  Retrieves all data flows that match the specified name. All default fields for these data flows will be included in the response.

  /dataflows?name=your_dataflow_name


• Filter by name and select specific fields:

  Retrieves data flows that match the given name, and the response for these data flows will only include the fields specified in the fields parameter.

  /dataflows?name=your_dataflow_name&fields=name,dataFlowId,dateCreated,...


• Filter by parentFolder only:

  Retrieves all data flows that match the specified parentFolder. All default fields for these data flows will be included in the response.

  /dataflows?parentFolder=your_parentFolder


• Filter by parentFolder and select specific fields:

  Retrieves data flows that match the given parentFolder, and the response for these data flows will only include the fields specified in the fields parameter.

  /dataflows?parentFolder=your_parentFolder&fields=name,dataFlowId,dateCreated,...

Request

Query Parameters

• fields: string
  comma-separated list of fields to include in the response
• name: string
  filters data flows by name
• parentFolder: string
  filters data flows by parentFolder

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

a response object containing the list of DataFlowBaseDTO

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DataFlowBaseDTO
  Representation of a data flow.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DataFlowBaseDTO"
    }
}

Nested 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