profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

ניתוב פרמטריסוגי רכיביםSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyכתיבת סקריפטים בבונה התבניותProject Scaffoldingספריית המדיה

ללא ראש

התחלה מהירהSplit Screen JSON Component Builder with LLMComponent Zod Pull

ממשק REST

סקירת REST APIgetחיבור-אתר-ל-API-של-CMSgetGET /routesgetGET /routegetקבלת בלוקיםgetהשגת-בלוקים-עם-מטמון-CELgetGET /blocks/generatedgetקבל רכיביםgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postתרגום פוסטpatchPATCH /translationsgetGET /usagepostפוסט-CSVpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

PATCH /dataset/{schema_name}

בצע פעולה של עדכון-או-הוספה עבור וריאנט של מסמך של רכיב מותאם אישית, שמקושר לפי מזהה המסמך.

בצע פעולה של עדכון-או-הוספה עבור וריאנט (שורה ב-documents) של רכיב מותאם אישית, כאשר המפתח הוא id של המסמך. ספק id כדי לעדכן וריאנט קיים; השמט אותו כדי להוסיף וריאנט חדש. הפעולה זמינה גם ב-/schemas/{schema_name}. התוכן מאומת מול הסכימה של הרכיב.

אימות: מפתח API — נדרש תמיד, ועל המפתח לשאת את ההרשאה content_write.

פרמטרי נתיב

פרמטרסוגנדרשהערות
schema_nameמחרוזתכןשם הרכיב המותאם אישית.

פרמטרי שאילתה

פרמטרסוגנדרשהערות
websiteIdUUIDלאאתר היעד; במקרה שלא סופק משתמשים בכותרת Host או בתצורה.
api_keyמחרוזתלאחלופה לכותרת x-api-key.

גוף הבקשה

{
  "id": "<uuid>",
  "title": "My variant",
  "content": { "title": "Hello", "body": "..." }
}
שדהסוגנדרשהערות
idUUIDלאעדכן את הווריאנט התואם כאשר קיים; הוסף כאשר חסר או לא נמצא.
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_write
  • 404 — סופק id אך לא נמצא וריאנט תואם
Continue Reading
Previous‹GET /content-changes (SSE)Nextתרגום פוסט›