Commands

A command is POST {Path}/command, with the token, and the JSON body { type, payload }:

It answers { "kind": "nodes", "items": [ … ], "totalCount": 42, "pageIndex": 0, "pageSize": 20, … }.

Pass values as typed parameters, never as literals. The query language has no literals for decimals or dates, and n.Price > 100 against a decimal property compares with 0. A parameter is { name, type, value }. Its type is string, int, long, double, float, decimal, bool, datetime, datetimeoffset, timespan, guid or geo, or an array such as guid[]. The SDK's query builder does this for you, and its toRequest() shows the text it writes (chapter 19).

Types, properties and relation ends are named by CodeName or by id. CodeNames are case-sensitive.

schema gives a client what it needs to build an editor. Each type has its icon (as SVG), title, description and canBeDraft. Each property has its kind and defaultValue, and one that holds other nodes has display: List, Table, Inline, Cards or Thumbnail.

Every write runs through NodeStore.Execute, so the store's transaction plugins run exactly as they do for a write from C#.

transaction runs its actions in one transaction: all of them happen, or none. Each action is a write command, named by op, with that command's payload. An action can use a node an earlier one inserts:

• insert fills the properties it is not given with the type's defaults. In a context with a culture, the node's first version is in that culture. With a collection, the node is in that site.
• A relation end takes an id, or a list of ids for a "many" end, and is set to exactly those.
• update-meta's meta takes readAccess, editViewAccess, editAccess, publishAccess, collectionId, releaseUtc, expireUtc and deleted. Null clears a value: an access group then comes from the type's or the database's default, and a node with no collectionId is in no site.

The content tree

The CMS interface's content tree runs on these commands. They read a one-to-many relation as parents and children: the one named in relation (class name, full name or id), else the CMS setting Content.Tree, else RTree.

• Items are { $id, $type, $displayName, $children, $status }, $children counting the children the tree shows. A search result also has $path, the way down to it.
• Sites. When sites (ISite) can be in the relation, as in RTree, the tree is one site's: root picks it. Only a site can go at the top.
• Hidden pages. A page whose ShowInTree is off is left out, with everything below it. hidden: true lists them too, marked $hidden.
• Moving. A node goes into parent as its last child, before or after a sibling, or to the top. With children, the default, its branch goes with it. Without, its children take its place.
• Copying. A copy has the node's values, access and files, and the links it can share: the "one" end of a one-to-many relation, and many-to-many links. A copy that is cancelled or fails removes what it made. Nothing limits its size, but the interface counts a copy first and warns past CmsApiOptions.TreeCopyWarnAt (10 000 nodes; 0 never warns).
• Deleting. tree-delete takes each node with everything below it, and is refused (403) when the user cannot read some of that. With children: false it deletes one node, and its children take its place.
• Addresses. A node moved, copied or created gets an address the store makes unique, such as news-2. tree-create makes it from the node's name.

revision can be left out for a node with one version. Publishing a revision archives the culture's published one. history-restore writes values only, not files, passwords or relations, into the revision the context's revisions names.

A file is never a value, and update refuses one. Upload it with POST {Path}/upload?id=…&property=…&name=…, the file as the body, up to CmsApiOptions.MaxUploadBytes (1 GB). Add context=, a payload context as JSON, to upload into a particular revision; the file commands use the context's revision too. file-copy sends no bytes through the client. file-delete leaves the stored file in place, as another revision or a copy of the node may hold it, and the store's clean-up of unreferenced files removes it later.

The process commands answer 404 for another user's process, and 400 for one that cannot do what is asked. maintenance-run is for administrators (403), runs one task at a time per user (409), and needs the site and culture the task asks for. Its result counts the nodes it checked, found, fixed and failed on, and items names the first 100 found, each with its problem. Processes shows how to write a process, and Sites describes the tasks.

Each node blade of the CMS interface joins its node's room, so it knows who else has the node open. A participant is an id the client chooses. connectionId is the id the event stream sent in connected. A node with revisions has a room per revision.

first is true for a participant that went live while no one else was: it brings the document. The server keeps no document. It passes the messages (base64, at most 8 MB per send) to the other live participants, or to the one named in to, and never back to the sender's connection. The CMS interface sends Yjs updates this way. Participants leave by themselves when their stream closes.

The commands here that change something are for administrators. Every skin value is checked before it is saved (Skins), and a skin cannot take a built-in skin's key.