Serialization groups

Roadiz CMS uses symfony/serializer to perform JSON serialization over any objects, especially Doctrine entities.

Group	Description
id	Serialize every entity id.
attribute	Serialize entities in a Attribute context.
attribute_documents	Serialize documents linked to a Attribute for each virtual field.
attribute_group	Serialize Attribute group name and translations.
attribute_node	Serialize AttributeValue in a node context (node-specific attribute values).
breadcrumbs	Serialize breadcrumb trail items within a web_response context.
children	Serializes a node along with its children using a treeWalker.
color	Serialize every entity color fields.
custom_form	Serialize entities in a CustomForm context.
custom_form_answer	Serialize CustomFormAnswer entity with its submission fields.
document	Serialize entities in a Document context.
document_copyright	Serialize Document copyright validity date range (copyrightValidSince, copyrightValidUntil).
document_display	Serialize Document information required for displaying them.
document_display_sources	Serialize Document information required for displaying alternative sources (audio, video).
document_filesize	Serialize Document filesize in bytes.
document_folders	Serialize Document information required for displaying attached visible folders.
document_folders_all	Serialize all Document attached folders, even not visible ones.
document_mount	Serialize Document storage mount path prefix.
document_original	Serialize Document original reference (for thumbnail documents pointing back to their original).
document_raw_relative_path	Serialize rawRelativePath when document has a RAW version and make it downloadable.
document_thumbnails	Serialize Document first available thumbnail.
folder	Serialize entities in a Folder context.
folder_children	Serialize Folder children.
folder_color	Serialize Folder color field.
folder_parent	Serialize Folder parent.
log	Serialize Log entity core fields.
log_sources	Serialize node/source context on Log entries.
log_user	Serialize user context on Log entries.
node	Serialize entities in a Node context.
node_attributes	Serialize Nodes with their attribute values.
node_children	Serialize Nodes with their children.
node_listing	Serialize Nodes and NodesSources with their listing children options. Adds listingSortOptions field to node-sources, with for example { "node.position": "ASC" } to be able to fetch children nodes in the same order as in the back office. If the current serialized node-source parent is hiding its children, listingSortOptions will contain the parent's listingSortOptions instead.
node_type	Serialize entities in a NodeType context.
nodes_sources	Serialize entities in a NodesSources context (all fields).
nodes_sources_base	Serialize entities in a NodesSources context, but with essential information.
nodes_sources_default	Serialize NodesSources fields not contained in any group.
nodes_sources_documents	Serialize documents linked to a NodesSources for each virtual field.
nodes_sources_published	Serialize NodesSources isPublished field when you fetch all NodesSources, even the unpublished ones.
nodes_sources_xxxx	Custom serialization groups are created according to your node-type fields groups. For example, if you set a field to a link group, nodes_sources_link serialization group will be automatically generated for this field. Be careful, Roadiz will use groups canonical names to generate serialization groups, it can mix _ and -.
position	Serialize every entity position fields.
realm	Serialize Realm access-control entity fields.
setting	Serialize entities in a Setting context.
setting_group	Serialize entities in a SettingGroup context.
tag	Serialize Tag.
tag_base	Serialize Tags with minimum information.
tag_children	Serialize Tags with their children, do not use with tag_parent group.
tag_color	Serialize Tags with their color field.
tag_documents	Serialize Tags with their documents.
tag_parent	Serialize Tags with their parent.
timestamps	Serialize every date-timed entity createdAt and updatedAt fields.
translated_tag	Serialize Tag with its translations collection.
translation	Serialize entities in a Translation context.
translation_base	Serialize Translation information required for displaying them.
url_alias	Serialize UrlAlias entity fields.
urls	Serialize the url fields of every entity.
user	Serialize entities in a User context.
user_chroot	Serialize User chroot node restriction.
user_group	Serialize User entity with its groups.
user_identifier	Serialize User entity with its identifier (may be a personal information).
user_personal	Serialize User entity with its personal information.
user_public	Serialize public-facing User fields from AbstractHuman.
user_role	Serialize User entity with its roles.
user_security	Serialize User security and authentication fields.
walker	Serializes a treeWalker children.
walker_metadata	Serializes a treeWalker metadata.
web_response	Serialize the top-level WebResponse API envelope fields.