SharePoint .NET 服务器、CSOM、JSOM 和 REST API 索引

重要

自 2023 年 11 月 27 日起,SharePoint Online 中的 SharePoint Add-In 模型已弃用,请查看 完整的停用公告 以了解详细信息。

弃用意味着该功能不会获得任何新投资,但仍受支持。 SharePoint 外接程序模型在 2026 年 4 月 2 日完全停用,此后不再可用。 SharePoint 外接程序模型的主要替换技术是 SharePoint 框架 (SPFx) ,将来也将继续支持它。

使用 API 索引,可查找在 .NET 服务器对象模型中以及在至少一个客户端编程模型(.NET 客户端对象模型 (CSOM)、JavaScript 对象模型 (JSOM) 和/或 REST)中实现的最常用的类型和对象。

此表列出最常用的核心 API,这些 API 在大多数情况下都基于 .NET 服务器实现的类型。 在某些情况下,类型对于 SharePoint 客户端编程而言是原生的,并且没有等效的 .NET 服务器类型。 在其他情况下,存在某些(但并非所有)特定类型的可能的客户端编程模型实现。

注意

使用表中所示的 REST 终结点 URI 之前,请将 缩写替换为 SharePoint 网站的路径;例如 http://<site collection>/<site>/_api/web/lists

SharePoint API 索引

API SP.Object/Enumeration (sp.js) REST 终结点
AttachmentCollectionSPAttachmentCollection SP.AttachmentCollection …/_api/web/lists('<list id>')/items(<item id>)/attachmentfiles
BasePermissionsSPBasePermissions SP.BasePermissions 对象 ..._api/web/getusereffectivepermissions(@user)?@user='<user login name>'
CalendarTypeSPCalendarType SP.CalendarType 枚举 不适用
ChangeCollectionSPChangeCollection SP.ChangeCollection 对象 …/_api/web/getchanges(changequery)
ChangeSiteSPChangeSite SP.ChangeSite 枚举 不适用
ClientContext SP.ClientContext 对象 …/_api/contextinfo
ContentTypeSPContentType SP.ContentType 对象 …/_api/web/contenttypes('<content type id>')
ContentTypeCollectionSPContentTypeCollection SP.ContentTypeCollection 对象 …/_api/web/contenttypes
SPContext SP.RequestContext 对象 不适用
EventReceiverDefinitionSPEventReceiverDefinition SP.EventReceiverDefinition 对象 …/_api/web/eventreceivers
EventReceiverDefinitionCollectionSPEventReceiverDefinitionCollection SP.EventReceiverDefinitionCollection 对象 …/_api/web/eventreceivers(eventreceiverid)
EventReceiverDefinitionCreationInformationSPEventReceiverDefinitionCreationInformation SP.EventReceiverDefinitionCreationInformation 对象 不适用
EventReceiverTypeSPEventReceiverType SP.EventReceiverType 枚举 不适用
功能SPFeature SP.Feature 对象 …/_api/web/features(featureid)
FeatureCollectionSPFeatureCollection SP.FeatureCollection 对象 …/_api/web/features
FeatureDefinitionScopeSPFeatureDefinitionScope SP.FeatureDefinitionScope 枚举 不适用
字段SPField SP.Field 对象 .../_api/web/fields ('field< id>')
FieldCalculatedSPFieldCalculated SP.FieldCalculated 对象 .../_api/web/fields ('field< id>')
FieldChoiceSPFieldChoice SP.FieldChoice 对象 .../_api/web/fields ('field< id>')
FieldCollectionSPFieldCollection SP.FieldCollection 对象 …/_api/web/fields
FieldComputedSPFieldComputed SP.FieldComputed 对象 .../_api/web/fields ('field< id>')
FieldCurrencySPFieldCurrency SP.FieldCurrency 对象 .../_api/web/fields ('field< id>')
FieldLinkSPFieldLink SP.FieldLink 对象 …/_api/web/contenttypes('<content type id>')/fieldlinks('<field link id>')
FieldLookupValueSPFieldLookupValue SP.FieldLookup 对象 .../_api/web/fields ('field< id>')
FieldMultiChoiceSPFieldMultiChoice SP.FieldMultiChoice 对象 .../_api/web/fields ('field< id>')
FieldMultiLineTextSPFieldMultiLineText SP.FieldMultiLineText 对象 .../_api/web/fields ('field< id>')
FieldNumberSPFieldNumber SP.FieldNumber 对象 .../_api/web/fields ('field< id>')
FieldTextSPFieldText SP.FieldText 对象 .../_api/web/fields ('field< id>')
FieldUrlSPFieldUrl SP.FieldUrl 对象 .../_api/web/fields ('field< id>')
FieldUrlValueSPFieldUrlValue SP.FieldUrlValue 对象 .../_api/web/fields ('field< id>')
FieldUserSPFieldUser SP.FieldUser 对象 .../_api/web/fields ('field< id>')
文件SPFile SP.File 对象 .../_api/web/getfilebyserverrelativeurl ('folder< name>/<file name>')
FileCollectionSPFileCollection SP.FieldCollection 对象 .../_api/web/getfolderbyserverrelativeurl ('/<folder name>') /files
文件夹SPFolder SP.Folder 对象 .../_api/web/getfolderbyserverrelativeurl ('/<folder name>')
表单SPForm SP.Form 对象 …/_api/web/lists(guid'<list id>')/forms('<form id>')
SPGroup SP.Group 对象 .../_api/web/sitegroups (<组 ID>)
GroupCollectionSPGroupCollection SP.GroupCollection 对象 …/_api/web/sitegroups
语言SPLanguage SP.Language 对象 不适用
列出SPList SP.List 对象 .../_api/web/lists (guid'list< id>')
ListCollectionSPListCollection SP.ListCollection 对象 …/_api/web/lists
ListDataSourceSPListDataSource SP.ListDataSource 对象 不适用
ListItemSPListItem SP.ListItem 对象 .../_api/web/lists (guid'list< id>') /items (<项 ID>)
ListItemCollectionSPListItemCollection SP.ListItemCollection 对象 .../_api/web/lists (guid'list< id>') /items
ListTemplateTypeSPListTemplateType SP.ListTemplateType 枚举 .../_api/web/lists (guid'list< id>') /BaseTemplate
导航SPNavigation SP.Navigation 对象 …/_api/web/navigation
NavigationNodeSPNavigationNode SP.NavigationNode 对象 不适用
主体SPPrincipal SP.Principal 对象 不适用
SPQuery 不适用
RecycleBinItemSPRecycleBinItem SP.RecycleBinItem 对象 …/_api/web/RecycleBin(recyclebinitemid)
RecycleBinItemCollectionSPRecycleBinItemCollection SP.RecycleBinItemCollection 对象 …/_api/web/RecycleBin
RegionalSettingsSPRegionalSettings SP.RegionalSettings 对象 …/_api/web/RegionalSettings
RoleAssignmentSPRoleAssignment SP.RoleAssignment 对象 .../_api/web/roleassignments (<主体 ID>)
RoleAssignmentCollectionSPRoleAssignmentCollection SP.RoleAssignmentCollection 对象 …/_api/web/roleassignments
RoleDefinitionSPRoleDefinition SP.RoleDefinition 对象 .../_api/web/roledefinitions (<角色定义 ID>)
RoleTypeSPRoleType SP.RoleType 枚举 不适用
SecureableObjectSPSecurableObject SP.SecurableObject 对象 不适用
站点SPSite SP.Site 对象 …/_api/site
TimeZoneSPTimeZone SP.TimeZone 对象 …/_api/web/RegionalSettings/TimeZones(timzoneid)
分类SPTaxonomySession SP.Taxonomy.TaxonomySession 对象 NA
TimeZoneCollectionSPTimeZoneCollection SP.TimeZoneCollection 对象 …/_api/web/RegionalSettings/TimeZones
用户SPUser SP.User 对象 …/_api/web/siteusers(@v)?@v='<login name>'
UserCollectionSPUserCollection SP.UserCollection 对象 .../_api/web/sitegroups (<组 ID>) /users
实用工具SPUtility SP.Utilities.Utility 对象 (sp.js) 不适用
UsageInfoSPUsageInfo SP。UsageInfo.storage 属性 (sp.js) …/_api/site/usage
查看SPView SP.View 对象 (sp.js) .../_api/web/lists (guid'list< id>') /views ('view< id>')
ViewCollectionSPViewCollection SP.ViewCollection 对象 .../_api/web/lists (guid'list< id>') /views
ViewFieldCollectionSPViewFieldCollection SP.ViewFieldCollection 对象 .../_api/web/lists (guid'list< id>') /views ('view< id>') /fields
WebSPWeb SP.Web 对象 …/_api/web
WebCollectionSPWebCollection SP.WebCollection 对象 …/_api/web/webs
WebInformationSPWebInfo SP.WebInformation 对象 …/_api/web/webinfos('<web information id>')
WebTemplateSPWebTemplate SP.WebTemplate 对象 …/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage)/getbyname(templatename)
WebTemplateCollectionSPWebTemplateCollection SP.WebTemplateCollection 对象 …/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage)

另请参阅