إدراج أو تحديث متغير مستند لمكوّن مخصّص، مفهرس حسب معرّف المستند.
إدراج أو تحديث متغير (صف في documents) لمكوّن مخصّص، مفهرس حسب معرّف المستند id. قدّم id لتحديث متغير موجود؛ واحذفه لإدراج متغير جديد. يتوفّر أيضًا عند /schemas/{schema_name}. يتم التحقق من صحة المحتوى وفق مخطط المكوّن.
المصادقة: مفتاح واجهة برمجة التطبيقات — مطلوب دائمًا، ويجب أن يمتلك المفتاح صلاحية content_write.
| المعامل | النوع | إلزامي | ملاحظات |
|---|---|---|---|
schema_name | string | نعم | اسم المكوّن المخصّص. |
| المعامل | النوع | إلزامي | ملاحظات |
|---|---|---|---|
websiteId | uuid | لا | الموقع المستهدف؛ يعود إلى ترويسة Host أو الإعدادات عند غيابها. |
api_key | string | لا | بديل عن ترويسة x-api-key. |
{
"id": "<uuid>",
"title": "متغيري",
"content": { "title": "مرحبًا", "body": "..." }
}
| الحقل | النوع | إلزامي | ملاحظات |
|---|---|---|---|
id | uuid | لا | يحدّث المتغير المطابق عند وجوده؛ ويُدرج متغيرًا جديدًا عند غيابه أو عدم العثور عليه. |
title | string | لا | عنوان العرض. يكون الافتراضي "بلا عنوان" عند الإدراج؛ ولا يتغيّر أثناء التحديث عند إغفاله. |
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 غير صالح، محتوى ليس كائنًا، مكوّن غير معروف أو مؤرشف، أو فشل في التحقق401 — مفتاح واجهة برمجة التطبيقات مفقود أو غير صالح403 — المفتاح يفتقر إلى صلاحية content_write404 — تم توفير id ولكن لا يوجد متغير مطابق