Referência e amostras da API REST

  • Artigo

Encontre a documentação no MSDN sobre a interface REST (transferência de estado representacional) do SharePoint 2013.

Esta página contém links para os recursos REST mais usados que estão disponíveis para os desenvolvedores do SharePoint 2013.

Última alteração: terça-feira, 17 de novembro de 2015

Aplica-se a: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

Assista ao vídeo: Fundamentos do REST e OData do SharePoint 2013

Dica

O serviço REST do SharePoint Online dá suporte à combinação de várias solicitações em uma única chamada para o serviço, com a opção de consulta $batch do OData. Para obter detalhes e links para exemplos de código, confira Fazem solicitações de lote com as APIs REST. Ainda não há suporte para essa opção no SharePoint local.

Referência da REST do SharePoint 2013

Observação

Alguns dos links a seguir abrem a documentação do objeto JavaScript correspondente, exibindo o ponto de extremidade REST na parte inferior da página.

Pontos de extremidade principais REST

Recurso

Descrição

SP. Objeto ChangeCollection (sp.js)

Representa uma coleção de objetos SP.Change.

SP. Objeto EventReceiverDefinitionCollection (sp.js)

Representa uma coleção de objetos EventReceiverDefinition que são usados para enumerar uma lista de receptores de evento registrados para objetos de Microsoft SharePoint Foundation.

SP. Objeto EventReceiverDefinition (sp.js)

SP. Objeto FeatureCollection (sp.js)

Representa uma coleção de objetos SP.Feature.

SP. Objeto de recurso (sp.js)

Representa um recurso ativado.

SP. Objeto RecycleBinItemCollection (sp.js)

Representa uma coleção de objetos SP.RecycleBinItem.

SP. Objeto RecycleBinItem (sp.js)

Representa um item de Lixeira na Lixeira de um site ou conjunto de sites.

SP. Objeto RegionalSettings (sp.js)

Representa configurações regionais em uso no servidor que executa Microsoft SharePoint Foundation.

SP. Objeto de site (sp.js)

Representa um conjunto de sites em um aplicativo Web, incluindo um site de nível superior e todos os seus subsites.

SP. Objeto TimeZoneCollection (sp.js)

SP. Objeto TimeZone (sp.js)

Web

Representa um site do SharePoint.

SP. Objeto WebTemplateCollection (sp.js)

Especifica uma coleção de modelos de site.

SP. Objeto WebTemplate (sp.js)

Especifica uma definição de site ou um modelo de site que é usado para instanciar um site.

Pontos de extremidade REST relacionados à lista

Recurso

Descrição

ListCollection

Representa uma coleção de recursos List.

List

Representa uma lista em um site do SharePoint.

ListItemCollection

Representa uma coleção de recursos ListItem.

ListItem

Representa um item ou linha em uma lista.

SP. Objeto ContentTypeCollection (sp.js)

Representa uma coleção de tipos de conteúdo de lista ou de site.

SP. Objeto ContentType (sp.js)

Representa o tipo de conteúdo de um site ou lista.

FieldCollection

Representa uma coleção de recursos Field.

Field

Representa um campo em uma lista do site do Microsoft SharePoint Foundation

SP. Objeto FieldLinkCollection (sp.js)

Representa uma coleção de objetos SP.FieldLink que são referências de campo ou colunas em um tipo de conteúdo.

SP. Objeto FieldLink (sp.js)

Especifica uma referência a um campo ou definição de campo para um tipo de conteúdo.

SP. Objeto FormCollection (sp.js)

Representa uma coleção de objetos SP.Form para uma lista.

SP. Objeto Form (sp.js)

Um formulário oferece uma interface de exibição e edição para um único item de lista.

Objeto SP.InformationRightsManagementSettings (sp.js)

SP. Objeto ListTemplateCollection (sp.js)

Representa uma coleção de objetos SP.ListTemplate.

SP. Objeto ListTemplate (sp.js)

Especifica um modelo de lista.

SP. Objeto RelatedFieldCollection (sp.js)

Representa uma coleção de propriedades de armazenamento de objetos SP.RelatedField dos campos de pesquisa de relação.

SP. Objeto RelatedField (sp.js)

Especifica uma relação para um campo de pesquisa

ViewCollection

Representa uma coleção de recursos View.

View

Especifica um modo de exibição de lista.

ViewFieldCollection

Representa uma coleção dos campos em um modo de exibição de lista.

Pontos de extremidade REST para arquivos e pastas

Recurso

Descrição

FileCollection

Representa uma coleção de recursos File.

File

Representa um arquivo em um site do SharePoint que pode ser uma Página de Web Parts, um item em uma biblioteca de documentos, ou um arquivo em uma pasta.

FileVersionCollection

Representa uma coleção de recursos FileVersion.

FileVersion

Representa uma versão de um recurso File.

FolderCollection

Representa uma coleção de recursos Folder.

Folder

Representa uma pasta em um site do SharePoint.

Pontos de extremidade REST para usuários e grupos

Recurso

Descrição

GroupCollection

Representa uma coleção de recursos Group.

Group

Representa um grupo em um site do Microsoft SharePoint Foundation.

RoleAssignmentCollection

Representa uma coleção de recursos RoleAssignment, que define todas as atribuições de função para um objeto protegível.

RoleAssignment

Define as atribuições de função de objeto protegível para um usuário ou grupo no site, lista ou item de lista.

RoleDefinitionCollection

Representa uma coleção de recursos RoleDefinition, que estipula as definições de função disponíveis para uso no site.

RoleDefinition

Define uma definição de função única, incluindo um nome, descrição e coleção de direitos.

RoleDefinitionBindingCollection

Define as definições de função que estão ligadas a um objeto de atribuição de funções.

UserCollection

Representa uma coleção de recursos User.

User

Representa um usuário do Microsoft SharePoint Foundation.

UserCustomActionCollection

Representa uma coleção de recursos UserCustomAction.

UserCustomAction

Representa uma ação personalizada associada a uma lista do SharePoint, site ou subsite.

Tipos complexos da REST

Recurso

Descrição

AppLicense

Representa uma licença de aplicativo para o usuário especificado para o Suplemento do SharePoint especificado.

AppLicenseCollection

AppPrincipalConfiguration

A configuração associada a uma entidade de segurança do aplicativo.

AppPrincipalCredentialReference

Representa uma referência a uma credencial de uma entidade de segurança do aplicativo.

BasePermissions

Representa as permissões base para uma definição de função.

CamlQuery

Especifica uma solicitação de CAML (Collaborative Application Markup Language) em uma lista ou listas interligadas.

ChangeLogItemQuery

Representa o parâmetro de entrada do método GetListItemChangesSinceToken.

ChangeQuery

Define a consulta que é executada no log de alterações.

ChangeToken

Representa a localização sequencial única de uma alteração contida no log de alterações.

ContentTypeCreationInformation

Especifica propriedades que são usadas como parâmetros para inicializar um novo tipo de conteúdo.

ContentTypeId

Representa o identificador de tipo de conteúdo (ID) de um tipo de conteúdo.

ContextWebInformation

As informações de contexto de um site.

DocumentLibraryInformation

Representa as informações referentes a uma biblioteca de documentos.

EventReceiverDefinitionCreationInformation

Especifica informações de criação de receptores de evento.

ExternalAppPrincipalCreationParameters

Representa o objeto que encapsula todos os parâmetros usados para criar uma nova entidade de segurança externa do aplicativo.

FieldCalculatedErrorValue

Representa o valor do campo calculado de um item de lista quando o valor do campo é um erro de cálculo, como uma divisão por zero ou estouro.

FieldCreationInformation

Representa propriedades que podem ser definidas ao criar um campo.

FieldGeolocationValue

Representa a altitude, latitude, longitude e valores de medida para um campo de geolocalização.

FieldLookupValue

Especifica o valor de uma pesquisa para um campo em um item de lista.

FieldRatingScaleQuestionAnswer

Representa uma subpergunta e resposta específica em um campo de escala de classificação de um item de lista.

FieldUrlValue

Especifica o hiperlink e os valores de descrição para FieldURL.

FieldUserValue

Representa o valor de um campo de usuário para um item de lista.

FileCreationInformation

Representa propriedades que podem ser definidas ao criar um arquivo usando o método FileCollection.Add.

GroupCreationInformation

Um objeto usado para facilitar a criação de um grupo intersite.

KeyValue

Representa um dicionário de pares chave e valor.

Language

Representa um idioma natural usado no contexto de Microsoft SharePoint Foundation.

ListDataSource

Representa informações associadas a uma conexão com uma fonte de dados externa.

ListDataValidationExceptionValue

A exceção que é acionada quando os dados para um campo ou item de lista falha a validação.

ListDataValidationFailure

Descreve uma falha de validação específica quando um item de lista é inserido ou atualizado.

ListItemCollectionPosition

Especifica as informações necessárias para obter a próxima página de dados para um modo de exibição de lista.

ListItemCreationInformation

Especifica as propriedades do novo item de lista.

ListItemFormUpdateValue

Representa propriedades de um campo de item de lista e o seu valor.

MenuNode

Representa um nó de navegação na hierarquia de navegação. Uma hierarquia de navegação é uma estrutura de árvore dos nós de navegação.

MenuState

Representa o estado de menu do padrão SiteMapProvider ("SPSiteMapProvider"), em que o despejo é iniciado no nó raiz do site com uma profundidade de 10 níveis.

NavigationNodeCreationInformation

Descreve um novo nó de navegação a ser criado.

RelatedItem

RenderListDataParameters

Representa os parâmetros a serem usados para renderizar os dados da lista como uma cadeia de caracteres JavaScript Object Notation (JSON).

RoleDefinitionCreationInformation

Contém propriedades que são usadas como parâmetros para inicializar uma definição de função.

SimpleDataRow

Representa uma linha em uma tabela de dados.

SimpleDataTable

Representa uma tabela de dados.

TimeZoneInformation

Representa informações sobre um fuso horário.

UpgradeInfo

Representa as informações de atualização do conjunto de sites.

UsageInfo

Fornece campos que são usados para acessar informações sobre o uso de conjuntos de sites.

UserCreationInformation

Parâmetros para convidar um usuário.

UserIdInfo

Representa as informações de identificador exclusivo de um provedor de identidade.

ViewCreationInformation

Especifica as propriedades usadas para criar um novo modo de exibição de lista.

WebCreationInformation

Especifica as propriedades de um novo site.

WebInfoCreationInformation

Representa os metadados referentes à criação do site.

WebRequestInfo

Representa os dados do chamador necessários para realizar a solicitação Web de saída.

WebResponseInfo

Contém uma cópia da resposta do serviço de terceiros.

XmlSchemaFieldCreationInformation

Representa propriedades que podem ser definidas ao criar um campo.

Visões gerais do REST do SharePoint 2013

Recurso

Descrição

Iniciar o serviço SharePoint 2013 REST

Conheça as noções básicas de uso do serviço REST do SharePoint 2013 para acessar e atualizar dados do SharePoint usando os padrões de protocolo da Web REST e OData.

Realizar operações básicas usando os pontos de extremidade REST do SharePoint 2013

Saiba como realizar operações CRUD básicas com a interface REST do SharePoint 2013.

Visão geral da API REST da Pesquisa do SharePoint

Adicione a funcionalidade de pesquisa e aplicativos móveis para os clientes usando o serviço de Pesquisa REST no SharePoint Server 2013 e em qualquer tecnologia compatível com os requisitos da Web para REST.

Referência da API REST de perfis de usuário

Saiba mais sobre os pontos de extremidade REST do SharePoint 2013 do usuário PeopleManager, ProfileLoader, UserProfile, bem como recursos relacionados.

Social feed REST API reference for SharePoint 2013

Saiba mais sobre pontos de extremidade REST do SharePoint 2013 para tarefas relacionadas a feeds.

Seguintes pessoas e conteúdo Referência API REST para o SharePoint 2013

Saiba mais sobre pontos de extremidade REST do SharePoint 2013 para o acompanhamento de pessoas e conteúdo.

Exemplos de código REST do SharePoint 2013

Recurso

Descrição

SharePoint 2013: Aplicativo remoto Hello World usando a REST

Saiba como criar um Suplemento do SharePoint hospedado pelo provedor do "hello world" que usa a interface REST do SharePoint para ler informações sobre um site do SharePoint 2013 por meio de um aplicativo Web remoto.

SharePoint 2013: Usando o serviço de pesquisa REST de um aplicativo para o SharePoint

Saiba como enviar uma consulta de pesquisa para o Pesquisa no SharePoint 2013 em um Suplemento do SharePoint.

SharePoint 2013: Criar consultas REST e usar a REST para percorrer um site

Saiba como usar as APIs REST do SharePoint para percorrer um site do SharePoint 2013, e para criar um aplicativo que cria consultas que realizam operações de dados básicos em entidades básicas do SharePoint que são expostas em pontos de extremidade REST.

SharePoint 2013: Realizar operações básicas de acesso a dados usando a REST nos aplicativos

Saiba como usar as APIs REST do SharePoint para realizar operações básicas de acesso a dados nas listas e itens de lista do SharePoint 2013.

SharePoint 2013: Realizar operações básicas em arquivos e pastas usando a REST

Um exemplo de código que usa a REST e biblioteca de domínio cruzado do SharePointJavaScript para realizar operações básicas em bibliotecas de documentos e arquivos.

SharePoint 2013: Fazer chamadas de tipo de política somente aplicativo em um aplicativo remoto (REST)

Saiba como usar o atributo AllowAppOnlyPolicy, com a REST e o OAuth, para fazer chamadas novamente para SharePoint 2013.

SharePoint 2013: Acessando uma lista externa com a REST

Saiba como criar um Suplemento do SharePoint que usará URLs RESTful para consultar e manipular dados em uma lista externa.

SharePoint 2013: Use o controle de cromo e a biblioteca de domínio cruzado (REST)

Saiba como incluir uma página da Web remota que hospeda o controle de cromo e recupera informações do host da Web usando a biblioteca de domínio cruzado e a REST no SharePoint 2013.

SharePoint 2013: Obter itens de lista usando a biblioteca de domínio cruzado (REST)

Saiba como usar a biblioteca de domínio cruzado no Suplementos do SharePoint para ler itens em uma lista hospedada no aplicativo Web.

SharePoint 2013: Obter o título do host da Web usando a biblioteca de domínio cruzado (REST)

Saiba como usar a biblioteca de domínio cruzado no SharePoint 2013 para ler a propriedade title do host da Web.

Definir permissões personalizadas em uma lista, usando a interface REST

Saiba como definir permissões refinadas e personalizadas em uma lista do SharePoint usando a interface REST e o JavaScript.

Recursos adicionais