Índice de las API de .NET Server, CSOM, JSOM y REST de SharePoint
Importante
El modelo de Add-In de SharePoint en SharePoint Online ha quedado en desuso a partir del 27 de noviembre de 2023, desproteger el anuncio de retirada completa para obtener más información.
El desuso significa que la característica no obtendrá inversiones nuevas, pero todavía se admite. El modelo de complemento de SharePoint se retira por completo el 2 de abril de 2026 y ya no está disponible después de ese tiempo. La tecnología de reemplazo principal para el modelo de complemento de SharePoint es SharePoint Framework (SPFx), que sigue siendo compatible también en el futuro.
Use el índice de la API para buscar muchos de los tipos y objetos que se usan con mayor frecuencia y que están implementados en el modelo de objetos del servidor .NET y al menos un modelo de programación de cliente: modelo de objeto de cliente (CSOM) de .NET, modelo de objeto de JavaScript (JSOM) y/o REST.
En esta tabla se enumeran las API principales más usadas, que en la mayoría de los casos se basan en tipos de la implementación del servidor .NET. En algunos casos, los tipos son nativos de la programación de cliente de SharePoint, y no hay ningún tipo de servidor .NET equivalente. En otros casos, existen algunas pero no todas las posibles implementaciones del modelo de programación de clientes de un tipo específico.
Nota:
Antes de usar un URI del punto de conexión de REST mostrado en la tabla, cambie la abreviatura … por la ruta de acceso al sitio de SharePoint; por ejemplo, http://<site collection>/<site>/_api/web/lists.
Índice de la API de SharePoint
| API | SP.Object/Enumeration (sp.js) | Punto de conexión de REST |
|---|---|---|
| AttachmentCollectionSPAttachmentCollection | SP.AttachmentCollection | …/_api/web/lists('<list id>')/items(<item id>)/attachmentfiles |
| BasePermissionsSPBasePermissions | Objeto SP.BasePermissions | ..._api/web/getusereffectivepermissions(@user)?@user='<user login name>' |
| CalendarTypeSPCalendarType | Enumeración SP.CalendarType | N/D |
| ChangeCollectionSPChangeCollection | Objeto SP.ChangeCollection | …/_api/web/getchanges(changequery) |
| ChangeSiteSPChangeSite | Enumeración SP.ChangeSite | N/D |
| ClientContext | Objeto SP.ClientContext | …/_api/contextinfo |
| ContentTypeSPContentType | Objeto SP.ContentType | …/_api/web/contenttypes('<content type id>') |
| ContentTypeCollectionSPContentTypeCollection | Objeto SP.ContentTypeCollection | …/_api/web/contenttypes |
| SPContext | Objeto SP.RequestContext | N/D |
| EventReceiverDefinitionSPEventReceiverDefinition | Objeto SP.EventReceiverDefinition | …/_api/web/eventreceivers |
| EventReceiverDefinitionCollectionSPEventReceiverDefinitionCollection | Objeto SP.EventReceiverDefinitionCollection | …/_api/web/eventreceivers(eventreceiverid) |
| EventReceiverDefinitionCreationInformationSPEventReceiverDefinitionCreationInformation | Objeto SP.EventReceiverDefinitionCreationInformation | N/D |
| EventReceiverTypeSPEventReceiverType | Enumeración SP.EventReceiverType | N/D |
| CaracterísticaSPFeature | Objeto SP.Feature | …/_api/web/features(featureid) |
| FeatureCollectionSPFeatureCollection | Objeto SP.FeatureCollection | …/_api/web/features |
| FeatureDefinitionScopeSPFeatureDefinitionScope | Enumeración SP.FeatureDefinitionScope | N/D |
| CampoSPField | Objeto SP.Field | .../_api/web/fields('<field id>') |
| FieldCalculatedSPFieldCalculated | Objeto SP.FieldCalculated | .../_api/web/fields('<field id>') |
| FieldChoiceSPFieldChoice | Objeto SP.FieldChoice | .../_api/web/fields('<field id>') |
| FieldCollectionSPFieldCollection | Objeto SP.FieldCollection | …/_api/web/fields |
| FieldComputedSPFieldComputed | Objeto SP.FieldComputed | .../_api/web/fields('<field id>') |
| SPFieldCurrencyde fieldcurrency | Objeto SP.FieldCurrency | .../_api/web/fields('<field id>') |
| FieldLinkSPFieldLink | Objeto SP.FieldLink | …/_api/web/contenttypes('<content type id>')/fieldlinks('<field link id>') |
| FieldLookupValueSPFieldLookupValue | Objeto SP.FieldLookup | .../_api/web/fields('<field id>') |
| FieldMultiChoiceSPFieldMultiChoice | Objeto SP.FieldMultiChoice | .../_api/web/fields('<field id>') |
| FieldMultiLineTextSPFieldMultiLineText | Objeto SP.FieldMultiLineText | .../_api/web/fields('<field id>') |
| FieldNumberSPFieldNumber | Objeto SP.FieldNumber | .../_api/web/fields('<field id>') |
| FieldTextSPFieldText | Objeto SP.FieldText | .../_api/web/fields('<field id>') |
| FieldUrlSPFieldUrl | Objeto SP.FieldUrl | .../_api/web/fields('<field id>') |
| FieldUrlValueSPFieldUrlValue | Objeto SP.FieldUrlValue | .../_api/web/fields('<field id>') |
| FieldUserSPFieldUser | Objeto SP.FieldUser | .../_api/web/fields('<field id>') |
| ArchivoSPFile | Objeto SP.File | .../_api/web/getfilebyserverrelativeurl('<nombre> de carpeta/<nombre de> archivo') |
| FileCollectionSPFileCollection | Objeto SP.FieldCollection | .../_api/web/getfolderbyserverrelativeurl('/<nombre> de carpeta')/files |
| CarpetaSPFolder | Objeto SP.Folder | .../_api/web/getfolderbyserverrelativeurl('/<nombre> de carpeta') |
| FormularioSPForm | Objeto SP.Form | …/_api/web/lists(guid'<list id>')/forms('<form id>') |
| GrupoSPGroup | Objeto SP.Group | .../_api/web/sitegroups(<id>. de grupo) |
| GroupCollectionSPGroupCollection | Objeto SP.GroupCollection | …/_api/web/sitegroups |
| SPLanguage de idioma | Objeto SP.Language | N/D |
| Listade SPList | Objeto SP.List | .../_api/web/lists(guid'list< id>') |
| ListCollectionSPListCollection | Objeto SP.ListCollection | …/_api/web/lists |
| ListDataSourceSPListDataSource | Objeto SP.ListDataSource | N/D |
| ListItemSPListItem | Objeto SP.ListItem | .../_api/web/lists(guid'list< id>')/items(<item id>) |
| ListItemCollectionSPListItemCollection | Objeto SP.ListItemCollection | .../_api/web/lists(guid'list< id>')/items |
| ListTemplateTypeSPListTemplateType | Enumeración SP.ListTemplateType | .../_api/web/lists(guid'list< id>')/BaseTemplate |
| SPNavigation denavegación | Objeto SP.Navigation | …/_api/web/navigation |
| NavigationNodeSPNavigationNode | Objeto SP.NavigationNode | N/D |
| SPPrincipal principal | Objeto SP.Principal | N/D |
| SPQuery | N/D | |
| RecycleBinItemSPRecycleBinItem | Objeto SP.RecycleBinItem | …/_api/web/RecycleBin(recyclebinitemid) |
| RecycleBinItemCollectionSPRecycleBinItemCollection | Objeto SP.RecycleBinItemCollection | …/_api/web/RecycleBin |
| RegionalSettingsSPRegionalSettings | Objeto SP.RegionalSettings | …/_api/web/RegionalSettings |
| RoleAssignmentSPRoleAssignment | Objeto SP.RoleAssignment | .../_api/web/roleassignments(<id. de entidad de seguridad>) |
| RoleAssignmentCollectionSPRoleAssignmentCollection | Objeto SP.RoleAssignmentCollection | …/_api/web/roleassignments |
| RoleDefinitionSPRoleDefinition | Objeto SP.RoleDefinition | .../_api/web/roledefinitions(<id>. de definición de rol) |
| RoleTypeSPRoleType | Enumeración SP.RoleType | N/D |
| SecurableObjectSPSecurableObject | Objeto SP.SecurableObject | N/D |
| SitioSPSite | Objeto SP.Site | …/_api/site |
| TimeZoneSPTimeZone | Objeto SP.TimeZone | …/_api/web/RegionalSettings/TimeZones(timzoneid) |
| TaxonomíaSPTaxonomySession | Objeto SP.Taxonomy.TaxonomySession | NA |
| TimeZoneCollectionSPTimeZoneCollection | Objeto SP.TimeZoneCollection | …/_api/web/RegionalSettings/TimeZones |
| UsuarioSPUser | Objeto SP.User | …/_api/web/siteusers(@v)?@v='<login name>' |
| UserCollectionSPUserCollection | Objeto SP.UserCollection | .../_api/web/sitegroups(<id.> de grupo)/users |
| UtilidadSPUtility | Objeto SP.Utilities.Utility (sp.js) | N/D |
| UsageInfoSPUsageInfo | SP. Propiedad UsageInfo.storage (sp.js) | …/_api/site/usage |
| VerSPView | Objeto SP.View (sp.js) | .../_api/web/lists(guid'list< id>')/views('<view id>') |
| ViewCollectionSPViewCollection | Objeto SP.ViewCollection | .../_api/web/lists(guid'list< id>')/views |
| ViewFieldCollectionSPViewFieldCollection | Objeto SP.ViewFieldCollection | .../_api/web/lists(guid'list< id>')/views('<view id>')/fields |
| WEBSPWeb | Objeto SP.Web | …/_api/web |
| WebCollectionSPWebCollection | Objeto SP.WebCollection | …/_api/web/webs |
| WebInformationSPWebInfo | Objeto SP.WebInformation | …/_api/web/webinfos('<web information id>') |
| WebTemplateSPWebTemplate | Objeto SP.WebTemplate | …/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage)/getbyname(templatename) |
| WebTemplateCollectionSPWebTemplateCollection | Objeto SP.WebTemplateCollection | …/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage) |