create_rendering

mutationSeit v1.0

Legt ein Rendering an — die Seitenvorlage für genau einen Knoten- oder Beziehungstyp. Jedes Element dieses Typs wird durch sie dargestellt, Sie schreiben also einmal die Form der Seite, statt jede Seite einzeln zu schreiben.

Das Dokument ist Markdown mit zwei Ergänzungen: Platzhaltern, die Werte des Elements einsetzen, um das es auf der Seite geht, und Blöcken, die verwandte Elemente, Eigenschaften, Kennzahlen oder Ansichten einbinden. Ein Typ kann mehrere Renderings haben — ein ausführliches für die Website, ein knappes für einen Vorstandsbericht — und jede Publikation wählt das aus, das sie braucht.

Führen Sie nach dem Schreiben eines Dokuments preview_rendering gegen ein echtes Element aus. Ein Block, der still auf nichts zutrifft, wird als nichts gerendert, und das Dokument selbst gibt keinerlei Hinweis darauf, dass etwas nicht stimmt. Den vollständigen Sprachumfang finden Sie im Hilfeartikel „Rendering-Dokumente schreiben”.

Parameter

Name	Typ	Pflichtfeld	Beschreibung
`name`	`String`	✓	Name für das Rendering. Wählen Sie einen, den Sie später wiedererkennen — „Service-Seite”, „Vorstandszusammenfassung” —, denn Publikationen wählen Renderings über den Namen aus.
`description`	`String`	—	Optionale Notiz für die Person, die das Rendering pflegt. Wird Lesern nicht angezeigt.
`folder_id`	`String`	—	Ordner, in dem das neue Rendering abgelegt wird, per ID oder Name.
`document`	`String`	—	Die Seitenvorlage: Markdown, dazu Platzhalter wie {{ subject.label }}, die Werte des Elements einsetzen, um das es auf der Seite geht, sowie Blöcke, die mit ::: beginnen und Eigenschaften, verwandte Elemente, Kennzahlen oder Ansichten einbinden. Ein optionaler Abfrageblock am Anfang legt fest, auf welche verwandten Elemente ein view-Block zurückgreifen kann. Zwei Dinge führen regelmäßig in die Irre. Typ- und Beziehungsnamen müssen exakt so geschrieben sein wie in Ihrem Modell — ein Name, den es nicht gibt, trifft auf nichts zu, ohne jede Meldung. Und eine Überschrift, die Sie als Text schreiben, erscheint auf jeder Seite, auch wenn der Block darunter nichts findet; setzen Sie die Überschrift deshalb an den Block. Den vollständigen Sprachumfang finden Sie im Hilfeartikel „Rendering-Dokumente schreiben”, und mit preview_rendering prüfen Sie, was ein Dokument tatsächlich erzeugt.
`target_type`	`String`	✓	Der Knoten- oder Beziehungstyp, den dieses Rendering darstellt, per ID oder Name. Jedes Element dieses Typs wird dadurch gerendert.

Beispielanfrage

{"name": "Service page", "target_type": "Service", "document": "# {{ subject.label }}\n\n:::prose{ source=subject.description }\n\n:::properties"}

Beispielantwort

{"success": true, "operation_count": 1, "versions": [92], "created": [{"kind": "rendering", "id": "4e2a...", "label": "Service page"}]}