Queries folders.

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 Yes ListDataServiceFolders

The operation that you want to perform. Set the value to ListDataServiceFolders.

PageNumber Integer Yes 1

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

PageSize Integer Yes 10

The number of entries to return on each page. Default value: 10. Maximum value: 100.

ProjectId Long Yes 10001

The ID of the workspace.

TenantId Long Yes 10002

The ID of the tenant. To obtain the tenant ID, perform the following steps: Log on to the DataWorks console. Find your workspace and go to the DataStudio page. On the page that appears, click the username for the logon in the upper-right corner and click User Info in the Menu section.

GroupId String No ds_123abc

The ID of the business process to which the folders belong.

FolderNameKeyword String No Keyword in folder names

The keyword in folder names. The keyword is used to search for folders whose names contain this keyword.

Response parameters

Parameter Type Example Description
RequestId String 0000-ABCD-EF****

The ID of the request.

FolderPagingResult Object

The paging result for the folders.

PageNumber Integer 1

The page number of the returned page. The value of this parameter is the same as that of the PageNumber parameter in the request.

PageSize Integer 10

The number of entries returned per page. Default value: 10. Maximum value: 100.

TotalCount Integer 100

The total number of returned entries.

Folders Array of Folder

The folders.

ParentId Long 0

The ID of the parent folder. The ID of the root folder in a business process is 0, and the ID of a folder created by a user in a business process is greater than 0.

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

The time when the folder was last modified.

GroupId String ds_1234

The ID of the business process to which the folder belongs.

FolderId Long 11

The ID of the folder.

FolderName String test1

The name of the folder.

ProjectId Long 10001

The ID of the workspace.

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

The time when the folder was created.

TenantId Long 10002

The ID of the tenant.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListDataServiceFolders
&PageNumber=1
&PageSize=10
&ProjectId=10001
&TenantId=10002
&GroupId=ds_123abc
&FolderNameKeyword=Keyword in folder names
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HTTP status code Error code Error message Description
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the number of requests for the resource has exceeded the upper limit.
429 Throttling.System The DataWorks system is busy. Try again later. The error message returned because the DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later. The error message returned because excessive requests have been submitted within a short period of time. Try again later.
500 InternalError.System An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.

For a list of error codes, see Service error codes.