SharePoint .NET Server, CSOM, JSOM e índice da API RESTSharePoint .NET Server, CSOM, JSOM, and REST API index

Use o índice de API para pesquisar muitos dos tipos e objetos usados com mais frequência que são implementados no modelo de objeto do servidor .NET e pelo menos um modelo de programação de cliente: modelo de objeto do cliente .NET (CSOM), modelo de objeto do JavaScript (JSOM) e/ou REST.Use the API index to look up many of the most frequently used types and objects that are implemented in the .NET server object model and at least one client programming model: .NET client-side object model (CSOM), JavaScript object model (JSOM), and/or REST.

Esta tabela lista as APIs principais usadas com mais frequência, que estão na maioria dos casos com base em tipos da implementação do servidor .NET.This table lists the most frequently used core APIs, which are in most cases based on types from the .NET server implementation. Em alguns casos, os tipos são nativos da programação de cliente do SharePoint e não há nenhum tipo de servidor .NET equivalente.In some cases, types are native to SharePoint client programming, and there is no equivalent .NET server type. Em outros casos, algumas das possíveis implementações de modelo de programação de cliente de um tipo específico existem.In other cases, some but not all possible client programming model implementations of a specific type exist.

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 exemplo http://<site collection>/<site>/_api/web/lists.Before using a REST endpoint URI shown in the table, replace the abbreviation with the path to your SharePoint site; for example http://<site collection>/<site>/_api/web/lists.

Índice da API do SharePointSharePoint API index

APIAPI PS. Objeto/enumeração (SP. js)SP.Object/Enumeration (sp.js) Ponto de extremidade RESTREST Endpoint
AttachmentCollection **** ObjectattachmentcollectionAttachmentCollection SPAttachmentCollection PS. AttachmentCollectionSP.AttachmentCollection …/_api/web/lists('<list id>')/items(<item id>)/attachmentfiles
BasePermissions SPBasePermissionsBasePermissions SPBasePermissions PS. Objeto BasePermissionsSP.BasePermissions object N/DN/A
CalendarType **** ObjectcalendartypeCalendarType SPCalendarType PS. Enumeração CalendarTypeSP.CalendarType enumeration N/DN/A
Changecollection **** OnchangcollectionChangeCollection SPChangeCollection PS. Objeto ChangecollectionSP.ChangeCollection object …/_api/web/getchanges(changequery)
ChangeSite SPChangeSiteChangeSite SPChangeSite PS. Enumeração ChangeSiteSP.ChangeSite enumeration N/DN/A
ClientContextClientContext PS. Objeto ClientContextSP.ClientContext object …/_api/contextinfo
ContentType SPContentTypeContentType SPContentType PS. Objeto ContentTypeSP.ContentType object …/_api/web/contenttypes('<content type id>')
Contenttypecollection **** ExcontenttypecollectionContentTypeCollection SPContentTypeCollection PS. Objeto ContentTypecollectionSP.ContentTypeCollection object …/_api/web/contenttypes
SPContextSPContext PS. Objeto RequestContextSP.RequestContext object N/DN/A
EventReceiverDefinition SPEventReceiverDefinitionEventReceiverDefinition SPEventReceiverDefinition PS. Objeto EventReceiverDefinitionSP.EventReceiverDefinition object …/_api/web/eventreceivers
EventReceiverDefinitionCollection SPEventReceiverDefinitionCollectionEventReceiverDefinitionCollection SPEventReceiverDefinitionCollection PS. Objeto EventReceiverDefinitionCollectionSP.EventReceiverDefinitionCollection object …/_api/web/eventreceivers(eventreceiverid)
EventReceiverDefinitionCreationInformation SPEventReceiverDefinitionCreationInformationEventReceiverDefinitionCreationInformation SPEventReceiverDefinitionCreationInformation PS. Objeto EventReceiverDefinitionCreationInformationSP.EventReceiverDefinitionCreationInformation object N/DN/A
EventReceiverType SPEventReceiverTypeEventReceiverType SPEventReceiverType PS. Enumeração EventReceiverTypeSP.EventReceiverType enumeration N/DN/A
Recurso RecursoFeature SPFeature PS. Objeto FeatureSP.Feature object …/_api/web/features(featureid)
Featurecollection Função de recursoFeatureCollection SPFeatureCollection PS. Objeto FeaturecollectionSP.FeatureCollection object …/_api/web/features
FeatureDefinitionScope SPFeatureDefinitionScopeFeatureDefinitionScope SPFeatureDefinitionScope PS. Enumeração FeatureDefinitionScopeSP.FeatureDefinitionScope enumeration N/DN/A
Campo SPFieldField SPField PS. Objeto FieldSP.Field object . ../_api/Web/Fields ('')…/_api/web/fields('')
FieldCalculated SPFieldCalculatedFieldCalculated SPFieldCalculated PS. Objeto FieldCalculatedSP.FieldCalculated object . ../_api/Web/Fields ('')…/_api/web/fields('')
FieldChoice SPFieldChoiceFieldChoice SPFieldChoice PS. Objeto FieldChoiceSP.FieldChoice object . ../_api/Web/Fields ('')…/_api/web/fields('')
FieldCollection SPFieldCollectionFieldCollection SPFieldCollection PS. Objeto FieldCollectionSP.FieldCollection object . ../_api/Web/Fields…/_api/web/fields
FieldComputed SPFieldComputedFieldComputed SPFieldComputed PS. Objeto FieldComputedSP.FieldComputed object . ../_api/Web/Fields ('')…/_api/web/fields('')
FieldCurrency SPFieldCurrencyFieldCurrency SPFieldCurrency PS. Objeto FieldCurrencySP.FieldCurrency object . ../_api/Web/Fields ('')…/_api/web/fields('')
FieldLink SPFieldLinkFieldLink SPFieldLink PS. Objeto FieldLinkSP.FieldLink object …/_api/web/contenttypes('<content type id>')/fieldlinks('<field link id>')
FieldLookupValue SPFieldLookupValueFieldLookupValue SPFieldLookupValue PS. Objeto FieldLookupSP.FieldLookup object N/DN/A
FieldMultiChoice SPFieldMultiChoiceFieldMultiChoice SPFieldMultiChoice PS. Objeto FieldMultiChoiceSP.FieldMultiChoice object . ../_api/Web/Fields ('')…/_api/web/fields('')
FieldMultiLineText SPFieldMultiLineTextFieldMultiLineText SPFieldMultiLineText PS. Objeto FieldMultiLineTextSP.FieldMultiLineText object . ../_api/Web/Fields ('')…/_api/web/fields('')
FieldNumber SPFieldNumberFieldNumber SPFieldNumber PS. Objeto FieldNumberSP.FieldNumber object . ../_api/Web/Fields ('')…/_api/web/fields('')
FieldText SPFieldTextFieldText SPFieldText PS. Objeto FieldTextSP.FieldText object . ../_api/Web/Fields ('')…/_api/web/fields('')
FieldUrl SPFieldUrlFieldUrl SPFieldUrl PS. Objeto FieldUrlSP.FieldUrl object . ../_api/Web/Fields ('')…/_api/web/fields('')
FieldUrlValue SPFieldUrlValueFieldUrlValue SPFieldUrlValue PS. Objeto FieldUrlValueSP.FieldUrlValue object N/DN/A
FieldUser SPFieldUserFieldUser SPFieldUser PS. Objeto FieldUserSP.FieldUser object . ../_api/Web/Fields ('')…/_api/web/fields('')
Arquivo SPFileFile SPFile PS. Objeto FileSP.File object . ../_api/Web/getfilebyserverrelativeurl ('//')…/_api/web/getfilebyserverrelativeurl('//')
Filecollection SPFileCollectionFileCollection SPFileCollection PS. Objeto FieldCollectionSP.FieldCollection object . ../_api/Web/getfolderbyserverrelativeurl ('/')/Files…/_api/web/getfolderbyserverrelativeurl('/')/files
Pasta SPFolderFolder SPFolder PS. Objeto FolderSP.Folder object . ../_api/Web/getfolderbyserverrelativeurl ('/')…/_api/web/getfolderbyserverrelativeurl('/')
Formulário Formato de formuláriosForm SPForm PS. Objeto FormSP.Form object …/_api/web/lists(guid'<list id>')/forms('<form id>')
Grupo SPGroupGroup SPGroup PS. Objeto GroupSP.Group object . ../_api/Web/SiteGroups ()…/_api/web/sitegroups()
GroupCollection GrouponGroupCollection SPGroupCollection PS. Objeto GroupCollectionSP.GroupCollection object . ../_api/Web/SiteGroups…/_api/web/sitegroups
Idioma IdiomaLanguage SPLanguage PS. Objeto LanguageSP.Language object N/DN/A
Lista SPListList SPList PS. Objeto ListSP.List object . ../_api/Web/Lists (GUID '')…/_api/web/lists(guid'')
ListCollection SPListCollectionListCollection SPListCollection PS. Objeto ListCollectionSP.ListCollection object . ../_api/Web/Lists…/_api/web/lists
ListDataSource SPListDataSourceListDataSource SPListDataSource PS. Objeto ListDataSourceSP.ListDataSource object N/DN/A
ListItem SPListItemListItem SPListItem PS. Objeto ListItemSP.ListItem object . ../_api/Web/Lists (GUID '')/Items ()…/_api/web/lists(guid'')/items()
ListItemCollection SPListItemCollectionListItemCollection SPListItemCollection PS. Objeto ListItemcollectionSP.ListItemCollection object . ../_api/Web/Lists (GUID '')/Items…/_api/web/lists(guid'')/items
ListTemplateType SPListTemplateTypeListTemplateType SPListTemplateType PS. Enumeração ListTemplateTypeSP.ListTemplateType enumeration N/DN/A
Navegação AntinavigationNavigation SPNavigation PS. Objeto NavigationSP.Navigation object …/_api/web/navigation
NavigationNode SPNavigationNodeNavigationNode SPNavigationNode PS. Objeto NavigationNodeSP.NavigationNode object N/DN/A
Principal Entidade de segurançaPrincipal SPPrincipal PS. Objeto principalSP.Principal object N/DN/A
SPQuerySPQuery N/DN/A
RecycleBinItem SPRecycleBinItemRecycleBinItem SPRecycleBinItem PS. Objeto RecycleBinItemSP.RecycleBinItem object …/_api/web/RecycleBin(recyclebinitemid)
RecycleBinItemCollection SPRecycleBinItemCollectionRecycleBinItemCollection SPRecycleBinItemCollection PS. Objeto RecycleBinItemCollectionSP.RecycleBinItemCollection object …/_api/web/RecycleBin
RegionalSettings SPRegionalSettingsRegionalSettings SPRegionalSettings PS. Objeto RegionalSettingsSP.RegionalSettings object …/_api/web/RegionalSettings
RoleAssignment SPRoleAssignmentRoleAssignment SPRoleAssignment PS. Objeto RoleAssignmentSP.RoleAssignment object . ../_api/Web/RoleAssignments ()…/_api/web/roleassignments()
RoleAssignmentCollection SPRoleAssignmentCollectionRoleAssignmentCollection SPRoleAssignmentCollection PS. Objeto RoleAssignmentCollectionSP.RoleAssignmentCollection object . ../_api/Web/RoleAssignments…/_api/web/roleassignments
RoleDefinition SPRoleDefinitionRoleDefinition SPRoleDefinition PS. Objeto RoleDefinitionSP.RoleDefinition object . ../_api/Web/RoleDefinitions ()…/_api/web/roledefinitions()
RoleType **** OnroletypeRoleType SPRoleType PS. Enumeração RoleTypeSP.RoleType enumeration N/DN/A
Protegívelobject **** AntiprotegívelobjectSecurableObject SPSecurableObject PS. Objeto ProtegívelobjectSP.SecurableObject object N/DN/A
Site SPSiteSite SPSite PS. Objeto siteSP.Site object …/_api/site
Fuso horário ComtimezoneTimeZone SPTimeZone PS. Objeto TimeZoneSP.TimeZone object …/_api/web/RegionalSettings/TimeZones(timzoneid)
Taxonomia SPTaxonomySessionTaxonomy SPTaxonomySession PS. Objeto taxonomia. TaxonomySessionSP.Taxonomy.TaxonomySession object N/DNA
**** Timezonecollection **** TranstimezonecollectionTimeZoneCollection SPTimeZoneCollection PS. Objeto timeZonecollectionSP.TimeZoneCollection object …/_api/web/RegionalSettings/TimeZones
Usuário SPUserUser SPUser PS. Objeto userSP.User object . ../_api/Web/SiteUsers (@ v) ? @ v = ''…/_api/web/siteusers(@v)?@v=''
UserCollection SPUserCollectionUserCollection SPUserCollection PS. Objeto UserCollectionSP.UserCollection object . ../_api/Web/SiteGroups ()/Users…/_api/web/sitegroups()/users
Utilitário InutilityUtility SPUtility PS. Objeto Utilities. Utility (SP. js)SP.Utilities.Utility object (sp.js) N/DN/A
Exibir SPViewView SPView PS. Objeto View (SP. js)SP.View object (sp.js) . ../_api/Web/Lists (GUID '')/views ('')…/_api/web/lists(guid'')/views('')
ViewCollection **** ProviewcollectionViewCollection SPViewCollection PS. Objeto ViewCollectionSP.ViewCollection object . ../_api/Web/Lists (GUID '')/views…/_api/web/lists(guid'')/views
ViewFieldCollection SPViewFieldCollectionViewFieldCollection SPViewFieldCollection PS. Objeto ViewFieldCollectionSP.ViewFieldCollection object . ../_api/Web/Lists (GUID '')/views ('')/Fields…/_api/web/lists(guid'')/views('')/fields
Web SPWebWeb SPWeb PS. Objeto WebSP.Web object . ../_api/Web…/_api/web
Webcollection SPWebCollectionWebCollection SPWebCollection PS. Objeto webCollectionSP.WebCollection object . ../_api/Web/Webs…/_api/web/webs
Webinformation SPWebInfoWebInformation SPWebInfo PS. Objeto webInformationSP.WebInformation object …/_api/web/webinfos('<web information id>')
WebTemplate SPWebTemplateWebTemplate SPWebTemplate PS. Objeto webTemplateSP.WebTemplate object …/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage)/getbyname(templatename)
**** Webtemplatecollection SPWebTemplateCollectionWebTemplateCollection SPWebTemplateCollection PS. Objeto webTemplatecollectionSP.WebTemplateCollection object …/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage)

Confira tambémSee also