Compartir a través de

Egnyte

Egnyte es un servicio que mantiene los archivos seguros, sincronizados y fáciles de compartir. Conéctese a Egnyte para administrar los archivos. Puede realizar varias acciones, como cargar, actualizar, obtener y eliminar archivos en Egnyte.

Este conector está disponible en los siguientes productos y regiones:

Service Class Regions
Copilot Studio Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas Estándar Todas las regiones de Logic Apps excepto las siguientes:
     - Regiones de Azure Government
     - Regiones de Azure China
     - Departamento de Defensa de EE. UU. (DoD)
Power Apps Premium Todas las regiones de Power Apps excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Power Automate Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Contacto
Nombre Compatibilidad con Egnyte
URL https://helpdesk.egnyte.com
Correo Electrónico support@egnyte.com
Metadatos del conector
Publicador Egnyte
Sitio web https://egnyte.com/
Directiva de privacidad https://www.egnyte.com/privacy-policy
Categorías Colaboración; Productividad

Egnyte

Egnyte es una plataforma de colaboración de contenido que mantiene los archivos seguros, sincronizados y fáciles de compartir. Conéctese a Egnyte para administrar los archivos. Puede realizar varias acciones, como cargar, mover, descargar y eliminar archivos en Egnyte.

Requisitos previos

Para usar el conector, debe ser un usuario de Egnyte.

Acciones admitidas

El conector admite las siguientes acciones:

Desencadenadores admitidos

El conector admite los siguientes desencadenadores:

  • When a file is locked: esta operación desencadena un flujo cuando un archivo está bloqueado
  • When a file is unlocked: esta operación desencadena un flujo cuando se desbloquea un archivo.
  • When a file is updated: esta operación desencadena un flujo cuando se actualiza un archivo en una carpeta específica.
  • When a file is created (webhook): esta operación desencadena un flujo cuando se crea un archivo en una carpeta específica.
  • When a share link is created: esta operación desencadena un flujo cuando se crea un vínculo de recurso compartido.
  • When a share link is deleted: esta operación desencadena un flujo cuando se elimina un vínculo de recurso compartido.
  • When the file or folder permission changes: esta operación desencadena un flujo cuando cambia un archivo o una carpeta.
  • When the file or folder metadata changes: esta operación desencadena un flujo cuando cambian los metadatos de un archivo o carpeta.
  • When a project folder is created: esta operación desencadena un flujo cuando se crea una carpeta del proyecto o cuando una carpeta existente está marcada como una carpeta de proyecto.
  • When a folder is unmarked as a project: esta operación desencadena un flujo cuando una carpeta está sin marcar como un proyecto.
  • When a project is updated: esta operación desencadena un flujo cuando se actualiza un proyecto.
  • When a workflow is created: esta operación desencadena un flujo cuando se crea un flujo de trabajo.
  • When a workflow is completed: esta operación desencadena un flujo cuando se completa un flujo de trabajo.
  • When an approval type workflow is approved: esta operación desencadena un flujo cuando se aprueba un flujo de trabajo de tipo de aprobación.
  • When an approval type workflow is rejected: esta operación desencadena un flujo cuando se rechaza un flujo de trabajo de tipo de aprobación.
  • When a group is created: esta operación desencadena un flujo cuando se crea un grupo.
  • When a group is updated: esta operación desencadena un flujo cuando se actualiza un grupo.
  • When a group is deleted: esta operación desencadena un flujo cuando se elimina un grupo.
  • When a file is created (polling): esta operación desencadena un flujo cuando se crea un nuevo archivo en una carpeta.
  • When a folder is created: esta operación desencadena un flujo cuando se crea una subcarpeta en una carpeta.
  • When a file is deleted: esta operación desencadena un flujo cuando se elimina un archivo en una carpeta.
  • When a folder is deleted: esta operación desencadena un flujo cuando se elimina una subcarpeta en una carpeta.
  • When a file is renamed: esta operación desencadena un flujo cuando se cambia el nombre de un archivo en una carpeta.
  • When a folder is renamed: esta operación desencadena un flujo cuando se cambia el nombre de una subcarpeta en una carpeta.
  • When a file is moved: esta operación desencadena un flujo cuando se mueve un archivo en una carpeta.
  • When a folder is moved: esta operación desencadena un flujo cuando se mueve una subcarpeta en una carpeta.
  • When a file is copied: esta operación desencadena un flujo cuando se copia un archivo en una carpeta.
  • When a folder is copied: esta operación desencadena un flujo cuando se copia una subcarpeta en una carpeta.

Limitaciones

Nombre Llamadas Período de renovación
Llamadas API por conexión 100 60 segundos

Acciones

[IA] Formular una pregunta a Egnyte Copilot

Formule preguntas a la plataforma copilot, proporcionando una respuesta controlada por ia basada en el contenido global dentro de su dominio de Egnyte. https://developers.egnyte.com/api-docs/read/ai-api#Copilot
[IA] Formular una pregunta sobre un documento

Formule preguntas relacionadas con un documento determinado y proporcione una respuesta controlada por inteligencia artificial basada en el contenido del documento. https://developers.egnyte.com/api-docs/read/ai-api#Ask-a-Question
[IA] Generación de un resumen de un documento

Genere un resumen para un documento determinado, lo que proporciona una respuesta controlada por ia basada en el contenido del documento. https://developers.egnyte.com/api-docs/read/ai-api#Summarize-a-Document
Actualización completa del grupo

Sobrescriba todos los atributos de un grupo. https://developers.egnyte.com/api-docs/read/group-management#Full-Update-to-a-Group
Actualización de claves de espacio de nombres

Actualice la clave de los metadatos personalizados de un dominio. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Keys
Actualización del proyecto por identificador

Actualiza las propiedades especificadas de un proyecto identificado por su identificador. https://developers.egnyte.com/api-docs/read/project-folder-api#Update-Project
Actualización parcial del grupo

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

Actualiza los atributos del espacio de nombres. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Attributes
Actualizar usuario por identificador

Actualice el usuario único. Aprende más: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Update-Single-User
Bloquear archivo por identificador

Bloquee el archivo mediante el identificador. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File
Bloquear archivo por ruta de acceso

Bloquear el archivo mediante la ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File
Buscar V1

Busque contenido almacenado en Egnyte basado en nombres de archivo, metadatos y contenido de texto. https://developers.egnyte.com/api-docs/read/search-api#Search-v1
Búsqueda V2

Busque contenido con funcionalidades avanzadas de búsqueda. https://developers.egnyte.com/api-docs/read/search-api#Search-v2
Compartir carpeta

Comparta una carpeta en Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
Copiar archivo por identificador

Copie un archivo mediante un identificador. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Copiar archivo por ruta de acceso

Copie un archivo mediante una ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Copiar carpeta por identificador

Copie una carpeta mediante un identificador. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Copiar carpeta por ruta de acceso

Copie una carpeta mediante una ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Creación de un espacio de nombres

Cree un espacio de nombres en Egnyte. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Namespace
Creación de un proyecto a partir de una plantilla

Cree un proyecto a partir de una plantilla de carpeta de proyecto. https://developers.egnyte.com/api-docs/read/project-folder-api#Create-From-Template
Creación de un usuario

Cree un nuevo usuario en Egnyte. Aprende más: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Create-Single-User
Creación de una clave de metadatos

Agregue una clave de metadatos a un espacio de nombres existente. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Metadata-Key
Crear archivo

Carga un archivo en Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Upload-a-File
Crear carpeta

Cree una carpeta en Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Create-a-Folder
Crear grupo

Cree un grupo en Egnyte. https://developers.egnyte.com/api-docs/read/group-management#Create-a-Group
Crear vínculo

Cree un vínculo. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
Desbloquear archivo por identificador

Desbloquee el archivo mediante el identificador. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File
Desbloquear archivo por ruta de acceso

Desbloquee el archivo mediante la ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File
Eliminar archivo por identificador

Elimine un archivo mediante un identificador. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Eliminar archivo por ruta de acceso

Elimine un archivo mediante una ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Eliminar carpeta por identificador

Elimine una carpeta mediante un identificador. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Eliminar carpeta por ruta de acceso

Elimine una carpeta mediante una ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Eliminar clave de metadatos

Elimine una clave de metadatos de un espacio de nombres existente. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Metadata-Key
Eliminar espacio de nombres

Elimine un espacio de nombres especificado. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Namespace
Eliminar grupo

Elimine un grupo por identificador. https://developers.egnyte.com/api-docs/read/group-management#Delete-a-Group
Eliminar proyecto por identificador

Quite un proyecto en función de su identificador. https://developers.egnyte.com/api-docs/read/project-folder-api#Remove-Project
Eliminar usuario por identificador

Elimine un usuario de Egnyte. Aprende más: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-User
Eliminar vínculo

Eliminar un vínculo. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Delete-a-Link
Enumerar todos los vínculos

Enumera todos los vínculos excepto los vínculos eliminados. Tenga en cuenta que, si el usuario que ejecuta este método no es un administrador, solo se mostrarán los vínculos creados por el usuario. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links
Enumerar todos los vínculos V2

Enumera todos los vínculos. Tenga en cuenta que, si el usuario que ejecuta este método no es un administrador, solo se mostrarán los vínculos creados por el usuario. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links-v2
Establecimiento de metadatos por identificador de archivo

Escriba metadatos en un archivo mediante el identificador de archivo. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace
Establecimiento de metadatos por identificador de carpeta

Escriba metadatos en una carpeta mediante el identificador de carpeta. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace
Establecimiento de permisos de carpeta

Establezca permisos para una carpeta. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Set-Folder-Permissions
Limpieza del proyecto por identificador

Este punto de conexión inicia una limpieza en un proyecto y, opcionalmente, elimina o deshabilita los usuarios especificados. https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-Project
Marcar carpeta como proyecto

Marque una carpeta existente como un proyecto. https://developers.egnyte.com/api-docs/read/project-folder-api#Mark-Folder-as-Project
Metadatos de búsqueda

Buscar elementos con un campo o valor de metadatos específicos. https://developers.egnyte.com/api-docs/read/metadata-api#Search-Metadata
Modificar opciones de carpeta

Modifique opciones de carpeta como descripción, configuración de uso compartido de vínculos, permisos de vínculo público, restricciones de movimiento o eliminación y preferencias de notificación por correo electrónico. https://developers.egnyte.com/api-docs/read/folder-options-api
Mostrar detalles del vínculo

Vea los detalles de un vínculo. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Show-Link-Details
Mover carpeta por identificador

Mueva una carpeta mediante el identificador. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Mover carpeta por ruta de acceso

Mueva una carpeta en Egnyte mediante la ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Mover el archivo por identificador

Mueva un archivo en Egnyte mediante el identificador de archivo. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Mover el archivo por ruta de acceso

Mueva un archivo en Egnyte mediante la ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Obtención de detalles del grupo

Recupere la información de grupo mediante el identificador. https://developers.egnyte.com/api-docs/read/group-management#Show-Single-Group
Obtención de detalles del usuario

Recupere la información sobre el usuario por identificador. Aprende más: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-Single-User
Obtención de información de archivo por identificador

Recupere la información del archivo mediante el identificador de archivo. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Obtención de metadatos por identificador de archivo

Obtenga metadatos de un archivo mediante el identificador de archivo. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace
Obtención de metadatos por identificador de carpeta

Obtenga metadatos de una carpeta mediante el identificador de carpeta. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace
Obtención de permisos de carpeta

Obtener permisos para una carpeta. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Folder-Permissions
Obtención del proyecto por identificador

Recupere un proyecto mediante el identificador. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-ID
Obtención del proyecto por identificador de carpeta raíz

Recupere un proyecto basado en su identificador de carpeta raíz. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-Root-Folder
Obtener contenido de archivo por identificador

Recupera el contenido del archivo de Egnyte mediante id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File
Obtener contenido de archivo por ruta de acceso

Recupera el contenido del archivo de Egnyte mediante la ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File
Obtener espacio de nombres

Enumere todas las claves de metadatos personalizadas que se han creado en un espacio de nombres determinado. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Namespace
Obtener información de archivo por ruta de acceso

Recupere la información del archivo mediante la ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Obtener información de carpeta por identificador

Recupere la información de la carpeta mediante el identificador. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Obtener información de carpeta por ruta de acceso

Recupere la información de la carpeta mediante la ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Obtener lista de todos los grupos

Recupere la lista de los grupos. https://developers.egnyte.com/api-docs/read/group-management#List-Groups
Obtener permisos efectivos

Obtener permisos efectivos para un usuario. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Effective-Permission-for-a-User
Obtener todos los espacios de nombres

Obtenga una lista de todos los espacios de nombres de metadatos personalizados del dominio. https://developers.egnyte.com/api-docs/read/metadata-api#Get-All-Namespaces
Obtener todos los proyectos

Enumere todas las carpetas de proyecto en el dominio. https://developers.egnyte.com/api-docs/read/project-folder-api#Get-All-Projects
Obtener una lista de todos los usuarios

Recupere la información sobre los usuarios. Aprende más: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-User-List
Recurso compartido de archivos

Comparta un archivo en Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
Vínculo profundo por identificador

Cree un vínculo profundo para archivo o carpeta por identificador. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders
Vínculo profundo por ruta de acceso

Cree un vínculo profundo para archivo o carpeta por ruta de acceso. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders

[IA] Formular una pregunta a Egnyte Copilot

Id. de la operación:
copilotAsk

Formule preguntas a la plataforma copilot, proporcionando una respuesta controlada por ia basada en el contenido global dentro de su dominio de Egnyte. https://developers.egnyte.com/api-docs/read/ai-api#Copilot

Parámetros

Nombre Clave Requerido Tipo Description
Pregunta
 question True string

La pregunta específica que desea formular
Id. de carpeta
 id string

Identificador de la carpeta seleccionada
Identificador de entrada de archivo
 entryId string

Identificador de entrada del archivo seleccionado
Incluir citas
 includeCitations boolean

Si la respuesta debe incluir citas (el valor predeterminado es false)
Rol
 role string
Contenido del mensaje
 content string

Devoluciones

Body
AICopilotResponse

[IA] Formular una pregunta sobre un documento

Id. de la operación:
askDocumentQuestion

Formule preguntas relacionadas con un documento determinado y proporcione una respuesta controlada por inteligencia artificial basada en el contenido del documento. https://developers.egnyte.com/api-docs/read/ai-api#Ask-a-Question

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de entrada de archivo
 entryId True string

Identificador de la versión específica del archivo
Pregunta
 question True string

La pregunta específica que desea formular
Incluir citas
 includeCitations boolean

Si la respuesta debe incluir citas (el valor predeterminado es false)
Rol
 role string
Contenido del mensaje
 content string

Devoluciones

Body
AIQuestionResponse

[IA] Generación de un resumen de un documento

Id. de la operación:
summarizeDocument

Genere un resumen para un documento determinado, lo que proporciona una respuesta controlada por ia basada en el contenido del documento. https://developers.egnyte.com/api-docs/read/ai-api#Summarize-a-Document

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de entrada de archivo
 entryId True string

Identificador de la versión específica del archivo
Rol
 role string
Contenido del mensaje
 content string

Devoluciones

Body
AISummaryResponse

Actualización completa del grupo

Id. de la operación:
fullGroupUpdate

Sobrescriba todos los atributos de un grupo. https://developers.egnyte.com/api-docs/read/group-management#Full-Update-to-a-Group

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de grupo
 id True string

Identificador del grupo creado.
Nombre para mostrar
 displayName True string

Nombre para mostrar del grupo.
Id. de usuario
 value integer

Identificador único global de un miembro del grupo.

Devoluciones

Nombre Ruta de acceso Tipo Description
Identificador de grupo
 id string

Identificador del grupo creado.
Nombre para mostrar
 displayName string

Nombre para mostrar de un grupo.
Miembros
 members array of object

Miembros del grupo
Nombre de usuario
 members.username string

Nombre de usuario de un miembro.
Id. de usuario
 members.value number

Identificador de usuario de un miembro.
Nombre para mostrar del usuario
 members.display string

Nombre para mostrar de un miembro.

Actualización de claves de espacio de nombres

Id. de la operación:
updateNamespaceKeys

Actualice la clave de los metadatos personalizados de un dominio. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Keys

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del espacio de nombres
 namespace True string

Identificador único del espacio de nombres en Egnyte.
Key
 key True string

Clave única en el espacio de nombres
Nombre para mostrar
 displayName string

Especifica el nombre que se muestra para la clave.
type
 type string

Especifica el tipo de datos de una clave.
prioridad
 priority number

Especifica la prioridad (orden) de las claves. Las claves se mostrarán de acuerdo con sus prioridades en orden descendente (primero se mostrarán las claves con mayor prioridad).
datos
 data string

Para una clave de tipo de enumeración, especifica los valores enumerados.
helpText
 helpText string

Texto informativo que se muestra cuando un usuario agrega o edita una propiedad para dar contexto al propósito de la propiedad

Devoluciones

Nombre Ruta de acceso Tipo Description
nombre
 name string

Nombre del espacio de nombres
key
 key string

Nombre de clave
Nombre para mostrar
 displayName string

Nombre para identificar el campo en la interfaz de usuario
helpText
 helpText string

Descripción de la información sobre herramientas para el campo de metadatos
prioridad
 priority number

Especifica la prioridad de la clave (las claves con mayor prioridad se mostrarán primero.

Actualización del proyecto por identificador

Id. de la operación:
updateProjectById

Actualiza las propiedades especificadas de un proyecto identificado por su identificador. https://developers.egnyte.com/api-docs/read/project-folder-api#Update-Project

Parámetros

Nombre Clave Requerido Tipo Description
nombre
 name True string

Nuevo nombre de la carpeta.
descripción
 description string

Nueva descripción de la carpeta.
projectId
 projectId True string

ID del proyecto.
customProjectId
 customProjectId string

Identificador personalizado del proyecto.
nombreDelCliente
 customerName string

El cliente asociado al proyecto.
calleDirección1
 streetAddress1 string

Primera línea de la dirección postal.
calleDirección2
 streetAddress2 string

Segunda línea de la dirección postal.
city
 city string

Ciudad.
estado
 state string

Comunidad autónoma o provincia.
postalCode
 postalCode string

Código ZIP o código postal.
country
 country string

usando un código de país de 3 caracteres del perfil DE GENC ISO 3166, por ejemplo: USA, GBR, POL.
estado
 status True string

Estado actual del proyecto.
startDate
 startDate string

Fecha de inicio del proyecto en formato ISO 8601.
fecha de finalización
 completionDate string

Fecha prevista de finalización del proyecto en formato ISO 8601.

Actualización parcial del grupo

Id. de la operación:
partialGroupUpdate

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

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de grupo
 id True string

Identificador del grupo creado.
Nombre para mostrar
 displayName string

Nombre para mostrar del grupo.
Id. de usuario
 value integer

Identificador único global de un miembro del grupo.
operation
 operation string

La acción que desea realizar en un grupo.

Devoluciones

Nombre Ruta de acceso Tipo Description
Identificador de grupo
 id string

Identificador del grupo creado.
Nombre para mostrar
 displayName string

Nombre para mostrar de un grupo.
Miembros
 members array of object

Miembros del grupo
Nombre de usuario
 members.username string

Nombre de usuario de un miembro.
Id. de usuario
 members.value number

Identificador de usuario de un miembro.
Nombre para mostrar del usuario
 members.display string

Nombre para mostrar de un miembro.

Actualizar atributos de espacio de nombres

Id. de la operación:
updateNamespaceAttributes

Actualiza los atributos del espacio de nombres. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Attributes

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del espacio de nombres
 namespace True string

Identificador único del espacio de nombres en Egnyte.
Nombre para mostrar
 displayName string

Nombre para identificar el espacio de nombres en la interfaz de usuario.
Prioridades
 priorities object

Especifica la prioridad (orden) de las claves. Las claves se mostrarán de acuerdo con sus prioridades en orden descendente (primero se mostrarán las claves con mayor prioridad).

Devoluciones

Body
NamespaceItem

Actualizar usuario por identificador

Id. de la operación:
updateUser

Actualice el usuario único. Aprende más: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Update-Single-User

Parámetros

Nombre Clave Requerido Tipo Description
Id. de usuario
 id True integer

Identificador único del usuario
Correo electrónico del usuario
 email string

La dirección de correo electrónico del usuario.
Nombre propio
 givenName string

El nombre del usuario.
Apellido
 familyName string

Los apellidos del usuario.
Active
 active boolean

Si el usuario está activo o inactivo.
Enviar invitación
 sendInvite boolean

Si se establece en true, se enviará un correo electrónico de invitación. El parámetro no puede ser el único modificado por esta acción.
Language
 language string

El parámetro "language" solo se acepta cuando el paquete de idioma se ha habilitado para el dominio.
Tipo de autenticación
 authType string

Tipo de autenticación para el usuario.
Tipo de usuario
 userType string

Tipo del usuario.
Rol
 role string

El rol asignado al usuario. Solo se aplica a los usuarios avanzados.
Id. de usuario de IDP
 idpUserId string

Solo es necesario si el usuario está autenticado y no usa la asignación de usuarios predeterminada.
Nombre principal de usuario
 userPrincipalName string

No especifique si el usuario no está autenticado en AD.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de usuario
 id integer

Identificador único del usuario
Correo electrónico del usuario
 email string

La dirección de correo electrónico del usuario.
Apellido
 familyName string

Los apellidos del usuario.
Nombre propio
 givenName string

El nombre del usuario.
Active
 active boolean

Si el usuario está activo o inactivo.
Enviar invitación
 sendInvite boolean

Si se establece en true, se enviará un correo electrónico de invitación.
Language
 language string

Solo se acepta cuando se ha habilitado el paquete de idioma.
Tipo de autenticación
 authType string

Tipo de autenticación para el usuario.
Tipo de usuario
 userType string

Tipo del usuario.
Rol
 role string

El rol asignado al usuario. Solo se aplica a los usuarios avanzados.
Id. de usuario de IDP
 idpUserId string

Solo es necesario si el usuario está autenticado por SSO.
Nombre principal de usuario
 userPrincipalName string

No especifique si el usuario no está autenticado en AD.

Bloquear archivo por identificador

Id. de la operación:
lockFileById

Bloquee el archivo mediante el identificador. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File

Parámetros

Nombre Clave Requerido Tipo Description
Id. de archivo
 id True string

Identificador único del archivo en Egnyte.

Devoluciones

Nombre Ruta de acceso Tipo Description
Timeout
 timeout integer

Tiempo en segundos durante el que se debe bloquear el archivo.
Token de bloqueo
 lock_token string

Token que se debe usar para desbloquear el archivo.

Bloquear archivo por ruta de acceso

Id. de la operación:
lockFileByPath

Bloquear el archivo mediante la ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso del archivo de destino
 path True string

Ruta de acceso del archivo de destino en Egnyte, incluido el nombre de archivo de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Timeout
 timeout integer

Tiempo en segundos durante el que se debe bloquear el archivo.
Token de bloqueo
 lock_token string

Token que se debe usar para desbloquear el archivo.

Buscar V1

Id. de la operación:
searchV1

Busque contenido almacenado en Egnyte basado en nombres de archivo, metadatos y contenido de texto. https://developers.egnyte.com/api-docs/read/search-api#Search-v1

Parámetros

Nombre Clave Requerido Tipo Description
Consulta de búsqueda
 query True string

Cadena de búsqueda que desea buscar.
Desplazar
 offset integer

Índice basado en 0 del registro inicial que se solicita.
Contar
 count integer

Número de entradas por página.
Carpeta
 folder string

Limite los resultados a los elementos de la carpeta y los descendientes especificados.
Modificado antes
 modifiedBefore string

Limite los resultados a los elementos modificados antes de esta marca de tiempo ISO-8601.
Modificado después de
 modifiedAfter string

Limite los resultados a los elementos modificados después de esta marca de tiempo ISO-8601.
Cargado antes
 uploadedBefore string

Limite los resultados a los elementos cargados antes de esta marca de tiempo ISO-8601.
Cargado después
 uploadedAfter string

Limite los resultados a los elementos cargados después de esta marca de tiempo ISO-8601.
Tipo
 type string

Qué tipos de elemento se deben buscar.
Fragmento de código solicitado
 snippetRequested boolean

Si los resultados de la búsqueda deben contener fragmentos de código.
Ordenar por
 sortBy string

Campo que se debe usar para la ordenación.
Dirección de ordenación
 sortDirection string

Dirección de la ordenación.
Campos de consulta de archivos
 fileQueryFields string

Busque archivos con campos específicos.
Campos de consulta de carpetas
 folderQueryFields string

Busque carpetas con campos específicos.
Operador de consulta
 queryOperator string

Busque todas las palabras o cualquiera de las palabras.

Devoluciones

Nombre Ruta de acceso Tipo Description
results
 results array of object
Nombre de archivo
 results.name string
Ruta de acceso del archivo
 results.path string
Tipo MIME
 results.type string
Tamaño de archivo
 results.size integer
Fragmento
 results.snippet string
Fragmento de código HTML
 results.snippet_html string
Id. de entrada
 results.entry_id string
Identificador de grupo
 results.group_id string
Última modificación
 results.last_modified string
Cargado por
 results.uploaded_by string
Cargado por nombre de usuario
 results.uploaded_by_username string
Número de versiones
 results.num_versions integer
Es carpeta
 results.is_folder boolean
Recuento total
 total_count integer
Desplazar
 offset integer
Contar
 count integer

Búsqueda V2

Id. de la operación:
searchV2

Busque contenido con funcionalidades avanzadas de búsqueda. https://developers.egnyte.com/api-docs/read/search-api#Search-v2

Parámetros

Nombre Clave Requerido Tipo Description
Consulta de búsqueda
 query True string

Cadena de búsqueda que desea buscar.
Desplazar
 offset integer

Índice basado en 0 del registro inicial que se solicita.
Contar
 count integer

Número de entradas por página.
Carpeta
 folder string

Limite los resultados a los elementos de la carpeta y los descendientes especificados.
Modificado antes
 modifiedBefore integer

Limite los resultados a los elementos modificados antes de esta marca de tiempo de Unix en milisegundos.
Modificado después de
 modifiedAfter integer

Limite los resultados a los elementos modificados después de esta marca de tiempo de Unix en milisegundos.
Cargado antes
 uploadedBefore integer

Limite los resultados a los elementos cargados antes de esta marca de tiempo de Unix en milisegundos.
Cargado después
 uploadedAfter integer

Limite los resultados a los elementos cargados después de esta marca de tiempo de Unix en milisegundos.
Tipo
 type string

Qué tipos de elemento se deben buscar.
Fragmento de código solicitado
 snippetRequested boolean

Si los resultados de la búsqueda deben contener fragmentos de código.
Ordenar por
 sortBy string

Campo que se debe usar para la ordenación.
Dirección de ordenación
 sortDirection string

Dirección de la ordenación.
Campos de consulta de archivos
 fileQueryFields array of string

Busque archivos con campos específicos.
Campos de consulta de carpetas
 folderQueryFields array of string

Busque carpetas con campos específicos.
Operador de consulta
 queryOperator string

Busque todas las palabras o cualquiera de las palabras.
Más parecido a esto (identificadores de documento)
 mlt array of string

Matriz de identificadores de documento que se usarán como referencia para la búsqueda de documentos similar.
Más parecido a esto (texto)
 mltt array of string

Matriz de contenido de texto que se va a usar como referencia para la búsqueda de documentos similar.

Devoluciones

Nombre Ruta de acceso Tipo Description
results
 results array of object
Nombre de archivo
 results.name string
Ruta de acceso del archivo
 results.path string
Tipo MIME
 results.type string
Tamaño de archivo
 results.size integer
Fragmento
 results.snippet string
Fragmento de código HTML
 results.snippet_html string
Id. de entrada
 results.entry_id string
Identificador de grupo
 results.group_id string
Última modificación
 results.last_modified string
Cargado por
 results.uploaded_by string
Cargado por nombre de usuario
 results.uploaded_by_username string
Número de versiones
 results.num_versions integer
Es carpeta
 results.is_folder boolean
Propiedades personalizadas
 results.custom_properties array of object
Ámbito
 results.custom_properties.scope string
Namespace
 results.custom_properties.namespace string
Key
 results.custom_properties.key string
Importancia
 results.custom_properties.value string
Puntuación de relevancia
 results.score number
Recuento total
 total_count integer
Contar
 count integer
Tiene más resultados
 hasMore boolean

Compartir carpeta

Id. de la operación:
shareFolder

Comparta una carpeta en Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 path True string

Ruta de acceso de carpeta de Egnyte que se va a compartir.

Devoluciones

Nombre Ruta de acceso Tipo Description
Enlaces
 links array of object

Enlaces
Id. de vínculo
 links.id string

Identificador del vínculo.
Url del vínculo
 links.url string

Dirección URL completa del vínculo.
Recipientes
 links.recipients array of string

Matriz de direcciones de correo electrónico válidas a las que se envió el vínculo.
Ruta de acceso de carpeta
 path string

Ruta de acceso completa de la carpeta compartida.
Tipo
 type string

Tipo de vínculo, ya sea archivo, carpeta o carga.
Accessibility
 accessibility string

Quién puede acceder a un vínculo, uno de los usuarios, contraseñas, dominios o destinatarios.
Notificar al creador cuando se accede a él
 notify boolean

Si se notificará al creador del vínculo por correo electrónico cuando se acceda al vínculo.
Hace referencia a la versión
 link_to_current boolean

¿Es esta versión actual? T o F
Fecha de expiración
 expiry_date string

Fecha y hora de expiración del vínculo.
Fecha de creación
 creation_date string

Fecha y hora de creación del vínculo.
Creado por
 created_by string

Nombre de usuario del usuario que creó el vínculo.

Copiar archivo por identificador

Id. de la operación:
copyFileById

Copie un archivo mediante un identificador. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Parámetros

Nombre Clave Requerido Tipo Description
Id. de archivo
 id True string

Identificador único del archivo que se va a copiar en Egnyte.
Ruta de acceso del archivo de destino
 destination_path True string

Ruta de acceso del archivo de destino en Egnyte, incluido el nombre de archivo de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Ruta de acceso del archivo
 path string

Ruta de acceso completa del archivo copiado.
Id. de archivo
 group_id string

Identificador para hacer referencia al archivo en su conjunto.

Copiar archivo por ruta de acceso

Id. de la operación:
copyFileByPath

Copie un archivo mediante una ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Parámetros

Nombre Clave Requerido Tipo Description
Archivo de origen
 path True string

Ruta de acceso del archivo de origen en Egnyte, incluido el nombre de archivo de destino.
Archivo de destino
 destination_path True string

Ruta de acceso del archivo de destino en Egnyte, incluido el nombre de archivo de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Ruta de acceso del archivo
 path string

Ruta de acceso completa del archivo copiado.
Id. de archivo
 group_id string

Identificador para hacer referencia al archivo en su conjunto.

Copiar carpeta por identificador

Id. de la operación:
copyFolderById

Copie una carpeta mediante un identificador. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Parámetros

Nombre Clave Requerido Tipo Description
Id. de carpeta
 id True string

Identificador único de la carpeta que se va a copiar en Egnyte.
Ruta de acceso de la carpeta de destino
 destination_path True string

Ruta de acceso de la carpeta de destino en Egnyte.

Devoluciones

Nombre Ruta de acceso Tipo Description
Ruta de acceso de carpeta
 path string

Ruta de acceso completa de la carpeta copiada.
Id. de carpeta
 folder_id string

Identificador único de la carpeta copiada.

Copiar carpeta por ruta de acceso

Id. de la operación:
copyFolderByPath

Copie una carpeta mediante una ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta de origen
 path True string

Ruta de acceso de la carpeta de origen en Egnyte.
Ruta de acceso de la carpeta de destino
 destination_path True string

Ruta de acceso de la carpeta de destino en Egnyte.

Devoluciones

Nombre Ruta de acceso Tipo Description
Ruta de acceso de carpeta
 path string

Ruta de acceso completa de la carpeta copiada.
Id. de carpeta
 folder_id string

Identificador único de la carpeta copiada.

Creación de un espacio de nombres

Id. de la operación:
createNamespace

Cree un espacio de nombres en Egnyte. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Namespace

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del espacio de nombres
 name True string

Nombre del espacio de nombres
Nombre para mostrar
 displayName string

Nombre para identificar el espacio de nombres en la interfaz de usuario.
Ámbito
 scope True string

Quién puede ver y modificar el espacio de nombres
Nombre de clave
 name True string

Nombre de la clave
Tipo
 type True string

Especifica el tipo de datos de una clave.
Nombre de pantalla
 displayName string

Nombre para identificar el campo en la interfaz de usuario
Texto de ayuda
 helpText string

Descripción de la información sobre herramientas para el campo de metadatos
Priority
 priority number

Especifica la prioridad de la clave (las claves con mayor prioridad se mostrarán primero.
Datos (para el tipo de enumeración)
 data array of string

Para una clave de tipo de enumeración, especifica los valores enumerados.

Creación de un proyecto a partir de una plantilla

Id. de la operación:
createProjectFromTemplate

Cree un proyecto a partir de una plantilla de carpeta de proyecto. https://developers.egnyte.com/api-docs/read/project-folder-api#Create-From-Template

Parámetros

Nombre Clave Requerido Tipo Description
Id. de carpeta principal
 parentFolderId True string

Id. de carpeta de la carpeta primaria donde se creará la carpeta del proyecto.
Identificador de carpeta de plantilla
 templateFolderId True string

Id. de carpeta de la plantilla de carpeta del proyecto
Nombre de carpeta
 folderName True string

Nombre de la nueva carpeta que se creará
Nombre
 name True string

Nombre del proyecto
Description
 description string

Descripción de la carpeta
Identificación del proyecto
 projectId string

Identificador personalizado del proyecto
Nombre del cliente
 customerName string

El cliente asociado al proyecto
Estado
 status True string

Estado del proyecto
Fecha de inicio (por ejemplo, 2023-12-31T23:59:59)
 startDate date-time

Fecha de inicio del proyecto.
Fecha de finalización (por ejemplo, 2023-12-31T23:59:59)
 completionDate date-time

Fecha de finalización del proyecto.
Dirección postal 1
 streetAddress1 string

Primera línea de la dirección
Dirección postal 2
 streetAddress2 string

Segunda línea de la dirección
City
 city string

City
Provincia
 state string

Provincia
País
 country string

País
Código postal o código postal
 postalCode string

Código postal o código postal

Devoluciones

Nombre Ruta de acceso Tipo Description
groupsCreated
 groupsCreated array of object
Identificación del proyecto
 groupsCreated.id string

Id. de proyecto
Nombre de proyecto
 groupsCreated.name string

Nombre de proyecto

Creación de un usuario

Id. de la operación:
createUser

Cree un nuevo usuario en Egnyte. Aprende más: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Create-Single-User

Parámetros

Nombre Clave Requerido Tipo Description
Nombre de usuario
 userName True string

Nombre de usuario de Egnyte para el usuario. Debe comenzar con una letra o un dígito.
Correo Electrónico
 email True string

Dirección de correo electrónico del usuario (por ejemplo, admin@acme.com).
Nombre propio
 givenName True string

El nombre del usuario.
Apellido
 familyName True string

Los apellidos del usuario.
Active
 active True boolean

Si el usuario está activo o inactivo.
Tipo de usuario
 userType True string

Tipo del usuario.
Tipo de autenticación
 authType True string

Tipo de autenticación para el usuario.
External ID
 externalId string

Identificador único inmutable proporcionado por el consumidor de API.
Enviar invitación
 sendInvite boolean

Si se establece en true al crear un usuario, se enviará un correo electrónico de invitación (si el usuario se crea en estado activo).
¿Es la cuenta de servicio?
 isServiceAccount boolean

Si se establece en true al crear un usuario, el usuario se creará como una cuenta de servicio.
Language
 language string

El parámetro "language" solo se acepta cuando el paquete de idioma se ha habilitado para el dominio.
Rol
 role string

El rol asignado al usuario. Solo se aplica a los usuarios avanzados.
Id. de usuario de IDP
 idpUserId string

Solo es necesario si el usuario está autenticado y no usa la asignación de usuarios predeterminada. No especifique si el usuario no está autenticado por SSO.
Nombre principal de usuario
 userPrincipalName string

No especifique si el usuario no está autenticado en AD. Se usa para enlazar directivas de autenticación secundarias a un usuario al usar la autenticación de Active Directory en una configuración de varios dominios.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de usuario
 id integer

Identificador único para el usuario recién creado
Nombre de usuario
 userName string

Nombre de usuario de Egnyte para el usuario.
External ID
 externalId string

Identificador único inmutable proporcionado por el consumidor de API.
Correo Electrónico
 email string

La dirección de correo electrónico del usuario.
Cambio de correo electrónico pendiente
 emailChangePending boolean

Si un cambio de correo electrónico está pendiente.
Nombre propio
 name.givenName string

El nombre del usuario.
Apellido
 name.familyName string

Los apellidos del usuario.
Nombre con formato
 name.formatted string

Nombre completo con formato del usuario.
Active
 active boolean

Si el usuario está activo.
Bloqueado
 locked boolean

Indica si la cuenta de usuario está bloqueada.
Tipo de autenticación
 authType string

Tipo de autenticación para el usuario.
Tipo de usuario
 userType string

Tipo del usuario.
Id. de usuario de IDP
 idpUserId string

La forma en que el usuario se identifica dentro de la respuesta SAML de un proveedor de identidades de SSO.
Nombre principal de usuario
 userPrincipalName string

Se usa para enlazar directivas de autenticación secundarias a un usuario al usar la autenticación de Active Directory.
Rol
 role string

El rol asignado al usuario. Solo se aplica a los usuarios avanzados.
Language
 language string

Preferencia de idioma para el usuario.
Fecha de creación
 createdDate date-time

Fecha y hora en que se creó el usuario.
Fecha de última modificación
 lastModificationDate date-time

Fecha y hora de la última modificación.
Última fecha activa
 lastActiveDate date-time

Fecha y hora de la última actividad.
Fecha de vencimiento
 expiryDate date-time

Fecha en que expirará la cuenta de usuario.

Creación de una clave de metadatos

Id. de la operación:
createMetadataKey

Agregue una clave de metadatos a un espacio de nombres existente. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Metadata-Key

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del espacio de nombres
 namespace True string

Identificador único del espacio de nombres en Egnyte.
Nombre de clave
 key True string

Nombre de la clave que está creando.
Tipo (para "enumeración": se requiere el parámetro data)
 type True string

Especifica el tipo de datos de una clave.
Nombre para mostrar
 displayName string

Nombre que se va a identificar el campo en la interfaz de usuario.
Priority
 priority number

Especifica la prioridad de la clave (primero se mostrarán las claves con mayor prioridad).
Texto de ayuda
 helpText string

Descripción de la información sobre herramientas para el campo de metadatos.
Data
 data array of string

Para una clave de tipo de enumeración, especifica los valores enumerados.

Crear archivo

Id. de la operación:
createFile

Carga un archivo en Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Upload-a-File

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del archivo
 Name True string

Nombre del archivo que se va a crear en Egnyte.
Folder path (Ruta de acceso a la carpeta)
 Path True string

Ruta de acceso de carpeta para cargar el archivo en Egnyte.
Contenido del archivo
 body True binary

Contenido del archivo que se va a cargar en Egnyte.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de la versión
 id string

Identificador de la versión actual del archivo.
Id. de archivo
 group_id string

Identificador para hacer referencia al archivo en su conjunto.
Ruta de acceso del archivo
 path string

Ruta de acceso completa del archivo cargado.

Crear carpeta

Id. de la operación:
createFolder

Cree una carpeta en Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Create-a-Folder

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 path True string

Ruta de acceso completa de la nueva carpeta.

Devoluciones

Nombre Ruta de acceso Tipo Description
Ruta de acceso de carpeta
 path string

Ruta de acceso completa de la carpeta creada
Id. de carpeta
 folder_id string

Identificador único de la carpeta creada

Crear grupo

Id. de la operación:
createGroup

Cree un grupo en Egnyte. https://developers.egnyte.com/api-docs/read/group-management#Create-a-Group

Parámetros

Nombre Clave Requerido Tipo Description
Nombre para mostrar
 displayName True string

Nombre para mostrar del grupo.
Id. de usuario
 value string

Identificador único global de un miembro del grupo.

Devoluciones

Nombre Ruta de acceso Tipo Description
Identificador de grupo
 id string

Identificador del grupo creado.
Nombre para mostrar
 displayName string

Nombre para mostrar de un grupo.
Miembros
 members array of object

Miembros del grupo
Nombre de usuario
 members.username string

Nombre de usuario de un miembro.
Id. de usuario
 members.value number

Identificador de usuario de un miembro.
Nombre para mostrar del usuario
 members.display string

Nombre para mostrar de un miembro.

Crear vínculo

Id. de la operación:
createLink

Cree un vínculo. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

Parámetros

Nombre Clave Requerido Tipo Description
Ruta
 path True string

Ruta de acceso absoluta del archivo o carpeta de destino.
Tipo
 type True string

Esto determina qué tipo de vínculo se creará.
Accessibility
 accessibility string

Determina quién es accesible un vínculo. Obligatorio excepto para los vínculos de carga o cuando "useDefaultSettings" es true.
Usar la configuración predeterminada
 useDefaultSettings True boolean

Determina si se deben usar los parámetros predeterminados en el dominio para la creación de vínculos.
Enviar correo electrónico
 send_email boolean

Si se establece true, Egnyte enviará un vínculo por correo electrónico.
Recipientes
 recipients array of string

Enumera las direcciones de correo electrónico de los destinatarios del vínculo. Solo es necesario si "Enviar correo electrónico" es true.
Mensaje (solo se aplica si "Enviar correo electrónico" es true).
 message string

Mensaje personal que se va a enviar en el correo electrónico de vínculo.
Copiarme (solo se aplica si "Enviar correo electrónico" es true)
 copy_me boolean

Si se establece true, se enviará una copia del mensaje de vínculo al creador del vínculo.
Notificar
 notify boolean

Si se establece true, el creador del vínculo recibirá una notificación por correo electrónico cuando se acceda al vínculo.
Vínculo a actual (solo aplicable a los vínculos de archivo).
 link_to_current boolean

Si se establece true, el vínculo siempre hará referencia a la versión actual del archivo.
Fecha de expiración (por ejemplo, 2023-12-31)
 expiry_date string

Fecha de expiración del vínculo. Si se especifica, no se puede establecer "Clics de expiración".
Clics de expiración
 expiry_clicks number

Número de clics para los que el vínculo es válido. Si se especifica, no se puede establecer "Fecha de expiración"
Agregar un nombre de archivo (solo se aplica a los vínculos de archivo, no a los vínculos de carpeta)
 add_file_name boolean

Si es true, el nombre de archivo se anexará al final del vínculo.
Contraseña (cuando el parámetro "accesibilidad" está establecido en "contraseña")
 password string

Cuando no se especifica, el sistema generará automáticamente una contraseña.
Protección
 protection string

Si se establece en "PREVIEW", creará un vínculo de solo vista previa.
Carpeta por destinatario (solo se aplica a los vínculos de carga).
 folder_per_recipient boolean

Si es true, los datos cargados de cada destinatario se colocarán en una carpeta independiente.

Devoluciones

Nombre Ruta de acceso Tipo Description
Enlaces
 links array of object

Matriz que contiene la información json completa de todos los vínculos del dominio que este usuario puede ver dentro de los intervalos especificados.
Id
 links.id string

Identificador del vínculo
URL
 links.url string

Dirección URL completa del vínculo
Recipientes
 links.recipients array of string

Matriz de direcciones de correo electrónico válidas a las que se envió el vínculo.
Ruta
 path string

Ruta de acceso absoluta del recurso de destino, ya sea archivo o carpeta.
Tipo
 type string

Tipo de vínculo, ya sea archivo, carpeta o carga.
Accessibility
 accessibility string

Quién puede acceder a un vínculo, uno de los usuarios, contraseñas, dominios o destinatarios.
Notificar
 notify boolean

Boolean sobre si se notificará al creador del vínculo por correo electrónico cuando se acceda al vínculo.
Vínculo a actual
 link_to_current boolean

Boolean sobre si el vínculo siempre hará referencia a la versión actual del archivo. Solo se aplica a los vínculos de archivo.
Fecha de vencimiento
 expiry_date string

Fecha y hora de expiración del vínculo. Este campo solo se muestra si el vínculo expira por fecha
Fecha de creación
 creation_date string

Fecha y hora de creación del vínculo
Creado por
 created_by string

Nombre de usuario del usuario que creó el vínculo

Desbloquear archivo por identificador

Id. de la operación:
unlockFileById

Desbloquee el archivo mediante el identificador. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File

Parámetros

Nombre Clave Requerido Tipo Description
Id. de archivo
 id True string

Identificador único del archivo en Egnyte.
Token de bloqueo
 lock_token True string

Token de bloqueo actual para el archivo.

Desbloquear archivo por ruta de acceso

Id. de la operación:
unlockFileByPath

Desbloquee el archivo mediante la ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso del archivo
 path True string

Ruta de acceso única al archivo en Egnyte.
Token de bloqueo
 lock_token True string

Token de bloqueo actual para el archivo.

Eliminar archivo por identificador

Id. de la operación:
deleteFileById

Elimine un archivo mediante un identificador. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Parámetros

Nombre Clave Requerido Tipo Description
Id. de archivo
 id True string

Identificador único del archivo que se va a eliminar de Egnyte.

Devoluciones

Nombre Ruta de acceso Tipo Description
Ruta de acceso de carpeta principal
 parent_folder_path string

Ruta de acceso a la carpeta primaria del archivo eliminado.

Eliminar archivo por ruta de acceso

Id. de la operación:
deleteFileByPath

Elimine un archivo mediante una ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso del archivo
 path True string

Ruta de acceso del archivo en Egnyte, incluido el nombre de archivo de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Ruta de acceso de carpeta principal
 parent_folder_path string

Ruta de acceso a la carpeta primaria del archivo eliminado

Eliminar carpeta por identificador

Id. de la operación:
deleteFolderById

Elimine una carpeta mediante un identificador. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Parámetros

Nombre Clave Requerido Tipo Description
Id. de carpeta
 id True string

Identificador único de la carpeta que se va a eliminar de Egnyte.

Devoluciones

Nombre Ruta de acceso Tipo Description
Ruta de acceso de carpeta principal
 parent_folder_path string

Ruta de acceso a la carpeta primaria de la carpeta eliminada.

Eliminar carpeta por ruta de acceso

Id. de la operación:
deleteFolderByPath

Elimine una carpeta mediante una ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 path True string

Ruta de acceso de carpeta en Egnyte, incluido el nombre de la carpeta de destino que se va a eliminar.

Devoluciones

Nombre Ruta de acceso Tipo Description
Ruta de acceso de carpeta principal
 parent_folder_path string

Ruta de acceso a la carpeta primaria de la carpeta eliminada.

Eliminar clave de metadatos

Id. de la operación:
deleteMetadataKey

Elimine una clave de metadatos de un espacio de nombres existente. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Metadata-Key

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del espacio de nombres
 namespace True string

Identificador único del espacio de nombres en Egnyte.
Nombre
 key True string

Nombre de la clave que va a eliminar.
Forzar la eliminación
 force boolean

Elimine incluso si se usa la clave de metadatos.

Eliminar espacio de nombres

Id. de la operación:
deleteNamespace

Elimine un espacio de nombres especificado. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Namespace

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del espacio de nombres
 namespace True string

Identificador único del espacio de nombres en Egnyte.
Forzar la eliminación
 force boolean

Eliminar incluso si se usa el espacio de nombres

Eliminar grupo

Id. de la operación:
deleteGroup

Elimine un grupo por identificador. https://developers.egnyte.com/api-docs/read/group-management#Delete-a-Group

Parámetros

Nombre Clave Requerido Tipo Description
Id. de grupo
 id True string

Identificador del grupo.

Eliminar proyecto por identificador

Id. de la operación:
deleteProjectById

Quite un proyecto en función de su identificador. https://developers.egnyte.com/api-docs/read/project-folder-api#Remove-Project

Parámetros

Nombre Clave Requerido Tipo Description
Id. de proyecto
 projectId True string

Identificador del proyecto que se va a eliminar

Eliminar usuario por identificador

Id. de la operación:
deleteUser

Elimine un usuario de Egnyte. Aprende más: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-User

Parámetros

Nombre Clave Requerido Tipo Description
Id. de usuario
 id True integer

Identificador del usuario que se va a eliminar

Eliminar vínculo

Id. de la operación:
deleteLink

Eliminar un vínculo. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Delete-a-Link

Parámetros

Nombre Clave Requerido Tipo Description
Id. de vínculo
 linkId True string

LinkId

Enumerar todos los vínculos

Id. de la operación:
listLinks

Enumera todos los vínculos excepto los vínculos eliminados. Tenga en cuenta que, si el usuario que ejecuta este método no es un administrador, solo se mostrarán los vínculos creados por el usuario. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links

Parámetros

Nombre Clave Requerido Tipo Description
Ruta
 path string

Enumera los vínculos a un archivo o carpeta especificados por su ruta de acceso completa.
Nombre de usuario
 username string

Enumera los vínculos creados por este usuario.
Creado antes
 createdBefore string

Enumerar vínculos creados antes de una fecha determinada (ISO-8601 o AAAA-MM-DD).
Creado después de
 createdAfter string

Enumerar vínculos creados después de una fecha determinada (ISO-8601 o AAAA-MM-DD).
Tipo
 type string

Filtre solo por elementos "file" o "folder".
Accessibility
 accessibility string

Selección del tipo de accesibilidad
Desplazar
 offset string

Índice basado en 0 del registro inicial que se solicita.
Count (De forma predeterminada, se devuelven 500 entradas)
 count string

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

Devoluciones

Nombre Ruta de acceso Tipo Description
Identificadores
 ids array of string

Matriz que contiene los identificadores de todos los vínculos del dominio que puede ver este usuario.
Desplazar
 offset number

Índice basado en 0 del registro inicial que se solicita.
Contar
 count number

Recuento de elementos devueltos. Si no se especifica este campo, el valor de recuento será 0.
Recuento total
 total_count number

Número de vínculos visibles para el usuario en el dominio.

Enumerar todos los vínculos V2

Id. de la operación:
listLinksV2

Enumera todos los vínculos. Tenga en cuenta que, si el usuario que ejecuta este método no es un administrador, solo se mostrarán los vínculos creados por el usuario. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links-v2

Parámetros

Nombre Clave Requerido Tipo Description
Ruta
 path string

Enumera los vínculos a un archivo o carpeta especificados por su ruta de acceso completa.
Nombre de usuario
 username string

Enumera los vínculos creados por este usuario.
Creado antes
 createdBefore string

Enumerar vínculos creados antes de una fecha determinada (ISO-8601 o AAAA-MM-DD).
Creado después de
 createdAfter string

Enumerar vínculos creados después de una fecha determinada (ISO-8601 o AAAA-MM-DD).
Tipo
 type string

Filtre solo por elementos "file" o "folder".
Accessibility
 accessibility string

Selección del tipo de accesibilidad
Desplazar
 offset string

Índice basado en 0 del registro inicial que se solicita.
Count (De forma predeterminada, se devuelven 500 entradas)
 count string

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

Devoluciones

Nombre Ruta de acceso Tipo Description
Enlaces
 links array of object

Matriz que contiene la información json completa de todos los vínculos del dominio que este usuario puede ver dentro de los intervalos especificados.
Ruta
 links.path string

Ruta de acceso absoluta del recurso de destino, ya sea archivo o carpeta.
Tipo
 links.type string

Tipo de vínculo, ya sea archivo, carpeta o carga.
Accessibility
 links.accessibility string

Quién puede acceder a un vínculo, uno de los usuarios, contraseñas, dominios o destinatarios.
Protección
 links.protection string

Si el vínculo "PREVIEW" de un archivo (o carpeta), es un vínculo de solo vista previa al archivo (carpeta), de lo contrario es "NONE".
Recipientes
 links.recipients array of string

Matriz de direcciones de correo electrónico válidas a las que se envió el vínculo.
Notificar
 links.notify boolean

Boolean sobre si se notificará al creador del vínculo por correo electrónico cuando se acceda al vínculo.
URL
 links.url string

Dirección URL completa del vínculo
Id
 links.id string

Identificador del vínculo
Vínculo a actual
 links.link_to_current boolean

Boolean sobre si el vínculo siempre hará referencia a la versión actual del archivo. Solo se aplica a los vínculos de archivo.
Fecha de creación
 links.creation_date string

Fecha y hora de creación del vínculo
Creado por
 links.created_by string

Nombre de usuario del usuario que creó el vínculo
Identificador de recurso
 links.resource_id string

Identificador del recurso asociado, identificador de grupo si es un vínculo de archivo o el identificador de carpeta si es una carpeta o vínculo de carga.
Clics de expiración
 links.expiry_clicks number

Número de clics que quedan en el vínculo antes de la expiración. Este campo solo se muestra si el vínculo expira a través de clics
Último acceso
 links.last_accessed string

Fecha y hora del último acceso del vínculo. Este campo solo se muestra si se ha accedido al vínculo al menos una vez
Fecha de vencimiento
 links.expiry_date string

Fecha y hora de expiración del vínculo. Este campo solo se muestra si el vínculo expira por fecha
Contar
 count number

Número de vínculos visibles para el usuario en el dominio que se devuelven.

Establecimiento de metadatos por identificador de archivo

Id. de la operación:
setMetadataByFileId

Escriba metadatos en un archivo mediante el identificador de archivo. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace

Parámetros

Nombre Clave Requerido Tipo Description
Id. de archivo
 fileId True string

Identificador único del archivo en Egnyte.
Nombre del espacio de nombres
 namespaceName True string

Nombre del espacio de nombres.
Nombre de clave de metadatos
 metadataName True string

Nombre de la clave a la que desea asignar valor.
Valor de metadatos
 metadataValue string

Valor de metadatos que se va a establecer.

Establecimiento de metadatos por identificador de carpeta

Id. de la operación:
setMetadataByFolderId

Escriba metadatos en una carpeta mediante el identificador de carpeta. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace

Parámetros

Nombre Clave Requerido Tipo Description
Id. de carpeta
 folderId True string

Identificador único de la carpeta en Egnyte.
Nombre del espacio de nombres
 namespaceName True string

Nombre del espacio de nombres.
Nombre de clave de metadatos
 metadataName True string

Nombre de la clave a la que desea asignar valor.
Valor de metadatos
 metadataValue True string

Valor de metadatos que se va a establecer.

Establecimiento de permisos de carpeta

Id. de la operación:
setFolderPermissions

Establezca permisos para una carpeta. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Set-Folder-Permissions

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 path True string

Ruta de acceso completa de la carpeta.
Permisos de usuario
 userPerms object

Asignación del usuario al valor de permiso.
Permisos de grupo
 groupPerms object

Asignación del nombre de grupo al valor de permiso
Hereda los permisos
 inheritsPermissions boolean

Si los permisos se deben heredar de la carpeta primaria.
Mantener los permisos primarios (solo si inheritsPermissions es false)
 keepParentPermissions boolean

Si los permisos de las carpetas primarias se deben aplicar a esta carpeta.

Limpieza del proyecto por identificador

Id. de la operación:
cleanupProject

Este punto de conexión inicia una limpieza en un proyecto y, opcionalmente, elimina o deshabilita los usuarios especificados. https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-Project

Parámetros

Nombre Clave Requerido Tipo Description
Id. de proyecto
 projectId True string

Id. de proyecto
deleteLinks
 deleteLinks True boolean

Si se establece en true, se eliminarán todos los vínculos activos existentes del proyecto.
usersToDelete
 usersToDelete array of integer

Lista de identificadores de usuario que se van a eliminar.
usersToDisable
 usersToDisable array of integer

Lista de identificadores de usuario que se van a deshabilitar.

Devoluciones

Nombre Ruta de acceso Tipo Description
Mensaje
 message string

Marcar carpeta como proyecto

Id. de la operación:
markFolderAsProject

Marque una carpeta existente como un proyecto. https://developers.egnyte.com/api-docs/read/project-folder-api#Mark-Folder-as-Project

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de carpeta raíz
 rootFolderId True string

FolderId de la carpeta del proyecto raíz
Nombre
 name True string

Nombre del proyecto
Description
 description string

Descripción de la carpeta
Estado
 status True string

Estado del proyecto
Fecha de inicio (por ejemplo, 2023-12-31T23:59:59)
 startDate date-time

Fecha de inicio del proyecto.
Fecha de finalización (por ejemplo, 2023-12-31T23:59:59)
 completionDate date-time

Fecha de finalización del proyecto.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id
 id string

Id. de elemento

Metadatos de búsqueda

Id. de la operación:
searchMetadata

Buscar elementos con un campo o valor de metadatos específicos. https://developers.egnyte.com/api-docs/read/metadata-api#Search-Metadata

Parámetros

Nombre Clave Requerido Tipo Description
Tipo de búsqueda
 type string

Qué tipos de elemento se deben buscar.
Nombre del espacio de nombres
 namespace True string

Nombre del espacio de nombres.
Clave de metadatos
 keyName True string

Nombre de la clave de metadatos.
Nombre del espacio de nombres
 namespace True string

Nombre del espacio de nombres.
Clave de metadatos
 keyName True string

Nombre de la clave de metadatos.
Valor de metadatos
 value True string

Valor de la clave de metadatos.

Modificar opciones de carpeta

Id. de la operación:
modifyFolderOptions

Modifique opciones de carpeta como descripción, configuración de uso compartido de vínculos, permisos de vínculo público, restricciones de movimiento o eliminación y preferencias de notificación por correo electrónico. https://developers.egnyte.com/api-docs/read/folder-options-api

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 path True string

Ruta de acceso única a la carpeta de Egnyte.
Descripción de la carpeta
 folder_description string

Descripción de la carpeta.
Permitir vínculos
 allow_links boolean

Elija si los vínculos se pueden compartir en archivos o subcarpetas dentro de esta carpeta.
Vínculos públicos
 public_links string

Especifique qué tipo de vínculos públicos se permiten. Valores posibles: files_folders, archivos, deshabilitados.
Restringir mover o eliminar
 restrict_move_delete boolean

Restrinja las operaciones de traslado y eliminación solo a los propietarios y administradores de carpetas.
Notificaciones de actualizaciones de contenido
 content_updates boolean

Habilite las notificaciones por correo electrónico para las actualizaciones de contenido.
Notificaciones de acceso a contenido
 content_accessed boolean

Habilite las notificaciones de correo electrónico para el contenido al que se accede.

Devoluciones

Nombre Ruta de acceso Tipo Description
Nombre
 name string

Nombre de la carpeta.
Última modificación
 lastModified integer

La última vez que se ha modificado cualquier archivo de la carpeta (pero no dentro de las subcarpetas).
Ruta de acceso de carpeta
 path string

Ruta de acceso completa de la carpeta.
Id. de carpeta
 folder_id string

Identificador único de la carpeta.
Descripción de la carpeta
 folder_description string

Descripción de la carpeta.
Carpeta Is
 is_folder boolean

Si el recurso es una carpeta. Verdadero o Falso
Posibles vínculos públicos
 public_links string

Se estableció la opción de carpeta en cuanto a cómo se estableció "Permitir vínculos públicos de esta carpeta para".
Se puede eliminar o mover
 restrict_move_delete boolean

¿Se puede eliminar o mover? T o F

Mostrar detalles del vínculo

Id. de la operación:
showLinkDetails

Vea los detalles de un vínculo. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Show-Link-Details

Parámetros

Nombre Clave Requerido Tipo Description
Id. de vínculo
 linkId True string

LinkId

Devoluciones

Nombre Ruta de acceso Tipo Description
Enlaces
 links array of object

Matriz que contiene la información json completa de todos los vínculos del dominio que este usuario puede ver dentro de los intervalos especificados.
Id
 links.id string

Identificador del vínculo
URL
 links.url string

Dirección URL completa del vínculo
Recipientes
 links.recipients array of string

Matriz de direcciones de correo electrónico válidas a las que se envió el vínculo.
Ruta
 path string

Ruta de acceso absoluta del recurso de destino, ya sea archivo o carpeta.
Tipo
 type string

Tipo de vínculo, ya sea archivo, carpeta o carga.
Accessibility
 accessibility string

Quién puede acceder a un vínculo, uno de los usuarios, contraseñas, dominios o destinatarios.
Notificar
 notify boolean

Boolean sobre si se notificará al creador del vínculo por correo electrónico cuando se acceda al vínculo.
Vínculo a actual
 link_to_current boolean

Boolean sobre si el vínculo siempre hará referencia a la versión actual del archivo. Solo se aplica a los vínculos de archivo.
Fecha de vencimiento
 expiry_date string

Fecha y hora de expiración del vínculo. Este campo solo se muestra si el vínculo expira por fecha
Fecha de creación
 creation_date string

Fecha y hora de creación del vínculo
Creado por
 created_by string

Nombre de usuario del usuario que creó el vínculo
Último acceso
 last_accessed string

Fecha y hora del último acceso del vínculo. Este campo solo se muestra si se ha accedido al vínculo al menos una vez

Mover carpeta por identificador

Id. de la operación:
moveFolderById

Mueva una carpeta mediante el identificador. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Parámetros

Nombre Clave Requerido Tipo Description
Id. de carpeta
 id True string

Identificador único de la carpeta en Egnyte.
Ruta de acceso de la carpeta de destino
 destination_path True string

Ruta de acceso de la carpeta de destino en Egnyte.

Devoluciones

Nombre Ruta de acceso Tipo Description
Ruta de acceso de carpeta
 path string

Ruta de acceso completa de la carpeta movida.
Id. de carpeta
 folder_id string

Identificador único de la carpeta movida.

Mover carpeta por ruta de acceso

Id. de la operación:
moveFolderByPath

Mueva una carpeta en Egnyte mediante la ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de origen
 path True string

Ruta de acceso a la carpeta de origen.
Ruta de acceso de la carpeta de destino
 destination_path True string

Ruta de acceso de la carpeta de destino en Egnyte.

Devoluciones

Nombre Ruta de acceso Tipo Description
Ruta de acceso de carpeta
 path string

Ruta de acceso completa de la carpeta movida.
Id. de carpeta
 folder_id string

Identificador único de la carpeta movida.

Mover el archivo por identificador

Id. de la operación:
moveFileById

Mueva un archivo en Egnyte mediante el identificador de archivo. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Parámetros

Nombre Clave Requerido Tipo Description
Id. de archivo
 id True string

Identificador único del archivo en Egnyte.
Ruta de acceso del archivo de destino
 destination_path True string

Ruta de acceso del archivo de destino en Egnyte. Incluido el nombre de archivo de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Ruta de acceso del archivo
 path string

Ruta de acceso completa del archivo movido.
Id. de archivo
 group_id string

Identificador para hacer referencia al archivo en su conjunto.

Mover el archivo por ruta de acceso

Id. de la operación:
moveFileByPath

Mueva un archivo en Egnyte mediante la ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de origen
 path True string

Ruta de acceso al archivo de origen.
Ruta de acceso del archivo de destino
 destination_path True string

Ruta de acceso del archivo de destino en Egnyte, incluido el nombre de archivo de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Ruta de acceso del archivo
 path string

Ruta de acceso completa del archivo movido.
Id. de archivo
 group_id string

Identificador para hacer referencia al archivo en su conjunto.

Obtención de detalles del grupo

Id. de la operación:
groupInfoById

Recupere la información de grupo mediante el identificador. https://developers.egnyte.com/api-docs/read/group-management#Show-Single-Group

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de grupo
 id True string

El ID del grupo.

Devoluciones

Nombre Ruta de acceso Tipo Description
Identificador de grupo
 id string

Identificador de grupo único global.
Nombre de grupo
 displayName string

Nombre del grupo.
Miembros
 members array of object

Miembros del grupo
Identificador de grupo
 members.username string

Nombre de usuario de un miembro del grupo
Id. de usuario
 members.value number

Identificador único global de un miembro del grupo.
Nombre para mostrar del usuario
 members.display string

Nombre para mostrar de un miembro del grupo.

Obtención de detalles del usuario

Id. de la operación:
getUser

Recupere la información sobre el usuario por identificador. Aprende más: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-Single-User

Parámetros

Nombre Clave Requerido Tipo Description
Id. de usuario
 id True integer

Identificador del usuario

Devoluciones

Información del usuario

Body
UserInfoResponse

Obtención de información de archivo por identificador

Id. de la operación:
fileInfoById

Recupere la información del archivo mediante el identificador de archivo. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Parámetros

Nombre Clave Requerido Tipo Description
Id. de archivo
 id True string

Identificador único del archivo en Egnyte.

Devoluciones

Body
FileInfoResponse

Obtención de metadatos por identificador de archivo

Id. de la operación:
getMetadataByFileId

Obtenga metadatos de un archivo mediante el identificador de archivo. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace

Parámetros

Nombre Clave Requerido Tipo Description
Id. de archivo
 fileId True string

Identificador único del archivo en Egnyte.
Nombre del espacio de nombres
 namespace True string

Nombre del espacio de nombres.

Obtención de metadatos por identificador de carpeta

Id. de la operación:
getMetadataByFolderId

Obtenga metadatos de una carpeta mediante el identificador de carpeta. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace

Parámetros

Nombre Clave Requerido Tipo Description
Id. de carpeta
 folderId True string

Identificador único de la carpeta en Egnyte.
Nombre del espacio de nombres
 namespace True string

Nombre del espacio de nombres.

Obtención de permisos de carpeta

Id. de la operación:
getFolderPermissions

Obtener permisos para una carpeta. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Folder-Permissions

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 path True string

Ruta de acceso completa de la carpeta.

Devoluciones

Nombre Ruta de acceso Tipo Description
Permisos de usuario
 userPerms object

Asignación del usuario al valor de permiso.
Permisos de grupo
 groupPerms object

Asignación del nombre de grupo al valor de permiso
Hereda los permisos
 inheritsPermissions boolean

Si los permisos se deben heredar de la carpeta primaria.
Mantener los permisos primarios
 keepParentPermissions boolean

Al deshabilitar la herencia de permisos con inheritsPermissions, esta opción determina si los permisos heredados previamente de las carpetas primarias deben copiarse en esta carpeta.

Obtención del proyecto por identificador

Id. de la operación:
getProjectById

Recupere un proyecto mediante el identificador. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-ID

Parámetros

Nombre Clave Requerido Tipo Description
Identificación del proyecto
 projectId True string

Identificación del proyecto

Devoluciones

Body
ProjectItem

Obtención del proyecto por identificador de carpeta raíz

Id. de la operación:
getProjectByRootFolderId

Recupere un proyecto basado en su identificador de carpeta raíz. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-Root-Folder

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de la carpeta raíz
 rootFolderId True string

Identificador de la carpeta raíz

Devoluciones

Body
ProjectItem

Obtener contenido de archivo por identificador

Id. de la operación:
getFileContentById

Recupera el contenido del archivo de Egnyte mediante id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File

Parámetros

Nombre Clave Requerido Tipo Description
Id. de archivo
 fileId True string

Identificador único del archivo en Egnyte.

Obtener contenido de archivo por ruta de acceso

Id. de la operación:
getFileContentByPath

Recupera el contenido del archivo de Egnyte mediante la ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso del archivo
 filePath True string

Ruta de acceso única al archivo en Egnyte.

Obtener espacio de nombres

Id. de la operación:
getNamespace

Enumere todas las claves de metadatos personalizadas que se han creado en un espacio de nombres determinado. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Namespace

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del espacio de nombres
 namespace True string

Identificador único del espacio de nombres en Egnyte.

Devoluciones

Body
NamespaceItem

Obtener información de archivo por ruta de acceso

Id. de la operación:
fileInfoByPath

Recupere la información del archivo mediante la ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso del archivo
 path True string

Ruta de acceso única al archivo en Egnyte.

Devoluciones

Body
FileInfoResponse

Obtener información de carpeta por identificador

Id. de la operación:
folderInfoById

Recupere la información de la carpeta mediante el identificador. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Parámetros

Nombre Clave Requerido Tipo Description
Id. de carpeta
 id True string

Identificador único de la carpeta en Egnyte.

Devoluciones

Body
FolderInfoResponse

Obtener información de carpeta por ruta de acceso

Id. de la operación:
folderInfoByPath

Recupere la información de la carpeta mediante la ruta de acceso. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 path True string

Ruta de acceso única a la carpeta de Egnyte.

Devoluciones

Body
FolderInfoResponse

Obtener lista de todos los grupos

Id. de la operación:
listGroups

Recupere la lista de los grupos. https://developers.egnyte.com/api-docs/read/group-management#List-Groups

Parámetros

Nombre Clave Requerido Tipo Description
Índice inicial
 startIndex integer

Índice basado en 1 del registro inicial que se solicita (entero ≥ 1).
Contar
 count integer

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

Permite solicitar un subconjunto de grupos. Estos términos no distinguen mayúsculas de minúsculas

Devoluciones

Nombre Ruta de acceso Tipo Description
Total de resultados
 totalResults integer

Número total de resultados que coinciden con la consulta.
Artículos por página
 itemsPerPage integer

Número de resultados devueltos.
Iniciar índice
 startIndex integer

Índice basado en 1 del primer resultado en el conjunto actual de resultados.
resources
 resources array of object
Identificador de grupo
 resources.id string

Identificador de grupo único global.
Nombre del grupo
 resources.displayName string

Nombre del grupo.

Obtener permisos efectivos

Id. de la operación:
getEffectivePermissions

Obtener permisos efectivos para un usuario. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Effective-Permission-for-a-User

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 path True string

Ruta de acceso completa de la carpeta.
Nombre de usuario
 username True string

Nombre de usuario

Devoluciones

Nombre Ruta de acceso Tipo Description
Permiso
 permission string

Valor de permiso

Obtener todos los espacios de nombres

Id. de la operación:
getAllNamespaces

Obtenga una lista de todos los espacios de nombres de metadatos personalizados del dominio. https://developers.egnyte.com/api-docs/read/metadata-api#Get-All-Namespaces

Devoluciones

response
array of NamespaceItem

Obtener todos los proyectos

Id. de la operación:
getAllProjects

Enumere todas las carpetas de proyecto en el dominio. https://developers.egnyte.com/api-docs/read/project-folder-api#Get-All-Projects

Devoluciones

response
array of ProjectItem

Obtener una lista de todos los usuarios

Id. de la operación:
getUserList

Recupere la información sobre los usuarios. Aprende más: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-User-List

Parámetros

Nombre Clave Requerido Tipo Description
Índice inicial
 startIndex integer

Índice basado en 1 del primer resultado de búsqueda.
Contar
 count integer

Especifica el número máximo deseado de resultados de búsqueda por página.
Filter
 filter string

Permite solicitar un subconjunto de usuarios. Consulte la documentación de la sección Acerca de.

Devoluciones

Obtención de la respuesta de la lista de usuarios

Body
UserListResponse

Recurso compartido de archivos

Id. de la operación:
shareFile

Comparta un archivo en Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso del archivo
 path True string

Ruta de acceso del archivo en Egnyte, incluido el nombre de archivo de destino que se va a compartir.

Devoluciones

Nombre Ruta de acceso Tipo Description
Enlaces
 links array of object

Enlaces
Id. de vínculo
 links.id string

Identificador del vínculo.
Url del vínculo
 links.url string

Dirección URL completa del vínculo.
Recipientes
 links.recipients array of string

Matriz de direcciones de correo electrónico válidas a las que se envió el vínculo.
Ruta de acceso del archivo
 path string

Ruta de acceso completa del archivo compartido.
Tipo
 type string

Tipo de vínculo, ya sea archivo, carpeta o carga.
Accessibility
 accessibility string

Quién puede acceder a un vínculo, uno de los usuarios, contraseñas, dominios o destinatarios.
Notificar al creador cuando se accede a él
 notify boolean

Si se notificará al creador del vínculo por correo electrónico cuando se acceda al vínculo.
Hace referencia a la versión
 link_to_current boolean

¿Es esta versión actual? T o F
Fecha de expiración
 expiry_date string

Fecha y hora de expiración del vínculo.
Fecha de creación
 creation_date string

Fecha y hora de creación del vínculo.
Autor
 created_by string

Nombre de usuario del usuario que creó el vínculo.

Vínculo profundo por identificador

Id. de la operación:
deepLinksById

Cree un vínculo profundo para archivo o carpeta por identificador. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders

Parámetros

Nombre Clave Requerido Tipo Description
Id
 id True string

Identificador del archivo o carpeta
Tipo
 type True string

Tipo del vínculo

Devoluciones

Nombre Ruta de acceso Tipo Description
URL
 url string

Vínculo profundo

Vínculo profundo por ruta de acceso

Id. de la operación:
deepLinksByPath

Cree un vínculo profundo para archivo o carpeta por ruta de acceso. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders

Parámetros

Nombre Clave Requerido Tipo Description
Ruta
 path True string

Ruta de acceso del archivo o carpeta

Devoluciones

Nombre Ruta de acceso Tipo Description
URL
 url string

Vínculo profundo

Desencadenadores

Cuando cambia el archivo o los metadatos de la carpeta

Esta operación desencadena un flujo cuando cambian los metadatos de un archivo o carpeta.
Cuando cambia el permiso de archivo o carpeta

Esta operación desencadena un flujo cuando cambia un archivo o una carpeta.
Cuando se actualiza un archivo

Esta operación desencadena un flujo cuando se actualiza un archivo en una carpeta específica.
Cuando se actualiza un grupo

Esta operación desencadena un flujo cuando se actualiza un grupo
Cuando se actualiza un proyecto

Esta operación desencadena un flujo cuando se actualiza un proyecto
Cuando se aprueba un flujo de trabajo de tipo de aprobación

Esta operación desencadena un flujo cuando se aprueba un flujo de trabajo de tipo de aprobación
Cuando se cambia el nombre de un archivo

Esta operación desencadena un flujo cuando se cambia el nombre de un archivo en una carpeta.
Cuando se cambia el nombre de una carpeta

Esta operación desencadena un flujo cuando se cambia el nombre de una subcarpeta en una carpeta.
Cuando se completa un flujo de trabajo

Esta operación desencadena un flujo cuando se completa un flujo de trabajo.
Cuando se copia un archivo

Esta operación desencadena un flujo cuando se copia un archivo en una carpeta.
Cuando se copia una carpeta

Esta operación desencadena un flujo cuando se copia una subcarpeta en una carpeta.
Cuando se crea un archivo (sondeo)

Esta operación desencadena un flujo cuando se crea un nuevo archivo en una carpeta.
Cuando se crea un archivo (webhook)

Esta operación desencadena un flujo cuando se crea un archivo en una carpeta específica
Cuando se crea un flujo de trabajo

Esta operación desencadena un flujo cuando se crea un flujo de trabajo.
Cuando se crea un grupo

Esta operación desencadena un flujo cuando se crea un grupo
Cuando se crea un vínculo de recurso compartido

Esta operación desencadena un flujo cuando se crea un vínculo de recurso compartido.
Cuando se crea una carpeta

Esta operación desencadena un flujo cuando se crea una subcarpeta en una carpeta.
Cuando se crea una carpeta de proyecto

Esta operación desencadena un flujo cuando se crea una carpeta del proyecto o cuando una carpeta existente está marcada como carpeta de proyecto
Cuando se desbloquea un archivo

Esta operación desencadena un flujo cuando se desbloquea un archivo
Cuando se elimina un archivo

Esta operación desencadena un flujo cuando se elimina un archivo en una carpeta.
Cuando se elimina un grupo

Esta operación desencadena un flujo cuando se elimina un grupo.
Cuando se elimina un vínculo de recurso compartido

Esta operación desencadena un flujo cuando se elimina un vínculo de recurso compartido.
Cuando se elimina una carpeta

Esta operación desencadena un flujo cuando se elimina una subcarpeta en una carpeta.
Cuando se mueve un archivo

Esta operación desencadena un flujo cuando se mueve un archivo en una carpeta.
Cuando se mueve una carpeta

Esta operación desencadena un flujo cuando se mueve una subcarpeta en una carpeta.
Cuando se rechaza un flujo de trabajo de tipo de aprobación

Esta operación desencadena un flujo cuando se rechaza un flujo de trabajo de tipo de aprobación.
Cuando un archivo está bloqueado

Esta operación desencadena un flujo cuando un archivo está bloqueado
Cuando una carpeta está sin marcar como un proyecto

Esta operación desencadena un flujo cuando una carpeta está sin marcar como un proyecto

Cuando cambia el archivo o los metadatos de la carpeta

Id. de la operación:
fileOrFolderMetadataChange

Esta operación desencadena un flujo cuando cambian los metadatos de un archivo o carpeta.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Ruta de acceso de destino
 targetPath string
Id. de grupo de destino
 targetGroupId string
Namespace
 namespace string
Key
 key string
Acción
 action string

Cuando cambia el permiso de archivo o carpeta

Id. de la operación:
fileOrFolderPermissionChange

Esta operación desencadena un flujo cuando cambia un archivo o una carpeta.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Persona asignada
 assignee string
Id. de asignado
 assigneeId number
Asignador
 assigner string
Id. del asignador
 assignerId number
Ruta de acceso de carpeta
 folderPath string
Nuevo privilegio
 newPrivilege string
Privilegio antiguo
 oldPrivilege string
Nombre de grupo
 groupName string

Cuando se actualiza un archivo

Id. de la operación:
fileUpdated

Esta operación desencadena un flujo cuando se actualiza un archivo en una carpeta específica.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso al archivo o carpeta de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Identificador de entrada de archivo
 targetEntryId string
Id. de archivo
 targetGroupId string
Ruta de acceso del archivo
 targetPath string

Cuando se actualiza un grupo

Id. de la operación:
groupUpdated

Esta operación desencadena un flujo cuando se actualiza un grupo

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de usuario
 user.id integer

Identificador único del usuario.
Nombre completo
 user.fullName string

Nombre completo del usuario.
Nombre de usuario
 user.userName string

Nombre de usuario del usuario.
Correo electrónico del usuario
 user.email string

La dirección de correo electrónico del usuario.
Id. de usuario
 owner.id integer

Identificador único del usuario.
Nombre completo
 owner.fullName string

Nombre completo del usuario.
Nombre de usuario
 owner.userName string

Nombre de usuario del usuario.
Correo electrónico del usuario
 owner.email string

La dirección de correo electrónico del usuario.
Nombre de grupo
 groupName string

Nombre del grupo.
Identificador de grupo
 groupId string

Identificador único del grupo.
Acción
 action string

Acción específica que desencadenó la actualización del grupo.
Members
 members array of GroupUser

Miembros del grupo.

Cuando se actualiza un proyecto

Id. de la operación:
folderProjectUpdated

Esta operación desencadena un flujo cuando se actualiza un proyecto

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
projectId
 projectId string
projectRootFolderId
 projectRootFolderId string
Nombre del proyecto
 name string
Ubicación del proyecto
 location string
Estado del proyecto
 status string

Estado del proyecto (PENDIENTE, EN CURSO, ON-HOLD, COMPLETED, CANCELED)

Cuando se aprueba un flujo de trabajo de tipo de aprobación

Id. de la operación:
workflowApprovalTaskApproved

Esta operación desencadena un flujo cuando se aprueba un flujo de trabajo de tipo de aprobación

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Body
WorkflowStepResponse

Cuando se cambia el nombre de un archivo

Id. de la operación:
pollRenamedFiles

Esta operación desencadena un flujo cuando se cambia el nombre de un archivo en una carpeta.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. del evento
 id integer

Identificador de un evento individual.
Marca de tiempo
 timestamp string

Marca de tiempo con formato ISO-8601 para cuando se registró este evento.
Id. de usuario
 actor integer

Identificador numérico del usuario que realizó la acción.
Acción
 action string

Acción asociada a este evento.
Ruta de acceso del archivo
 data.target_path string

Ruta de acceso completa al archivo cuyo nombre ha cambiado
Id. de la versión
 data.target_id string

Identificador de la versión específica del archivo.
Id. de archivo
 data.target_group_id string

Identificador para hacer referencia al archivo en su conjunto.
Ruta de acceso del archivo de origen
 data.source_path string

Ruta de acceso original completa al archivo.
Es carpeta
 data.is_folder boolean

Si el recurso es una carpeta. (True o False)
Origen de la acción
 action_source string

Origen del evento. Por ejemplo, WebUI, Mobile, etc.
Detalles del objeto
 object_detail string

Detalles del objeto

Cuando se cambia el nombre de una carpeta

Id. de la operación:
pollRenamedFolders

Esta operación desencadena un flujo cuando se cambia el nombre de una subcarpeta en una carpeta.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. del evento
 id integer

Identificador de un evento individual.
Marca de tiempo
 timestamp string

Marca de tiempo con formato ISO-8601 para cuando se registró este evento.
Id. de usuario
 actor integer

Identificador numérico del usuario que realizó la acción.
Acción
 action string

Acción asociada a este evento.
Ruta de acceso de carpeta
 data.target_path string

Ruta de acceso de destino completa a la carpeta.
Ruta de acceso de carpeta de origen
 data.source_path string

Ruta de acceso original completa a la carpeta.
Es carpeta
 data.is_folder boolean

Si el recurso es una carpeta. (True o False)
Origen de la acción
 action_source string

Origen del evento. Por ejemplo, WebUI, Mobile, etc.
Detalles del objeto
 object_detail string

Detalles del objeto

Cuando se completa un flujo de trabajo

Id. de la operación:
workflowCompleted

Esta operación desencadena un flujo cuando se completa un flujo de trabajo.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de flujo de trabajo
 workflow.id string
Nombre del flujo de trabajo
 workflow.name string
Id. de visualización de flujo de trabajo
 workflow.displayId number
Tipo de flujo de trabajo
 workflow.type string
Identificador de plantilla de flujo de trabajo
 workflow.templateId string
Estado de la acción de flujo de trabajo
 workflow.actionStatus string
Primer tipo de entidad
 firstEntity.type string
Primera ruta de acceso de entidad
 firstEntity.filePath string
Primer identificador de entrada de entidad
 firstEntity.entryID string
Primer identificador de grupo de entidades
 firstEntity.groupID string
Código de estado de finalización
 completionStatusCode string
Número total de pasos
 totalNumberOfSteps number
Fecha de finalización
 completionDate number

Cuando se copia un archivo

Id. de la operación:
pollCopiedFiles

Esta operación desencadena un flujo cuando se copia un archivo en una carpeta.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. del evento
 id integer

Identificador de un evento individual.
Marca de tiempo
 timestamp string

Marca de tiempo con formato ISO-8601 para cuando se registró este evento.
Id. de usuario
 actor integer

Identificador numérico del usuario que realizó la acción.
Acción
 action string

Acción asociada a este evento.
Ruta de acceso del archivo
 data.target_path string

Ruta de acceso completa al archivo.
Id. de la versión
 data.target_id string

Identificador de la versión específica del archivo.
Id. de archivo
 data.target_group_id string

Identificador para hacer referencia al archivo en su conjunto.
Ruta de acceso del archivo de origen
 data.source_path string

Ruta de acceso original completa al archivo.
Id. de versión del archivo de origen
 data.source_id string

Id. de versión específica del archivo de origen.
Id. de archivo de origen
 data.source_group_id string

Identificador del archivo de origen para hacer referencia al archivo en su conjunto.
Es carpeta
 data.is_folder boolean

Si el recurso es una carpeta. (True o False)
Origen de la acción
 action_source string

Origen del evento. Por ejemplo, WebUI, Mobile, etc.
Detalles del objeto
 object_detail string

Detalle del objeto.

Cuando se copia una carpeta

Id. de la operación:
pollCopiedFolders

Esta operación desencadena un flujo cuando se copia una subcarpeta en una carpeta.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. del evento
 id integer

Identificador de un evento individual.
Marca de tiempo
 timestamp string

Marca de tiempo con formato ISO-8601 para cuando se registró este evento.
Id. de usuario
 actor integer

Identificador numérico del usuario que realizó la acción.
Acción
 action string

Acción asociada a este evento.
Ruta de acceso de carpeta
 data.target_path string

Ruta de acceso de destino completa a la carpeta
Ruta de acceso de carpeta de origen
 data.source_path string

Ruta de acceso original completa a la carpeta
Es carpeta
 data.is_folder boolean

Si el recurso es una carpeta (True o False)
Origen de la acción
 action_source string

Origen del evento. Por ejemplo, WebUI, Mobile, etc.
Detalles del objeto
 object_detail string

Detalles del objeto

Cuando se crea un archivo (sondeo)

Id. de la operación:
pollCreatedFiles

Esta operación desencadena un flujo cuando se crea un nuevo archivo en una carpeta.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. del evento
 id integer

Identificador de un evento.
Marca de tiempo
 timestamp string

Marca de tiempo con formato ISO-8601 para cuando se registró este evento.
Id. de usuario
 actor integer

Identificador numérico del usuario que realizó la acción.
Acción
 action string

Acción asociada a este evento.
Ruta de acceso del archivo
 data.target_path string

Ruta de acceso completa al archivo.
Id. de la versión
 data.target_id string

Identificador de la versión específica del archivo.
Id. de archivo
 data.target_group_id string

Identificador para hacer referencia al archivo en su conjunto.
Es carpeta
 data.is_folder boolean

Si el recurso es una carpeta (True o False).
Origen de la acción
 action_source string

Origen del evento. Por ejemplo, WebUI, Mobile, etc.
Detalles del objeto
 object_detail string

Detalle del objeto.

Cuando se crea un archivo (webhook)

Id. de la operación:
fileCreated

Esta operación desencadena un flujo cuando se crea un archivo en una carpeta específica

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso al archivo o carpeta de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Identificador de entrada de archivo
 targetEntryId string
Id. de archivo
 targetGroupId string
Ruta de acceso del archivo
 targetPath string
Cargar la dirección URL del vínculo
 uploadLinkUrl string

Solo está disponible si el archivo se cargó a través del vínculo de carga

Cuando se crea un flujo de trabajo

Id. de la operación:
workflowCreated

Esta operación desencadena un flujo cuando se crea un flujo de trabajo.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de flujo de trabajo
 workflow.id string
Nombre del flujo de trabajo
 workflow.name string
Id. de visualización de flujo de trabajo
 workflow.displayId number
Tipo de flujo de trabajo
 workflow.type string
Identificador de plantilla de flujo de trabajo
 workflow.templateId string
Estado de la acción de flujo de trabajo
 workflow.actionStatus string
Primer tipo de entidad
 firstEntity.type string
Primera ruta de acceso de entidad
 firstEntity.filePath string
Primer identificador de entrada de entidad
 firstEntity.entryID string
Primer identificador de grupo de entidades
 firstEntity.groupID string
Definición de JSON
 definitionJson string

Cuando se crea un grupo

Id. de la operación:
groupCreated

Esta operación desencadena un flujo cuando se crea un grupo

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de usuario
 user.id integer

Identificador único del usuario.
Nombre completo
 user.fullName string

Nombre completo del usuario.
Nombre de usuario
 user.userName string

Nombre de usuario del usuario.
Correo electrónico del usuario
 user.email string

La dirección de correo electrónico del usuario.
Id. de usuario
 owner.id integer

Identificador único del usuario.
Nombre completo
 owner.fullName string

Nombre completo del usuario.
Nombre de usuario
 owner.userName string

Nombre de usuario del usuario.
Correo electrónico del usuario
 owner.email string

La dirección de correo electrónico del usuario.
Nombre de grupo
 groupName string

Nombre del grupo.
Identificador de grupo
 groupId string

Identificador único del grupo.
Members
 members array of GroupUser

Miembros del grupo.

Cuando se crea un vínculo de recurso compartido

Id. de la operación:
shareLinkCreated

Esta operación desencadena un flujo cuando se crea un vínculo de recurso compartido.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Body
LinkWebhookResponse

Cuando se crea una carpeta

Id. de la operación:
pollCreatedFolders

Esta operación desencadena un flujo cuando se crea una subcarpeta en una carpeta.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. del evento
 id integer

Identificador de un evento.
Marca de tiempo
 timestamp string

Marca de tiempo con formato ISO-8601 para cuando se registró este evento.
Id. de usuario
 actor integer

Identificador numérico del usuario que realizó la acción.
Acción
 action string

Acción asociada a este evento.
Ruta de acceso de carpeta
 data.target_path string

Ruta de acceso completa a la carpeta.
Es carpeta
 data.is_folder boolean

Si el recurso es una carpeta. (True o False)
Origen de la acción
 action_source string

Origen del evento. Por ejemplo, WebUI, Mobile, etc.
Detalles del objeto
 object_detail string

Detalle del objeto.

Cuando se crea una carpeta de proyecto

Id. de la operación:
folderProjectAdded

Esta operación desencadena un flujo cuando se crea una carpeta del proyecto o cuando una carpeta existente está marcada como carpeta de proyecto

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Body
FolderProjectCommon

Cuando se desbloquea un archivo

Id. de la operación:
fileUnlocked

Esta operación desencadena un flujo cuando se desbloquea un archivo

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso al archivo o carpeta de destino.

Devoluciones

Body
FileLockWebhookResponse

Cuando se elimina un archivo

Id. de la operación:
pollDeletedFiles

Esta operación desencadena un flujo cuando se elimina un archivo en una carpeta.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. del evento
 id integer

Identificador de un evento.
Marca de tiempo
 timestamp string

Marca de tiempo con formato ISO-8601 para cuando se registró este evento.
Id. de usuario
 actor integer

Identificador numérico del usuario que realizó la acción.
Acción
 action string

Acción asociada a este evento.
Ruta de acceso de versión
 data.target_path string

Ruta de acceso completa a la versión de archivo específica.
Id. de archivo
 data.target_group_id string

Identificador para hacer referencia al archivo en su conjunto.
Es carpeta
 data.is_folder boolean

Si el recurso es una carpeta. (True o False)
Origen de la acción
 action_source string

Origen del evento. Por ejemplo, WebUI, Mobile, etc.

Cuando se elimina un grupo

Id. de la operación:
groupDeleted

Esta operación desencadena un flujo cuando se elimina un grupo.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de usuario
 user.id integer

Identificador único del usuario.
Nombre completo
 user.fullName string

Nombre completo del usuario.
Nombre de usuario
 user.userName string

Nombre de usuario del usuario.
Correo electrónico del usuario
 user.email string

La dirección de correo electrónico del usuario.
Nombre de grupo
 groupName string

Nombre del grupo.
Identificador de grupo
 groupId string

Identificador único del grupo.

Cuando se elimina un vínculo de recurso compartido

Id. de la operación:
shareLinkDeleted

Esta operación desencadena un flujo cuando se elimina un vínculo de recurso compartido.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Body
LinkWebhookResponse

Cuando se elimina una carpeta

Id. de la operación:
pollDeletedFolders

Esta operación desencadena un flujo cuando se elimina una subcarpeta en una carpeta.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. del evento
 id integer

Identificador de un evento.
Marca de tiempo
 timestamp string

Marca de tiempo con formato ISO-8601 para cuando se registró este evento.
Id. de usuario
 actor integer

Identificador numérico del usuario que realizó la acción.
Acción
 action string

Acción asociada a este evento.
Ruta de acceso de carpeta
 data.target_path string

Ruta de acceso completa a la carpeta eliminada.
Es carpeta
 data.is_folder boolean

Si el recurso es una carpeta. (True o False)
Origen de la acción
 action_source string

Origen del evento. Por ejemplo, WebUI, Mobile, etc.

Cuando se mueve un archivo

Id. de la operación:
pollMovedFiles

Esta operación desencadena un flujo cuando se mueve un archivo en una carpeta.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. del evento
 id integer

Identificador de un evento individual.
Marca de tiempo
 timestamp string

Marca de tiempo con formato ISO-8601 para cuando se registró este evento.
Id. de usuario
 actor integer

Identificador numérico del usuario que realizó la acción.
Acción
 action string

Acción asociada a este evento.
Ruta de acceso del archivo
 data.target_path string

Ruta de acceso completa al archivo.
Id. de la versión
 data.target_id string

Identificador de la versión específica del archivo.
Id. de archivo
 data.target_group_id string

Identificador para hacer referencia al archivo en su conjunto.
Ruta de acceso del archivo de origen
 data.source_path string

Ruta de acceso original completa al archivo.
Es carpeta
 data.is_folder boolean

Si el recurso es una carpeta. (True o False)
Origen de la acción
 action_source string

Origen del evento. Por ejemplo, WebUI, Mobile, etc.
Detalles del objeto
 object_detail string

Detalle del objeto.

Cuando se mueve una carpeta

Id. de la operación:
pollMovedFolders

Esta operación desencadena un flujo cuando se mueve una subcarpeta en una carpeta.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. del evento
 id integer

Identificador de un evento individual.
Marca de tiempo
 timestamp string

Marca de tiempo con formato ISO-8601 para cuando se registró este evento.
Id. de usuario
 actor integer

Identificador numérico del usuario que realizó la acción.
Acción
 action string

Acción asociada a este evento.
Ruta de acceso de carpeta
 data.target_path string

Ruta de acceso de destino completa a la carpeta.
Ruta de acceso de carpeta de origen
 data.source_path string

Ruta de acceso original completa a la carpeta.
Es carpeta
 data.is_folder boolean

Si el recurso es una carpeta. (True o False)
Origen de la acción
 action_source string

Origen del evento. Por ejemplo, WebUI, Mobile, etc.
Detalles del objeto
 object_detail string

Detalles del objeto

Cuando se rechaza un flujo de trabajo de tipo de aprobación

Id. de la operación:
workflowApprovalTaskRejected

Esta operación desencadena un flujo cuando se rechaza un flujo de trabajo de tipo de aprobación.

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Body
WorkflowStepResponse

Cuando un archivo está bloqueado

Id. de la operación:
fileLocked

Esta operación desencadena un flujo cuando un archivo está bloqueado

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso al archivo o carpeta de destino.

Devoluciones

Body
FileLockWebhookResponse

Cuando una carpeta está sin marcar como un proyecto

Id. de la operación:
folderProjectUnmarked

Esta operación desencadena un flujo cuando una carpeta está sin marcar como un proyecto

Parámetros

Nombre Clave Requerido Tipo Description
Ruta de acceso de carpeta
 FolderPath True string

Ruta de acceso a la carpeta de destino.

Devoluciones

Body
FolderProjectCommon

Definiciones

GroupUser

Nombre Ruta de acceso Tipo Description
Id. de usuario
 id integer

Identificador único del usuario.
Nombre completo
 fullName string

Nombre completo del usuario.
Nombre de usuario
 userName string

Nombre de usuario del usuario.
Correo electrónico del usuario
 email string

La dirección de correo electrónico del usuario.

LinkWebhookResponse

Nombre Ruta de acceso Tipo Description
Ruta de acceso de origen
 sourcePath string
Id. de vínculo
 linkId string
Tipo de vínculo
 linkType string

Archivo o carpeta
Dirección URL del vínculo
 linkURL string

FileInfoResponse

Nombre Ruta de acceso Tipo Description
Suma de comprobación
 checksum string

Valor de suma de comprobación de la versión actual del archivo usado para determinar los cambios de archivo.
Tamaño
 size integer

Tamaño del archivo en bytes.
Ruta de acceso del archivo
 path string

Ruta de acceso completa del archivo.
Nombre
 name string

Nombre del archivo.
Está bloqueado
 locked boolean

Estado del bloqueo en el archivo.
Carpeta Is
 is_folder boolean

Si el recurso es una carpeta. Verdadero o Falso
Id. de la versión
 entry_id string

Identificador de la versión actual del archivo.
Id. de archivo
 group_id string

Identificador para hacer referencia al archivo en su conjunto.
Id. de carpeta principal
 parent_id string

Identificador de la carpeta primaria solicitada.
Última modificación
 last_modified string

Hora de última modificación de la versión actual de un archivo.
Cargado por
 uploaded_by string

Nombre de usuario del usuario que cargó la versión actual.
Marca de tiempo cargada
 uploaded integer

Hora cargada de la versión actual del archivo.
Número de versiones
 num_versions integer

Número total de versiones asociadas a la ruta de acceso de archivo específica.
versiones
 versions array of object

Versions
Carpeta Is (versión)
 versions.is_folder boolean

Si el recurso es una carpeta. Verdadero o Falso
Id. de la versión
 versions.entry_id string

Identificador de la versión específica del archivo.
Suma de comprobación (versión)
 versions.checksum string

Valor de suma de comprobación de la versión del archivo usado para determinar los cambios de archivo.
Última modificación (versión)
 versions.last_modified string

Hora de última modificación de la versión específica de un archivo.
Cargado por (versión)
 versions.uploaded_by string

Nombre de usuario del usuario que cargó la versión.
Marca de tiempo cargada (versión)
 versions.uploaded integer

Hora cargada de la versión específica del archivo.
Tamaño (versión)
 versions.size integer

Tamaño del archivo en bytes para la versión específica.

UserInfoResponse

Información del usuario

Nombre Ruta de acceso Tipo Description
Id. de usuario
 id integer

Identificador de usuario
Nombre de usuario
 userName string

Nombre de usuario del usuario
External ID
 externalId string

External ID
Correo Electrónico
 email string

Correo electrónico del usuario
Apellido
 name.familyName string

Nombre de familia de usuario (apellidos)
Nombre propio
 name.givenName string

Nombre especificado por el usuario (nombre)
Active
 active boolean

¿Está activa la cuenta de usuario?
Fecha de creación
 createdDate string

Fecha en la que se creó el usuario
Fecha de última modificación
 lastModificationDate string

La última fecha en la que se modificó el usuario
Última fecha activa
 lastActiveDate string

La última fecha en la que el usuario estaba activo
Bloqueado
 locked boolean

El usuario está bloqueado
Language
 language string

El parámetro "language" solo se acepta cuando el paquete de idioma se ha habilitado para el dominio.
Tipo de autenticación
 authType string

Tipo de autenticación para el usuario.
Tipo de usuario
 userType string

Tipo del usuario.
Rol
 role string

El rol asignado al usuario. Solo se aplica a los usuarios avanzados.
Id. de usuario de IDP
 idpUserId string

Identificador de usuario del proveedor de identidades
¿Es la cuenta de servicio?
 isServiceAccount boolean

Es la cuenta que se usa como cuenta de servicio.
Eliminar al expirar
 deleteOnExpiry string

¿Se eliminará la cuenta después de que expire?
Cambio de correo electrónico pendiente
 emailChangePending boolean

¿Está pendiente el cambio de correo electrónico del usuario?
Fecha de vencimiento
 expiryDate string

Expiración de la cuenta
Nombre principal de usuario
 userPrincipalName string
groups
 groups array of object
Nombre para mostrar
 groups.displayName string

Nombre del grupo
Identificador de grupo
 groups.value string

El ID del grupo

UserListResponse

Obtención de la respuesta de la lista de usuarios

Nombre Ruta de acceso Tipo Description
Total de resultados
 totalResults integer

Número total de resultados que coinciden con la consulta.
Artículos por página
 itemsPerPage integer

Número de resultados devueltos.
Iniciar índice
 startIndex integer

Índice basado en 1 del primer resultado en el conjunto actual de resultados.
resources
 resources array of object
Id. de usuario
 resources.id integer

Identificador del usuario
Nombre de usuario
 resources.userName string

Nombre de usuario del usuario
External ID
 resources.externalId string

External ID
Correo Electrónico
 resources.email string

Correo electrónico del usuario
Nombre con formato
 resources.name.formatted string

Nombre con formato de usuario
Apellido
 resources.name.familyName string

Nombre de familia de usuario (apellidos)
Nombre propio
 resources.name.givenName string

Nombre especificado por el usuario (nombre)
Active
 resources.active boolean

¿Está activa la cuenta de usuario?
Bloqueado
 resources.locked boolean

¿La cuenta de usuario está bloqueada?
Fecha de creación
 resources.createdDate string

Fecha en la que se creó el usuario
Fecha de última modificación
 resources.lastModificationDate string

La última fecha en la que se modificó el usuario
Última fecha activa
 resources.lastActiveDate string

La última fecha en la que el usuario estaba activo
Language
 resources.language string

El parámetro "language" solo se acepta cuando el paquete de idioma se ha habilitado para el dominio.
Tipo de autenticación
 resources.authType string

Tipo de autenticación para el usuario.
Tipo de usuario
 resources.userType string

Tipo del usuario.
Rol
 resources.role string

El rol asignado al usuario. Solo se aplica a los usuarios avanzados.
Id. de usuario de IDP
 resources.idpUserId string

Identificador de usuario del proveedor de identidades
¿Es la cuenta de servicio?
 resources.isServiceAccount boolean

Es la cuenta que se usa como cuenta de servicio.
Eliminar al expirar
 resources.deleteOnExpiry string

¿Se eliminará la cuenta después de que expire?
Cambio de correo electrónico pendiente
 resources.emailChangePending boolean

¿Está pendiente el cambio de correo electrónico del usuario?
Fecha de vencimiento
 resources.expiryDate string

Expiración de la cuenta
Nombre principal de usuario
 resources.userPrincipalName string

FolderInfoResponse

Nombre Ruta de acceso Tipo Description
Nombre
 name string

Nombre de la carpeta.
Última modificación
 lastModified integer

La última vez que se ha modificado cualquier archivo de la carpeta (pero no dentro de las subcarpetas).
Marca de tiempo cargada
 uploaded integer

Hora en que se ha cargado o creado la carpeta.
Ruta de acceso de carpeta
 path string

Ruta de acceso completa de la carpeta.
Id. de carpeta
 folder_id string

Identificador único de la carpeta.
Id. de carpeta principal
 parent_id string

Identificador de la carpeta primaria.
Recuento de subelementos
 total_count integer

Número total de elementos disponibles para devolver.
Carpeta Is
 is_folder boolean

Si el recurso es una carpeta. Verdadero o Falso
Posibles vínculos públicos
 public_links string

Se estableció la opción de carpeta en cuanto a cómo se estableció "Permitir vínculos públicos de esta carpeta para".
Se puede compartir
 allow_links boolean

¿Se puede compartir? T o F
Se puede eliminar o mover
 restrict_move_delete boolean

¿Se puede eliminar o mover? T o F
Carpetas
 folders array of object

Carpetas
Nombre (subcarpeta)
 folders.name string

Nombre de la carpeta.
Última modificación (subcarpeta)
 folders.lastModified integer

La última vez que se ha modificado cualquier archivo de la carpeta (pero no dentro de las subcarpetas).
Marca de tiempo cargada (subcarpeta)
 folders.uploaded integer

Hora en que se ha cargado o creado la carpeta.
Ruta de acceso (subcarpeta)
 folders.path string

Ruta de acceso completa de la carpeta según se solicite.
Id. (subcarpeta)
 folders.folder_id string

Identificador de la carpeta solicitada.
Carpeta Is (subcarpeta)
 folders.is_folder boolean

Si el recurso es una carpeta. Verdadero o Falso
Id. de carpeta principal (subcarpeta)
 folders.parent_id string

Identificador de la carpeta primaria.
files
 files array of object

Archivos
Suma de comprobación (archivo)
 files.checksum string

Valor de suma de comprobación de la versión actual del archivo usado para determinar los cambios de archivo.
Tamaño (archivo)
 files.size integer

Tamaño del archivo en bytes.
Ruta de acceso (archivo)
 files.path string

Ruta de acceso completa del archivo.
Nombre (archivo)
 files.name string

Nombre del archivo.
Está bloqueado (archivo)
 files.locked boolean

Estado del bloqueo en el archivo.
Carpeta Is (archivo)
 files.is_folder boolean

Si el recurso es una carpeta. Verdadero o Falso
Id. de versión (archivo)
 files.entry_id string

Identificador de la versión específica del archivo.
Id. (archivo)
 files.group_id string

Identificador para hacer referencia al archivo en su conjunto.
Id. de carpeta principal (archivo)
 files.parent_id string

Identificador de la carpeta primaria.
Última modificación (archivo)
 files.last_modified string

Hora de última modificación de la versión actual de un archivo.
Cargado por (archivo)
 files.uploaded_by string

Nombre de usuario del usuario que cargó la versión.
Marca de tiempo cargada (archivo)
 files.uploaded integer

Hora cargada de la versión actual del archivo.
Recuento de versiones (archivo)
 files.num_versions integer

Número total de versiones asociadas a la ruta de acceso de archivo específica.

NamespaceItem

Nombre Ruta de acceso Tipo Description
Nombre del espacio de nombres
 name string
Ámbito del espacio de nombres
 scope string
keys
 keys object
Nombre para mostrar
 displayName string

Nombre para identificar el espacio de nombres en la interfaz de usuario.
prioridad
 priority number

Especifica la prioridad (orden) de las claves. Las claves se mostrarán de acuerdo con sus prioridades en orden descendente (primero se mostrarán las claves con mayor prioridad).
heredable
 inheritable boolean
schemaSystemGenerated
 schemaSystemGenerated boolean
metadataScopeType
 metadataScopeType string
editable
 editable boolean

ProjectItem

Nombre Ruta de acceso Tipo Description
Id
 id string

Id. de elemento
Identificador de carpeta raíz
 rootFolderId string

Identificador de carpeta raíz
Nombre
 name string

Nombre del proyecto
Identificación del proyecto
 projectId string

Id. del proyecto
Nombre del cliente
 customerName string

El cliente asociado al proyecto
Description
 description string

Descripción de la carpeta
location
 location ProjectLocationItem
Estado
 status string

Estado del proyecto
Autor
 createdBy number

Autor
Última actualización por
 lastUpdatedBy number

Última actualización por
Hora de creación
 creationTime string

Hora de creación
Hora de la última modificación
 lastModifiedTime string

Hora de la última modificación
Fecha de inicio
 startDate string

Fecha de inicio del proyecto.
Fecha de finalización
 completionDate string

Fecha de finalización del proyecto.

ProjectLocationItem

Nombre Ruta de acceso Tipo Description
Dirección postal 1
 streetAddress1 string

Primera línea de la dirección
Dirección postal 2
 streetAddress2 string

Segunda línea de la dirección
City
 city string

City
Provincia
 state string

Provincia
País
 country string

País
Código postal o código postal
 postalCode string

Código postal o código postal

FileLockWebhookResponse

Nombre Ruta de acceso Tipo Description
Id. de archivo
 targetGroupId string
Suma de comprobación de archivos
 targetFileChecksum string
Ruta de acceso del archivo
 targetPath string

FolderProjectCommon

Nombre Ruta de acceso Tipo Description
projectId
 projectId string
projectRootFolderId
 projectRootFolderId string

WorkflowStepResponse

Nombre Ruta de acceso Tipo Description
Id. de flujo de trabajo
 workflow.id string
Nombre del flujo de trabajo
 workflow.name string
Id. de visualización de flujo de trabajo
 workflow.displayId number
Tipo de flujo de trabajo
 workflow.type string
Identificador de plantilla de flujo de trabajo
 workflow.templateId string
Estado de la acción de flujo de trabajo
 workflow.actionStatus string
Primer tipo de entidad
 firstEntity.type string
Primera ruta de acceso de entidad
 firstEntity.filePath string
Primer identificador de entrada de entidad
 firstEntity.entryID string
Primer identificador de grupo de entidades
 firstEntity.groupID string
Id. de paso
 step.id string
Nombre del paso
 step.name string
Tipo de paso
 step.type string
Id. de asignado
 assignee.id number
Nombre para mostrar del receptor
 assignee.displayName string
Nombre de usuario asignado
 assignee.username string
Correo electrónico asignado
 assignee.email string
Número total de pasos
 totalNumberOfSteps number
Fecha de finalización
 completionDate number
Fecha de creación
 creationDate number

AIQuestionResponse

Nombre Ruta de acceso Tipo Description
response
 response AIResponse
Citas
 citations array of AICitation

Citas y referencias usadas para generar la respuesta

AISummaryResponse

Nombre Ruta de acceso Tipo Description
response
 response AIResponse

AICopilotResponse

Nombre Ruta de acceso Tipo Description
response
 response AIResponse
Citas
 citations array of AICitation

Citas y referencias usadas para generar la respuesta
Id. de la conversación
 conversationId string

Identificador único de la conversación

AICitation

Nombre Ruta de acceso Tipo Description
Filename
 filename string

Nombre del archivo de origen
Id. de entrada
 entryId string

Identificador de entrada del archivo de origen
Fragmentos de texto
 chunks array of object

Matriz de fragmentos de texto del origen
Id. de fragmento
 chunks.chunkId string

Identificador del fragmento de texto
Texto de origen
 chunks.sourceText string

Contenido de texto del fragmento

AIResponse

Nombre Ruta de acceso Tipo Description
Texto de respuesta
 text string

Texto de respuesta generado por IA