Définition de l'objet
Groupe
Group
Les propriétés d'une fiche « Groupe », ses énumérations et ses liaisons avec les autres fiches.
Une fiche « Groupe », telle que l'API la lit et l'écrit (Group dans la référence). Sa liste et sa création : https://staging-api.docage.com/Groups ; une fiche : https://staging-api.docage.com/Groups/{id}. Les propriétés communes à toutes les fiches sont sur la page des définitions des objets.
Ses propriétés
AddToGroupCompanyIdsliste d'identifiantsSociétés à lier au groupe
AddToGroupContactIdsliste d'identifiantsContacts à ajouter au groupe
CompositionGroupCompositionComposition
CountrytextePays
DescriptiontexteDescription
FilterExpressionFilterRequête enregistrée d'un groupe dynamique, sur les propriétés de Contact. Ignorée quand la composition est statique. Un ExpressionFilter, la forme des filtres des listes : un groupe dynamique est donc littéralement « la liste des contacts, filtrée », avec les mêmes droits. Jamais nul : un groupe sans critère porte un filtre vide.
GroupExcludedModulesliste deDocageModuleModules masqués
Instancesliste deGroupInstances de groupe
NametexteObligatoireNom
ParentCompanyIdidentifiantIdentifiant de la société propriétaire
RemoveFromGroupCompanyIdsliste d'identifiantsSociétés à délier du groupe
RemoveFromGroupContactIdsliste d'identifiantsContacts à retirer du groupe
TemplateGroupModèle dont ce groupe est issu — un ciblage réutilisable. Ce qu'un modèle de groupe transmet, et ce qu'il ne transmet pas. Ses critères (Filter), sa Composition, ses modules masqués (GroupExcludedModules) et sa société propriétaire (ParentCompanyId) suivent ; ses contacts choisis un à un et ses sociétés liées ne suivent PAS. Un modèle dit QUI VISER, pas qui est dedans aujourd'hui.
AddToBoxIdsliste d'identifiantsIdentifiants des classeurs à lier à l'entité
ArchiveRetentionYearsentierDurée d'archivage en années
BoxIdsliste d'identifiantsLecture seuleIdentifiants des classeurs liés à l'entité (lecture seule)
CreationDatedate et heure (UTC)Écrite par le serveurDate de création
Créateur
CreationUserIdidentifiantÉcrite par le serveurIdentifiant du créateur
CultureInfotexteCulture
CustomFieldsliste deFieldLes champs personnalisés de la fiche : ceux de son organisation et ceux de son modèle.
CustomFieldsForInstancesliste deFieldChamps personnalisés pour les entités générées par le modèle
CustomFieldsFromOrganizationliste deFieldChamps personnalisés de l'organisation
CustomFieldsFromTemplateliste deFieldChamps personnalisés du modèle
CustomFieldsUserDataliste deFieldUserDataValeurs des champs personnalisés
DeletionDatedate et heure (UTC)Écrite par le serveurDate de suppression
Auteur de la suppression
DeletionUserIdidentifiantÉcrite par le serveurIdentifiant de l'auteur de la suppression
DynamicInclusionDynamicInclusionSi une inclusion dynamique est définie, l'entité sera incluse dans son parent que si la condition est remplie
EntityStateStateLevelLecture seuleEtat de l'entité
ExternalIdtexte, 128 caractères au plusIdentifiant externe
GeneratedByCampaignIdidentifiantÉcrite par le serveurCampagne ayant généré l'entité
GeneratedByFormIdidentifiantIdentifiant du formulaire ayant généré l'entité
IdidentifiantÉcrite par le serveurIdentifiant
IsArchivedoui ou nonArchivé
IsSystemoui ou nonÉcrite par le serveurEst système
IsTemplateoui ou nonLecture seuleEst un modèle
LanguageLanguageLangue
LastModificationDatedate et heure (UTC)Écrite par le serveurDate de modification
Dernier modificateur
LastModificationUserIdidentifiantÉcrite par le serveurIdentifiant du dernier modificateur
MergeEntitiesliste deMergeEntityObjets participant à la fusion
MergeFieldsliste deMergeFieldChamps de fusion
MustBeArchivedoui ou nonDate de début d'archivage
Nametexte, 255 caractères au plusNom
NotestexteNotes
ParentOrganizationIdidentifiantLecture seuleOrganisation parente
ParentRightsDTOliste deRightDTOLes nouveaux droits de la fiche, à sa création ou à sa mise à jour : la liste REMPLACE ses droits, elle doit donc contenir tous les nouveaux droits. Réservé à qui administre la fiche : pouvoir la modifier ne suffit pas.
RelationDefinitionsForInstancesliste deRelationDefinitionLes relations déclarées sur ce modèle : une extrémité est imposée (le modèle lui-même), et la relation ne vaut que pour ses instances — en plus de celles déclarées au niveau de l'organisation dont une extrémité est du même type. Elles se propagent comme CustomFieldsForInstances : une instance les lit dans RelationDefinitionsFromTemplate.
RelationDefinitionsFromTemplateliste deRelationDefinitionLes relations qu'une instance tient de son modèle. Elles ne sont pas recopiées : elles se relisent sur le modèle à chaque lecture. Ajouter une relation sur un modèle la fait donc apparaître sur toutes ses instances existantes, y compris celles créées avant, comme un champ personnalisé (CustomFieldsFromTemplate).
RemoveFromBoxIdsliste d'identifiantsIdentifiants des classeurs à délier de l'entité
TemplateIdidentifiantIdentifiant de Modèle utilisé
Aucune propriété ne correspond.
Ses énumérations
GroupComposition
- 0Statique
- 1Dynamique
DocageModule
- 0Signature
- 1Contacts
- 2Emails
- 3CRM
- 4Assistance
- 5Formulaires
- 6Calendrier
Ses liaisons
Les fiches auxquelles elle se lie, et le rôle de chacune : ce que LinkedToTypeName et LinkedToId retrouvent dans
une liste (voir Lire des listes).