profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchΡύθμιση διακομιστή μεσολάβησης πίνακα διαχείρισηςCEL Scripting in Template BuilderProject ScaffoldingΒιβλιοθήκη πολυμέσων

Χωρίς κεφαλή

Γρήγορη εκκίνησηjson και Claude κώδικαςComponent Zod Pull

REST API

επισκόπηση του REST APIgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetΛήψη μπλοκ με cel cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getΛήψη ονόματος σχήματος συνόλου δεδομένωνgetGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

PATCH /dataset/{schema_name}

Εισαγάγετε ή ενημερώστε μία παραλλαγή εγγράφου ενός προσαρμοσμένου στοιχείου, με κλειδί το αναγνωριστικό του εγγράφου.

Εκτελέστε λειτουργία εισαγωγής ή ενημέρωσης (upsert) για μια παραλλαγή (μία γραμμή documents) ενός προσαρμοσμένου στοιχείου, με κλειδί το id του εγγράφου. Παρέχετε το id για να ενημερώσετε μια υπάρχουσα παραλλαγή· παραλείψτε το για να εισαγάγετε μια νέα. Διατίθεται επίσης στο /schemas/{schema_name}. Το περιεχόμενο επικυρώνεται σε σχέση με το σχήμα του στοιχείου.

Auth: Κλειδί API — απαιτείται πάντα, και το κλειδί πρέπει να διαθέτει την άδεια content_write.

Παράμετροι διαδρομής

ΠαράμετροςΤύποςΥποχρεωτικόΣημειώσεις
schema_namestringyesΤο όνομα του προσαρμοσμένου στοιχείου.

Παράμετροι ερωτήματος

ΠαράμετροςΤύποςΥποχρεωτικόΣημειώσεις
websiteIduuidnoΙστότοπος-στόχος· προεπιλέγει την επικεφαλίδα Host / τη ρύθμιση.
api_keystringnoΕναλλακτική της επικεφαλίδας x-api-key.

Σώμα αιτήματος

{
  "id": "<uuid>",
  "title": "Η παραλλαγή μου",
  "content": { "title": "Γεια", "body": "..." }
}
ΠεδίοΤύποςΥποχρεωτικόΣημειώσεις
iduuidnoΕνημερώνει την αντίστοιχη παραλλαγή όταν υπάρχει· εισάγει νέα όταν λείπει ή δεν βρεθεί.
titlestringnoΤίτλος εμφάνισης. Προεπιλεγμένη τιμή "Untitled" κατά την εισαγωγή· παραμένει αμετάβλητος κατά την ενημέρωση όταν παραλείπεται.
contentobjectyesΤιμές πεδίων, επικυρωμένες με βάση το σχήμα του στοιχείου. Πρέπει να είναι αντικείμενο 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_write
  • 404 — δόθηκε id αλλά δεν βρέθηκε αντίστοιχη παραλλαγή
Continue Reading
Previous‹GET /content-changes (SSE)NextPOST /translation›