Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Wichtig
Das SharePoint Add-In-Modell in SharePoint Online ist seit dem 27. November 2023 veraltet. Weitere Informationen finden Sie in der Ankündigung zur vollständigen Einstellung .
Veraltet bedeutet, dass das Feature keine neuen Investitionen erhält, aber weiterhin unterstützt wird. Das SharePoint-Add-In-Modell wird am 2. April 2026 vollständig eingestellt und ist danach nicht mehr verfügbar. Die primäre Ersatztechnologie für das SharePoint-Add-In-Modell ist SharePoint Framework (SPFx), das auch in Zukunft weiterhin unterstützt wird.
Im API-Index können Sie viele der am häufigsten verwendeten Typen und Objekte nachschlagen, die im .NET-Serverobjektmodell und mindestens einem Clientprogrammiermodell implementiert sind: das clientseitige .NET-Objektmodell (CSOM), JavaScript-Objektmodell (JSOM) und/oder REST.
In dieser Tabelle sind die am häufigsten verwendeten Kern-APIs aufgeführt, die in den meisten Fällen auf Typen aus der .NET-Serverimplementierung basieren. In einigen Fällen sind Typen inhärent für die SharePoint-Clientprogrammierung, ohne dass es einen entsprechenden .NET-Servertyp gibt. In anderen Fällen sind einige, aber nicht alle möglichen Implementierungen eines Clientprogrammiermodells eines bestimmten Typs vorhanden.
Hinweis
Bevor Sie, wie in der Tabelle gezeigt, einen REST-Endpunkt-URI verwenden, ersetzen Sie die Abkürzung … durch den Pfad zu Ihrer SharePoint-Website, z. B. http://<site collection>/<site>/_api/web/lists.
SharePoint-API-Index
| API | SP.Object/Enumeration (sp.js) | REST-Endpunkt |
|---|---|---|
| AttachmentCollectionSPAttachmentCollection | SP. AttachmentCollection | …/_api/web/lists('<list id>')/items(<item id>)/attachmentfiles |
| BasePermissionsSPBasePermissions | SP.BasePermissions-Objekt | ..._api/web/getusereffectivepermissions(@user)?@user='<user login name>' |
| CalendarTypeSPCalendarType | SP.CalendarType-Enumeration | Nicht zutreffend |
| ChangeCollectionSPChangeCollection | SP.ChangeCollection-Objekt | …/_api/web/getchanges(changequery) |
| ChangeSiteSPChangeSite | SP.ChangeSite-Enumeration | Nicht zutreffend |
| ClientContext | SP.ClientContext-Objekt | …/_api/contextinfo |
| ContentTypeSPContentType | SP.ContentType-Objekt | …/_api/web/contenttypes('<content type id>') |
| ContentTypeCollectionSPContentTypeCollection | SP.ContentTypeCollection-Objekt | …/_api/web/contenttypes |
| SPContext | SP.RequestContext-Objekt | Nicht zutreffend |
| EventReceiverDefinitionSPEventReceiverDefinition | SP.EventReceiverDefinition-Objekt | …/_api/web/eventreceivers |
| EventReceiverDefinitionCollectionSPEventReceiverDefinitionCollection | SP.EventReceiverDefinitionCollection-Objekt | …/_api/web/eventreceivers(eventreceiverid) |
| EventReceiverDefinitionCreationInformationSPEventReceiverDefinitionCreationInformation | SP.EventReceiverDefinitionCreationInformation-Objekt | Nicht zutreffend |
| EventReceiverTypeSPEventReceiverType | SP.EventReceiverType-Enumeration | Nicht zutreffend |
| FeatureSPFeature | SP.Feature-Objekt | …/_api/web/features(featureid) |
| FeatureCollectionSPFeatureCollection | SP.FeatureCollection-Objekt | …/_api/web/features |
| FeatureDefinitionScopeSPFeatureDefinitionScope | SP.FeatureDefinitionScope-Enumeration | Nicht zutreffend |
| Feld-SPField | SP.Field-Objekt | .../_api/web/fields('<Feld-ID>') |
| FieldCalculatedSPFieldCalculated | SP.FieldCalculated-Objekt | .../_api/web/fields('<Feld-ID>') |
| FieldChoiceSPFieldChoice | SP.FieldChoice-Objekt | .../_api/web/fields('<Feld-ID>') |
| FieldCollectionSPFieldCollection | SP.FieldCollection-Objekt | …/_api/web/fields |
| FieldComputedSPFieldComputed | SP.FieldComputed-Objekt | .../_api/web/fields('<Feld-ID>') |
| FieldCurrencySPFieldCurrency | SP.FieldCurrency-Objekt | .../_api/web/fields('<Feld-ID>') |
| FieldLinkSPFieldLink | SP.FieldLink-Objekt | …/_api/web/contenttypes('<content type id>')/fieldlinks('<field link id>') |
| FieldLookupValueSPFieldLookupValue | SP.FieldLookup-Objekt | .../_api/web/fields('<Feld-ID>') |
| FieldMultiChoiceSPFieldMultiChoice | SP.FieldMultiChoice-Objekt | .../_api/web/fields('<Feld-ID>') |
| FieldMultiLineTextSPFieldMultiLineText | SP.FieldMultiLineText-Objekt | .../_api/web/fields('<Feld-ID>') |
| FieldNumberSPFieldNumber | SP.FieldNumber-Objekt | .../_api/web/fields('<Feld-ID>') |
| FieldTextSPFieldText | SP.FieldText-Objekt | .../_api/web/fields('<Feld-ID>') |
| FieldUrlSPFieldUrl | SP.FieldUrl-Objekt | .../_api/web/fields('<Feld-ID>') |
| FieldUrlValueSPFieldUrlValue | SP.FieldUrlValue-Objekt | .../_api/web/fields('<Feld-ID>') |
| FieldUserSPFieldUser | SP.FieldUser-Objekt | .../_api/web/fields('<Feld-ID>') |
| DateiSPFile | SP.File-Objekt | .../_api/web/getfilebyserverrelativeurl('<Ordnername>/<Dateiname>') |
| FileCollectionSPFileCollection | SP.FieldCollection-Objekt | .../_api/web/getfolderbyserverrelativeurl('/<folder name>')/files |
| Ordner-SPFolder | SP.Folder-Objekt | .../_api/web/getfolderbyserverrelativeurl('/<folder name>') |
| Formular-SPForm | SP.Form-Objekt | …/_api/web/lists(guid'<list id>')/forms('<form id>') |
| Gruppen-SPGroup | SP.Group-Objekt | .../_api/web/sitegroups(<gruppen-ID>) |
| GroupCollectionSPGroupCollection | SP.GroupCollection-Objekt | …/_api/web/sitegroups |
| LanguageSPLanguage | SP.Language-Objekt | Nicht zutreffend |
| SPList auflisten | SP.List-Objekt | .../_api/web/lists(guid'list< id>') |
| ListCollectionSPListCollection | SP.ListCollection-Objekt | …/_api/web/lists |
| ListDataSourceSPListDataSource | SP.ListDataSource-Objekt | Nicht zutreffend |
| ListItemSPListItem | SP.ListItem-Objekt | .../_api/web/lists(guid'list< id>')/items(<element id>) |
| ListItemCollectionSPListItemCollection | SP.ListItemCollection-Objekt | .../_api/web/lists(guid'list< id>')/items |
| ListTemplateTypeSPListTemplateType | SP.ListTemplateType-Enumeration | .../_api/web/lists(guid'list< id>')/BaseTemplate |
| NavigationSPNavigation | SP.Navigation-Objekt | …/_api/web/navigation |
| NavigationNodeSPNavigationNode | SP.NavigationNode-Objekt | Nicht zutreffend |
| Prinzipal-SPPrincipal | SP.Principal-Objekt | Nicht zutreffend |
| SPQuery | Nicht zutreffend | |
| RecycleBinItemSPRecycleBinItem | SP.RecycleBinItem-Objekt | …/_api/web/RecycleBin(recyclebinitemid) |
| RecycleBinItemCollectionSPRecycleBinItemCollection | SP.RecycleBinItemCollection-Objekt | …/_api/web/RecycleBin |
| RegionalSettingsSPRegionalSettings | SP.RegionalSettings-Objekt | …/_api/web/RegionalSettings |
| RoleAssignmentSPRoleAssignment | SP.RoleAssignment-Objekt | .../_api/web/roleassignments(<principal id>) |
| RoleAssignmentCollectionSPRoleAssignmentCollection | SP.RoleAssignmentCollection-Objekt | …/_api/web/roleassignments |
| RoleDefinitionSPRoleDefinition | SP.RoleDefinition-Objekt | .../_api/web/roledefinitions(<Rollendefinitions-ID>) |
| RoleTypeSPRoleType | SP.RoleType-Enumeration | Nicht zutreffend |
| SecurableObjectSPSecurableObject | SP.SecurableObject-Objekt | Nicht zutreffend |
| Website-SPSite | SP.Site-Objekt | …/_api/site |
| TimeZoneSPTimeZone | SP.TimeZone-Objekt | …/_api/web/RegionalSettings/TimeZones(timzoneid) |
| TaxonomieSPTaxonomySession | SP.Taxonomy.TaxonomySession-Objekt | – |
| TimeZoneCollectionSPTimeZoneCollection | SP.TimeZoneCollection-Objekt | …/_api/web/RegionalSettings/TimeZones |
| BenutzerSPUser | SP.User-Objekt | …/_api/web/siteusers(@v)?@v='<login name>' |
| UserCollectionSPUserCollection | SP.UserCollection-Objekt | .../_api/web/sitegroups(<gruppen-ID>)/users |
| HilfsprogrammSPUtility | SP.Utilities.Utility-Objekt (sp.js) | Nicht zutreffend |
| UsageInfoSPUsageInfo | SP. UsageInfo.storage-Eigenschaft (sp.js) | …/_api/site/usage |
| SPView anzeigen | SP.View-Objekt (sp.js) | .../_api/web/lists(guid'list< id>')/views('<view id>') |
| ViewCollectionSPViewCollection | SP.ViewCollection-Objekt | .../_api/web/lists(guid'list< id>')/views |
| ViewFieldCollectionSPViewFieldCollection | SP.ViewFieldCollection-Objekt | .../_api/web/lists(guid'list< id>')/views('<view id>')/fields |
| WebSPWeb | SP.Web-Objekt | …/_api/web |
| WebCollectionSPWebCollection | SP.WebCollection-Objekt | …/_api/web/webs |
| WebInformationSPWebInfo | SP.WebInformation-Objekt | …/_api/web/webinfos('<web information id>') |
| WebTemplateSPWebTemplate | SP.WebTemplate-Objekt | …/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage)/getbyname(templatename) |
| WebTemplateCollectionSPWebTemplateCollection | SP.WebTemplateCollection-Objekt | …/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage) |