SocialluxSociallux
Toggle navigation menu
Docs navigationv

Primitive

atom.appendDataField

BETA

Short name: appendDataField

Version: 1.0.0

System primitive that appends a single FieldEntry to an atom's data map. Fails if the field name already exists (use a separate update primitive to overwrite).

Back to primitive library

Inputs

KeyTypeRequiredDescription
atomIdobjectIdtrueAtom to mutate. Caller must have manage rights (owner, org-member, or admin).
fieldNamestringtrueKey under data to create. Must not already exist on the atom.
isPublicbooleanfalseField-level visibility. Only the atom owner may set this to false; org-members and admins cannot privatize a field they do not own.
lexemeAliasesobjectfalseMap of lexemeId → display label, allowing this field to surface under different names per subscribed lexeme.
valueanytrueStored value for the new FieldEntry. No type is enforced; valueType is descriptive metadata.
valueTypestringfalseDeclared AtomFieldInputType for the value. One of: string, number, integer, boolean, date, instant, linkedAtom, linkedAtomArray, array, object, markdown, url.

Outputs

KeyTypeRequiredDescription
atomobjectfalseUpdated atom summary: { id, version, lexemeIds, data, isPublic }.
fieldNamestringfalseThe field name that was appended.