create_publication

mutationSeit v1.0

Legt eine Publikation an — das, was aus Ihrem Modell eine lesbare Website oder einen PDF-Bericht macht. Eine Publikation entscheidet drei Dinge: welche Navigationsbäume die Seitenstruktur bilden, welches Rendering jeden Elementtyp darstellt und was auf der Startseite steht.

Verwenden Sie zuerst list_trees und list_renderings, um die benötigten IDs zu finden. Die Startseite wird genauso geschrieben wie ein Rendering-Dokument, nur dass es dabei um kein bestimmtes Element geht.

Wird sofort angewendet. Das Veröffentlichen — sie für Leser auf eine bestimmte Modellversion festzulegen — ist ein eigener Schritt; siehe publish_publication.

Parameter

Name	Typ	Pflichtfeld	Standard	Beschreibung
`show_auto_ids`	`Boolean`	—	true	Ob Leser die Auto-IDs der Elemente sehen — „PRC-9: Zahlungserfassung” — und zwar überall dort, wo sie lesen: im Navigationsbaum, in Abschnittsübersichten, in Seitentiteln und in dem, was der Lese-Assistent zitieren darf. Bei einer neuen Publikation standardmäßig eingeschaltet.
`slug`	`String`	✓		Der Pfadabschnitt der Publikation in ihrer URL. Halten Sie ihn kurz und URL-tauglich — „service-handbook”.
`description`	`String`	—		Optionale Notiz für die Person, die die Publikation pflegt. Wird Lesern nicht angezeigt.
`homepage`	`String`	—		Die Startseite der Publikation, genauso geschrieben wie ein Rendering-Dokument, nur dass es dabei um kein bestimmtes Element geht. Blöcke, die über das ganze Modell greifen, funktionieren hier; solche, die sich auf ein Subjekt beziehen, haben keinen Ausgangspunkt.
`nav`	`Array<Object>`	—		Welche Navigationsbäume die Seitenstruktur bilden und damit, welche Seiten die Publikation überhaupt hat. Finden Sie Baum-IDs über list_trees.
`rendering_selection`	`Array<Object>`	—		Welches Rendering welchen Elementtyp darstellt. Bei einem Typ mit mehreren Renderings — etwa einer ausführlichen Seite und einer kurzen Zusammenfassung — wird hier entschieden, je Publikation. Finden Sie Rendering-IDs über list_renderings.
`name`	`String`	✓		Der Anzeigename der Publikation.
`external_services`	`Array<Object>`	—		An diese Publikation angebundene Berichtsdienste.
`folder_id`	`String`	—		Ordner, in dem die neue Publikation abgelegt wird, per ID oder Name.

Beispielanfrage

{"name": "Service Handbook", "slug": "service-handbook", "homepage": "# Service Handbook\n\nEverything we run, and who owns it.", "nav": [{"tree_id": "c017..."}], "rendering_selection": [{"target_type_id": "nt-uuid", "rendering_id": "4e2a..."}]}

Beispielantwort

{"success": true, "operation_count": 1, "versions": [95], "created": [{"kind": "publication", "id": "pb-1", "label": "Service Handbook"}]}