SharePoint Incorporado
O Microsoft SharePoint Embedded é um sistema de gestão de ficheiros e documentos baseado na cloud, adequado para utilização em qualquer aplicação. O SharePoint Embedded é uma solução apenas com API que permite aos programadores de aplicações aproveitar o poder da plataforma de armazenamento de ficheiros e documentos Microsoft 365 para qualquer aplicação, sendo adequada para empresas que desenvolvem aplicações de linha de negócio e ISVs que criam aplicações multiinquilino.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Standard | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Standard | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Standard | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Microsoft |
| URL | https://learn.microsoft.com/en-us/sharepoint/dev/embedded/overview |
| spe-connector@service.microsoft.com |
| Metadados do conector | |
|---|---|
| Editora | Microsoft |
| Sítio Web | https://learn.microsoft.com/en-us/sharepoint/dev/embedded/overview |
| Política de privacidade | https://privacy.microsoft.com/ |
| Categorias | Conteúdo e Ficheiros |
Introdução
Antes de poderes usar o conector SharePoint Embededed, terás de criar uma aplicação SharePoint Embededed. Consulte a documentação do SharePoint Embedded para saber mais e começar.
Conceder Acesso ao Conector Incorporado do SharePoint
Para que o conector SharePoint Embedded interaja com contentores de armazenamento de ficheiros e conteúdos num tenant, terá de criar uma applicationPermissionGrant aplicação para o conector SharePoint Embedded nesse containerTypeRegistration tenant. Isto permite ao conector SharePoint Embedded aceder ao tipo específico de contentor da sua aplicação num inquilino.
Conceda full permissões ao ID e8e1b0bf-140f-4b8b-8e94-fbe8937fad04 da aplicação do conector SharePoint Embedded para delegated chamadas usando a API Microsoft Graph.
PUT /storage/fileStorage/containerTypeRegistrations/{containerTypeId}/applicationPermissionGrants/e8e1b0bf-140f-4b8b-8e94-fbe8937fad04
Content-Type: application/json
{
"delegatedPermissions": ["full"],
"applicationPermissions": ["none"]
}
Consulte o artigo de referência Create fileStorageContainerTypeAppAppPermissionConceder API para saber mais.
Problemas conhecidos e limitações
- O tamanho máximo suportado com a tarefa Criar ficheiro é de 10MB
- A criação de contentores não está disponível com o conector
- Apenas a autenticação delegada é suportada
Ações
| Apagar a versão do ficheiro |
Esta operação elimina uma versão específica de um ficheiro num contentor SharePoint Embededred. |
| Ativar contentor |
Ativar um contentor |
| Atualizar permissão de contentor |
Atualizar uma permissão num contentor |
| Atualizar propriedades personalizadas do contentor |
Atualizar propriedades personalizadas de um contentor |
| Campos de ficheiros de lista |
Esta operação recebe os campos de itens da lista (metadados) associados a um ficheiro num contentor SharePoint Embededed. |
| Coluna de contentor Delete |
Eliminar uma coluna que defina o esquema do contentor |
| Coluna de contentores Get |
Recolha uma coluna do recipiente |
| Colunas de contentor de lista |
Colunas de lista que definem o esquema do contentor |
| Conteúdo do ficheiro de atualização |
Esta operação atualiza o conteúdo de um ficheiro. |
| Contêiner de atualização |
Atualizar um contentor |
| Criar coluna contentor |
Crie uma coluna que defina o esquema do contentor |
| Criar ficheiro |
Esta operação cria um ficheiro e devolve os metadados do driveItem. |
| Criar link de partilha |
Esta operação cria um link de partilha para um ficheiro num contentor SharePoint Embededed. |
| Criar pasta |
Esta operação cria uma nova pasta num contentor SharePoint Embebed, seja ao nível raiz ou dentro de outra pasta. |
| Criar pré-visualização de ficheiros |
Esta operação cria uma pré-visualização de um ficheiro num contentor SharePoint Embededed. |
| Definir campos de ficheiro |
Esta operação atualiza os campos de itens da lista (metadados) associados a um ficheiro num contentor SharePoint Embededed. Use valores nulos para limpar valores de campo. |
| Eliminar contentor |
Excluir um contêiner |
| Eliminar ficheiro |
Esta operação elimina um ficheiro num contentor SharePoint Embededed. |
| Eliminar itens reciclados |
Esta operação elimina permanentemente um ou mais itens reciclados do contentor de reciclagem de um contentor SharePoint Embededed. |
| Eliminar recipiente reciclado |
Eliminar permanentemente um recipiente reciclado |
| Eliminar saída |
Esta operação descarta o check-out de um ficheiro num contentor SharePoint Embededed. |
| Enviar convite de partilha |
Esta operação envia um convite de partilha para um ficheiro num contentor SharePoint Embededed. |
| Fazer check-in do arquivo |
Esta operação verifica um ficheiro que foi requisitado num contentor SharePoint Embededed. |
| Fazer check-out do arquivo |
Esta operação faz check-out de um ficheiro num contentor SharePoint Embededed, o que impede que outros editem o documento. |
| Lista de itens no contentor |
Esta operação recebe a lista de ficheiros e subpastas num contentor. |
| Lista de itens reciclados |
Esta operação lista os itens no contentor de reciclagem de um contentor SharePoint Embebed. |
| Lista de recipientes reciclados |
Lista de recipientes reciclados |
| Listar contêineres |
Listar contêineres |
| Listar permissões de contentores |
Listar permissões num contentor |
| Miniaturas da lista |
Esta operação lista as miniaturas disponíveis para um ficheiro num contentor SharePoint Embededed. |
| Obtenha permissão de partilha |
Esta operação obtém uma permissão específica de partilha para um ficheiro num contentor SharePoint Embededed. |
| Obtenha propriedades personalizadas de contentores |
Obtenha propriedades personalizadas de um contentor |
| Obtenha um contentor |
Obtenha um contentor |
| Obter a versão do ficheiro |
Esta operação recebe uma versão específica de um ficheiro num contentor SharePoint Embededed. |
| Obter conteúdo de ficheiro |
Esta operação obtém o conteúdo de um arquivo. |
| Obter propriedades do arquivo |
Esta operação obtém as propriedades de um ficheiro num contentor SharePoint Embededed. |
| Obtém miniatura |
Esta operação recebe uma miniatura específica para um ficheiro num contentor SharePoint Embededed. |
| Permissão de apagar partilha |
Esta operação elimina uma permissão específica de partilha para um ficheiro num contentor SharePoint Embededed. |
| Permissão para criar contentor |
Crie uma permissão num contentor |
| Permissão para eliminar contentores |
Apagar uma permissão num contentor |
| Permissões de partilha de itens de lista |
Esta operação lista as permissões de partilha para um item num contentor SharePoint Embededed. |
| Renomear arquivo |
Esta operação renomeia um ficheiro num contentor SharePoint Embededed. |
| Restaurar itens reciclados |
Esta operação restaura um ou mais itens reciclados do contentor de reciclagem de um contentor SharePoint Embebed. |
| Restaurar recipientes reciclados |
Restaurar um recipiente reciclado |
| Versões dos ficheiros de lista |
Esta operação lista as versões anteriores de um ficheiro num contentor SharePoint Embededed. |
Apagar a versão do ficheiro
Esta operação elimina uma versão específica de um ficheiro num contentor SharePoint Embededred.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
|
ID da versão
|
version-id | True | string |
O identificador único da versão a eliminar |
Ativar contentor
Ativar um contentor
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O ID do contentor |
Atualizar permissão de contentor
Atualizar uma permissão num contentor
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O ID do contentor |
|
ID de Permissão
|
permission-id | True | string |
O ID de permissão |
|
Funções de Permissão
|
roles | True | array of string |
Os papéis a atribuir ao utilizador |
Regressos
Atualizar propriedades personalizadas do contentor
Atualizar propriedades personalizadas de um contentor
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O ID do contentor |
|
|
object |
Regressos
Campos de ficheiros de lista
Esta operação recebe os campos de itens da lista (metadados) associados a um ficheiro num contentor SharePoint Embededed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
ETag
|
@odata.etag | string |
O valor ETag para os campos |
Coluna de contentor Delete
Eliminar uma coluna que defina o esquema do contentor
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O ID do contentor |
|
Identificador da Coluna
|
column-id | True | string |
O ID da coluna |
Coluna de contentores Get
Recolha uma coluna do recipiente
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O ID do contentor |
|
Identificador da Coluna
|
column-id | True | string |
O ID da coluna |
Regressos
Colunas de contentor de lista
Colunas de lista que definem o esquema do contentor
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O ID do contentor |
|
Filter
|
$filter | string |
O filtro a aplicar aos resultados |
Regressos
Conteúdo do ficheiro de atualização
Esta operação atualiza o conteúdo de um ficheiro.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
Conteúdo do ficheiro (Base64)
|
body | True | byte |
Conteúdo do arquivo codificado Base64 |
Regressos
O conteúdo do ficheiro
- Conteúdo do ficheiro
- binary
Contêiner de atualização
Atualizar um contentor
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O ID do contentor |
|
Description
|
description | string |
Descrição do contentor |
|
|
Nome de exibição
|
displayName | string |
O nome do contêiner |
|
|
OCR Ativado
|
isOcrEnabled | boolean |
Se o OCR (Reconhecimento Ótico de Caracteres) está ativado para o contentor |
|
|
Limite de Versões Menores de Itens
|
itemMinorVersionLimit | integer |
O número máximo de versões menores a manter para os itens no contentor |
|
|
Versionamento de Itens Ativado
|
isItemVersioningEnabled | boolean |
Se a versão dos itens está ativada para o contentor |
Regressos
- Body
- FileStorageContainer
Criar coluna contentor
Crie uma coluna que defina o esquema do contentor
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O ID do contentor |
|
|
object |
Regressos
Criar ficheiro
Esta operação cria um ficheiro e devolve os metadados do driveItem.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do pai
|
parent-id | True | string |
ID do item da unidade da pasta pai, ou 'root' |
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
Nome do arquivo
|
file-name | True | string |
O nome do arquivo |
|
Conteúdo do ficheiro (Base64)
|
body | True | byte |
Conteúdo do arquivo codificado Base64 |
Regressos
Metadados dos itens da unidade
- Body
- DriveItem
Criar link de partilha
Esta operação cria um link de partilha para um ficheiro num contentor SharePoint Embededed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
|
Tipo de link
|
type | True | string |
O tipo de link de partilha para criar. |
|
Escopo do link
|
scope | string |
O âmbito do link de partilha |
|
|
Data de validade
|
expirationDateTime | date-time |
A data e hora em que o link expira (yyyy-MM-ddTHH:mm:ssZ) |
Regressos
Representa um link de partilha para um ficheiro ou pasta
- Body
- SharingLink
Criar pasta
Esta operação cria uma nova pasta num contentor SharePoint Embebed, seja ao nível raiz ou dentro de outra pasta.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID da pasta principal
|
parent-id | True | string |
O ID da pasta principal onde a nova pasta será criada. Use 'root' para criar uma pasta ao nível raiz do contentor ou forneça um ID de pasta específico para criar uma pasta aninhada. |
|
Nome da pasta
|
name | True | string |
O nome da pasta a criar |
|
Comportamento de Conflito
|
@microsoft.graph.conflictBehavior | string |
O que fazer se já existir uma pasta com o mesmo nome |
Regressos
Metadados dos itens da unidade
- Body
- DriveItem
Criar pré-visualização de ficheiros
Esta operação cria uma pré-visualização de um ficheiro num contentor SharePoint Embededed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
|
Página
|
page | integer |
Especifica o número de página do documento a pré-visualizar |
|
|
Nível de zoom
|
zoom | float |
Especifica o nível de zoom da pré-visualização do documento (por exemplo, 0.5, 1.0, 1.5) |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Obter URL
|
getUrl | string |
Uma URL que pode ser usada para recuperar a pré-visualização usando um pedido GET |
|
Parâmetros de Pós-Produção
|
postParameters | string |
Parâmetros que podem ser usados com a propriedade postUrl para recuperar a pré-visualização usando um pedido POST |
|
URL da publicação
|
postUrl | string |
Uma URL que pode ser usada para recuperar a pré-visualização através de um pedido POST |
Definir campos de ficheiro
Esta operação atualiza os campos de itens da lista (metadados) associados a um ficheiro num contentor SharePoint Embededed. Use valores nulos para limpar valores de campo.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
|
|
object |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
ETag
|
@odata.etag | string |
O valor ETag para os campos |
Eliminar contentor
Excluir um contêiner
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O ID do contentor |
Eliminar ficheiro
Esta operação elimina um ficheiro num contentor SharePoint Embededed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
Eliminar itens reciclados
Esta operação elimina permanentemente um ou mais itens reciclados do contentor de reciclagem de um contentor SharePoint Embededed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
IDs de itens
|
ids | True | array of string |
Conjunto de IDs de itens reciclados para eliminar permanentemente |
Eliminar recipiente reciclado
Eliminar permanentemente um recipiente reciclado
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O ID do contentor |
Eliminar saída
Esta operação descarta o check-out de um ficheiro num contentor SharePoint Embededed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
Enviar convite de partilha
Esta operação envia um convite de partilha para um ficheiro num contentor SharePoint Embededed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
|
Exigir Iniciar Sessão
|
requireSignIn | True | boolean |
Indica se o destinatário do convite é obrigado a iniciar sessão para ver o item partilhado |
|
Funções
|
roles | True | array of string |
As permissões concedidas aos destinatários do convite de partilha |
|
Email
|
string |
O endereço de e-mail do destinatário |
||
|
Alias
|
alias | string |
O pseudónimo do destinatário (no caso de um destinatário do Microsoft 365) |
|
|
ID do objeto
|
objectId | string |
O identificador único do destinatário no Azure Active Directory |
|
|
Message
|
message | True | string |
Uma mensagem personalizada enviada como parte do convite de partilha |
|
Enviar Convite
|
sendInvitation | True | boolean |
Se for verdade, é enviado um link de partilha aos destinatários. Se for falso, é criada uma permissão mas não é enviada nenhuma mensagem de convite. |
Regressos
Representa uma lista de permissões para um ficheiro ou pasta
Fazer check-in do arquivo
Esta operação verifica um ficheiro que foi requisitado num contentor SharePoint Embededed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
|
Comment
|
comment | string |
Um comentário de check-in associado à versão |
|
|
Check-in como
|
checkInAs | string |
O estado do documento após o check-in (publicado ou menor) |
Fazer check-out do arquivo
Esta operação faz check-out de um ficheiro num contentor SharePoint Embededed, o que impede que outros editem o documento.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
Lista de itens no contentor
Esta operação recebe a lista de ficheiros e subpastas num contentor.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID da pasta principal
|
parentId | True | string |
O ID da pasta pai para listar os itens. Use 'root' para obter itens do nível raiz do contentor, ou forneça um ID de pasta específico para obter itens dessa pasta |
|
Filter
|
$filter | string |
Critérios de filtro para os resultados (formato OData) ex: parentReference/id eq '{{folderId}}' AND contains(listitem/fields/FileLeafRef, {{user_name_string}}) |
|
|
Selecionar
|
$select | string |
Propriedades a incluir nos resultados (separadas por vírgulas) |
|
|
Expandir
|
$expand | string |
Recursos relacionados para expandir a resposta |
|
|
Início
|
$top | integer |
O número de resultados a apresentar |
|
|
Encomendar por
|
$orderby | string |
Campo(s) e direção para ordenar os resultados |
Regressos
Representa uma página de itens do disco.
Lista de itens reciclados
Esta operação lista os itens no contentor de reciclagem de um contentor SharePoint Embebed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
Regressos
Uma coleção de itens no contentor de reciclagem
Lista de recipientes reciclados
Lista de recipientes reciclados
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID de Tipo de Contentor
|
containerType | True | string |
Liste recipientes reciclados do tipo especificado |
Regressos
Listar contêineres
Listar contêineres
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID de Tipo de Contentor
|
containerType | True | string |
Liste contentores do tipo especificado |
Regressos
Listar permissões de contentores
Listar permissões num contentor
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O ID do contentor |
Regressos
Miniaturas da lista
Esta operação lista as miniaturas disponíveis para um ficheiro num contentor SharePoint Embededed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
Regressos
Representa uma coleção de conjuntos de miniaturas
- Body
- ThumbnailSets
Obtenha permissão de partilha
Esta operação obtém uma permissão específica de partilha para um ficheiro num contentor SharePoint Embededed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
|
ID de Permissão
|
permission-id | True | string |
O identificador único da permissão |
Regressos
Representa uma permissão para um ficheiro ou pasta
Obtenha propriedades personalizadas de contentores
Obtenha propriedades personalizadas de um contentor
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O ID do contentor |
Regressos
Obtenha um contentor
Obtenha um contentor
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O ID do contentor |
Regressos
- Body
- FileStorageContainer
Obter a versão do ficheiro
Esta operação recebe uma versão específica de um ficheiro num contentor SharePoint Embededed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
|
ID da versão
|
version-id | True | string |
O identificador único da versão |
Regressos
Representa uma versão de um ficheiro
- Body
- FileVersion
Obter conteúdo de ficheiro
Esta operação obtém o conteúdo de um arquivo.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
Obter propriedades do arquivo
Esta operação obtém as propriedades de um ficheiro num contentor SharePoint Embededed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
Regressos
Metadados dos itens da unidade
- Body
- DriveItem
Obtém miniatura
Esta operação recebe uma miniatura específica para um ficheiro num contentor SharePoint Embededed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
|
ID da miniatura
|
thumbnail-id | True | string |
O identificador único do conjunto de miniaturas |
|
Tamanho
|
size | True | string |
O tamanho da unha da miniatura a recuperar |
Regressos
Representa uma única miniatura
- Body
- Thumbnail
Permissão de apagar partilha
Esta operação elimina uma permissão específica de partilha para um ficheiro num contentor SharePoint Embededed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
|
ID de Permissão
|
permission-id | True | string |
O identificador único da permissão para eliminar |
Permissão para criar contentor
Crie uma permissão num contentor
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O ID do contentor |
|
Funções de Permissão
|
roles | True | array of string |
Os papéis a atribuir ao utilizador |
|
Nome Principal do Utilizador
|
userPrincipalName | True | string |
O nome principal de utilizador da identidade |
Regressos
Permissão para eliminar contentores
Apagar uma permissão num contentor
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O ID do contentor |
|
ID de Permissão
|
permission-id | True | string |
O ID de permissão |
Permissões de partilha de itens de lista
Esta operação lista as permissões de partilha para um item num contentor SharePoint Embededed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
Item ID
|
file-id | True | string |
O identificador único do item |
Regressos
Representa uma lista de permissões para um ficheiro ou pasta
Renomear arquivo
Esta operação renomeia um ficheiro num contentor SharePoint Embededed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
|
Nome
|
name | string |
O novo nome do arquivo |
Regressos
Metadados dos itens da unidade
- Body
- DriveItem
Restaurar itens reciclados
Esta operação restaura um ou mais itens reciclados do contentor de reciclagem de um contentor SharePoint Embebed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
IDs de itens
|
ids | True | array of string |
Conjunto de IDs de itens reciclados a restaurar |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
valor
|
value | array of object | |
|
Item ID
|
value.id | string |
O ID do item restaurado |
Restaurar recipientes reciclados
Restaurar um recipiente reciclado
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O ID do contentor |
Regressos
- Body
- FileStorageContainer
Versões dos ficheiros de lista
Esta operação lista as versões anteriores de um ficheiro num contentor SharePoint Embededed.
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
O identificador único do contentor |
|
ID do ficheiro
|
file-id | True | string |
O identificador exclusivo do ficheiro |
Regressos
Representa uma coleção de versões de ficheiros
- Body
- FileVersions
Gatilhos
| Monitorizar alterações de itens num contentor |
Ativa-se quando itens são adicionados, modificados ou eliminados num contentor SharePoint Embedded |
Monitorizar alterações de itens num contentor
Ativa-se quando itens são adicionados, modificados ou eliminados num contentor SharePoint Embedded
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID do contêiner
|
container-id | True | string |
ID do contentor a monitorizar |
|
Intervalo de Sondagem (segundos)
|
pollingInterval | integer |
Com que frequência verificar as alterações (60-3600 segundos, padrão: 300) |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
valor
|
value | array of DriveItem |
A lista de itens alterados |
|
@odata.deltaLink
|
@odata.deltaLink | string |
Link Delta para o próximo pedido de sondagem |
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
Definições
FileStorageContainer
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
ID do contêiner
|
id | string |
O ID do contentor |
|
ID de Tipo de Contentor
|
containerTypeId | string |
O id do tipo de contentor a que este contentor pertence |
|
Description
|
description | string |
Descrição do contentor |
|
Nome de exibição
|
displayName | string |
O nome do contêiner |
|
Tempo de Criação
|
createdDateTime | date-time |
Data e hora da criação do contentor |
|
customProperties
|
customProperties | FileStorageContainer.CustomProperties | |
|
permissões
|
permissions | FileStorageContainer.Permissions | |
|
estado
|
status | string |
O estado do contentor |
FileStorageContainer.List
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
valor
|
value | array of FileStorageContainer |
FileStorageContainer.Permissões
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Itens
|
FileStorageContainer.Permission |
FileStorageContainer.Permission
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
ID de Permissão
|
id | string |
O ID de permissão |
|
Funções de Permissão
|
roles | FileStorageContainer.Permission.Roles |
Os papéis a atribuir ao utilizador |
|
Nome de exibição
|
grantedToV2.user.displayName | string |
O nome de identidade para mostrar |
|
Email
|
grantedToV2.user.email | string |
O email de identidade |
|
Nome Principal do Utilizador
|
grantedToV2.user.userPrincipalName | string |
O nome principal de utilizador da identidade |
FileStorageContainer.Permission.Roles
Os papéis a atribuir ao utilizador
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Itens
|
string |
FileStorageContainer.Permissions.List
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
valor
|
value | FileStorageContainer.Permissions |
FileStorageContainer.CustomProperties
FileStorageContainer.Column
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Identificador da Coluna
|
id | string |
O identificador único para a coluna |
|
Nome da Coluna
|
name | string |
O nome de exibição da coluna |
|
Description
|
description | string |
Descrição da coluna |
|
Impor Valores Únicos
|
enforceUniqueValues | boolean |
Se os valores das colunas devem ser únicos |
|
Escondido
|
hidden | boolean |
Se a coluna é exibida na interface de utilizador |
|
Indexado
|
indexed | boolean |
Se a coluna está indexada |
|
Obrigatório
|
required | boolean |
Se a coluna é necessária |
|
Somente leitura
|
readOnly | boolean |
Se os valores das colunas podem ser modificados |
|
Grupo de Colunas
|
columnGroup | string |
O grupo a que esta coluna pertence |
|
Nome de exibição
|
displayName | string |
O nome de exibição da coluna |
|
É Eliminável
|
isDeletable | boolean |
Indica se esta coluna pode ser eliminada. |
|
É Reordenável
|
isReorderable | boolean |
Indica se esta coluna pode ser reordenada. |
|
Está Selado
|
isSealed | boolean |
Especifica se a coluna pode ser alterada. |
|
Propagar Alterações
|
propagateChanges | boolean |
Se for verdade, as alterações a esta coluna serão propagadas para listas que implementam a coluna. |
|
Coluna de Valor Padrão - Fórmula
|
defaultValue.formula | string |
A fórmula usada para calcular o valor padrão da coluna. |
|
Coluna de Valor Padrão - Valor
|
defaultValue.value | string |
O valor direto a usar como valor padrão para a coluna. |
|
Coluna de Texto - Comprimento Máximo
|
text.maxLength | integer |
Comprimento máximo do texto |
|
Coluna de Texto - Permitir Múltiplas Linhas
|
text.allowMultipleLines | boolean |
Se deve permitir várias linhas de texto |
|
Coluna de Texto - Adicionar Alterações
|
text.appendChangesToExistingText | boolean |
Se as atualizações desta coluna devem ser acrescentadas ao texto existente |
|
Coluna de Texto - Linhas para Edição
|
text.linesForEditing | integer |
Número de linhas de texto a mostrar nos controlos de edição |
|
Coluna de Texto - Tipo de Texto
|
text.textType | string |
O tipo de texto armazenado |
|
Coluna Numérica - Casas Decimais
|
number.decimalPlaces | string |
Quantas casas decimais mostrar |
|
Coluna Numérica - Mostrar como
|
number.displayAs | string |
Como mostrar o número |
|
Coluna Numérica - Máximo
|
number.maximum | number |
Valor máximo permitido |
|
Coluna do Número - Mínimo
|
number.minimum | number |
Valor mínimo permitido |
|
Booleano
|
boolean | object |
Definições para colunas booleanas |
|
Coluna DataHora - Mostrar Como
|
dateTime.displayAs | string |
Como mostrar a data e a hora |
|
Coluna DateHora - Formato
|
dateTime.format | string |
Se deve incluir o tempo com a data |
|
Coluna de Escolha - Permitir Introdução de Texto
|
choice.allowTextEntry | boolean |
Se os valores personalizados podem ser inseridos |
|
Coluna de Escolhas - Escolhas
|
choice.choices | array of string |
A lista de escolhas para a coluna |
|
Coluna de Escolha - Mostrar Como
|
choice.displayAs | string |
Como mostrar as escolhas |
|
Coluna de consulta - Permitir múltiplos valores
|
lookup.allowMultipleValues | boolean |
Se múltiplos valores podem ser selecionados |
|
Coluna de Pesquisa - Permitir Comprimento Ilimitado
|
lookup.allowUnlimitedLength | boolean |
Se os valores na coluna deveriam poder exceder o limite padrão de 255 caracteres. |
|
Coluna de Pesquisa - ID da Lista
|
lookup.listId | string |
O ID da lista de onde esta pesquisa obtém a informação |
|
Coluna de Pesquisa - ID da Coluna de Pesquisa Primária
|
lookup.primaryLookupColumnId | string |
O ID da coluna para obter informação de |
|
Coluna Monetária - Local
|
currency.locale | string |
A localização da moeda |
|
Coluna PersonOrGroup - Permitir Seleção Múltipla
|
personOrGroup.allowMultipleSelection | boolean |
Se podem ser selecionadas várias pessoas ou grupos |
|
Coluna PersonOrGroup - Escolha entre Tipos
|
personOrGroup.chooseFromType | string |
Os tipos de pessoas ou grupos que podem ser selecionados |
|
Coluna PersonOrGroup - Mostrar como
|
personOrGroup.displayAs | string |
Como exibir as pessoas ou grupos |
|
Coluna HyperlinkOrPicture - É Imagem
|
hyperlinkOrPicture.isPicture | boolean |
Se o hiperlink é uma imagem |
|
Coluna Calculada - Fórmula
|
calculated.formula | string |
A fórmula para o cálculo |
|
Coluna Calculada - Tipo de Saída
|
calculated.outputType | string |
O tipo da saída |
|
Coluna Calculada - Formato
|
calculated.format | string |
Se deve incluir o tempo com a data |
|
Coluna de Geolocalização
|
geolocation | object |
Definições para colunas de localização |
|
Propriedades da Coluna Miniatura
|
thumbnail | object |
Definições para colunas em miniatura |
|
Estado de Aprovação de Conteúdo Propriedades da Coluna
|
contentApprovalStatus | object |
Esta coluna armazena o estado de aprovação de conteúdos. |
|
Coluna de Termos - Permitir Múltiplos Valores
|
term.allowMultipleValues | boolean |
Se múltiplos valores podem ser selecionados |
|
Coluna do Termo - Mostrar Nome Totalmente Qualificado
|
term.showFullyQualifiedName | boolean |
Especifica se deve mostrar todo o caminho do termo ou apenas o rótulo do termo. |
|
ID do Tipo de Conteúdo
|
sourceContentType.id | string |
O ID do tipo de conteúdo. |
|
Nome do tipo de conteúdo
|
sourceContentType.name | string |
O nome do tipo de conteúdo. |
FileStorageContainer.Columns.List
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
valor
|
value | array of FileStorageContainer.Column |
DriveItemCollectionPage
Representa uma página de itens do disco.
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
valor
|
value | array of DriveItem |
Coleção de itens de drive. |
|
@odata.nextLink
|
@odata.nextLink | string |
Um URL que pode ser usado para recuperar a próxima página. |
DriveItem
Metadados dos itens da unidade
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
URL de download
|
@microsoft.graph.downloadUrl | string |
Um URL que pode ser usado para descarregar o conteúdo deste item |
|
URL de download (Sem autorização)
|
@microsoft.graph.downloadUrlNoAuth | string |
Um URL que pode ser usado para descarregar o conteúdo deste item sem autenticação |
|
ID
|
id | string |
O identificador único do ficheiro ou pasta |
|
Nome
|
name | string |
O nome do ficheiro ou pasta |
|
Tamanho
|
size | integer |
O tamanho do ficheiro ou da pasta em bytes |
|
URL da Web
|
webUrl | string |
URL que mostra o item no navegador |
|
Tempo de Criação
|
createdDateTime | date-time |
A data e hora em que o ficheiro ou pasta foi criado |
|
Hora da última modificação
|
lastModifiedDateTime | date-time |
A data e hora em que o ficheiro ou pasta foi modificado pela última vez |
|
ETag
|
eTag | string |
O etag do ficheiro ou pasta |
|
CTag
|
cTag | string |
Uma etiqueta que indica que o conteúdo foi alterado |
|
Tipo de acionamento
|
parentReference.driveType | string |
Tipo de unidade que contém o item |
|
ID do disco
|
parentReference.driveId | string |
ID da unidade que contém o item |
|
ID do pai
|
parentReference.id | string |
ID da pasta-mãe |
|
Nome do pai
|
parentReference.name | string |
Nome da pasta principal |
|
Caminho pai
|
parentReference.path | string |
Caminho para a pasta pai |
|
ID do Site
|
parentReference.siteId | string |
ID do site que contém o item |
|
ID da aplicação
|
createdBy.application.id | string |
ID da aplicação que criou o item |
|
Nome do aplicativo
|
createdBy.application.displayName | string |
Nome de exibição da aplicação que criou o item |
|
ID de utilizador
|
createdBy.user.id | string |
ID do utilizador que criou o item |
|
Nome de Utilizador
|
createdBy.user.displayName | string |
Nome de exibição do utilizador que criou o item |
|
ID da aplicação
|
lastModifiedBy.application.id | string |
ID da aplicação que modificou o item pela última vez |
|
Nome do aplicativo
|
lastModifiedBy.application.displayName | string |
Nome de exibição da aplicação que modificou o item pela última vez |
|
ID de utilizador
|
lastModifiedBy.user.id | string |
ID do utilizador que modificou o item pela última vez |
|
Nome de Utilizador
|
lastModifiedBy.user.displayName | string |
Nome de exibição do utilizador que modificou o artigo pela última vez |
|
Tipo de MIME
|
file.mimeType | string |
O tipo MIME do ficheiro |
|
QuickXor Hash
|
file.hashes.quickXorHash | string |
O hash QuickXor do ficheiro |
|
Tempo de Criação
|
fileSystemInfo.createdDateTime | date-time |
A data e hora em que o ficheiro ou pasta foi criado no sistema de ficheiros |
|
Hora da última modificação
|
fileSystemInfo.lastModifiedDateTime | date-time |
A data e hora em que o ficheiro ou pasta foi modificado pela última vez no sistema de ficheiros |
|
Contagem de crianças
|
folder.childCount | integer |
Número de itens na pasta |
|
Partilha de Âmbito
|
shared.scope | string |
O âmbito da partilha (utilizadores, organização ou qualquer pessoa) |
SharingLink
Representa um link de partilha para um ficheiro ou pasta
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Link ID
|
id | string |
O identificador único para o link de partilha |
|
Tipo de link
|
link.type | string |
O tipo de link de partilha (visualizar, editar, incorporar) |
|
Escopo do link
|
link.scope | string |
O âmbito do link de partilha |
|
URL da Web
|
link.webUrl | string |
O URL do link de partilha |
|
nome de exibição
|
link.application.displayName | string |
O nome de exibição da aplicação |
|
id
|
link.application.id | string |
O identificador exclusivo do aplicativo |
SharingPermissionResponse
Representa uma permissão para um ficheiro ou pasta
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
ID de Permissão
|
id | string |
O identificador único da permissão |
|
Funções
|
roles | array of string |
Os papéis concedidos para esta permissão |
|
Partilhar ID
|
shareId | string |
Um token único que pode ser usado para aceder a este item partilhado através da API de partilhas |
|
Nome de exibição
|
grantedTo.user.displayName | string |
O nome para exibição do usuário |
|
Email
|
grantedTo.user.email | string |
O endereço de e-mail do utilizador |
|
ID de utilizador
|
grantedTo.user.id | string |
O identificador único do utilizador |
|
Escopo do link
|
link.scope | string |
O âmbito da ligação |
|
Tipo de link
|
link.type | string |
O tipo da ligação |
|
URL da Web
|
link.webUrl | string |
A URL do link |
|
Email
|
invitation.email | string |
O endereço de email para onde o convite foi enviado |
|
É Necessário Iniciar Sessão
|
invitation.signInRequired | boolean |
Se é necessário iniciar sessão para aceder ao item partilhado |
|
Data de validade, hora
|
expirationDateTime | date-time |
A data e hora em que a autorização expira |
|
Concedidos às Identidades
|
grantedToIdentities | array of object |
Quando especificado, restringe a partilha apenas aos utilizadores listados |
|
Nome de exibição
|
grantedToIdentities.user.displayName | string |
O nome para exibição do usuário |
|
Email
|
grantedToIdentities.user.email | string |
O endereço de e-mail do utilizador |
|
ID de utilizador
|
grantedToIdentities.user.id | string |
O identificador único do utilizador |
SharingPermissionsList
Representa uma lista de permissões para um ficheiro ou pasta
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
valor
|
value | array of SharingPermissionResponse |
FileVersion
Representa uma versão de um ficheiro
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
ID da versão
|
id | string |
O ID da versão |
|
Modificado por
|
lastModifiedBy.user.displayName | string |
O nome do utilizador que modificou a versão |
|
ID de utilizador
|
lastModifiedBy.user.id | string |
O ID do utilizador que modificou a versão |
|
Última modificação
|
lastModifiedDateTime | date-time |
A data e hora em que esta versão foi modificada pela última vez |
|
Tamanho
|
size | integer |
O tamanho da versão em bytes |
|
Nível de Publicação
|
publication.level | string |
O nível de publicação desta versão (publicado ou consultado) |
|
ID da versão
|
publication.versionId | string |
O ID da versão que está a ser publicada |
FilesVersions
Representa uma coleção de versões de ficheiros
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
valor
|
value | array of FileVersion |
A coleção de versões dos ficheiros |
Conjunto de miniaturas
Representa um conjunto de miniaturas para um ficheiro
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
ID do Conjunto de Miniaturas
|
id | string |
O identificador único do conjunto de miniaturas |
|
grande
|
large | Thumbnail |
Representa uma única miniatura |
|
meio
|
medium | Thumbnail |
Representa uma única miniatura |
|
pequeno
|
small | Thumbnail |
Representa uma única miniatura |
|
origem
|
source | Thumbnail |
Representa uma única miniatura |
Miniatura
Representa uma única miniatura
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Altura
|
height | integer |
A altura da miniatura, em píxeis |
|
Largura
|
width | integer |
A largura da miniatura, em píxeis |
|
URL
|
url | string |
O URL da miniatura |
ThumbnailSets
Representa uma coleção de conjuntos de miniaturas
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
valor
|
value | array of ThumbnailSet |
A coleção de conjuntos de miniaturas |
RecycleBinItem
Representa um item no contentor de reciclagem
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
ID
|
id | string |
Identificador único do artigo reciclado |
|
Nome
|
name | string |
Nome do artigo reciclado |
|
Tamanho
|
size | integer |
Tamanho do item em bytes |
|
Data de eliminação
|
deletedDateTime | date-time |
Data e hora em que o item foi eliminado |
|
Eliminado da localização
|
deletedFromLocation | string |
URL relativa do local que originalmente continha o item |
|
Title
|
title | string |
Título do artigo reciclado |
|
Eliminado por
|
deletedBy.user.displayName | string |
O nome de exibição do utilizador que eliminou o item |
|
Email
|
deletedBy.user.email | string |
O email do utilizador que apagou o item |
|
ID de utilizador
|
deletedBy.user.id | string |
O identificador único do utilizador que eliminou o item |
RecycleBinItemCollection
Uma coleção de itens no contentor de reciclagem
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
valor
|
value | array of RecycleBinItem |
A recolha dos itens no contentor de reciclagem |
binário
Este é o tipo de dados básico 'binário'.