Type de ressource columnDefinition

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Représente une colonne dans un site, list ou contentType.

Par défaut, les valeurs columnDefinitions et les valeurs de champ pour hidden les colonnes ne sont pas affichées. Pour les afficher lors de l’énumération des ressources columnDefinitions, incluez hidden dans votre instruction $select. Pour les afficher lors de l’affichage des valeurs de champ sur listItems, incluez les colonnes souhaitées par nom dans votre $select instruction.

Méthodes

Méthode	Type de retour	Description
Répertorier les colonnes d’un site	collection columnDefinition	Obtenez la liste des objets columnDefinition et leurs propriétés dans un site.
Lister les colonnes d’une liste	collection columnDefinition	Obtenez la liste des objets columnDefinition et leurs propriétés dans une liste.
Lister les colonnes d’un type de contenu	collection columnDefinition	Obtenez la liste des objets columnDefinition et leurs propriétés dans un type de contenu.
Créer columnDefinition pour un site	columnDefinition	Créez un objet columnDefinition dans un site.
Créer columnDefinition pour une liste	columnDefinition	Créez un objet columnDefinition dans une liste.
Créer columnDefinition pour un type de contenu	columnDefinition	Créez un objet columnDefinition dans un type de contenu.
Obtenir columnDefinition	columnDefinition	Lisez les propriétés et les relations d’un objet columnDefinition .
Mettre à jour columnDefinition	columnDefinition	Mettez à jour les propriétés d’un objet columnDefinition .
Supprimer columnDefinition	Aucune	Supprimer un objet columnDefinition .

Propriétés

Les colonnes peuvent contenir des données de divers types. Les propriétés suivantes indiquent le type de données contenues dans une colonne, ainsi que les paramètres supplémentaires pour ces données. Les propriétés liées au type (booléen, calculé, choice, currency, dateTime, lookup, number, personOrGroup, text) s’excluent mutuellement : une colonne ne peut avoir qu’une seule d’entre elles spécifiée.

Propriété	Type	Description
columnGroup	string	Pour les colonnes de site, nom du groupe auquel cette colonne appartient. Permet d’organiser les colonnes associées.
description	string	Description de la colonne visible par les utilisateurs.
displayName	string	Nom de la colonne visible par les utilisateurs.
enforceUniqueValues	Valeur booléenne	Si truela valeur est , deux éléments de liste peuvent avoir la même valeur pour cette colonne.
hidden	Valeur booléenne	Indique si la colonne est affichée dans l’interface utilisateur.
id	string	Identificateur unique de la colonne.
indexed	Valeur booléenne	Indique si les valeurs de la colonne peuvent être utilisées pour le tri et la recherche.
name	string	Nom de la colonne dans l’API tel qu’il apparaît dans la ressource fields sur un objet listItem. Pour le nom visible par les utilisateurs, reportez-vous à la propriété displayName.
readOnly	Valeur booléenne	Indique si les valeurs de la colonne peuvent être modifiées.
required	Valeur booléenne	Spécifie si la valeur de colonne n’est pas facultative.
boolean	booleanColumn	Cette colonne contient des valeurs booléennes.
calculated	calculatedColumn	Les données de cette colonne sont calculées en fonction des autres colonnes.
choice	choiceColumn	Cette colonne contient des données provenant d’une liste de choix.
currency	currencyColumn	Cette colonne contient des valeurs monétaires.
dateTime	dateTimeColumn	Cette colonne contient des valeurs DateTime.
defaultValue	defaultColumnValue	Valeur par défaut de cette colonne.
Géolocalisation	geolocationColumn	Cette colonne stocke une géolocalisation.
lookup	lookupColumn	Les données de cette colonne sont recherchées dans une autre source dans le site.
number	numberColumn	Cette colonne contient des valeurs numériques.
personOrGroup	personOrGroupColumn	Cette colonne contient des valeurs de personne ou de groupe.
text	textColumn	Cette colonne contient des valeurs textuelles.
isDeletable	Valeur booléenne	Indique si cette colonne peut être supprimée.
propagateChanges	Valeur booléenne	Si truela valeur est , les modifications apportées à cette colonne sont propagées aux listes qui implémentent la colonne.
isReorderable	Valeur booléenne	Indique si les valeurs de la colonne peuvent être réorganisées. En lecture seule.
isSealed	Valeur booléenne	Spécifie si la colonne peut être modifiée.
Validation	columnValidation	Cette colonne stocke la formule de validation et le message pour la colonne.
hyperlinkOrPicture	hyperlinkOrPictureColumn	Cette colonne stocke les valeurs de lien hypertexte ou d’image.
Terme	termColumn	Cette colonne stocke les termes de taxonomie.
sourceContentType	contentTypeInfo	ContentType dont cette colonne est héritée. Utilisé uniquement pour extraire des colonnes contentTypes.
thumbnail	thumbnailColumn	Cette colonne stocke les valeurs de miniatures.
type	columnTypes	Pour les colonnes de site, type de colonne. En lecture seule.
contentApprovalStatus	contentApprovalStatusColumn	Cette colonne stocke les status d’approbation du contenu.

Relations

Relation	Type	Description
sourceColumn	columnDefinition	Colonne source pour la colonne de type de contenu.

Note: Ces propriétés correspondent à l’énumération SPFieldType SharePoint. Notez que les types de champs les plus courants sont représentés dans le tableau précédent. Toutefois, cette API bêta en manque encore. Dans ce cas, aucune des facettes du type de colonne n’est remplie et la colonne aura seulement ses propriétés de base.

Représentation JSON

Voici une représentation JSON de la ressource.

{
  "boolean": {"@odata.type": "microsoft.graph.booleanColumn"},
  "calculated": {"@odata.type": "microsoft.graph.calculatedColumn"},
  "choice": {"@odata.type": "microsoft.graph.choiceColumn"},
  "columnGroup": "String",
  "contentApprovalStatus": {"@odata.type": "microsoft.graph.contentApprovalStatusColumn"},
  "currency": {"@odata.type": "microsoft.graph.currencyColumn"},
  "dateTime": {"@odata.type": "microsoft.graph.dateTimeColumn"},
  "defaultValue": {"@odata.type": "microsoft.graph.defaultColumnValue"},
  "description": "String",
  "displayName": "String",
  "enforceUniqueValues": "Boolean",
  "geolocation": {"@odata.type": "microsoft.graph.geolocationColumn"},
  "hidden": "Boolean",
  "hyperlinkOrPicture": {"@odata.type": "microsoft.graph.hyperlinkOrPictureColumn"},
  "id": "String (identifier)",
  "indexed": "Boolean",
  "isDeletable": "Boolean",
  "isReorderable": "Boolean",
  "isSealed": "Boolean",
  "lookup": {"@odata.type": "microsoft.graph.lookupColumn"},
  "name": "staticNameForApi",
  "number": {"@odata.type": "microsoft.graph.numberColumn"},
  "personOrGroup": {"@odata.type": "microsoft.graph.personOrGroupColumn"},
  "propagateChanges": "Boolean",
  "readOnly": "Boolean",
  "required": "Boolean",
  "sourceContentType": {"@odata.type": "microsoft.graph.contentTypeInfo"},
  "term": {"@odata.type": "microsoft.graph.termColumn"},
  "text": {"@odata.type": "microsoft.graph.textColumn"},
  "thumbnail": {"@odata.type": "microsoft.graph.thumbnailColumn"},
  "type": {"@odata.type": "microsoft.graph.columnTypes"},
  "validation": {"@odata.type": "microsoft.graph.columnValidation"}
}