Jump to

• Request
• Response

List Folders

get

[host-url]/dt-rest/v2/projects/{projectId}/folders

Retrieves a list of folders for a specific project. This method supports various query parameters to filter and customize the response:

• fields: specifies the fields to include in the response (comma-separated)

The following examples demonstrate the supported query patterns:

• Retrieve all folders for a project:

  Retrieves all folders for the project with the given projectId, including their children. All default fields for these folders will be included in the response.

  /projects/{projectId}/folders


• Retrieve all folders for a project with specific fields:

  Retrieves all folders for the project with the given projectId, including their children, and the response will only include the fields specified in the fields parameter.

  /projects/{projectId}/folders?fields=name,folderId,...

Request

Path Parameters

• projectId(required): string
  ID of the project for which to retrieve folders

Query Parameters

• fields: string
  comma-separated list of fields to include in the response

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 folders

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: DTFolderDTO

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

Nested Schema : DTFolderDTO

Match All

Represents a folder for grouping data flows and workflows.

Show Source

• object DTFolderBaseDTO
  Represents a data transforms folder.
• object DTFolderDTO-allOf[1]
  Represents a folder for grouping data flows and workflows.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DTFolderBaseDTO"
        },
        {
            "type":"object",
            "description":"Represents a folder for grouping data flows and workflows.",
            "properties":{
                "dataFlows":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                },
                "workflows":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            }
        }
    ]
}

Nested Schema : DTFolderBaseDTO

Type: object

Represents a data transforms folder.

Show Source

• folderId: string
• name(required): string
• projectName: string

{
    "type":"object",
    "description":"Represents a data transforms folder.",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "folderId":{
            "type":"string"
        },
        "projectName":{
            "type":"string"
        }
    }
}

Nested Schema : DTFolderDTO-allOf[1]

Type: object

Represents a folder for grouping data flows and workflows.

Show Source

• dataFlows: object dataFlows
  Additional Properties Allowed: additionalProperties
• workflows: object workflows
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "description":"Represents a folder for grouping data flows and workflows.",
    "properties":{
        "dataFlows":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "workflows":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : dataFlows

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : workflows

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

401 Response

Unauthorized

404 Response

Not Found

Back to Top