Help Center/ KooDrive/ API Reference/ API/ File List Query/ Listing Files in the Individual Space

Updated on 2024-07-30 GMT+08:00

View PDF

Listing Files in the Individual Space

Function

List files in the individual space.

URI

POST /koodrive/ose/v1/files/{type}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
type	Yes	String	0: individual space. 1: individual recycle bin.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	Yes	String	Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.
X-Traceid	No	String	Message log trace ID. The value contains 58 bits.
language	No	String	Language code, which complies with the internationalization specifications. For example, en-US indicates English (United States). English (United States) is used by default.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
pageInfo	No	PageInfo object	Pagination information.
sortInfo	No	FileSortInfo object	Classification information.
containerId	Yes	String	Space ID.
parentFileId	Yes	String	Parent directory of the file. root: root directory of the common file system. sbox: root directory of the safe file system.
fileType	No	String	File type. 10: folder. 15: image. 20: video. 26: Word file. 27: Excel file. 28: PowerPoint file. 30: audio. 35: compressed file. 40: application. 45: other.

**Table 4** PageInfo
Parameter	Mandatory	Type	Description
pageSize	No	Integer	Number of files on each page. Default value: 100.
pageCursor	No	String	Pagination start cursor.

**Table 5** FileSortInfo
Parameter	Mandatory	Type	Description
sortType	No	Integer	Sorting field. 1: by file name. 2: by file size. 3: by creation time. 4: by modification time. 5: by recycling time (only for recycled files). 6: by file format.
sortDirection	No	Integer	Sorting order. 1: ascending. 2: descending.

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
category	String	Resource type. The value is fixed to drive#fileList.
nextCursor	String	Pagination cursor. If the cursor does not exist, the last record has been returned.
searchCompleted	Boolean	Whether the search is complete.
files	Array of FileListMetadata objects	File list.
code	String	Response code.
msg	String	Response information.

**Table 7** FileListMetadata
Parameter	Type	Description
id	String	File ID.
fileName	String	File name, which contains up to 80 characters.
fileType	String	File type, which is input externally.
mimeType	String	Content type.
favorite	Boolean	Whether the file is added to favorites.
recycled	Boolean	Whether the file is moved to the recycle bin.
recycledTime	String	Time when the file is moved to the recycle bin. This parameter is returned when the file is recycled.
parentFolder	Array of strings	ID of the parent directory IDs. Currently, only the first ID is used.
properties	Map<String,String>	Common user-defined attributes of the file. The number of key-value pairs cannot exceed 30. A single key-value pair can contain up to 124 characters.
containers	Array of strings	Space ID.
createdTime	String	UTC time when the file is created.
editedTime	String	UTC time when the file is modified.
owners	Array of User objects	Owner.
lastEditor	User object	Last editor.
fileSuffix	String	File name extension, which is the last character string of fullFileExtension.
size	Integer	File size.
attachments	Array of FileListAttachment objects	Attachment.
downloadLinks	Array of DownLoadLink objects	Link for downloading FileProxy files.
userProperties	FileListPrivateProperties object	User attributes.

**Table 8** User
Parameter	Type	Description
category	String	Type. The value is drive#user. Enumeration values: drive#user
userId	String	Huawei user ID.
displayName	String	Display name of the user.
me	Boolean	Whether you are the user.
permissionId	String	Permission ID.

**Table 9** FileListAttachment
Parameter	Type	Description
usage	String	Default usage: content or thumbnail. This parameter is customizable.
hash	String	Hash of the resource associated with the asset.
sha256	String	SHA256 of the resource associated with the asset.
asset	FileListAsset object	Asset.

**Table 10** FileListAsset
Parameter	Type	Description
resource	FileListResource object	Resource.
mimeType	String	MIME type

**Table 11** FileListResource
Parameter	Type	Description
object	FileListSliceObject object	Part object, which is applicable when type is set to 0 or 3.

**Table 12** FileListSliceObject
Parameter	Type	Description
id	String	Part ID.
start	Long	Start position of a part, which is not applicable when type is set to 12.
downloadUrl	EndpointURLMetadata object	Download URL.
image	Array of Images objects	Thumbnail information.

**Table 13** Images
Parameter	Type	Description
process	String	File resource name.
downloadUrl	EndpointURLMetadata object	URL structure for file upload or download.

**Table 14** EndpointURLMetadata
Parameter	Type	Description
url	String	URL
method	String	http method

**Table 15** DownLoadLink
Parameter	Type	Description
usage	String	Default usage: content or thumbnail. This parameter is customizable.
downloadLink	String	Attachment download link.

**Table 16** FileListPrivateProperties
Parameter	Type	Description
properties	Map<String,String>	Extended attributes (The size of a single attribute is not limited, but the total size cannot exceed 16 KB.)

Status code: 400

**Table 17** Response body parameters
Parameter	Type	Description
error	Error object	Error message.

**Table 18** Error
Parameter	Type	Description
errorData	errorData object	Extended data returned to visitors when an exception occurs.
errorDetail	Array of ErrorMsg objects	Error chain.
code	Integer	HTTP status code.
description	String	HTTP status information.

**Table 19** errorData
Parameter	Type	Description
conflictFileId	String	Conflicting file ID.

**Table 20** ErrorMsg
Parameter	Type	Description
domain	String	Domain.
reason	String	Error cause.
errorCode	String	Internal system error code. For details, see the error code specifications.
description	String	Error message.
errorPos	String	Error position type.
errorParam	String	Error position.

Example Requests

Lists files in the root directory of individual space IAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b.

POST /koodrive/ose/v1/files/0

Authorization:Bearer+10f88*********4791e9ff

{
  "pageInfo": {
    "pageSize": "10",
    "pageCursor": ""
  },
  "sortInfo": {
    "sortType": "",
    "sortDirection": ""
  },
  "containerId": "IAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b",
  "parentFileId": "root",
  "fileType": "",
  "fileName": ""
}

Example Responses

Status code: 200

Returns the file list.

{
  "category" : "drive#fileList",
  "nextCursor" : "0|[9-1-0,11-0-1][JzIwMjMtMTItMTNUMDM6MzA6NTkuNTU4Wic=,J0ZpQk02VHhsS2JiSEx4LW54X3FaT2M1bFJBZXEwU0xZeCc=]",
  "searchCompleted" : false,
  "files" : [ {
    "id" : "Fk0n_I_3nVynIIlxGSUdLkYILxIZQ5Yyp",
    "fileName" : "AI Test",
    "mimeType" : "application/vnd.huawei-apps.folder",
    "fileSuffix" : "",
    "recycled" : false,
    "parentFolder" : [ "DEUI7pa0C24ArootIAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b" ],
    "containers" : [ "IAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b" ],
    "properties" : {
      "srcFileId" : "Fuyt9uELO9mny6vLWnWpIDqppRh3vzC3p",
      "createUser" : "369528171409614001",
      "lastEditUser" : "369528171409614001"
    },
    "owners" : [ {
      "category" : "drive#user",
      "me" : true,
      "permissionId" : "1243622029865966464",
      "userId" : "NDEzMDA4NjAwMDAwMjc0MTY2NS00MDA4NjAwMDAwNDg3MTY2Ng",
      "displayName" : "Tenant Administrator"
    } ],
    "lastEditor" : {
      "category" : "drive#user",
      "me" : true,
      "permissionId" : "1243622029865966464",
      "userId" : "NDEzMDA4NjAwMDAwMjc0MTY2NS00MDA4NjAwMDAwNDg3MTY2Ng",
      "displayName" : "Tenant Administrator"
    },
    "fileType" : "10",
    "createdTime" : "2023-12-11T09:17:25.529Z",
    "editedTime" : "2023-12-11T09:17:25.529Z",
    "favorite" : false
  } ],
  "code" : 0,
  "msg" : "OK"
}