Partilhar via

Egnyte

O Egnyte é um serviço que mantém os seus ficheiros seguros, sincronizados e fáceis de partilhar. Ligue-se ao Egnyte para gerir os seus ficheiros. Você pode executar várias ações, como carregar, atualizar, obter e excluir arquivos no Egnyte.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium 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)
Aplicações Power Premium 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)
Automatize o poder Premium 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 Suporte Egnyte
URL https://helpdesk.egnyte.com
Email support@egnyte.com
Metadados do conector
Editora Egnyte
Sítio Web https://egnyte.com/
Política de privacidade https://www.egnyte.com/privacy-policy
Categorias Colaboração; Produtividade

Egnyte

O Egnyte é uma plataforma de colaboração de conteúdo que mantém os seus ficheiros seguros, sincronizados e fáceis de partilhar. Ligue-se ao Egnyte para gerir os seus ficheiros. Você pode executar várias ações, como carregar, mover, baixar e excluir arquivos no Egnyte.

Pre-requisites

Para usar o conector, você precisa ser um usuário Egnyte.

Ações Suportadas

O conector suporta as seguintes ações:

Gatilhos suportados

O conector suporta os seguintes gatilhos:

  • When a file is locked: Esta operação dispara um fluxo quando um arquivo está bloqueado
  • When a file is unlocked: Esta operação dispara um fluxo quando um arquivo é desbloqueado
  • When a file is updated: Esta operação dispara um fluxo quando um arquivo é atualizado em uma pasta específica
  • When a file is created (webhook): Esta operação dispara um fluxo quando um arquivo é criado em uma pasta específica
  • When a share link is created: Esta operação dispara um fluxo quando um link de compartilhamento é criado
  • When a share link is deleted: Esta operação dispara um fluxo quando um link de compartilhamento é excluído
  • When the file or folder permission changes: Esta operação dispara um fluxo quando as permissões de um arquivo ou pasta são alteradas
  • When the file or folder metadata changes: Esta operação dispara um fluxo quando um arquivo ou uma pasta de metadados é alterado
  • When a project folder is created: Esta operação dispara um fluxo quando uma pasta de projeto é criada ou quando uma pasta existente é marcada como uma pasta de projeto
  • When a folder is unmarked as a project: Esta operação dispara um fluxo quando uma pasta não está marcada como um projeto
  • When a project is updated: Esta operação dispara um fluxo quando um projeto é atualizado
  • When a workflow is created: Esta operação dispara um fluxo quando um fluxo de trabalho é criado
  • When a workflow is completed: Esta operação dispara um fluxo quando um fluxo de trabalho é concluído
  • When an approval type workflow is approved: Esta operação dispara um fluxo quando um fluxo de trabalho de tipo de aprovação é aprovado
  • When an approval type workflow is rejected: Esta operação dispara um fluxo quando um fluxo de trabalho de tipo de aprovação é rejeitado
  • When a group is created: Esta operação dispara um fluxo quando um grupo é criado
  • When a group is updated: Esta operação dispara um fluxo quando um grupo é atualizado
  • When a group is deleted: Esta operação dispara um fluxo quando um grupo é excluído
  • When a file is created (polling): Esta operação dispara um fluxo quando um novo arquivo é criado em uma pasta.
  • When a folder is created: Esta operação dispara um fluxo quando uma subpasta é criada em uma pasta.
  • When a file is deleted: Esta operação dispara um fluxo quando um arquivo é excluído em uma pasta.
  • When a folder is deleted: Esta operação dispara um fluxo quando uma subpasta é excluída em uma pasta.
  • When a file is renamed: Esta operação dispara um fluxo quando um arquivo é renomeado em uma pasta.
  • When a folder is renamed: Esta operação dispara um fluxo quando uma subpasta é renomeada em uma pasta.
  • When a file is moved: Esta operação dispara um fluxo quando um arquivo é movido em uma pasta.
  • When a folder is moved: Esta operação dispara um fluxo quando uma subpasta é movida em uma pasta.
  • When a file is copied: Esta operação dispara um fluxo quando um arquivo é copiado em uma pasta.
  • When a folder is copied: Esta operação dispara um fluxo quando uma subpasta é copiada em uma pasta.

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

[IA] Fazer uma pergunta sobre um documento

Faça perguntas relacionadas a um determinado documento, fornecendo uma resposta orientada por IA com base no conteúdo do documento. https://developers.egnyte.com/api-docs/read/ai-api#Ask-a-Question
[IA] Faça uma pergunta ao Egnyte Copilot

Faça perguntas ao copiloto da plataforma, fornecendo uma resposta orientada por IA com base no conteúdo global dentro do seu domínio Egnyte. https://developers.egnyte.com/api-docs/read/ai-api#Copilot
[IA] Gerar um resumo para um documento

Gere um resumo para um determinado documento, fornecendo uma resposta orientada por IA com base no conteúdo do documento. https://developers.egnyte.com/api-docs/read/ai-api#Summarize-a-Document
Atualizar atributos de namespace

Atualiza atributos de namespace. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Attributes
Atualizar chaves de namespace

Atualize a chave de um metadados personalizados para um domínio. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Keys
Atualizar projeto por ID

Atualiza as propriedades especificadas de um projeto identificado por sua ID. https://developers.egnyte.com/api-docs/read/project-folder-api#Update-Project
Atualizar usuário por ID

Atualize o usuário único. Saiba mais: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Update-Single-User
Atualização completa do grupo

Substitua todos os atributos de um grupo. https://developers.egnyte.com/api-docs/read/group-management#Full-Update-to-a-Group
Atualização parcial do grupo

Atualizar atributos específicos de um grupo. https://developers.egnyte.com/api-docs/read/group-management#Partial-Update-to-a-Group
Bloquear arquivo por caminho

Bloqueie o arquivo usando o caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File
Bloquear ficheiro por ID

Bloqueie o arquivo usando ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File
Copiar arquivo por caminho

Copie um arquivo usando um caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Copiar ficheiro por ID

Copie um arquivo usando uma ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Copiar pasta por caminho

Copie uma pasta usando um caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Copiar pasta por ID

Copie uma pasta usando um ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Criar chave de metadados

Adicione uma chave de metadados a um namespace existente. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Metadata-Key
Criar ficheiro

Carrega um ficheiro para o Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Upload-a-File
Criar grupo

Crie um grupo no Egnyte. https://developers.egnyte.com/api-docs/read/group-management#Create-a-Group
Criar ligação

Crie um link. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
Criar namespace

Crie um namespace no Egnyte. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Namespace
Criar pasta

Crie uma pasta no Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Create-a-Folder
Criar projeto a partir do modelo

Crie um novo projeto a partir de um modelo de pasta de projeto. https://developers.egnyte.com/api-docs/read/project-folder-api#Create-From-Template
Criar utilizador

Crie um novo utilizador no Egnyte. Saiba mais: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Create-Single-User
Deep link por caminho

Crie um link profundo para arquivo ou pasta por caminho. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders
Deep link por ID

Crie um link direto para arquivo ou pasta por ID. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders
Definir metadados por ID de arquivo

Grave metadados em um arquivo usando a ID do arquivo. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace
Definir metadados por ID de pasta

Grave metadados em uma pasta usando a ID da pasta. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace
Definir permissões de pasta

Defina permissões para uma pasta. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Set-Folder-Permissions
Desbloquear arquivo por caminho

Desbloqueie o arquivo usando o caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File
Desbloquear ficheiro por ID

Desbloqueie o arquivo usando o ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File
Eliminar utilizador por ID

Apagar um utilizador do Egnyte. Saiba mais: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-User
Excluir arquivo por caminho

Exclua um arquivo usando um caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Excluir arquivo por ID

Exclua um arquivo usando uma ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Excluir chave de metadados

Exclua uma chave de metadados de um namespace existente. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Metadata-Key
Excluir Grupo

Excluir um grupo por ID. https://developers.egnyte.com/api-docs/read/group-management#Delete-a-Group
Excluir link

Exclua um link. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Delete-a-Link
Excluir namespace

Exclua um namespace especificado. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Namespace
Excluir pasta por caminho

Exclua uma pasta usando um caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Excluir pasta por ID

Exclua uma pasta usando um ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Excluir projeto por ID

Remova um projeto com base em sua Id. https://developers.egnyte.com/api-docs/read/project-folder-api#Remove-Project
Limpar projeto por ID

Esse ponto de extremidade inicia uma limpeza em um projeto e, opcionalmente, exclui ou desabilita usuários especificados. https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-Project
Listar todos os links

Lista todos os links, exceto os links excluídos. Por favor, note que, se o usuário que executa este método não é um administrador, então apenas os links criados pelo usuário serão listados. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links
Listar todos os links V2

Lista todos os links. Por favor, note que, se o usuário que executa este método não é um administrador, então apenas os links criados pelo usuário serão listados. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links-v2
Marcar pasta como projeto

Marque uma pasta existente como um projeto. https://developers.egnyte.com/api-docs/read/project-folder-api#Mark-Folder-as-Project
Metadados de pesquisa

Encontre itens com um campo ou valor de metadados específico. https://developers.egnyte.com/api-docs/read/metadata-api#Search-Metadata
Modificar opções de pasta

Modifique as opções de pasta, como descrição, configurações de compartilhamento de links, permissões de links públicos, restrições de movimentação/exclusão e preferências de notificação por e-mail. https://developers.egnyte.com/api-docs/read/folder-options-api
Mostrar detalhes do link

Veja os detalhes de um link. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Show-Link-Details
Mover arquivo por caminho

Mova um arquivo no Egnyte usando o caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Mover ficheiro por ID

Mova um ficheiro no Egnyte utilizando o ID do ficheiro. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Mover pasta por caminho

Mova uma pasta no Egnyte usando o caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Mover pasta por ID

Mova uma pasta usando ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Obter conteúdo de arquivo por caminho

Recupera o conteúdo do arquivo do Egnyte usando o caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File
Obter conteúdo de arquivo por ID

Recupera o conteúdo do arquivo do Egnyte usando ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File
Obter detalhes do grupo

Recupere informações do grupo usando ID. https://developers.egnyte.com/api-docs/read/group-management#Show-Single-Group
Obter detalhes do utilizador

Recupere as informações sobre o usuário por ID. Saiba mais: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-Single-User
Obter informações da pasta por caminho

Recupere as informações da pasta usando o caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Obter informações da pasta por ID

Recupere as informações da pasta usando o ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Obter informações do arquivo por caminho

Recupere informações do arquivo usando o caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Obter informações do arquivo por ID

Recupere informações do arquivo usando a ID do arquivo. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Obter lista de todos os grupos

Recupere a lista dos grupos. https://developers.egnyte.com/api-docs/read/group-management#List-Groups
Obter lista de todos os usuários

Recupere as informações sobre os usuários. Saiba mais: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-User-List
Obter metadados por ID de arquivo

Obtenha metadados de um arquivo usando a ID do arquivo. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace
Obter metadados por ID de pasta

Obtenha metadados de uma pasta usando a ID da pasta. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace
Obter namespace

Liste todas as chaves de metadados personalizadas que foram criadas em um determinado namespace. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Namespace
Obter permissões de pasta

Obtenha permissões para uma pasta. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Folder-Permissions
Obter permissões efetivas

Obtenha permissões efetivas para um usuário. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Effective-Permission-for-a-User
Obter projeto por ID

Recupere um projeto usando ID. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-ID
Obter projeto por ID de pasta raiz

Recupere um projeto com base em seu ID de pasta raiz. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-Root-Folder
Obter todos os namespaces

Obtenha uma lista de todos os namespaces de metadados personalizados no domínio. https://developers.egnyte.com/api-docs/read/metadata-api#Get-All-Namespaces
Obter todos os projetos

Liste todas as pastas do projeto no domínio. https://developers.egnyte.com/api-docs/read/project-folder-api#Get-All-Projects
Partilhar ficheiro

Partilhe um ficheiro no Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
Partilhar pasta

Partilhe uma pasta no Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
Pesquisar V1

Encontre conteúdo armazenado no Egnyte com base em nomes de arquivos, metadados e conteúdo de texto. https://developers.egnyte.com/api-docs/read/search-api#Search-v1
Pesquisar V2

Encontre conteúdo com recursos avançados de pesquisa. https://developers.egnyte.com/api-docs/read/search-api#Search-v2

[IA] Fazer uma pergunta sobre um documento

ID da Operação:
askDocumentQuestion

Faça perguntas relacionadas a um determinado documento, fornecendo uma resposta orientada por IA com base no conteúdo do documento. https://developers.egnyte.com/api-docs/read/ai-api#Ask-a-Question

Parâmetros

Name Chave Necessário Tipo Description
ID de entrada de arquivo
 entryId True string

A ID da versão específica do arquivo
Question
 question True string

A pergunta específica que pretende fazer
Incluir citações
 includeCitations boolean

Se a resposta deve incluir citações (o padrão é false)
Funções
 role string
Conteúdo da mensagem
 content string

Devoluções

Body
AIQuestionResponse

[IA] Faça uma pergunta ao Egnyte Copilot

ID da Operação:
copilotAsk

Faça perguntas ao copiloto da plataforma, fornecendo uma resposta orientada por IA com base no conteúdo global dentro do seu domínio Egnyte. https://developers.egnyte.com/api-docs/read/ai-api#Copilot

Parâmetros

Name Chave Necessário Tipo Description
Question
 question True string

A pergunta específica que pretende fazer
ID da pasta
 id string

ID da pasta selecionada
ID de entrada de arquivo
 entryId string

ID de entrada do arquivo selecionado
Incluir citações
 includeCitations boolean

Se a resposta deve incluir citações (o padrão é false)
Funções
 role string
Conteúdo da mensagem
 content string

Devoluções

Body
AICopilotResponse

[IA] Gerar um resumo para um documento

ID da Operação:
summarizeDocument

Gere um resumo para um determinado documento, fornecendo uma resposta orientada por IA com base no conteúdo do documento. https://developers.egnyte.com/api-docs/read/ai-api#Summarize-a-Document

Parâmetros

Name Chave Necessário Tipo Description
ID de entrada de arquivo
 entryId True string

A ID da versão específica do arquivo
Funções
 role string
Conteúdo da mensagem
 content string

Devoluções

Body
AISummaryResponse

Atualizar atributos de namespace

ID da Operação:
updateNamespaceAttributes

Atualiza atributos de namespace. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Attributes

Parâmetros

Name Chave Necessário Tipo Description
Nome do namespace
 namespace True string

O identificador exclusivo do namespace no Egnyte.
nome de exibição
 displayName string

O nome para identificar o namespace na interface do usuário
prioridades
 priorities object

Especifica a prioridade (ordem) para as chaves. As chaves serão exibidas de acordo com suas prioridades em ordem decrescente (chaves com prioridade mais alta serão exibidas primeiro)

Devoluções

Body
NamespaceItem

Atualizar chaves de namespace

ID da Operação:
updateNamespaceKeys

Atualize a chave de um metadados personalizados para um domínio. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Keys

Parâmetros

Name Chave Necessário Tipo Description
Nome do namespace
 namespace True string

O identificador exclusivo do namespace no Egnyte.
Key
 key True string

A chave exclusiva no namespace
nome de exibição
 displayName string

Especifica o nome exibido para a chave
tipo
 type string

Especifica o tipo de dados para uma chave
priority
 priority number

Especifica a prioridade (ordem) para as chaves. As chaves serão exibidas de acordo com suas prioridades em ordem decrescente (chaves com prioridade mais alta serão exibidas primeiro)
dados
 data string

Para uma chave do tipo enum, especifica os valores enumerados
helpText
 helpText string

Texto instrucional que é exibido quando um usuário está adicionando/editando uma propriedade para contextualizar a finalidade da propriedade

Devoluções

Name Caminho Tipo Description
nome
 name string

Nome do namespace
chave
 key string

Nome da chave
nome de exibição
 displayName string

O nome para identificar o campo na interface do usuário
helpText
 helpText string

Uma descrição de dica de ferramenta para o campo de metadados
priority
 priority number

Especifica a prioridade para a chave (as chaves com a prioridade mais alta serão exibidas primeiro

Atualizar projeto por ID

ID da Operação:
updateProjectById

Atualiza as propriedades especificadas de um projeto identificado por sua ID. https://developers.egnyte.com/api-docs/read/project-folder-api#Update-Project

Parâmetros

Name Chave Necessário Tipo Description
nome
 name True string

O novo nome da pasta.
descrição
 description string

Uma nova descrição para a pasta.
projectId
 projectId True string

ID do projeto.
customProjectId
 customProjectId string

ID personalizada do projeto.
nome_do_cliente
 customerName string

O cliente associado ao projeto.
ruaEndereço1
 streetAddress1 string

Primeira linha do endereço.
ruaEndereço2
 streetAddress2 string

Segunda linha do endereço.
city
 city string

Cidade.
state
 state string

Estado ou província.
postalCode
 postalCode string

Código postal ou CEP.
country
 country string

usando um código de país de 3 caracteres do perfil ISO 3166 GENC, por exemplo: EUA, GBR, POL.
estado
 status True string

Situação atual do projeto.
startDate
 startDate string

A data de início do projeto no formato ISO 8601.
Data de conclusão
 completionDate string

A data prevista de conclusão do projeto no formato ISO 8601.

Atualizar usuário por ID

ID da Operação:
updateUser

Atualize o usuário único. Saiba mais: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Update-Single-User

Parâmetros

Name Chave Necessário Tipo Description
ID de utilizador
 id True integer

Identificador exclusivo do utilizador
E-mail de utilizador
 email string

O endereço de e-mail do usuário.
Nome próprio
 givenName string

O primeiro nome do usuário.
Nome de família
 familyName string

O sobrenome do usuário.
Active
 active boolean

Se o usuário está ativo ou inativo.
Enviar convite
 sendInvite boolean

Se definido como true, um e-mail de convite será enviado. O parâmetro não pode ser o único modificado por esta ação.
Linguagem
 language string

O parâmetro "language" é aceito somente quando o Language Pack foi habilitado para o domínio.
Tipo de autenticação
 authType string

O tipo de autenticação para o usuário.
Tipo de utilizador
 userType string

O tipo do usuário.
Funções
 role string

A função atribuída ao usuário. Aplicável apenas a Utilizadores Avançados.
ID de usuário do IDP
 idpUserId string

Necessário somente se o usuário for autenticado por SSO e não estiver usando o mapeamento de usuário padrão
Nome principal do usuário
 userPrincipalName string

Não especifique se o usuário não é autenticado pelo AD.

Devoluções

Name Caminho Tipo Description
ID de utilizador
 id integer

Identificador exclusivo do utilizador
E-mail de utilizador
 email string

O endereço de e-mail do usuário.
Nome de família
 familyName string

O sobrenome do usuário.
Nome próprio
 givenName string

O primeiro nome do usuário.
Active
 active boolean

Se o usuário está ativo ou inativo.
Enviar convite
 sendInvite boolean

Se definido como true, um e-mail de convite será enviado.
Linguagem
 language string

Só é aceite quando o Pacote de Idiomas estiver ativado.
Tipo de autenticação
 authType string

O tipo de autenticação para o usuário.
Tipo de utilizador
 userType string

O tipo do usuário.
Funções
 role string

A função atribuída ao usuário. Aplicável apenas a Utilizadores Avançados.
ID de usuário do IDP
 idpUserId string

Necessário somente se o usuário for autenticado por SSO
Nome principal do usuário
 userPrincipalName string

Não especifique se o usuário não é autenticado pelo AD.

Atualização completa do grupo

ID da Operação:
fullGroupUpdate

Substitua todos os atributos de um grupo. https://developers.egnyte.com/api-docs/read/group-management#Full-Update-to-a-Group

Parâmetros

Name Chave Necessário Tipo Description
ID do grupo
 id True string

A ID do grupo criado.
Nome de exibição
 displayName True string

O nome para exibição do grupo.
ID de utilizador
 value integer

O ID globalmente exclusivo de um membro do grupo.

Devoluções

Name Caminho Tipo Description
ID do grupo
 id string

A ID do grupo criado.
nome de exibição
 displayName string

O nome para exibição de um grupo.
Membros
 members array of object

Membros do grupo
Nome de utilizador
 members.username string

O nome de usuário de um membro.
ID de utilizador
 members.value number

O ID de usuário de um membro.
Nome de exibição do usuário
 members.display string

O nome para exibição de um membro.

Atualização parcial do grupo

ID da Operação:
partialGroupUpdate

Atualizar atributos específicos de um grupo. https://developers.egnyte.com/api-docs/read/group-management#Partial-Update-to-a-Group

Parâmetros

Name Chave Necessário Tipo Description
ID do grupo
 id True string

A ID do grupo criado.
Nome de exibição
 displayName string

O nome para exibição do grupo.
ID de utilizador
 value integer

A ID globalmente exclusiva de um membro do grupo.
operação
 operation string

A ação que você deseja executar em um grupo.

Devoluções

Name Caminho Tipo Description
ID do grupo
 id string

A ID do grupo criado.
nome de exibição
 displayName string

O nome para exibição de um grupo.
Membros
 members array of object

Membros do grupo
Nome de utilizador
 members.username string

O nome de usuário de um membro.
ID de utilizador
 members.value number

O ID de usuário de um membro.
Nome de exibição do usuário
 members.display string

O nome para exibição de um membro.

Bloquear arquivo por caminho

ID da Operação:
lockFileByPath

Bloqueie o arquivo usando o caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File

Parâmetros

Name Chave Necessário Tipo Description
Caminho do arquivo de destino
 path True string

O caminho do arquivo de destino no Egnyte, incluindo o nome do arquivo de destino.

Devoluções

Name Caminho Tipo Description
Timeout
 timeout integer

O tempo, em segundos, pelo qual o arquivo deve ser bloqueado.
Token de bloqueio
 lock_token string

O token que deve ser usado para desbloquear o arquivo.

Bloquear ficheiro por ID

ID da Operação:
lockFileById

Bloqueie o arquivo usando ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File

Parâmetros

Name Chave Necessário Tipo Description
ID do arquivo
 id True string

O identificador exclusivo do arquivo no Egnyte.

Devoluções

Name Caminho Tipo Description
Timeout
 timeout integer

O tempo, em segundos, pelo qual o arquivo deve ser bloqueado.
Token de bloqueio
 lock_token string

O token que deve ser usado para desbloquear o arquivo.

Copiar arquivo por caminho

ID da Operação:
copyFileByPath

Copie um arquivo usando um caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Parâmetros

Name Chave Necessário Tipo Description
Arquivo de origem
 path True string

O caminho do arquivo de origem no Egnyte, incluindo o nome do arquivo de destino.
Arquivo de destino
 destination_path True string

O caminho do arquivo de destino no Egnyte, incluindo o nome do arquivo de destino.

Devoluções

Name Caminho Tipo Description
Caminho do arquivo
 path string

Caminho completo do arquivo copiado.
ID do ficheiro
 group_id string

O ID para fazer referência ao arquivo como um todo.

Copiar ficheiro por ID

ID da Operação:
copyFileById

Copie um arquivo usando uma ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Parâmetros

Name Chave Necessário Tipo Description
ID do arquivo
 id True string

O identificador exclusivo do arquivo a ser copiado no Egnyte.
Caminho do arquivo de destino
 destination_path True string

O caminho do arquivo de destino no Egnyte, incluindo o nome do arquivo de destino.

Devoluções

Name Caminho Tipo Description
Caminho do arquivo
 path string

Caminho completo do arquivo copiado.
ID do ficheiro
 group_id string

O ID para fazer referência ao arquivo como um todo.

Copiar pasta por caminho

ID da Operação:
copyFolderByPath

Copie uma pasta usando um caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta de origem
 path True string

O caminho da pasta de origem no Egnyte.
Caminho da pasta de destino
 destination_path True string

O caminho da pasta de destino no Egnyte.

Devoluções

Name Caminho Tipo Description
Caminho da pasta
 path string

Caminho completo da pasta copiada.
ID da pasta
 folder_id string

A ID exclusiva da pasta copiada.

Copiar pasta por ID

ID da Operação:
copyFolderById

Copie uma pasta usando um ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Parâmetros

Name Chave Necessário Tipo Description
ID da pasta
 id True string

O identificador exclusivo da pasta a ser copiada no Egnyte.
Caminho da pasta de destino
 destination_path True string

O caminho da pasta de destino no Egnyte.

Devoluções

Name Caminho Tipo Description
Caminho da pasta
 path string

Caminho completo da pasta copiada.
ID da pasta
 folder_id string

A ID exclusiva da pasta copiada.

Criar chave de metadados

ID da Operação:
createMetadataKey

Adicione uma chave de metadados a um namespace existente. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Metadata-Key

Parâmetros

Name Chave Necessário Tipo Description
Nome do namespace
 namespace True string

O identificador exclusivo do namespace no Egnyte.
Nome da chave
 key True string

O nome da chave que você está criando.
Tipo (Para "enum": parâmetro de dados é necessário)
 type True string

Especifica o tipo de dados para uma chave.
Nome de exibição
 displayName string

O nome para identificar o campo na interface do usuário.
Priority
 priority number

Especifica a prioridade para a chave (as chaves com a prioridade mais alta serão exibidas primeiro).
Texto de ajuda
 helpText string

Uma descrição de dica de ferramenta para o campo de metadados.
Data
 data array of string

Para uma chave do tipo enum, especifica os valores enumerados.

Criar ficheiro

ID da Operação:
createFile

Carrega um ficheiro para o Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Upload-a-File

Parâmetros

Name Chave Necessário Tipo Description
Nome do ficheiro
 Name True string

O nome do arquivo a ser criado no Egnyte.
Caminho da pasta
 Path True string

O caminho da pasta para carregar o arquivo para o Egnyte.
Conteúdo do ficheiro
 body True binary

O conteúdo do ficheiro a carregar para o Egnyte.

Devoluções

Name Caminho Tipo Description
ID da versão
 id string

O id da versão atual do arquivo.
ID do ficheiro
 group_id string

O ID para fazer referência ao arquivo como um todo.
Caminho do arquivo
 path string

Caminho completo do ficheiro carregado.

Criar grupo

ID da Operação:
createGroup

Crie um grupo no Egnyte. https://developers.egnyte.com/api-docs/read/group-management#Create-a-Group

Parâmetros

Name Chave Necessário Tipo Description
Nome de exibição
 displayName True string

O nome para exibição do grupo.
ID de utilizador
 value string

A ID globalmente exclusiva de um membro do grupo.

Devoluções

Name Caminho Tipo Description
ID do grupo
 id string

A ID do grupo criado.
nome de exibição
 displayName string

O nome para exibição de um grupo.
Membros
 members array of object

Membros do grupo
Nome de utilizador
 members.username string

O nome de usuário de um membro.
ID de utilizador
 members.value number

O ID de usuário de um membro.
Nome de exibição do usuário
 members.display string

O nome para exibição de um membro.

Criar ligação

ID da Operação:
createLink

Crie um link. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

Parâmetros

Name Chave Necessário Tipo Description
Caminho
 path True string

O caminho absoluto do arquivo ou pasta de destino.
Tipo
 type True string

Isso determina que tipo de link será criado.
Accessibility
 accessibility string

Determina por quem um link é acessível. Obrigatório, exceto para links de upload ou quando "useDefaultSettings" é true.
Usar configurações padrão
 useDefaultSettings True boolean

Determina se os parâmetros padrão no domínio devem ser usados para a criação de links
Enviar e-mail
 send_email boolean

Se true estiver definido, o link será enviado por e-mail pela Egnyte.
Destinatários
 recipients array of string

Liste os endereços de e-mail dos destinatários do link. Apenas necessário se "Enviar e-mail" for verdadeiro.
Mensagem (Só se aplica se "Enviar e-mail" for verdadeiro.)
 message string

Mensagem pessoal a ser enviada no link e-mail.
Copiar-me (só se aplica se "Enviar e-mail" for verdadeiro)
 copy_me boolean

Se true estiver definido, uma cópia da mensagem de link será enviada ao criador do link.
Notificar
 notify boolean

Se true estiver definido, o criador do link será notificado por e-mail quando o link for acessado.
Link para atual (Aplicável apenas para links de arquivos.)
 link_to_current boolean

Se true estiver definido, o link sempre se referirá à versão atual do arquivo.
Data de validade (por exemplo, 2023-12-31)
 expiry_date string

Data de validade do link. Se especificado, "Cliques de expiração" não pode ser definido.
Cliques de expiração
 expiry_clicks number

Número de cliques para os quais o link é válido. Se especificado, "Data de validade" não pode ser definido
Adicionar um nome de arquivo (só se aplica a links de arquivo, não links de pasta)
 add_file_name boolean

Se verdadeiro, o nome do arquivo será anexado ao final do link.
Senha (quando o parâmetro "acessibilidade" é definido como "senha")
 password string

Quando não especificado, o sistema irá gerar uma senha automaticamente.
Proteção
 protection string

Se definido como "PREVIEW", ele criará um link somente de visualização.
Pasta por destinatário (Aplica-se apenas a links de upload.)
 folder_per_recipient boolean

Se verdadeiro, os dados carregados de cada destinatário serão colocados em uma pasta separada.

Devoluções

Name Caminho Tipo Description
Links
 links array of object

Uma matriz contendo as informações json completas para todos os links para o seu domínio que esse usuário pode ver dentro de qualquer intervalo especificado
Id
 links.id string

O id do link
Endereço URL
 links.url string

O url completo do link
Destinatários
 links.recipients array of string

Uma matriz de endereços de e-mail válidos para os quais o link foi enviado.
Caminho
 path string

O caminho absoluto do recurso de destino, seja arquivo ou pasta.
Tipo
 type string

O tipo de link, seja arquivo, pasta ou upload
Accessibility
 accessibility string

Por quem um link é acessível, um de qualquer pessoa, senha, domínio ou destinatários.
Notificar
 notify boolean

Boolean sobre se o criador do link será notificado via e-mail quando o link for acessado.
Link para o atual
 link_to_current boolean

Boolean sobre se o link sempre se referirá à versão atual do arquivo. Aplicável apenas para links de arquivos.
Data de expiração
 expiry_date string

Data e hora da expiração do link. Este campo só é mostrado se o link expirar até a data
Data de criação
 creation_date string

Data e hora de criação do link
Criado por
 created_by string

Nome de usuário do usuário que criou o link

Criar namespace

ID da Operação:
createNamespace

Crie um namespace no Egnyte. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Namespace

Parâmetros

Name Chave Necessário Tipo Description
Nome do namespace
 name True string

O nome do namespace
Nome de exibição
 displayName string

O nome para identificar o namespace na interface do usuário
Scope
 scope True string

Quem pode ver e modificar o namespace
Nome da chave
 name True string

O nome da chave
Tipo
 type True string

Especifica o tipo de dados para uma chave
Nome de exibição
 displayName string

O nome para identificar o campo na interface do usuário
Texto de Ajuda
 helpText string

Uma descrição de dica de ferramenta para o campo de metadados
Priority
 priority number

Especifica a prioridade para a chave (as chaves com a prioridade mais alta serão exibidas primeiro
Dados (para o tipo de enum)
 data array of string

Para uma chave do tipo enum, especifica os valores enumerados

Criar pasta

ID da Operação:
createFolder

Crie uma pasta no Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Create-a-Folder

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 path True string

O caminho completo da nova pasta.

Devoluções

Name Caminho Tipo Description
Caminho da pasta
 path string

Caminho completo da pasta criada
ID da pasta
 folder_id string

A ID exclusiva da pasta criada

Criar projeto a partir do modelo

ID da Operação:
createProjectFromTemplate

Crie um novo projeto a partir de um modelo de pasta de projeto. https://developers.egnyte.com/api-docs/read/project-folder-api#Create-From-Template

Parâmetros

Name Chave Necessário Tipo Description
ID da pasta pai
 parentFolderId True string

ID da pasta pai onde a pasta do projeto será criada
ID da pasta do modelo
 templateFolderId True string

ID da pasta do modelo de pasta do projeto
Nome da pasta
 folderName True string

Nome da nova pasta que será criada
Nome
 name True string

O nome do projeto
Description
 description string

Descrição da pasta
ID do projeto
 projectId string

ID personalizada do projeto
Nome do Cliente
 customerName string

O cliente associado ao projeto
Situação
 status True string

Estado do projeto
Data de início (por exemplo, 2023-12-31T23:59:59)
 startDate date-time

A data de início do projeto.
Data de conclusão (por exemplo, 2023-12-31T23:59:59)
 completionDate date-time

A data de conclusão do projeto.
Endereço 1
 streetAddress1 string

Primeira linha do endereço
Endereço 2
 streetAddress2 string

Segunda linha do endereço
City
 city string

City
Estado ou Província
 state string

Estado ou Província
Country
 country string

Country
Código postal ou código postal
 postalCode string

Código postal ou código postal

Devoluções

Name Caminho Tipo Description
gruposCriado
 groupsCreated array of object
ID do projeto
 groupsCreated.id string

ID do projeto
Nome do projeto
 groupsCreated.name string

Nome do projeto

Criar utilizador

ID da Operação:
createUser

Crie um novo utilizador no Egnyte. Saiba mais: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Create-Single-User

Parâmetros

Name Chave Necessário Tipo Description
Nome de utilizador
 userName True string

O nome de utilizador Egnyte para o utilizador. Deve começar com uma letra ou um dígito.
Email
 email True string

O endereço de email do utilizador (por exemplo, admin@acme.com).
Nome próprio
 givenName True string

O primeiro nome do usuário.
Nome de família
 familyName True string

O sobrenome do usuário.
Active
 active True boolean

Se o usuário está ativo ou inativo.
Tipo de utilizador
 userType True string

O tipo do usuário.
Tipo de autenticação
 authType True string

O tipo de autenticação para o usuário.
ID externo
 externalId string

Identificador único imutável fornecido pelo consumidor da API.
Enviar convite
 sendInvite boolean

Se for definido como true ao criar um utilizador, será enviado um email de convite (se o utilizador estiver criado em estado ativo).
É conta de serviço
 isServiceAccount boolean

Se for definido como true ao criar um utilizador, o utilizador será criado como uma Conta de Serviço.
Linguagem
 language string

O parâmetro "language" é aceito somente quando o Language Pack foi habilitado para o domínio.
Funções
 role string

A função atribuída ao usuário. Aplicável apenas a Utilizadores Avançados.
ID de usuário do IDP
 idpUserId string

Só é obrigatório se o utilizador estiver autenticado por SSO e não usar o mapeamento padrão do utilizador. Não especifique se o utilizador não está autenticado por SSO.
Nome principal do usuário
 userPrincipalName string

Não especifique se o usuário não é autenticado pelo AD. Usado para vincular políticas de autenticação de filhos a um utilizador ao utilizar autenticação do Active Directory numa configuração multidomínio.

Devoluções

Name Caminho Tipo Description
ID de utilizador
 id integer

Identificador único para o utilizador recém-criado
Nome de utilizador
 userName string

O nome de utilizador Egnyte para o utilizador.
ID externo
 externalId string

Identificador único imutável fornecido pelo consumidor da API.
Email
 email string

O endereço de e-mail do usuário.
Alteração de e-mail pendente
 emailChangePending boolean

Se uma alteração de email está pendente.
Nome próprio
 name.givenName string

O primeiro nome do usuário.
Nome de família
 name.familyName string

O sobrenome do usuário.
Nome formatado
 name.formatted string

O nome completo formatado do utilizador.
Active
 active boolean

Se o utilizador está ativo.
Bloqueada
 locked boolean

Se a conta de utilizador está bloqueada.
Tipo de autenticação
 authType string

O tipo de autenticação para o usuário.
Tipo de utilizador
 userType string

O tipo do usuário.
ID de usuário do IDP
 idpUserId string

A forma como o utilizador é identificado na Resposta SAML de um Fornecedor de Identidade SSO.
Nome principal do usuário
 userPrincipalName string

Usado para vincular políticas de autenticação de filhos a um utilizador ao usar autenticação do Active Directory.
Funções
 role string

A função atribuída ao usuário. Aplicável apenas a Utilizadores Avançados.
Linguagem
 language string

A preferência linguística para o utilizador.
Data de criação
 createdDate date-time

A data e a hora em que o usuário foi criado.
Data da última modificação
 lastModificationDate date-time

A data e hora da última modificação.
Última data ativa
 lastActiveDate date-time

A data e hora da última atividade.
Data de expiração
 expiryDate date-time

A data em que a conta de utilizador expira.
ID da Operação:
deepLinksByPath

Crie um link profundo para arquivo ou pasta por caminho. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders

Parâmetros

Name Chave Necessário Tipo Description
Caminho
 path True string

Caminho do arquivo ou pasta

Devoluções

Name Caminho Tipo Description
Endereço URL
 url string

Ligação direta
ID da Operação:
deepLinksById

Crie um link direto para arquivo ou pasta por ID. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders

Parâmetros

Name Chave Necessário Tipo Description
Id
 id True string

Id do ficheiro ou pasta
Tipo
 type True string

Tipo de ligação

Devoluções

Name Caminho Tipo Description
Endereço URL
 url string

Ligação direta

Definir metadados por ID de arquivo

ID da Operação:
setMetadataByFileId

Grave metadados em um arquivo usando a ID do arquivo. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace

Parâmetros

Name Chave Necessário Tipo Description
ID do arquivo
 fileId True string

O identificador exclusivo do arquivo no Egnyte.
Nome do namespace
 namespaceName True string

O nome do namespace.
Nome da chave de metadados
 metadataName True string

O nome da chave à qual você deseja atribuir valor.
Valor dos metadados
 metadataValue string

Valor de metadados a ser definido.

Definir metadados por ID de pasta

ID da Operação:
setMetadataByFolderId

Grave metadados em uma pasta usando a ID da pasta. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace

Parâmetros

Name Chave Necessário Tipo Description
ID da pasta
 folderId True string

O identificador exclusivo da pasta no Egnyte.
Nome do namespace
 namespaceName True string

O nome do namespace.
Nome da chave de metadados
 metadataName True string

O nome da chave à qual você deseja atribuir valor.
Valor dos metadados
 metadataValue True string

Valor de metadados a ser definido.

Definir permissões de pasta

ID da Operação:
setFolderPermissions

Defina permissões para uma pasta. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Set-Folder-Permissions

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 path True string

Caminho completo da pasta.
Permissões de usuário
 userPerms object

Mapa do usuário para o valor de permissão.
Permissões de grupo
 groupPerms object

Mapa do nome do grupo para o valor de permissão
Herda permissões
 inheritsPermissions boolean

Se as permissões devem ser herdadas da pasta pai.
Manter permissões pai (somente se inheritsPermissions for false)
 keepParentPermissions boolean

Se as permissões das pastas pai devem ser aplicadas a essa pasta.

Desbloquear arquivo por caminho

ID da Operação:
unlockFileByPath

Desbloqueie o arquivo usando o caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File

Parâmetros

Name Chave Necessário Tipo Description
Caminho do arquivo
 path True string

O caminho exclusivo para o arquivo no Egnyte.
Token de bloqueio
 lock_token True string

O token de bloqueio atual para o arquivo.

Desbloquear ficheiro por ID

ID da Operação:
unlockFileById

Desbloqueie o arquivo usando o ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File

Parâmetros

Name Chave Necessário Tipo Description
ID do arquivo
 id True string

O identificador exclusivo do arquivo no Egnyte.
Token de bloqueio
 lock_token True string

O token de bloqueio atual para o arquivo.

Eliminar utilizador por ID

ID da Operação:
deleteUser

Apagar um utilizador do Egnyte. Saiba mais: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-User

Parâmetros

Name Chave Necessário Tipo Description
ID de utilizador
 id True integer

O ID do utilizador a eliminar

Excluir arquivo por caminho

ID da Operação:
deleteFileByPath

Exclua um arquivo usando um caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Parâmetros

Name Chave Necessário Tipo Description
Caminho do arquivo
 path True string

O caminho do arquivo no Egnyte, incluindo o nome do arquivo de destino.

Devoluções

Name Caminho Tipo Description
Caminho da pasta pai
 parent_folder_path string

Caminho para a pasta pai do arquivo excluído

Excluir arquivo por ID

ID da Operação:
deleteFileById

Exclua um arquivo usando uma ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Parâmetros

Name Chave Necessário Tipo Description
ID do arquivo
 id True string

O identificador exclusivo do arquivo a ser excluído do Egnyte.

Devoluções

Name Caminho Tipo Description
Caminho da pasta pai
 parent_folder_path string

Caminho para a pasta pai do arquivo excluído.

Excluir chave de metadados

ID da Operação:
deleteMetadataKey

Exclua uma chave de metadados de um namespace existente. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Metadata-Key

Parâmetros

Name Chave Necessário Tipo Description
Nome do namespace
 namespace True string

O identificador exclusivo do namespace no Egnyte.
Nome
 key True string

O nome da chave que você está excluindo.
Forçar a eliminação
 force boolean

Exclua mesmo que a chave de metadados seja usada.

Excluir Grupo

ID da Operação:
deleteGroup

Excluir um grupo por ID. https://developers.egnyte.com/api-docs/read/group-management#Delete-a-Group

Parâmetros

Name Chave Necessário Tipo Description
ID do Grupo
 id True string

O ID do grupo.
ID da Operação:
deleteLink

Exclua um link. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Delete-a-Link

Parâmetros

Name Chave Necessário Tipo Description
Link Id
 linkId True string

Ligação

Excluir namespace

ID da Operação:
deleteNamespace

Exclua um namespace especificado. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Namespace

Parâmetros

Name Chave Necessário Tipo Description
Nome do namespace
 namespace True string

O identificador exclusivo do namespace no Egnyte.
Forçar a eliminação
 force boolean

Excluir, mesmo que o namespace seja usado

Excluir pasta por caminho

ID da Operação:
deleteFolderByPath

Exclua uma pasta usando um caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 path True string

O caminho da pasta no Egnyte, incluindo o nome da pasta de destino a ser excluído.

Devoluções

Name Caminho Tipo Description
Caminho da pasta pai
 parent_folder_path string

Caminho para a pasta pai da pasta excluída.

Excluir pasta por ID

ID da Operação:
deleteFolderById

Exclua uma pasta usando um ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Parâmetros

Name Chave Necessário Tipo Description
ID da pasta
 id True string

O identificador exclusivo da pasta a ser excluída do Egnyte.

Devoluções

Name Caminho Tipo Description
Caminho da pasta pai
 parent_folder_path string

Caminho para a pasta pai da pasta excluída.

Excluir projeto por ID

ID da Operação:
deleteProjectById

Remova um projeto com base em sua Id. https://developers.egnyte.com/api-docs/read/project-folder-api#Remove-Project

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
 projectId True string

ID do projeto que está sendo excluído

Limpar projeto por ID

ID da Operação:
cleanupProject

Esse ponto de extremidade inicia uma limpeza em um projeto e, opcionalmente, exclui ou desabilita usuários especificados. https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-Project

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
 projectId True string

ID do projeto
excluirLinks
 deleteLinks True boolean

Se definido como true, todos os links ativos existentes no projeto serão excluídos.
usuáriosToDelete
 usersToDelete array of integer

Lista de IDs de usuário a serem excluídos.
usersToDisable
 usersToDisable array of integer

Lista de IDs de usuário a serem desabilitados.

Devoluções

Name Caminho Tipo Description
mensagem
 message string
ID da Operação:
listLinks

Lista todos os links, exceto os links excluídos. Por favor, note que, se o usuário que executa este método não é um administrador, então apenas os links criados pelo usuário serão listados. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links

Parâmetros

Name Chave Necessário Tipo Description
Caminho
 path string

Liste links para um arquivo ou pasta especificado por seu caminho completo.
Nome de utilizador
 username string

Listar links criados por este usuário.
Criado antes
 createdBefore string

Listar links criados antes de uma determinada data (ISO-8601 ou AAAA-MM-DD).
Criado após
 createdAfter string

Listar links criados após uma determinada data (ISO-8601 ou AAAA-MM-DD).
Tipo
 type string

Filtre apenas para itens de "arquivo" ou "pasta".
Accessibility
 accessibility string

Selecione o tipo de acessibilidade
Compensação
 offset string

O índice baseado em 0 do registro inicial que está sendo solicitado.
Contagem (Por padrão, 500 entradas são retornadas)
 count string

Limite o número de entradas por página.

Devoluções

Name Caminho Tipo Description
Ids
 ids array of string

Uma matriz que contém os IDs de todos os links para o seu domínio que esse usuário pode ver.
Compensação
 offset number

O índice baseado em 0 do registro inicial que está sendo solicitado.
Contar
 count number

A contagem de itens devolvidos. Se este campo não for especificado, o valor da contagem será 0.
Contagem total
 total_count number

O número de links visíveis para o usuário no domínio.
ID da Operação:
listLinksV2

Lista todos os links. Por favor, note que, se o usuário que executa este método não é um administrador, então apenas os links criados pelo usuário serão listados. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links-v2

Parâmetros

Name Chave Necessário Tipo Description
Caminho
 path string

Liste links para um arquivo ou pasta especificado por seu caminho completo.
Nome de utilizador
 username string

Listar links criados por este usuário.
Criado antes
 createdBefore string

Listar links criados antes de uma determinada data (ISO-8601 ou AAAA-MM-DD).
Criado após
 createdAfter string

Listar links criados após uma determinada data (ISO-8601 ou AAAA-MM-DD).
Tipo
 type string

Filtre apenas para itens de "arquivo" ou "pasta".
Accessibility
 accessibility string

Selecione o tipo de acessibilidade
Compensação
 offset string

O índice baseado em 0 do registro inicial que está sendo solicitado.
Contagem (Por padrão, 500 entradas são retornadas)
 count string

Limite o número de entradas por página.

Devoluções

Name Caminho Tipo Description
Links
 links array of object

Uma matriz contendo as informações json completas para todos os links para o seu domínio que esse usuário pode ver dentro de qualquer intervalo especificado
Caminho
 links.path string

O caminho absoluto do recurso de destino, seja arquivo ou pasta.
Tipo
 links.type string

O tipo de link, seja arquivo, pasta ou upload
Accessibility
 links.accessibility string

Por quem um link é acessível, um de qualquer pessoa, senha, domínio ou destinatários.
Proteção
 links.protection string

Se "PREVIEW" para um arquivo (ou pasta) link, é um link somente visualização para o arquivo (pasta), caso contrário, é "NONE"
Destinatários
 links.recipients array of string

Uma matriz de endereços de e-mail válidos para os quais o link foi enviado.
Notificar
 links.notify boolean

Boolean sobre se o criador do link será notificado via e-mail quando o link for acessado.
Endereço URL
 links.url string

O url completo do link
Id
 links.id string

O id do link
Link para o atual
 links.link_to_current boolean

Boolean sobre se o link sempre se referirá à versão atual do arquivo. Aplicável apenas para links de arquivos.
Data de criação
 links.creation_date string

Data e hora de criação do link
Criado por
 links.created_by string

Nome de usuário do usuário que criou o link
ID do recurso
 links.resource_id string

Id do recurso associado, id de grupo, se for um link de arquivo, ou ID de pasta, se for uma pasta ou link de upload
Cliques de expiração
 links.expiry_clicks number

Número de cliques deixados no link antes da expiração. Este campo só é mostrado se o link expirar através de cliques
Último acesso
 links.last_accessed string

Data e hora do último acesso do link. Este campo só é mostrado se o link tiver sido acessado pelo menos uma vez
Data de expiração
 links.expiry_date string

Data e hora da expiração do link. Este campo só é mostrado se o link expirar até a data
Contar
 count number

O número de links visíveis para o usuário no domínio que são retornados

Marcar pasta como projeto

ID da Operação:
markFolderAsProject

Marque uma pasta existente como um projeto. https://developers.egnyte.com/api-docs/read/project-folder-api#Mark-Folder-as-Project

Parâmetros

Name Chave Necessário Tipo Description
ID da pasta raiz
 rootFolderId True string

FolderId da pasta raiz do projeto
Nome
 name True string

O nome do projeto
Description
 description string

Descrição da pasta
Situação
 status True string

Estado do projeto
Data de início (por exemplo, 2023-12-31T23:59:59)
 startDate date-time

A data de início do projeto.
Data de conclusão (por exemplo, 2023-12-31T23:59:59)
 completionDate date-time

A data de conclusão do projeto.

Devoluções

Name Caminho Tipo Description
Id
 id string

Item Id

Metadados de pesquisa

ID da Operação:
searchMetadata

Encontre itens com um campo ou valor de metadados específico. https://developers.egnyte.com/api-docs/read/metadata-api#Search-Metadata

Parâmetros

Name Chave Necessário Tipo Description
Tipo de pesquisa
 type string

Que tipos de itens devem ser pesquisados.
Nome do namespace
 namespace True string

O nome do namespace.
Chave de metadados
 keyName True string

O nome da chave de metadados.
Nome do namespace
 namespace True string

O nome do namespace.
Chave de metadados
 keyName True string

O nome da chave de metadados.
Valor dos metadados
 value True string

O valor da chave de metadados.

Modificar opções de pasta

ID da Operação:
modifyFolderOptions

Modifique as opções de pasta, como descrição, configurações de compartilhamento de links, permissões de links públicos, restrições de movimentação/exclusão e preferências de notificação por e-mail. https://developers.egnyte.com/api-docs/read/folder-options-api

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 path True string

O caminho exclusivo para a pasta no Egnyte.
Descrição da pasta
 folder_description string

Descrição da pasta.
Permitir links
 allow_links boolean

Escolha se os links podem ser compartilhados com arquivos ou subpastas dentro dessa pasta.
Ligações Públicas
 public_links string

Especifique que tipo de links públicos são permitidos. Valores possíveis: files_folders, ficheiros, desativado.
Restringir Mover/Excluir
 restrict_move_delete boolean

Restrinja as operações de movimentação e exclusão apenas aos proprietários e administradores de pastas.
Notificações de atualizações de conteúdo
 content_updates boolean

Habilite notificações por e-mail para atualizações de conteúdo.
Notificações de conteúdo acessado
 content_accessed boolean

Habilite notificações por e-mail para o conteúdo acessado.

Devoluções

Name Caminho Tipo Description
Nome
 name string

Nome da pasta.
Última modificação
 lastModified integer

A última vez que qualquer arquivo na pasta (mas não dentro de subpastas) foi modificado.
Caminho da pasta
 path string

Caminho completo da pasta.
ID da pasta
 folder_id string

A ID exclusiva da pasta.
Descrição da pasta
 folder_description string

A descrição da pasta.
É pasta
 is_folder boolean

Se o recurso é uma pasta. Verdadeiro ou Falso
Possíveis ligações públicas
 public_links string

A configuração da opção de pasta como "Permitir links públicos desta pasta para" foi definida.
Pode ser excluído ou movido
 restrict_move_delete boolean

Pode ser eliminado ou movido? T ou F
ID da Operação:
showLinkDetails

Veja os detalhes de um link. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Show-Link-Details

Parâmetros

Name Chave Necessário Tipo Description
Link Id
 linkId True string

Ligação

Devoluções

Name Caminho Tipo Description
Links
 links array of object

Uma matriz contendo as informações json completas para todos os links para o seu domínio que esse usuário pode ver dentro de qualquer intervalo especificado
Id
 links.id string

O id do link
Endereço URL
 links.url string

O url completo do link
Destinatários
 links.recipients array of string

Uma matriz de endereços de e-mail válidos para os quais o link foi enviado.
Caminho
 path string

O caminho absoluto do recurso de destino, seja arquivo ou pasta.
Tipo
 type string

O tipo de link, seja arquivo, pasta ou upload
Accessibility
 accessibility string

Por quem um link é acessível, um de qualquer pessoa, senha, domínio ou destinatários.
Notificar
 notify boolean

Boolean sobre se o criador do link será notificado via e-mail quando o link for acessado.
Link para o atual
 link_to_current boolean

Boolean sobre se o link sempre se referirá à versão atual do arquivo. Aplicável apenas para links de arquivos.
Data de expiração
 expiry_date string

Data e hora da expiração do link. Este campo só é mostrado se o link expirar até a data
Data de criação
 creation_date string

Data e hora de criação do link
Criado por
 created_by string

Nome de usuário do usuário que criou o link
Último acesso
 last_accessed string

Data e hora do último acesso do link. Este campo só é mostrado se o link tiver sido acessado pelo menos uma vez

Mover arquivo por caminho

ID da Operação:
moveFileByPath

Mova um arquivo no Egnyte usando o caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Parâmetros

Name Chave Necessário Tipo Description
Caminho de origem
 path True string

O caminho para o arquivo de origem.
Caminho do arquivo de destino
 destination_path True string

O caminho do arquivo de destino no Egnyte, incluindo o nome do arquivo de destino.

Devoluções

Name Caminho Tipo Description
Caminho do arquivo
 path string

Caminho completo do arquivo movido.
ID do ficheiro
 group_id string

O ID para fazer referência ao arquivo como um todo.

Mover ficheiro por ID

ID da Operação:
moveFileById

Mova um ficheiro no Egnyte utilizando o ID do ficheiro. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Parâmetros

Name Chave Necessário Tipo Description
ID do arquivo
 id True string

O identificador exclusivo do arquivo no Egnyte.
Caminho do arquivo de destino
 destination_path True string

O caminho do arquivo de destino no Egnyte. Incluindo o nome do arquivo de destino.

Devoluções

Name Caminho Tipo Description
Caminho do arquivo
 path string

Caminho completo do arquivo movido.
ID do ficheiro
 group_id string

O ID para fazer referência ao arquivo como um todo.

Mover pasta por caminho

ID da Operação:
moveFolderByPath

Mova uma pasta no Egnyte usando o caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Parâmetros

Name Chave Necessário Tipo Description
Caminho de origem
 path True string

O caminho para a pasta de origem.
Caminho da pasta de destino
 destination_path True string

O caminho da pasta de destino no Egnyte.

Devoluções

Name Caminho Tipo Description
Caminho da pasta
 path string

Caminho completo da pasta movida.
ID da pasta
 folder_id string

A ID exclusiva da pasta movida.

Mover pasta por ID

ID da Operação:
moveFolderById

Mova uma pasta usando ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Parâmetros

Name Chave Necessário Tipo Description
ID da pasta
 id True string

O identificador exclusivo da pasta no Egnyte.
Caminho da pasta de destino
 destination_path True string

O caminho da pasta de destino no Egnyte.

Devoluções

Name Caminho Tipo Description
Caminho da pasta
 path string

Caminho completo da pasta movida.
ID da pasta
 folder_id string

A ID exclusiva da pasta movida.

Obter conteúdo de arquivo por caminho

ID da Operação:
getFileContentByPath

Recupera o conteúdo do arquivo do Egnyte usando o caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File

Parâmetros

Name Chave Necessário Tipo Description
Caminho do arquivo
 filePath True string

O caminho exclusivo para o arquivo no Egnyte.

Obter conteúdo de arquivo por ID

ID da Operação:
getFileContentById

Recupera o conteúdo do arquivo do Egnyte usando ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File

Parâmetros

Name Chave Necessário Tipo Description
ID do arquivo
 fileId True string

O identificador exclusivo do arquivo no Egnyte.

Obter detalhes do grupo

ID da Operação:
groupInfoById

Recupere informações do grupo usando ID. https://developers.egnyte.com/api-docs/read/group-management#Show-Single-Group

Parâmetros

Name Chave Necessário Tipo Description
ID do grupo
 id True string

A ID do grupo.

Devoluções

Name Caminho Tipo Description
ID do grupo
 id string

O ID de grupo globalmente exclusivo.
Nome do Grupo
 displayName string

O nome do grupo.
Membros
 members array of object

Membros do grupo
ID do grupo
 members.username string

O nome de usuário de um membro do grupo
ID de utilizador
 members.value number

A ID globalmente exclusiva de um membro do grupo.
Nome de exibição do usuário
 members.display string

O nome para exibição de um membro do grupo.

Obter detalhes do utilizador

ID da Operação:
getUser

Recupere as informações sobre o usuário por ID. Saiba mais: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-Single-User

Parâmetros

Name Chave Necessário Tipo Description
ID de utilizador
 id True integer

O ID do usuário

Devoluções

Informação do utilizador

Body
UserInfoResponse

Obter informações da pasta por caminho

ID da Operação:
folderInfoByPath

Recupere as informações da pasta usando o caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 path True string

O caminho exclusivo para a pasta no Egnyte.

Devoluções

Body
FolderInfoResponse

Obter informações da pasta por ID

ID da Operação:
folderInfoById

Recupere as informações da pasta usando o ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Parâmetros

Name Chave Necessário Tipo Description
ID da pasta
 id True string

O identificador exclusivo da pasta no Egnyte.

Devoluções

Body
FolderInfoResponse

Obter informações do arquivo por caminho

ID da Operação:
fileInfoByPath

Recupere informações do arquivo usando o caminho. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Parâmetros

Name Chave Necessário Tipo Description
Caminho do arquivo
 path True string

O caminho exclusivo para o arquivo no Egnyte.

Devoluções

Body
FileInfoResponse

Obter informações do arquivo por ID

ID da Operação:
fileInfoById

Recupere informações do arquivo usando a ID do arquivo. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Parâmetros

Name Chave Necessário Tipo Description
ID do arquivo
 id True string

O identificador exclusivo do arquivo no Egnyte.

Devoluções

Body
FileInfoResponse

Obter lista de todos os grupos

ID da Operação:
listGroups

Recupere a lista dos grupos. https://developers.egnyte.com/api-docs/read/group-management#List-Groups

Parâmetros

Name Chave Necessário Tipo Description
Índice de Início
 startIndex integer

O índice baseado em 1 do registro inicial que está sendo solicitado (Inteiro ≥ 1).
Contar
 count integer

O número de entradas por página (min 1, max 100)
Filter
 filter string

Permite solicitar um subconjunto de grupos. Estes termos não diferenciam maiúsculas de minúsculas

Devoluções

Name Caminho Tipo Description
Total de resultados
 totalResults integer

O número total de resultados correspondentes à consulta.
Itens por página
 itemsPerPage integer

O número de resultados retornados.
Iniciar índice
 startIndex integer

O índice baseado em 1 do primeiro resultado no conjunto atual de resultados.
resources
 resources array of object
ID do grupo
 resources.id string

O ID de grupo globalmente exclusivo.
Nome do grupo
 resources.displayName string

O nome do grupo.

Obter lista de todos os usuários

ID da Operação:
getUserList

Recupere as informações sobre os usuários. Saiba mais: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-User-List

Parâmetros

Name Chave Necessário Tipo Description
Índice de Início
 startIndex integer

O índice baseado em 1 do primeiro resultado da pesquisa.
Contar
 count integer

Especifica o número máximo desejado de resultados de pesquisa por página.
Filter
 filter string

Permite solicitar um subconjunto de usuários. Consulte a documentação na seção Sobre.

Devoluções

Obter resposta da Lista de Usuários

Body
UserListResponse

Obter metadados por ID de arquivo

ID da Operação:
getMetadataByFileId

Obtenha metadados de um arquivo usando a ID do arquivo. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 fileId True string

O identificador exclusivo do arquivo no Egnyte.
Nome do namespace
 namespace True string

O nome do namespace.

Obter metadados por ID de pasta

ID da Operação:
getMetadataByFolderId

Obtenha metadados de uma pasta usando a ID da pasta. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace

Parâmetros

Name Chave Necessário Tipo Description
ID da pasta
 folderId True string

O identificador exclusivo da pasta no Egnyte.
Nome do namespace
 namespace True string

O nome do namespace.

Obter namespace

ID da Operação:
getNamespace

Liste todas as chaves de metadados personalizadas que foram criadas em um determinado namespace. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Namespace

Parâmetros

Name Chave Necessário Tipo Description
Nome do namespace
 namespace True string

O identificador exclusivo do namespace no Egnyte.

Devoluções

Body
NamespaceItem

Obter permissões de pasta

ID da Operação:
getFolderPermissions

Obtenha permissões para uma pasta. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Folder-Permissions

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 path True string

Caminho completo da pasta.

Devoluções

Name Caminho Tipo Description
Permissões de usuário
 userPerms object

Mapa do usuário para o valor de permissão.
Permissões de grupo
 groupPerms object

Mapa do nome do grupo para o valor de permissão
Herda permissões
 inheritsPermissions boolean

Se as permissões devem ser herdadas da pasta pai.
Manter permissões de pai
 keepParentPermissions boolean

Ao desabilitar a herança de permissões com inheritsPermissions, essa opção determina se as permissões herdadas anteriormente das pastas pai devem ser copiadas para essa pasta.

Obter permissões efetivas

ID da Operação:
getEffectivePermissions

Obtenha permissões efetivas para um usuário. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Effective-Permission-for-a-User

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 path True string

Caminho completo da pasta.
Nome de utilizador
 username True string

Nome de utilizador

Devoluções

Name Caminho Tipo Description
Permissão
 permission string

Valor de permissão

Obter projeto por ID

ID da Operação:
getProjectById

Recupere um projeto usando ID. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-ID

Parâmetros

Name Chave Necessário Tipo Description
ID do projeto
 projectId True string

ID do projeto

Devoluções

Body
ProjectItem

Obter projeto por ID de pasta raiz

ID da Operação:
getProjectByRootFolderId

Recupere um projeto com base em seu ID de pasta raiz. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-Root-Folder

Parâmetros

Name Chave Necessário Tipo Description
O ID da pasta raiz
 rootFolderId True string

O ID da pasta raiz

Devoluções

Body
ProjectItem

Obter todos os namespaces

ID da Operação:
getAllNamespaces

Obtenha uma lista de todos os namespaces de metadados personalizados no domínio. https://developers.egnyte.com/api-docs/read/metadata-api#Get-All-Namespaces

Devoluções

response
array of NamespaceItem

Obter todos os projetos

ID da Operação:
getAllProjects

Liste todas as pastas do projeto no domínio. https://developers.egnyte.com/api-docs/read/project-folder-api#Get-All-Projects

Devoluções

response
array of ProjectItem

Partilhar ficheiro

ID da Operação:
shareFile

Partilhe um ficheiro no Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

Parâmetros

Name Chave Necessário Tipo Description
Caminho do arquivo
 path True string

O caminho do arquivo no Egnyte, incluindo o nome do arquivo de destino para compartilhar.

Devoluções

Name Caminho Tipo Description
links
 links array of object

Links
Link ID
 links.id string

O id do link.
Link Url
 links.url string

O url completo do link.
Destinatários
 links.recipients array of string

Uma matriz de endereços de e-mail válidos para os quais o link foi enviado.
Caminho do arquivo
 path string

Caminho completo do arquivo compartilhado.
Tipo
 type string

O tipo de link, seja arquivo, pasta ou upload.
Accessibility
 accessibility string

Por quem um link é acessível, um de qualquer pessoa, senha, domínio ou destinatários.
Notificar o criador quando acessado
 notify boolean

Se o criador do link será notificado por e-mail quando o link for acessado.
Refere-se à versão
 link_to_current boolean

Esta é a versão atual? T ou F
Data de Expiração
 expiry_date string

Data e hora da expiração do link.
Data de criação
 creation_date string

Data e hora de criação do link.
Criado por
 created_by string

Nome de usuário do usuário que criou o link.

Partilhar pasta

ID da Operação:
shareFolder

Partilhe uma pasta no Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 path True string

O caminho da pasta no Egnyte, para compartilhar.

Devoluções

Name Caminho Tipo Description
links
 links array of object

Links
Link ID
 links.id string

O id do link.
Link Url
 links.url string

O url completo do link.
Destinatários
 links.recipients array of string

Uma matriz de endereços de e-mail válidos para os quais o link foi enviado.
Caminho da pasta
 path string

Caminho completo da pasta compartilhada.
Tipo
 type string

O tipo de link, seja arquivo, pasta ou upload.
Accessibility
 accessibility string

Por quem um link é acessível, um de qualquer pessoa, senha, domínio ou destinatários.
Notificar o criador quando acessado
 notify boolean

Se o criador do link será notificado por e-mail quando o link for acessado.
Refere-se à versão
 link_to_current boolean

Esta é a versão atual? T ou F
Data de Expiração
 expiry_date string

Data e hora da expiração do link.
Data de criação
 creation_date string

Data e hora de criação do link.
Criado por
 created_by string

Nome de usuário do usuário que criou o link.

Pesquisar V1

ID da Operação:
searchV1

Encontre conteúdo armazenado no Egnyte com base em nomes de arquivos, metadados e conteúdo de texto. https://developers.egnyte.com/api-docs/read/search-api#Search-v1

Parâmetros

Name Chave Necessário Tipo Description
Consulta de pesquisa
 query True string

A cadeia de caracteres de pesquisa que você deseja localizar.
Compensação
 offset integer

O índice baseado em 0 do registro inicial que está sendo solicitado.
Contar
 count integer

O número de entradas por página.
Folder
 folder string

Limite os resultados a itens na pasta especificada e descendentes.
Modificado antes
 modifiedBefore string

Limite os resultados aos itens modificados antes deste carimbo de data/hora ISO-8601.
Modificado após
 modifiedAfter string

Limite os resultados aos itens modificados após este carimbo de data/hora ISO-8601.
Carregado antes
 uploadedBefore string

Limite os resultados aos itens carregados antes deste carimbo de data/hora ISO-8601.
Carregado após
 uploadedAfter string

Limite os resultados aos itens carregados após este carimbo de data/hora ISO-8601.
Tipo
 type string

Que tipos de itens devem ser pesquisados.
Trechos solicitados
 snippetRequested boolean

Se os resultados da pesquisa devem conter trechos.
Ordenar Por
 sortBy string

O campo que deve ser usado para classificação.
Direção da Ordenação
 sortDirection string

A direção do tipo.
Campos de consulta de arquivo
 fileQueryFields string

Pesquise arquivos usando campos específicos.
Campos de consulta de pasta
 folderQueryFields string

Procure pastas usando campos específicos.
Operador de consulta
 queryOperator string

Procure todas as palavras ou qualquer uma das palavras.

Devoluções

Name Caminho Tipo Description
results
 results array of object
Nome do arquivo
 results.name string
Caminho do arquivo
 results.path string
Tipo de MIME
 results.type string
Tamanho do Ficheiro
 results.size integer
Trechos
 results.snippet string
Trechos HTML
 results.snippet_html string
ID de entrada
 results.entry_id string
ID do grupo
 results.group_id string
Última modificação
 results.last_modified string
Enviado por
 results.uploaded_by string
Carregado por nome de utilizador
 results.uploaded_by_username string
Número de versões
 results.num_versions integer
É pasta
 results.is_folder boolean
Contagem Total
 total_count integer
Compensação
 offset integer
Contar
 count integer

Pesquisar V2

ID da Operação:
searchV2

Encontre conteúdo com recursos avançados de pesquisa. https://developers.egnyte.com/api-docs/read/search-api#Search-v2

Parâmetros

Name Chave Necessário Tipo Description
Consulta de pesquisa
 query True string

A cadeia de caracteres de pesquisa que você deseja localizar.
Compensação
 offset integer

O índice baseado em 0 do registro inicial que está sendo solicitado.
Contar
 count integer

O número de entradas por página.
Folder
 folder string

Limite os resultados a itens na pasta especificada e descendentes.
Modificado antes
 modifiedBefore integer

Limite os resultados a itens modificados antes deste carimbo de data/hora Unix em milissegundos.
Modificado após
 modifiedAfter integer

Limite os resultados a itens modificados após este carimbo de data/hora Unix em milissegundos.
Carregado antes
 uploadedBefore integer

Limite os resultados aos itens carregados antes deste carimbo de data/hora Unix em milissegundos.
Carregado após
 uploadedAfter integer

Limite os resultados aos itens carregados após este carimbo de data/hora Unix em milissegundos.
Tipo
 type string

Que tipos de itens devem ser pesquisados.
Trechos solicitados
 snippetRequested boolean

Se os resultados da pesquisa devem conter trechos.
Ordenar Por
 sortBy string

O campo que deve ser usado para classificação.
Direção da Ordenação
 sortDirection string

A direção do tipo.
Campos de consulta de arquivo
 fileQueryFields array of string

Pesquise arquivos usando campos específicos.
Campos de consulta de pasta
 folderQueryFields array of string

Procure pastas usando campos específicos.
Operador de consulta
 queryOperator string

Procure todas as palavras ou qualquer uma das palavras.
Mais como isto (IDs de documento)
 mlt array of string

Matriz de IDs de documentos a serem usados como referência para pesquisa de documentos semelhante.
Mais como este (texto)
 mltt array of string

Matriz de conteúdo de texto para usar como referência para pesquisa de documentos semelhantes.

Devoluções

Name Caminho Tipo Description
results
 results array of object
Nome do arquivo
 results.name string
Caminho do arquivo
 results.path string
Tipo de MIME
 results.type string
Tamanho do Ficheiro
 results.size integer
Trechos
 results.snippet string
Trechos HTML
 results.snippet_html string
ID de entrada
 results.entry_id string
ID do grupo
 results.group_id string
Última modificação
 results.last_modified string
Enviado por
 results.uploaded_by string
Carregado por nome de utilizador
 results.uploaded_by_username string
Número de versões
 results.num_versions integer
É pasta
 results.is_folder boolean
Propriedades personalizadas
 results.custom_properties array of object
Scope
 results.custom_properties.scope string
Namespace
 results.custom_properties.namespace string
Key
 results.custom_properties.key string
Valor
 results.custom_properties.value string
Pontuação de relevância
 results.score number
Contagem Total
 total_count integer
Contar
 count integer
Tem mais resultados
 hasMore boolean

Acionadores

Quando a permissão de arquivo ou pasta é alterada

Esta operação dispara um fluxo quando as permissões de um arquivo ou pasta são alteradas
Quando os metadados do arquivo ou pasta são alterados

Esta operação dispara um fluxo quando um arquivo ou uma pasta de metadados é alterado
Quando um arquivo é atualizado

Esta operação dispara um fluxo quando um arquivo é atualizado em uma pasta específica
Quando um arquivo é criado (sondagem)

Esta operação dispara um fluxo quando um novo arquivo é criado em uma pasta.
Quando um arquivo é criado (webhook)

Esta operação dispara um fluxo quando um arquivo é criado em uma pasta específica
Quando um arquivo é movido

Esta operação dispara um fluxo quando um arquivo é movido em uma pasta.
Quando um arquivo é renomeado

Esta operação dispara um fluxo quando um arquivo é renomeado em uma pasta.
Quando um ficheiro está bloqueado

Esta operação dispara um fluxo quando um arquivo está bloqueado
Quando um ficheiro é copiado

Esta operação dispara um fluxo quando um arquivo é copiado em uma pasta.
Quando um ficheiro é desbloqueado

Esta operação dispara um fluxo quando um arquivo é desbloqueado
Quando um ficheiro é eliminado

Esta operação dispara um fluxo quando um arquivo é excluído em uma pasta.
Quando um fluxo de trabalho de tipo de aprovação é aprovado

Esta operação dispara um fluxo quando um fluxo de trabalho de tipo de aprovação é aprovado
Quando um fluxo de trabalho de tipo de aprovação é rejeitado

Esta operação dispara um fluxo quando um fluxo de trabalho de tipo de aprovação é rejeitado
Quando um fluxo de trabalho é concluído

Esta operação dispara um fluxo quando um fluxo de trabalho é concluído
Quando um fluxo de trabalho é criado

Esta operação dispara um fluxo quando um fluxo de trabalho é criado
Quando um grupo é atualizado

Esta operação dispara um fluxo quando um grupo é atualizado
Quando um grupo é criado

Esta operação dispara um fluxo quando um grupo é criado
Quando um grupo é excluído

Esta operação dispara um fluxo quando um grupo é excluído
Quando um link de compartilhamento é criado

Esta operação dispara um fluxo quando um link de compartilhamento é criado
Quando um link de compartilhamento é excluído

Esta operação dispara um fluxo quando um link de compartilhamento é excluído
Quando um projeto é atualizado

Esta operação dispara um fluxo quando um projeto é atualizado
Quando uma pasta de projeto é criada

Esta operação dispara um fluxo quando uma pasta de projeto é criada ou quando uma pasta existente é marcada como uma pasta de projeto
Quando uma pasta não está marcada como um projeto

Esta operação dispara um fluxo quando uma pasta é desmarcada como um projeto
Quando uma pasta é copiada

Esta operação dispara um fluxo quando uma subpasta é copiada em uma pasta.
Quando uma pasta é criada

Esta operação dispara um fluxo quando uma subpasta é criada em uma pasta.
Quando uma pasta é excluída

Esta operação dispara um fluxo quando uma subpasta é excluída em uma pasta.
Quando uma pasta é movida

Esta operação dispara um fluxo quando uma subpasta é movida em uma pasta.
Quando uma pasta é renomeada

Esta operação dispara um fluxo quando uma subpasta é renomeada em uma pasta.

Quando a permissão de arquivo ou pasta é alterada

ID da Operação:
fileOrFolderPermissionChange

Esta operação dispara um fluxo quando as permissões de um arquivo ou pasta são alteradas

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Name Caminho Tipo Description
Cessionário
 assignee string
ID do cessionário
 assigneeId number
Cedente
 assigner string
ID do cedente
 assignerId number
Caminho da pasta
 folderPath string
Novo privilégio
 newPrivilege string
Antigo privilégio
 oldPrivilege string
Nome do Grupo
 groupName string

Quando os metadados do arquivo ou pasta são alterados

ID da Operação:
fileOrFolderMetadataChange

Esta operação dispara um fluxo quando um arquivo ou uma pasta de metadados é alterado

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Name Caminho Tipo Description
Caminho de destino
 targetPath string
ID do grupo-alvo
 targetGroupId string
Namespace
 namespace string
Key
 key string
Ação
 action string

Quando um arquivo é atualizado

ID da Operação:
fileUpdated

Esta operação dispara um fluxo quando um arquivo é atualizado em uma pasta específica

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para o arquivo ou pasta de destino.

Devoluções

Name Caminho Tipo Description
ID de entrada de arquivo
 targetEntryId string
ID do ficheiro
 targetGroupId string
Caminho do arquivo
 targetPath string

Quando um arquivo é criado (sondagem)

ID da Operação:
pollCreatedFiles

Esta operação dispara um fluxo quando um novo arquivo é criado em uma pasta.

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Name Caminho Tipo Description
ID do Evento
 id integer

A ID de um evento.
Data e Hora
 timestamp string

O carimbo de data/hora formatado pela ISO-8601 para quando esse evento foi gravado.
ID de utilizador
 actor integer

A ID numérica do usuário que executou a ação.
Ação
 action string

A ação associada a este evento.
Caminho do arquivo
 data.target_path string

Caminho completo para o arquivo.
ID da versão
 data.target_id string

A ID da versão específica do arquivo.
ID do ficheiro
 data.target_group_id string

O ID para fazer referência ao arquivo como um todo.
É pasta
 data.is_folder boolean

Se o recurso é uma pasta (True ou False).
Fonte de ação
 action_source string

A origem do evento. Por exemplo, WebUI, Mobile, etc.
Detalhe do objeto
 object_detail string

Detalhe do objeto.

Quando um arquivo é criado (webhook)

ID da Operação:
fileCreated

Esta operação dispara um fluxo quando um arquivo é criado em uma pasta específica

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para o arquivo ou pasta de destino.

Devoluções

Name Caminho Tipo Description
ID de entrada de arquivo
 targetEntryId string
ID do ficheiro
 targetGroupId string
Caminho do arquivo
 targetPath string
Carregar URL do link
 uploadLinkUrl string

Disponível apenas se o ficheiro tiver sido carregado através do link de carregamento

Quando um arquivo é movido

ID da Operação:
pollMovedFiles

Esta operação dispara um fluxo quando um arquivo é movido em uma pasta.

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Name Caminho Tipo Description
ID do Evento
 id integer

A ID de um evento individual.
Data e Hora
 timestamp string

O carimbo de data/hora formatado pela ISO-8601 para quando esse evento foi gravado.
ID de utilizador
 actor integer

A ID numérica do usuário que executou a ação.
Ação
 action string

A ação associada a este evento.
Caminho do arquivo
 data.target_path string

Caminho completo para o arquivo.
ID da versão
 data.target_id string

A ID da versão específica do arquivo.
ID do ficheiro
 data.target_group_id string

O ID para fazer referência ao arquivo como um todo.
Caminho do arquivo de origem
 data.source_path string

Caminho original completo para o arquivo.
É pasta
 data.is_folder boolean

Se o recurso é uma pasta. (Verdadeiro ou Falso)
Fonte de ação
 action_source string

A origem do evento. Por exemplo, WebUI, Mobile, etc.
Detalhe do objeto
 object_detail string

Detalhe do objeto.

Quando um arquivo é renomeado

ID da Operação:
pollRenamedFiles

Esta operação dispara um fluxo quando um arquivo é renomeado em uma pasta.

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Name Caminho Tipo Description
ID do Evento
 id integer

A ID de um evento individual.
Data e Hora
 timestamp string

O carimbo de data/hora formatado pela ISO-8601 para quando esse evento foi gravado.
ID de utilizador
 actor integer

A ID numérica do usuário que executou a ação.
Ação
 action string

A ação associada a este evento.
Caminho do arquivo
 data.target_path string

Caminho completo para o arquivo renomeado
ID da versão
 data.target_id string

A ID da versão específica do arquivo.
ID do ficheiro
 data.target_group_id string

O ID para fazer referência ao arquivo como um todo.
Caminho do arquivo de origem
 data.source_path string

Caminho original completo para o arquivo.
É pasta
 data.is_folder boolean

Se o recurso é uma pasta. (Verdadeiro ou Falso)
Fonte de ação
 action_source string

A origem do evento. Por exemplo, WebUI, Mobile, etc.
Detalhe do objeto
 object_detail string

Detalhe do objeto

Quando um ficheiro está bloqueado

ID da Operação:
fileLocked

Esta operação dispara um fluxo quando um arquivo está bloqueado

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para o arquivo ou pasta de destino.

Devoluções

Body
FileLockWebhookResponse

Quando um ficheiro é copiado

ID da Operação:
pollCopiedFiles

Esta operação dispara um fluxo quando um arquivo é copiado em uma pasta.

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Name Caminho Tipo Description
ID do Evento
 id integer

A ID de um evento individual.
Data e Hora
 timestamp string

O carimbo de data/hora formatado pela ISO-8601 para quando esse evento foi gravado.
ID de utilizador
 actor integer

A ID numérica do usuário que executou a ação.
Ação
 action string

A ação associada a este evento.
Caminho do arquivo
 data.target_path string

Caminho completo para o arquivo.
ID da versão
 data.target_id string

A ID da versão específica do arquivo.
ID do ficheiro
 data.target_group_id string

O ID para fazer referência ao arquivo como um todo.
Caminho do arquivo de origem
 data.source_path string

Caminho original completo para o arquivo.
ID da versão do arquivo de origem
 data.source_id string

ID da versão específica do arquivo de origem.
ID do arquivo de origem
 data.source_group_id string

O ID do arquivo de origem para fazer referência ao arquivo como um todo.
É pasta
 data.is_folder boolean

Se o recurso é uma pasta. (Verdadeiro ou Falso)
Fonte de ação
 action_source string

A origem do evento. Por exemplo, WebUI, Mobile, etc.
Detalhe do objeto
 object_detail string

Detalhe do objeto.

Quando um ficheiro é desbloqueado

ID da Operação:
fileUnlocked

Esta operação dispara um fluxo quando um arquivo é desbloqueado

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para o arquivo ou pasta de destino.

Devoluções

Body
FileLockWebhookResponse

Quando um ficheiro é eliminado

ID da Operação:
pollDeletedFiles

Esta operação dispara um fluxo quando um arquivo é excluído em uma pasta.

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Name Caminho Tipo Description
ID do Evento
 id integer

A ID de um evento.
Data e Hora
 timestamp string

O carimbo de data/hora formatado pela ISO-8601 para quando esse evento foi gravado.
ID de utilizador
 actor integer

A ID numérica do usuário que executou a ação.
Ação
 action string

A ação associada a este evento.
Caminho da versão
 data.target_path string

Caminho completo para a versão específica do arquivo.
ID do ficheiro
 data.target_group_id string

O ID para fazer referência ao arquivo como um todo.
É pasta
 data.is_folder boolean

Se o recurso é uma pasta. (Verdadeiro ou Falso)
Fonte de ação
 action_source string

A origem do evento. Por exemplo, WebUI, Mobile, etc.

Quando um fluxo de trabalho de tipo de aprovação é aprovado

ID da Operação:
workflowApprovalTaskApproved

Esta operação dispara um fluxo quando um fluxo de trabalho de tipo de aprovação é aprovado

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Body
WorkflowStepResponse

Quando um fluxo de trabalho de tipo de aprovação é rejeitado

ID da Operação:
workflowApprovalTaskRejected

Esta operação dispara um fluxo quando um fluxo de trabalho de tipo de aprovação é rejeitado

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Body
WorkflowStepResponse

Quando um fluxo de trabalho é concluído

ID da Operação:
workflowCompleted

Esta operação dispara um fluxo quando um fluxo de trabalho é concluído

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Name Caminho Tipo Description
ID do fluxo de trabalho
 workflow.id string
Nome do fluxo de trabalho
 workflow.name string
ID de exibição do fluxo de trabalho
 workflow.displayId number
Tipo de fluxo de trabalho
 workflow.type string
ID do modelo de fluxo de trabalho
 workflow.templateId string
Status da ação do fluxo de trabalho
 workflow.actionStatus string
Primeiro tipo de entidade
 firstEntity.type string
Primeiro caminho da entidade
 firstEntity.filePath string
ID da Primeira Entrada de Entidade
 firstEntity.entryID string
ID do Primeiro Grupo de Entidades
 firstEntity.groupID string
Código de status de conclusão
 completionStatusCode string
Número total de passos
 totalNumberOfSteps number
Data de conclusão
 completionDate number

Quando um fluxo de trabalho é criado

ID da Operação:
workflowCreated

Esta operação dispara um fluxo quando um fluxo de trabalho é criado

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Name Caminho Tipo Description
ID do fluxo de trabalho
 workflow.id string
Nome do fluxo de trabalho
 workflow.name string
ID de exibição do fluxo de trabalho
 workflow.displayId number
Tipo de fluxo de trabalho
 workflow.type string
ID do modelo de fluxo de trabalho
 workflow.templateId string
Status da ação do fluxo de trabalho
 workflow.actionStatus string
Primeiro tipo de entidade
 firstEntity.type string
Primeiro caminho da entidade
 firstEntity.filePath string
ID da Primeira Entrada de Entidade
 firstEntity.entryID string
ID do Primeiro Grupo de Entidades
 firstEntity.groupID string
Definição JSON
 definitionJson string

Quando um grupo é atualizado

ID da Operação:
groupUpdated

Esta operação dispara um fluxo quando um grupo é atualizado

Devoluções

Name Caminho Tipo Description
ID de utilizador
 user.id integer

O identificador exclusivo do usuário.
Nome Completo
 user.fullName string

O nome completo do utilizador.
Nome de utilizador
 user.userName string

O nome de usuário do usuário.
E-mail de utilizador
 user.email string

O endereço de e-mail do usuário.
ID de utilizador
 owner.id integer

O identificador exclusivo do usuário.
Nome Completo
 owner.fullName string

O nome completo do utilizador.
Nome de utilizador
 owner.userName string

O nome de usuário do usuário.
E-mail de utilizador
 owner.email string

O endereço de e-mail do usuário.
Nome do Grupo
 groupName string

O nome do grupo.
ID do grupo
 groupId string

O identificador exclusivo do grupo.
Ação
 action string

A ação específica que acionou a atualização do grupo.
Members
 members array of GroupUser

Os membros do grupo.

Quando um grupo é criado

ID da Operação:
groupCreated

Esta operação dispara um fluxo quando um grupo é criado

Devoluções

Name Caminho Tipo Description
ID de utilizador
 user.id integer

O identificador exclusivo do usuário.
Nome Completo
 user.fullName string

O nome completo do utilizador.
Nome de utilizador
 user.userName string

O nome de usuário do usuário.
E-mail de utilizador
 user.email string

O endereço de e-mail do usuário.
ID de utilizador
 owner.id integer

O identificador exclusivo do usuário.
Nome Completo
 owner.fullName string

O nome completo do utilizador.
Nome de utilizador
 owner.userName string

O nome de usuário do usuário.
E-mail de utilizador
 owner.email string

O endereço de e-mail do usuário.
Nome do Grupo
 groupName string

O nome do grupo.
ID do grupo
 groupId string

O identificador exclusivo do grupo.
Members
 members array of GroupUser

Os membros do grupo.

Quando um grupo é excluído

ID da Operação:
groupDeleted

Esta operação dispara um fluxo quando um grupo é excluído

Devoluções

Name Caminho Tipo Description
ID de utilizador
 user.id integer

O identificador exclusivo do usuário.
Nome Completo
 user.fullName string

O nome completo do utilizador.
Nome de utilizador
 user.userName string

O nome de usuário do usuário.
E-mail de utilizador
 user.email string

O endereço de e-mail do usuário.
Nome do Grupo
 groupName string

O nome do grupo.
ID do grupo
 groupId string

O identificador exclusivo do grupo.
ID da Operação:
shareLinkCreated

Esta operação dispara um fluxo quando um link de compartilhamento é criado

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Body
LinkWebhookResponse
ID da Operação:
shareLinkDeleted

Esta operação dispara um fluxo quando um link de compartilhamento é excluído

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Body
LinkWebhookResponse

Quando um projeto é atualizado

ID da Operação:
folderProjectUpdated

Esta operação dispara um fluxo quando um projeto é atualizado

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Name Caminho Tipo Description
projectId
 projectId string
projectRootFolderId
 projectRootFolderId string
Nome do Projeto
 name string
Localização do Projeto
 location string
Estado do Projeto
 status string

Estado do projeto (PENDENTE, EM CURSO, EM ESPERA, CONCLUÍDO, CANCELADO)

Quando uma pasta de projeto é criada

ID da Operação:
folderProjectAdded

Esta operação dispara um fluxo quando uma pasta de projeto é criada ou quando uma pasta existente é marcada como uma pasta de projeto

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Body
FolderProjectCommon

Quando uma pasta não está marcada como um projeto

ID da Operação:
folderProjectUnmarked

Esta operação dispara um fluxo quando uma pasta é desmarcada como um projeto

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Body
FolderProjectCommon

Quando uma pasta é copiada

ID da Operação:
pollCopiedFolders

Esta operação dispara um fluxo quando uma subpasta é copiada em uma pasta.

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Name Caminho Tipo Description
ID do Evento
 id integer

A ID de um evento individual.
Data e Hora
 timestamp string

O carimbo de data/hora formatado pela ISO-8601 para quando esse evento foi gravado.
ID de utilizador
 actor integer

A ID numérica do usuário que executou a ação.
Ação
 action string

A ação associada a este evento.
Caminho da pasta
 data.target_path string

Caminho de destino completo para a pasta
Caminho da pasta de origem
 data.source_path string

Caminho original completo para a pasta
É pasta
 data.is_folder boolean

Se o recurso é uma pasta (True ou False)
Fonte de ação
 action_source string

A origem do evento. Por exemplo, WebUI, Mobile, etc.
Detalhe do objeto
 object_detail string

Detalhe do objeto

Quando uma pasta é criada

ID da Operação:
pollCreatedFolders

Esta operação dispara um fluxo quando uma subpasta é criada em uma pasta.

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Name Caminho Tipo Description
ID do Evento
 id integer

A ID de um evento.
Data e Hora
 timestamp string

O carimbo de data/hora formatado pela ISO-8601 para quando esse evento foi gravado.
ID de utilizador
 actor integer

A ID numérica do usuário que executou a ação.
Ação
 action string

A ação associada a este evento.
Caminho da pasta
 data.target_path string

O caminho completo para a pasta.
É pasta
 data.is_folder boolean

Se o recurso é uma pasta. (Verdadeiro ou Falso)
Fonte de ação
 action_source string

A origem do evento. Por exemplo, WebUI, Mobile, etc.
Detalhe do objeto
 object_detail string

Detalhe do objeto.

Quando uma pasta é excluída

ID da Operação:
pollDeletedFolders

Esta operação dispara um fluxo quando uma subpasta é excluída em uma pasta.

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Name Caminho Tipo Description
ID do Evento
 id integer

A ID de um evento.
Data e Hora
 timestamp string

O carimbo de data/hora formatado pela ISO-8601 para quando esse evento foi gravado.
ID de utilizador
 actor integer

A ID numérica do usuário que executou a ação.
Ação
 action string

A ação associada a este evento.
Caminho da pasta
 data.target_path string

Caminho completo para a pasta excluída.
É pasta
 data.is_folder boolean

Se o recurso é uma pasta. (Verdadeiro ou Falso)
Fonte de ação
 action_source string

A origem do evento. Por exemplo, WebUI, Mobile, etc.

Quando uma pasta é movida

ID da Operação:
pollMovedFolders

Esta operação dispara um fluxo quando uma subpasta é movida em uma pasta.

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Name Caminho Tipo Description
ID do Evento
 id integer

A ID de um evento individual.
Data e Hora
 timestamp string

O carimbo de data/hora formatado pela ISO-8601 para quando esse evento foi gravado.
ID de utilizador
 actor integer

A ID numérica do usuário que executou a ação.
Ação
 action string

A ação associada a este evento.
Caminho da pasta
 data.target_path string

Caminho de destino completo para a pasta.
Caminho da pasta de origem
 data.source_path string

Caminho original completo para a pasta.
É pasta
 data.is_folder boolean

Se o recurso é uma pasta. (Verdadeiro ou Falso)
Fonte de ação
 action_source string

A origem do evento. Por exemplo, WebUI, Mobile, etc.
Detalhe do objeto
 object_detail string

Detalhe do objeto

Quando uma pasta é renomeada

ID da Operação:
pollRenamedFolders

Esta operação dispara um fluxo quando uma subpasta é renomeada em uma pasta.

Parâmetros

Name Chave Necessário Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Devoluções

Name Caminho Tipo Description
ID do Evento
 id integer

A ID de um evento individual.
Data e Hora
 timestamp string

O carimbo de data/hora formatado pela ISO-8601 para quando esse evento foi gravado.
ID de utilizador
 actor integer

A ID numérica do usuário que executou a ação.
Ação
 action string

A ação associada a este evento.
Caminho da pasta
 data.target_path string

Caminho de destino completo para a pasta.
Caminho da pasta de origem
 data.source_path string

Caminho original completo para a pasta.
É pasta
 data.is_folder boolean

Se o recurso é uma pasta. (Verdadeiro ou Falso)
Fonte de ação
 action_source string

A origem do evento. Por exemplo, WebUI, Mobile, etc.
Detalhe do objeto
 object_detail string

Detalhe do objeto

Definições

GroupUser

Name Caminho Tipo Description
ID de utilizador
 id integer

O identificador exclusivo do usuário.
Nome Completo
 fullName string

O nome completo do utilizador.
Nome de utilizador
 userName string

O nome de usuário do usuário.
E-mail de utilizador
 email string

O endereço de e-mail do usuário.

LinkWebhookResponse

Name Caminho Tipo Description
Caminho de origem
 sourcePath string
Link ID
 linkId string
Tipo de link
 linkType string

Pasta ou ficheiro
Ligação URL
 linkURL string

FileInfoResponse

Name Caminho Tipo Description
Soma de verificação
 checksum string

Valor da soma de verificação da versão atual do arquivo usado para determinar as alterações no arquivo.
Tamanho
 size integer

Tamanho do ficheiro em bytes.
Caminho do arquivo
 path string

Caminho completo do arquivo.
Nome
 name string

Nome do ficheiro.
Está bloqueado
 locked boolean

Status do bloqueio no arquivo.
É pasta
 is_folder boolean

Se o recurso é uma pasta. Verdadeiro ou Falso
ID da versão
 entry_id string

A ID da versão atual do arquivo.
ID do ficheiro
 group_id string

O ID para fazer referência ao arquivo como um todo.
ID da pasta principal
 parent_id string

A ID da pasta pai solicitada.
Última modificação
 last_modified string

Última modificação da versão atual de um arquivo.
Enviado por
 uploaded_by string

Nome de usuário do usuário que carregou a versão atual.
Carimbo de data/hora carregado
 uploaded integer

Hora de upload da versão atual do arquivo.
Número de versões
 num_versions integer

O número total de versões associadas ao caminho de arquivo específico.
versions
 versions array of object

Versions
É pasta (versão)
 versions.is_folder boolean

Se o recurso é uma pasta. Verdadeiro ou Falso
ID da versão
 versions.entry_id string

A ID da versão específica do arquivo.
Soma de verificação (versão)
 versions.checksum string

Valor da soma de verificação da versão do arquivo usado para determinar as alterações no arquivo.
Última modificação (versão)
 versions.last_modified string

Hora da última modificação da versão específica de um ficheiro.
Enviado por (versão)
 versions.uploaded_by string

Nome de usuário do usuário que carregou a versão.
Carimbo de data/hora carregado (versão)
 versions.uploaded integer

Tempo de carregamento da versão específica do ficheiro.
Tamanho (versão)
 versions.size integer

Tamanho do arquivo em bytes para a versão específica.

UserInfoResponse

Informação do utilizador

Name Caminho Tipo Description
ID de utilizador
 id integer

O ID de utilizador
Nome de utilizador
 userName string

O nome de utilizador do utilizador
ID externo
 externalId string

ID externo
Email
 email string

E-mail de utilizador
Nome de família
 name.familyName string

Nome de família de utilizador (Apelido)
Nome próprio
 name.givenName string

Nome próprio do utilizador (Nome)
Active
 active boolean

A conta de utilizador está ativa
Data de criação
 createdDate string

A data em que o usuário foi criado
Data da última modificação
 lastModificationDate string

A última data em que o usuário foi modificado
Última data ativa
 lastActiveDate string

A última data em que o usuário estava ativo
Bloqueada
 locked boolean

O usuário está bloqueado
Linguagem
 language string

O parâmetro "language" é aceito somente quando o Language Pack foi habilitado para o domínio.
Tipo de autenticação
 authType string

O tipo de autenticação para o usuário.
Tipo de utilizador
 userType string

O tipo do usuário.
Funções
 role string

A função atribuída ao usuário. Aplicável apenas a Utilizadores Avançados.
ID de usuário do IDP
 idpUserId string

ID de usuário do provedor de identidade
É conta de serviço
 isServiceAccount boolean

A conta é usada como conta de serviço
Eliminar no termo do prazo de validade
 deleteOnExpiry string

A conta será excluída depois que expirar?
Alteração de e-mail pendente
 emailChangePending boolean

A alteração do e-mail do usuário está pendente
Data de expiração
 expiryDate string

A expiração da conta
Nome principal do usuário
 userPrincipalName string
groups
 groups array of object
Nome de exibição
 groups.displayName string

O nome do grupo
ID do grupo
 groups.value string

A ID do grupo

UserListResponse

Obter resposta da Lista de Usuários

Name Caminho Tipo Description
Total de resultados
 totalResults integer

O número total de resultados correspondentes à consulta.
Itens por página
 itemsPerPage integer

O número de resultados retornados.
Iniciar índice
 startIndex integer

O índice baseado em 1 do primeiro resultado no conjunto atual de resultados.
resources
 resources array of object
ID de utilizador
 resources.id integer

O ID do utilizador
Nome de utilizador
 resources.userName string

O nome de utilizador do utilizador
ID externo
 resources.externalId string

ID externo
Email
 resources.email string

E-mail de utilizador
Nome formatado
 resources.name.formatted string

Nome formatado do usuário
Nome de família
 resources.name.familyName string

Nome de família de utilizador (Apelido)
Nome próprio
 resources.name.givenName string

Nome próprio do utilizador (Nome)
Active
 resources.active boolean

A conta de utilizador está ativa
Bloqueada
 resources.locked boolean

A conta de utilizador está bloqueada
Data de criação
 resources.createdDate string

A data em que o usuário foi criado
Data da última modificação
 resources.lastModificationDate string

A última data em que o usuário foi modificado
Última data ativa
 resources.lastActiveDate string

A última data em que o usuário estava ativo
Linguagem
 resources.language string

O parâmetro "language" é aceito somente quando o Language Pack foi habilitado para o domínio.
Tipo de autenticação
 resources.authType string

O tipo de autenticação para o usuário.
Tipo de utilizador
 resources.userType string

O tipo do usuário.
Funções
 resources.role string

A função atribuída ao usuário. Aplicável apenas a Utilizadores Avançados.
ID de usuário do IDP
 resources.idpUserId string

ID de usuário do provedor de identidade
É conta de serviço
 resources.isServiceAccount boolean

A conta é usada como conta de serviço
Eliminar no termo do prazo de validade
 resources.deleteOnExpiry string

A conta será excluída depois que expirar?
Alteração de e-mail pendente
 resources.emailChangePending boolean

A alteração do e-mail do usuário está pendente
Data de expiração
 resources.expiryDate string

A expiração da conta
Nome principal do usuário
 resources.userPrincipalName string

FolderInfoResponse

Name Caminho Tipo Description
Nome
 name string

Nome da pasta.
Última modificação
 lastModified integer

A última vez que qualquer arquivo na pasta (mas não dentro de subpastas) foi modificado.
Carimbo de data/hora carregado
 uploaded integer

Hora em que a pasta foi carregada ou criada.
Caminho da pasta
 path string

Caminho completo da pasta.
ID da pasta
 folder_id string

A ID exclusiva da pasta.
ID da pasta principal
 parent_id string

A id da pasta pai.
Contagem de subitens
 total_count integer

O número total de itens realmente disponíveis para devolução.
É pasta
 is_folder boolean

Se o recurso é uma pasta. Verdadeiro ou Falso
Possíveis ligações públicas
 public_links string

A configuração da opção de pasta como "Permitir links públicos desta pasta para" foi definida.
É partilhável
 allow_links boolean

É partilhável? T ou F
Pode ser excluído ou movido
 restrict_move_delete boolean

Pode ser eliminado ou movido? T ou F
pastas
 folders array of object

Pastas de Arquivos
Nome (subpasta)
 folders.name string

Nome da pasta.
Última modificação (subpasta)
 folders.lastModified integer

A última vez que qualquer arquivo na pasta (mas não dentro de subpastas) foi modificado.
Carimbo de data/hora carregado (subpasta)
 folders.uploaded integer

Hora em que a pasta foi carregada ou criada.
Caminho (subpasta)
 folders.path string

O caminho completo da pasta, conforme solicitado.
ID (subpasta)
 folders.folder_id string

A ID da pasta solicitada.
É pasta (subpasta)
 folders.is_folder boolean

Se o recurso é uma pasta. Verdadeiro ou Falso
ID da pasta pai (subpasta)
 folders.parent_id string

A id da pasta pai.
files
 files array of object

Ficheiros
Soma de verificação (arquivo)
 files.checksum string

Valor da soma de verificação da versão atual do arquivo usado para determinar as alterações no arquivo.
Tamanho (ficheiro)
 files.size integer

Tamanho do ficheiro em bytes.
Caminho (arquivo)
 files.path string

Caminho completo do arquivo.
Nome (ficheiro)
 files.name string

Nome do ficheiro.
Está bloqueado (ficheiro)
 files.locked boolean

Status do bloqueio no arquivo.
É pasta (arquivo)
 files.is_folder boolean

Se o recurso é uma pasta. Verdadeiro ou Falso
ID da versão (arquivo)
 files.entry_id string

A ID da versão específica do arquivo.
ID (ficheiro)
 files.group_id string

O ID para fazer referência ao arquivo como um todo.
ID da pasta pai (arquivo)
 files.parent_id string

A ID da pasta pai.
Última modificação (arquivo)
 files.last_modified string

Última modificação da versão atual de um arquivo.
Enviado por (arquivo)
 files.uploaded_by string

Nome de usuário do usuário que carregou a versão.
Carimbo de data/hora carregado (arquivo)
 files.uploaded integer

Hora de upload da versão atual do arquivo.
Contagem de versões (arquivo)
 files.num_versions integer

O número total de versões associadas ao caminho de arquivo específico.

NamespaceItem

Name Caminho Tipo Description
Nome do namespace
 name string
Escopo do namespace
 scope string
Teclas
 keys object
nome de exibição
 displayName string

O nome para identificar o namespace na interface do usuário
priority
 priority number

Especifica a prioridade (ordem) para as chaves. As chaves serão exibidas de acordo com suas prioridades em ordem decrescente (chaves com prioridade mais alta serão exibidas primeiro)
hereditário
 inheritable boolean
schemaSystemGenerated
 schemaSystemGenerated boolean
metadataScopeType
 metadataScopeType string
editável
 editable boolean

Item de Projeto

Name Caminho Tipo Description
Id
 id string

Item Id
ID da pasta raiz
 rootFolderId string

ID da pasta raiz
Nome
 name string

O nome do projeto
ID do projeto
 projectId string

ID do projeto
Nome do Cliente
 customerName string

O cliente associado ao projeto
Description
 description string

Descrição da pasta
localização
 location ProjectLocationItem
Situação
 status string

Estado do projeto
Criado por
 createdBy number

Criado por
Última atualização por
 lastUpdatedBy number

Última atualização por
Tempo de Criação
 creationTime string

Tempo de Criação
Hora da última modificação
 lastModifiedTime string

Hora da última modificação
Data de início
 startDate string

A data de início do projeto.
Data de conclusão
 completionDate string

A data de conclusão do projeto.

ProjectLocationItem

Name Caminho Tipo Description
Endereço 1
 streetAddress1 string

Primeira linha do endereço
Endereço 2
 streetAddress2 string

Segunda linha do endereço
City
 city string

City
Estado ou Província
 state string

Estado ou Província
Country
 country string

Country
Código postal ou código postal
 postalCode string

Código postal ou código postal

FileLockWebhookResponse

Name Caminho Tipo Description
ID do ficheiro
 targetGroupId string
Soma de verificação do arquivo
 targetFileChecksum string
Caminho do arquivo
 targetPath string

FolderProjectCommon

Name Caminho Tipo Description
projectId
 projectId string
projectRootFolderId
 projectRootFolderId string

WorkflowStepResponse

Name Caminho Tipo Description
ID do fluxo de trabalho
 workflow.id string
Nome do fluxo de trabalho
 workflow.name string
ID de exibição do fluxo de trabalho
 workflow.displayId number
Tipo de fluxo de trabalho
 workflow.type string
ID do modelo de fluxo de trabalho
 workflow.templateId string
Status da ação do fluxo de trabalho
 workflow.actionStatus string
Primeiro tipo de entidade
 firstEntity.type string
Primeiro caminho da entidade
 firstEntity.filePath string
ID da Primeira Entrada de Entidade
 firstEntity.entryID string
ID do Primeiro Grupo de Entidades
 firstEntity.groupID string
ID do passo
 step.id string
Nome da etapa
 step.name string
Tipo de Passo
 step.type string
ID do cessionário
 assignee.id number
Nome de exibição do cessionário
 assignee.displayName string
Nome de utilizador do cessionário
 assignee.username string
Endereço eletrónico do cessionário
 assignee.email string
Número total de passos
 totalNumberOfSteps number
Data de conclusão
 completionDate number
Data de criação
 creationDate number

AIQuestionResponse

Name Caminho Tipo Description
response
 response AIResponse
Citações
 citations array of AICitation

Citações e referências utilizadas na geração da resposta

AISummaryResponse

Name Caminho Tipo Description
response
 response AIResponse

AICopilotResponse

Name Caminho Tipo Description
response
 response AIResponse
Citações
 citations array of AICitation

Citações e referências utilizadas na geração da resposta
ID da conversação
 conversationId string

Identificador exclusivo da conversa

AICitação

Name Caminho Tipo Description
Nome do ficheiro
 filename string

Nome do ficheiro de origem
ID de entrada
 entryId string

ID de entrada do arquivo de origem
Blocos de texto
 chunks array of object

Matriz de blocos de texto da fonte
ID do bloco
 chunks.chunkId string

ID do bloco de texto
Texto de partida
 chunks.sourceText string

Conteúdo de texto do bloco

AIResponse

Name Caminho Tipo Description
Texto de resposta
 text string

O texto de resposta gerado por IA