SharePoint .NET Server, CSOM, JSOM e índice da API REST
Importante
O modelo de Add-In do SharePoint no SharePoint Online foi preterido a partir de 27 de novembro de 2023. Veja o anúncio completo da descontinuação para saber mais.
A descontinuação significa que a funcionalidade não obterá novos investimentos, mas continuará a ser suportada. O modelo de suplemento do SharePoint foi totalmente descontinuado a 2 de abril de 2026 e deixará de estar disponível após esse período. A principal tecnologia de substituição do modelo de suplemento do SharePoint é o SharePoint Framework (SPFx), que continua a ser suportado também no futuro.
Use o índice de API para procurar muitos dos tipos e dos objetos mais utilizados que são implementados no modelo de objeto do servidor do .NET e pelo menos um modelo de programação de cliente: modelo de objeto do lado cliente do .NET (CSOM), modelo de objeto do JavaScript (JSOM) e/ou REST.
Esta tabela lista as APIs principais usadas com mais frequência, que estão na maioria dos casos baseadas em tipos da implementação do servidor .NET. Em alguns casos, os tipos são nativos para a programação de cliente do SharePoint e não há nenhum tipo de servidor .NET equivalente. Em outros casos, alguns, mas não todas, possíveis implementações de modelo de programação de cliente de um tipo específico.
Observação
Antes de usar um URI de ponto de extremidade REST mostrado na tabela, substitua a …abreviação com o caminho para o site do SharePoint, por exemplohttp://<site collection>/<site>/_api/web/lists.
Índice de API do SharePoint
| API | SP.Object/Enumeration (sp.js) | Ponto de extremidade 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 | SP.CalendarType enumeration | N/D |
| ChangeCollectionSPChangeCollection | Objeto SP.ChangeCollection | …/_api/web/getchanges(changequery) |
| ChangeSiteSPChangeSite | Enumeração 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 | Enumeração SP.EventReceiverType | N/D |
| FuncionalidadeSPFeature | Objeto SP.Feature | …/_api/web/features(featureid) |
| FeatureCollectionSPFeatureCollection | Objeto SP.FeatureCollection | …/_api/web/features |
| FeatureDefinitionScopeSPFeatureDefinitionScope | Enumeração SP.FeatureDefinitionScope | N/D |
| CampoSPField | Objeto SP.Field | .../_api/web/fields('<id> de campo') |
| FieldCalculatedSPFieldCalculated | Objeto SP.FieldCalculated | .../_api/web/fields('<id> de campo') |
| FieldChoiceSPFieldChoice | Objeto SP.FieldChoice | .../_api/web/fields('<id> de campo') |
| FieldCollectionSPFieldCollection | Objeto SP.FieldCollection | …/_api/web/fields |
| FieldComputedSPFieldComputed | Objeto SP.FieldComputed | .../_api/web/fields('<id> de campo') |
| FieldCurrencySPFieldCurrency | Objeto SP.FieldCurrency | .../_api/web/fields('<id> de campo') |
| FieldLinkSPFieldLink | Objeto SP.FieldLink | …/_api/web/contenttypes('<content type id>')/fieldlinks('<field link id>') |
| FieldLookupValueSPFieldLookupValue | Objeto SP.FieldLookup | .../_api/web/fields('<id> de campo') |
| FieldMultiChoiceSPFieldMultiChoice | Objeto SP.FieldMultiChoice | .../_api/web/fields('<id> de campo') |
| FieldMultiLineTextSPFieldMultiLineText | Objeto SP.FieldMultiLineText | .../_api/web/fields('<id> de campo') |
| FieldNumberSPFieldNumber | Objeto SP.FieldNumber | .../_api/web/fields('<id> de campo') |
| FieldTextSPFieldText | Objeto SP.FieldText | .../_api/web/fields('<id> de campo') |
| FieldUrlSPFieldUrl | Objeto SP.FieldUrl | .../_api/web/fields('<id> de campo') |
| FieldUrlValueSPFieldUrlValue | Objeto SP.FieldUrlValue | .../_api/web/fields('<id> de campo') |
| FieldUserSPFieldUser | Objeto SP.FieldUser | .../_api/web/fields('<id> de campo') |
| FicheiroSPFile | Objeto SP.File | .../_api/web/getfilebyserverrelativeurl('<nome> da pasta/<nome> do ficheiro') |
| FileCollectionSPFileCollection | Objeto SP.FieldCollection | .../_api/web/getfolderbyserverrelativeurl('/<nome> da pasta')/files |
| PastaSPFolder | Objeto SP.Folder | .../_api/web/getfolderbyserverrelativeurl('/<nome> da pasta') |
| FormulárioSPForm | 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 |
| LinguagemSPLanguage | Objeto SP.Language | N/D |
| ListarSPList | 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(<id> do item) |
| ListItemCollectionSPListItemCollection | Objeto SP.ListItemCollection | .../_api/web/lists(guid'list< id>')/items |
| ListTemplateTypeSPListTemplateType | Enumeração SP.ListTemplateType | .../_api/web/lists(guid'list< id>')/BaseTemplate |
| NavegaçãoSPNavigation | Objeto SP.Navigation | …/_api/web/navigation |
| NavigationNodeSPNavigationNode | Objeto SP.NavigationNode | N/D |
| PrincipalSPPrincipal | 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> principal) |
| RoleAssignmentCollectionSPRoleAssignmentCollection | Objeto SP.RoleAssignmentCollection | …/_api/web/roleassignments |
| RoleDefinitionSPRoleDefinition | Objeto SP.RoleDefinition | .../_api/web/roledefinitions(<id> de definição de função) |
| RoleTypeSPRoleType | Enumeração SP.RoleType | N/D |
| SecurableObjectSPSecurableObject | Objeto SP.SecurableObject | N/D |
| SiteSPSite | Objeto SP.Site | …/_api/site |
| TimeZoneSPTimeZone | SP.TimeZone object | …/_api/web/RegionalSettings/TimeZones(timzoneid) |
| TaxonomiaSPTaxonomySession | objeto SP.Taxonomy.TaxonomySession | NA |
| TimeZoneCollectionSPTimeZoneCollection | Objeto SP.TimeZoneCollection | …/_api/web/RegionalSettings/TimeZones |
| SPUser do Utilizador | Objeto SP.User | …/_api/web/siteusers(@v)?@v='<login name>' |
| UserCollectionSPUserCollection | Objeto SP.UserCollection | .../_api/web/sitegroups(<id> de grupo)/utilizadores |
| UtilitySPUtility | Objeto SP.Utilities.Utility (sp.js) | N/D |
| UsageInfoSPUsageInfo | SP. Propriedade 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) |