בצע פעולה של עדכון-או-הוספה עבור וריאנט של מסמך של רכיב מותאם אישית, שמקושר לפי מזהה המסמך.
בצע פעולה של עדכון-או-הוספה עבור וריאנט (שורה ב-documents) של רכיב מותאם אישית, כאשר המפתח הוא id של המסמך. ספק id כדי לעדכן וריאנט קיים; השמט אותו כדי להוסיף וריאנט חדש. הפעולה זמינה גם ב-/schemas/{schema_name}. התוכן מאומת מול הסכימה של הרכיב.
אימות: מפתח API — נדרש תמיד, ועל המפתח לשאת את ההרשאה content_write.
| פרמטר | סוג | נדרש | הערות |
|---|---|---|---|
schema_name | מחרוזת | כן | שם הרכיב המותאם אישית. |
| פרמטר | סוג | נדרש | הערות |
|---|---|---|---|
websiteId | UUID | לא | אתר היעד; במקרה שלא סופק משתמשים בכותרת Host או בתצורה. |
api_key | מחרוזת | לא | חלופה לכותרת x-api-key. |
{
"id": "<uuid>",
"title": "My variant",
"content": { "title": "Hello", "body": "..." }
}
| שדה | סוג | נדרש | הערות |
|---|---|---|---|
id | UUID | לא | עדכן את הווריאנט התואם כאשר קיים; הוסף כאשר חסר או לא נמצא. |
title | מחרוזת | לא | כותרת תצוגה. ברירת המחדל היא "Untitled" בעת הוספה; נשארת ללא שינוי בעת עדכון כאשר היא מושמטת. |
content | אובייקט | כן | ערכי השדות, מאומתים מול הסכימה של הרכיב. חייב להיות אובייקט JSON. |
{
"id": "...",
"schema_name": "post",
"title": "My variant",
"status": "draft",
"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":"Hello"}}'
400 — websiteId לא חוקי, content שאינו אובייקט, רכיב לא מוכר או בארכיון, או כשל באימות401 — מפתח API חסר או לא חוקי403 — למפתח חסרה ההרשאה content_write404 — סופק id אך לא נמצא וריאנט תואם