เพิ่มหรืออัปเดตตัวแปรของเอกสารสำหรับคอมโพเนนต์แบบกำหนดเอง โดยใช้รหัสเอกสารเป็นคีย์.
เพิ่มหรืออัปเดต variant (แถวใน documents) ของคอมโพเนนต์แบบกำหนดเอง โดยใช้ id ของเอกสารเป็นคีย์ ระบุ id เพื่ออัปเดตตัวแปรที่มีอยู่แล้ว; ละไว้เพื่อแทรกตัวใหม่ ใช้งานได้ที่ /schemas/{schema_name} ด้วย เนื้อหาจะถูกตรวจสอบความถูกต้องตามสคีมาของคอมโพเนนต์.
การยืนยันตัวตน: คีย์ API — ต้องใช้เสมอ และคีย์ต้องมีสิทธิ์ content_write.
| พารามิเตอร์ | ชนิด | จำเป็น | หมายเหตุ |
|---|---|---|---|
schema_name | string | ใช่ | ชื่อคอมโพเนนต์แบบกำหนดเอง. |
| พารามิเตอร์ | ชนิด | จำเป็น | หมายเหตุ |
|---|---|---|---|
websiteId | uuid | ไม่ | เว็บไซต์เป้าหมาย; จะย้อนกลับไปใช้เฮดเดอร์ Host / การตั้งค่าหากไม่ได้ระบุ. |
api_key | string | ไม่ | ทางเลือกแทนเฮดเดอร์ x-api-key. |
{
"id": "<uuid>",
"title": "ตัวแปรของฉัน",
"content": { "title": "สวัสดี", "body": "..." }
}
| ฟิลด์ | ชนิด | จำเป็น | หมายเหตุ |
|---|---|---|---|
id | uuid | ไม่ | อัปเดตตัวแปรที่ตรงกันเมื่อมี; แทรกเมื่อไม่มีหรือไม่พบ. |
title | string | ไม่ | ชื่อที่แสดง ค่าเริ่มต้นเป็น "Untitled" เมื่อแทรก; จะคงเดิมเมื่ออัปเดตหากละไว้. |
content | object | ใช่ | ค่าของฟิลด์ ตรวจสอบความถูกต้องตามสคีมาของคอมโพเนนต์ ต้องเป็นอ็อบเจ็กต์ JSON. |
{
"id": "...",
"schema_name": "post",
"title": "ตัวแปรของฉัน",
"status": "ฉบับร่าง",
"version": 2,
"created": true
}
created จะเป็น true เมื่อแทรก (HTTP 201) และเป็น false เมื่ออัปเดต (HTTP 200).
curl -X PATCH '{CMS_API_URL}/dataset/post?websiteId=<uuid>' \
-H 'x-api-key: <key>' \
-H 'Content-Type: application/json' \
-d '{"content":{"title":"สวัสดี"}}'
400 — websiteId ไม่ถูกต้อง, content ที่ไม่ใช่อ็อบเจ็กต์, คอมโพเนนต์ที่ไม่รู้จักหรือถูกเก็บถาวร, หรือการตรวจสอบไม่ผ่าน401 — ไม่มีหรือคีย์ API ไม่ถูกต้อง403 — คีย์ไม่มีสิทธิ์ content_write404 — ระบุ id แต่ไม่พบตัวแปรที่ตรงกัน