Help Center/KooDrive/API Reference(Carrier)/API/File Management/Obtaining the Full Name and ID Paths of a File
Updated on 2026-02-12 GMT+08:00

Obtaining the Full Name and ID Paths of a File

Function

Obtain the full name and ID paths of a file.

URI

GET /koodrive/ose/v1/files/path

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

fileId

Yes

String

Definition:

File ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

containerId

Yes

String

Definition:

ID of the space to which the file belongs.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Definition:

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}.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Traceid

No

String

Definition:

Service trace ID, which contains 58 bits.

Constraints:

N/A

Range:

The value contains 58 bits.

Default Value:

N/A

language

No

String

Definition:

Language code.

Constraints:

The value must comply with the internationalization specifications. For example, en_us indicates English (United States).

Range:

The value must comply with the internationalization specifications.

Default Value:

en-US

X-User-Id

Yes

String

Definition:

User ID on KooDrive, which is used for app authentication.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Date

Yes

String

Definition:

Date, which is used for app authentication. The format is yyyyMMdd'T'HHmmss'Z'.

Constraints:

The time must be within 15 minutes from the current time and cannot be later than the current time.

Range:

N/A

Default Value:

N/A

x-hw-share-folder-id

No

String

Definition:

ID of the shared folder. If this request header is passed, the current operation is performed in the shared folder.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Response code.

msg

String

Response message.

fileIdPath

String

Full path of the file ID.

namePath

String

Full path of the file name.

Example Requests

Queries the full directory path of a file.

GET /koodrive/ose/v1/files/path?fileId=FqS6hLLy_DkjlWdfOnEdCErhsmokRvdXI&containerId=IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4

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

Example Responses

Status code: 200

Full path information.

{
  "fileIdPath" : "/DEUI7pa0C24ArootIAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4/FkbdCAceMj89bprz5xLJASID1eaRqjlRP/FqIAmBlIz7ovbThxeUBlOpbnCHaP_MTUL/FqS6hLLy_DkjlWdfOnEdCErhsmokRvdXI",
  "namePath" : "/rootIAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4/007/001/Batch Task Test",
  "code" : 0,
  "msg" : "OK"
}

Status Codes

Status Code

Description

200

Full path information.