แก้ไขเส้นทางเดียวด้วยเส้นทาง URL พร้อมการจับคู่พารามิเตอร์และการตรวจสอบเอกสารพารามิเตอร์.
แก้ไขเส้นทางเดียวสำหรับเส้นทางที่กำหนด หากพบเส้นทางที่ตรงกันพอดีจะถือว่าชนะ มิฉะนั้นจะเลือกแพตเทิร์นแบบพารามิเตอร์ที่ได้คะแนนดีที่สุด ตรวจสอบค่าพารามิเตอร์ที่ผูกไว้กับเอกสาร และคำนวณบล็อกที่มีผล นอกจากนี้ยังสามารถส่งคืนเอกสารพารามิเตอร์ที่แก้ไขแล้วได้ตามต้องการ
การยืนยันตัวตน: คีย์ API (ส่วนหัว x-api-key หรือพารามิเตอร์ query api_key).
| พารามิเตอร์ | ชนิด | จำเป็น | หมายเหตุ |
|---|---|---|---|
websiteId | uuid | ใช่ | เว็บไซต์เป้าหมาย. |
path | string | ใช่ | เส้นทาง URL ที่ต้องการแก้ไข เช่น /docs/getting-started. |
api_key | string | ไม่ | ทางเลือกแทนส่วนหัว x-api-key. |
preview | boolean | ไม่ | ค่าเริ่มต้นคือ false เมื่อเป็น true จะทำการแก้ไขกับเนื้อหาฉบับร่างและไม่ต้องการเอกสารที่เผยแพร่แล้ว. |
skipValidation | boolean | ไม่ | ค่าเริ่มต้นคือ false เมื่อเป็น true ความล้มเหลวในการตรวจสอบพารามิเตอร์จะไม่ส่งกลับ 404. |
{
"route": {
"path": "/docs/us/guide",
"pattern": "/docs/{country}/guide",
"block_ids": ["..."],
"state": "Live",
"param_bindings": { "country": "country" }
},
"resolvedParams": {
"country": {
"value": "us",
"schemaName": "country",
"document": { "id": "...", "schema_name": "country", "title": "United States", "published_content": {} }
}
}
}
route มีโครงสร้างเหมือนกับรายการจาก GET /routes resolvedParams จะมีเฉพาะเมื่อเส้นทางมีการผูกพารามิเตอร์และมีเอกสารที่ถูกแก้ไขอย่างน้อยหนึ่งรายการ พารามิเตอร์ที่ผูกกับสคีม่า language จะถูกแก้ไขจากรายการภาษาที่รองรับในตัวแทนที่จะใช้ฐานข้อมูล
curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
-H 'x-api-key: <key>'
400 — ไม่มีหรือ websiteId ไม่ถูกต้อง หรือไม่มี/ว่าง path401 — คีย์ API ไม่ถูกต้อง404 — ไม่พบเส้นทาง หรือการตรวจสอบพารามิเตอร์ล้มเหลว (ยกเว้นกรณี skipValidation=true)