set_file_lock
POST
/api/v1/files/{id}/lock
const url = 'https://example.com/api/v1/files/1/lock';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"locked":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}use serde_json::json;use reqwest;
#[tokio::main]pub async fn main() { let url = "https://example.com/api/v1/files/1/lock";
let payload = json!({"locked": true});
let mut headers = reqwest::header::HeaderMap::new(); headers.insert("Authorization", "Bearer <token>".parse().unwrap()); headers.insert("Content-Type", "application/json".parse().unwrap());
let client = reqwest::Client::new(); let response = client.post(url) .headers(headers) .json(&payload) .send() .await;
let results = response.unwrap() .json::<serde_json::Value>() .await .unwrap();
dbg!(results);}curl --request POST \ --url https://example.com/api/v1/files/1/lock \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "locked": true }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
integer format: int64
File ID
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
Lock or unlock a file.
object
locked
required
boolean
Examplegenerated
{ "locked": true}Responses
Section titled “Responses”Lock state updated
Media typeapplication/json
统一 API 响应格式
成功: { "code": "success", "msg": "", "data": {...} }
失败: { "code": "auth.credentials_failed", "msg": "Invalid Credentials" }
object
code
required
string
data
object
blob_id
required
integer format: int64
compound_extension
string | null
created_at
required
string
created_by_user_id
integer | null format: int64
created_by_username
required
string
deleted_at
string | null
extension
required
string
file_category
required
High-level file category inferred from extension and MIME type.
string
folder_id
integer | null format: int64
id
required
integer format: int64
is_locked
required
boolean
mime_type
required
string
name
required
string
owner_user_id
integer | null format: int64
size
required
integer format: int64
storage_used
Total quota bytes for the file detail view: current size plus all
historical version sizes. size is only the current version size.
integer | null format: int64
tags
required
Array<object>
object
color
required
string
id
required
integer format: int64
name
required
string
team_id
integer | null format: int64
updated_at
required
string
error
msg
required
string
Example
{ "code": "success", "data": { "file_category": "image" }}Unauthorized
File not found