Xóa hồ sơ
Endpoint
| Method | URL |
|---|---|
| POST | https://tpa.docbase.ai/api/v1/integrations/folders/{FolderID}/submissions/delete |
Params
| Tham số | Các giá trị đầu vào | Mô tả |
|---|---|---|
| delete_file | "true" hoặc "false" | Nếu là "true" thì sẽ xóa file gốc của hồ sơ, "false" thì sẽ không xóa |
| delete_thumb | "true" hoặc "false" | Nếu là "true" thì sẽ xóa file ảnh từng trang của hồ sơ, "false" thì sẽ không xóa |
Authorization
Auth Type: Basic Auth
Username: api_key của thư mục chứa hồ sơ
Body
| Tham số | Kiểu dữ liệu | Mô tả |
|---|---|---|
| submission_ids | array[integer] | ID của các hồ sơ cần xóa (ví dụ: [1,3,6,36]) |
Ví dụ
| Method | URL |
|---|---|
| POST | https://tpa.docbase.ai/api/v1/integrations/folders/1/submissions/delete |
Mô tả Trả về thông tin của bộ hồ sơ nào xóa thành công và bộ nào xóa thất bại.
Response 200
{
"deleted_ids": [],
"error_ids": []
}
| Tên trường | Kiểu dữ liệu | Mô tả |
|---|---|---|
| deleted_ids | list | Danh sách id của hồ sơ đã xóa thành công |
| error_ids | list | Danh sách id của hồ sơ xóa không thành công |