Skip to main content

Lấy dữ liệu chi tiết của bộ hồ sơ

Endpoint

MethodURL
GEThttps://tpa.docbase.ai/api/v1/integrations/organizations/{OrganizationID}/folders/{FolderID}/submissions/{SubmissionID}/data

*Sử dụng external_id thay thế cho SubmissionID

MethodURL
GEThttps://tpa.docbase.ai/api/v1/integrations/organizations/{OrganizationID}/folders/{FolderID}/requests/{external_id}/data

Params

box = "true" hoặc "false"

Trong đó:

  • box: "true" là sẽ trả về thông tin box, confidence_score và last_ocr_value và "false" sẽ không trả về thông tin box, confidence_score và last_ocr_value

Ví dụ

MethodURL
GEThttps://tpa.docbase.ai/api/v1/integrations/organizations/1/folders/2/submissions/3663/data?box=true

Mô tả

Trả về thông tin chung của bộ hồ sơ và dữ liệu OCR.

Response 200

Có tất cả thông tin giống API 6 có khác trong documents có thêm trường data_set: thông tin dữ liệu OCR của chứng từ

Ví dụ cho trường data_set:

{
"id": 623610,
"data_set": [],
"created_at": "2025-10-25T05:01:46.579179Z",
"updated_at": "2025-10-25T05:01:47.330264Z",
"deleted_at": null,
"last_ocr_value": "HỒ PHƯƠNG MÂY",
"value": "HỒ PHƯƠNG MÂY",
"confidence_score": 0.9985864162445068,
"status": "for_review",
"category": "datapoint",
"box": [281, 307, 474, 343],
"classified": null,
"classified_detail": null,
"level": null,
"document": 12093,
"page": 15368,
"service_label": {
"id": 3054,
"created_at": "2025-04-14T04:53:17.431222Z",
"updated_at": "2025-10-08T02:43:39.029737Z",
"deleted_at": null,
"display_name": "Họ tên người bệnh",
"enable": true,
"data_type": "String",
"category": "datapoint",
"document_type": "test_results",
"is_custom": false,
"parent": null
},
"parent": null
}

Ý nghĩa các trường

Tên trườngKiểu dữ liệuMô tả
idintID của dữ liệu
data_setlistDanh sách dữ liệu con (bảng)
created_atdatetimeNgày tạo
updated_atdatetimeNgày bị sửa đổi
deleted_atdatetimeNgày bị xóa
last_ocr_valuestringGiá trị OCR gốc
valuestringGiá trị OCR đã được chuẩn hóa
statusstringTrạng thái của trường dữ liệu
categorystringLoại dữ liệu
boxlistTọa độ của dữ liệu trên chứng từ
classifiedstringPhân loại chi phí
classified_detailstringPhân loại chi tiết

Ví dụ cho trường service_label:

{
"id": 3054,
"created_at": "2025-04-14T04:53:17.431222Z",
"updated_at": "2025-10-08T02:43:39.029737Z",
"deleted_at": null,
"display_name": "Họ tên người bệnh",
"enable": true,
"data_type": "String",
"category": "datapoint",
"document_type": "test_results",
"is_custom": false,
"parent": null
}

Ý nghĩa các trường:

Tên trườngKiểu dữ liệuMô tả
idintID của nhãn
created_atdatetimeNgày tạo
updated_atdatetimeNgày chỉnh sửa gần nhất
deleted_atdatetimeNgày xóa
display_namestringTên hiển thị
enableboolCó đang kích hoạt không
data_typestringLoại của dữ liệu
categorystringLoại của nhãn
document_typestringLoại của document
is_customboolCó phải nhãn trong template không
parentintID của nhãn cha