Индекс REST API, SharePoint .NET Server, CSOM, JSOM
Важно!
Модель sharePoint Add-In в SharePoint Online устарела с 27 ноября 2023 г. Ознакомьтесь с полным объявлением о выходе из эксплуатации , чтобы узнать больше.
Устаревание означает, что функция не будет получать новые инвестиции, но она по-прежнему поддерживается. Модель надстроек SharePoint полностью прекращена 2 апреля 2026 г. и больше не будет доступна после этого времени. Основной технологией замены для модели надстроек SharePoint является SharePoint Framework (SPFx), которая будет поддерживаться и в будущем.
Используйте индекс API для поиска многих из наиболее часто используемых типов и объектов, реализуемых в серверной объектной модели .NET и по крайней мере одной клиентской модели программирования (клиентская объектная модель .NET, или CSOM, объектная модель JavaScript, или JSOM, и REST).
В этой таблице перечислены наиболее часто используемые основные API, которые в большинстве случаев базируются на типах реализации сервера .NET. В некоторых случаях типы предназначены для клиентского программирования SharePoint, а эквивалентный тип сервера .NET отсутствует. В других случаях некоторые, но не все возможные, реализации модели клиентского программирования для определенного типа существуют.
Примечание.
Перед использованием URI конечной точки REST, указанного в таблице, замените сокращение … на путь к сайту SharePoint (например, http://<site collection>/<site>/_api/web/lists).
Индекс API SharePoint
| 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('<имя> папки/<имя> файла') |
| FileCollectionSPFileCollection | Объект SP.FieldCollection | .../_api/web/getfolderbyserverrelativeurl('/<имя> папки')/files |
| ПапкаSPFolder | Объект SP.Folder | .../_api/web/getfolderbyserverrelativeurl('/<имя> папки') |
| ФормаSPForm | Объект SP.Form | …/_api/web/lists(guid'<list id>')/forms('<form id>') |
| ГруппаSPGroup | Объект SP.Group | .../_api/web/sitegroups(<идентификатор> группы) |
| 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(<item 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(<идентификатор> субъекта) |
| RoleAssignmentCollectionSPRoleAssignmentCollection | Объект SP.RoleAssignmentCollection | …/_api/web/roleassignments |
| RoleDefinitionSPRoleDefinition | Объект SP.RoleDefinition | .../_api/web/roledefinitions(<идентификатор> определения роли) |
| RoleTypeSPRoleType | Перечисление SP.RoleType | Н/Д |
| SecurableObjectSPSecurableObject | Объект SP.SecurableObject | Н/Д |
| СайтSPSite | Объект SP.Site | …/_api/site |
| TimeZoneSPTimeZone | Объект SP.TimeZone | …/_api/web/RegionalSettings/TimeZones(timzoneid) |
| ТаксономияSPTaxonomySession | Объект SP.Taxonomy.TaxonomySession | Н/Д |
| TimeZoneCollectionSPTimeZoneCollection | Объект SP.TimeZoneCollection | …/_api/web/RegionalSettings/TimeZones |
| UserSPUser | Объект SP.User | …/_api/web/siteusers(@v)?@v='<login name>' |
| UserCollectionSPUserCollection | Объект SP.UserCollection | .../_api/web/sitegroups(<идентификатор> группы)/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 |
| Веб-приложениеSPWeb | Объект 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) |