ดึงรายการตารางฐานข้อมูล
ดึงรายการตารางฐานข้อมูล
รองรับการดึงรายการตารางฐานข้อมูลทั้งหมดภายใต้ Agent ที่ระบุผ่าน API นี้ โดยจะคืนค่าข้อมูลพื้นฐานของแต่ละตาราง (ชื่อตาราง คำอธิบาย จำนวนฟิลด์ จำนวนข้อมูล ฯลฯ)
วิธีการร้องขอ
POST
Endpoint
https://api-${endpoint}.gptbots.ai/v1/database/tables/page
การยืนยันตัวตน
ดูรายละเอียดวิธีการยืนยันตัวตนได้ที่ API Overview
คำขอ
ตัวอย่างการร้องขอ
curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/database/tables/page' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
"agent_id": "680d1a2b3c4d5e6f7a8b9c0d"
}'
curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/database/tables/page' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
"agent_id": "680d1a2b3c4d5e6f7a8b9c0d"
}'
บล็อกโค้ดนี้ในหน้าต่างลอย
Request Headers
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
| Authorization | Bearer ${API Key} | ใช้ Authorization: Bearer ${API Key} สำหรับการยืนยันตัวตน รับ API Key ได้จากหน้า API Key |
| Content-Type | application/json | ประเภทข้อมูล มีค่าเป็น application/json |
Request Body
| ฟิลด์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| agent_id | string | ใช่ | ตัวระบุเฉพาะของ Agent |
การตอบกลับ
ตัวอย่างการตอบกลับ
{
"tables": [
{
"table_id": "680d1a2b3c4d5e6f7a8b9c0d",
"name": "ตารางข้อมูลลูกค้า",
"description": "จัดเก็บข้อมูลพื้นฐานของลูกค้า",
"field_number": 8,
"record_count": 1250
},
{
"table_id": "680d1a2b3c4d5e6f7a8b9c0e",
"name": "ตารางคำสั่งซื้อ",
"description": "จัดเก็บข้อมูลคำสั่งซื้อ",
"field_number": 12,
"record_count": 5430
}
]
}
{
"tables": [
{
"table_id": "680d1a2b3c4d5e6f7a8b9c0d",
"name": "ตารางข้อมูลลูกค้า",
"description": "จัดเก็บข้อมูลพื้นฐานของลูกค้า",
"field_number": 8,
"record_count": 1250
},
{
"table_id": "680d1a2b3c4d5e6f7a8b9c0e",
"name": "ตารางคำสั่งซื้อ",
"description": "จัดเก็บข้อมูลคำสั่งซื้อ",
"field_number": 12,
"record_count": 5430
}
]
}
บล็อกโค้ดนี้ในหน้าต่างลอย
การตอบกลับเมื่อสำเร็จ
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
| tables | list | รายการตารางฐานข้อมูล |
| table_id | string | ตัวระบุเฉพาะของตารางฐานข้อมูล |
| name | string | ชื่อตาราง |
| description | string | คำอธิบายตาราง |
| field_number | int | จำนวนฟิลด์ |
| record_count | int | จำนวนข้อมูล (จำนวนแถวข้อมูล) |
การตอบกลับเมื่อผิดพลาด
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
| code | int | รหัสข้อผิดพลาด |
| message | string | รายละเอียดข้อผิดพลาด |
รหัสข้อผิดพลาด
| Code | Message |
|---|---|
| 40000 | พารามิเตอร์ไม่ถูกต้อง |
| 50000 | ข้อผิดพลาดภายในระบบ |
