1. API Description
Domain name for API request: wedata.intl.tencentcloudapi.com.
Query Directory Tree
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name |
Required |
Type |
Description |
| Action |
Yes |
String |
Common Params. The value used for this API: DescribeDsFolderTree. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2021-08-20. |
| Region |
Yes |
String |
Common Params. For more information, please see the list of regions supported by the product. |
| ProjectId |
Yes |
String |
Project ID |
| FirstLevelPull |
No |
Boolean |
Whether to Pull at First Level true Yes false No |
| FolderId |
No |
String |
Folder ID |
| WorkflowId |
No |
String |
Workflow ID |
| Keyword |
No |
String |
Keyword Search |
| IncludeWorkflow |
No |
Boolean |
Whether to Include Workflow true Yes false No |
| IncludeTask |
No |
Boolean |
Whether to Include Tasks true Yes false No |
| IncludeVirtualTask |
No |
Boolean |
Does it include virtual tasks? This parameter is effective only when IncludeTask is true, default is true |
| TaskFolderId |
No |
String |
Task directory ID |
| DisplayType |
No |
String |
classification. Categorized Display catalog. Directory Display |
| IncludeTaskFolder |
No |
Boolean |
Does it include task directories? true means yes false No |
3. Output Parameters
| Parameter Name |
Type |
Description |
| Data |
Array of PathNodeDsVO |
Unified Tree Structure Return Attribute List |
| RequestId |
String |
The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Query Directory Tree
Query Directory Tree, Expand Directory Tree
POST / HTTP/1.1
Host: wedata.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDsFolderTree
<Common request parameters>
{
"ProjectId": "1485413914375667733",
"FirstLevelPull": true,
"FolderId": "11265328-2c7d-11ee-8d13-a4ae120f8272",
"WorkflowId": "11265328-2c7d-11ee-8d13-a4ae120f8273",
"Keyword": "demoKey",
"IncludeWorkflow": true,
"IncludeTask": true
}
Output Example
{
"Response": {
"Data": [
{
"Children": [
{
"Children": [],
"Id": "156b3b03-2c7d-11ee-8d13-a4ae120f8272",
"IsLeaf": false,
"Params": "eyJzdWJtaXRGbGFnIjp0cnVlLCJvd25lcklkIjoiMTAwMDI5NDExMDU2Iiwid29ya2Zsb3dEZXNjIjoiIn0=",
"ParentId": "11265328-2c7d-11ee-8d13-a4ae120f8272",
"Title": "f1332",
"Type": "workflow"
},
{
"Children": [],
"Id": "2f03778a-2c7d-11ee-8d13-a4ae120f8272",
"IsLeaf": false,
"Params": "eyJzdWJtaXRGbGFnIjp0cnVlLCJvd25lcklkIjoiMTAwMDI5NDExMDU2Iiwid29ya2Zsb3dEZXNjIjoiIn0=",
"ParentId": "11265328-2c7d-11ee-8d13-a4ae120f8272",
"Title": "f2",
"Type": "workflow"
}
],
"Id": "11265328-2c7d-11ee-8d13-a4ae120f8272",
"IsLeaf": false,
"Params": null,
"ParentId": "",
"Title": "0_dengboxu",
"Type": "folder"
}
],
"RequestId": "de4d6055-1501-46e4-86d3-7b6e47c5b8d5"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code |
Description |
| FailedOperation |
Operation Failure. |