Compartir a través de

NetDocuments

NetDocuments es un servicio de administración de contenido en la nube para empresas de todos los tamaños para crear, almacenar, administrar y compartir de forma segura su trabajo de documentos en cualquier lugar y en cualquier momento.

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

Service Class Regions
Copilot Studio Estándar 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 Estándar 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 Estándar 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
URL https://support.netdocuments.com/hc/en-us
Metadatos del conector
Publicador NetDocuments Software, Inc.
Website https://www.netdocuments.com/
Directiva de privacidad https://www.netdocuments.com/privacy-policy/

Creación de una conexión

El conector admite los siguientes tipos de autenticación:
Predeterminado Parámetros para crear una conexión. Todas las regiones No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre Tipo Description Obligatorio
Región cuerda / cadena Región en la que reside el documento neto. Cierto

Limitaciones

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

Acciones

Actualizar documento

Actualizar el contenido de un documento
Actualizar un área de trabajo

Actualizar un área de trabajo
Agregar o quitar grupo del gabinete

Adición de grupos a armario y derechos de acceso predeterminados
Agregar o quitar miembro del grupo

Agregar o quitar miembro del grupo
Agregar usuario al repositorio o quitarlo del repositorio

Agregar usuario al repositorio o quitarlo del repositorio
Archivo o desarchivo de documento a carpeta

File an item in a folder or unfile an item from a folder.
Bloquear documento

Bloquear documento
Bloquear la versión del documento

Bloquear la versión del documento
Buscar en un gabinete y modificar las ACL

Buscar en un gabinete y modificar las ACL
Buscar entradas de tabla de búsqueda

Buscar entradas de tabla de búsqueda
Buscar uno o varios gabinetes

Buscar uno o varios gabinetes
Cambiar el nombre del documento

Cambiar el nombre de un documento
Cambiar nombre de carpeta

Cambiar el nombre de una carpeta
Creación de CollabSpace

Creación de un nuevo objeto CollabSpace
Creación de un grupo de repositorios

Creación de un grupo de repositorios
Creación de un grupo externo de gabinete

Creación de un grupo externo de gabinete
Creación de un usuario

Creación de un usuario en un repositorio
Creación de un vínculo protegido

Generar un vínculo a un documento al que cualquier usuario pueda acceder
Creación de una nueva versión de un documento

Creación de una nueva versión de un documento
Crear carpeta

Creación de una carpeta
Crear documento

Crear documento nuevo
Crear o actualizar una entrada de tabla de búsqueda

Crear o actualizar una entrada de tabla de búsqueda
Crear o actualizar una entrada de tabla de búsqueda secundaria

Crear o actualizar una entrada de tabla de búsqueda secundaria
Desbloquear documento

Desconocer documento
Documento de des check out

Consultar un documento
Documento de registro

Proteger un documento desprotegido
Eliminación de una entrada de tabla de búsqueda

Eliminación de una entrada de tabla de búsqueda
Eliminación de una entrada de tabla de búsqueda secundaria

Eliminación de una entrada de tabla de búsqueda secundaria
Eliminación del grupo de repositorios

Eliminación de un grupo de repositorios
Eliminar carpeta

Eliminar una carpeta
Eliminar documento

Eliminar un documento
Historial de documentos

Recuperar una lista de acciones realizadas en un documento
Obtención de atributos personalizados del gabinete

Obtención de atributos personalizados del gabinete
Obtención de grupos de repositorios

Obtención de grupos de repositorios
Obtención de información de usuario

Obtener información sobre un usuario
Obtención de información de usuario actual

Obtención de información sobre el usuario actual, no se requiere el identificador
Obtención de información del repositorio

Obtención de información del repositorio
Obtención de información del área de trabajo

Obtención de información del área de trabajo
Obtención de usuarios del repositorio

Obtención de usuarios del repositorio
Obtención de versiones de documentos

Obtención de versiones de documentos
Obtención del contenido del contenedor

Obtener el contenido del contenedor seleccionado
Obtención del registro del repositorio

Obtención del registro del repositorio
Obtener contenido del documento

Recuperar un documento
Obtener derechos de acceso a grupos de gabinetes no ocultos

Obtener derechos de acceso a grupos de gabinetes no ocultos
Obtener elementos de carpeta

Recuperar el contenido de una carpeta, incluidos documentos y subcarpetas
Obtener grupos de gabinetes

Obtener todos los grupos agregados a un gabinete
Obtener información de grupo

Obtener información de grupo
Obtener información del gabinete

Obtener información del gabinete
Obtener la configuración del gabinete

Obtener la configuración del gabinete
Obtener la lista de gabinetes de usuario

Obtener gabinetes de usuario
Obtener o crear un área de trabajo (con atributos primarios y secundarios)

Obtener o crear un área de trabajo (con atributos primarios y secundarios)
Obtener o crear un área de trabajo (con un único atributo)

Obtener o crear un área de trabajo (con un único atributo)
Obtener perfil de documento

Obtener información sobre un documento
Obtener pertenencia a grupos

Obtener pertenencia a grupos
Obtener una entrada de tabla de búsqueda o buscar entradas de tabla secundarias

Obtener una entrada de tabla de búsqueda o buscar entradas de tabla secundarias
Obtener una entrada de tabla de búsqueda secundaria

Obtener una entrada de tabla de búsqueda secundaria
Seguir carpeta

Recibir alertas cuando se agrega contenido nuevo a una carpeta
Seguir documento

Recibir alertas cuando se actualiza el documento

Actualizar documento

Id. de la operación:
UpdateDocument

Actualizar el contenido de un documento

Parámetros

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

Id. de documento de 12 dígitos.
Extensión de documento
 extension string

Solo es necesario si se cambia la extensión del documento. No incluya el período inicial.
¿Codificado en Base64?
 base64 boolean

¿Codificado en Base64?
Contenido actualizado del documento
 body True byte

Contenido del documento.

Actualizar un área de trabajo

Id. de la operación:
RefreshWorkspace

Actualizar un área de trabajo

Parámetros

Nombre Clave Requerido Tipo Description
ID del espacio de trabajo
 workspaceID True string

ID del espacio de trabajo

Agregar o quitar grupo del gabinete

Id. de la operación:
AddToOrRemoveGroupFromCabinet

Adición de grupos a armario y derechos de acceso predeterminados

Parámetros

Nombre Clave Requerido Tipo Description
Id. de gabinete
 cabinetID True string

(Comienza con NG-)
Agregar o quitar grupo
 action True string

Agregar o quitar grupo
Identificador de grupo
 id True string

Id. de grupo (comienza con UG-).
Ver derechos
 view True boolean

Ver derechos (V): solo para agregar.
Editar derechos
 edit True boolean

Editar derechos (E): solo para agregar.
Derechos de uso compartido
 share True boolean

Derechos de recurso compartido (S): solo para agregar.
Administración de derechos
 administer True boolean

Administrar derechos (A): solo para agregar.
Sin derechos de acceso
 noAccess True boolean

Sin derechos de acceso (N): solo para agregar.

Agregar o quitar miembro del grupo

Id. de la operación:
AddOrRemoveGroupMember

Agregar o quitar miembro del grupo

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de grupo
 groupID True string

(Comienza con UG-)
Agregar o quitar el usuario
 action True string

Agregar o quitar el usuario
Id. de usuario
 member True string

(Debe ser miembro del repositorio ya).

Agregar usuario al repositorio o quitarlo del repositorio

Id. de la operación:
AddOrRemoveUserRepository

Agregar usuario al repositorio o quitarlo del repositorio

Parámetros

Nombre Clave Requerido Tipo Description
ID del repositorio
 repositoryID True string

(Comienza con CA-)
Agregar o quitar usuario
 action True string

Agregar o quitar usuario
Id. de usuario
 member True string

Id. de usuario
El usuario es externo
 external True boolean

El usuario es externo
Eliminar usuario (si está federado)
 deleteIfFederated boolean

(Solo aplicable en remove)

Archivo o desarchivo de documento a carpeta

Id. de la operación:
FileFolder

File an item in a folder or unfile an item from a folder.

Parámetros

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

Identificador de carpeta de 12 dígitos.
Id. de documento
 item True string

Id. de documento de 12 dígitos.
Archivo o desarchivo
 action True string

Archivo o desarchivo

Bloquear documento

Id. de la operación:
LockDocument

Bloquear documento

Parámetros

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

Id. de documento
Comentario
 comment string

Comentario

Bloquear la versión del documento

Id. de la operación:
LockDocumentVersion

Bloquear la versión del documento

Parámetros

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

Id. de documento de 12 dígitos.
Versión del documento
 version True integer

Versión del documento
Descripción de la versión
 description string

Descripción de la versión

Buscar en un gabinete y modificar las ACL

Id. de la operación:
SearchCabinetModifyACLs

Buscar en un gabinete y modificar las ACL

Parámetros

Nombre Clave Requerido Tipo Description
Id. de gabinete
 cabinetID True string

(Comienza con NG-)
Query
 q True string

(Revise la documentación del formato de consulta).
Modificar el modo de ACL
 mode True string

Modificar el modo de ACL
Nueva ACL
 newAcl True string

(Revise la documentación para obtener el formato JSON adecuado)
Dirección de correo electrónico
 email email

(Enviar notificación a esta dirección en su lugar)
Enviar correos electrónicos de finalización
 completionEmail string

(true = send always (default), false = don't send, fail = send only on fail)

Buscar entradas de tabla de búsqueda

Id. de la operación:
SearchLookupEntries

Buscar entradas de tabla de búsqueda

Parámetros

Nombre Clave Requerido Tipo Description
ID del repositorio
 repositoryID True string

(Comienza con CA-)
Id. de atributo
 attributeID True string

(Quite el "10" inicial)
Filter
 $filter string

(Consulte la documentación de los filtros disponibles).
Campos que se van a recuperar
 $select string

(Incluya una lista separada por comas de: 'key', 'description', 'parent', 'hold', 'closed', 'defaulting', 'type', 'user', and/or 'access')
Número de registros coincidentes que se van a omitir
 $skip integer

(Esto se usa al recuperar varios bloques de resultados).
Número máximo de registros que se van a devolver
 $top integer

Número máximo de registros que se van a devolver

Devoluciones

Nombre Ruta de acceso Tipo Description
Filas
 rows array of object
moroso
 rows.defaulting string
descripción
 rows.description string
sostener
 rows.hold boolean
key
 rows.key string
cerrado
 rows.closed string
acceso
 rows.access string

Buscar uno o varios gabinetes

Id. de la operación:
SearchCabinets

Buscar uno o varios gabinetes

Parámetros

Nombre Clave Requerido Tipo Description
Gabinetes
 cabinets True string

(delimitado por comas)
Query
 q True string

(Revise la documentación del formato de consulta).
Información que se va a devolver
 select True string

(Revise la documentación del formato de devolución)
Ordenar por
 orderby string

(Formato: field#|desc o field#|asc)
Número de resultados que se van a devolver (el valor predeterminado es 50)
 top integer

(Máximo 500 por página)
Número de resultados que se van a omitir
 skip integer

Número de resultados que se van a omitir
Token usado para paginar resultados
 skiptoken string

Token usado para paginar resultados

Cambiar el nombre del documento

Id. de la operación:
RenameDocument

Cambiar el nombre de un documento

Parámetros

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

Id. de documento de 12 dígitos.
Nuevo nombre
 name True string

Cambiar nombre de carpeta

Id. de la operación:
RenameFolder

Cambiar el nombre de una carpeta

Parámetros

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

Identificador de carpeta de 12 dígitos.
Nuevo nombre
 name True string

Creación de CollabSpace

Id. de la operación:
CreateCollabSpace

Creación de un nuevo objeto CollabSpace

Parámetros

Nombre Clave Requerido Tipo Description
ID del espacio de trabajo
 workspaceID True string

ID del espacio de trabajo
Nombre de CollabSpace
 name True string

Nombre de CollabSpace
Description
 description string

Description

Devoluciones

Nombre Ruta de acceso Tipo Description
Id
 Id string
EnvUrl
 EnvUrl string

Creación de un grupo de repositorios

Id. de la operación:
CreateRepositoryGroup

Creación de un grupo de repositorios

Parámetros

Nombre Clave Requerido Tipo Description
ID del repositorio
 repositoryID True string

(Comienza con CA-)
Nombre del grupo
 name True string

Nombre del grupo
External
 external True boolean

External
Ocultar en listas
 hidden True boolean

Ocultar en listas
Pertenencia oculta
 hideMembership True boolean

Pertenencia oculta

Devoluciones

Nombre Ruta de acceso Tipo Description
externo
 external boolean
hidden
 hidden boolean
hideMembership
 hideMembership boolean
id
 id string
nombre
 name string

Creación de un grupo externo de gabinete

Id. de la operación:
CreateCabinetExternalGroup

Creación de un grupo externo de gabinete

Parámetros

Nombre Clave Requerido Tipo Description
Id. de gabinete
 cabinetID True string

(Comienza con NG-)
Nombre del grupo
 name True string

Nombre del grupo
Opciones de grupo
 options string

Opciones de grupo
Acceso predeterminado del gabinete
 access string

Acceso predeterminado del gabinete
Id. de CollabSpace
 collaborationSpaceId string

(Para convertir esto en un grupo externo de CollabSpace)
Acceso a CollabSpace
 collaborationspaceaccess string

Acceso a CollabSpace
Valor de atributo del área de trabajo superior
 topwsattributegroupkey string

(Para grupos externos de gabinete normales; para asociar el grupo a un valor de atributo de área de trabajo superior específico)

Devoluciones

Nombre Ruta de acceso Tipo Description
Tipo
 Type integer
Id
 Id string
Nombre
 Name string
Options
 Options string
Acceso
 Access string

Creación de un usuario

Id. de la operación:
CreateUser

Creación de un usuario en un repositorio

Parámetros

Nombre Clave Requerido Tipo Description
Nombre de usuario
 username True email

(Igual que la dirección de correo electrónico del usuario)
Nombre
 displayFirstName True string

Nombre
Segundo nombre
 displayMiddleName string

Segundo nombre
Apellido
 displayLastName True string

Apellido
Dirección de correo electrónico
 email True email

Dirección de correo electrónico
El usuario es externo
 external True boolean

(Solo se aplica al agregar)
Enviar correo de bienvenida
 sendWelcome True boolean

Enviar correo de bienvenida
ID del repositorio
 repository True string

(Comienza con CA-)

Devoluciones

Nombre Ruta de acceso Tipo Description
Nombre para mostrar
 displayName string
Correo electrónico
 email email
id
 id string
externo
 external boolean

Creación de un vínculo protegido

Id. de la operación:
CreateSecuredLink

Generar un vínculo a un documento al que cualquier usuario pueda acceder

Parámetros

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

Id. de documento de 12 dígitos.
Contraseña del vínculo protegido
 password string

Dependiendo de la configuración del gabinete, la contraseña puede ser opcional o obligatoria.
Fecha de expiración del vínculo protegido.
 expirationdate string

Formato de entrada: aaaa-MM-dd.
Versión del documento
 version string

La versión del documento que se va a compartir. Si está vacía, se compartirá la versión oficial.
Descargar documento
 download boolean

Si es true, el destinatario puede descargar el documento.
Notificarme
 notifyme boolean

Si es true, notifique al remitente cuando se acceda al vínculo protegido.
Bloquear documento
 lock boolean

Opcionalmente, bloquee la versión seleccionada del documento. Esto requiere derechos de edición.

Devoluciones

Nombre Ruta de acceso Tipo Description
view
 standardAttributes.view string
descargar
 standardAttributes.download string

Creación de una nueva versión de un documento

Id. de la operación:
NewVersion

Creación de una nueva versión de un documento

Parámetros

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

Id. de documento de 12 dígitos.
Extensión de documento
 extension string

No incluya el período inicial.
Descripción de la versión
 version_description string

Descripción de la versión
Nombre de la nueva versión
 verName string

Nombre de la nueva versión
Hacer la versión oficial
 official boolean

La nueva versión no será la versión oficial si este parámetro no está establecido.
Agregar a documentos recientes
 addToRecent boolean

Agregar a documentos recientes
Número de versión de origen
 srcVer string

Si copia el contenido de una versión anterior, qué versión del documento se va a copiar.
Crear como subversión
 allocatesubversion boolean

Cree como subversión en lugar de como una versión completa.
Nuevo contenido del documento de versión
 body binary

Contenido de la nueva versión, si no copia otra versión o la versión oficial.

Devoluciones

Nombre Ruta de acceso Tipo Description
latestVersionNumber
 latestVersionNumber integer
newVer
 newVer integer
newVersionLabel
 newVersionLabel string
officialVer
 officialVer integer
officialVerName
 officialVerName string
versiones
 versions integer

Crear carpeta

Id. de la operación:
CreateFolder

Creación de una carpeta

Parámetros

Nombre Clave Requerido Tipo Description
Nombre de carpeta
 name True string

Nombre de carpeta.
Id. primario
 parent string

Identificador de 12 dígitos o EnvID del contenedor primario de la nueva carpeta.
Id. de gabinete
 cabinet string

(Comienza con NG-) Se puede omitir si se especifica un identificador de carpeta o área de trabajo en el elemento primario.

Devoluciones

Nombre Ruta de acceso Tipo Description
id
 standardAttributes.id string
nombre
 standardAttributes.name string

Crear documento

Id. de la operación:
CreateDocument

Crear documento nuevo

Parámetros

Nombre Clave Requerido Tipo Description
Destino
 destination True string

Identificador de 12 dígitos o EnvID de la carpeta, filtro o área de trabajo.
Contenido del documento
 file True file

Coloque el nombre de archivo más la extensión en el campo de nombre de archivo adjunto.
Agregar a recientes
 addToRecent boolean

Agregar a recientes
Perfil de documento
 profile string

Establecimiento del perfil de documento (formato JSON)

Devoluciones

Nombre Ruta de acceso Tipo Description
id
 id string
extensión
 extension string
nombre
 name string

Crear o actualizar una entrada de tabla de búsqueda

Id. de la operación:
CreateEntry

Crear o actualizar una entrada de tabla de búsqueda

Parámetros

Nombre Clave Requerido Tipo Description
ID del repositorio
 repositoryID True string

(Comienza con CA-)
Id. de atributo
 attributeID True string

(Quite el "10" inicial)
Key
 parentID True string

Key
Description
 description string
Tipo
 defaulting string
Retención por juicio
 hold boolean
Fecha de cierre
 closed string

Formato '/Date(Number of Millis From Jan 1, 1970+-UTC', like: '/Date(1582261200000-0500)/'
Permisos filtrados
 filtered_permissions True boolean
Forzar permsiones
 force_permissions True boolean
Ver
 view True boolean
Edit
 edit True boolean
Compartir
 share True boolean
Administer
 administer True boolean
Sin acceso
 noAccess True boolean
Valor predeterminado del gabinete
 cabDefault True boolean
Entidad de seguridad
 principal True string

(Identificador de usuario o grupo)

Devoluciones

Nombre Ruta de acceso Tipo Description
count
 count integer

Crear o actualizar una entrada de tabla de búsqueda secundaria

Id. de la operación:
CreateChildEntry

Crear o actualizar una entrada de tabla de búsqueda secundaria

Parámetros

Nombre Clave Requerido Tipo Description
ID del repositorio
 repositoryID True string

(Comienza con CA-)
Identificador de atributo secundario
 childAttributeID True string

(Quite el "10" inicial)
Clave principal
 parentID True string

Clave principal
Clave secundaria
 childID True string

Clave secundaria
Description
 description string
Tipo
 defaulting string
Retención por juicio
 hold boolean
Fecha de cierre
 closed string

Formato '/Date(Number of Millis From Jan 1, 1970+-UTC', like: '/Date(1582261200000-0500)/'
Permisos filtrados
 filtered_permissions True boolean
Forzar permsiones
 force_permissions True boolean
Ver
 view True boolean
Edit
 edit True boolean
Compartir
 share True boolean
Administer
 administer True boolean
Sin acceso
 noAccess True boolean
Valor predeterminado del gabinete
 cabDefault True boolean
Entidad de seguridad
 principal True string

(Identificador de usuario o grupo)

Devoluciones

Nombre Ruta de acceso Tipo Description
count
 count integer

Desbloquear documento

Id. de la operación:
UnockDocument

Desconocer documento

Parámetros

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

Id. de documento

Documento de des check out

Id. de la operación:
CheckOutDoc

Consultar un documento

Parámetros

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

Id. de documento de 12 dígitos.
Comentario
 comment string

Comentario
Descargar documento
 download boolean

Devuelve el contenido del documento.
Versión que se va a descargar
 version string

Especifica el contenido de la versión que se debe descargar. El valor predeterminado es la versión oficial.
Agregar a recientes
 addToRecent boolean

Agregar a recientes

Documento de registro

Id. de la operación:
CheckinDoc

Proteger un documento desprotegido

Parámetros

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

Id. de documento de 12 dígitos.
Extensión de documento
 extension string

No incluya el período inicial.
Contenido del documento
 file file

Documento en forma de varias partes.
Agregar a recientes
 addToRecent boolean

Agregue a la lista de documentos recientes del usuario.

Eliminación de una entrada de tabla de búsqueda

Id. de la operación:
DeleteLookupEntry

Eliminación de una entrada de tabla de búsqueda

Parámetros

Nombre Clave Requerido Tipo Description
ID del repositorio
 repositoryID True string

(Comienza con CA-)
Id. de atributo
 attributeID True string

(Quite el "10" inicial)
Key
 parentID True string

Key

Devoluciones

Nombre Ruta de acceso Tipo Description
count
 count integer

Eliminación de una entrada de tabla de búsqueda secundaria

Id. de la operación:
DeleteChildEntry

Eliminación de una entrada de tabla de búsqueda secundaria

Parámetros

Nombre Clave Requerido Tipo Description
ID del repositorio
 repositoryID True string

(Comienza con CA-)
Identificador de atributo secundario
 childAttributeID True string

(Quite el "10" inicial)
Clave principal
 parentID True string

Clave principal
Clave secundaria
 childID True string

Clave secundaria

Devoluciones

Nombre Ruta de acceso Tipo Description
count
 count integer

Eliminación del grupo de repositorios

Id. de la operación:
DeleteRepositoryGroup

Eliminación de un grupo de repositorios

Parámetros

Nombre Clave Requerido Tipo Description
ID del repositorio
 repositoryID True string

(Comienza con CA-)
Identificador de grupo
 groupID True string

(Comienza con UG-)

Eliminar carpeta

Id. de la operación:
DeleteFolder

Eliminar una carpeta

Parámetros

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

Id. de carpeta de 12 dígitos.
Eliminar permanentemente
 permanent boolean

Indica que la carpeta se debe eliminar permanentemente, en lugar de moverla a Elementos eliminados. El contenido de la carpeta, incluidas las subcarpetas descendientes, no se eliminará permanentemente.
Eliminación del contenido de la carpeta
 deleteContents boolean

Indica que los documentos de la carpeta eliminada (y en cualquier subcarpeta descendiente) deben eliminarse también, en lugar de simplemente no filtrados.

Eliminar documento

Id. de la operación:
DeleteDoc

Eliminar un documento

Parámetros

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

Id. de documento de 12 dígitos.
Eliminar permanentemente
 permanent boolean

Indica que el documento debe eliminarse permanentemente, en lugar de moverse a Elementos eliminados.

Historial de documentos

Id. de la operación:
GetDocHistory

Recuperar una lista de acciones realizadas en un documento

Parámetros

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

Id. de documento de 12 dígitos.

Obtención de atributos personalizados del gabinete

Id. de la operación:
GetCabinetCustomAttributes

Obtención de atributos personalizados del gabinete

Parámetros

Nombre Clave Requerido Tipo Description
Id. de gabinete
 cabinetID True string

(Comienza con NG-)

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
items
 object

Obtención de grupos de repositorios

Id. de la operación:
GetRepositoryGroups

Obtención de grupos de repositorios

Parámetros

Nombre Clave Requerido Tipo Description
ID del repositorio
 repositoryID True string

(Comienza con CA-)
Filter
 $filter string

(Consulte la documentación para conocer los criterios de filtro).
Número de resultados
 $top string

(El valor predeterminado es 5000. Máximo 10 000)
Paging
 paging boolean

(Devuelve los resultados en páginas; el valor predeterminado es false)
Token de paginación
 $skiptoken string

(Para fines de paginación; devuelto por llamadas anteriores como "next")
Información de devolución
 returnInfo string

todos devolverán nombres de grupo. El valor predeterminado es en blanco para devolver solo identificadores

Devoluciones

Nombre Ruta de acceso Tipo Description
array of string

Obtención de información de usuario

Id. de la operación:
GetUserInfo

Obtener información sobre un usuario

Parámetros

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

Identificador de usuario asignado por NetDocuments.
Id. de gabinete
 cabGuid string

(Comienza con NG-)

Devoluciones

Nombre Ruta de acceso Tipo Description
Nombre para mostrar
 displayName string
Correo electrónico
 email email
id
 id string
organización
 organization string
isRepositoryMember
 isRepositoryMember boolean
primaryCabinet
 primaryCabinet string
sortLookupBy
 sortLookupBy string
externo
 external boolean

Obtención de información de usuario actual

Id. de la operación:
GetCurrentUserInfo

Obtención de información sobre el usuario actual, no se requiere el identificador

Parámetros

Nombre Clave Requerido Tipo Description
Id. de gabinete
 cabGuid string

(Comienza con NG-)

Devoluciones

Nombre Ruta de acceso Tipo Description
Nombre para mostrar
 displayName string
Correo electrónico
 email email
id
 id string
organización
 organization string
isRepositoryMember
 isRepositoryMember boolean
primaryCabinet
 primaryCabinet string
sortLookupBy
 sortLookupBy string
externo
 external boolean

Obtención de información del repositorio

Id. de la operación:
GetRepositoryInformation

Obtención de información del repositorio

Parámetros

Nombre Clave Requerido Tipo Description
ID del repositorio
 repositoryID True string

(Comienza con CA-)

Obtención de información del área de trabajo

Id. de la operación:
GetWorkspaceInformation

Obtención de información del área de trabajo

Parámetros

Nombre Clave Requerido Tipo Description
ID del espacio de trabajo
 workspaceID True string

ID del espacio de trabajo

Obtención de usuarios del repositorio

Id. de la operación:
GetRepositoryUsers

Obtención de usuarios del repositorio

Parámetros

Nombre Clave Requerido Tipo Description
ID del repositorio
 repositoryID True string

(Comienza con CA-)

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
Nombre para mostrar
 displayName string
Correo electrónico
 email string
externo
 external boolean
id
 id string
lastLogin
 lastLogin string
registrado
 registered string

Obtención de versiones de documentos

Id. de la operación:
GetDocumentVersions

Obtención de versiones de documentos

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 documentID True string

Id. de documento de 12 dígitos.

Obtención del contenido del contenedor

Id. de la operación:
GetContainerContents

Obtener el contenido del contenedor seleccionado

Parámetros

Nombre Clave Requerido Tipo Description
ID de contenedor
 containerID True string

ID de contenedor
Información que se va a devolver
 select True string

(Revise la documentación del formato de devolución)
Número de resultados que se van a devolver (el valor predeterminado es 50)
 top integer

(Máximo 500 por página)
Token usado para paginar resultados
 skiptoken string

Token usado para paginar resultados
Ordenar por
 orderby string

(Formato: field#|desc o field#|asc)

Obtención del registro del repositorio

Id. de la operación:
GetRepositoryLog

Obtención del registro del repositorio

Parámetros

Nombre Clave Requerido Tipo Description
ID del repositorio
 repositoryID True string

(Comienza con CA-)
Fecha y hora de inicio
 start string

(El valor predeterminado es de 30 días; formatear aaaa-MM-dd o aaaa-MM-ddThh:mm:ssZ)
Fecha y hora de finalización
 end string

(El mismo formato que el inicio; el valor predeterminado es hoy)
Tipo de registro
 Logtype True string

Tipo de registro

Obtener contenido del documento

Id. de la operación:
GetDocContent

Recuperar un documento

Parámetros

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

Id. de documento de 12 dígitos.
¿Codificado en Base64?
 base64 boolean

¿Codificado en Base64?

Obtener derechos de acceso a grupos de gabinetes no ocultos

Id. de la operación:
GetCabinetDefaultAccess

Obtener derechos de acceso a grupos de gabinetes no ocultos

Parámetros

Nombre Clave Requerido Tipo Description
Id. de gabinete
 cabinetID True string

(Comienza con NG-)

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
administrar
 administer boolean
cabDefault
 cabDefault boolean
edit
 edit boolean
nombre
 name string
noAccess
 noAccess boolean
principal
 principal string
Compartir
 share boolean
view
 view boolean

Obtener elementos de carpeta

Id. de la operación:
GetFldContent

Recuperar el contenido de una carpeta, incluidos documentos y subcarpetas

Parámetros

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

Identificador de carpeta de 12 dígitos.
Atributos que se van a devolver
 $select string

Lista separada por comas de valores de atributo. Consulte la documentación de la API REST para obtener más detalles.

Obtener grupos de gabinetes

Id. de la operación:
GetCabinetGroups

Obtener todos los grupos agregados a un gabinete

Parámetros

Nombre Clave Requerido Tipo Description
Id. de gabinete
 cabinetID True string

(Comienza con NG-)

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
Id
 Id string
Nombre
 Name string
External
 External boolean
Oculto
 Hidden boolean

Obtener información de grupo

Id. de la operación:
GetGroupInformation

Obtener información de grupo

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de grupo
 groupID True string

Id. de grupo (comienza con UG-).
Pertenencia al gabinete de grupo
 cabMembership boolean

(Si se establece en "true", los gabinetes de estos grupos son miembros y se incluirán los derechos de acceso de documento predeterminados para cada gabinete).

Devoluciones

Nombre Ruta de acceso Tipo Description
externo
 external boolean
hidden
 hidden boolean
hideMembership
 hideMembership boolean
id
 id string
nombre
 name string
cabMembership
 cabMembership array of object
id
 cabMembership.id string
nombre
 cabMembership.name string
derechos
 cabMembership.rights string

Obtener información del gabinete

Id. de la operación:
GetCabinetInformation

Obtener información del gabinete

Parámetros

Nombre Clave Requerido Tipo Description
Id. de gabinete
 cabinetID True string

(Comienza con NG-)

Obtener la configuración del gabinete

Id. de la operación:
GetCabinetSettings

Obtener la configuración del gabinete

Parámetros

Nombre Clave Requerido Tipo Description
Id. de gabinete
 cabinetID True string

(Comienza con NG-)

Obtener la lista de gabinetes de usuario

Id. de la operación:
GetUserCabinets

Obtener gabinetes de usuario

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
id
 id string
isCollaborationSpacesEnabled
 isCollaborationSpacesEnabled string
nombre
 name string
repositoryId
 repositoryId string
repositoryName
 repositoryName string
wsAttrNum
 wsAttrNum integer
wsOrgAttrNum
 wsOrgAttrNum integer

Obtener o crear un área de trabajo (con atributos primarios y secundarios)

Id. de la operación:
CreateWorkspaceParentChild

Obtener o crear un área de trabajo (con atributos primarios y secundarios)

Parámetros

Nombre Clave Requerido Tipo Description
Id. de gabinete
 cabinetID True string

(Comienza con NG-)
Valor primario
 parentID True string

Valor primario que se usa para definir áreas de trabajo en el gabinete.
Valor secundario
 childID True string

Valor secundario que se usa para definir áreas de trabajo en el gabinete.

Devoluciones

Nombre Ruta de acceso Tipo Description
id
 standardAttributes.id string

Obtener o crear un área de trabajo (con un único atributo)

Id. de la operación:
CreateWorkspaceSingle

Obtener o crear un área de trabajo (con un único atributo)

Parámetros

Nombre Clave Requerido Tipo Description
Id. de gabinete
 cabinetID True string

(Comienza con NG-)
Valor único
 parentID True string

Valor único que se usa para definir áreas de trabajo en el gabinete.

Devoluciones

Nombre Ruta de acceso Tipo Description
id
 standardAttributes.id string

Obtener perfil de documento

Id. de la operación:
GetDocInfo

Obtener información sobre un documento

Parámetros

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

Id. de documento de 12 dígitos.

Obtener pertenencia a grupos

Id. de la operación:
GetGroupMembership

Obtener pertenencia a grupos

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de grupo
 groupID True string

(Comienza con UG-)

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
Nombre para mostrar
 displayName string
id
 id string

Obtener una entrada de tabla de búsqueda o buscar entradas de tabla secundarias

Id. de la operación:
GetLookupEntry

Obtener una entrada de tabla de búsqueda o buscar entradas de tabla secundarias

Parámetros

Nombre Clave Requerido Tipo Description
ID del repositorio
 repositoryID True string

(Comienza con CA-)
Id. de atributo
 attributeID True string

(Quite el "10" inicial. Para devolver un valor único, escriba el identificador de atributo primario o busque entradas secundarias, escriba el identificador de atributo secundario).
Key
 parentID True string

(Para devolver un valor único, escriba la clave del atributo único o para buscar entradas secundarias, escriba la clave del elemento primario).
Filtro (solo al buscar)
 $filter string

(Consulte la documentación de los filtros disponibles).
Campos que se van a recuperar
 $select string

(Incluya una lista separada por comas de: 'key', 'description', 'parent', 'hold', 'closed', 'defaulting', 'type', 'user', and/or 'access')
Número de registros coincidentes que se van a omitir
 $skip integer

(Esto se usa al recuperar varios bloques de resultados).
Número máximo de registros que se van a devolver
 $top integer

Número máximo de registros que se van a devolver
Ordenar los resultados por
 $orderby string

Ordenar los resultados por

Obtener una entrada de tabla de búsqueda secundaria

Id. de la operación:
GetChildEntry

Obtener una entrada de tabla de búsqueda secundaria

Parámetros

Nombre Clave Requerido Tipo Description
ID del repositorio
 repositoryID True string

(Comienza con CA-)
Identificador de atributo secundario
 childAttributeID True string

(Quite el "10" inicial)
Clave principal
 parentID True string

Clave principal
Clave secundaria
 childID True string

Clave secundaria

Seguir carpeta

Id. de la operación:
FollowFolder

Recibir alertas cuando se agrega contenido nuevo a una carpeta

Parámetros

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

Identificador de carpeta de 12 dígitos.
Recipientes
 recipients True string

Una o varias direcciones de correo electrónico válidas separadas por punto y coma. Se omiten los duplicados.
Send
 send string

Qué categoría de usuarios debe recibir la alerta.

Seguir documento

Id. de la operación:
FollowDocument

Recibir alertas cuando se actualiza el documento

Parámetros

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

Id. de documento de 12 dígitos.
Recipientes
 recipients True string

Una o varias direcciones de correo electrónico válidas separadas por punto y coma. Se omiten los duplicados.
Send
 send string

Qué categoría de usuarios debe recibir la alerta.

Desencadenadores

Gabinete de búsqueda

Buscar en el gabinete especificado

Gabinete de búsqueda

Id. de la operación:
SearchCab

Buscar en el gabinete especificado

Parámetros

Nombre Clave Requerido Tipo Description
Id. de gabinete
 cabId True string

(Comienza con NG-)
Criterios de búsqueda
 q True string

Use el mismo formato y operadores que en la interfaz web de NetDocuments.
Ordenar por
 $orderby string

Ordenar por
Número máximo de resultados
 $top string

Entero entre 1 y 500. El valor predeterminado es 100.
Atributos que se van a devolver
 $select string

Lista separada por comas de valores de atributo. Consulte la documentación de la API REST para obtener más detalles.