SharePoint .NET Server, CSOM, JSOM et index d’API REST
Importante
Le modèle SharePoint Add-In dans SharePoint Online a été mis hors service le 27 novembre 2023, consultez l’annonce de mise hors service complète pour en savoir plus.
La mise hors service signifie que la fonctionnalité ne recevra aucun nouvel investissement, mais qu’elle est toujours prise en charge. La fin de vie signifie que la fonctionnalité sera abandonnée et qu’elle n’est plus disponible.
L’index des API permet de rechercher de nombreux types et objets fréquemment utilisés implémentés dans le modèle objet serveur .NET, et au moins un modèle de programmation client : CSOM (Client-side Server Object Model) .NET, JSOM (JavaScript Object Model) et/ou REST.
Ce tableau répertorie les API principales les plus fréquemment utilisées, qui sont dans la plupart des cas basées sur les types de l’implémentation du serveur .NET. Dans certains cas, les types sont originaires de la programmation du client SharePoint et il n'existe pas de type de serveur .NET équivalent. Dans d'autres cas, certaines implémentations de modèle de programmation client d'un type spécifique sont disponibles.
Remarque
Avant d’utiliser un URI de point de terminaison REST indiqué dans le tableau, remplacez l’abréviation … par le chemin de votre site SharePoint, par exemple http://<site collection>/<site>/_api/web/lists.
Index des API SharePoint
| API | SP.Object/Enumeration (sp.js) | Point de terminaison REST |
|---|---|---|
| AttachmentCollectionSPAttachmentCollection | SP.AttachmentCollection | …/_api/web/lists('<list id>')/items(<item id>)/attachmentfiles |
| BasePermissionsSPBasePermissions | Objet SP.BasePermissions | S/O |
| CalendarTypeSPCalendarType | Énumération SP.CalendarType | S/O |
| ChangeCollectionSPChangeCollection | Objet SP.ChangeCollection | …/_api/web/getchanges(changequery) |
| ChangeSiteSPChangeSite | Énumération SP.ChangeSite | S/O |
| ClientContext | Objet SP.ClientContext | …/_api/contextinfo |
| ContentTypeSPContentType | Objet SP.ContentType | …/_api/web/contenttypes('<content type id>') |
| ContentTypeCollectionSPContentTypeCollection | Objet SP.ContentTypeCollection | …/_api/web/contenttypes |
| SPContext | Objet SP.RequestContext | S/O |
| EventReceiverDefinitionSPEventReceiverDefinition | Objet SP.EventReceiverDefinition | …/_api/web/eventreceivers |
| EventReceiverDefinitionCollectionSPEventReceiverDefinitionCollection | Objet SP.EventReceiverDefinitionCollection | …/_api/web/eventreceivers(eventreceiverid) |
| EventReceiverDefinitionCreationInformationSPEventReceiverDefinitionCreationInformation | Objet SP.EventReceiverDefinitionCreationInformation | S/O |
| EventReceiverTypeSPEventReceiverType | Énumération SP.EventReceiverType | S/O |
| SpFeaturede fonctionnalité | Objet SP.Feature | …/_api/web/features(featureid) |
| FeatureCollectionSPFeatureCollection | Objet SP.FeatureCollection | …/_api/web/features |
| FeatureDefinitionScopeSPFeatureDefinitionScope | Énumération SP.FeatureDefinitionScope | S/O |
| ChampSPField | Objet SP.Field | .../_api/web/fields('<id de> champ') |
| FieldCalculatedSPFieldCalculated | Objet SP.FieldCalculated | .../_api/web/fields('<id de> champ') |
| FieldChoiceSPFieldChoice | Objet SP.FieldChoice | .../_api/web/fields('<id de> champ') |
| FieldCollectionSPFieldCollection | Objet SP.FieldCollection | …/_api/web/fields |
| FieldComputedSPFieldComputed | Objet SP.FieldComputed | .../_api/web/fields('<id de> champ') |
| FieldCurrencySPFieldCurrency | Objet SP.FieldCurrency | .../_api/web/fields('<id de> champ') |
| FieldLinkSPFieldLink | Objet SP.FieldLink | …/_api/web/contenttypes('<content type id>')/fieldlinks('<field link id>') |
| FieldLookupValueSPFieldLookupValue | Objet SP.FieldLookup | S/O |
| FieldMultiChoiceSPFieldMultiChoice | Objet SP.FieldMultiChoice | .../_api/web/fields('<id de> champ') |
| FieldMultiLineTextSPFieldMultiLineText | Objet SP.FieldMultiLineText | .../_api/web/fields('<id de> champ') |
| FieldNumberSPFieldNumber | Objet SP.FieldNumber | .../_api/web/fields('<id de> champ') |
| FieldTextSPFieldText | Objet SP.FieldText | .../_api/web/fields('<id de> champ') |
| FieldUrlSPFieldUrl | Objet SP.FieldUrl | .../_api/web/fields('<id de> champ') |
| FieldUrlValueSPFieldUrlValue | Objet SP.FieldUrlValue | S/O |
| FieldUserSPFieldUser | Objet SP.FieldUser | .../_api/web/fields('<id de> champ') |
| FichierSPFile | Objet SP.File | .../_api/web/getfilebyserverrelativeurl('<folder name>/<file name>') |
| FileCollectionSPFileCollection | Objet SP.FieldCollection | .../_api/web/getfolderbyserverrelativeurl('/<folder name>')/files |
| DossierSPFolder | Objet SP.Folder | .../_api/web/getfolderbyserverrelativeurl('/<folder name>') |
| FormulaireSPForm | Objet SP.Form | …/_api/web/lists(guid'<list id>')/forms('<form id>') |
| GrouperSPGroup | Objet SP.Group | .../_api/web/sitegroups(<id de> groupe) |
| GroupCollectionSPGroupCollection | Objet SP.GroupCollection | …/_api/web/sitegroups |
| LangageSPLanguage | Objet SP.Language | S/O |
| ListerSPList | Objet SP.List | .../_api/web/lists(guid’list< id>') |
| ListCollectionSPListCollection | Objet SP.ListCollection | …/_api/web/lists |
| ListDataSourceSPListDataSource | Objet SP.ListDataSource | S/O |
| ListItemSPListItem | Objet SP.ListItem | .../_api/web/lists(guid’id<> de liste')/items(<id d’élément>) |
| ListItemCollectionSPListItemCollection | Objet SP.ListItemCollection | .../_api/web/lists(guid’id<> de liste')/items |
| ListTemplateTypeSPListTemplateType | Énumération SP.ListTemplateType | S/O |
| NavigationSPNavigation | Objet SP.Navigation | …/_api/web/navigation |
| NavigationNodeSPNavigationNode | Objet SP.NavigationNode | S/O |
| SPPrincipalprincipal | Objet SP.Principal | S/O |
| SPQuery | S/O | |
| RecycleBinItemSPRecycleBinItem | Objet SP.RecycleBinItem | …/_api/web/RecycleBin(recyclebinitemid) |
| RecycleBinItemCollectionSPRecycleBinItemCollection | Objet SP.RecycleBinItemCollection | …/_api/web/RecycleBin |
| RegionalSettingsSP RegionalSettings | Objet SP.RegionalSettings | …/_api/web/RegionalSettings |
| RoleAssignmentSPRoleAssignment | Objet SP.RoleAssignment | .../_api/web/roleassignments(<id de> principal) |
| RoleAssignmentCollectionSPRoleAssignmentCollection | Objet SP.RoleAssignmentCollection | …/_api/web/roleassignments |
| RoleDefinitionSPRoleDefinition | Objet SP.RoleDefinition | .../_api/web/roledefinitions(<id> de définition de rôle) |
| RoleTypeSPRoleType | Énumération SP.RoleType | S/O |
| SecurableObjectSPSecurableObject | Objet SP.SecurableObject | S/O |
| SiteSPSite | Objet SP.Site | …/_api/site |
| TimeZoneSPTimeZone | Objet SP.TimeZone | …/_api/web/RegionalSettings/TimeZones(timzoneid) |
| TaxonomieSPTaxonomySession | Objet SP.Taxonomy.TaxonomySession | N/A |
| TimeZoneCollectionSPTimeZoneCollection | Objet SP.TimeZoneCollection | …/_api/web/RegionalSettings/TimeZones |
| UtilisateurSPUser | Objet SP.User | …/_api/web/siteusers(@v)?@v='<login name>' |
| UserCollectionSPUserCollection | Objet SP.UserCollection | .../_api/web/sitegroups(<id de> groupe)/users |
| UtilitaireSPUtility | Objet SP.Utilities.Utility (sp.js) | S/O |
| Afficher SPView | Objet SP.View (sp.js) | .../_api/web/lists(guid’list< id>')/views('<view id>') |
| ViewCollectionSPViewCollection | Objet SP.ViewCollection | .../_api/web/lists(guid’list< id>')/views |
| ViewFieldCollectionSPViewFieldCollection | Objet SP.ViewFieldCollection | .../_api/web/lists(guid’list< id>')/views('<view id>')/fields |
| WebSPWeb | Objet SP.Web | …/_api/web |
| WebCollectionSPWebCollection | Objet SP.WebCollection | …/_api/web/webs |
| WebInformationSPWebInfo | Objet SP.WebInformation | …/_api/web/webinfos('<web information id>') |
| WebTemplateSPWebTemplate | Objet SP.WebTemplate | …/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage)/getbyname(templatename) |
| WebTemplateCollectionSPWebTemplateCollection | Objet SP.WebTemplateCollection | …/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage) |