Referência de API REST Webs

Artigo
09/21/2016

Saiba mais sobre os recursos relacionados ao site e pontos de extremidade SharePoint API REST.

Última alteração: quinta-feira, 15 de setembro de 2016

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

Sobre os exemplos de solicitação neste artigo

Os exemplos descritos neste artigo usam solicitações jQuery AJAX. Antes de tentar usar os exemplos, faça o seguinte:

Altere <site url> e outros dados de espaço reservado, como quaisquer IDs, nomes ou caminhos de entidades do SharePoint.

Se você estiver usando a biblioteca entre domínios, você terá que alterar o formato de solicitação. Por exemplo, ele pode parecer com o seguinte.

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/getchanges?@target='<host web url>'",
  method: "POST",
  body: "{ 'query': { '__metadata': { 'type': 'SP.ChangeQuery' }, 'Web': true, 'Update': true } }",
  headers: {
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Se você estiver usando o OAuth, adicione um cabeçalho Authorization ("Authorization": "Bearer " + <access token>) para enviar o token de acesso OAuth.
Remova as quebras de linha dos valores de propriedade url e data nos exemplos de solicitação. Quebras de linha são adicionadas aos exemplos para facilitar a leitura.
Se quiser que o servidor retorne respostas no formato Atom, remova o cabeçalho "accept": "application/json;odata=verbose".

Veja Como as solicitações REST diferem por ambiente para obter mais informações sobre como alterar as solicitações. Veja Recursos adicionais para obter links que levam a mais informações sobre como usar a biblioteca de domínio cruzado, o OAuth e o serviço REST do SharePoint.

Dica

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

Recurso da Web

URI do ponto de extremidade | Propriedades | Métodos | Representação do OData

Representa um site de SharePoint. Um site é um tipo de SP.SecurableObject.

URI do ponto de extremidade

http://<site url>/_api/web

Métodos HTTP com suporte

GET | POST | DELETE | MERGE | PUT

Exemplos de solicitação

Exemplo de solicitação GET: Obtenha um site

$.ajax({
  url: "http://<site url>/_api/web",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Exemplo de solicitação POST: Criar um site usando o método Add da WebCollection do recurso

$.ajax({
  url: "http://<site url>/_api/web/webs/add",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.WebCreationInformation' },
    'Title': 'Team projects', 'Url': 'TeamProjects', 'WebTemplate': 'STS',
    'UseSamePermissionsAsParentSite': true } }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Ou você pode usar o método Add do recurso de WebInformationCollection , conforme mostrado na criação de um site com o REST.

Exemplo de solicitação de mesclagem: Alterar um site

$.ajax({
  url: "http://<site url>/_api/web",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Web' }, 'Description': 'All team projects',
    'EnableMinimalDownload': false }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Exemplo de solicitação de excluir: Excluir um site

$.ajax({
  url: "http://<site url>/_api/web",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Propriedades da Web

Para obter uma propriedade, envie uma solicitação GET para o ponto de extremidade da propriedade, conforme mostrado no exemplo a seguir.

$.ajax({
  url: "http://<site url>/_api/web/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propriedade	Tipo	De leitura/gravação	Retornados com recurso	Descrição
AllowCreateDeclarativeWorkflowForCurrentUser	Boolean	L	Não	Especifica se o usuário atual pode criar fluxos de trabalho declarativos. Se não está desabilitada no aplicativo Web, o valor é o mesmo que a propriedade AllowCreateDeclarativeWorkflow do conjunto de sites. Valor padrão: true.
AllowDesignerForCurrentUser	Boolean	L	Não	Obtém um valor que especifica se o usuário atual tem permissão para usar um aplicativo de design para personalizar este site.
AllowMasterPageEditingForCurrentUser	Boolean	L	Não	Obtém um valor que especifica se o usuário atual tem permissão para editar a página mestra.
AllowRevertFromTemplateForCurrentUser	Boolean	L	Não	Obtém um valor que especifica se o usuário atual tem permissão para reverter o site para um modelo de site padrão.
AllowRssFeeds	Boolean	L	Sim	Obtém um valor que especifica se o site permite feeds RSS.
AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser	Boolean	L	Não	Especifica se o usuário atual pode salvar fluxos de trabalho declarativos como um modelo. Se não está desabilitada no aplicativo Web, o valor é o mesmo que a propriedade AllowSaveDeclarativeWorkflowAsTemplate do conjunto de sites. Valor padrão: true.
AllowSavePublishDeclarativeWorkflowForCurrentUser	Boolean	De leitura e gravação	Não	Especifica se o usuário atual pode salvar ou publicar fluxos de trabalho declarativos. Se não está desabilitada no aplicativo Web, o valor é o mesmo que a propriedade AllowSavePublishDeclarativeWorkflowAsTemplate do conjunto de sites. Quando habilitada, só pode ser definida por um administrador do conjunto de sites. Valor padrão: true.
AllProperties	SP.PropertyValues	L	Não	Obtém uma coleção de metadados para o site.
AppInstanceId	GUID	L	Sim	O Id de instância da Instância de Aplicativo que esta web representa.
AssociatedMemberGroup	SP.Group	De leitura e gravação	Não	Obtém ou define o grupo de usuários aos quais tenham sido atribuídas permissões de contribuição para o site.
AssociatedOwnerGroup	SP.Group	De leitura e gravação	Não	Obtém ou define o grupo de proprietário associado do site.
AssociatedVisitorGroup	SP.Group	De leitura e gravação	Não	Obtém ou define o grupo de visitante associado do site.
AvailableContentTypes	SP.ContentTypeCollection	L	Não	Obtém a coleção de todos os tipos de conteúdo que se aplicam ao escopo atual, incluindo aqueles do site atual, bem como quaisquer sites pai.
AvailableFields	SP.FieldCollection	L	Não	Obtém um valor que especifica a coleção de todos os campos disponíveis para o escopo atual, incluindo aqueles do site atual, bem como de quaisquer sites pai.
Configuração	Int16	L	Sim	Obtém o identificador da configuração de definição de site que foi usada para criar o site, ou a ID da configuração de definição de site da qual o modelo de site usado para criar o site é derivado.
ContentTypes	SP.ContentTypeCollection	L	Não	Obtém a coleção de tipos de conteúdo para o site.
Created	DateTime	L	Sim	Obtém um valor que especifica quando o site foi criado.
CurrentUser	SP.User	L	Não	Obtém o usuário atual do site.
CustomMasterUrl	String	De leitura e gravação	Sim	Obtém ou define a URL para um arquivo de página mestra personalizado para aplicar ao site.
Description	String	De leitura e gravação	Sim	Obtém ou define a descrição para o site.
DesignerDownloadUrlForCurrentUser	String	L	Não	Obtém a URL onde o usuário atual pode baixar SharePoint Designer.
DocumentLibraryCalloutOfficeWebAppPreviewersDisabled	Boolean	L	Sim	Determina se os visualizadores de WAC dos Textos Explicativos da Biblioteca de Documentos estão habilitados ou não.
EffectiveBasePermissions	SP.BasePermissions	L	Não	Representa a interseção de permissões do aplicativo principal e a entidade de segurança do usuário. Caso somente app, essa propriedade retorna somente as permissões da entidade de segurança de aplicativo. Para verificar apenas as permissões de usuário (ignorando as permissões do aplicativo), use o método GetUserEffectivePermissions .
EnableMinimalDownload	Boolean	De leitura e gravação	Sim	Obtém ou define um valor Booliano que especifica se o site da Web deverá usar Estratégia de Download Mínimo.
EventReceivers	SP.EventReceiverCollection	L	Não	Obtém a coleção de definições de receptores de evento que estão atualmente disponíveis no site.
Recursos	SP.FeatureCollection	L	Não	Obtém um valor que especifica a coleção de recursos que estão atualmente ativados no site.
Fields	SP.FieldCollection	L	Não	Obtém a coleção de objetos de campo que representam todos os campos no site.
Pastas	SP.FolderCollection	L	Não	Obtém a coleção de todas as pastas de primeiro nível no site.
Id	GUID	L	Sim	Obtém um valor que especifica o identificador para o site.
Idioma	Int32	L	Sim	Obtém um valor que especifica o LCID para o idioma utilizado no site.
LastItemModifiedDate	DateTime	L	Sim	Obtém um valor que especifica quando um item foi modificado pela última vez no site.
Listas	SP.ListCollection	L	Não	Obtém uma coleção de todas as listas que estão contidas no site disponíveis para o usuário atual com base nas permissões do usuário atual.
ListTemplates	SP.ListTemplateCollection	L	Não	Obtém um valor que especifica a coleção de definições de lista e modelos de lista disponíveis para criar listas no site.
MasterUrl	String	De leitura e gravação	Sim	Obtém ou define a URL da página mestre usada no site.
Navegação	SP.Navigation	L	Não	Obtém um valor que especifica a estrutura de navegação no site, incluindo a área de Início Rápido e a barra de navegação superior.
ParentWeb	SP.Web	L	Não	Obtém o site pai do site especificado.
PushNotificationSubscribers	SP.PushNotificationSubscriberCollection	L	Não	Obtém uma coleção de assinantes de notificações por push sobre o site.
QuickLaunchEnabled	Boolean	De leitura e gravação	Sim	Obtém ou define um valor que especifica se a área de Inicialização Rápida está habilitada no site.
RecycleBin	SP.RecycleBin	L	Não	Especifica a coleção de itens de lixeira da lixeira do site.
RecycleBinEnabled	Boolean	L	Sim	Obtém ou define um valor que determina se a lixeira está habilitada para o site.
RegionalSettings	SP.RegionalSettings	L	Não	Obtém as configurações regionais atualmente implementadas no site.
RoleDefinitions	SP.RoleDefinitionCollection	L	Não	Obtém a coleção de definição de funções para a página.
RootFolder	SP.Folder	L	Não	Obtém a pasta raiz para o site.
SaveSiteAsTemplateEnabled	Boolean	De leitura e gravação	Não	Obtém ou define um valor Booliano que especifica se o site pode ser salvo como um modelo de site.
ServerRelativeUrl	String	De leitura e gravação	Sim	Obtém ou define a URL relativa ao servidor para o site.
ShowUrlStructureForCurrentUser	Boolean	L	Não	Obtém um valor que especifica se o usuário atual pode visualizar a estrutura de sistema de arquivos deste site.
SiteGroups	SP.GroupCollection	L	Não	Obtém a coleção de grupos para o conjunto de sites.
SiteUserInfoList	SP.List	L	Não	Obtém a lista de UserInfo do conjunto de sites que contém o site.
SiteUsers	SP.UserCollection	L	Não	Obtém a coleção de todos os usuários que pertencem ao conjunto de sites.
SupportedUILanguageIds	Collection(Int32)	L	Não	Especifica os identificadores de código de idioma (LCIDs) dos idiomas habilitados para este site.
SyndicationEnabled	Boolean	De leitura e gravação	Sim	Obtém ou define um valor que especifica se os feeds RSS estão habilitados no site.
ThemeInfo	SP.ThemeInfo	L	Não	A informação de tema para este site. Isso inclui informações como cores, fontes, tamanho de raio de borda, etc.
Título	String	De leitura e gravação	Sim	Obtém ou define o título para o site.
TreeViewEnabled	Boolean	De leitura e gravação	Sim	Obtém ou define o valor que especifica se o modo de exibição de árvore está habilitado no site.
UIVersion	Int32	De leitura e gravação	Sim	Obtém ou define a versão de interface de usuário (IU) do site.
UIVersionConfigurationEnabled	Boolean	De leitura e gravação	Sim	Obtém ou define um valor que especifica se a IU de configurações para atualização visual é exibida ou oculta.
URL	String	L	Sim	Obtém a URL absoluta para o site.
UserCustomActions	SP.UserCustomActionCollection	L	Não	Obtém um valor que especifica a coleção de ações personalizadas de usuário para o site.
WebInfos	SP.WebInformation	L	Não	Representa propriedades de chave de subsites de um site.
Webs	SP.WebCollection	L	Não	Obtém um objeto de conjunto de sites da Web que representa todos os sites da Web imediatamente abaixo do site, excluindo os filhos desses sites da Web.
WebTemplate	String	L	Sim	Obtém o nome da definição ou modelo de site usado para criar o site.
WorkflowAssociations	SP.WorkflowAssociationCollection	L	Não	Obtém um valor que especifica a coleção de todas as associações de fluxo de trabalho para o site.
WorkflowTemplates	SP.WorkflowTemplateCollection	L	Não	Obtém um valor que especifica a coleção de modelos de fluxos de trabalho associados ao site.

Métodos da Web

ApplyTheme
ApplyWebTemplate
BreakRoleInheritance
DeleteObject
DoesPushNotificationSubscriberExist
DoesUserHavePermissions
EnsureUser
ExecuteRemoteLOB
GetAppBdcCatalog
GetAppBdcCatalogForAppInstance
GetAppInstanceById
GetAppInstancesByProductId
GetAvailableWebTemplates
GetCatalog
GetChanges
GetContextWebInformation
GetEntity
GetDocumentLibraries
GetFileByServerRelativeUrl
GetFolderByServerRelativeUrl
GetList
GetPushNotificationSubscriber
GetPushNotificationSubscribersByArgs
GetPushNotificationSubscribersByUser
GetSubwebsFilteredForCurrentUser
GetUserById
GetUserEffectivePermissions
GetWebUrlFromPageUrl
LoadAndInstallApp
LoadAndInstallAppInSpecifiedLocale
LoadApp
MapsToIcon
ProcessExternalNotification
RegisterPushNotificationSubscriber
ResetRoleInheritance
UnregisterPushNotificationSubscriber

Método ApplyTheme

Aplica o tema especificado pelos conteúdos de cada um dos arquivos especificados nos argumentos para o site.

Ponto de extremidade	/ApplyTheme (colorpaletteurl, fontschemeurl, backgroundimageurl, sharegenerated)
Parâmetros	colorpaletteurl Tipo: String a URL relativa de servidor do arquivo de paleta de cores. fontschemeurl Tipo: String a URL relativa de servidor do esquema de fonte. backgroundimageurl Tipo: String a URL relativa de servidor da imagem do plano de fundo. sharegenerated Tipo: Boolean true para armazenar os arquivos de tema gerado no site raiz ou false armazená-los neste site.
HTTP method	POST
Resposta	Nenhuma

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /applytheme(colorpaletteurl='/_catalogs/theme/15/palette011.spcolor',
        fontschemeurl='/_catalogs/theme/15/fontscheme007.spfont',
        backgroundimageurl='/piclibrary/th.jpg', sharegenerated=true)",
  type: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

Ou, você pode enviar os parâmetros no corpo: { 'colorPaletteUrl':'/_catalogs/theme/15/palette011.spcolor', 'fontSchemeUrl':'/_catalogs/theme/15/fontscheme007.spfont', 'backgroundImageUrl':'/piclibrary/pics/th.jpg', 'shareGenerated':true }

Consulte Visão geral de temas para o SharePoint 2013.

Método ApplyWebTemplate

Aplica a definição de site especificada ou modelo de site ao site que não tenha modelos aplicados a ele.

Observação

Chamar esse método dentro de uma função de retorno de chamada definida dentro a mesma configuração de definição de site que está sendo aplicada de provisionamento de site pode resultar em um loop infinito. Em vez disso, crie duas configurações de definição de site semelhante dentro a definição de site, que é visível e que está oculto. A configuração visível, em seguida, pode conter um retorno de chamada do assembly provisionamento que se aplica a configuração oculta aos sites.

Ponto de extremidade	/applywebtemplate('<site definition or web template name>')
Parâmetros	Tipo: String o nome da definição do site ou o nome do modelo de site. Use o método GetAvailableWebTemplates obter os nomes dos modelos de site disponíveis.
HTTP method	POST
Resposta	Nenhuma

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /applywebtemplate(@v)?@v='blog%230'",
  type: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

Método BreakRoleInheritance

Cria atribuições de função exclusivas para o objeto protegível.

Ponto de extremidade	/breakroleinheritance(copyroleassignments, clearsubscopes)
Parâmetros	copyroleassignments Tipo: Boolean true para copiar as atribuições de funções do objeto protegível pai; false para remover as atribuições de função herdadas, exceto a que contém o usuário atual. clearsubscopes Tipo: Boolean opcional. true para tornar todos os objetos protegíveis filho herdam atribuições da função de ao objeto atual. false (padrão) deixar as atribuições da função inalteradas para objetos protegíveis de filhos que não herdam atribuições da função do objeto pai.
HTTP method	POST
Resposta	Nenhuma

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /breakroleinheritance(copyroleassignments=false, clearsubscopes=true)",
  method: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

Método DeleteObject

A maneira recomendada de excluir um site é enviar uma solicitação de DELETE ao ponto de extremidade de recurso Web , conforme mostrado nos exemplos da solicitação de Web.

Método de DoesPushNotificationSubscriberExist

Verifica se o assinante de notificações por push existe para o usuário atual com o ID da instância de aplicativo de dispositivo fornecido.

Ponto de extremidade	/doespushnotificationsubscriberexist('<device app instance id >')
Parâmetros	Tipo: GUID o ID da instância do aplicativo do dispositivo.
HTTP method	GET
Resposta	Tipo: Boolean true se a inscrição de existir. falsede qualquer outra forma.

Método DoesUserHavePermissions

Retorna se o usuário atual tem a coleção de permissões determinada.

Ponto de extremidade	/doesuserhavepermissions(@v) ?@v= {'Alta':'<value>', 'Baixa':'<value>'}
Parâmetros	Tipo: SP. BasePermissions o intervalo de permissão alta e baixa. Use o ponto de extremidade …/_api/web/roledefinitions obter os valores permissão alta e baixa para as funções no site.
HTTP method	GET
Resposta	Tipo: Boolean true se o usuário tem as permissões, caso contrário false.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /doesuserhavepermissions(@v)?@v={'High':'432', 'Low':'1012866047'}",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método de EnsureUser

Verifica se o nome de logon especificado pertence a um usuário válido no site. Se o usuário não existir, adiciona o usuário ao site.

Ponto de extremidade	/ensureuser
Parâmetros	logonName Tipo: String o nome de logon do usuário. Passe o parâmetro logonName no corpo da solicitação, como mostra o exemplo de solicitação.
HTTP method	POST
Resposta	Tipo: SP. Usuário o usuário especificado.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /ensureuser",
  type: "POST",
  data: "{ 'logonName': 'i:0#.f|membership|user@domain.onmicrosoft.com' }",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Método ExecuteRemoteLOB

Envia dados para um serviço OData.

Este método é o ponto de entrada para conectividade híbrida e é usado para chamar o serviço OData de um servidor local. Parâmetros de entrada necessários para fazer com que o serviço OData chamada são passados como cabeçalhos HTTP personalizados. Consulte ExecuteRemoteLOB.

Ponto de extremidade	/executeremotelob
Parâmetros	inputStream Tipo: Stream OData o objeto de entrada. Usado para apenas operações de criação ou de atualização.
HTTP method	POST
Resposta	Tipo: Stream OData a resposta do serviço OData.

Método GetAppBdcCatalog

Ponto de extremidade	/getappbdccatalog
Parâmetros	Nenhum
HTTP method	POST
Resposta	Tipo: SP.BusinessData.AppBdcCatalog o Business Data Connectivity (BDC) service MetadataCatalog para a instância atual do aplicativo.

Método GetAppBdcCatalogForAppInstance

Ponto de extremidade	/getappbdccatalogforappinstance('<app instance id>')
Parâmetros	Tipo: GUID identificação da instância do aplicativo.
HTTP method	POST
Resposta	Tipo: SP.BusinessData.AppBdcCatalog o BDC MetadataCatalog da instância do aplicativo especificado.

Método de GetAppInstanceById

Recupera uma AppInstance instalada neste Site.

Ponto de extremidade	/getappinstancebyid('<app instance id>')
Parâmetros	Tipo: GUID o ID da instância do aplicativo.
HTTP method	GET
Resposta	Tipo: SP.AppInstance a instância do aplicativo especificado.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /getappinstancebyid('3122ea58-8435-4d9a-a302-345599838671')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método de GetAppInstancesByProductId

Recupera todas as AppInstances instaladas neste site que sejam instâncias do Aplicativo especificado.

Ponto de extremidade	/getappinstancesbyproductid('<product id>')
Parâmetros	Tipo: GUID a ID do produto do aplicativo.
HTTP method	GET
Resposta	Tipo: Collection(SP.AppInstance) as instâncias de aplicativo instaladas no site para o produto especificado.

Método GetAvailableWebTemplates

Retorna uma coleção de modelos de site disponíveis para o site.

Ponto de extremidade	/getavailablewebtemplates (lcid, doincludecrosslanguage)
Parâmetros	lcid Tipo: Int64 o LCID dos modelos de site ser obtido. doincludecrosslanguage Tipo: Boolean true para incluir modelos de site de idioma neutro; Caso contrário false.
HTTP method	GET
Resposta	Tipo: SP.WebTemplateCollection a coleção de modelos de site disponíveis. Retorna uma coleção vazia se o LCID especificado não é válido.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /getavailablewebtemplates(lcid=1033, doincludecrosslanguage=true)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método GetCatalog

Retorna a Galeria de lista no site.

Ponto de extremidade	/GetCatalog (<gallery type >)
Parâmetros	Tipo: Int32 o tipo de galeria. Representa um valor de ListTemplateType como WebTemplateCatalog = 111, WebPartCatalog = 113 ListTemplateCatalog = 114, MasterPageCatalog = 116, SolutionCatalog = 121, ThemeCatalog = 123, DesignCatalog = 124, AppDataCatalog = 125.
HTTP method	GET
Resposta	Tipo: SP. Lista Galeria de tipo de lista especificado. Retorna null se não houver nenhuma galeria com o tipo especificado ou se o tipo de modelo de lista não é válido.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /getcatalog(113)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método GetChanges

Retorna a coleção de todas as alterações do log de alterações que ocorreram dentro do escopo do site, com base na consulta especificada.

Ponto de extremidade	/getchanges
Parâmetros	query Tipo: SP. ChangeQuery a alterar consulta. Passe o parâmetro query no corpo da solicitação, como mostra o exemplo de solicitação.
HTTP method	POST
Resposta	Tipo: SP.ChangeCollection as alterações para o site que correspondem aos critérios da consulta alteração especificada.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /getchanges",
  type: "POST",
  data: "{ 'query': { '__metadata': { 'type': 'SP.ChangeQuery' },
    'Web': true, 'Update': true, 'Add': true } }",
  headers: {
    "X-RequestDigest": <form digest value>
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

GetContextWebInformation

Obtém as informações de contexto para o site. Método estático.

Ponto de extremidade	http://<site url>/_api/contextinfo
Parâmetros	Nenhum
HTTP method	POST
Resposta	Tipo: SP. ContextWebInformation as informações de contexto para o site.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api
    /contextinfo",
  type: "POST",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Método GetCustomListTemplates

Obtém os modelos de lista personalizada para o site.

Ponto de extremidade	/getcustomlisttemplates
Parâmetros	Nenhum
HTTP method	GET
Resposta	Tipo: SP.ListTemplateCollection os modelos de lista personalizada para o site.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /getcustomlisttemplates",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método GetDocumentLibraries

Obtém as bibliotecas de documentos em um site. Método estático. (SharePoint Online somente)

Ponto de extremidade	http://<site url>/_api/sp.web.getdocumentlibraries(@v)?@v='<full site url>'
Parâmetros	Tipo: String a URL completa do site.
HTTP method	GET
Resposta	Tipo: Coleção (SP. DocumentLibraryInformation) propriedades das bibliotecas de documentos no site. Este método não retorna bibliotecas privadas, bibliotecas de imagens, bibliotecas de catálogo, bibliotecas de ativos, aplicativo listas ou bibliotecas que o usuário não tem permissões para exibir itens.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api
    /sp.web.getdocumentlibraries(@v)?@v='https://contoso.sharepoint.com'",
  method: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler});

Método GetEntity

Obtém o tipo de conteúdo externo especificado em um aplicativo de sistema de linha de negócios (LOB).

Ponto de extremidade	/getentity (namespace, name)
Parâmetros	namespace Tipo: String o namespace do tipo de conteúdo externo. name Tipo: String o nome do tipo de conteúdo externo.
HTTP method	POST
Resposta	Tipo: SP.BusinessData.Entity tipo de conteúdo externo.

Método GetFileByServerRelativeUrl

Retorna o objeto de arquivo localizado na URL relativa do servidor especificada.

Ponto de extremidade	/getfilebyserverrelativeurl('<server relative url>')
Parâmetros	Tipo: String a URL relativa do servidor do arquivo.
HTTP method	GET
Resposta	Tipo: SP. Arquivo o arquivo especificado.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /getfilebyserverrelativeurl('/templates/ResourceRequest.docx')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método GetFolderByServerRelativeUrl

Retorna o objeto de pasta localizado na URL relativa ao servidor especificada.

Ponto de extremidade	/getfolderbyserverrelativeurl('<server relative url>')
Parâmetros	Tipo: String a URL relativa de servidor da pasta.
HTTP method	GET
Resposta	Tipo: SP. Pasta da pasta especificada.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /getfolderbyserverrelativeurl('/templates/test')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método GetList

Obtém a lista na URL especificada relativo do site.

Ponto de extremidade	/GetList('<list url>')
Parâmetros	Tipo: String a URL relativa de site da lista.
HTTP method	GET
Resposta	Tipo: SP. Lista a lista especificada.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /getlist('/lists/ideas')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método GetPushNotificationSubscriber

Obtém o assinante de notificações por push sobre o site para o ID de instância de aplicativo do dispositivo especificado.

Ponto de extremidade	/getpushnotificationsubscriber('<device app instance id>')
Parâmetros	Tipo: GUID o ID da instância de app do dispositivo.
HTTP method	GET
Resposta	Tipo: SP.PushNotificationSubscriber o assinante de notificação de push registrados.

Método GetPushNotificationSubscribersByArgs

Consultas para os assinantes de notificações por push do site para o valor especificado de argumentos personalizados. Argumentos personalizados nulos ou inválidos retornarão assinantes sem qualquer filtragem.

Ponto de extremidade	/getpushnotificationsubscribersbyargs('<arguments>')
Parâmetros	Tipo: String argumentos para filtrar os resultados. Argumentos passados são comparados aos argumentos dos assinantes personalizado no repositório. Passe Nulo ou argumentos vazios para retornar resultados não filtrados.
HTTP method	GET
Resposta	Tipo: SP.PushNotificationSubscriberCollection os assinantes de notificação de push registrados que coincidem com os argumentos. Retorna uma coleção vazia se nenhuma correspondência for encontrada.

Método GetPushNotificationSubscribersByUser

Consultas para os assinantes de notificações por push sobre o site para o usuário especificado.

Ponto de extremidade	/getpushnotificationsubscribersbyuser(@v) 2 _ @v ='<login name>'
Parâmetros	Tipo: String o nome de logon do usuário. Consulte usuário para formatos usados para passar os nomes de logon na sequência de consulta.
HTTP method	GET
Resposta	Tipo: SP.PushNotificationSubscriberCollection os assinantes de notificação de push registrados para o usuário.

Método GetSubwebsFilteredForCurrentUser

Retorna o conjunto de sites filho do site atual com base na consulta especificada.

Disponível no SharePoint Online somente.

Ponto de extremidade	/getsubwebsfilteredforcurrentuser (nwebtemplatefilter, nconfigurationfilter)
Parâmetros	nwebtemplatefilter Tipo: Int32 a identificação do modelo usado na definição de site dos sites. nconfigurationfilter Tipo: Int16 a identificação do modelo de site usado para provisionar os sites.
HTTP method	GET
Resposta	Tipo: Collection(SP.WebInformation) informações sobre os sites que o usuário atual pode acessar.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /getsubwebsfilteredforcurrentuser(nwebtemplatefilter=-1,nconfigurationfilter=0)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método GetUserById

Retorna o usuário correspondente ao identificador de membro especificado para o site atual.

Ponto de extremidade	/getuserbyid (<user id>)
Parâmetros	Tipo: Int32 a identificação do usuário.
HTTP method	GET
Resposta	Tipo: SP. Usuário usuário específico.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /getuserbyid(12)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método GetUserEffectivePermissions

Obtém as permissões efetivas que o usuário especificado possui no escopo de aplicativo atual.

Para verificar as permissões de um usuário diferente do usuário atual, aplicativos precisa ter permissões de Full Control do site.

Ponto de extremidade	/getusereffectivepermissions(@v) 2 _ @v ='<login name>'
Parâmetros	Tipo: String o nome de logon do usuário. Consulte o usuário for formatos usados para passar nomes de logon na sequência de consulta.
HTTP method	GET
Resposta	Tipo: SP. BasePermissions as permissões do usuário especificada.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /getusereffectivepermissions(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método GetWebUrlFromPageUrl

Obtém a URL do site de uma URL da página. Método estático.

Ponto de extremidade	http://<site url>/_api/sp.web.getweburlfrompageurl(@v)?@v='<full page url>'
Parâmetros	Tipo: String a URL completa da página SharePoint, com URL caracteres codificados conforme necessário.
HTTP method	GET
Resposta	Tipo: String a URL completa do site SharePoint.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api
    /sp.web.getweburlfrompageurl(@v)?@v='https://contoso.sharepoint.com/subsite/_layouts/15/start.aspx'",
  method: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método LoadAndInstallApp

Carrega e instala um pacote de aplicativo neste site.

Este site deve ser habilitado para desenvolvimento remoto.

Ponto de extremidade	/loadandinstallapp
Parâmetros	appPackageStream Tipo: Stream o fluxo de pacote do app.
Método HTTP	POST
Resposta	Tipo: SP.AppInstance a instância do aplicativo.

Método LoadAndInstallAppInSpecifiedLocale

Carrega e instala um pacote de Aplicativo no site em uma localidade específica.

Ponto de extremidade	/loadandinstallappinspecifiedlocale
Parâmetros	appPackageStream Tipo: Stream o fluxo de pacote de aplicativo. installationLocaleLCID Tipo: Int32 o LCID da localidade usar para criar a instância do aplicativo.
HTTP method	POST
Resposta	Tipo: SP.AppInstance a instância do aplicativo.

Método LoadApp

Carrega um pacote de Aplicativo e cria uma instância a partir dele.

Ponto de extremidade	/loadapp
Parâmetros	appPackageStream Tipo: Stream o fluxo de pacote de aplicativo. installationLocaleLCID Tipo: Int32 o LCID da localidade usar para criar a instância do aplicativo.
HTTP method	POST
Resposta	Tipo: SP.AppInstance a instância do aplicativo.

Método MapToIcon

Retorna o nome do arquivo de imagem para o ícone que é usado para representar o arquivo especificado.

Ponto de extremidade	/maptoicon (filename, progid, size)
Parâmetros	filename Tipo: String o nome do arquivo. Se esse parâmetro estiver vazio, o servidor retorna uma sequência vazia. progid Tipo: String o ProgID do aplicativo que foi utilizado para criar o arquivo, em que o formulário OLEServerName.ObjectName (por exemplo, Excel.Sheet ou PowerPoint.Slide). Esta é a identificação usada pelo registro do Windows para identificar exclusivamente um objeto. size Tipo: Int32 o tamanho do ícone: 16 x 16 pixels = 0, 32 x 32 pixels = 1.
HTTP method	GET
Resposta	Tipo: String o nome do arquivo de imagem do ícone.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /maptoicon(filename='spectemplate.docx', progid='', size=0)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método ProcessExternalNotification

Processa uma notificação de um sistema externo.

Ponto de extremidade	/processexternalnotification
Parâmetros	stream Tipo: Stream a mensagem de notificação do sistema externo.
HTTP method	POST
Resposta	Tipo: String o status de processamento: Success indica processamento bem-sucedido, SubscriptionNotRequired indica que a inscrição não é mais necessária e pode ser excluída com segurança.

Método RegisterPushNotificationSubscriber

Registra o assinante para notificações por push sobre o site. Se o registro já existir, o token do serviço será atualizado com o novo valor.

Ponto de extremidade	/registerpushnotificationsubscriber (deviceappinstanceid, servicetoken)
Parâmetros	deviceappinstanceid Tipo: GUID o ID da instância do aplicativo do dispositivo. servicetoken Tipo: String o token fornecido pelo serviço de notificação para o dispositivo para receber notificações.
HTTP method	POST
Resposta	Tipo: SP.PushNotificationSubscriber o assinante de notificação de push registrados.

Método ResetRoleInheritance

Redefine a herança de função para o objeto protegível e herda atribuições de função do objeto protegível pai.

Ponto de extremidade	/resetroleinheritance
Parâmetros	Nenhum
HTTP method	POST
Resposta	Nenhuma

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web
    /resetroleinheritance",
  method: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

Método UnregisterPushNotificationSubscriber

Cancela o registro do assinante para notificações por push do site.

Ponto de extremidade	/unregisterpushnotificationsubscriber('<device app instance id>')
Parâmetros	Tipo: GUID o ID da instância do aplicativo do dispositivo.
HTTP method	POST
Resposta	Nenhuma

Representação do OData

O exemplo a seguir representa um recurso da Web no formato JSON.

    {"d":{
      "__metadata":{
        "id":"https://<site url>/_api/Web",
        "uri":"https://<site url>/_api/Web",
        "type":"SP.Web"
      },
      "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/_api/Web/FirstUniqueAncestorSecurableObject"}},
      "RoleAssignments":{"__deferred":{"uri":"https://<site url>/_api/Web/RoleAssignments"}},
      "AllProperties":{"__deferred":{"uri":"https://<site url>/_api/Web/AllProperties"}},
      "AssociatedMemberGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedMemberGroup"}},
      "AssociatedOwnerGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedOwnerGroup"}},
      "AssociatedVisitorGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedVisitorGroup"}},
      "AvailableContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/AvailableContentTypes"}},
      "AvailableFields":{"__deferred":{"uri":"https://<site url>/_api/Web/AvailableFields"}},
      "ContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/ContentTypes"}},
      "CurrentUser":{"__deferred":{"uri":"https://<site url>/_api/Web/CurrentUser"}},
      "DescriptionResource":{"__deferred":{"uri":"https://<site url>/_api/Web/DescriptionResource"}},
      "EventReceivers":{"__deferred":{"uri":"https://<site url>/_api/Web/EventReceivers"}},
      "Features":{"__deferred":{"uri":"https://<site url>/_api/Web/Features"}},
      "Fields":{"__deferred":{"uri":"https://<site url>/_api/Web/Fields"}},
      "Folders":{"__deferred":{"uri":"https://<site url>/_api/Web/Folders"}},
      "Lists":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists"}},
      "ListTemplates":{"__deferred":{"uri":"https://<site url>/_api/Web/ListTemplates"}},
      "Navigation":{"__deferred":{"uri":"https://<site url>/_api/Web/Navigation"}},
      "ParentWeb":{"__deferred":{"uri":"https://<site url>/_api/Web/ParentWeb"}},
      "PushNotificationSubscribers":{"__deferred":{"uri":"https://<site url>/_api/Web/PushNotificationSubscribers"}},
      "RecycleBin":{"__deferred":{"uri":"https://<site url>/_api/Web/RecycleBin"}},
      "RegionalSettings":{"__deferred":{"uri":"https://<site url>/_api/Web/RegionalSettings"}},
      "RoleDefinitions":{"__deferred":{"uri":"https://<site url>/_api/Web/RoleDefinitions"}},
      "RootFolder":{"__deferred":{"uri":"https://<site url>/_api/Web/RootFolder"}},
      "SiteGroups":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteGroups"}},
      "SiteUserInfoList":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteUserInfoList"}},
      "SiteUsers":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteUsers"}},
      "ThemeInfo":{"__deferred":{"uri":"https://<site url>/_api/Web/ThemeInfo"}},
      "TitleResource":{"__deferred":{"uri":"https://<site url>/_api/Web/TitleResource"}},
      "UserCustomActions":{"__deferred":{"uri":"https://<site url>/_api/Web/UserCustomActions"}},
      "Webs":{"__deferred":{"uri":"https://<site url>/_api/Web/Webs"}},
      "WebInfos":{"__deferred":{"uri":"https://<site url>/_api/Web/WebInfos"}},
      "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/_api/Web/WorkflowAssociations"}},
      "WorkflowTemplates":{"__deferred":{"uri":"https://<site url>/_api/Web/WorkflowTemplates"}},
      "AllowRssFeeds":true,
      "AppInstanceId":"d025f690-8281-4cb7-ab11-04793e232661",
      "Configuration":0,
      "Created":"2014-02-27T20:08:25",
      "CustomMasterUrl":"/_catalogs/masterpage/app.master",
      "Description":"",
      "DocumentLibraryCalloutOfficeWebAppPreviewersDisabled":false,
      "EnableMinimalDownload":false,
      "Id":"ba0bfd3d-ba13-4400-aacf-f60d56eecfbc",
      "Language":1033,
      "LastItemModifiedDate":"2014-02-27T20:08:28Z",
      "MasterUrl":"/_catalogs/masterpage/app.master",
      "QuickLaunchEnabled":true,
      "RecycleBinEnabled":true,
      "ServerRelativeUrl":"",
      "SyndicationEnabled":true,
      "Title":"ParseUm",
      "TreeViewEnabled":false,
      "UIVersion":15,
      "UIVersionConfigurationEnabled":false,
      "Url":"https://<site url>",
      "WebTemplate":"APP"
    }}

Recurso de WebCollection

URI do ponto de extremidade | Métodos | Representação do OData

Representa um conjunto de sites.

URI do ponto de extremidade

http://<site url>/_api/web/webs

Métodos HTTP com suporte

GET | POST

Exemplos de solicitação

Exemplo de solicitação GET: Obtenha todos os subsites em um site

$.ajax({
  url: "http://<site url>/_api/web/webs",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Exemplo de solicitação POST: Criar um site usando o método Add

$.ajax({
  url: "http://<site url>/_api/web/webs/add",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.WebCreationInformation' },
    'Title': 'Social Meetup', 'Url': 'social', 'WebTemplate': 'MPS#3',
    'UseSamePermissionsAsParentSite': true } }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Ou você pode usar o método Add do recurso de WebInformationCollection , conforme mostrado na criação de um site com o REST.

Consulte os exemplos de solicitação da Web para obter exemplos que mostram como alterar ou excluir um site.

Métodos WebCollection

Adicionar

Método Add

Adiciona um novo site à coleção.

Ponto de extremidade	/ Adicionar
Parâmetros	parameters Tipo: SP. WebCreationInformation as propriedades do novo site. Envie esse parâmetro no corpo da solicitação, como mostra o exemplo de solicitação.
HTTP method	POST
Resposta	Tipo: SP. Web do novo site.

Exemplo de solicitação

$.ajax({
  url: "http://<site url>/_api/web/webs
    /add",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.WebCreationInformation' },
    'Title': 'Social Meetup', 'Url': 'social', 'WebTemplate': 'MPS#3',
    'UseSamePermissionsAsParentSite': true } }",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Use o método GetAvailableWebTemplates para obter os nomes dos modelos de site disponíveis.

Representação do OData

O exemplo seguinte representa um recurso de WebCollection no formato JSON.

    {"d":{
      "results":[{
          "__metadata":{
            "id":"https://<site url>/_api/Web",
            "uri":"https://<site url>/_api/Web",
            "type":"SP.Web"
          },
          "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/_api/Web/FirstUniqueAncestorSecurableObject"}},
          "RoleAssignments":{"__deferred":{"uri":"https://<site url>/_api/Web/RoleAssignments"}},
          "AllProperties":{"__deferred":{"uri":"https://<site url>/_api/Web/AllProperties"}},
          "AssociatedMemberGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedMemberGroup"}},
          "AssociatedOwnerGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedOwnerGroup"}},
          "AssociatedVisitorGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedVisitorGroup"}},
          "AvailableContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/AvailableContentTypes"}},
          "AvailableFields":{"__deferred":{"uri":"https://<site url>/_api/Web/AvailableFields"}},
          "ContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/ContentTypes"}},
          "CurrentUser":{"__deferred":{"uri":"https://<site url>/_api/Web/CurrentUser"}},
          "DescriptionResource":{"__deferred":{"uri":"https://<site url>/_api/Web/DescriptionResource"}},
          "EventReceivers":{"__deferred":{"uri":"https://<site url>/_api/Web/EventReceivers"}},
          "Features":{"__deferred":{"uri":"https://<site url>/_api/Web/Features"}},
          "Fields":{"__deferred":{"uri":"https://<site url>/_api/Web/Fields"}},
          "Folders":{"__deferred":{"uri":"https://<site url>/_api/Web/Folders"}},
          "Lists":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists"}},
          "ListTemplates":{"__deferred":{"uri":"https://<site url>/_api/Web/ListTemplates"}},
          "Navigation":{"__deferred":{"uri":"https://<site url>/_api/Web/Navigation"}},
          "ParentWeb":{"__deferred":{"uri":"https://<site url>/_api/Web/ParentWeb"}},
          "PushNotificationSubscribers":{"__deferred":{"uri":"https://<site url>/_api/Web/PushNotificationSubscribers"}},
          "RecycleBin":{"__deferred":{"uri":"https://<site url>/_api/Web/RecycleBin"}},
          "RegionalSettings":{"__deferred":{"uri":"https://<site url>/_api/Web/RegionalSettings"}},
          "RoleDefinitions":{"__deferred":{"uri":"https://<site url>/_api/Web/RoleDefinitions"}},
          "RootFolder":{"__deferred":{"uri":"https://<site url>/_api/Web/RootFolder"}},
          "SiteGroups":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteGroups"}},
          "SiteUserInfoList":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteUserInfoList"}},
          "SiteUsers":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteUsers"}},
          "ThemeInfo":{"__deferred":{"uri":"https://<site url>/_api/Web/ThemeInfo"}},
          "TitleResource":{"__deferred":{"uri":"https://<site url>/_api/Web/TitleResource"}},
          "UserCustomActions":{"__deferred":{"uri":"https://<site url>/_api/Web/UserCustomActions"}},
          "Webs":{"__deferred":{"uri":"https://<site url>/_api/Web/Webs"}},
          "WebInfos":{"__deferred":{"uri":"https://<site url>/_api/Web/WebInfos"}},
          "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/_api/Web/WorkflowAssociations"}},
          "WorkflowTemplates":{"__deferred":{"uri":"https://<site url>/_api/Web/WorkflowTemplates"}},
          "AllowRssFeeds":true,
          "AppInstanceId":"9f85a4a6-3609-44d6-9427-e7a5f16ceeeb",
          "Configuration":0,
          "Created":"2013-10-03T19:45:27",
          "CustomMasterUrl":"/apppart/_catalogs/masterpage/app.master",
          "Description":"",
          "DocumentLibraryCalloutOfficeWebAppPreviewersDisabled":false,
          "EnableMinimalDownload":false,
          "Id":"2dbf86de-6538-4d1a-b4fe-2a8e9816d692",
          "Language":1033,
          "LastItemModifiedDate":"2013-10-03T19:45:30Z",
          "MasterUrl":"/apppart/_catalogs/masterpage/app.master",
          "QuickLaunchEnabled":true,
          "RecycleBinEnabled":true,
          "ServerRelativeUrl":"/apppart",
          "SyndicationEnabled":true,
          "Title":"apppart",
          "TreeViewEnabled":false,
          "UIVersion":15,
          "UIVersionConfigurationEnabled":false,
          "Url":"https://<site url>",
          "WebTemplate":"APP"
        },{
        "__metadata":{
          "id":"https://<site url>,
          "uri":"https://<site url>,
          "type":"SP.Web"
        },
          "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/FirstUniqueAncestorSecurableObject"}},
          "RoleAssignments":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RoleAssignments"}},
          "AllProperties":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AllProperties"}},
          "AssociatedMemberGroup":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AssociatedMemberGroup"}},
          "AssociatedOwnerGroup":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AssociatedOwnerGroup"}},
          "AssociatedVisitorGroup":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AssociatedVisitorGroup"}},
          "AvailableContentTypes":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AvailableContentTypes"}},
          "AvailableFields":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AvailableFields"}},
          "ContentTypes":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/ContentTypes"}},
          "CurrentUser":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/CurrentUser"}},
          "DescriptionResource":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/DescriptionResource"}},
          "EventReceivers":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/EventReceivers"}},
          "Features":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Features"}},
          "Fields":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Fields"}},
          "Folders":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Folders"}},
          "Lists":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Lists"}},
          "ListTemplates":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/ListTemplates"}},
          "Navigation":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Navigation"}},
          "ParentWeb":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/ParentWeb"}},
          "PushNotificationSubscribers":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/PushNotificationSubscribers"}},
          "RecycleBin":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RecycleBin"}},
          "RegionalSettings":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RegionalSettings"}},
          "RoleDefinitions":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RoleDefinitions"}},
          "RootFolder":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RootFolder"}},
          "SiteGroups":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/SiteGroups"}},
          "SiteUserInfoList":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/SiteUserInfoList"}},
          "SiteUsers":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/SiteUsers"}},
          "ThemeInfo":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/ThemeInfo"}},
          "TitleResource":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/TitleResource"}},
          "UserCustomActions":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/UserCustomActions"}},
          "Webs":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Webs"}},
          "WebInfos":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/WebInfos"}},
          "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/WorkflowAssociations"}},
          "WorkflowTemplates":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/WorkflowTemplates"}},
          "AllowRssFeeds":true,
          "AppInstanceId":"00000000-0000-0000-0000-000000000000",
          "Configuration":0,
          "Created":"2014-02-28T21:41:11",
          "CustomMasterUrl":"/TeamProjects/_catalogs/masterpage/seattle.master",
          "Description":"",
          "DocumentLibraryCalloutOfficeWebAppPreviewersDisabled":false,
          "EnableMinimalDownload":true,
          "Id":"3a37226d-8f0b-41bd-a720-6f63fd1e2abb",
          "Language":1033,
          "LastItemModifiedDate":"2014-02-28T21:41:23Z",
          "MasterUrl":"/TeamProjects/_catalogs/masterpage/seattle.master",
          "QuickLaunchEnabled":true,
          "RecycleBinEnabled":true,
          "ServerRelativeUrl":"/TeamProjects",
          "SyndicationEnabled":true,
          "Title":"Team projects",
          "TreeViewEnabled":false,
          "UIVersion":15,
          "UIVersionConfigurationEnabled":false,
          "Url":"https://<site url>/TeamProjects",
          "WebTemplate":"STS"
        },{
          ...
        }
      }]
    }}

Share via

Referência de API REST Webs

Sobre os exemplos de solicitação neste artigo

Recurso da Web

URI do ponto de extremidade

Métodos HTTP com suporte

Exemplos de solicitação

Propriedades da Web

Métodos da Web

Método ApplyTheme

Método ApplyWebTemplate

Método BreakRoleInheritance

Método DeleteObject

Método de DoesPushNotificationSubscriberExist

Método DoesUserHavePermissions

Método de EnsureUser

Método ExecuteRemoteLOB

Método GetAppBdcCatalog

Método GetAppBdcCatalogForAppInstance

Método de GetAppInstanceById

Método de GetAppInstancesByProductId

Método GetAvailableWebTemplates

Método GetCatalog

Método GetChanges

GetContextWebInformation

Método GetCustomListTemplates

Método GetDocumentLibraries

Método GetEntity

Método GetFileByServerRelativeUrl

Método GetFolderByServerRelativeUrl

Método GetList

Método GetPushNotificationSubscriber

Método GetPushNotificationSubscribersByArgs

Método GetPushNotificationSubscribersByUser

Método GetSubwebsFilteredForCurrentUser

Método GetUserById

Método GetUserEffectivePermissions

Método GetWebUrlFromPageUrl

Método LoadAndInstallApp

Método LoadAndInstallAppInSpecifiedLocale

Método LoadApp

Método MapToIcon

Método ProcessExternalNotification

Método RegisterPushNotificationSubscriber

Método ResetRoleInheritance

Método UnregisterPushNotificationSubscriber

Representação do OData

Recurso de WebCollection

URI do ponto de extremidade

Métodos HTTP com suporte

Exemplos de solicitação

Métodos WebCollection

Método Add

Representação do OData

Recursos adicionais

Recursos adicionais