Compartir a través de

DocuWare

Acceda a las características comunes de DocuWare desde los flujos.

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 DocuWare GmbH
URL https://support.docuware.com
Correo Electrónico support@docuware.com
Metadatos del conector
Publicador DocuWare
Sitio web https://start.docuware.com
Directiva de privacidad https://start.docuware.com/data-privacy
Categorías Contenido y archivos; Productividad

DocuWare proporciona una API REST eficaz y extensa. Con el conector de Power Automate de DocuWare, los usuarios ahora pueden aprovechar muchas de las características más comunes de la API rest de DocuWare en Power Automate. Esto permite al usuario una mayor flexibilidad para crear flujos que aborden completamente sus necesidades empresariales, gracias a la integración perfecta con DocuWare.

Prerrequisitos

Necesitará lo siguiente para continuar:

  • Una suscripción a DocuWare Cloud
  • Una cuenta de Microsoft Power Apps o Power Automate

Obtención de credenciales

La creación de una nueva clave de API es fácil y se puede realizar desde DocuWare.

Siga estos pasos para crear una nueva clave de API en DocuWare:

  1. Inicie sesión en la cuenta de DocuWare que desea usar con Power Automate.
  2. En el menú principal, vaya a "Configuraciones"
  3. En la página "Configuraciones", vaya a la sección "Integraciones" y haga clic en el icono de "Claves de API de Power Automate".
    • Si no ve el icono "Claves de API de Power Automate", es posible que el usuario no tenga los permisos correctos. Póngase en contacto con el administrador de DocuWare para resolverlo.
  4. Haga clic en el botón "Crear clave de API".
  5. Rellene los valores "Name" y "Description" (opcional) y haga clic en "Crear".
    • Después de presionar "Crear", puede haber un ligero retraso a medida que el proceso de configuración crea la clave.
    • Además, asegúrese de guardar la clave de API. Esta será la única oportunidad de ver la clave de API completa. Si pierde esta clave, deberá crear otra.

En este momento, ahora tiene una clave de API válida que se puede usar en Power Automate para crear una conexión a DocuWare. Después, esta conexión se puede usar con el conector de DocuWare Power Automate.

Introducción al conector

La creación de una conexión en Power Automate es fácil y se puede realizar al crear los flujos.

Siga estos pasos para crear una nueva conexión en Power Automate:

  1. Inicio de sesión en Power Automate
  2. Creación de un nuevo flujo o apertura de un flujo existente
  3. Incorporación de una actividad desde el conector de DocuWare Power Automate al flujo
    • Haga clic en "+ Nuevo paso" para agregar un nuevo paso al flujo.
    • Cuando se presenta "Elegir una operación", seleccione "Todo" en la selección de categoría y escriba "DocuWare" en el campo de búsqueda.
    • Seleccione el conector "DocuWare" y, a continuación, elija en la lista de acciones disponibles.
  4. Cuando se agregue la acción al flujo, se le pedirá que cree una nueva conexión.
  5. Escriba un nombre de conexión ("Nombre de conexión") y la clave de API ("Clave de API") que recibió de DocuWare en la sección anterior y haga clic en "Crear".

Desde este punto de adelante, todas las actividades que se agregan desde el conector docuWare usarán esta conexión. Para crear conexiones adicionales, haga clic en "..." en la esquina superior derecha de una actividad y, a continuación, haga clic en "+ Agregar nueva conexión" en la parte inferior del menú que aparece.

Problemas y limitaciones conocidos

En este momento, el conector de Power Automate de DocuWare no se admite en el nuevo diseñador de flujo de Power Automate.

Errores y soluciones comunes

Códigos de error HTTP:

  • 400: asegúrese de que ha rellenado todos los campos obligatorios de la actividad. Algunos campos son obligatorios y deben rellenarse antes de que se pueda ejecutar la actividad.
  • 401: Asegúrese de que ha escrito la clave de API correcta. También puede comprobar el estado de la clave de API en la página "Configuraciones", en "Integraciones" -> "Claves de API de Power Automate".
  • 404: Asegúrese de que el documento especificado y/o el archivador existen y que tiene acceso a ellos. Si el documento o el gabinete de archivos no existen o no tiene acceso a ellos, recibirá un error 404.
  • 500: se trata de un error genérico que puede deberse a una serie de problemas diferentes. Si recibe este error, póngase en contacto con el soporte técnico de DocuWare para obtener ayuda.

Preguntas más frecuentes

Procedimientos recomendados

A continuación se muestran algunos de los procedimientos recomendados que se recomiendan al usar el conector de Power Automate de DocuWare:

  • Use siempre un usuario dedicado de DocuWare para autenticarse con el conector de DocuWare Power Automate. Esto le permitirá realizar un seguimiento y administrar fácilmente las acciones que realiza el conector.
  • Empiece por probar el flujo con la actividad "Obtener organización". Esta es la acción más básica proporcionada en el conector de DocuWare Power Automate y le permitirá comprobar que la conexión funciona correctamente.

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
API key securestring La clave de API para acceder a DocuWare Cierto

Limitaciones

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

Acciones

Actualizar campos de índice

Actualiza los campos de índice de un documento.
Almacenar en el contenedor de archivos

Almacena un nuevo documento en un contenedor de archivos.
Anexar un archivo

Anexa un archivo o sección a un documento existente.
Buscar en el gabinete de archivos

Busque en un contenedor de archivos documentos que coincidan con los criterios especificados.
Colocar un sello

Coloca un sello en un documento.
Descarga de un archivo

Descarga un archivo o sección de un documento almacenado en un contenedor de archivos o bandeja de documentos.
Descargar un documento

Descarga un documento de un contenedor de archivos o una bandeja de documentos.
Eliminar un archivo

Elimina un archivo o sección de un documento existente.
Eliminar un documento

Elimina un documento de un contenedor de archivos o una bandeja de documentos.
Enumerar documentos en la bandeja de documentos

Enumera los documentos de la bandeja de documentos especificada.
Importar a la bandeja de documentos

Importe un nuevo documento en una bandeja de documentos.
Obtención de campos de marca

Obtiene una lista de campos de un sello.
Obtención de información del documento

Obtiene información sobre un documento.
Obtener armarios de archivos y bandejas de documentos

Obtiene una lista de armarios de archivos o bandejas de documentos.
Obtener campos de diálogo

Obtiene los campos de un cuadro de diálogo.
Obtener campos del archivador

Obtiene una lista de campos de un archivador.
Obtener diálogos

Obtiene una lista de diálogos para un contenedor de archivos o una bandeja de documentos.
Obtener organización

Obtenga el nombre de la organización.
Obtener sellos

Obtiene una lista de sellos para un contenedor de archivos o una bandeja de documentos.
Reemplazar un archivo

Reemplaza un archivo o sección en un documento existente.
Transferir documentos

Mueve uno o varios documentos de una bandeja de archivos o bandeja de documentos a otra.

Actualizar campos de índice

Id. de la operación:
UpdateIndexFields

Actualiza los campos de índice de un documento.

Parámetros

Nombre Clave Requerido Tipo Description
Archivador
 FileCabinetID True string

Seleccione el archivador de archivos con el documento que se va a actualizar.
Id. de documento
 DocumentID True integer

Especifique el identificador del documento que se va a actualizar.
Nombre
 Name string

Seleccione o especifique un campo de índice.
Importancia
 Value string

Especifique un valor de índice.

Devoluciones

Nombre Ruta de acceso Tipo Description
Secciones
 Sections array of object

Secciones
SignatureStatus
 Sections.SignatureStatus array of string

SignatureStatus
SectionId
 Sections.SectionId string

SectionId
ContentType
 Sections.ContentType string

ContentType
HaveMorePages
 Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Sections.PageCount integer

PageCount
Tamaño de archivo
 Sections.FileSize integer

Tamaño de archivo
OriginalFileName
 Sections.OriginalFileName string

OriginalFileName
ContentModified
 Sections.ContentModified string

ContentModified
HasTextAnnotation
 Sections.HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 Sections.AnnotationsPreview boolean

AnnotationsPreview
DocumentId
 DocumentId integer

DocumentId
IndexFields
 IndexFields object

IndexFields
DocumentTitle
 DocumentTitle string

DocumentTitle
FileCabinetId
 FileCabinetId string

FileCabinetId
TotalPages
 TotalPages integer

TotalPages
Tamaño de archivo
 FileSize integer

Tamaño de archivo
ContentType
 ContentType string

ContentType
VersionStatus
 VersionStatus string

VersionStatus
isCold
 DocumentFlags.isCold boolean

isCold
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 DocumentFlags.isProtected boolean

isProtected
isDeleted
 DocumentFlags.isDeleted boolean

isDeleted
isEmail
 DocumentFlags.isEmail boolean

isEmail

Almacenar en el contenedor de archivos

Id. de la operación:
StoreToFileCabinet

Almacena un nuevo documento en un contenedor de archivos.

Parámetros

Nombre Clave Requerido Tipo Description
Archivador
 FileCabinet True string

Seleccione el archivador en el que se va a almacenar.
Cuadro de diálogo Tienda
 StoreDialogId True string

Seleccione el cuadro de diálogo de la tienda que se va a usar para almacenar.
Datos de índice
 index string

Especifique los datos de índice del documento.
Contenido del archivo
 file file

Especifique el contenido del archivo que se va a almacenar.

Devoluciones

Nombre Ruta de acceso Tipo Description
Secciones
 Sections array of object

Secciones
SignatureStatus
 Sections.SignatureStatus array of string

SignatureStatus
SectionId
 Sections.SectionId string

SectionId
ContentType
 Sections.ContentType string

ContentType
HaveMorePages
 Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Sections.PageCount integer

PageCount
Tamaño de archivo
 Sections.FileSize integer

Tamaño de archivo
OriginalFileName
 Sections.OriginalFileName string

OriginalFileName
ContentModified
 Sections.ContentModified string

ContentModified
HasTextAnnotation
 Sections.HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 Sections.AnnotationsPreview boolean

AnnotationsPreview
DocumentId
 DocumentId integer

DocumentId
IndexFields
 IndexFields object

IndexFields
DocumentTitle
 DocumentTitle string

DocumentTitle
FileCabinetId
 FileCabinetId string

FileCabinetId
TotalPages
 TotalPages integer

TotalPages
Tamaño de archivo
 FileSize integer

Tamaño de archivo
ContentType
 ContentType string

ContentType
VersionStatus
 VersionStatus string

VersionStatus
isCold
 DocumentFlags.isCold boolean

isCold
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 DocumentFlags.isProtected boolean

isProtected
isDeleted
 DocumentFlags.isDeleted boolean

isDeleted
isEmail
 DocumentFlags.isEmail boolean

isEmail

Anexar un archivo

Id. de la operación:
AppendFile

Anexa un archivo o sección a un documento existente.

Parámetros

Nombre Clave Requerido Tipo Description
Archivador/Bandeja de documentos
 FileCabinet True string

Seleccione el gabinete de archivos o la bandeja de documentos con el documento.
Id. de documento
 DocID True string

Especifique el identificador del documento al que se va a anexar.
Contenido del archivo
 file file

Especifique el contenido del archivo que se va a almacenar.

Devoluciones

Nombre Ruta de acceso Tipo Description
SignatureStatus
 SignatureStatus array of string

SignatureStatus
SectionId
 SectionId string

SectionId
ContentType
 ContentType string

ContentType
HaveMorePages
 HaveMorePages boolean

HaveMorePages
PageCount
 PageCount integer

PageCount
Tamaño de archivo
 FileSize integer

Tamaño de archivo
OriginalFileName
 OriginalFileName string

OriginalFileName
ContentModified
 ContentModified string

ContentModified
HasTextAnnotation
 HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 AnnotationsPreview boolean

AnnotationsPreview

Buscar en el gabinete de archivos

Id. de la operación:
SearchForDocumentsInFileCabinet

Busque en un contenedor de archivos documentos que coincidan con los criterios especificados.

Parámetros

Nombre Clave Requerido Tipo Description
Archivador
 FileCabinet True string

Seleccione el gabinete de archivos que se va a buscar.
Cuadro de diálogo buscar
 SearchDialogId True string

Seleccione el cuadro de diálogo de búsqueda que se va a usar para buscar.
Consulta de búsqueda
 SearchQuery True

Devoluciones

Nombre Ruta de acceso Tipo Description
Contar
 Count integer

Contar
Documentos
 Documents array of object

Documentos
Secciones
 Documents.Sections array of

Secciones
DocumentId
 Documents.DocumentId integer

DocumentId
IndexFields
 Documents.IndexFields object

IndexFields
DocumentTitle
 Documents.DocumentTitle string

DocumentTitle
FileCabinetId
 Documents.FileCabinetId string

FileCabinetId
TotalPages
 Documents.TotalPages integer

TotalPages
Tamaño de archivo
 Documents.FileSize integer

Tamaño de archivo
ContentType
 Documents.ContentType string

ContentType
VersionStatus
 Documents.VersionStatus string

VersionStatus
isCold
 Documents.DocumentFlags.isCold boolean

isCold
isDBRecord
 Documents.DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 Documents.DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 Documents.DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 Documents.DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 Documents.DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 Documents.DocumentFlags.isProtected boolean

isProtected
isDeleted
 Documents.DocumentFlags.isDeleted boolean

isDeleted
isEmail
 Documents.DocumentFlags.isEmail boolean

isEmail

Colocar un sello

Id. de la operación:
PlaceAStamp

Coloca un sello en un documento.

Parámetros

Nombre Clave Requerido Tipo Description
Archivador/Bandeja de documentos
 FileCabinetID True string

Seleccione el gabinete de archivos o la bandeja de documentos con el documento.
Id. de documento
 DocumentID True integer

Especifique el identificador del documento que desea marcar.
Número de archivo
 FileNumber True integer

Especifique el archivo o la sección que contiene la página que se va a marcar.
Número de página
 PageNumber True integer

Especifique el número de página en el que se va a colocar la marca.
Nivel
 Layer True integer

Especifique la capa de documento para colocar la marca en [1-5]
Posición horizontal (posición X)
 PositionX number

[Opcional] Posición desde el borde izquierdo de la página en mm.
Posición vertical (posición Y)
 PositionY number

[Opcional] Posición desde el borde superior de la página en mm.
Sello
 StampId True string

Seleccione o especifique el sello que se va a usar.
Contraseña
 Password string

Especifique la contraseña del sello (si es necesario).
Nombre
 Name string

Especifique un nombre de campo.
Importancia
 Value string

Especifique un valor de campo.

Devoluciones

Nombre Ruta de acceso Tipo Description
Usuario
 Created.User string

Usuario
Time
 Created.Time string

Time
Tipo
 Type string

Tipo
Color
 Color string

Color
Rotation
 Rotation integer

Rotation
Transparent
 Transparent boolean

Transparent
StrokeWidth
 StrokeWidth integer

StrokeWidth
GUID
 Guid string

GUID

Descarga de un archivo

Id. de la operación:
DownloadFile

Descarga un archivo o sección de un documento almacenado en un contenedor de archivos o bandeja de documentos.

Parámetros

Nombre Clave Requerido Tipo Description
Archivador/Bandeja de documentos
 FileCabinetID True string

Seleccione el gabinete de archivos o la bandeja de documentos con el documento.
Id. de documento
 DocumentId True integer

Especifique el identificador del documento con el archivo que desea descargar.
Número de archivo
 FileNumber True string

Especifique el número de archivo del archivo que desea descargar.
Formato de documento
 DocumentFormat True string

Seleccione el formato del documento descargado.

Devoluciones

Body

Body
binary

Descargar un documento

Id. de la operación:
DownloadDocument

Descarga un documento de un contenedor de archivos o una bandeja de documentos.

Parámetros

Nombre Clave Requerido Tipo Description
Archivador/Bandeja de documentos
 FileCabinetID True string

Seleccione el gabinete de archivos o la bandeja de documentos con el documento.
Id. de documento
 DocumentId True integer

Especifique el identificador del documento que desea descargar.
Formato de documento
 DocumentFormat True string

Seleccione el formato del documento descargado.

Devoluciones

Body

Body
binary

Eliminar un archivo

Id. de la operación:
DeleteFile

Elimina un archivo o sección de un documento existente.

Parámetros

Nombre Clave Requerido Tipo Description
Archivador/Bandeja de documentos
 FileCabinet True string

Seleccione el gabinete de archivos o la bandeja de documentos con el documento.
Id. de documento
 DocumentID True integer

Especifique el identificador del documento del que se va a eliminar.
Número de archivo
 FileNumber True integer

Especifique el número de archivo que se va a eliminar.

Eliminar un documento

Id. de la operación:
DeleteDocument

Elimina un documento de un contenedor de archivos o una bandeja de documentos.

Parámetros

Nombre Clave Requerido Tipo Description
Archivador/Bandeja de documentos
 FileCabinetID True string

Seleccione el gabinete de archivos o la bandeja de documentos con el documento.
Id. de documento
 DocumentID True integer

Especifique el identificador del documento que desea eliminar.

Enumerar documentos en la bandeja de documentos

Id. de la operación:
ListDocumentsInDocumentTray

Enumera los documentos de la bandeja de documentos especificada.

Parámetros

Nombre Clave Requerido Tipo Description
Bandeja de documentos
 DocumentTray True string

Seleccione la Bandeja de documentos para buscar.

Devoluciones

Nombre Ruta de acceso Tipo Description
Contar
 Count integer

Contar
Documentos
 Documents array of object
Secciones
 Documents.Sections array of

Secciones
DocumentId
 Documents.DocumentId integer

DocumentId
IndexFields
 Documents.IndexFields object

IndexFields
DocumentTitle
 Documents.DocumentTitle string

DocumentTitle
FileCabinetId
 Documents.FileCabinetId string

FileCabinetId
TotalPages
 Documents.TotalPages integer

TotalPages
Tamaño de archivo
 Documents.FileSize integer

Tamaño de archivo
ContentType
 Documents.ContentType string

ContentType
VersionStatus
 Documents.VersionStatus string

VersionStatus
isCold
 Documents.DocumentFlags.isCold boolean

isCold
isDBRecord
 Documents.DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 Documents.DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 Documents.DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 Documents.DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 Documents.DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 Documents.DocumentFlags.isProtected boolean

isProtected
isDeleted
 Documents.DocumentFlags.isDeleted boolean

isDeleted
isEmail
 Documents.DocumentFlags.isEmail boolean

isEmail

Importar a la bandeja de documentos

Id. de la operación:
ImportToDocumentTray

Importe un nuevo documento en una bandeja de documentos.

Parámetros

Nombre Clave Requerido Tipo Description
Bandeja de documentos
 DocumentTray True string

Seleccione la bandeja de documentos a la que importar.
Cuadro de diálogo Tienda
 StoreDialogId string

Seleccione el cuadro de diálogo de almacén que se usará durante la importación.
Datos de índice
 index string

Especifique los datos de índice del documento.
Contenido del archivo
 file file

Especifique el contenido del archivo que se va a importar.

Devoluciones

Nombre Ruta de acceso Tipo Description
Secciones
 Sections array of object

Secciones
SignatureStatus
 Sections.SignatureStatus array of string

SignatureStatus
SectionId
 Sections.SectionId string

SectionId
ContentType
 Sections.ContentType string

ContentType
HaveMorePages
 Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Sections.PageCount integer

PageCount
Tamaño de archivo
 Sections.FileSize integer

Tamaño de archivo
OriginalFileName
 Sections.OriginalFileName string

OriginalFileName
ContentModified
 Sections.ContentModified string

ContentModified
HasTextAnnotation
 Sections.HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 Sections.AnnotationsPreview boolean

AnnotationsPreview
DocumentId
 DocumentId integer

DocumentId
IndexFields
 IndexFields object

IndexFields
DocumentTitle
 DocumentTitle string

DocumentTitle
FileCabinetId
 FileCabinetId string

FileCabinetId
TotalPages
 TotalPages integer

TotalPages
Tamaño de archivo
 FileSize integer

Tamaño de archivo
ContentType
 ContentType string

ContentType
VersionStatus
 VersionStatus string

VersionStatus
isCold
 DocumentFlags.isCold boolean

isCold
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 DocumentFlags.isProtected boolean

isProtected
isDeleted
 DocumentFlags.isDeleted boolean

isDeleted
isEmail
 DocumentFlags.isEmail boolean

isEmail

Obtención de campos de marca

Id. de la operación:
GetStampFields

Obtiene una lista de campos de un sello.

Parámetros

Nombre Clave Requerido Tipo Description
Archivador/Bandeja de documentos
 FileCabinet True string

Seleccione el gabinete de archivos o la bandeja de documentos con la marca deseada.
Sello
 Stamp True string

Seleccione la marca para obtener sus campos.

Devoluciones

Nombre Ruta de acceso Tipo Description
Fields
 Fields array of object

Fields
Id
 Fields.Id string

Id
Etiqueta
 Fields.Label string

Etiqueta
DisplayName (Nombre para mostrar)
 Fields.DisplayName string

DisplayName (Nombre para mostrar)

Obtención de información del documento

Id. de la operación:
GetDocumentInformation

Obtiene información sobre un documento.

Parámetros

Nombre Clave Requerido Tipo Description
Archivador/Bandeja de documentos
 FileCabinetID True string

Seleccione el gabinete de archivos o la bandeja de documentos con el documento.
Id. de documento
 DocumentID True integer

Especifique el identificador del documento en el que desea obtener información.

Devoluciones

Nombre Ruta de acceso Tipo Description
Secciones
 Sections array of object

Secciones
SignatureStatus
 Sections.SignatureStatus array of string

SignatureStatus
SectionId
 Sections.SectionId string

SectionId
ContentType
 Sections.ContentType string

ContentType
HaveMorePages
 Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Sections.PageCount integer

PageCount
Tamaño de archivo
 Sections.FileSize integer

Tamaño de archivo
OriginalFileName
 Sections.OriginalFileName string

OriginalFileName
ContentModified
 Sections.ContentModified string

ContentModified
HasTextAnnotation
 Sections.HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 Sections.AnnotationsPreview boolean

AnnotationsPreview
DocumentId
 DocumentId integer

DocumentId
IndexFields
 IndexFields object

IndexFields
DocumentTitle
 DocumentTitle string

DocumentTitle
FileCabinetId
 FileCabinetId string

FileCabinetId
TotalPages
 TotalPages integer

TotalPages
Tamaño de archivo
 FileSize integer

Tamaño de archivo
ContentType
 ContentType string

ContentType
VersionStatus
 VersionStatus string

VersionStatus
isCold
 DocumentFlags.isCold boolean

isCold
isDBRecord
 DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 DocumentFlags.isProtected boolean

isProtected
isDeleted
 DocumentFlags.isDeleted boolean

isDeleted
isEmail
 DocumentFlags.isEmail boolean

isEmail

Obtener armarios de archivos y bandejas de documentos

Id. de la operación:
GetFileCabinets

Obtiene una lista de armarios de archivos o bandejas de documentos.

Parámetros

Nombre Clave Requerido Tipo Description
Tipo de gabinete de archivos
 FileCabinetType True string

Seleccione los tipos que desea que se devuelvan.

Devoluciones

Nombre Ruta de acceso Tipo Description
FileCabinets
 FileCabinets array of object

FileCabinets
Nombre
 FileCabinets.Name string

Nombre
GUID
 FileCabinets.Guid string

GUID
Color
 FileCabinets.Color string

Color
IsTray
 FileCabinets.IsTray boolean

IsTray
Id. de la operación:
GetDialogFields

Obtiene los campos de un cuadro de diálogo.

Parámetros

Nombre Clave Requerido Tipo Description
Archivador
 FileCabinet True string

Seleccione el gabinete de archivos.
Dialog
 DialogId True string

Seleccione el cuadro de diálogo para el que obtener los campos.

Devoluciones

Nombre Ruta de acceso Tipo Description
Fields
 Fields array of object

Fields
DBFieldName
 Fields.DBFieldName string

DBFieldName
DWFieldType
 Fields.DWFieldType string

DWFieldType
DisplayName (Nombre para mostrar)
 Fields.DisplayName string

DisplayName (Nombre para mostrar)
ReadOnly
 Fields.ReadOnly boolean

ReadOnly
Visible
 Fields.Visible boolean

Visible

Obtener campos del archivador

Id. de la operación:
GetFileCabinetFields

Obtiene una lista de campos de un archivador.

Parámetros

Nombre Clave Requerido Tipo Description
Archivador
 FileCabinet True string

Seleccione el archivador de archivos para el que obtener los campos.
Tipo de campo
 FieldType string

Seleccione el tipo de campos que se van a devolver.

Devoluciones

Nombre Ruta de acceso Tipo Description
Fields
 Fields array of object

Fields
TableFieldColumns
 Fields.TableFieldColumns array of object

TableFieldColumns
DBFieldName
 Fields.TableFieldColumns.DBFieldName string

DBFieldName
DWFieldType
 Fields.TableFieldColumns.DWFieldType string

DWFieldType
DisplayName (Nombre para mostrar)
 Fields.TableFieldColumns.DisplayName string

DisplayName (Nombre para mostrar)
DropLeadingBlanks
 Fields.TableFieldColumns.DropLeadingBlanks boolean

DropLeadingBlanks
DropLeadingZero
 Fields.TableFieldColumns.DropLeadingZero boolean

DropLeadingZero
FieldInfoText
 Fields.TableFieldColumns.FieldInfoText string

FieldInfoText
FixedEntry
 Fields.TableFieldColumns.FixedEntry string

FixedEntry
Length
 Fields.TableFieldColumns.Length integer

Length
NotEmpty
 Fields.TableFieldColumns.NotEmpty boolean

NotEmpty
Precisión
 Fields.TableFieldColumns.Precision integer

Precisión
Ámbito
 Fields.TableFieldColumns.Scope string

Ámbito
UsedAsDocumentName
 Fields.UsedAsDocumentName boolean

UsedAsDocumentName
DBFieldName
 Fields.DBFieldName string

DBFieldName
DWFieldType
 Fields.DWFieldType string

DWFieldType
DisplayName (Nombre para mostrar)
 Fields.DisplayName string

DisplayName (Nombre para mostrar)
DropLeadingBlanks
 Fields.DropLeadingBlanks boolean

DropLeadingBlanks
DropLeadingZero
 Fields.DropLeadingZero boolean

DropLeadingZero
FieldInfoText
 Fields.FieldInfoText string

FieldInfoText
FixedEntry
 Fields.FixedEntry string

FixedEntry
Length
 Fields.Length integer

Length
NotEmpty
 Fields.NotEmpty boolean

NotEmpty
Precisión
 Fields.Precision integer

Precisión
Ámbito
 Fields.Scope string

Ámbito

Obtener diálogos

Id. de la operación:
GetDialogs

Obtiene una lista de diálogos para un contenedor de archivos o una bandeja de documentos.

Parámetros

Nombre Clave Requerido Tipo Description
Archivador/Bandeja de documentos
 FileCabinet True string

Seleccione el armario de archivos o la bandeja de documentos para obtener diálogos.
Tipo de diálogo
 DialogType string

Seleccione el tipo de diálogos que se va a devolver.

Devoluciones

Nombre Ruta de acceso Tipo Description
Dialogs
 Dialogs array of object

Dialogs
Nombre
 Dialogs.Name string

Nombre
GUID
 Dialogs.Guid string

GUID
Color
 Dialogs.Color string

Color
IsDefault
 Dialogs.IsDefault boolean

IsDefault
Tipo
 Dialogs.Type string

Tipo
FileCabinetId
 Dialogs.FileCabinetId string

FileCabinetId

Obtener organización

Id. de la operación:
GetOrganization

Obtenga el nombre de la organización.

Devoluciones

Nombre Ruta de acceso Tipo Description
Nombre
 Name string

Nombre

Obtener sellos

Id. de la operación:
GetStamps

Obtiene una lista de sellos para un contenedor de archivos o una bandeja de documentos.

Parámetros

Nombre Clave Requerido Tipo Description
Archivador/Bandeja de documentos
 FileCabinet True string

Seleccione el gabinete de archivos o la bandeja de documentos para obtener sellos.

Devoluciones

Nombre Ruta de acceso Tipo Description
Álbum
 Stamps array of object

Álbum
Id
 Stamps.Id string

Id
Nombre
 Stamps.Name string

Nombre
DisplayName (Nombre para mostrar)
 Stamps.DisplayName string

DisplayName (Nombre para mostrar)
Color
 Stamps.Color string

Color
Signature
 Stamps.Signature string

Signature
PasswordProtected
 Stamps.PasswordProtected boolean

PasswordProtected
Sobrescribir
 Stamps.Overwrite boolean

Sobrescribir
Tipo
 Stamps.Type string

Tipo
FileCabinetId
 Stamps.FileCabinetId string

FileCabinetId

Reemplazar un archivo

Id. de la operación:
ReplaceFile

Reemplaza un archivo o sección en un documento existente.

Parámetros

Nombre Clave Requerido Tipo Description
Archivador/Bandeja de documentos
 FileCabinet True string

Seleccione el gabinete de archivos o la bandeja de documentos con el documento.
Id. de documento
 DocumentID True integer

Especifique el identificador del documento con el archivo que se va a reemplazar.
Número de archivo
 FileNumber True integer

Especifique el número de archivo que se va a reemplazar.
Contenido del archivo
 file file

Especifique el contenido del archivo que se va a almacenar.

Devoluciones

Nombre Ruta de acceso Tipo Description
SignatureStatus
 SignatureStatus array of string

SignatureStatus
SectionId
 SectionId string

SectionId
ContentType
 ContentType string

ContentType
HaveMorePages
 HaveMorePages boolean

HaveMorePages
PageCount
 PageCount integer

PageCount
Tamaño de archivo
 FileSize integer

Tamaño de archivo
OriginalFileName
 OriginalFileName string

OriginalFileName
ContentModified
 ContentModified string

ContentModified
HasTextAnnotation
 HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 AnnotationsPreview boolean

AnnotationsPreview

Transferir documentos

Id. de la operación:
TransferDocument

Mueve uno o varios documentos de una bandeja de archivos o bandeja de documentos a otra.

Parámetros

Nombre Clave Requerido Tipo Description
Bandeja de documentos o gabinete de archivos de destino
 DestinationFileCabinetID True string

Seleccione el gabinete de archivos de destino o la bandeja de documentos.
Cuadro de diálogo Tienda
 StoreDialogID string

Seleccione el cuadro de diálogo almacén para indexar los documentos que se van a mover.
Bandeja de documentos o gabinete de archivos de origen
 SourceFileCabinetId True string

Seleccione el gabinete de archivos de origen o la bandeja de documentos.
identificación
 DocumentId integer

Especifique un identificador de documento.
Nombre
 Name string

Seleccione o especifique un nombre de campo.
Importancia
 Value string

Especifique un valor de campo.
Mantener el origen
 KeepSource boolean

Elija si los documentos de origen deben eliminarse o no.
Rellenar Intellix
 FillIntellix boolean

Elija si se debe usar la indexación inteligente al almacenar.

Devoluciones

Nombre Ruta de acceso Tipo Description
Contar
 Count integer

Contar
Documentos
 Documents array of object

Documentos
Secciones
 Documents.Sections array of object

Secciones
SignatureStatus
 Documents.Sections.SignatureStatus array of string

SignatureStatus
SectionId
 Documents.Sections.SectionId string

SectionId
ContentType
 Documents.Sections.ContentType string

ContentType
HaveMorePages
 Documents.Sections.HaveMorePages boolean

HaveMorePages
PageCount
 Documents.Sections.PageCount integer

PageCount
Tamaño de archivo
 Documents.Sections.FileSize integer

Tamaño de archivo
OriginalFileName
 Documents.Sections.OriginalFileName string

OriginalFileName
ContentModified
 Documents.Sections.ContentModified string

ContentModified
HasTextAnnotation
 Documents.Sections.HasTextAnnotation boolean

HasTextAnnotation
AnnotationsPreview
 Documents.Sections.AnnotationsPreview boolean

AnnotationsPreview
DocumentId
 Documents.DocumentId integer

DocumentId
IndexFields
 Documents.IndexFields object

IndexFields
DocumentTitle
 Documents.DocumentTitle string

DocumentTitle
FileCabinetId
 Documents.FileCabinetId string

FileCabinetId
TotalPages
 Documents.TotalPages integer

TotalPages
Tamaño de archivo
 Documents.FileSize integer

Tamaño de archivo
ContentType
 Documents.ContentType string

ContentType
VersionStatus
 Documents.VersionStatus string

VersionStatus
isCold
 Documents.DocumentFlags.isCold boolean

isCold
isDBRecord
 Documents.DocumentFlags.isDBRecord boolean

isDBRecord
isCheckedOut
 Documents.DocumentFlags.isCheckedOut boolean

isCheckedOut
isCopyRightProtected
 Documents.DocumentFlags.isCopyRightProtected boolean

isCopyRightProtected
isVoiceAvailable
 Documents.DocumentFlags.isVoiceAvailable boolean

isVoiceAvailable
hasAppendedDocuments
 Documents.DocumentFlags.hasAppendedDocuments boolean

hasAppendedDocuments
isProtected
 Documents.DocumentFlags.isProtected boolean

isProtected
isDeleted
 Documents.DocumentFlags.isDeleted boolean

isDeleted
isEmail
 Documents.DocumentFlags.isEmail boolean

isEmail

Definiciones

binary

Este es el tipo de datos básico "binary".