Redque (versión preliminar)
Acceso y administración del sistema Redque.
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 | Redque s.r.o. |
| URL | https://redque.com |
| Correo Electrónico | info@redque.com |
| Metadatos del conector | |
|---|---|
| Publicador | Redque s.r.o. |
| Sitio web | https://redque.cz/en/ |
| Directiva de privacidad | https://redque.cz/policy.html |
| Categorías | IA; Finanzas |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualizar datos de carpeta |
Actualiza los datos de la carpeta. |
| Actualizar documento |
Actualiza el documento. |
| Actualizar enumeración específica |
Actualiza una enumeración específica. |
| Actualizar la devolución a la configuración del remitente |
Las actualizaciones vuelven a la configuración del remitente. |
| Actualizar usuario |
Actualiza parcialmente un usuario especificado. |
| Agregar permisos |
Agrega permisos al usuario. |
| Bloquear documento |
Documento de bloqueos (abiertos) que impide que otros usuarios lo modifiquen. |
| Buscar carpeta |
Busca la carpeta por identificador. |
| Buscar usuario |
Busca un usuario. |
| Cambiar contraseña |
Cambia la contraseña del usuario. |
| Cambio de la contraseña del usuario |
Cambia la contraseña del usuario especificado. Requiere permiso de administración de usuarios. |
| Cargar un documento y programarlo para su procesamiento |
Carga el documento y lo programa para su procesamiento. |
| Concesión de acceso de documentos al usuario especificado |
Concede acceso al documento al usuario especificado. |
| Creación de un usuario |
Crea un nuevo usuario. |
| Creación de una nueva enumeración |
Tenga en cuenta que la clave de enumeración se genera automáticamente y las claves de valor solo deben contener letras minúsculas, letras mayúsculas, números, subrayado, guiones |
| Crear carpeta |
Crea una nueva carpeta. |
| Desbloquear documento bloqueado |
Desbloquea el documento bloqueado (cerrado) para permitir que otros usuarios modifiquen su contenido. |
| Descargar carpeta |
Descarga todos los documentos de una carpeta como un único archivo. |
| Descargar el archivo del documento |
Descarga el archivo del documento. |
| Devolver documento al emisor para correcciones |
Devuelve el documento al emisor para las correcciones a la dirección de correo electrónico proporcionada. |
| Devolver todas las enumeraciones |
Devuelve la lista de todas las enumeraciones. |
| Elimina la enumeración con un identificador específico. |
Elimina una enumeración específica. |
| Eliminación de usuario |
Elimina un usuario. |
| Enumeración de devolución |
Devuelve una enumeración específica. |
| Extracción del documento |
Solicita la extracción de un documento. Una vez recuperado el documento, está programado para su eliminación. |
| Filtrar documentos |
Devuelve la lista de documentos basados en parámetros. |
| Filtrar usuarios |
Obtiene la lista de usuarios por criterios. |
| Generar token |
Genera un nuevo token de registro. |
| Imagen de una página determinada |
Devuelve una imagen para una página determinada. |
| Información de licencia |
Devuelve información de licencia. |
| Obtener documento extraído |
El documento extraído se marca para su eliminación y se eliminará en un plazo de varias horas a partir de la cual se accede. Esto proporciona a los usuarios tiempo para volver a intentar recuperar el resultado si se produce un error. |
| Obtener los metadatos del documento |
Obtiene los metadatos del documento. |
| Quita el token |
Quita el token de registro. |
| Quitar carpeta |
Quita la carpeta existente. |
| Quitar documento existente |
Quita el documento existente. |
| Quitar el acceso al documento para el usuario especificado |
Quita el acceso al documento para el usuario especificado. |
| Quitar permisos |
Revoca los permisos del usuario. |
| Token de devolución |
Devuelve el token de registro actual o nada si el token no está activo. |
| Volver a la configuración del remitente |
Recupere la configuración actual para volver a la acción del remitente. |
Actualizar datos de carpeta
Actualiza los datos de la carpeta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de carpeta
|
folderId | True | string |
Id. de carpeta |
|
folderId
|
folderId | string |
Id. de documento. |
|
|
ownerId
|
ownerId | string |
Identificador del propietario del contenedor |
|
|
creado
|
created | date-time |
Hora de creación del contenedor |
|
|
metadata
|
metadata | object |
Todos los encabezados adjuntos al contenedor |
Actualizar documento
Actualiza el documento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Id. de documento |
|
documentId
|
documentId | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
value
|
value | boolean | ||
|
value
|
value | boolean | ||
|
value
|
value | string | ||
|
value
|
value | string | ||
|
operation
|
operation | string | ||
|
key
|
key | string | ||
|
Mensaje
|
message | string | ||
|
isWarning
|
isWarning | boolean | ||
|
wordIds
|
wordIds | array of integer | ||
|
value
|
value | string | ||
|
operation
|
operation | string | ||
|
key
|
key | string | ||
|
Mensaje
|
message | string | ||
|
isWarning
|
isWarning | boolean | ||
|
wordIds
|
wordIds | array of integer | ||
|
userId
|
userId | string | ||
|
userId
|
userId | string | ||
|
estado
|
state | string |
Estado del documento |
|
|
value
|
value | string | ||
|
operation
|
operation | string | ||
|
value
|
value | string | ||
|
operation
|
operation | string |
Devoluciones
Datos de respuesta de estado. Se usa como respuesta cuando la solicitud no devuelve datos.
- Body
- RedQueStatus
Actualizar enumeración específica
Actualiza una enumeración específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de enumeración
|
id | True | string |
Identificador de enumeración |
|
id
|
id | string |
Identificador de enumeración |
|
|
nombre
|
name | string |
Nombre de enumeración descriptivo |
|
|
values
|
values | object |
Lista de valores de enumeración |
|
|
isEditable
|
isEditable | boolean |
Indica si se puede editar la enumeración. |
Actualizar la devolución a la configuración del remitente
Las actualizaciones vuelven a la configuración del remitente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
template
|
template | string | ||
|
Asunto
|
subject | string |
Actualizar usuario
Actualiza parcialmente un usuario especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Id. de usuario |
|
firstName
|
firstName | string |
Nombre del usuario |
|
|
lastName
|
lastName | string |
Apellidos del usuario |
Agregar permisos
Agrega permisos al usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Id del usuario |
|
permissions
|
permissions | array of string |
Acceder a datos |
Bloquear documento
Documento de bloqueos (abiertos) que impide que otros usuarios lo modifiquen.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Id. de documento |
Buscar carpeta
Busca la carpeta por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de carpeta
|
folderId | True | string |
Identificador de carpeta |
|
Con miembros
|
withMembers | boolean |
True si el documento con miembros |
Devoluciones
Metadatos de contenedor con metadatos de documentos dentro del contenedor
- Body
- ApiFolderWithMembers
Buscar usuario
Busca un usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Id del usuario |
Devoluciones
Información del usuario
- Body
- ApiUser
Cambiar contraseña
Cambia la contraseña del usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Id del usuario |
|
body
|
body | string |
Contraseña del usuario |
Cambio de la contraseña del usuario
Cambia la contraseña del usuario especificado. Requiere permiso de administración de usuarios.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Id del usuario |
|
contraseña
|
password | string |
Contraseña del usuario |
|
|
accountId
|
accountId | string |
Identificador de cuenta del usuario |
|
|
activationkey
|
activationkey | string |
Clave de activación del usuario |
Cargar un documento y programarlo para su procesamiento
Carga el documento y lo programa para su procesamiento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivo
|
File | file |
Archivo |
|
|
Identificador externo del documento
|
DocumentId | string |
Id. de documento externo |
|
|
Id. de carpeta
|
FolderId | string |
Id. de carpeta |
|
|
Fecha
|
Date | date-time |
Fecha |
|
|
Pedido
|
Ordinal | integer |
Orden usado para mantener el orden de los documentos que se cargan en paralelo |
|
|
¿Se documenta un archivo adjunto?
|
IsAttachment | boolean |
True si el documento es un archivo adjunto |
|
|
Clase Document
|
DocumentClass | string |
Clase Document |
Devoluciones
Resultado de una carga de archivos
- Body
- ApiUploadResponse
Concesión de acceso de documentos al usuario especificado
Concede acceso al documento al usuario especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Id. de documento |
|
Id. de usuario
|
userId | True | string |
Id. de usuario |
|
documentId
|
documentId | string |
Id. de documento |
|
|
userId
|
userId | string |
Id. de usuario |
|
|
Mensaje
|
message | string |
Creación de un usuario
Crea un nuevo usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
firstName
|
firstName | string |
Nombre del usuario |
|
|
lastName
|
lastName | string |
Apellidos del usuario |
|
|
contraseña
|
password | string |
Contraseña de la cuenta |
|
|
Correo electrónico
|
string |
Correo electrónico (nombre de inicio de sesión) del usuario |
Creación de una nueva enumeración
Tenga en cuenta que la clave de enumeración se genera automáticamente y las claves de valor solo deben contener letras minúsculas, letras mayúsculas, números, subrayado, guiones
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | string |
Identificador de enumeración |
|
|
nombre
|
name | string |
Nombre de enumeración descriptivo |
|
|
values
|
values | object |
Lista de valores de enumeración |
|
|
isEditable
|
isEditable | boolean |
Indica si se puede editar la enumeración. |
Devoluciones
Valor de respuesta genérico
- Body
- StringApiValue
Crear carpeta
Crea una nueva carpeta.
Devoluciones
Resultado de la creación de contenedores
Desbloquear documento bloqueado
Desbloquea el documento bloqueado (cerrado) para permitir que otros usuarios modifiquen su contenido.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Id. de documento |
Descargar carpeta
Descarga todos los documentos de una carpeta como un único archivo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de carpeta
|
folderId | True | string |
Identificador de carpeta |
Descargar el archivo del documento
Descarga el archivo del documento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Identificador de documento |
Devolver documento al emisor para correcciones
Devuelve el documento al emisor para las correcciones a la dirección de correo electrónico proporcionada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Id. de documento |
|
additionalDocuments
|
additionalDocuments | array of string | ||
|
recipientEmail
|
recipientEmail | string | ||
|
razón
|
reason | string | ||
|
requestedByUserId
|
requestedByUserId | string |
Devolver todas las enumeraciones
Elimina la enumeración con un identificador específico.
Elimina una enumeración específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Clave de enumeración
|
id | True | string |
Identificador o clave de enumeración |
Eliminación de usuario
Elimina un usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
ID de usuario |
Enumeración de devolución
Devuelve una enumeración específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de enumeración
|
id | True | string |
Identificador de enumeración |
Devoluciones
Enumeración de datos para enumeración de tipo de campo
- Body
- ApiEnum
Extracción del documento
Solicita la extracción de un documento. Una vez recuperado el documento, está programado para su eliminación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
externalDocumentId | string |
Id. de documento (opcional: el identificador de documento externo) |
|
|
Archivo
|
file | file |
Archivo |
Filtrar documentos
Devuelve la lista de documentos basados en parámetros.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
texto
|
text | string |
Texto de búsqueda usado para búsquedas generales |
|
|
value
|
value | string | ||
|
values
|
values | string |
Estado del documento |
|
|
values
|
values | string |
Estado del documento |
|
|
value
|
value | string | ||
|
value
|
value | boolean | ||
|
values
|
values | string | ||
|
values
|
values | array of string | ||
|
desde
|
from | date-time | ||
|
to
|
to | date-time | ||
|
fields
|
fields | object |
Filtros de campo |
|
|
skip
|
skip | integer |
Cuántos elementos se van a omitir desde el principio de la lista. Permite la paginación. |
|
|
tomar
|
take | integer |
Número máximo de elementos de lista que se devolverán |
|
|
campo
|
field | string |
Lista de propiedades en las que se pueden ordenar los resultados |
|
|
direction
|
direction | string |
Dirección en la que se ordenan los valores de lista |
|
|
ámbitos
|
scopes | string |
Ámbito de documento que filtra qué partes del documento se deben devolver |
Devoluciones
Resultado de la búsqueda
Filtrar usuarios
Obtiene la lista de usuarios por criterios.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
texto
|
text | string |
Texto de búsqueda usado para búsquedas generales |
|
|
value
|
value | string | ||
|
skip
|
skip | integer |
Cuántos elementos se van a omitir desde el principio de la lista. Permite la paginación. |
|
|
tomar
|
take | integer |
Número máximo de elementos de lista que se devolverán |
|
|
campo
|
field | string |
Enumeración para declarar los parámetros de ordenación del usuario |
|
|
direction
|
direction | string |
Dirección en la que se ordenan los valores de lista |
Devoluciones
Resultado de la búsqueda
- Body
- ApiUserApiListResult
Generar token
Imagen de una página determinada
Devuelve una imagen para una página determinada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Id. de documento |
|
Índice de página
|
pageIndex | True | integer |
Índice de página |
|
Preview
|
isPreview | boolean |
True si se debe devolver la imagen de tamaño reducido. |
Devoluciones
- response
- uri
Información de licencia
Obtener documento extraído
El documento extraído se marca para su eliminación y se eliminará en un plazo de varias horas a partir de la cual se accede. Esto proporciona a los usuarios tiempo para volver a intentar recuperar el resultado si se produce un error.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
id | True | string |
Id. de documento (proporcionado por RedQue o externo) |
Obtener los metadatos del documento
Obtiene los metadatos del documento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
id. de documento |
|
¿Es el identificador externo del identificador de documento?
|
isExternalId | boolean |
¿Es el identificador externo del identificador de documento? |
Devoluciones
- Body
- ApiDocument
Quita el token
Quita el token de registro.
Quitar carpeta
Quita la carpeta existente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de carpeta
|
folderId | True | string |
Identificador de carpeta |
Quitar documento existente
Quita el documento existente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
id. de documento |
Quitar el acceso al documento para el usuario especificado
Quita el acceso al documento para el usuario especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Identificador de documento |
|
Id. de usuario
|
userId | True | string |
Identificador de usuario |
Quitar permisos
Revoca los permisos del usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Id del usuario |
|
permissions
|
permissions | array of string |
Acceder a datos |
Token de devolución
Devuelve el token de registro actual o nada si el token no está activo.
Devoluciones
Valor de respuesta genérico
- Body
- StringApiValue
Volver a la configuración del remitente
Recupere la configuración actual para volver a la acción del remitente.
Definiciones
ApiApproval
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Aprobador
|
approver | ApiUser |
Información del usuario |
|
approvalStepTime
|
approvalStepTime | date-time |
Tiempo de asignación al aprobador actual. |
|
approvalState
|
approvalState | ApprovalState |
Estado del documento |
|
delegatedTo
|
delegatedTo | ApiUser |
Información del usuario |
|
nota
|
note | string |
Nota del aprobador |
ApiApprovalReminder
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
fromUser
|
fromUser | ApiUser |
Información del usuario |
|
toUser
|
toUser | ApiUser |
Información del usuario |
|
sentTime
|
sentTime | date-time |
Hora de envío |
|
nota
|
note | string |
Nota de urgencia |
ApiDocument
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
documentId
|
documentId | string |
Id. de documento |
|
externalDocumentId
|
externalDocumentId | string |
Id. de documento externo |
|
folderId
|
folderId | string |
Id. de contenedor de documentos |
|
contentHash
|
contentHash | string |
Hash del contenido |
|
pageCount
|
pageCount | integer |
Número total de páginas del documento, el primer índice es 1. Es posible que este número no sea igual al número de páginas, porque si el documento tiene demasiadas páginas, es posible que algunos de ellos se omitan debido a motivos de rendimiento. |
|
fileName
|
fileName | string |
Nombre de archivo del documento |
|
owner
|
owner | ApiUser |
Información del usuario |
|
estado
|
state | DocumentState |
Estado del documento |
|
error
|
error | string |
Código de error del documento |
|
isImagesGenerated
|
isImagesGenerated | boolean |
Se generaron imágenes |
|
isReturned
|
isReturned | boolean |
True si los documentos se devolvieron al remitente. |
|
returnReason
|
returnReason | string |
Motivo del retorno. |
|
creationTime
|
creationTime | date-time |
Fecha de creación |
|
size
|
size | integer |
Tamaño del documento en KB |
|
tipo de contenido
|
contentType | string |
Tipo de contenido |
|
source
|
source | DocumentSource | |
|
fuenteInfo
|
sourceInfo | string |
Detalles de origen (en dirección de correo electrónico general) |
|
extractionTime
|
extractionTime | date-time |
Fecha de clasificación |
|
model
|
model | string |
Tipo de este documento |
|
isAttachment
|
isAttachment | boolean |
Indica si el documento es un archivo adjunto. |
|
isValidated
|
isValidated | boolean |
Indicador si se ha validado el documento |
|
isEdited
|
isEdited | boolean |
Indicador, si se ha editado este documento (se ha cambiado al menos un campo, nota o etiqueta) |
|
nota
|
note | string |
Nota de usuario personalizada |
|
fields
|
fields | object |
Lista de campos extraídos |
|
items
|
items | array of object |
Lista de elementos extraídos |
|
items
|
items | object | |
|
pages
|
pages | array of ApiPage |
Lista de todas las páginas que forman parte de una extracción. |
|
pluginResults
|
pluginResults | array of ApiPluginResult |
Resultados generales |
|
isPostProcessCompleted
|
isPostProcessCompleted | boolean |
Indicador, si se ha completado el procesamiento posterior |
|
isPrevalidated
|
isPrevalidated | boolean |
Si un documento tiene o no algunos scripts pp de validación previa |
|
lastOpenTime
|
lastOpenTime | date-time |
Fecha de última apertura |
|
lastOpenUserId
|
lastOpenUserId | string |
Identificador del usuario que abrió este documento por última vez |
|
isLocked
|
isLocked | boolean |
Determina si el documento está bloqueado o no |
|
validationTime
|
validationTime | date-time |
Hora en que se ha validado el documento |
|
version
|
version | integer |
Número de versión, incrementado con cada actualización |
|
approvalState
|
approvalState | ApprovalState |
Estado del documento |
|
currentApproverId
|
currentApproverId | string |
Identificador de usuario que tiene que aprobar este documento |
|
lastApprovalStepTime
|
lastApprovalStepTime | date-time |
Tiempo de asignación al aprobador actual |
|
isCurrentApproverNotificationSent
|
isCurrentApproverNotificationSent | boolean |
La notificación se envió al aprobador actual |
|
approvalHistory
|
approvalHistory | array of ApiApproval |
Historial de aprobación |
|
approvalReminderHistory
|
approvalReminderHistory | array of ApiApprovalReminder |
Aprobar historial |
|
authorizedUserIds
|
authorizedUserIds | array of string |
Usuarios autorizados para acceder al documento |
|
duplicateDocIds
|
duplicateDocIds | array of string |
Identificadores de documento duplicados (basados en valores de campos) |
|
approvedBy
|
approvedBy | ApiUser |
Información del usuario |
|
validatedBy
|
validatedBy | ApiUser |
Información del usuario |
ApiDocumentApiListResult
Resultado de la búsqueda
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
list
|
list | array of ApiDocument |
Lista de todos los valores encontrados |
|
hasMore
|
hasMore | boolean |
True si la búsqueda puede devolver más valores |
|
offset
|
offset | integer |
Valor de desplazamiento (número de valores omitidos) |
ApiEnum
Enumeración de datos para enumeración de tipo de campo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador de enumeración |
|
nombre
|
name | string |
Nombre de enumeración descriptivo |
|
values
|
values | object |
Lista de valores de enumeración |
|
isEditable
|
isEditable | boolean |
Indica si se puede editar la enumeración. |
ApiFolderCreationResult
Resultado de la creación de contenedores
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
folderId
|
folderId | string |
ID de contenedor |
ApiFolderWithMembers
Metadatos de contenedor con metadatos de documentos dentro del contenedor
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
folderId
|
folderId | string |
Id. de documento. |
|
ownerId
|
ownerId | string |
Identificador del propietario del contenedor |
|
creado
|
created | date-time |
Hora de creación del contenedor |
|
metadata
|
metadata | object |
Todos los encabezados adjuntos al contenedor |
|
Miembros
|
members | array of ApiDocument |
Lista de todos los miembros del contenedor |
ApiItemCell
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | string |
Valor de celda |
|
modifiedByPostProcessing
|
modifiedByPostProcessing | boolean |
Indica si este valor se modificó mediante el procesamiento posterior. |
|
pluginResults
|
pluginResults | array of ApiPluginResult |
Resultados de complementos |
ApiItemColumn
Define la columna de tabla de elementos.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
campo
|
field | string |
Campo |
|
Ancho
|
width | double |
Alto de la fila. |
ApiItemRow
Define la fila de la tabla de elementos.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
altura
|
height | double |
Alto de la fila. |
|
células
|
cells | array of ApiItemCell |
Lista de todas las celdas de esta columna. Count debe ser siempre igual al número de columnas. |
ApiItemTable
Tabla de elementos
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
pageIndex
|
pageIndex | integer |
Índice de la página a la que pertenece la tabla. |
|
offset
|
offset | Offset |
Define el desplazamiento bidimensional con coordenadas X e Y. |
|
columns
|
columns | array of ApiItemColumn |
Lista de definiciones de columna. |
|
Filas
|
rows | array of ApiItemRow |
Lista de definiciones de fila y celdas de cada fila. |
ApiPage
Página Documento
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
index
|
index | integer |
Índice de página del documento. Indexado a partir de 1. |
|
Ancho
|
width | integer |
Ancho de la página en píxeles. |
|
altura
|
height | integer |
Alto de la página en píxeles. |
|
rotación
|
rotation | double |
Rotación de la página en grados. |
|
words
|
words | array of ApiWord |
Lista de todas las palabras presentes en la página. |
|
itemTable
|
itemTable | ApiItemTable |
Tabla de elementos |
ApiPluginResult
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
pluginName
|
pluginName | string |
Obtiene o establece el nombre del script que ha validado este documento. |
|
resultCode
|
resultCode | PostProcessResult |
Resultado posterior al procesamiento |
|
value
|
value | string |
Obtiene o establece la colección de mensajes localizados. |
|
extraInformationRequired
|
extraInformationRequired | boolean |
Obtiene o establece si se necesita información adicional. |
|
extraInformationMessage
|
extraInformationMessage | string |
Obtiene o establece el mensaje de requisitos de información adicional. |
ApiUploadResponse
Resultado de una carga de archivos
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
documentId
|
documentId | string |
Id. de documento |
|
folderId
|
folderId | string |
Id. de carpeta |
ApiUser
Información del usuario
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador del usuario |
|
firstName
|
firstName | string |
Nombre del usuario |
|
lastName
|
lastName | string |
Apellidos del usuario |
|
Correo electrónico
|
string |
Correo electrónico del usuario |
ApiUserApiListResult
Resultado de la búsqueda
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
list
|
list | array of ApiUser |
Lista de todos los valores encontrados |
|
hasMore
|
hasMore | boolean |
True si la búsqueda puede devolver más valores |
|
offset
|
offset | integer |
Valor de desplazamiento (número de valores omitidos) |
ApiWord
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
wordId
|
wordId | integer |
Identificador de la palabra, único para un documento |
|
pageIndex
|
pageIndex | integer |
Índice de la página que se presenta la palabra |
|
texto
|
text | string |
Texto de la palabra |
|
locX
|
locX | integer |
Coordenada X de la palabra |
|
locY
|
locY | integer |
Coordenada Y de la palabra |
|
Ancho
|
width | integer |
Ancho de word |
|
altura
|
height | integer |
Alto de Word |
ApprovalState
DocumentSource
DocumentState
LicenseTimePeriod
MLicense
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
responseCode
|
responseCode | ResponseCode | |
|
responseMessage
|
responseMessage | string | |
|
validFrom
|
validFrom | date-time | |
|
validTo
|
validTo | date-time | |
|
nextPeriod
|
nextPeriod | date-time | |
|
usageLimit
|
usageLimit | integer | |
|
usageLimitPeriod
|
usageLimitPeriod | LicenseTimePeriod |
Período de tiempo para las licencias |
|
isTrial
|
isTrial | boolean | |
|
usageCount
|
usageCount | integer |
Desplazar
Define el desplazamiento bidimensional con coordenadas X e Y.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
x
|
x | double |
Desplazamiento en coordenada X. |
|
y
|
y | double |
Desplazamiento en coordenada Y. |
PostProcessResult
RedQueStatus
Datos de respuesta de estado. Se usa como respuesta cuando la solicitud no devuelve datos.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código de estado
|
statusCode | integer |
Código de estado |
|
Mensaje
|
message | string |
Message |
Código de respuesta
StringApiValue
Valor de respuesta genérico
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | string |
Importancia |