Queries the details of a Data Service folder in a DataWorks workspace.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| TenantId |
integer |
No |
The tenant ID. This parameter is deprecated. You can obtain the tenant ID by logging on to the DataWorks console, navigating to DataStudio, clicking your username in the upper-right corner, and selecting User Info. |
10003 |
| ProjectId |
integer |
Yes |
The ID of the workspace. |
10002 |
| FolderId |
integer |
Yes |
The ID of the folder. |
10001 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. |
0000-ABCD-EF**** |
| Folder |
object |
The details of the folder. |
|
| ParentId |
integer |
The parent folder ID. The root folder ID in a business process is 0. User-created folder IDs are greater than 0. |
0 |
| ModifiedTime |
string |
The time when the folder was last modified. |
2020-09-24T18:37:51+0800 |
| GroupId |
string |
The ID of the business process to which the folder belongs. |
ds_1234 |
| FolderId |
integer |
The folder ID. |
11 |
| ProjectId |
integer |
The workspace ID. |
10001 |
| FolderName |
string |
The name of the folder. |
test1 |
| CreatedTime |
string |
The time when the folder was created. |
2020-09-24T18:37:51+0800 |
| TenantId |
integer |
The tenant ID. |
10002 |
Examples
Success response
JSON format
{
"RequestId": "0000-ABCD-EF****",
"Folder": {
"ParentId": 0,
"ModifiedTime": "2020-09-24T18:37:51+0800",
"GroupId": "ds_1234",
"FolderId": 11,
"ProjectId": 10001,
"FolderName": "test1",
"CreatedTime": "2020-09-24T18:37:51+0800",
"TenantId": 10002
}
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | No permission, please authorize |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.