Définition de l'objet
Objet personnalisé
CustomEntityDefinition
Les propriétés d'une fiche « Objet personnalisé », ses énumérations et ses liaisons avec les autres fiches.
Une fiche « Objet personnalisé », telle que l'API la lit et l'écrit (CustomEntityDefinition dans la référence). Sa liste et sa création : https://staging-api.docage.com/CustomEntityDefinitions ; une fiche : https://staging-api.docage.com/CustomEntityDefinitions/{id}. Les propriétés communes à toutes les fiches sont sur la page des définitions des objets.
Ses propriétés
CardFieldsliste deFieldLe dessin de la vignette de kanban : même structure, même concepteur et même grille que Fields — le rang, la colonne et la largeur de chaque champ (
RowIndex,ColumnIndex,ColumnWidth) —, sur un canevas plus étroit. Fields dessine la fiche, ListColumns la liste, CardFields la vignette. Utilisé seulement quand DefinitionType vautPipelineItem; vide sinon. Une vignette est en lecture seule et tient sans défilement.Codetexte, 64 caractères au plusCode
CompositionEnabledoui ou nonComposition autorisée
DefaultSubFormIdidentifiantIdentifiant du sous-formulaire de création par défaut
DefinitionTypeDefinitionType« Décrivez-vous une fiche, ou un processus ? » — la question posée à la création du type. DefinitionType.CustomObject : une chose qui persiste (Véhicule, Bien immobilier). DefinitionType.PipelineItem : un processus qui commence, avance et se termine (Ticket, Deal, Candidature) — et le type doit alors porter au moins un Pipeline. Elle pilote tout ce que l'utilisateur perçoit : la place dans le menu, la vue par défaut (kanban plutôt que liste), les réglages visibles dans la configuration, les champs système offerts dans la palette du concepteur, l'affichage du bandeau d'état sur la fiche. Elle ne se change plus une fois des enregistrements créés : la modification est refusée, et il faut créer un type neuf.
Fieldsliste deFieldLa vue de détail, au format exact du concepteur des champs personnalisés — c'est ce qui permet de réutiliser l'éditeur existant au lieu d'en écrire un.
Icontexte, 128 caractères au plusIcône
IsBookableoui ou nonRéservable
IsFeminineoui ou nonGenre du nom
IsSystemoui ou nonÉcrite par le serveurEst système
IsTemplateEnabledoui ou nonGère des modèles
ListColumnsliste de textesColonnes de la vue liste
Nametexte, 255 caractères au plusObligatoireNom
PluralNametexte, 255 caractères au plusNom au pluriel
RelationDefinitionsliste deRelationDefinitionLes relations déclarées vers les entités existantes ou vers d'autres objets personnalisés.
TitleFieldNametexte, 64 caractères au plusChamp portant le nom
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
DefinitionType
- 0Fiche
- 1Processus
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).