SharePoint .NET Server、CSOM、JSOM、および REST API インデックス
重要
SharePoint Online の SharePoint Add-In モデルは、2023 年 11 月 27 日の時点で非推奨となりました。詳細については、 完全な廃止のお知らせ をご覧ください。
非推奨とは、機能が新しい投資を得られないことを意味しますが、引き続きサポートされています。 SharePoint アドイン モデルは 2026 年 4 月 2 日に完全に廃止され、その後は使用できなくなります。 SharePoint アドイン モデルの主な置き換えテクノロジは SharePoint Framework (SPFx) であり、今後も引き続きサポートされます。
API インデックスを使用すると、.NET サーバー オブジェクト モデルと少なくとも 1 つのクライアント プログラミング モデル (.NET クライアント側オブジェクト モデル (CSOM)、JavaScript オブジェクト モデル (JSOM)、および REST) で実装された使用頻度の高い API の型やオブジェクトを参照できます。
この表は、最も使用頻度が高いコア API を示しています。ほとんどの場合、コア API は .NET サーバー実装の型に基づいています。 ただし、型が SharePoint クライアント プログラミングに固有で、相当する .NET Server の型が存在しない場合もあります。 または、特定の型のクライアント プログラミング モデルの可能な実装が、すべてではなく一部だけ存在する場合もあります。
注:
表に示した 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(<group 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(<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(<principal id>) |
| RoleAssignmentCollectionSPRoleAssignmentCollection | SP.RoleAssignmentCollection オブジェクト | …/_api/web/roleassignments |
| RoleDefinitionSPRoleDefinition | SP.RoleDefinition オブジェクト | .../_api/web/roledefinitions(<role 定義 ID>) |
| 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 |
| ユーザーSPUser | SP.User オブジェクト | …/_api/web/siteusers(@v)?@v='<login name>' |
| UserCollectionSPUserCollection | SP.UserCollection オブジェクト | .../_api/web/sitegroups(<group 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) |