profound-logoProfound CMS
⌘K
Admin
Theme
Tài liệuHướng dẫnBlogTriết học
Tài liệuHướng dẫnBlogTriết học

Kết hợp

Định tuyến tham sốCác loại ComponentSetup server sent events (SSE) content refetchThiết lập proxy bảng điều khiển quản trịCEL Scripting in Template BuilderProject ScaffoldingThư viện phương tiện

Không đầu

Bắt đầu nhanhJson và claude codeComponent Zod Pull

REST API

Tổng quan REST APIgetKết nối API trang webgetGET /routesgetLấy tuyếngetGET /blocksgetLấy các khối kèm bộ đệm CELgetGET /blocks/generatedgetGET /componentsgetLấy tên thành phầngetLấy tên lược đồ tập dữ liệugetGET /content-changes (SSE)patchCập nhật tên lược đồ tập dữ liệupostPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

Cập nhật tên lược đồ tập dữ liệu

Chèn hoặc cập nhật một biến thể tài liệu của thành phần tùy chỉnh, được xác định bằng id tài liệu.

Chèn hoặc cập nhật một biến thể (một dòng documents) của thành phần tùy chỉnh, được xác định bằng id của tài liệu. Cung cấp id để cập nhật biến thể hiện có; bỏ qua để chèn một biến thể mới. Cũng có sẵn tại /schemas/{schema_name}. Nội dung được xác thực dựa trên lược đồ của thành phần.

Xác thực: Khóa API — luôn bắt buộc, và khóa phải có quyền content_write.

Tham số đường dẫn

Tham sốKiểuBắt buộcGhi chú
schema_namechuỗicóTên thành phần tùy chỉnh.

Tham số truy vấn

Tham sốKiểuBắt buộcGhi chú
websiteIduuidkhôngWebsite đích; mặc định là tiêu đề Host / cấu hình.
api_keychuỗikhôngThay thế cho tiêu đề x-api-key.

Thân yêu cầu

{
  "id": "<uuid>",
  "title": "Biến thể của tôi",
  "content": { "title": "Xin chào", "body": "..." }
}
TrườngKiểuBắt buộcGhi chú
iduuidkhôngCập nhật biến thể tương ứng khi có; chèn khi vắng mặt hoặc không tìm thấy.
titlechuỗikhôngTiêu đề hiển thị. Mặc định là "Không tiêu đề" khi chèn; giữ nguyên khi cập nhật nếu bỏ qua.
contentđối tượngcóCác giá trị trường, được xác thực theo lược đồ của thành phần. Phải là một đối tượng JSON.

Phản hồi

{
  "id": "...",
  "schema_name": "post",
  "title": "Biến thể của tôi",
  "status": "bản nháp",
  "version": 2,
  "created": true
}

created là true khi chèn (HTTP 201) và false khi cập nhật (HTTP 200).

Ví dụ

curl -X PATCH '{CMS_API_URL}/dataset/post?websiteId=<uuid>' \
  -H 'x-api-key: <key>' \
  -H 'Content-Type: application/json' \
  -d '{"content":{"title":"Xin chào"}}'

Lỗi

  • 400 — websiteId không hợp lệ, content không phải đối tượng, thành phần không xác định hoặc đã lưu trữ, hoặc lỗi xác thực
  • 401 — khóa API bị thiếu hoặc không hợp lệ
  • 403 — khóa không có quyền content_write
  • 404 — id được cung cấp nhưng không có biến thể khớp
Continue Reading
Previous‹GET /content-changes (SSE)NextPOST /translation›