Help Center/ KooDrive/ API Reference/ API/ File Favorites/ Adding Files to Favorites
Updated on 2024-07-30 GMT+08:00
View PDF
Share

Adding Files to Favorites

Function

Add files to favorites or remove files from favorites. Up to 100 files are supported.

URI

POST /koodrive/ose/v1/star/batch

Request Parameters

Table 1 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-hw-trace-id

No

String

Message log trace ID. The value contains 58 bits.
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

starred

Yes

Boolean

Whether files are added to favorites.

subRequestList

Yes

Array of StarFileRequest objects

Files to be added to favorites.
Table 3 StarFileRequest

Parameter

Mandatory

Type

Description

containerId

Yes

String

Space ID.

fileId

Yes

String

File ID, which must be unique.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

Integer

Response status. 0: all successful; 1: partially successful; 2: all failed.

subResponseList

Array of SubResponse objects

Sub-response list.
Table 5 SubResponse

Parameter

Type

Description

fileId

String

File ID.

code

String

Response code.

message

String

Response information.

Example Requests

{
  "starred" : true,
  "subRequestList" : [ {
    "containerId" : "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4",
    "fileId" : "Fn1bTLIOomJkTCAe9DEVBRY4U6IkuqkMZ"
  } ]
}

Example Responses

Status code: 200

OK

{
  "status" : 0,
  "subResponseList" : [ {
    "fileId" : "Fn1bTLIOomJkTCAe9DEVBRY4U6IkuqkMZ",
    "code" : "0",
    "message" : "success"
  } ]
}

Status Codes

Status Code

Description

200

OK
Parent topic: File Favorites