Referência de API REST de arquivos e pastas

Artigo
09/21/2016

Saiba mais sobre a API REST para File, FileVersion, Foldere recursos relacionados.

Última alteração: quinta-feira, 17 de setembro de 2015

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

Sobre os exemplos de solicitação neste artigo

Os exemplos de solicitação neste artigo assumem que você está usando a biblioteca entre domínios (SP. RequestExecutor.js) para fazer solicitações entre domínios, para que eles usar SP.AppContextSite no ponto de extremidade URI. Consulte Acessar dados do SharePoint 2013 de suplementos usando a biblioteca de domínio cruzado para obter mais informações.

Antes de usar um exemplo de solicitação, faça o seguinte:

Alterar <app web url>, <host web url>e outros dados de espaço reservado como qualquer IDs, nomes ou caminhos de entidades de SharePoint.
Se você não estiver usando a biblioteca entre domínios, inclua um cabeçalho X-RequestDigest para enviar que o valor de digest de formulário em todas as solicitações de POSTAGEM e um cabeçalho de content-length POST solicita que enviar dados no corpo da solicitação.
Se você não estiver fazendo solicitações entre domínios, remova SP.AppContextSite(@target) e ?@target='<host web url>' o URI do ponto de extremidade.
Se você estiver usando OAuth, inclua um cabeçalho de Authorization ("Authorization": "Bearer " + <access token>) para enviar o token de acesso OAuth.
Remova as quebras de linha os valores de propriedade url e body nos exemplos a solicitação. Quebras de linha são adicionadas aos exemplos para facilitar a leitura.
Se desejar que o servidor retorne respostas no formato Atom, remova o cabeçalho "accept": "application/json; odata=verbose" .

Consulte os recursos adicionais para obter links para obter mais informações sobre como usar o serviço REST SharePoint, OAuth e a biblioteca entre domínios. Para obter informações sobre formatos de solicitação, consulte solicitações como REST diferem pelo ambiente e Propriedades usadas em solicitações REST .

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.

Explore a sintaxe REST SharePoint 2013 arquivos e pastas

Explore visualmente as listas de SharePoint 2013 e a sintaxe REST de itens de lista.

Explore a outros diagramas de sintaxe do REST SharePoint:

Listas e itens de lista | Usuários e grupos

Baixe o PDF combinado de todos os diagramas de sintaxe REST SharePoint.

Arquivo de recurso

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.

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

URI do ponto de extremidade

http://<site url>/_api/web/getfilebyserverrelativeurl('/<folder name>/<file name>')

Métodos HTTP com suporte

OBTER | PUT (recurso de mídia)

OBTER | EXCLUIR | POST (recurso de arquivo)

Exemplos de solicitação

Exemplo de solicitação GET: Obter o conteúdo do arquivo (recurso de mídia)

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/$value
    ?@target='<host web url>'",
  method: "GET",
  binaryStringResponseBody: true,
  success: successHandler,
  error: errorHandler
});

Exemplo de solicitação GET: Obter o metadados de arquivo

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

PUT solicitação exemplo: Atualizar o conteúdo do arquivo (recurso de mídia)

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.txt')/$value
    ?@target='<host web url>'",
  method: "POST",
  body: "Updated contents of the file go here",
  headers: { "X-HTTP-Method":"PUT" },
  success: successHandler,
  error: errorHandler
});

Check-out do arquivo primeiro para impedir que outros usuários alterem-lo. Então, verifique novamente no depois de fazer as alterações. Consulte o método de check-out e o método CheckIn.

Exemplo de solicitação de exclusão: Excluir um arquivo

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    ?@target='<host web url>'",
  method: "POST",
  headers: { "X-HTTP-Method":"DELETE" },
  success: successHandler,
  error: errorHandler
});

Ou você pode usar a Reciclagem método para remover o arquivo e obter o GUID do item reciclado.

Observação

Consulte o método Add para obter um exemplo que mostra como criar um arquivo e adicioná-lo para uma pasta.

Propriedades do arquivo

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/<property name>
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propriedade	Tipo	GRAVAÇÃO/LEITURA	Retornado por recurso	Descrição
Autor	SP.User	N	Não	Obtém um valor que especifica o usuário que adicionou o arquivo.
CheckedOutByUser	SP.User	N	Não	Obtém um valor que retorna o usuário que fez o check-out do arquivo.
CheckInComment	String	N	Sim	Obtém um valor que retorna o comentário usado quando um documento dá entrada em uma biblioteca de documentos.
CheckOutType	Int32	N	Sim	Obtém um valor que indica como é feito o check-out de um arquivo da biblioteca de documentos. Representa um valor de SP.CheckOutType : Online = 0; Off-line = 1; Nenhum = 2. O estado de check-out de um arquivo é independente do seu estado bloqueado.
ContentTag	String	N	Sim	Retorna uma versão interna de conteúdo, usada para validar igualdade de documentos para propósitos de leitura.
CustomizedPageStatus	Int32	N	Sim	Obtém um valor que especifica o status de personalização do arquivo. Representa um valor de SP.CustomizedPageStatus : nenhum = 0; Não personalizadas = 1; Personalizado = 2.
ETag	String	N	Sim	Obtém um valor que especifica o valor de ETag.
Existe	Boolean	N	Sim	Obtém um valor que especifica se o arquivo existe.
Comprimento	Int64	N	Sim	Obtém o tamanho do arquivo em bytes, excluindo o tamanho de quaisquer Web Parts usadas no arquivo.
Nível	Byte	N	Sim	Obtém um valor que especifica o nível de publicação e o nível de arquivo. Representa um valor de SP.FileLevel : publicado = 1; Rascunho = 2; Check-out = 255.
ListItemAllFields	SP.ListItem	N	Não	Obtém o valor que especifica os valores do campo de item de lista para o item de lista correspondente ao arquivo.
LockedByUser	SP.User	N	Não	Obtém um valor que retorna o usuário que possui o bloqueio atual no arquivo.
MajorVersion	Int32	N	Sim	Obtém um valor que especifica a versão principal do arquivo.
MinorVersion	Int32	N	Sim	Obtém um valor que especifica a versão secundária do arquivo.
ModifiedBy	SP.User	N	Não	Obtém um valor que retorna o usuário que modificou o arquivo pela última vez.
Nome	String	R	Sim	Obtém o nome do arquivo incluindo a extensão.
ServerRelativeUrl	String	N	Sim	Obtém a URL relativa do arquivo com base na URL para o servidor.
TimeCreated	DateTime	N	Sim	Obtém um valor que especifica a data em que o arquivo foi criado.
TimeLastModified	DateTime	N	Sim	Obtém um valor que especifica quando o arquivo foi modificado pela última vez.
Título	String	N	Sim	Obtém um valor que especifica o nome de exibição do arquivo.
UiVersion	Int32	N	Sim	Obtém um valor que especifica o identificador de versão do arquivo específico para a implementação.
UiVersionLabel	String	N	Sim	Obtém um valor que especifica o identificador de versão do arquivo específico da implementação.
Versões	SP.FileVersionCollection	N	Não	Obtém um valor que retorna uma coleção de objetos de versão de arquivo que representam as versões do arquivo.

Métodos de arquivo

Aprovar
CancelUpload
CheckIn
check-out
ContinueUpload
CopyTo
ExcluirObjeto
Negar
FinishUpload
GetLimitedWebPartManager
MoveTo
OpenBinaryStream
Publicar
Reciclar
SaveBinaryStream
StartUpload
UndoCheckOut
cancelamento de publicação

Aprovar

Aprova o arquivo enviado para aprovação de conteúdo com o comentário especificado.

Somente os documentos em listas que são habilitados para aprovação de conteúdo podem ser aprovados.

ponto de extremidade	/ Aprovar (comment)
Parâmetros	comment Tipo: String o comentário para a aprovação.
Método HTTP	postar
Resposta	Nenhum

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /approve(comment='Check-in comment for the approval.')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Método cancelUpload

Interrompe a sessão de carregamento de partes sem salvar os dados carregados. Se o arquivo ainda não existir na biblioteca, o arquivo parcialmente carregado será excluído. Use isto em resposta à ação do usuário (como uma solicitação para cancelar um carregamento) ou a um erro ou exceção.

Use o valor de uploadId passado para o método StartUpload que iniciou a sessão de carregamento.

Este método está atualmente disponível apenas no Office 365.

Endpoint	/cancelUpload (uploadId)
Parameters	uploadID Tipo: GUID o identificador exclusivo da sessão de carregamento.
HTTP method	postar
Response	Nenhum

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /cancelupload(uploadId=guid'GUID')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Método CheckIn

Faz o check-in de um arquivo em uma biblioteca de documentos com base no tipo de check-in.

Endpoint	/Checkin (comment, checkInType)
Parameters	comment Tipo: String um comentário para o check-in. Seu comprimento deve ser < = 1023. checkInType Tipo: Int32 o SP.CheckinType para o arquivo: MinorCheckIn = 0; MajorCheckIn = 1; OverwriteCheckIn = 2.
HTTP method	postar
Response	Nenhum

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /checkin(comment='Check-in comment.',checkintype=0)
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Método CheckOut

Faz o check-out do arquivo da biblioteca de documentos com base no tipo de check-out.

Endpoint	/Checkout
Parameters	Nenhum
HTTP method	postar
Response	Nenhum

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /checkout
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Método continueUpload

Continua a sessão de carregamento de partes com um fragmento adicional. O conteúdo do arquivo atual não será alterado.

Use o valor de uploadId passado para o método StartUpload que iniciou a sessão de carregamento.

Este método está atualmente disponível apenas no Office 365.

Endpoint	/continueupload (uploadId, fileOffset)
Parameters	uploadID Tipo: GUID o identificador exclusivo da sessão de carregamento. fileOffset Tipo: Int64 o tamanho do deslocamento no arquivo onde o fragmento é iniciado. Envie o conteúdo do arquivo (stream) no corpo da postagem.
HTTP method	postar
Response	Tipo: Int64 o tamanho dos dados carregados total em bytes.

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /continueupload(uploadId=guid'GUID',fileOffset=8388608)
    ?@target='<host web url>'",
  method: "POST",
  body: stream containing intermediate chunk of file
  success: successHandler,
  error: errorHandler
});

Método CopyTo

Copia o arquivo para a URL de destino.

ponto de extremidade	/CopyTo (strNewUrl, bOverWrite)
Parâmetros	strNewUrl Tipo: String a URL absoluta ou uma URL relativa de servidor do caminho do arquivo de destino para copiar. bOverWrite Tipo: Boolean true para substituir um arquivo com o mesmo nome no mesmo local; Caso contrário false.
HTTP method	postar
Resposta	Nenhum

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /copyto(strnewurl='/foldername/filename.docx',boverwrite=false)
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Método DeleteObject

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

Método Deny

Rejeita aprovação para um arquivo que tenha sido enviado para aprovação de conteúdos.

Somente os documentos em listas que são habilitados para aprovação de conteúdo podem ser negados.

ponto de extremidade	/ Negar (comment)
Parâmetros	comment Tipo: String o comentário para a negação.
HTTP method	postar
Resposta	Nenhum

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /deny(comment='Check-in comment for the denial.')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Método finishUpload

Carrega o último fragmento de arquivo e confirma o arquivo. O conteúdo do arquivo atual será alterado quando este método for concluído.

Use o valor de uploadId passado para o método StartUpload que iniciou a sessão de carregamento.

Este método está atualmente disponível apenas no Office 365.

Endpoint	/finishupload (uploadId, fileOffset)
Parameters	uploadID Tipo: GUID o identificador exclusivo da sessão de carregamento. fileOffset Tipo: Int64 o tamanho do deslocamento no arquivo onde o fragmento é iniciado. Envie o conteúdo do arquivo (stream) no corpo da postagem.
HTTP method	postar
Response	Tipo: SP. Arquivo o arquivo acabou de ser carregado.

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /finishupload(uploadId=guid'GUID',fileOffset=125829120)
    ?@target='<host web url>'",
  method: "POST",
  body: stream containing final chunk of file
  success: successHandler,
  error: errorHandler
});

Método GetLimitedWebPartManager

Especifica a coleção de controles usada para acessar, modificar ou adicionar Web Parts associadas a esta Página de Web Parts e modo de exibição.

Uma exceção é lançada se o arquivo não é uma página ASPX.

ponto de extremidade	/getlimitedwebpartmanager (scope)
Parâmetros	scope Tipo: Int32 no modo de exibição SP.WebParts.PersonalizationScope a Web Parts page. Usuário = 0; Shared = 1.
HTTP method	Get
Resposta	Tipo: SP.WebParts.LimitedWebPartManager o conjunto de controle associado usado para acessar, modificar ou adicionar Web Parts.

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/fileName.aspx')
    /getlimitedwebpartmanager(scope=0)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método MoveTo

Move o arquivo para a URL de destino especificada.

ponto de extremidade	/MoveTo (newUrl, flags)
Parâmetros	newUrl Tipo: String a URL absoluta ou uma URL relativa de servidor do caminho do arquivo de destino para mover para. flags Tipo: Int32 o valor de bit a bit SP.MoveOperations como mover o arquivo. Substituir = 1; AllowBrokenThickets (mover mesmo se os arquivos de suporte são separados do arquivo exe) = 8.
HTTP method	postar
Resposta	Nenhum

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /moveto(newurl='/Other Folder/filename.docx',flags=1)
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Método OpenBinaryStream

Abre o arquivo como um fluxo.

ponto de extremidade	/openbinarystream
Parâmetros	Nenhum
HTTP method	Get
Resposta	Tipo: Stream o fluxo de arquivo especificado.

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /openbinarystream
    ?@target='<host web url>'",
  method: "GET",
  binaryStringResponseBody: true,
  success: successHandler,
  error: errorHandler
});

Observação

Ou você pode usar $value do recurso para o arquivo para abrir um arquivo. Exemplo: …/getfilebyserverrelativeurl('/Shared Documents/filename.docx')/$value.

Método Publish

Envia o arquivo para aprovação de conteúdo com o comentário especificado.

ponto de extremidade	/ Publicar (comment)
Parâmetros	comment Tipo: String o comentário para o arquivo publicado. Seu comprimento deve ser < = 1023.
HTTP method	postar
Resposta	Nenhuma

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /publish(comment='Check-in comment for the publish operation.')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Reciclar o método

Move o arquivo para a Lixeira e retorna o identificador do novo item de Lixeira.

ponto de extremidade	/Recycle
Parâmetros	Nenhum
HTTP method	postar
Resposta	Tipo: GUID o GUID do arquivo reciclado.

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /recycle
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método SaveBinaryStream

ponto de extremidade	/savebinary
Parâmetros	Envie o conteúdo do arquivo (stream) no corpo da postagem.
HTTP method	postar
Resposta	Nenhum

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /savebinarystream
    ?@target='<host web url>'",
  method: "POST",
  body: "This is the new content.",
  success: successHandler,
  error: errorHandler
});

Método startUpload

Inicia uma nova sessão de carregamento de bloco e carrega o fragmento do primeiro. O conteúdo do arquivo atual não é alterado quando esse método for concluído. O método é idempotente (e, portanto, não altera o resultado) desde que você usa os mesmos valores para uploadId e stream. A sessão de carregamento termina quando você usar o método CancelUpload ou quando você concluir com êxito a sessão de carregamento, passando o restante do conteúdo do arquivo por meio dos métodos ContinueUpload e FinishUpload .

Por exemplo, você pode passar um arquivo de 35 MB, dividindo-lo em três fluxos de 10 MB e um fluxo de 5 MB e carregando-os dessa maneira (usando os valores de deslocamento resultantes de 10, 20 e 30 MB):

startUpload stream1 (GUID)
continueUpload (GUID, 10 MB, stream2)
continueUpload (GUID, 20 MB, stream3)
finishUpload (GUID, 30 MB, stream4)

Os métodos StartUpload e ContinueUpload retornam o tamanho da soma acumulada de dados carregados em bytes, para que você pode passar os valores de retorno para usos subseqüentes do ContinueUpload e FinishUpload.

Este método está atualmente disponível apenas no Office 365.

Endpoint	/startUpload (uploadId)
Parameters	uploadID Tipo: GUID o identificador exclusivo da sessão de carregamento. Envie o conteúdo do arquivo (stream) no corpo da postagem.
HTTP method	postar
Response	Tipo: Int64 o tamanho dos dados carregados em bytes.

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /startupload(uploadId=guid'GUID')
    ?@target='<host web url>'",
  method: "POST",
  body: stream containing first chunk of file
  success: successHandler,
  error: errorHandler
});

Método UndoCheckOut

Reverte um check-out existente para o arquivo.

ponto de extremidade	/Undocheckout
Parâmetros	Nenhum
HTTP method	postar
Resposta	Nenhum

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /undocheckout
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Método de cancelamento de publicação

Remove o arquivo da aprovação de conteúdo ou cancela a publicação de uma versão principal.

ponto de extremidade	/ cancelamento de publicação
Parâmetros	comment Tipo: String o comentário para a operação unpublish. Seu comprimento deve ser < = 1023.
HTTP method	postar
Resposta	Nenhum

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /unpublish(comment='Check-in comment for the unpublish operation.')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Representação de OData

O exemplo a seguir representa um recurso de arquivo no formato JSON.

    {"d":{
      "__metadata":{,
        "id":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared Documents/folderName/fileName.docx')",
        "uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName.docx')",
        "type":"SP.File"
      },
      "Author":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName.docx')/Author"}},
      "CheckedOutByUser":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName.docx')/CheckedOutByUser"}},
      "ListItemAllFields":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName.docx')/ListItemAllFields"}},
      "LockedByUser":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName.docx')/LockedByUser"}},
      "ModifiedBy":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName.docx')/ModifiedBy"}},
      "Versions":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName.docx')/Versions"}},
      "CheckInComment":"Revisions to the file.",
      "CheckOutType":2,
      "ContentTag":"{2FBB0C3C-4059-41A2-A5CF-3E076EA0A94C},2,3",
      "CustomizedPageStatus":0,
      "ETag":"\"{2FBB0C3C-4059-41A2-A5CF-3E076EA0A94C},2\"",
      "Exists":true,
      "Length":"20609",
      "Level":1,
      "MajorVersion":1,
      "MinorVersion":0,
      "Name":"fileName.docx",
      "ServerRelativeUrl":"/Shared Documents/folderName/fileName.docx",
      "TimeCreated":"2013-05-16T21:01:23Z",
      "TimeLastModified":"2013-05-18T04:57:32Z",
      "Title":"",
      "UIVersion":512,
      "UIVersionLabel":"1.0"
    }}

Recurso de FileCollection

Representa uma coleção de recursos File.

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

URI do ponto de extremidade

http://<site url>/_api/web/getfolderbyserverrelativeurl('/<folder name>')/files

Métodos HTTP com suporte

OBTER | POST

Exemplos de solicitação

Exemplo de solicitação GET: Obtenha os metadados de todos os arquivos em uma pasta

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')/files
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Exemplo de solicitação GET: Obter o conteúdo do arquivo (recurso de mídia) pelo nome de arquivo

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')/files('filename.docx')/$value
    ?@target='<host web url>'",
  method: "GET",
  binaryStringResponseBody: true,
  success: successHandler,
  error: errorHandler
});

Exemplo de solicitação GET: Obter o metadados de arquivo

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')/files('filename.docx')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
};

Veja exemplos de solicitação de arquivo para obter exemplos de como recuperar um arquivo usando o ponto de extremidade GetFileByServerRelativeUrl e como atualizar e excluir um arquivo. Para criar um arquivo, consulte o método Add.

Métodos de FileCollection

Adicionar
AddTemplateFile
GetByUrl

Método Add

ponto de extremidade	/ Adicionar (content, overwrite, url)
Parâmetros	content Tipo: Stream o conteúdo do arquivo. Passe o parâmetro content no corpo da solicitação. O tamanho máximo de um arquivo binário que você pode adicionar usando a API REST é 2 GB. overwrite Tipo: Boolean true para substituir o arquivo se ele já existir; Caso contrário false. url Tipo: String a URL relativa à pasta do arquivo.
HTTP method	postar
Resposta	Tipo: SP. Arquivo o novo arquivo.

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')/files
    /add(overwrite=true,url='filename.txt')
    ?@target='<host web url>'",
  method: "POST",
  body: "Contents of the file go here",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

O exemplo a seguir mostra como carregar um arquivo binário usando a biblioteca entre domínios, que requer a converter o fluxo de arquivos em uma cadeia de caracteres. Para obter um exemplo de jQuery, consulte Carregar um arquivo usando a API REST e jQuery.

function addFile(arrayBuffer) { 
    var executor = new SP.RequestExecutor(appWebUrl);

    // Construct the endpoint.
    // The GetList method is available for SharePoint Online only. 
    var fileCollectionEndpoint = String.format(
         "{0}/_api/sp.appcontextsite(@target)/web/getlist('{1}')/" +
         "rootfolder/files/add(overwrite=true, url='{2}')?@target='{3}'",
         appWebUrl, listName, fileName, hostWebUrl);

    var fileData = '';
    var byteArray = new Uint8Array(arrayBuffer);
    for (var i = 0; i < byteArray.byteLength; i++) {
        fileData += String.fromCharCode(byteArray[i]);
    }

    // Send the request.
    executor.executeAsync({
        url: fileCollectionEndpoint,
        method: "POST",
        body: fileData,
        binaryStringRequestBody: true,
        headers: {"accept":"application/json;odata=verbose"},
        success: function (data) {
            alert('File upload succeeded.');
        },
        error: function (err) {
            alert('Error: ' + err.responseText);
        }
    });
}

Método AddTemplateFile

Adiciona um arquivo fantasma a uma lista existente ou biblioteca de documentos.

ponto de extremidade	/addTemplateFile(urlOfFile,templateFileType)
Parâmetros	urlOfFile Tipo: String a URL relativa de servidor onde você deseja salvar o arquivo. templateFileType Tipo: Int32 SP.TemplateFileType a ser usado para criar o arquivo: StandardPage = 0; WikiPage = 1; FormPage = 2.
HTTP method	postar
Resposta	Tipo: SP. Arquivo o arquivo de modelo que foi adicionado.

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents')/files
    /addtemplatefile(urloffile='/Shared Documents/newwikipage.aspx',templatefiletype=1)
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método GetByUrl

Obtém o arquivo da URL especificada.

O ponto de extremidade GetFileByServerRelativeUrl é recomendável a maneira de obter um arquivo. Consulte SP. Exemplos de solicitação de arquivo.

ponto de extremidade	/getbyurl('<name or server-relative url of file>')
Parâmetros	Nenhum
HTTP method	Get
Resposta	Tipo: SP. Arquivo o arquivo na URL especificada.

Exemplos de solicitação

Obter o conteúdo do arquivo (recurso de mídia)

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/foldername')/files
    /getbyurl('filename.docx')/$value
    ?@target='<host web url>'",
  method: "GET",
  binaryStringResponseBody: true,
  success: successHandler,
  error: errorHandler
});

Obtenha os metadados de um arquivo (Recurso de arquivo)

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/foldername')/files
    /getbyurl('filename.docx')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Consulte exemplos de solicitação de arquivo e exemplos de solicitação de FileCollection para ver outras maneiras de deixar um arquivo.

Representação de OData

O exemplo a seguir representa um recurso de FileCollection no formato JSON.

    {"d":{
      "results":[{
        "__metadata":{
          "id":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared Documents/folderName/fileName1.docx')",
          "uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName1.docx')",
          "type":"SP.File"
        },
        "Author":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName1.docx')/Author"}},
        "CheckedOutByUser":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName1.docx')/CheckedOutByUser"}},
        "ListItemAllFields":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName1.docx')/ListItemAllFields"}},
        "LockedByUser":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName1.docx')/LockedByUser"}},
        "ModifiedBy":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName1.docx')/ModifiedBy"}},
        "Versions":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName1.docx')/Versions"}},
        "CheckInComment":"",
        "CheckOutType":2,
        "ContentTag":"{2FBB0C3C-4059-41A2-A5CF-3E076EA0A94C},4,7",
        "CustomizedPageStatus":0,
        "ETag":"\"{2FBB0C3C-4059-41A2-A5CF-3E076EA0A94C},4\"",
        "Exists":true,
        "Length":"20609",
        "Level":1,
        "MajorVersion":1,
        "MinorVersion":0,
        "Name":"fileName1.docx",
        "ServerRelativeUrl":"/Shared Documents/folderName/fileName1.docx",
        "TimeCreated":"2013-05-16T21:01:23Z",
        "TimeLastModified":"2013-06-09T02:38:14Z",
        "Title":"Title of fileName1",
        "UIVersion":512,
        "UIVersionLabel":"1.0"
        },{
        "__metadata":{
          "id":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared Documents/folderName/fileName2.docx')",
          "uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName2.docx')",
          "type":"SP.File"
        },
        "Author":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName2.docx')/Author"}},
        "CheckedOutByUser":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName2.docx')/CheckedOutByUser"}},
        "ListItemAllFields":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName2.docx')/ListItemAllFields"}},
        "LockedByUser":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName2.docx')/LockedByUser"}},
        "ModifiedBy":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName2.docx')/ModifiedBy"}},
        "Versions":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName2.docx')/Versions"}},
        "CheckInComment":"",
        "CheckOutType":2,
        "ContentTag":"{E654B970-C4BF-4DC5-9719-B5B01CAD6FD9},4,9",
        "CustomizedPageStatus":0,
        "ETag":"\"{E654B970-C4BF-4DC5-9719-B5B01CAD6FD9},4\"",
        "Exists":true,
        "Length":"12263",
        "Level":1,
        "MajorVersion":1,
        "MinorVersion":0,
        "Name":"fileName2.docx",
        "ServerRelativeUrl":"/Shared Documents/folderName/fileName2.docx",
        "TimeCreated":"2013-05-18T05:01:51Z",
        "TimeLastModified":"2013-06-09T02:38:59Z",
        "Title":"Title of fileName2",
        "UIVersion":512,
        "UIVersionLabel":"1.0"
      }]}}

Recursos FileVersion

Representa uma versão de um recurso File.

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

URI do ponto de extremidade

http://<site url>/_api/web/getfilebyserverrelativeurl('/<folder name>/<file name>')/versions (<version id>)

Métodos HTTP com suporte

OBTER | POST | EXCLUIR

Exemplos de solicitação

Exemplo de solicitação GET: Obtenha os metadados para uma versão do arquivo

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions(512)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Exemplo de solicitação de exclusão: Excluir uma versão específica de um arquivo

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions(513)
    ?@target='<host web url>'",
  method: "POST",
  headers: { "X-HTTP-Method":"DELETE" },
  success: successHandler,
  error: errorHandler
});

Propriedades FileVersion

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /versions(512)/<property name>
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Propriedade	Tipo	GRAVAÇÃO/LEITURA	Retornado por recurso	Descrição
CheckInComment	String	N	Sim	Obtém um valor que especifica o comentário de check-in.
Criado	DateTime	N	Sim	Obtém um valor que especifica a data e hora de criação da versão do arquivo.
CreatedBy	SP.User	N	Não	Obtém um valor que especifica o usuário que representa o criador da versão de arquivo.
ID	Int32	N	Sim	Obtém o identificador interno da versão de arquivo.
IsCurrentVersion	Boolean	N	Sim	Obtém um valor que especifica se a versão do arquivo é a versão atual.
Tamanho	Int32	N	Sim
Url	String	N	Sim	Obtém um valor que especifica a URL relativa da versão do arquivo com base na URL para o site ou subsite.
VersionLabel	String	N	Sim	Obtém um valor que especifica o identificador específico da implementação do arquivo. Usa o majorVersionNumber. Formatar minorVersionNumber , por exemplo: 1.2.

Métodos de FileVersion

DeleteObject

Método DeleteObject

A maneira recomendada para excluir uma versão do arquivo é enviar uma solicitação de DELETE ao ponto de extremidade de recurso FileVersion , conforme mostrado nos exemplos de solicitação FileVersion.

Representação de OData

O exemplo a seguir representa um recurso de FileVersion no formato JSON.

    {"d":{
      "__metadata":{,
        "id":"http://<site url>/_api/web/getfilebyserverrelativeurl('/Shared Documents/folderName/fileName1.docx')/versions(512)",
        "uri":"http://<site url>/_api/web/getfilebyserverrelativeurl('/Shared%20Documents/folderName/fileName1.docx')/versions(512)",
        "type":"SP.FileVersion"
      },
      "CreatedBy":{"__deferred":{"uri":"http://<site url>/_api/web/getfilebyserverrelativeurl('/Shared%20Documents/folderName/fileName1.docx')/versions(512)/CreatedBy"}},
      "CheckInComment":"Revisions to the file.",
      "Created":"2013-06-10T04:02:53Z",
      "ID":512,
      "IsCurrentVersion":true,
      "Size":20609,
      "Url":"_vti_history/512/Shared Documents/folderName/fileName1.docx",
      "VersionLabel":"1.0"
    }}

Recurso de FileVersionCollection

Representa uma coleção de recursos FileVersion.

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

URI do ponto de extremidade

http://<site url>/_api/web/getfilebyserverrelativeurl('/<folder name>/<file name>')/versions

Métodos HTTP

Este recurso suporta os seguintes métodos HTTP:

OBTER | POST

Exemplo de solicitação

Exemplo de solicitação GET: Obtenha os metadados para todas as versões de um arquivo

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Exemplo de solicitação GET: Obtenha os metadados para uma versão do arquivo

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions(512)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Métodos de FileVersionCollection

DeleteAll
DeleteById
DeleteByLabel
GetById
RestoreByLabel

Método DeleteAll

Exclui todos os objetos de versão de arquivo da coleção.

ponto de extremidade	/DeleteAll
Parâmetros	Nenhum
HTTP method	postar
Resposta	Nenhum

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions
    /deleteall
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Método DeleteById

Exclui a versão especificada do arquivo.

ponto de extremidade	/deletebyid (vid)
Parâmetros	vid Tipo: Int32 identificação da versão do arquivo para excluir.
HTTP method	postar
Resposta	Nenhum

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions
    /deletebyid(vid=3)
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Método DeleteByLabel

Exclui o objeto de versão de arquivo com o rótulo de versão especificado.

ponto de extremidade	/deletebylabel (versionlabel)
Parâmetros	versionlabel Tipo: String a propriedade SP.FileVersion.VersionLabel da versão do arquivo para excluir.
HTTP method	postar
Resposta	Nenhum

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions
    /deletebylabel(versionlabel='1.2')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Método GetById

ponto de extremidade	/GetByID (versionid)
Parâmetros	versionid Tipo: Int32 a identificação da versão do arquivo a ser obtido.
HTTP method	Get
Resposta	Tipo: SP. FileVersion a versão do arquivo especificado.

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions
    /getbyid(512)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Ou você pode passar a identificação da versão diretamente à coleção (…/versions(512)). Veja exemplos de solicitação de FileVersionCollection.

Método RestoreByLabel

Obtém uma nova versão de arquivo a partir do arquivo especificado pelo rótulo de versão.

ponto de extremidade	/restorebylabel (versionlabel)
Parâmetros	versionlabel Tipo: String a propriedade SP.FileVersion.VersionLabel da versão do arquivo para restaurar.
HTTP method	postar
Resposta	Nenhum

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions
    /restorebylabel(versionlabel='1.2')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Representação de OData

O exemplo a seguir representa um recurso de FileVersionCollection no formato JSON.

    {"d":{
      "results":[{
        "__metadata":{
          "id":"http://<site url>/_api/SP.FileVersiona6a6bb00-2b96-41e6-a901-46df015183b9",
          "uri":"http://<site url>/_api/SP.FileVersiona6a6bb00-2b96-41e6-a901-46df015183b9",
          "type":"SP.FileVersion"
        },
        "CreatedBy":{"__deferred":{"uri":"http://<site url>/_api/SP.FileVersiona6a6bb00-2b96-41e6-a901-46df015183b9/CreatedBy"}},
        "CheckInComment":"",
        "Created":"2013-06-10T04:02:53Z",
        "ID":512,
        "IsCurrentVersion":true,
        "Size":20609,
        "Url":"_vti_history/512/Shared Documents/folderName/fileName1.docx",
        "VersionLabel":"1.0"
        },{
        "__metadata":{
          "id":"http://<site url>/_api/SP.FileVersion6accd876-7579-47b6-9779-19a24f6ab8a1",
          "uri":"http://<site url>/_api/SP.FileVersion6accd876-7579-47b6-9779-19a24f6ab8a1",
          "type":"SP.FileVersion"
        },
        "CreatedBy":{"__deferred":{"uri":"http://<site url>/_api/SP.FileVersion6accd876-7579-47b6-9779-19a24f6ab8a1/CreatedBy"}},
        "CheckInComment":"Revisions to the file.",
        "Created":"2013-06-11T17:42:41Z",
        "ID":513,
        "IsCurrentVersion":false,
        "Size":17973,
        "Url":"_vti_history/513/Shared Documents/folderName/fileName1.docx",
        "VersionLabel":"1.1"
      }]}}

Recursos de pasta

Representa uma pasta em um site do SharePoint.

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

URI do ponto de extremidade

http://<site url>/_api/web/getfolderbyserverrelativeurl('/<folder name>')

Métodos HTTP com suporte

OBTER | POST | EXCLUIR | MESCLAR | PUT

Exemplos de solicitação

Exemplo de solicitação GET: Obtenha uma pasta

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Exemplo de solicitação de mesclagem: Alterar uma pasta

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata':{ 'type': 'SP.Folder' }, 'WelcomePage':'Folder B/WelcomePage.aspx' }",
  headers: {
    "content-type": "application/json; odata=verbose",
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Exemplo de solicitação de exclusão: Excluir uma pasta

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')
    ?@target='<host web url>'",
  method: "POST",
  headers: { "X-HTTP-Method":"DELETE" },
  success: successHandler,
  error: errorHandler
});

Veja exemplos de solicitação FolderCollection para obter um exemplo de como criar uma pasta.

Propriedades de pasta

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')/<property name>
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Para definir uma propriedade gravável, obtenha o recurso, defina o valor da propriedade no corpo e use o método MERGE no recurso para mesclar suas alterações ou use o método PUT para substituir o recurso. Veja exemplos de solicitação de pasta para ver um exemplo.

Propriedade	Tipo	GRAVAÇÃO/LEITURA	Retornado por recurso	Descrição
ContentTypeOrder	Collection(SP.ContentTypeId)	N	Sim	Especifica a sequência nas quais os tipos de conteúdo são exibidos.
Arquivos	SP.FileCollection	N	Não	Obtém a coleção de todos os arquivos contidos na pasta da lista. Você pode adicionar um arquivo para uma pasta, usando o método Add no recurso de FileCollection da pasta.
Pastas	SP.FolderCollection	N	Não	Obtém a coleção de pastas de lista contidas na pasta de lista.
ItemCount	Int32	N	Sim	Obtém o valor que especifica a contagem de itens na pasta de lista.
ListItemAllFields	SP.ListItem	N	Não	Especifica os valores (2) do campo do item de lista para o item de lista correspondente ao arquivo.
Nome	String	N	Sim	Obtém o nome da pasta.
ParentFolder	SP.Folder	N	Não	Obtém a pasta de lista pai da pasta.
Propriedades	SP.PropertyValues	N	Não	Obtém uma coleção de todos os arquivos contidos na pasta.
ServerRelativeUrl	String	N	Sim	Obtém a URL relativa do servidor da pasta de lista.
UniqueContentTypeOrder	Collection(SP.ContentTypeId)	RW	Sim	Obtém ou define um valor que especifica a ordem de tipo de conteúdo.
WelcomePage	String	RW	Sim	Obtém ou define um valor que especifica a URL relativa à pasta para a página inicial de pasta da lista.

Métodos de pasta

ExcluirObjeto
Reciclar

Método DeleteObject

A maneira recomendada para excluir uma pasta é enviar uma solicitação de DELETE ao ponto de extremidade de recurso Folder , conforme mostrado nos exemplos de solicitação de pasta.

Reciclar o método

Move a pasta de lista para a Lixeira e retorna o identificador do novo item de Lixeira.

ponto de extremidade	/Recycle
HTTP method	postar
Parâmetros	Nenhum
Resposta	Tipo: GUID identificação da operação de reciclagem.

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')
    /recycle
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Representação de OData

O exemplo a seguir representa um recurso de pasta no formato JSON.

    {"d":{
      "__metadata":{,
        "id":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared Documents/Folder A')",
        "uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Folder%20A')",
        "type":"SP.Folder"
      },
      "Files":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Folder%20A')/Files"}},
      "ListItemAllFields":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Folder%20A')/ListItemAllFields"}},
      "ParentFolder":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Folder%20A')/ParentFolder"}},
      "Properties":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Folder%20A')/Properties"}},
      "Folders":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Folder%20A')/Folders"}},
      "ItemCount":7,
      "Name":"Folder A",
      "ServerRelativeUrl":"/Shared Documents/Folder A",
      "WelcomePage":""
    }}

Recurso de FolderCollection

Representa uma coleção de recursos Folder.

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

URI do ponto de extremidade

http://<site url>/_api/web/folders (pastas de nível superior no site da raiz)
http://<site url>/_api/web/getfolderbyserverrelativeurl('/<folder name>')/folders

Métodos HTTP com suporte

OBTER | POST

Exemplos de solicitação

Exemplo de solicitação GET: Obtenha as pastas no site da raiz

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/folders
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Exemplo de solicitação GET: Obtenha as pastas em uma biblioteca de documentos

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents')/folders
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Exemplo de solicitação GET: Fazer pelo nome a uma pasta

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')/folders('Folder B')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Exemplo de solicitação POST: Crie uma pasta (ou você pode usar o método Add)

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')/folders
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata':{ 'type': 'SP.Folder' }, 'ServerRelativeUrl':'Folder B' }",
  headers: {
    "accept": "application/json; odata=verbose",
    "content-type": "application/json; odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Veja exemplos de solicitação de pasta para obter exemplos de como atualizar e excluir uma pasta.

Métodos de FolderCollection

Adicionar
GetByUrl

Método Add

Adiciona a pasta que está localizada na URL especificada para a coleção.

ponto de extremidade	/ Adicionar (url)
Parâmetros	url Tipo: String o caminho onde você deseja adicionar a pasta (incluindo o nome da nova pasta) como uma URL totalmente qualificada, URL relativa de servidor ou URL relativa de site.
HTTP method	POST
Resposta	Tipo: SP. Pasta a pasta recém-adicionado.

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/folders
    /add('/Shared Documents/Folder A/Folder B')
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Método GetByUrl

ponto de extremidade	/getbyurl('<server-relative folder url>')
Parâmetros	Tipo: String a URL relativa de servidor da pasta.
HTTP method	Get
Resposta	Tipo: SP. Pasta na pasta especificada.

Exemplo de solicitação

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/folders
    /getbyurl('Folder B')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Você também pode passar um nome de pasta diretamente a uma coleção de pasta. Exemplo: …/folders('Folder B'). Veja exemplos de solicitação de FolderCollection.

Representação de OData

O exemplo a seguir representa um recurso de FolderCollection no formato JSON.

    {"d":{
      "results":[{
        "__metadata":{
          "id":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared Documents/Forms')",
          "uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Forms')",
          "type":"SP.Folder"
        },
        "Files":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Forms')/Files"}},
        "ListItemAllFields":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Forms')/ListItemAllFields"}},
        "ParentFolder":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Forms')/ParentFolder"}},
        "Properties":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Forms')/Properties"}},
        "Folders":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Forms')/Folders"}},
        "ItemCount":0,
        "Name":"Forms",
        "ServerRelativeUrl":"/Shared Documents/Forms",
        "WelcomePage":""
        },{
        "__metadata":{
          "id":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared Documents/folderName')",
          "uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/folderName')",
          "type":"SP.Folder"
        },
        "Files":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/folderName')/Files"}},
        "ListItemAllFields":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/folderName')/ListItemAllFields"}},
        "ParentFolder":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/folderName')/ParentFolder"}},
        "Properties":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/folderName')/Properties"}},
        "Folders":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/folderName')/Folders"}},
        "ItemCount":4,
        "Name":"folderName",
        "ServerRelativeUrl":"/Shared Documents/folderName",
        "WelcomePage":""
      }]}}

Referência de API REST de arquivos e pastas

Sobre os exemplos de solicitação neste artigo

Explore a sintaxe REST SharePoint 2013 arquivos e pastas

Arquivo de recurso

URI do ponto de extremidade

Métodos HTTP com suporte

Exemplos de solicitação

Propriedades do arquivo

Métodos de arquivo

Aprovar

Método cancelUpload

Método CheckIn

Método CheckOut

Método continueUpload

Método CopyTo

Método DeleteObject

Método Deny

Método finishUpload

Método GetLimitedWebPartManager

Método MoveTo

Método OpenBinaryStream

Método Publish

Reciclar o método

Método SaveBinaryStream

Método startUpload

Método UndoCheckOut

Método de cancelamento de publicação

Representação de OData

Recurso de FileCollection

URI do ponto de extremidade

Métodos HTTP com suporte

Exemplos de solicitação

Métodos de FileCollection

Método Add

Método AddTemplateFile

Método GetByUrl

Representação de OData

Recursos FileVersion

URI do ponto de extremidade

Métodos HTTP com suporte

Exemplos de solicitação

Propriedades FileVersion

Métodos de FileVersion

Método DeleteObject

Representação de OData

Recurso de FileVersionCollection

URI do ponto de extremidade

Métodos HTTP

Exemplo de solicitação

Métodos de FileVersionCollection

Método DeleteAll

Método DeleteById

Método DeleteByLabel

Método GetById

Método RestoreByLabel

Representação de OData

Recursos de pasta

URI do ponto de extremidade

Métodos HTTP com suporte

Exemplos de solicitação

Propriedades de pasta

Métodos de pasta

Método DeleteObject

Reciclar o método

Representação de OData

Recurso de FolderCollection

URI do ponto de extremidade

Métodos HTTP com suporte

Exemplos de solicitação

Métodos de FolderCollection

Método Add

Método GetByUrl

Representação de OData

Recursos adicionais

Recursos adicionais