Compartilhar via

Egnyte

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

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

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte do Egnyte
URL https://helpdesk.egnyte.com
Email support@egnyte.com
Metadados do conector
Publicador Egnyte
Site 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 seus arquivos seguros, sincronizados e fáceis de compartilhar. Conecte-se ao Egnyte para gerenciar seus arquivos. Você pode executar várias ações, como carregar, mover, baixar e excluir arquivos no Egnyte.

Pré-requisitos

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

Ações Suportadas

O conector dá suporte às seguintes ações:

Gatilhos com suporte

O conector dá suporte aos seguintes gatilhos:

  • When a file is locked: essa operação dispara um fluxo quando um arquivo é bloqueado
  • When a file is unlocked: essa 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 pasta específica
  • When a file is created (webhook): esta operação dispara um fluxo quando um arquivo é criado em pasta específica
  • When a share link is created: essa 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: essa operação dispara um fluxo quando um arquivo ou uma pasta é alterado
  • When the file or folder metadata changes: esta operação dispara um fluxo quando um arquivo ou metadados de pasta é alterado
  • When a project folder is created: essa 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: essa 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: essa operação dispara um fluxo quando um fluxo de trabalho é criado
  • When a workflow is completed: essa 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: essa 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: essa operação dispara um fluxo quando um grupo é excluído
  • When a file is created (polling): essa operação dispara um fluxo quando um novo arquivo é criado em uma pasta.
  • When a folder is created: essa operação dispara um fluxo quando uma subpasta é criada em uma pasta.
  • When a file is deleted: essa operação dispara um fluxo quando um arquivo é excluído em uma pasta.
  • When a folder is deleted: essa operação dispara um fluxo quando uma subpasta é excluída em uma pasta.
  • When a file is renamed: essa operação dispara um fluxo quando um arquivo é renomeado em uma pasta.
  • When a folder is renamed: essa operação dispara um fluxo quando uma subpasta é renomeada em uma pasta.
  • When a file is moved: essa operação dispara um fluxo quando um arquivo é movido em uma pasta.
  • When a folder is moved: essa operação dispara um fluxo quando uma subpasta é movida em uma pasta.
  • When a file is copied: essa operação dispara um fluxo quando um arquivo é copiado em uma pasta.
  • When a folder is copied: essa operação dispara um fluxo quando uma subpasta é copiada em uma pasta.

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

[IA] Faça uma pergunta a Egnyte Copilot

Faça perguntas ao copilot da plataforma, fornecendo uma resposta orientada por IA com base no conteúdo global em seu domínio Egnyte. https://developers.egnyte.com/api-docs/read/ai-api#Copilot
[IA] Faça 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] 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 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

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

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

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

Compartilhe um arquivo no Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
Compartilhar pasta

Compartilhe uma pasta no Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
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 arquivo 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 uma ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Criar arquivo

Carrega um arquivo no Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Upload-a-File
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 grupo

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

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 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 uma pasta

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

Crie um novo usuário no Egnyte. Saiba mais: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Create-Single-User
Definir metadados por ID da pasta

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

Escreva metadados em um arquivo usando a ID do arquivo. 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 arquivo por ID

Desbloqueie o arquivo usando a ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File
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

Excluir 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 uma 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
Excluir usuário por ID

Exclua um usuário do Egnyte. Saiba mais: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-User
Limpar projeto por ID

Esse ponto de extremidade inicia uma limpeza em um projeto e, opcionalmente, exclui ou desabilitar usuários especificados. https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-Project
Link profundo 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
Link profundo por ID

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

Lista todos os links, exceto links excluídos. Observe que, se o usuário que executa esse método não for um administrador, somente 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. Observe que, se o usuário que executa esse método não for um administrador, somente 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

Localize 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 opções de pasta, como descrição, configurações de compartilhamento de link, permissões de link público, restrições de movimentação/exclusão e preferências de notificação por email. https://developers.egnyte.com/api-docs/read/folder-options-api
Mostrar detalhes do link

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

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

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

Mover 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

Mover uma pasta usando a ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Obter conteúdo do 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 do arquivo por ID

Recupera o conteúdo do arquivo do Egnyte usando a 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 a ID. https://developers.egnyte.com/api-docs/read/group-management#Show-Single-Group
Obter detalhes do usuário

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

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

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

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

Recuperar informações de 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 da 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 metadados por ID do 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 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 o projeto por ID da pasta raiz

Recupere um projeto com base na ID da pasta raiz. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-Root-Folder
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 a ID. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-ID
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 de projeto no domínio. https://developers.egnyte.com/api-docs/read/project-folder-api#Get-All-Projects
Pesquisar V1

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

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

[IA] Faça uma pergunta a Egnyte Copilot

ID da operação:
copilotAsk

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Pergunta
 question True string

A pergunta específica que você deseja 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 (padrões como false)
Função
 role string
Conteúdo da Mensagem
 content string

Retornos

Corpo
AICopilotResponse

[IA] Faça 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

Nome Chave Obrigatório Tipo Description
ID de entrada de arquivo
 entryId True string

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

A pergunta específica que você deseja fazer
Incluir citações
 includeCitations boolean

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

Retornos

Corpo
AIQuestionResponse

[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

Nome Chave Obrigatório Tipo Description
ID de entrada de arquivo
 entryId True string

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

Retornos

Corpo
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

Nome Chave Obrigató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) das chaves. As chaves serão exibidas de acordo com suas prioridades em ordem decrescente (chaves com prioridade mais alta serão exibidas primeiro)

Retornos

Corpo
NamespaceItem

Atualizar chaves de namespace

ID da operação:
updateNamespaceKeys

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

Parâmetros

Nome Chave Obrigató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) das 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 de tipo enumerado, especifica os valores enumerados
helpText
 helpText string

Texto instrucional exibido quando um usuário está adicionando/editando uma propriedade para dar contexto quanto à finalidade da propriedade

Retornos

Nome 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 da dica de ferramenta para o campo de metadados
priority
 priority number

Especifica a prioridade da chave (as chaves com 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

Nome Chave Obrigató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.
nomeDoCliente
 customerName string

O cliente associado ao projeto.
Endereço1
 streetAddress1 string

Primeira linha do endereço da rua.
endereço2
 streetAddress2 string

Segunda linha do endereço da rua.
city
 city string

Cidade.
estado
 state string

Estado ou província.
postalCode
 postalCode string

Cep ou código postal.
country
 country string

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

Status 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 de conclusão prevista 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

Nome Chave Obrigatório Tipo Description
ID do Usuário
 id True integer

Identificador exclusivo para o usuário
Email do usuário
 email string

O endereço de email do usuário.
Nome indicado
 givenName string

Primeiro nome do usuário.
Nome da família
 familyName string

Sobrenome do usuário.
Active
 active boolean

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

Se definido como true, um email de convite será enviado. O parâmetro não pode ser o único modificado por essa 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 usuário
 userType string

O tipo do usuário.
Função
 role string

A função atribuída ao usuário. Aplicável somente aos Usuários do Power.
ID do usuário do IDP
 idpUserId string

Necessário somente se o usuário estiver autenticado em 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 está autenticado no AD.

Retornos

Nome Caminho Tipo Description
ID do Usuário
 id integer

Identificador exclusivo para o usuário
Email do usuário
 email string

O endereço de email do usuário.
Nome da família
 familyName string

Sobrenome do usuário.
Nome indicado
 givenName string

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 email de convite será enviado.
Linguagem
 language string

Ele é aceito somente quando o Language Pack foi habilitado.
Tipo de autenticação
 authType string

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

O tipo do usuário.
Função
 role string

A função atribuída ao usuário. Aplicável somente aos Usuários do Power.
ID do usuário do IDP
 idpUserId string

Necessário somente se o usuário for autenticado em SSO
Nome Principal do Usuário
 userPrincipalName string

Não especifique se o usuário não está autenticado no 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

Nome Chave Obrigatório Tipo Description
ID do grupo
 id True string

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

O nome de exibição do grupo.
ID do Usuário
 value integer

A ID global exclusiva de um membro do grupo.

Retornos

Nome Caminho Tipo Description
ID do grupo
 id string

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

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

Membros do grupo
Nome de usuário
 members.username string

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

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

O nome de exibição de um membro.

Atualização parcial do grupo

ID da operação:
partialGroupUpdate

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do grupo
 id True string

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

O nome de exibição do grupo.
ID do Usuário
 value integer

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

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

Retornos

Nome Caminho Tipo Description
ID do grupo
 id string

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

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

Membros do grupo
Nome de usuário
 members.username string

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

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

O nome de exibição de um membro.

Bloquear arquivo por caminho

ID da operação:
lockFileByPath

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

Parâmetros

Nome Chave Obrigató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.

Retornos

Nome Caminho Tipo Description
Intervalo
 timeout integer

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

O token que deve ser usado para desbloquear o arquivo.

Bloquear arquivo por ID

ID da operação:
lockFileById

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do arquivo
 id True string

O identificador exclusivo do arquivo no Egnyte.

Retornos

Nome Caminho Tipo Description
Intervalo
 timeout integer

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

O token que deve ser usado para desbloquear o arquivo.

Compartilhar arquivo

ID da operação:
shareFile

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho do Arquivo
 path True string

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

Retornos

Nome Caminho Tipo Description
links
 links array of object

Links
Link ID
 links.id string

A ID do link.
Link Url
 links.url string

A URL completa do link.
Destinatários
 links.recipients array of string

Uma matriz de endereços de email 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, arquivo, pasta ou upload.
Accessibility
 accessibility string

Por quem um link está 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 email quando o link for acessado.
Está se referindo à versão
 link_to_current boolean

Essa é a versão atual? T ou F
Data de vencimento
 expiry_date string

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

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

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

Compartilhar pasta

ID da operação:
shareFolder

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 path True string

O caminho da pasta no Egnyte, a ser compartilhado.

Retornos

Nome Caminho Tipo Description
links
 links array of object

Links
Link ID
 links.id string

A ID do link.
Link Url
 links.url string

A URL completa do link.
Destinatários
 links.recipients array of string

Uma matriz de endereços de email 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, arquivo, pasta ou upload.
Accessibility
 accessibility string

Por quem um link está 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 email quando o link for acessado.
Está se referindo à versão
 link_to_current boolean

Essa é a versão atual? T ou F
Data de vencimento
 expiry_date string

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

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

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

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

Nome Chave Obrigató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.

Retornos

Nome Caminho Tipo Description
Caminho do Arquivo
 path string

Caminho completo do arquivo copiado.
ID de Arquivo
 group_id string

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

Copiar arquivo 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

Nome Chave Obrigató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.

Retornos

Nome Caminho Tipo Description
Caminho do Arquivo
 path string

Caminho completo do arquivo copiado.
ID de Arquivo
 group_id string

A 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

Nome Chave Obrigató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.

Retornos

Nome 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 uma ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Parâmetros

Nome Chave Obrigató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.

Retornos

Nome 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 arquivo

ID da operação:
createFile

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome do arquivo
 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 no Egnyte.
Conteúdo do ficheiro
 body True binary

O conteúdo do arquivo a ser carregado no Egnyte.

Retornos

Nome Caminho Tipo Description
ID da versão
 id string

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

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

Caminho completo do arquivo carregado.

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

Nome Chave Obrigató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 de 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 da chave (as chaves com prioridade mais alta serão exibidas primeiro).
Texto de ajuda
 helpText string

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

Para uma chave de tipo enumerado, especifica os valores enumerados.

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

Nome Chave Obrigatório Tipo Description
Nome de exibição
 displayName True string

O nome de exibição do grupo.
ID do Usuário
 value string

A ID global exclusiva de um membro do grupo.

Retornos

Nome Caminho Tipo Description
ID do grupo
 id string

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

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

Membros do grupo
Nome de usuário
 members.username string

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

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

O nome de exibição de um membro.
ID da operação:
createLink

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

Parâmetros

Nome Chave Obrigató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 está acessível. Necessário, exceto para links de upload ou quando "useDefaultSettings" for verdadeiro.
Usar configurações padrão
 useDefaultSettings True boolean

Determina se os parâmetros padrão devem ser usados no domínio para criação de link
Enviar email
 send_email boolean

Se true for definido, o link será enviado por email pelo Egnyte.
Destinatários
 recipients array of string

Listar endereços de email de destinatários do link. Necessário somente se "Enviar email" for verdadeiro.
Mensagem (aplica-se somente se "Enviar email" for true.)
 message string

Mensagem pessoal a ser enviada em email de link.
Copiar-me (aplica-se somente se "Enviar email" for verdadeiro)
 copy_me boolean

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

Se true for definido, o criador do link será notificado por email quando o link for acessado.
Link para atual (aplicável somente para links de arquivo.)
 link_to_current boolean

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

Data de expiração 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 o qual o link é válido. Se especificado, "Data de expiração" não pode ser definida
Adicionar um nome de arquivo (aplica-se somente a links de arquivo, não a links de pasta)
 add_file_name boolean

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

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

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

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

Retornos

Nome Caminho Tipo Description
Links
 links array of object

Uma matriz que contém as informações de json completas para todos os links para seu domínio que esse usuário pode ver em quaisquer intervalos especificados
ID
 links.id string

A ID do link
URL
 links.url string

A URL completa do link
Destinatários
 links.recipients array of string

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

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

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

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

Booliano sobre se o criador do link será notificado por email quando o link for acessado.
Link para atual
 link_to_current boolean

Booliano sobre se o link sempre se referirá à versão atual do arquivo. Aplicável somente para links de arquivo.
Data de vencimento
 expiry_date string

Data e hora da expiração do link. Esse campo só será mostrado se o link expirar por data
Data de criação
 creation_date string

Data e hora da 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

Nome Chave Obrigató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 da Ajuda
 helpText string

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

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

Para uma chave de tipo enumerado, especifica os valores enumerados

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

Nome Chave Obrigatório Tipo Description
ID da pasta pai
 parentFolderId True string

ID da pasta pai em que a pasta do projeto será criada
ID da pasta de 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

Status 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 de Rua 1
 streetAddress1 string

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

Segunda linha do endereço
City
 city string

City
Estado
 state string

Estado
País
 country string

País
Cep ou cep
 postalCode string

Cep ou cep

Retornos

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

ID do projeto
Nome do projeto
 groupsCreated.name string

Nome do projeto

Criar uma 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

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 path True string

O caminho completo da nova pasta.

Retornos

Nome 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 usuário

ID da operação:
createUser

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome de usuário
 userName True string

O nome de usuário do Egnyte para o usuário. Deve começar com uma letra ou dígito.
Email
 email True string

O endereço de email do usuário (por exemplo admin@acme.com).
Nome indicado
 givenName True string

Primeiro nome do usuário.
Nome da família
 familyName True string

Sobrenome do usuário.
Active
 active True boolean

Se o usuário está ativo ou inativo.
Tipo de usuário
 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 externa
 externalId string

Identificador exclusivo imutável fornecido pelo consumidor de API.
Enviar convite
 sendInvite boolean

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

Se definido como true ao criar um usuário, o usuário 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ção
 role string

A função atribuída ao usuário. Aplicável somente aos Usuários do Power.
ID do usuário do IDP
 idpUserId string

Necessário somente se o usuário estiver autenticado em SSO e não estiver usando o mapeamento de usuário padrão. Não especifique se o usuário não está autenticado no SSO.
Nome Principal do Usuário
 userPrincipalName string

Não especifique se o usuário não está autenticado no AD. Usado para associar políticas de autenticação filho a um usuário ao usar a autenticação do Active Directory em uma configuração de vários domínios.

Retornos

Nome Caminho Tipo Description
ID do Usuário
 id integer

Identificador exclusivo para o usuário recém-criado
Nome de usuário
 userName string

O nome de usuário do Egnyte para o usuário.
ID externa
 externalId string

Identificador exclusivo imutável fornecido pelo consumidor de API.
Email
 email string

O endereço de email do usuário.
Alteração de email pendente
 emailChangePending boolean

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

Primeiro nome do usuário.
Nome da família
 name.familyName string

Sobrenome do usuário.
Nome formatado
 name.formatted string

O nome completo formatado do usuário.
Active
 active boolean

Se o usuário está ativo.
Bloqueado
 locked boolean

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

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

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

A maneira como o usuário é identificado na Resposta SAML de um Provedor de Identidade de SSO.
Nome Principal do Usuário
 userPrincipalName string

Usado para associar políticas de autenticação filho a um usuário ao usar a autenticação do Active Directory.
Função
 role string

A função atribuída ao usuário. Aplicável somente aos Usuários do Power.
Linguagem
 language string

A preferência de idioma para o usuário.
Data da 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 a hora da última modificação.
Última data ativa
 lastActiveDate date-time

A data e a hora da última atividade.
Data de vencimento
 expiryDate date-time

A data em que a conta de usuário expirará.

Definir metadados por ID da pasta

ID da operação:
setMetadataByFolderId

Escreva 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

Nome Chave Obrigató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 metadados por ID do arquivo

ID da operação:
setMetadataByFileId

Escreva 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

Nome Chave Obrigató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 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

Nome Chave Obrigató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 da permissão.
Permissões de grupo
 groupPerms object

Mapa do nome do grupo para o valor da 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

Nome Chave Obrigató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 do arquivo.

Desbloquear arquivo por ID

ID da operação:
unlockFileById

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

Parâmetros

Nome Chave Obrigató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 do arquivo.

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

Nome Chave Obrigatório Tipo Description
Caminho do Arquivo
 path True string

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

Retornos

Nome 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

Nome Chave Obrigatório Tipo Description
ID do arquivo
 id True string

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

Retornos

Nome 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

Nome Chave Obrigató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 exclusão
 force boolean

Exclua mesmo se a chave de metadados for 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

Nome Chave Obrigatório Tipo Description
ID do grupo
 id True string

A ID do grupo.
ID da operação:
deleteLink

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Link Id
 linkId True string

LinkId

Excluir namespace

ID da operação:
deleteNamespace

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome do namespace
 namespace True string

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

Excluir mesmo se o namespace for 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

Nome Chave Obrigató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.

Retornos

Nome 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 uma ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da pasta
 id True string

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

Retornos

Nome 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

Nome Chave Obrigatório Tipo Description
ID do projeto
 projectId True string

ID do projeto que está sendo excluído

Excluir usuário por ID

ID da operação:
deleteUser

Exclua um usuário do Egnyte. Saiba mais: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-User

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Usuário
 id True integer

A ID do usuário a ser 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 desabilitar usuários especificados. https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-Project

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do projeto
 projectId True string

ID do projeto
deleteLinks
 deleteLinks True boolean

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

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

Lista de IDs de usuário a serem desabilitadas.

Retornos

Nome Caminho Tipo Description
mensagem
 message string
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

Nome Chave Obrigatório Tipo Description
Caminho
 path True string

Caminho do arquivo ou pasta

Retornos

Nome Caminho Tipo Description
URL
 url string

Link profundo
ID da operação:
deepLinksById

Crie um link profundo 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

Nome Chave Obrigatório Tipo Description
ID
 id True string

ID do arquivo ou pasta
Tipo
 type True string

Tipo do link

Retornos

Nome Caminho Tipo Description
URL
 url string

Link profundo
ID da operação:
listLinks

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho
 path string

Listar links para um arquivo ou pasta especificado por seu caminho completo.
Nome de usuário
 username string

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

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

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

Filtrar somente para itens de "arquivo" ou "pasta".
Accessibility
 accessibility string

Selecionar tipo de acessibilidade
Offset
 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.

Retornos

Nome Caminho Tipo Description
Ids
 ids array of string

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

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

A contagem de itens retornados. Se esse 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. Observe que, se o usuário que executa esse método não for um administrador, somente 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

Nome Chave Obrigatório Tipo Description
Caminho
 path string

Listar links para um arquivo ou pasta especificado por seu caminho completo.
Nome de usuário
 username string

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

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

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

Filtrar somente para itens de "arquivo" ou "pasta".
Accessibility
 accessibility string

Selecionar tipo de acessibilidade
Offset
 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.

Retornos

Nome Caminho Tipo Description
Links
 links array of object

Uma matriz que contém as informações de json completas para todos os links para seu domínio que esse usuário pode ver em quaisquer intervalos especificados
Caminho
 links.path string

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

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

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

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

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

Booliano sobre se o criador do link será notificado por email quando o link for acessado.
URL
 links.url string

A URL completa do link
ID
 links.id string

A ID do link
Link para atual
 links.link_to_current boolean

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

Data e hora da 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 do grupo se for um link de arquivo ou a ID da pasta se for uma pasta ou um link de upload
Cliques de expiração
 links.expiry_clicks number

Número de cliques deixados no link antes da expiração. Esse campo só será mostrado se o link expirar por meio de cliques
Último acesso
 links.last_accessed string

Data e hora do último acesso do link. Esse campo só será mostrado se o link tiver sido acessado pelo menos uma vez
Data de vencimento
 links.expiry_date string

Data e hora da expiração do link. Esse campo só será mostrado se o link expirar por data
Contagem
 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

Nome Chave Obrigató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

Status 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.

Retornos

Nome Caminho Tipo Description
ID
 id string

Item Id

Metadados de pesquisa

ID da operação:
searchMetadata

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Tipo de pesquisa
 type string

Quais tipos de item 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 opções de pasta, como descrição, configurações de compartilhamento de link, permissões de link público, restrições de movimentação/exclusão e preferências de notificação por email. https://developers.egnyte.com/api-docs/read/folder-options-api

Parâmetros

Nome Chave Obrigató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 nessa pasta.
Links públicos
 public_links string

Especifique que tipo de links públicos são permitidos. Valores possíveis: files_folders, arquivos, desabilitados.
Restringir movimentação/exclusão
 restrict_move_delete boolean

Restrinja operações de movimentação e exclusão a apenas proprietários e administradores de pastas.
Notificações de Atualizações de Conteúdo
 content_updates boolean

Habilite notificações por email para atualizações de conteúdo.
Notificações acessadas por conteúdo
 content_accessed boolean

Habilite as notificações por email para o conteúdo acessado.

Retornos

Nome Caminho Tipo Description
Nome
 name string

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

A última vez em 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 links públicos
 public_links string

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

Pode ser excluído ou movido? T ou F
ID da operação:
showLinkDetails

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Link Id
 linkId True string

LinkId

Retornos

Nome Caminho Tipo Description
Links
 links array of object

Uma matriz que contém as informações de json completas para todos os links para seu domínio que esse usuário pode ver em quaisquer intervalos especificados
ID
 links.id string

A ID do link
URL
 links.url string

A URL completa do link
Destinatários
 links.recipients array of string

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

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

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

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

Booliano sobre se o criador do link será notificado por email quando o link for acessado.
Link para atual
 link_to_current boolean

Booliano sobre se o link sempre se referirá à versão atual do arquivo. Aplicável somente para links de arquivo.
Data de vencimento
 expiry_date string

Data e hora da expiração do link. Esse campo só será mostrado se o link expirar por data
Data de criação
 creation_date string

Data e hora da 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. Esse campo só será mostrado se o link tiver sido acessado pelo menos uma vez

Mover arquivo por caminho

ID da operação:
moveFileByPath

Mover 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

Nome Chave Obrigató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.

Retornos

Nome Caminho Tipo Description
Caminho do Arquivo
 path string

Caminho completo do arquivo movido.
ID de Arquivo
 group_id string

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

Mover arquivo por ID

ID da operação:
moveFileById

Mover um arquivo no Egnyte usando a ID do arquivo. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Parâmetros

Nome Chave Obrigató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.

Retornos

Nome Caminho Tipo Description
Caminho do Arquivo
 path string

Caminho completo do arquivo movido.
ID de Arquivo
 group_id string

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

Mover pasta por caminho

ID da operação:
moveFolderByPath

Mover 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

Nome Chave Obrigató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.

Retornos

Nome 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

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

Parâmetros

Nome Chave Obrigató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.

Retornos

Nome 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 do 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

Nome Chave Obrigatório Tipo Description
Caminho do Arquivo
 filePath True string

O caminho exclusivo para o arquivo no Egnyte.

Obter conteúdo do arquivo por ID

ID da operação:
getFileContentById

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

Parâmetros

Nome Chave Obrigató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 a ID. https://developers.egnyte.com/api-docs/read/group-management#Show-Single-Group

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do grupo
 id True string

A ID do grupo.

Retornos

Nome Caminho Tipo Description
ID do grupo
 id string

A ID de grupo globalmente exclusiva.
Nome de 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 do Usuário
 members.value number

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

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

Obter detalhes do usuário

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

Nome Chave Obrigatório Tipo Description
ID do Usuário
 id True integer

A ID do usuário

Retornos

Informações do usuário

Corpo
UserInfoResponse

Obter informações da pasta por caminho

ID da operação:
folderInfoByPath

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 path True string

O caminho exclusivo para a pasta no Egnyte.

Retornos

Corpo
FolderInfoResponse

Obter informações da pasta por ID

ID da operação:
folderInfoById

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da pasta
 id True string

O identificador exclusivo da pasta no Egnyte.

Retornos

Corpo
FolderInfoResponse

Obter informações de arquivo por caminho

ID da operação:
fileInfoByPath

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho do Arquivo
 path True string

O caminho exclusivo para o arquivo no Egnyte.

Retornos

Corpo
FileInfoResponse

Obter informações de arquivo por ID

ID da operação:
fileInfoById

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do arquivo
 id True string

O identificador exclusivo do arquivo no Egnyte.

Retornos

Corpo
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

Nome Chave Obrigatório Tipo Description
Índice de Início
 startIndex integer

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

O número de entradas por página (mínimo 1, máximo de 100)
Filter
 filter string

Permite que você solicite um subconjunto de grupos. Esses termos não diferenciam maiúsculas de minúsculas

Retornos

Nome 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

A ID de grupo globalmente exclusiva.
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

Nome Chave Obrigatório Tipo Description
Índice de Início
 startIndex integer

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

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

Permite que você solicite um subconjunto de usuários. Consulte a documentação na seção Sobre.

Retornos

Obter resposta da Lista de Usuários

Corpo
UserListResponse

Obter metadados por ID da 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

Nome Chave Obrigató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 metadados por ID do 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

Nome Chave Obrigatório Tipo Description
ID de Arquivo
 fileId True string

O identificador exclusivo do arquivo 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

Nome Chave Obrigatório Tipo Description
Nome do namespace
 namespace True string

O identificador exclusivo do namespace no Egnyte.

Retornos

Corpo
NamespaceItem

Obter o projeto por ID da pasta raiz

ID da operação:
getProjectByRootFolderId

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

Parâmetros

Nome Chave Obrigatório Tipo Description
A ID da pasta raiz
 rootFolderId True string

A ID da pasta raiz

Retornos

Corpo
ProjectItem

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

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 path True string

Caminho completo da pasta.

Retornos

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

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

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

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

Ao desabilitar a herança de permissões com inheritsPermissions, essas opções determinam se as permissões herdadas anteriormente de 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

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 path True string

Caminho completo da pasta.
Nome de usuário
 username True string

Nome de usuário

Retornos

Nome Caminho Tipo Description
Permissão
 permission string

Valor da permissão

Obter projeto por ID

ID da operação:
getProjectById

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do projeto
 projectId True string

ID do projeto

Retornos

Corpo
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

Retornos

response
array of NamespaceItem

Obter todos os projetos

ID da operação:
getAllProjects

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

Retornos

response
array of ProjectItem

Pesquisar V1

ID da operação:
searchV1

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Consulta de pesquisa
 query True string

A cadeia de caracteres de pesquisa que você deseja encontrar.
Offset
 offset integer

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

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

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

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

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

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

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

Quais tipos de item devem ser pesquisados.
Snippet solicitado
 snippetRequested boolean

Se os resultados da pesquisa devem conter snippets.
Classificar Por
 sortBy string

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

A direção da classificação.
Campos de consulta de arquivo
 fileQueryFields string

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

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

Pesquise todas as palavras ou qualquer uma das palavras.

Retornos

Nome Caminho Tipo Description
results
 results array of object
Nome do Arquivo
 results.name string
Caminho do Arquivo
 results.path string
Tipo MIME
 results.type string
Tamanho do arquivo
 results.size integer
Fragmento
 results.snippet string
HTML Snippet
 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
Carregado por
 results.uploaded_by string
Carregado por nome de usuário
 results.uploaded_by_username string
Número de versões
 results.num_versions integer
É Pasta
 results.is_folder boolean
Contagem total
 total_count integer
Offset
 offset integer
Contagem
 count integer

Pesquisar V2

ID da operação:
searchV2

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Consulta de pesquisa
 query True string

A cadeia de caracteres de pesquisa que você deseja encontrar.
Offset
 offset integer

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

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

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

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

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

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

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

Quais tipos de item devem ser pesquisados.
Snippet solicitado
 snippetRequested boolean

Se os resultados da pesquisa devem conter snippets.
Classificar Por
 sortBy string

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

A direção da classificação.
Campos de consulta de arquivo
 fileQueryFields array of string

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

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

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

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

Matriz de conteúdo de texto a ser usado como referência para pesquisa de documento semelhante.

Retornos

Nome Caminho Tipo Description
results
 results array of object
Nome do Arquivo
 results.name string
Caminho do Arquivo
 results.path string
Tipo MIME
 results.type string
Tamanho do arquivo
 results.size integer
Fragmento
 results.snippet string
HTML Snippet
 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
Carregado por
 results.uploaded_by string
Carregado por nome de usuário
 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
Value
 results.custom_properties.value string
Pontuação de relevância
 results.score number
Contagem total
 total_count integer
Contagem
 count integer
Tem mais resultados
 hasMore boolean

Gatilhos

Quando a permissão de arquivo ou pasta for alterada

Essa operação dispara um fluxo quando um arquivo ou uma pasta é alterado
Quando os metadados de arquivo ou pasta são alterados

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

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

Essa operação dispara um fluxo quando um arquivo é bloqueado
Quando um arquivo é copiado

Essa operação dispara um fluxo quando um arquivo é copiado em uma pasta.
Quando um arquivo é criado (sondagem)

Essa 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 pasta específica
Quando um arquivo é desbloqueado

Essa operação dispara um fluxo quando um arquivo é desbloqueado
Quando um arquivo é excluído

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

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

Essa operação dispara um fluxo quando um arquivo é renomeado em uma pasta.
Quando um fluxo de trabalho de tipo de aprovação é aprovado

Essa 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

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

Essa 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

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

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

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

Essa 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

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

Essa 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

Essa operação dispara um fluxo quando uma pasta não está marcada como um projeto
Quando uma pasta é copiada

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

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

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

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

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

Quando a permissão de arquivo ou pasta for alterada

ID da operação:
fileOrFolderPermissionChange

Essa operação dispara um fluxo quando um arquivo ou uma pasta é alterado

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Nome Caminho Tipo Description
Assignee
 assignee string
ID do atribuídor
 assigneeId number
Atribuídor
 assigner string
ID do atribuídor
 assignerId number
Caminho da pasta
 folderPath string
Novo Privilégio
 newPrivilege string
Privilégio Antigo
 oldPrivilege string
Nome de Grupo
 groupName string

Quando os metadados de arquivo ou pasta são alterados

ID da operação:
fileOrFolderMetadataChange

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Nome Caminho Tipo Description
Caminho de destino
 targetPath string
ID do grupo de destino
 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 pasta específica

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para o arquivo ou pasta de destino.

Retornos

Nome Caminho Tipo Description
ID de entrada de arquivo
 targetEntryId string
ID de Arquivo
 targetGroupId string
Caminho do Arquivo
 targetPath string

Quando um arquivo é bloqueado

ID da operação:
fileLocked

Essa operação dispara um fluxo quando um arquivo é bloqueado

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para o arquivo ou pasta de destino.

Retornos

Corpo
FileLockWebhookResponse

Quando um arquivo é copiado

ID da operação:
pollCopiedFiles

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Nome Caminho Tipo Description
ID do evento
 id integer

A ID de um evento individual.
Timestamp
 timestamp string

O carimbo de data/hora formatado ISO-8601 para quando esse evento foi registrado.
ID do Usuário
 actor integer

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

A ação associada a esse 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 de Arquivo
 data.target_group_id string

A 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 de versão específica do arquivo de origem.
ID do arquivo de origem
 data.source_group_id string

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

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

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

Detalhes do objeto.

Quando um arquivo é criado (sondagem)

ID da operação:
pollCreatedFiles

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Nome Caminho Tipo Description
ID do evento
 id integer

A ID de um evento.
Timestamp
 timestamp string

O carimbo de data/hora formatado ISO-8601 para quando esse evento foi registrado.
ID do Usuário
 actor integer

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

A ação associada a esse 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 de Arquivo
 data.target_group_id string

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

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

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

Detalhes do objeto.

Quando um arquivo é criado (webhook)

ID da operação:
fileCreated

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para o arquivo ou pasta de destino.

Retornos

Nome Caminho Tipo Description
ID de entrada de arquivo
 targetEntryId string
ID de Arquivo
 targetGroupId string
Caminho do Arquivo
 targetPath string
CARREGAR URL do Link
 uploadLinkUrl string

Disponível somente se o arquivo tiver sido carregado por meio do link de upload

Quando um arquivo é desbloqueado

ID da operação:
fileUnlocked

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para o arquivo ou pasta de destino.

Retornos

Corpo
FileLockWebhookResponse

Quando um arquivo é excluído

ID da operação:
pollDeletedFiles

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Nome Caminho Tipo Description
ID do evento
 id integer

A ID de um evento.
Timestamp
 timestamp string

O carimbo de data/hora formatado ISO-8601 para quando esse evento foi registrado.
ID do Usuário
 actor integer

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

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

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

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

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

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

Quando um arquivo é movido

ID da operação:
pollMovedFiles

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Nome Caminho Tipo Description
ID do evento
 id integer

A ID de um evento individual.
Timestamp
 timestamp string

O carimbo de data/hora formatado ISO-8601 para quando esse evento foi registrado.
ID do Usuário
 actor integer

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

A ação associada a esse 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 de Arquivo
 data.target_group_id string

A 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. (True ou False)
Origem da ação
 action_source string

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

Detalhes do objeto.

Quando um arquivo é renomeado

ID da operação:
pollRenamedFiles

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Nome Caminho Tipo Description
ID do evento
 id integer

A ID de um evento individual.
Timestamp
 timestamp string

O carimbo de data/hora formatado ISO-8601 para quando esse evento foi registrado.
ID do Usuário
 actor integer

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

A ação associada a esse 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 de Arquivo
 data.target_group_id string

A 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. (True ou False)
Origem da ação
 action_source string

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

Detalhes do objeto

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

ID da operação:
workflowApprovalTaskApproved

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Corpo
WorkflowStepResponse

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

ID da operação:
workflowApprovalTaskRejected

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Corpo
WorkflowStepResponse

Quando um fluxo de trabalho é concluído

ID da operação:
workflowCompleted

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Nome 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
Caminho da Primeira 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 etapas
 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

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Nome 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
Caminho da Primeira Entidade
 firstEntity.filePath string
ID da primeira entrada de entidade
 firstEntity.entryID string
ID do primeiro grupo de entidades
 firstEntity.groupID string
Definição de JSON
 definitionJson string

Quando um grupo é atualizado

ID da operação:
groupUpdated

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

Retornos

Nome Caminho Tipo Description
ID do Usuário
 user.id integer

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

O nome completo do usuário.
Nome de usuário
 user.userName string

O nome de usuário do usuário.
Email do usuário
 user.email string

O endereço de email do usuário.
ID do Usuário
 owner.id integer

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

O nome completo do usuário.
Nome de usuário
 owner.userName string

O nome de usuário do usuário.
Email do usuário
 owner.email string

O endereço de email do usuário.
Nome de 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 disparou a atualização de grupo.
Members
 members array of GroupUser

Os membros do grupo.

Quando um grupo é criado

ID da operação:
groupCreated

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

Retornos

Nome Caminho Tipo Description
ID do Usuário
 user.id integer

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

O nome completo do usuário.
Nome de usuário
 user.userName string

O nome de usuário do usuário.
Email do usuário
 user.email string

O endereço de email do usuário.
ID do Usuário
 owner.id integer

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

O nome completo do usuário.
Nome de usuário
 owner.userName string

O nome de usuário do usuário.
Email do usuário
 owner.email string

O endereço de email do usuário.
Nome de 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

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

Retornos

Nome Caminho Tipo Description
ID do Usuário
 user.id integer

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

O nome completo do usuário.
Nome de usuário
 user.userName string

O nome de usuário do usuário.
Email do usuário
 user.email string

O endereço de email do usuário.
Nome de Grupo
 groupName string

O nome do grupo.
ID do grupo
 groupId string

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

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Corpo
LinkWebhookResponse
ID da operação:
shareLinkDeleted

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Corpo
LinkWebhookResponse

Quando um projeto é atualizado

ID da operação:
folderProjectUpdated

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Nome Caminho Tipo Description
projectId
 projectId string
projectRootFolderId
 projectRootFolderId string
Nome do Projeto
 name string
Local do projeto
 location string
Status do projeto
 status string

Status do projeto (PENDENTE, EM ANDAMENTO, EM ESPERA, CONCLUÍDA, CANCELADA)

Quando uma pasta de projeto é criada

ID da operação:
folderProjectAdded

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Corpo
FolderProjectCommon

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

ID da operação:
folderProjectUnmarked

Essa operação dispara um fluxo quando uma pasta não está marcada como um projeto

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Corpo
FolderProjectCommon

Quando uma pasta é copiada

ID da operação:
pollCopiedFolders

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Nome Caminho Tipo Description
ID do evento
 id integer

A ID de um evento individual.
Timestamp
 timestamp string

O carimbo de data/hora formatado ISO-8601 para quando esse evento foi registrado.
ID do Usuário
 actor integer

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

A ação associada a esse 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)
Origem da ação
 action_source string

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

Detalhes do objeto

Quando uma pasta é criada

ID da operação:
pollCreatedFolders

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Nome Caminho Tipo Description
ID do evento
 id integer

A ID de um evento.
Timestamp
 timestamp string

O carimbo de data/hora formatado ISO-8601 para quando esse evento foi registrado.
ID do Usuário
 actor integer

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

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

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

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

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

Detalhes do objeto.

Quando uma pasta é excluída

ID da operação:
pollDeletedFolders

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Nome Caminho Tipo Description
ID do evento
 id integer

A ID de um evento.
Timestamp
 timestamp string

O carimbo de data/hora formatado ISO-8601 para quando esse evento foi registrado.
ID do Usuário
 actor integer

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

A ação associada a esse 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. (True ou False)
Origem da ação
 action_source string

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

Quando uma pasta é movida

ID da operação:
pollMovedFolders

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Nome Caminho Tipo Description
ID do evento
 id integer

A ID de um evento individual.
Timestamp
 timestamp string

O carimbo de data/hora formatado ISO-8601 para quando esse evento foi registrado.
ID do Usuário
 actor integer

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

A ação associada a esse 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)
Origem da ação
 action_source string

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

Detalhes do objeto

Quando uma pasta é renomeada

ID da operação:
pollRenamedFolders

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da pasta
 FolderPath True string

O caminho para a pasta de destino.

Retornos

Nome Caminho Tipo Description
ID do evento
 id integer

A ID de um evento individual.
Timestamp
 timestamp string

O carimbo de data/hora formatado ISO-8601 para quando esse evento foi registrado.
ID do Usuário
 actor integer

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

A ação associada a esse 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)
Origem da ação
 action_source string

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

Detalhes do objeto

Definições

GroupUser

Nome Caminho Tipo Description
ID do Usuário
 id integer

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

O nome completo do usuário.
Nome de usuário
 userName string

O nome de usuário do usuário.
Email do usuário
 email string

O endereço de email do usuário.

LinkWebhookResponse

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

Pasta ou arquivo
Link URL
 linkURL string

FileInfoResponse

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

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

Tamanho do arquivo em bytes.
Caminho do Arquivo
 path string

Caminho completo do arquivo.
Nome
 name string

Nome do arquivo.
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 de Arquivo
 group_id string

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

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

Hora da última modificação da versão atual de um arquivo.
Carregado por
 uploaded_by string

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

Tempo carregado 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.
versões
 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 de soma de verificação da versão do arquivo usada para determinar alterações de arquivo.
Última modificação (versão)
 versions.last_modified string

Hora da última modificação da versão específica de um arquivo.
Carregado 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 carregado da versão específica do arquivo.
Tamanho (versão)
 versions.size integer

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

UserInfoResponse

Informações do usuário

Nome Caminho Tipo Description
ID do Usuário
 id integer

A ID do usuário
Nome de usuário
 userName string

Nome de usuário do usuário
ID externa
 externalId string

ID externa
Email
 email string

Email do usuário
Nome da família
 name.familyName string

Nome da família do usuário (sobrenome)
Nome indicado
 name.givenName string

Nome fornecido pelo usuário (nome)
Active
 active boolean

A conta de usuário está ativa
Data da criação
 createdDate string

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

O usuário da última data foi modificado
Última data ativa
 lastActiveDate string

O usuário da última data estava ativo
Bloqueado
 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 usuário
 userType string

O tipo do usuário.
Função
 role string

A função atribuída ao usuário. Aplicável somente aos Usuários do Power.
ID do usuário do IDP
 idpUserId string

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

É a conta usada como conta de serviço
Excluir na expiração
 deleteOnExpiry string

A conta será excluída após expirar
Alteração de email pendente
 emailChangePending boolean

A alteração de email do usuário está pendente
Data de vencimento
 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

O ID do grupo

UserListResponse

Obter resposta da Lista de Usuários

Nome 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 Usuário
 resources.id integer

A ID do usuário
Nome de usuário
 resources.userName string

Nome de usuário do usuário
ID externa
 resources.externalId string

ID externa
Email
 resources.email string

Email do usuário
Nome formatado
 resources.name.formatted string

Nome formatado pelo usuário
Nome da família
 resources.name.familyName string

Nome da família do usuário (sobrenome)
Nome indicado
 resources.name.givenName string

Nome fornecido pelo usuário (nome)
Active
 resources.active boolean

A conta de usuário está ativa
Bloqueado
 resources.locked boolean

A conta de usuário está bloqueada
Data da criação
 resources.createdDate string

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

O usuário da última data foi modificado
Última data ativa
 resources.lastActiveDate string

O usuário da última data 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 usuário
 resources.userType string

O tipo do usuário.
Função
 resources.role string

A função atribuída ao usuário. Aplicável somente aos Usuários do Power.
ID do usuário do IDP
 resources.idpUserId string

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

É a conta usada como conta de serviço
Excluir na expiração
 resources.deleteOnExpiry string

A conta será excluída após expirar
Alteração de email pendente
 resources.emailChangePending boolean

A alteração de email do usuário está pendente
Data de vencimento
 resources.expiryDate string

A expiração da conta
Nome Principal do Usuário
 resources.userPrincipalName string

FolderInfoResponse

Nome Caminho Tipo Description
Nome
 name string

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

A última vez em 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 pai
 parent_id string

A ID da pasta pai.
Contagem de subitems
 total_count integer

O número total de itens realmente disponíveis para retornar.
É pasta
 is_folder boolean

Se o recurso é uma pasta. Verdadeiro ou Falso
Possíveis links públicos
 public_links string

A configuração da opção de pasta sobre como "Permitir links públicos dessa pasta" foi definida.
É compartilhável
 allow_links boolean

É compartilhável? T ou F
Pode ser excluído ou movido
 restrict_move_delete boolean

Pode ser excluído ou movido? T ou F
Pastas
 folders array of object

Pastas
Nome (subpasta)
 folders.name string

Nome da pasta.
Última modificação (subpasta)
 folders.lastModified integer

A última vez em 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.
arquivos
 files array of object

Arquivos
Soma de verificação (arquivo)
 files.checksum string

Valor de soma de verificação da versão atual do arquivo usada para determinar alterações de arquivo.
Tamanho (arquivo)
 files.size integer

Tamanho do arquivo em bytes.
Caminho (arquivo)
 files.path string

Caminho completo do arquivo.
Nome (arquivo)
 files.name string

Nome do arquivo.
Está bloqueado (arquivo)
 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 (arquivo)
 files.group_id string

A 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

Hora da última modificação da versão atual de um arquivo.
Carregado 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

Tempo carregado 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

Nome Caminho Tipo Description
Nome do namespace
 name string
Escopo do namespace
 scope string
keys
 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) das chaves. As chaves serão exibidas de acordo com suas prioridades em ordem decrescente (chaves com prioridade mais alta serão exibidas primeiro)
Herdável
 inheritable boolean
schemaSystemGenerated
 schemaSystemGenerated boolean
metadataScopeType
 metadataScopeType string
Editável
 editable boolean

ProjectItem

Nome 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
local
 location ProjectLocationItem
Situação
 status string

Status do projeto
Criado por
 createdBy number

Criado por
Última atualização por
 lastUpdatedBy number

Última atualização por
Hora de Criação
 creationTime string

Hora 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

Nome Caminho Tipo Description
Endereço de Rua 1
 streetAddress1 string

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

Segunda linha do endereço
City
 city string

City
Estado
 state string

Estado
País
 country string

País
Cep ou cep
 postalCode string

Cep ou cep

FileLockWebhookResponse

Nome Caminho Tipo Description
ID de Arquivo
 targetGroupId string
Soma de verificação de arquivo
 targetFileChecksum string
Caminho do Arquivo
 targetPath string

FolderProjectCommon

Nome Caminho Tipo Description
projectId
 projectId string
projectRootFolderId
 projectRootFolderId string

WorkflowStepResponse

Nome 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
Caminho da Primeira Entidade
 firstEntity.filePath string
ID da primeira entrada de entidade
 firstEntity.entryID string
ID do primeiro grupo de entidades
 firstEntity.groupID string
ID da etapa
 step.id string
Nome da etapa
 step.name string
Tipo de etapa
 step.type string
ID do atribuídor
 assignee.id number
Nome de Exibição do Atribuídor
 assignee.displayName string
Nome de usuário do atribuídor
 assignee.username string
Email do Atribuídor
 assignee.email string
Número total de etapas
 totalNumberOfSteps number
Data de conclusão
 completionDate number
Data de Criação
 creationDate number

AIQuestionResponse

Nome Caminho Tipo Description
response
 response AIResponse
Citações
 citations array of AICitation

Citações e referências usadas na geração da resposta

AISummaryResponse

Nome Caminho Tipo Description
response
 response AIResponse

AICopilotResponse

Nome Caminho Tipo Description
response
 response AIResponse
Citações
 citations array of AICitation

Citações e referências usadas na geração da resposta
ID da conversa
 conversationId string

Identificador exclusivo para a conversa

AICitation

Nome Caminho Tipo Description
Nome do Arquivo
 filename string

Nome do arquivo de origem
ID de entrada
 entryId string

ID de entrada do arquivo de origem
Partes de Texto
 chunks array of object

Matriz de partes de texto da origem
ID do bloco
 chunks.chunkId string

ID da parte de texto
Texto de origem
 chunks.sourceText string

Conteúdo de texto da parte

AIResponse

Nome Caminho Tipo Description
Texto de resposta
 text string

O texto de resposta gerado por IA