Call the ListDataServiceFolders to query the folder list in dataservice studio.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Required ListDataServiceFolders

The operation that you want to perform.

PageNumber Integer Yes 1

The number of the page to return. Pages start from page 1. Default value: 1.

PageSize Integer Yes 10

The size of each page. The minimum value is 1. The maximum value is 50. The default value is 10.

ProjectId Long Yes 10001

The ID of the DataWorks workspace.

RegionId String Required cn-shanghai

The ID of the region where your project resides.

TenantId Long Yes 10002

The ID of the tenant.

GroupId String No ds_123abc

The ID of the workflow to which the folder belongs.

FolderNameKeyword String No Folder keyword

Enter a keyword of the folder name to use for substring matching.

Response parameters

Parameter Type Example Description
FolderPagingResult Struct

The paging result of the folder list.

Folders Array of Folder

The list of folders.

CreatedTime String 2020-09-24T18:37:51+0800

The time when the folder was created.

FolderId Long 11

ID of the folder.

FolderName String test1

The name of the folder.

GroupId String ds_1234

The ID of the workflow to which the folder belongs.

ModifiedTime String 2020-09-24T18:37:51+0800

The editing time of the folder.

ParentId Long 0

The ID of the parent folder. The root folder ID under the workflow is equal to 0, and the ID of the user-created folder is greater than 0.

ProjectId Long 10001

The ID of the DataWorks workspace.

TenantId Long 10002

The ID of the tenant.

PageNumber Integer 1

The number of the page, which is consistent with the PageNumber value in the request.

PageSize Integer 10

The size of each page, which is the same as the value of PageSize in the request.

TotalCount Integer 100

The total number of records returned.

RequestId String 0000-ABCD-EF****

The unique ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ListDataServiceFolders
&PageNumber=1
&PageSize=10
&ProjectId=10001
&RegionId=cn-shanghai
&TenantId=10002
&<Common request parameters>

Sample success responses

XML format

<RequestId>0000-ABCD-EF****</RequestId>
<FolderPagingResult>
    <TotalCount>100</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Folders>
        <ParentId>0</ParentId>
        <TenantId>10002</TenantId>
        <CreatedTime>2020-09-24T18:37:51+0800</CreatedTime>
        <ModifiedTime>2020-09-24T18:37:51+0800</ModifiedTime>
        <ProjectId>10001</ProjectId>
        <FolderId>11</FolderId>
        <FolderName>test1</FolderName>
        <GroupId>ds_1234</GroupId>
    </Folders>
</FolderPagingResult>

JSON format

{
    "RequestId": "0000-ABCD-EF****",
    "FolderPagingResult": {
        "TotalCount": 100,
        "PageSize": 10,
        "PageNumber": 1,
        "Folders": {
            "ParentId": 0,
            "TenantId": 10002,
            "CreatedTime": "2020-09-24T18:37:51+0800",
            "ModifiedTime": "2020-09-24T18:37:51+0800",
            "ProjectId": 10001,
            "FolderId": 11,
            "FolderName": "test1",
            "GroupId": "ds_1234"
        }
    }
}

Error code

HttpCode Error code Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. Your access is restricted, possibly because you have not activated DataWorks.
500 InternalError.System An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
403 ResourceNotAuthorized.Api You are not authorized to access the resources. You cannot access resources without authorization.
429 Throttling.Api The request for this resource has exceeded your available limit. The request for the resource exceeds your available upper limit.
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks the system is busy, please try again later.
429 Throttling.User Your request is too frequent. Try again later. Your request is too frequent, please try to slow down the request speed.

For a list of error codes, visit the API Error Center.