InfoShare
InfoShare está diseñado para su uso en empresas que buscan optimizar la forma en que administran documentos digitales, información, enlazadores y procesos.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Compatibilidad con Kendox |
| URL | https://kendox.com/en/service/support-services |
| Correo Electrónico | support@kendox.com |
| Metadatos del conector | |
|---|---|
| Publicador | Kendox AG |
| Sitio web | https://www.kendox.com/en |
| Directiva de privacidad | https://www.kendox.com/en/about-us/data-protection |
| Categorías | Colaboración; Contenido y archivos |
Conector de Kendox InfoShare
Kendox InfoShare proporciona una API REST eficaz y muy extensa. Con esta API, puede crear y administrar documentos y procesos en InfoShare. Junto con kendox InfoShare Power Automate Connector, puede simplificar los procesos de contenido en un panorama de aplicaciones generalizado, evitando así los silos de información.
Requisitos previos
Necesitará lo siguiente para continuar:
- Una licencia para usar este conector disponible a través de sales365@kendox.com.
- Kendox InfoShare con los puntos de conexión de servicio WCF accesibles en línea.
- Credenciales de inicio de sesión de Kendox InfoShare.
Operaciones admitidas
El conector admite las siguientes operaciones:
General
-
Logon: inicie sesión en InfoShare Server. -
Logon with hashed password: inicie sesión en InfoShare Server. -
Logoff: iniciar sesión desde InfoShare Server -
Get documents and processes selection: obtener documentos y procesos seleccionados en el cliente web móvil a través de la acción del botón personalizado
Documento
-
Create document (deprecated): cree un documento en InfoShare, versión en desuso. -
Create document (V2): cree un documento en InfoShare, versión sugerida. -
Update document (deprecated): actualizar el documento en InfoShare, versión en desuso -
Update document (V2): se ha actualizado el documento en InfoShare, versión sugerida. -
Get document properties: obtener las propiedades de un documento de InfoShare -
Get file content: obtener el contenido de un archivo de InfoShare -
Get file content converted: convierte el contenido de un archivo en otro formato de archivo (e.g. tiff a pdf). Obtener contenido de archivo, incluidas anotaciones y superposiciones -
Get document: devuelve información del documento (estructura) de InfoShare -
Merge PDF documents: combinar dos o más documentos PDF en un documento de destino
Proceso
-
Create process: crear e iniciar un proceso -
Update process (deprecated): actualización de un proceso en InfoShare, versión en desuso -
Update process (V2): actualizar un proceso en InfoShare, versión sugerida -
Close an open process: cierre un proceso en InfoShare -
Close task and continue process: cerrar una tarea de proceso en InfoShare -
Close current task and assign user to next task: cierre una tarea de proceso y asigne un usuario a la siguiente tarea en InfoShare -
Get process: devuelve una lista de información de proceso (estructura) de InfoShare. -
Get process properties: obtener las propiedades de un proceso de InfoShare
Search
-
Document Search (deprecated): buscar documentos en InfoShare, versión en desuso -
Document Search (V2): buscar documentos en InfoShare, versión sugerida -
List processes (deprecated): obtener una lista de procesos dentro de InfoShare, reemplazado por la acción de búsqueda proceso -
Process search: búsqueda de procesos en InfoShare
Tablas de usuario
-
Create a user table: crea una tabla de usuario. -
Get rows from a user table: obtiene algunas filas de una tabla de usuario. -
Insert rows into a user table: insertar filas en una tabla de usuario -
Update a row in a user table: actualización de una fila en una tabla de usuario -
Delete user table rows: elimina algunas filas de una tabla de usuario.
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 |
|---|---|---|---|
| Clave de API | securestring | La clave de API de esta API | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualización de una fila en una tabla de usuario |
Actualización de una fila en una tabla de usuario |
| Actualizar documento (en desuso) [EN DESUSO] |
Actualizar documento (en desuso) |
| Actualizar documento (V2) |
Actualizar documento (V2) |
| Búsqueda de documentos (en desuso) [EN DESUSO] |
Búsqueda de documentos (en desuso) |
| Búsqueda de documentos (V2) |
Búsqueda de documentos (V2) |
| Búsqueda de procesos |
Búsqueda de procesos |
| Cerrar un proceso abierto |
Cerrar un proceso abierto |
| Cierre de la tarea y continúe el proceso |
Cierre de la tarea y continúe el proceso |
| Cierre la tarea actual y asigne un usuario a la siguiente tarea |
Cierre la tarea actual y asigne un usuario a la siguiente tarea |
| Combinar documentos PDF |
Combinar dos o más documentos PDF en un documento |
| Creación de una tabla de usuario |
Creación de una tabla de usuario |
| Crear documento (en desuso) [EN DESUSO] |
Crear documento (en desuso) |
| Crear documento (V2) |
Crear documento (V2) |
| Crear proceso |
Crear proceso |
| Eliminación de filas de tabla de usuario |
Eliminación de filas de tabla de usuario |
| Enumerar procesos (en desuso) [EN DESUSO] |
Enumerar procesos (en desuso) |
| Iniciar sesión |
Iniciar sesión |
| Inicio de sesión con contraseña con hash |
Inicio de sesión con contraseña con hash |
| Insertar filas en una tabla de usuario |
Importación de filas de tabla en una tabla de usuario |
| Logoff |
Logoff |
| Obtención de documentos y procesos de selección |
Obtener documentos y procesos seleccionados en el cliente web móvil a través de la acción del botón personalizado |
| Obtención de filas de una tabla de usuario |
Obtención de filas de una tabla de usuario |
| Obtención de las propiedades del proceso |
Obtención de las propiedades del proceso |
| Obtención del contenido del archivo convertido |
Convierta el contenido del archivo en un formato diferente. Agregar anotación o superposición al contenido del archivo |
| Obtener contenido de archivo |
Obtener contenido de archivo |
| Obtener documento |
Obtener documento |
| Obtener proceso |
Obtener proceso |
| Obtener propiedades del documento |
Obtener propiedades del documento |
| Proceso de actualización (en desuso) [EN DESUSO] |
Proceso de actualización (en desuso) |
| Proceso de actualización (V2) |
Proceso de actualización (V2) |
Actualización de una fila en una tabla de usuario
Actualización de una fila en una tabla de usuario
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
Nombre de tabla de usuario
|
UserTable | True | string |
Nombre de tabla de usuario |
|
RowData
|
RowData | True | string |
Cadena que contiene datos de fila que se van a actualizar, separados por punto y coma, el primer elemento debe ser el InternalRecord_Id de la fila que se va a actualizar, "100" en el ejemplo siguiente: 100; John; Coneja; 2024-01-01; 2024-12-31 |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
userTableUpdateRowResult
|
userTableUpdateRowResult | integer |
userTableUpdateRowResult |
Actualizar documento (en desuso) [EN DESUSO]
Actualizar documento (en desuso)
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
DocumentId
|
DocumentId | True | string |
Id. del documento |
|
DocumentTitle
|
DocumentTitle | string |
Título del documento |
|
|
DocumentProperties
|
DocumentProperties | string |
Formato de actualización de propiedades del documento: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
Cultura
|
Culture | string |
Referencia cultural en la que se da el texto (de, en, fr, ...). Valor predeterminado = de |
|
|
FileContent
|
FileContent | string |
Cadena base64 de contenido del archivo |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
abonnements
|
abonnements | array of object |
abonnements |
|
OnContentChange
|
abonnements.onContentChange | boolean |
Abonnement está activo en los cambios de archivo |
|
OnDelete
|
abonnements.onDelete | boolean |
Abonnement está activo al eliminar |
|
OnMetadataChange
|
abonnements.onMetadataChange | boolean |
Abonnement está activo en los cambios de índice |
|
UserId
|
abonnements.userId | string |
Identificador de usuario de este abonnnement |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of object |
postItAnnotations |
|
CreatedDate
|
annotationManager.postItAnnotations.createdDate | string |
Fecha de creación a partir de la anotación posterior |
|
CreatorId
|
annotationManager.postItAnnotations.creatorId | string |
Identificador de usuario del creador de la anotación post it |
|
IsItalic
|
annotationManager.postItAnnotations.fontInfo.isItalic | boolean |
¿Tiene cursiva de fuente la anotación post-it? |
|
IsStrikeOut
|
annotationManager.postItAnnotations.fontInfo.isStrikeOut | boolean |
¿La fuente sale de la anotación de publicación? |
|
IsUnderline
|
annotationManager.postItAnnotations.fontInfo.isUnderline | boolean |
¿La fuente se subraya desde la anotación posterior? |
|
Nombre
|
annotationManager.postItAnnotations.fontInfo.name | string |
Nombre de fuente de la anotación post it. Valor predeterminado = Arial |
|
Inclinación
|
annotationManager.postItAnnotations.fontInfo.pitch | integer |
Tono de fuente de la anotación post it |
|
Tamaño
|
annotationManager.postItAnnotations.fontInfo.size | integer |
Tamaño de fuente de la anotación post it. Ejemplo: Size:12 es 12000. Necesita factor 1000 |
|
Weight
|
annotationManager.postItAnnotations.fontInfo.weight | integer |
Peso de fuente de la anotación post it |
|
Id
|
annotationManager.postItAnnotations.id | string |
Identificador de la anotación post it |
|
ModifiedDate
|
annotationManager.postItAnnotations.modifiedDate | string |
Fecha de modificación de la anotación post it. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.postItAnnotations.pageNumber | integer |
Número de páginas de la anotación post it |
|
SecurityLevelEnum
|
annotationManager.postItAnnotations.securityLevelEnum | string |
Nivel de seguridad para la anotación post it (PublicAvailable, Personal, PersonalProtected, OnlyEditors). Valor predeterminado = Públicamente disponible |
|
Seleccionable
|
annotationManager.postItAnnotations.selectable | boolean |
Define si el usuario puede seleccionar la anotación después de publicarla. |
|
Mensaje de texto
|
annotationManager.postItAnnotations.text | string |
Texto definido por el usuario para publicarla anotación |
|
X
|
annotationManager.postItAnnotations.x | integer |
Coordenada X en píxel por pulgada para 7200 PPP de anotación post it |
|
S
|
annotationManager.postItAnnotations.y | integer |
Coordenada Y en píxel por pulgada para 7200 PPP de anotación post it |
|
rectánguloAnnotations
|
annotationManager.rectangleAnnotations | array of object |
rectánguloAnnotations |
|
Color
|
annotationManager.rectangleAnnotations.color | integer |
Color del rectángulo (valor ARGB de 32 bits) de la anotación rectángulo Ejemplo: Negro: -16777216 Blanco: -1 Rojo: -65536 Verde: -16744448 Azul: -16776961 |
|
ColorHexCode
|
annotationManager.rectangleAnnotations.colorHexCode | string |
Color del rectángulo (código hexadecimal RGB) de la anotación de rectángulo. Ejemplo: Negro: #000000 Blanco: #FFFFFF Rojo: #FF0000 Verde: #008000 Azul: #0000FF |
|
CreatedDate
|
annotationManager.rectangleAnnotations.createdDate | string |
Fecha de creación de la anotación de rectángulo. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
creatorId
|
annotationManager.rectangleAnnotations.creatorId | string |
CreatorId |
|
Altura
|
annotationManager.rectangleAnnotations.height | integer |
Alto del rectángulo en píxel por pulgada para 7200 PPP |
|
Id
|
annotationManager.rectangleAnnotations.Id | string |
Identificador de la anotación de rectángulo |
|
ModifiedDate
|
annotationManager.rectangleAnnotations.modifiedDate | string |
Fecha de modificación de la anotación de rectángulo. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.rectangleAnnotations.pageNumber | integer |
Número de páginas de la anotación de rectángulo |
|
SecurityLevelEnum
|
annotationManager.rectangleAnnotations.securityLevelEnum | string |
Nivel de seguridad para la anotación de rectángulo (Públicamente Disponible, Personal, PersonalProtected, OnlyEditors). Valor predeterminado = Públicamente disponible |
|
Seleccionable
|
annotationManager.rectangleAnnotations.selectable | boolean |
Define si el usuario puede seleccionar la anotación de rectángulo. |
|
Transparent
|
annotationManager.rectangleAnnotations.transparent | boolean |
El rectángulo debe ser transparente (resaltado) |
|
Ancho
|
annotationManager.rectangleAnnotations.width | integer |
Ancho del rectángulo en píxel por pulgada para 7200 PPP |
|
X
|
annotationManager.rectangleAnnotations.x | integer |
Coordenada X en píxel por pulgada para 7200 PPP de anotación de rectángulo |
|
S
|
annotationManager.rectangleAnnotations.y | integer |
Coordenada Y en píxel por pulgada para 7200 PPP de anotación de rectángulo |
|
textAnnotations
|
annotationManager.textAnnotations | array of object |
textAnnotations |
|
BackgroundColor
|
annotationManager.textAnnotations.backgroundColor | integer |
Color del fondo (valor ARGB de 32 bits) de la anotación de texto. Ejemplo: Negro: blanco -16777216: -1 rojo: -65536 verde: -16744448 azul: -16776961 |
|
BackgroundColorHexCode
|
annotationManager.textAnnotations.backgroundColorHexCode | string |
Color del fondo (código hexadecimal RGB) de la anotación de texto. Ejemplo: Negro: #000000 Blanco: #FFFFFF Rojo: #FF0000 Verde: #008000 Azul: #0000FF |
|
CreatedDate
|
annotationManager.textAnnotations.createdDate | string |
fecha de creación a partir de la anotación de texto. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CreatorId
|
annotationManager.textAnnotations.creatorId | string |
Identificador de usuario del creador de la anotación de texto |
|
IsItalic
|
annotationManager.textAnnotations.fontInfo.isItalic | boolean |
¿Es la letra cursiva de la anotación de texto? |
|
IsStrikeOut
|
annotationManager.textAnnotations.fontInfo.isStrikeOut | boolean |
¿La fuente sale de la anotación de texto? |
|
IsUnderline
|
annotationManager.textAnnotations.fontInfo.isUnderline | boolean |
Es el subrayado de fuente de la anotación de texto. |
|
Nombre
|
annotationManager.textAnnotations.fontInfo.name | string |
Nombre de fuente de la anotación de texto. Valor predeterminado = Arial |
|
Inclinación
|
annotationManager.textAnnotations.fontInfo.pitch | integer |
Tono de fuente de la anotación de texto |
|
Tamaño
|
annotationManager.textAnnotations.fontInfo.size | integer |
Tamaño de fuente de la anotación de texto. Ejemplo: Size:12 es 12000. Necesita factor 1000 |
|
Weight
|
annotationManager.textAnnotations.fontInfo.weight | integer |
Peso de fuente de la anotación de texto |
|
ForegroundColor
|
annotationManager.textAnnotations.foregroundColor | integer |
Color del primer plano (valor ARGB de 32 bits) de la anotación de texto. Ejemplo: Negro: blanco -16777216: -1 rojo: -65536 verde: -16744448 azul: -16776961 |
|
ForegroundColorHexCode
|
annotationManager.textAnnotations.foregroundColorHexCode | string |
Color de primer plano (código hexadecimal RGB) de la anotación de texto. Ejemplo: Negro: #000000 Blanco: #FFFFFF Rojo: #FF0000 Verde: #008000 Azul: #0000FF |
|
Altura
|
annotationManager.textAnnotations.height | integer |
Alto del texto en píxel por pulgada para 7200 PPP de anotación de texto |
|
Id
|
annotationManager.textAnnotations.id | string |
Id. de anotación de texto |
|
ModifiedDate
|
annotationManager.textAnnotations.modifiedDate | string |
Fecha de modificación de la anotación de texto. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.textAnnotations.pageNumber | integer |
Número de páginas de anotación de texto |
|
Rotation
|
annotationManager.textAnnotations.rotation | integer |
Rotación en grados de anotación de texto |
|
SecurityLevelEnum
|
annotationManager.textAnnotations.securityLevelEnum | string |
Nivel de seguridad para la anotación de texto (Públicamente Disponible, Personal, PersonalProtected, OnlyEditors). Valor predeterminado = Públicamente disponible |
|
Seleccionable
|
annotationManager.textAnnotations.selectable | boolean |
Define si el usuario puede seleccionar la anotación de texto. |
|
Mensaje de texto
|
annotationManager.textAnnotations.text | string |
Texto definido por el usuario de la anotación de texto |
|
Transparent
|
annotationManager.textAnnotations.transparent | boolean |
La anotación de texto debe ser transparente |
|
Ancho
|
annotationManager.textAnnotations.width | integer |
Ancho del texto en píxel por pulgada para 7200 PPP de anotación de texto |
|
X
|
annotationManager.textAnnotations.x | integer |
Coordenada X en píxel por pulgada para 7200 PPP de anotación de texto |
|
S
|
annotationManager.textAnnotations.y | integer |
Coordenada Y en píxel por pulgada para 7200 PPP de anotación de texto |
|
blogs
|
blogs | array of object |
blogs |
|
CreatedDate
|
blogs.createdDate | string |
Fecha en la que se creó el blog. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CreatorId
|
blogs.creatorId | string |
Identificador de usuario del blog de creación de usuarios |
|
Id
|
blogs.id | string |
Identificador del blog |
|
Mensaje de texto
|
blogs.text | string |
Texto del elemento de blog |
|
CheckOutStateEnum
|
checkOutStateEnum | string |
Desproteger el estado del documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
Identificador del usuario para el que se desprotegió el documento |
|
documentData
|
documentData | array of object |
documentData |
|
Id
|
documentData.id | string |
Id. de datos de documento |
|
Nombre
|
documentData.name | string |
Nombre de datos del documento |
|
Copias
|
documentData.renditions | array of |
Copias |
|
HasOverlay
|
hasOverlay | boolean |
Define si el documento debe mostrarse con una superposición. |
|
Id
|
id | string |
Id. del documento |
|
ImportTemplateId
|
importTemplateId | string |
Identificador de la plantilla de importación de este documento |
|
InfoStoreId
|
infoStoreId | string |
Identificador del almacén de información |
|
CheckOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Estado del ciclo de vida de desprotección |
|
LifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Fecha de finalización calculada del ciclo de vida. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Fecha de inicio del ciclo de vida. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Identificador del estado LifeCycle |
|
NextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Siguiente estado de ciclo de vida automático |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of string |
nextLifeCycleStates |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
lifeCycleProtections |
|
DeleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Permitir eliminar el documento después de la expiración de la protección |
|
Id
|
lifeCycleManager.lifeCycleProtections.id | string |
Id. de protección de estado del ciclo de vida |
|
ProtectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Protección contra los cambios de anotación |
|
ProtectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Protección contra la des check out |
|
ProtectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Protección contra el cambio de contenido |
|
ProtectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Protección contra la eliminación |
|
ProtectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Protección contra los cambios de propiedad |
|
ProtectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Protección contra el cambio de seguridad |
|
ProtectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Duración de la protección |
|
LifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Id. de LifeCycle |
|
MainFileLength
|
mainFileLength | integer |
Tamaño del archivo principal |
|
Nombre
|
name | string |
Nombre del documento |
|
PageCount
|
pageCount | integer |
Recuento de páginas del archivo principal |
|
Propiedades
|
properties | array of object |
Propiedades |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultura
|
properties.globalValues.values.culture | string |
Cultura |
|
texto
|
properties.globalValues.values.text | string |
Mensaje de texto |
|
nombre de la propiedad
|
properties.propertyName | string |
Nombre de la propiedad |
|
PropertyTypeId
|
properties.propertyTypeId | string |
Identificador de tipo del campo de índice |
|
values
|
properties.values | array of string |
Valores PropertyType |
|
ProtectionDomainId
|
protectionDomainId | string |
Identificador del dominio de protección |
|
Recordatorios
|
reminders | array of object |
Recordatorios |
|
Description
|
reminders.description | string |
Descripción del aviso |
|
Intervalo
|
reminders.interval | integer |
Intervalo en días entre recordatorios |
|
ProcessTemplateId
|
reminders.processTemplateId | string |
Identificador de plantilla de proceso para este recordatorio |
|
ReminderDate
|
reminders.reminderDate | string |
Fecha del aviso. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
ReminderId
|
reminders.reminderId | string |
Identificador del aviso |
|
subjectIds
|
reminders.subjectIds | array of |
subjectIds |
|
UseUserFromProcessTemplate
|
reminders.useUserFromProcessTemplate | boolean |
Define si se usará la definición de usuario de la plantilla de proceso. |
|
SigningProfileId
|
signingProfileId | string |
Identificador del perfil de firma |
|
VersionId
|
versionId | string |
Identificador de versión del documento |
Actualizar documento (V2)
Actualizar documento (V2)
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
DocumentTitle
|
DocumentTitle | string |
Título del documento |
|
|
DocumentProperties
|
DocumentProperties | string |
Formato de actualización de propiedades del documento: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
RemoveDocumentProperties
|
RemoveDocumentProperties | string |
Lista de nombres o identificadores de propiedad separados por punto y coma que se van a quitar del documento, como "FistName; b9cfbdf7-f6fb-4179-91c8-d9681fb680dd; Departamentos" |
|
|
Cultura
|
Culture | string |
Referencia cultural en la que se da el texto (de, en, fr, ...). Valor predeterminado = de |
|
|
DocumentId
|
DocumentId | True | string |
Id. del documento |
|
ProtectionDomain
|
ProtectionDomain | string |
Nombre o identificador de ProtectionDomain |
|
|
Blog
|
Blog | string |
Agregar una entrada de texto de blog en el documento |
|
|
UploadMethod
|
UploadMethod | string |
Método usado para cargar el documento en InfoShare. Default = UploadFileBytesLarge |
|
|
FileContent
|
FileContent | string |
Cadena base64 de contenido del archivo |
|
|
ForceUndoCheckout
|
ForceUndoCheckout | boolean |
Deshacer la desprotección de un documento. Valor predeterminado = false |
|
|
ChunkSize
|
ChunkSize | integer |
Tamaño del fragmento de carga de archivos usado con los métodos uploadStreamChunks y UploadFileBytesLarge, 262144 predeterminado |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
abonnements
|
abonnements | array of object |
Abonnements |
|
OnContentChange
|
abonnements.onContentChange | boolean |
Abonnement está activo en los cambios de archivo |
|
OnDelete
|
abonnements.onDelete | boolean |
Abonnement está activo al eliminar |
|
OnMetadataChange
|
abonnements.onMetadataChange | boolean |
Abonnement está activo en los cambios de índice |
|
UserId
|
abonnements.userId | string |
Identificador de usuario de este abonnnement |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
Lista de enumeraciones de derechos de acceso |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of object |
postItAnnotations |
|
CreatedDate
|
annotationManager.postItAnnotations.createdDate | string |
Fecha de creación a partir de la anotación posterior |
|
CreatorId
|
annotationManager.postItAnnotations.creatorId | string |
Identificador de usuario del creador de la anotación post it |
|
IsItalic
|
annotationManager.postItAnnotations.fontInfo.isItalic | boolean |
¿Tiene cursiva de fuente la anotación post-it? |
|
IsStrikeOut
|
annotationManager.postItAnnotations.fontInfo.isStrikeOut | boolean |
¿La fuente sale de la anotación de publicación? |
|
IsUnderline
|
annotationManager.postItAnnotations.fontInfo.isUnderline | boolean |
¿La fuente se subraya desde la anotación posterior? |
|
Nombre
|
annotationManager.postItAnnotations.fontInfo.name | string |
Nombre de fuente de la anotación post it. Valor predeterminado = Arial |
|
Inclinación
|
annotationManager.postItAnnotations.fontInfo.pitch | integer |
Tono de fuente de la anotación post it |
|
Tamaño
|
annotationManager.postItAnnotations.fontInfo.size | integer |
Tamaño de fuente de la anotación post it. Ejemplo: Size:12 es 12000. Necesita factor 1000 |
|
Weight
|
annotationManager.postItAnnotations.fontInfo.weight | integer |
Peso de fuente de la anotación post it |
|
Id
|
annotationManager.postItAnnotations.id | string |
Anotación post it Id |
|
ModifiedDate
|
annotationManager.postItAnnotations.modifiedDate | string |
Fecha de modificación de la anotación post it. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.postItAnnotations.pageNumber | integer |
Número de páginas de la anotación post it |
|
SecurityLevelEnum
|
annotationManager.postItAnnotations.securityLevelEnum | string |
Nivel de seguridad para la anotación post it (PublicAvailable, Personal, PersonalProtected, OnlyEditors). Valor predeterminado = Públicamente disponible |
|
Seleccionable
|
annotationManager.postItAnnotations.selectable | boolean |
Define si el usuario puede seleccionar la anotación después de publicarla. |
|
Mensaje de texto
|
annotationManager.postItAnnotations.text | string |
Texto definido por el usuario para publicarla anotación |
|
X
|
annotationManager.postItAnnotations.x | integer |
Coordenada X en píxel por pulgada para 7200 PPP de anotación post it |
|
S
|
annotationManager.postItAnnotations.y | integer |
Coordenada Y en píxel por pulgada para 7200 PPP de anotación post it |
|
rectánguloAnnotations
|
annotationManager.rectangleAnnotations | array of object |
rectánguloAnnotations |
|
Color
|
annotationManager.rectangleAnnotations.color | integer |
Color del rectángulo (valor ARGB de 32 bits) de la anotación rectángulo Ejemplo: Negro: -16777216 Blanco: -1 Rojo: -65536 Verde: -16744448 Azul: -16776961 |
|
ColorHexCode
|
annotationManager.rectangleAnnotations.colorHexCode | string |
Color del rectángulo (código hexadecimal RGB) de la anotación de rectángulo. Ejemplo: Negro: #000000 Blanco: #FFFFFF Rojo: #FF0000 Verde: #008000 Azul: #0000FF |
|
CreatedDate
|
annotationManager.rectangleAnnotations.createdDate | string |
Fecha de creación de la anotación de rectángulo. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
creatorId
|
annotationManager.rectangleAnnotations.creatorId | string |
Id. del creador de anotaciones de rectángulo |
|
Altura
|
annotationManager.rectangleAnnotations.height | integer |
Alto del rectángulo en píxel por pulgada para 7200 PPP |
|
Id
|
annotationManager.rectangleAnnotations.Id | string |
Id. de anotación de rectángulo |
|
ModifiedDate
|
annotationManager.rectangleAnnotations.modifiedDate | string |
Fecha de modificación de la anotación de rectángulo. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.rectangleAnnotations.pageNumber | integer |
Número de páginas de la anotación de rectángulo |
|
SecurityLevelEnum
|
annotationManager.rectangleAnnotations.securityLevelEnum | string |
Nivel de seguridad para la anotación de rectángulo (Públicamente Disponible, Personal, PersonalProtected, OnlyEditors). Valor predeterminado = Públicamente disponible |
|
Seleccionable
|
annotationManager.rectangleAnnotations.selectable | boolean |
Define si el usuario puede seleccionar la anotación de rectángulo. |
|
Transparent
|
annotationManager.rectangleAnnotations.transparent | boolean |
El rectángulo debe ser transparente (resaltado) |
|
Ancho
|
annotationManager.rectangleAnnotations.width | integer |
Ancho del rectángulo en píxel por pulgada para 7200 PPP |
|
X
|
annotationManager.rectangleAnnotations.x | integer |
Coordenada X en píxel por pulgada para 7200 PPP de anotación de rectángulo |
|
S
|
annotationManager.rectangleAnnotations.y | integer |
Coordenada Y en píxel por pulgada para 7200 PPP de anotación de rectángulo |
|
textAnnotations
|
annotationManager.textAnnotations | array of object |
Anotaciones de texto |
|
BackgroundColor
|
annotationManager.textAnnotations.backgroundColor | integer |
Color del fondo (valor ARGB de 32 bits) de la anotación de texto. Ejemplo: Negro: blanco -16777216: -1 rojo: -65536 verde: -16744448 azul: -16776961 |
|
BackgroundColorHexCode
|
annotationManager.textAnnotations.backgroundColorHexCode | string |
Color del fondo (código hexadecimal RGB) de la anotación de texto. Ejemplo: Negro: #000000 Blanco: #FFFFFF Rojo: #FF0000 Verde: #008000 Azul: #0000FF |
|
CreatedDate
|
annotationManager.textAnnotations.createdDate | string |
fecha de creación a partir de la anotación de texto. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CreatorId
|
annotationManager.textAnnotations.creatorId | string |
Identificador de usuario del creador de la anotación de texto |
|
IsItalic
|
annotationManager.textAnnotations.fontInfo.isItalic | boolean |
¿Es la letra cursiva de la anotación de texto? |
|
IsStrikeOut
|
annotationManager.textAnnotations.fontInfo.isStrikeOut | boolean |
¿La fuente sale de la anotación de texto? |
|
IsUnderline
|
annotationManager.textAnnotations.fontInfo.isUnderline | boolean |
Es el subrayado de fuente de la anotación de texto. |
|
Nombre
|
annotationManager.textAnnotations.fontInfo.name | string |
Nombre de fuente de la anotación de texto. Valor predeterminado = Arial |
|
Inclinación
|
annotationManager.textAnnotations.fontInfo.pitch | integer |
Tono de fuente de la anotación de texto |
|
Tamaño
|
annotationManager.textAnnotations.fontInfo.size | integer |
Tamaño de fuente de la anotación de texto. Ejemplo: Size:12 es 12000. Necesita factor 1000 |
|
Weight
|
annotationManager.textAnnotations.fontInfo.weight | integer |
Peso de fuente de la anotación de texto |
|
ForegroundColor
|
annotationManager.textAnnotations.foregroundColor | integer |
Color del primer plano (valor ARGB de 32 bits) de la anotación de texto. Ejemplo: Negro: blanco -16777216: -1 rojo: -65536 verde: -16744448 azul: -16776961 |
|
ForegroundColorHexCode
|
annotationManager.textAnnotations.foregroundColorHexCode | string |
Color de primer plano (código hexadecimal RGB) de la anotación de texto. Ejemplo: Negro: #000000 Blanco: #FFFFFF Rojo: #FF0000 Verde: #008000 Azul: #0000FF |
|
Altura
|
annotationManager.textAnnotations.height | integer |
Alto del texto en píxel por pulgada para 7200 PPP de anotación de texto |
|
Id
|
annotationManager.textAnnotations.id | string |
Id. de anotación de texto |
|
ModifiedDate
|
annotationManager.textAnnotations.modifiedDate | string |
Fecha de modificación de la anotación de texto. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.textAnnotations.pageNumber | integer |
Número de páginas de anotación de texto |
|
Rotation
|
annotationManager.textAnnotations.rotation | integer |
Rotación en grados de anotación de texto |
|
SecurityLevelEnum
|
annotationManager.textAnnotations.securityLevelEnum | string |
Nivel de seguridad para la anotación de texto (Públicamente Disponible, Personal, PersonalProtected, OnlyEditors). Valor predeterminado = Públicamente disponible |
|
Seleccionable
|
annotationManager.textAnnotations.selectable | boolean |
Define si el usuario puede seleccionar la anotación de texto. |
|
Mensaje de texto
|
annotationManager.textAnnotations.text | string |
Texto definido por el usuario de la anotación de texto |
|
Transparent
|
annotationManager.textAnnotations.transparent | boolean |
La anotación de texto debe ser transparente |
|
Ancho
|
annotationManager.textAnnotations.width | integer |
Ancho del texto en píxel por pulgada para 7200 PPP de anotación de texto |
|
X
|
annotationManager.textAnnotations.x | integer |
Coordenada X en píxel por pulgada para 7200 PPP de anotación de texto |
|
S
|
annotationManager.textAnnotations.y | integer |
Coordenada Y en píxel por pulgada para 7200 PPP de anotación de texto |
|
blogs
|
blogs | array of object |
blogs |
|
CreatedDate
|
blogs.createdDate | string |
Fecha en la que se creó el blog. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CreatorId
|
blogs.creatorId | string |
Identificador de usuario del blog de creación de usuarios |
|
Id
|
blogs.id | string |
Identificador del blog |
|
Mensaje de texto
|
blogs.text | string |
Texto del elemento de blog |
|
CheckOutStateEnum
|
checkOutStateEnum | string |
Desproteger el estado del documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
Identificador del usuario para el que se desprotegió el documento |
|
documentData
|
documentData | array of object |
Datos del documento |
|
Id
|
documentData.id | string |
Id. de datos del documento |
|
Nombre
|
documentData.name | string |
Nombre de datos del documento |
|
Copias
|
documentData.renditions | array of |
Copias |
|
HasOverlay
|
hasOverlay | boolean |
Define si el documento debe mostrarse con una superposición. |
|
Id
|
id | string |
Id. del documento |
|
ImportTemplateId
|
importTemplateId | string |
Identificador de la plantilla de importación de este documento |
|
InfoStoreId
|
infoStoreId | string |
Identificador del almacén de información |
|
CheckOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Estado del ciclo de vida de desprotección |
|
LifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Fecha de finalización calculada del ciclo de vida. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Fecha de inicio del ciclo de vida. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Identificador del estado LifeCycle |
|
NextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Siguiente estado de ciclo de vida automático |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of string |
Estados del ciclo de vida siguiente |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
lifeCycleProtections |
|
DeleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Permitir eliminar el documento después de la expiración de la protección |
|
Id
|
lifeCycleManager.lifeCycleProtections.id | string |
Id. de protección de estado del ciclo de vida |
|
ProtectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Protección contra los cambios de anotación |
|
ProtectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Protección contra la des check out |
|
ProtectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Protección contra el cambio de contenido |
|
ProtectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Protección contra la eliminación |
|
ProtectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Protección contra los cambios de propiedad |
|
ProtectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Protección contra el cambio de seguridad |
|
ProtectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Duración de la protección |
|
LifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Id. de LifeCycle |
|
MainFileLength
|
mainFileLength | integer |
Tamaño del archivo principal |
|
Nombre
|
name | string |
Nombre del documento |
|
PageCount
|
pageCount | integer |
Recuento de páginas del archivo principal |
|
Propiedades
|
properties | array of object |
Propiedades |
|
globalValues
|
properties.globalValues | array of object |
Valores globales |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultura
|
properties.globalValues.values.culture | string |
Referencia cultural de valor global |
|
texto
|
properties.globalValues.values.text | string |
Texto del valor global |
|
nombre de la propiedad
|
properties.propertyName | string |
Nombre de la propiedad |
|
PropertyTypeId
|
properties.propertyTypeId | string |
Identificador de tipo del campo de índice |
|
values
|
properties.values | array of string |
Valores de tipo de propiedad |
|
ProtectionDomainId
|
protectionDomainId | string |
Identificador del dominio de protección |
|
Recordatorios
|
reminders | array of object |
Recordatorios |
|
Description
|
reminders.description | string |
Descripción del aviso |
|
Intervalo
|
reminders.interval | integer |
Intervalo en días entre recordatorios |
|
ProcessTemplateId
|
reminders.processTemplateId | string |
Identificador de plantilla de proceso para este recordatorio |
|
ReminderDate
|
reminders.reminderDate | string |
Fecha del aviso. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
ReminderId
|
reminders.reminderId | string |
Identificador del aviso |
|
subjectIds
|
reminders.subjectIds | array of |
subjectIds |
|
UseUserFromProcessTemplate
|
reminders.useUserFromProcessTemplate | boolean |
Define si se usará la definición de usuario de la plantilla de proceso. |
|
SigningProfileId
|
signingProfileId | string |
Identificador del perfil de firma |
|
VersionId
|
versionId | string |
Identificador de versión del documento |
Búsqueda de documentos (en desuso) [EN DESUSO]
Búsqueda de documentos (en desuso)
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
Conditions
|
Conditions | string |
Formato de condición de búsqueda: [<PropertyName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn" RelationEnums:"And,Or". Por ejemplo: [Última entrada|Less|2021-12-31|Y],[Nombre|Equals|Peter|Y] |
|
|
Cultura
|
Culture | string |
Referencia cultural (de,en,fr,...). Valor predeterminado = de |
|
|
FulltextWords
|
FulltextWords | string |
Palabras que se van a buscar con texto completo |
|
|
FulltextWordRelation
|
FulltextWordRelation | string |
Relación de palabras de texto completo (AND, OR). Valor predeterminado = AND |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Número máximo de resultados de búsqueda de documentos. Valor predeterminado = 100 |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of object |
Documentos |
|
Abonnements
|
documents.abonnements | string |
Lista de abonnements |
|
accessRightsEnumList
|
documents.accessRightsEnumList | array of string |
accessRightsEnumList |
|
AnnotationManager
|
documents.annotationManager | string |
Anotaciones para el archivo de documento principal |
|
Blogs
|
documents.blogs | string |
Lista de todos los elementos de blog |
|
CheckOutState
|
documents.checkOutStateEnum | string |
Desproteger el estado del documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
documents.checkOutUserId | string |
Identificador del usuario para el que se desprotegió el documento |
|
DocumentData
|
documents.documentData | string |
Lista de datos del documento |
|
HasOverlay
|
documents.hasOverlay | boolean |
Define si el documento debe mostrarse con una superposición. |
|
Id
|
documents.id | string |
Id. del documento |
|
ImportTemplateId
|
documents.importTemplateId | string |
Identificador de la plantilla de importación de este documento |
|
InfoStoreId
|
documents.infoStoreId | string |
Identificador del almacén de información |
|
LifeCycleManager
|
documents.lifeCycleManager | string |
Información del ciclo de vida |
|
MainFileLength
|
documents.mainFileLength | integer |
Tamaño del archivo principal |
|
Nombre
|
documents.name | string |
Nombre del documento |
|
PageCount
|
documents.pageCount | integer |
Recuento de páginas del archivo principal |
|
Propiedades
|
documents.properties | array of |
Propiedades |
|
ProtectionDomainId
|
documents.protectionDomainId | string |
Identificador del dominio de protección |
|
Recordatorios
|
documents.reminders | string |
Lista de todos los recordatorios |
|
SessionCount
|
documents.sessionCount | integer |
Recuento de sesiones |
|
SigningProfileId
|
documents.signingProfileId | string |
Identificador del perfil de firma |
|
VersionId
|
documents.versionId | string |
Identificador de versión del documento |
|
HasMore
|
hasMore | boolean |
Indica si existen más resultados o no. La marca se establece en true si hay más resultados disponibles. |
|
ResumePoint
|
resumePoint | string |
Punto de reanudación de la operación de búsqueda anterior. Establecer null para la primera operación de búsqueda |
Búsqueda de documentos (V2)
Búsqueda de documentos (V2)
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
Conditions
|
Conditions | string |
Formato de condición de búsqueda: [<PropertyName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn,Between" RelationEnums:"And,Or". Por ejemplo: [Última entrada|Less|2021-12-31|Y],[Nombre|Equals|Peter|Y],[Fecha|Entre|2021-12-31; 2022-12-31|Y] |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Número máximo de resultados de búsqueda de documentos. Valor predeterminado = 100 |
|
|
ResultProperties
|
ResultProperties | string |
Lista de propiedades de resultados, separadas por comas. Puede ser el nombre o el identificador de la propiedad, como "Name,Last check in,68b901cd-4d8f-11e6-aa6f-00ff04d7e62a" |
|
|
Cultura
|
Culture | string |
Referencia cultural en la que se da el texto (de, en, fr, ...). Valor predeterminado = de |
|
|
Stores
|
Stores | string |
Lista separada por comas de InfoStores en la que buscar. Puede ser el nombre o el identificador de almacén, como "Standard,9cd306e3-7e96-486c-8280-65d9f0239776" |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of object |
Resultado de la búsqueda de documentos |
|
nombre
|
documents.name | string |
Nombre del documento |
|
id
|
documents.id | string |
Id. de documento |
|
folderElementId
|
documents.folderElementId | string |
Identificador del elemento Folder |
|
checkOutStateEnum
|
documents.checkOutStateEnum | string |
Enumeración de estado de des check out |
|
hasSignature
|
documents.hasSignature | boolean |
Tiene firma |
|
hasBlog
|
documents.hasBlog | boolean |
Tiene blog |
|
hasAnnotation
|
documents.hasAnnotation | boolean |
Tiene anotación |
|
hasLinks
|
documents.hasLinks | boolean |
Tiene vínculos |
|
Propiedades
|
documents.properties | array of object |
Propiedades |
|
propertyTypeId
|
documents.properties.propertyTypeId | string |
PropertyType Id |
|
values
|
documents.properties.values | array of string |
Valores de tipo de propiedad |
|
globalValues
|
documents.properties.globalValues | array of object |
Valores globales |
|
values
|
documents.properties.globalValues.values | array of object |
values |
|
cultura
|
documents.properties.globalValues.values.culture | string |
Referencia cultural de valores globales |
|
texto
|
documents.properties.globalValues.values.text | string |
Texto de valores globales |
|
propertyTypeName
|
documents.properties.propertyTypeName | string |
Nombre propertyType |
|
propertyName
|
documents.properties.propertyName | string |
Nombre de propiedad |
|
hasTempAccess
|
documents.hasTempAccess | boolean |
Tiene acceso temporal |
|
accessRightsEnumList
|
documents.accessRightsEnumList | array of string |
Lista de enumeraciones de derechos de acceso |
|
mainFileLength
|
documents.mainFileLength | integer |
Longitud del archivo principal |
|
versionId
|
documents.versionId | string |
Id. de versión |
|
hasReminders
|
documents.hasReminders | boolean |
Tiene recordatorios |
|
hasAbonnement
|
documents.hasAbonnement | boolean |
Tiene abonnement |
|
hasOverlay
|
documents.hasOverlay | boolean |
Superposición de oasis |
|
hasMore
|
hasMore | boolean |
Tiene más |
|
resumePoint
|
resumePoint | string |
Punto de reanudación |
Búsqueda de procesos
Búsqueda de procesos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
Conditions
|
Conditions | string |
Formato de condición de búsqueda: [<PropertyName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn,Between" RelationEnums:"And,Or". Por ejemplo: [Última entrada|Less|2021-12-31|Y],[Nombre|Equals|Peter|Y],[Fecha|Entre|2021-12-31; 2022-12-31|Y] |
|
|
ResultProperties
|
ResultProperties | string |
Lista de propiedades de resultados, separadas por comas. Puede ser el nombre o el identificador de la propiedad, como "Name,Last check in,68b901cd-4d8f-11e6-aa6f-00ff04d7e62a" |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Número máximo de resultados de búsqueda de documentos. Valor predeterminado = 100 |
|
|
Cultura
|
Culture | string |
Referencia cultural en la que se da el texto (de, en, fr, ...). Valor predeterminado = de |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
processes
|
processes | array of object |
Resultado de la búsqueda de procesos |
|
values
|
processes.name.values | array of object |
Valores de propiedad |
|
cultura
|
processes.name.values.culture | string |
Referencia cultural de propiedades |
|
texto
|
processes.name.values.text | string |
Texto de la propiedad |
|
id
|
processes.id | string |
Id. de proceso |
|
folderElementId
|
processes.folderElementId | string |
Identificador del elemento Folder |
|
checkOutStateEnum
|
processes.checkOutStateEnum | string |
Enumeración de estado de des check out |
|
Propiedades
|
processes.properties | array of object |
Propiedades |
|
propertyTypeId
|
processes.properties.propertyTypeId | string |
PropertyType Id |
|
values
|
processes.properties.values | array of string |
Valores de propiedad |
|
globalValues
|
processes.properties.globalValues | array of object |
Valores globales |
|
values
|
processes.properties.globalValues.values | array of object |
values |
|
cultura
|
processes.properties.globalValues.values.culture | string |
Referencia cultural de valor global |
|
texto
|
processes.properties.globalValues.values.text | string |
Texto del valor global |
|
propertyTypeName
|
processes.properties.propertyTypeName | string |
Nombre propertyType |
|
propertyName
|
processes.properties.propertyName | string |
Nombre de propiedad |
|
priorityEnum
|
processes.priorityEnum | string |
Enumeración de prioridad |
|
statusEnum
|
processes.statusEnum | string |
Enumeración de estado |
|
dueDate
|
processes.dueDate | string |
Fecha de vencimiento |
|
hasLinks
|
processes.hasLinks | boolean |
Tiene vínculos |
|
accessRightsEnumList
|
processes.accessRightsEnumList | array of string |
Lista de enumeraciones de derechos de acceso |
|
hasMore
|
hasMore | boolean |
Tiene más |
|
resumePoint
|
resumePoint | string |
Punto de reanudación |
Cerrar un proceso abierto
Cerrar un proceso abierto
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
Identificador de conexión para identificar la conexión |
|
ProcessId
|
processId | True | string |
Identificador del proceso (Guid) |
|
Comentario
|
comment | string |
Comentario que se va a agregar |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
AccessRightsEnumList
|
CloseProcessResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
CloseProcessResult.CheckOutStateEnum | string |
Desproteger el estado del documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
CloseProcessResult.CheckOutUserId | string |
Identificador del usuario para el que se desprotegió el proceso |
|
Comentarios
|
CloseProcessResult.Comments | array of object |
Comentarios |
|
Fecha
|
CloseProcessResult.Comments.Date | string |
Fecha de comentario |
|
Id
|
CloseProcessResult.Comments.Id | string |
Identificador del comentario |
|
Mensaje de texto
|
CloseProcessResult.Comments.Text | string |
Comentario definido por el usuario |
|
UserId
|
CloseProcessResult.Comments.UserId | string |
Id. de usuario |
|
CompletedDate
|
CloseProcessResult.CompletedDate | string |
Fecha de finalización del proceso. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CompletedTasks
|
CloseProcessResult.CompletedTasks | array of object |
CompletedTasks |
|
Acción
|
CloseProcessResult.CompletedTasks.Action | string |
Texto de acción para el usuario |
|
AssignedUserIds
|
CloseProcessResult.CompletedTasks.AssignedUserIds | array of |
AssignedUserIds |
|
Comentarios
|
CloseProcessResult.CompletedTasks.Comments | array of object |
Comentarios |
|
Fecha
|
CloseProcessResult.CompletedTasks.Comments.Date | string |
Fecha de comentario |
|
Id
|
CloseProcessResult.CompletedTasks.Comments.Id | string |
Identificador del comentario |
|
Mensaje de texto
|
CloseProcessResult.CompletedTasks.Comments.Text | string |
Comentario definido por el usuario |
|
UserId
|
CloseProcessResult.CompletedTasks.Comments.UserId | string |
Identificador del usuario, que ha establecido el comentario |
|
CompletedDate
|
CloseProcessResult.CompletedTasks.CompletedDate | string |
Fecha de finalización de la tarea completada. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
CloseProcessResult.CompletedTasks.CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
CloseProcessResult.CompletedTasks.CreatedDate | string |
Fecha de creación de la tarea completada. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CreatorId
|
CloseProcessResult.CompletedTasks.CreatorId | string |
Identificador de usuario del creador de la tarea completada |
|
Description
|
CloseProcessResult.CompletedTasks.Description | string |
Descripción de la tarea completada |
|
Fecha de vencimiento
|
CloseProcessResult.CompletedTasks.DueDate | string |
Fecha de vencimiento de la tarea. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
Id
|
CloseProcessResult.CompletedTasks.Id | string |
Identificador de la tarea |
|
IntendedUserIds
|
CloseProcessResult.CompletedTasks.IntendedUserIds | array of |
IntendedUserIds |
|
ReminderDate
|
CloseProcessResult.CompletedTasks.ReminderDate | string |
Fecha para recordar la tarea completada. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
RequireAllRecipients
|
CloseProcessResult.CompletedTasks.RequiresAllRecipients | boolean |
Define si todos los destinatarios tienen que cerrar esta tarea. |
|
ShowCloseTaskDialog
|
CloseProcessResult.CompletedTasks.ShowCloseTaskDialog | boolean |
Mostrar cuadro de diálogo cerrar tarea al final de la tarea |
|
StatusEnum
|
CloseProcessResult.CompletedTasks.StatusEnum | string |
Estado de la tarea (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
CloseProcessResult.CompletedTasks.TaskTemplateId | string |
Id. de plantilla de tarea |
|
CreatedDate
|
CloseProcessResult.CreatedDate | string |
Fecha de creación del formato de fecha del proceso: aaaa-MM-ddTHH:mm:ss |
|
Acción
|
CloseProcessResult.CurrentTask.Action | string |
Texto de acción para el usuario |
|
AssignedUserIds
|
CloseProcessResult.CurrentTask.AssignedUserIds | array of string |
AssignedUserIds |
|
Comentarios
|
CloseProcessResult.CurrentTask.Comments | array of object |
Comentarios |
|
Fecha
|
CloseProcessResult.CurrentTask.Comments.Date | string |
Fecha de comentario |
|
Id
|
CloseProcessResult.CurrentTask.Comments.Id | string |
Identificador del comentario |
|
Mensaje de texto
|
CloseProcessResult.CurrentTask.Comments.Text | string |
Comentario definido por el usuario |
|
UserId
|
CloseProcessResult.CurrentTask.Comments.UserId | string |
Identificador del usuario, que ha establecido el comentario |
|
CompletedDate
|
CloseProcessResult.CurrentTask.CompletedDate | string |
Fecha de finalización de la tarea actual. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
CloseProcessResult.CurrentTask.CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
CloseProcessResult.CurrentTask.CreatedDate | string |
Fecha de creación de la tarea actual. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CreatorId
|
CloseProcessResult.CurrentTask.CreatorId | string |
Identificador de usuario del creador de la tarea actual |
|
Description
|
CloseProcessResult.CurrentTask.Description | string |
Descripción de la tarea actual |
|
Fecha de vencimiento
|
CloseProcessResult.CurrentTask.DueDate | string |
Fecha de vencimiento de la tarea actual. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
Id
|
CloseProcessResult.CurrentTask.Id | string |
Identificador de la tarea actual |
|
IntendedUserIds
|
CloseProcessResult.CurrentTask.IntendedUserIds | array of string |
IntendedUserIds |
|
ReminderDate
|
CloseProcessResult.CurrentTask.ReminderDate | string |
Fecha para recordar la tarea actual. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
RequireAllRecipients
|
CloseProcessResult.CurrentTask.RequiresAllRecipients | boolean |
Define si todos los destinatarios tienen que cerrar la tarea actual. |
|
ShowCloseTaskDialog
|
CloseProcessResult.CurrentTask.ShowCloseTaskDialog | boolean |
Mostrar cuadro de diálogo cerrar tarea en la tarea actual |
|
StatusEnum
|
CloseProcessResult.CurrentTask.StatusEnum | string |
Estado de la tarea actual (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
CloseProcessResult.CurrentTask.TaskTemplateId | string |
Identificador de plantilla de tarea de la tarea actual |
|
CustomProperties
|
CloseProcessResult.CustomProperties | array of object |
CustomProperties |
|
CustomPropertyTypeEnum
|
CloseProcessResult.CustomProperties.CustomPropertyTypeEnum | string |
Valor de enumeración de tipo de propiedad personalizada (String, Date, Number) |
|
Nombre
|
CloseProcessResult.CustomProperties.Name | string |
Nombre de la propiedad personalizada |
|
Importancia
|
CloseProcessResult.CustomProperties.Value | string |
Valor de la propiedad personalizada |
|
DocumentIds
|
CloseProcessResult.DocumentIds | array of string |
DocumentIds |
|
Fecha de vencimiento
|
CloseProcessResult.DueDate | string |
Fecha de vencimiento del proceso. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
Id
|
CloseProcessResult.Id | string |
Identificador del proceso |
|
Valores
|
CloseProcessResult.Name.Values | array of object |
Valores |
|
Cultura
|
CloseProcessResult.Name.Values.Culture | string |
Referencia cultural en la que se da el texto (de, en, fr, ...) |
|
Mensaje de texto
|
CloseProcessResult.Name.Values.Text | string |
Nombre del proceso |
|
PluginStream
|
CloseProcessResult.PluginStream | array of |
PluginStream |
|
PriorityEnum
|
CloseProcessResult.PriorityEnum | string |
Prioridad del proceso (Alto, Normal, Bajo) |
|
ProcessTemplateId
|
CloseProcessResult.ProcessTemplateId | string |
Id. de plantilla de proceso |
|
Propiedades
|
CloseProcessResult.Properties | array of object |
Propiedades |
|
GlobalValues
|
CloseProcessResult.Properties.GlobalValues | array of object |
GlobalValues |
|
Valores
|
CloseProcessResult.Properties.GlobalValues.Values | array of object |
Valores |
|
Cultura
|
CloseProcessResult.Properties.GlobalValues.Values.Culture | string |
Cultura |
|
Mensaje de texto
|
CloseProcessResult.Properties.GlobalValues.Values.Text | string |
Mensaje de texto |
|
PropertyTypeId
|
CloseProcessResult.Properties.PropertyTypeId | string |
Identificador de tipo del campo de índice |
|
Valores
|
CloseProcessResult.Properties.Values | array of string |
Valores |
|
ProtectionDomainId
|
CloseProcessResult.ProtectionDomainId | string |
Identificador de dominio de protección del proceso |
|
SessionCount
|
CloseProcessResult.SessionCount | integer |
Recuento de sesiones |
|
StatusEnum
|
CloseProcessResult.StatusEnum | string |
Estado del proceso (Open, InProcess, Complete, PreparedToComplete, Error) |
Cierre de la tarea y continúe el proceso
Cierre de la tarea y continúe el proceso
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
Identificador de conexión para identificar la conexión |
|
ProcessId
|
processId | True | string |
Identificador del proceso (Guid) |
|
Comentario
|
comment | string |
Comentario que se va a agregar |
|
|
TaskId
|
taskId | string |
Id. de tarea |
|
|
AssignUsers
|
assignUsers | True | boolean |
Asignar a los usuarios. Si se establece en no, asigne un usuario con la acción Actualizar proceso. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Acción
|
action | string |
Texto de acción para el usuario. Se muestra al usuario final |
|
AssignedUserIds
|
assignedUserIds | string |
Lista de identificadores de usuario asignados |
|
comments
|
comments | array of object |
comments |
|
Fecha
|
comments.date | string |
Fecha de comentario |
|
Id
|
comments.id | string |
Identificador del comentario |
|
Mensaje de texto
|
comments.text | string |
Comentario definido por el usuario |
|
UserId
|
comments.userId | string |
ID de usuario |
|
CompletedDate
|
completedDate | string |
Fecha de finalización. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
completedUserIds | string |
Lista de todos los identificadores de usuario completados |
|
CreatedDate
|
createdDate | string |
Fecha de creación. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CreatorId
|
creatorId | string |
Identificador de usuario del creador |
|
Description
|
description | string |
Descripción de la tarea |
|
Fecha de vencimiento
|
dueDate | string |
Fecha de vencimiento de la tarea. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
IntendedUserIds
|
intendedUserIds | string |
Usuarios previstos para esta tarea |
|
ReminderDate
|
reminderDate | string |
Fecha de aviso. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
RequireAllRecipients
|
requiresAllRecipients | boolean |
Define si todos los destinatarios tienen que cerrar esta tarea. |
|
ShowCloseTaskDialog
|
showCloseTaskDialog | boolean |
Mostrar cuadro de diálogo cerrar tarea al final de la tarea |
|
Estado
|
statusEnum | string |
Estado de la tarea Status (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
taskTemplateId | string |
Id. de plantilla de tarea |
Cierre la tarea actual y asigne un usuario a la siguiente tarea
Cierre la tarea actual y asigne un usuario a la siguiente tarea
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
ProcessId
|
ProcessId | True | string |
Identificador del proceso (Guid) |
|
TaskId
|
TaskId | string |
Identificador de tarea (Guid) |
|
|
Comentario
|
Comment | string |
Comentario |
|
|
AssignUserLoginNames
|
AssignUserLoginNames | True | string |
AssignUserLoginNames |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Acción
|
action | string |
Texto de acción para el usuario. Se muestra al usuario final |
|
assignedUserIds
|
assignedUserIds | array of string |
assignedUserIds |
|
comments
|
comments | array of object |
comments |
|
Fecha
|
comments.date | string |
Fecha de comentario |
|
Id
|
comments.id | string |
Identificador del comentario |
|
Mensaje de texto
|
comments.text | string |
Comentario definido por el usuario |
|
UserId
|
comments.userId | string |
Identificador del usuario, que ha establecido el comentario |
|
CompletedDate
|
completedDate | string |
Fecha de finalización. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
createdDate | string |
Fecha de creación. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CreatorId
|
creatorId | string |
Identificador de usuario del creador |
|
Description
|
description | string |
Descripción de la tarea |
|
Fecha de vencimiento
|
dueDate | string |
Fecha de vencimiento de la tarea. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
intendedUserIds
|
intendedUserIds | array of string |
intendedUserIds |
|
ReminderDate
|
reminderDate | string |
Fecha de aviso. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
RequireAllRecipients
|
requiresAllRecipients | boolean |
Define si todos los destinatarios tienen que cerrar esta tarea. |
|
ShowCloseTaskDialog
|
showCloseTaskDialog | boolean |
Mostrar cuadro de diálogo cerrar tarea al final de la tarea |
|
Estado
|
statusEnum | string |
Estado de la tarea Status (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
taskTemplateId | string |
Id. de plantilla de tarea |
Combinar documentos PDF
Combinar dos o más documentos PDF en un documento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
DocumentId
|
DocumentId | True | string |
Id. del primer documento PDF, se creará una nueva versión con el nuevo contenido combinado. |
|
DocumentIdToAppend
|
DocumentIdToAppend | True | string |
Identificadores de documento que se anexarán (combinados) en el primer punto y coma separados, es decir, '77b3c69d-7a9a-4083-9d75-83a5e6f3deca; 82514f19-057c-484f-8ee2-c21df811a928' |
|
ForceUndoCheckout
|
ForceUndoCheckout | boolean |
Deshaga una desprotección en el primer documento PDF, según sea necesario. Valor predeterminado = false |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string |
Nombre del documento |
|
id
|
id | string |
Id. de documento |
|
versionId
|
versionId | string |
Id. de versión del documento |
|
currentVersionId
|
currentVersionId | string |
Documento del identificador de versión actual |
|
protectionDomainId
|
protectionDomainId | string |
Identificador de dominio de protección de documentos |
|
infoStoreId
|
infoStoreId | string |
Identificador de InfoStore |
|
checkOutStateEnum
|
checkOutStateEnum | string |
Enumeración de estado de des check out |
|
checkOutUserId
|
checkOutUserId | string |
Desproteger el identificador de usuario |
|
Propiedades
|
properties | array of object |
Propiedades |
|
propertyTypeId
|
properties.propertyTypeId | string |
PropertyType Id |
|
values
|
properties.values | array of string |
Valores PropertyType |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultura
|
properties.globalValues.values.culture | string |
Referencia cultural de valores globales |
|
texto
|
properties.globalValues.values.text | string |
Texto de valores globales |
|
propertyTypeName
|
properties.propertyTypeName | string |
Nombre propertyType |
|
propertyName
|
properties.propertyName | string |
Nombre de propiedad |
|
importTemplateId
|
importTemplateId | string |
Importar identificador de plantilla |
|
blogs
|
blogs | array of object |
Blogs |
|
fecha de creación
|
blogs.createdDate | string |
Fecha de creación del blog |
|
creatorId
|
blogs.creatorId | string |
Identificador del creador del blog |
|
texto
|
blogs.text | string |
Texto del blog |
|
id
|
blogs.id | string |
Id. de blog |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
Lista de enumeraciones de derechos de acceso |
|
Recordatorios
|
reminders | array of |
Recordatorios |
|
pageCount
|
pageCount | integer |
Recuento de páginas |
|
mainFileLength
|
mainFileLength | integer |
Longitud del archivo principal |
|
abonnements
|
abonnements | array of |
Abonnements |
|
textAnnotations
|
annotationManager.textAnnotations | array of |
Anotaciones de texto |
|
rectánguloAnnotations
|
annotationManager.rectangleAnnotations | array of |
Anotaciones de rectángulo |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of |
Anotaciones PostIt |
|
stampAnnotations
|
annotationManager.stampAnnotations | array of |
Anotaciones de sello |
|
documentData
|
documentData | array of object |
Datos del documento |
|
id
|
documentData.id | string |
Id. de datos del documento |
|
nombre
|
documentData.name | string |
Nombre de datos del documento |
|
Copias
|
documentData.renditions | array of object |
Copias |
|
id
|
documentData.renditions.id | string |
Id. de representación |
|
size
|
documentData.renditions.size | string |
Tamaño de la representación |
|
files
|
documentData.renditions.files | array of object |
Archivos de representación |
|
blobStoreId
|
documentData.renditions.files.blobStoreId | string |
Identificador del almacén de blobs de representación |
|
blobPath
|
documentData.renditions.files.blobPath | string |
Ruta de acceso del blob de representación |
|
pageCount
|
documentData.renditions.pageCount | string |
Recuento de páginas de representación |
|
extensión
|
documentData.renditions.extension | string |
Extensión de representación |
|
hashValue
|
documentData.renditions.hashValue | array of integer |
Valor hash de representación |
|
contentProtections
|
documentData.renditions.contentProtections | array of |
Protecciones de contenido de representación |
|
signingProfileId
|
signingProfileId | string |
Identificador de perfil de firma |
|
lifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Identificador del ciclo de vida |
|
lifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Identificador de estado del ciclo de vida |
|
lifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Fecha de inicio del ciclo de vida |
|
lifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Fecha de finalización del ciclo de vida |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of |
Estados del ciclo de vida siguiente |
|
checkOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Consulte el identificador de estado del ciclo de vida. |
|
nextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Siguiente identificador de estado del ciclo de vida automático |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
Protecciones del ciclo de vida |
|
id
|
lifeCycleManager.lifeCycleProtections.id | string |
Identificador de protección del ciclo de vida |
|
protectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Tics de duración de la protección del ciclo de vida |
|
protectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Protección del ciclo de vida desproteger |
|
protectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Cambio de contenido de protección del ciclo de vida |
|
protectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Cambio de propiedad de protección del ciclo de vida |
|
protectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Cambio de anotación de protección del ciclo de vida |
|
protectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Cambio de dominio de protección del ciclo de vida |
|
protectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Eliminación de la protección del ciclo de vida |
|
deleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Eliminación de la protección del ciclo de vida después de la expiración |
|
hasOverlay
|
hasOverlay | boolean |
Tiene superposición |
|
sessionCount
|
sessionCount | integer |
Recuento de sesiones |
|
hasSignature
|
hasSignature | boolean |
Tiene firma |
|
hasBlog
|
hasBlog | boolean |
Tiene blog |
|
hasAnnotation
|
hasAnnotation | boolean |
Tiene anotación |
|
hasTempAccess
|
hasTempAccess | boolean |
Tiene acceso temporal |
|
hasReminders
|
hasReminders | boolean |
Tiene recordatorios |
|
hasLinks
|
hasLinks | boolean |
Tiene vínculos |
|
hasAbonnement
|
hasAbonnement | boolean |
Tiene abonnement |
Creación de una tabla de usuario
Creación de una tabla de usuario
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
UserTable
|
UserTable | True | string |
Nombre de la tabla de usuario (por ejemplo: Dirección) |
|
ColumnHeaders
|
ColumnHeaders | True | string |
Una lista de encabezados de columna (por ejemplo: Firstname,Lastname,City) |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Tabla de usuarios
|
userTable | string |
Nombre de la tabla de usuario |
Crear documento (en desuso) [EN DESUSO]
Crear documento (en desuso)
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
DocumentTitle
|
DocumentTitle | True | string |
Título del documento (incl. extensión) |
|
ImportTemplate
|
ImportTemplate | True | string |
Importar plantilla |
|
DocumentProperties
|
DocumentProperties | string |
Formato de inserción de propiedades del documento: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
Cultura
|
Culture | string |
Referencia cultural en la que se proporcionan los nombres de propiedad (de, en, fr, ...). Valor predeterminado = de |
|
|
FileContent
|
FileContent | True | string |
Cadena base64 de contenido del archivo |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
abonnements
|
abonnements | array of string |
abonnements |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of object |
postItAnnotations |
|
CreatedDate
|
annotationManager.postItAnnotations.createdDate | string |
Fecha de creación a partir de la anotación posterior |
|
CreatorId
|
annotationManager.postItAnnotations.creatorId | string |
Identificador de usuario del creador de la anotación post it |
|
IsItalic
|
annotationManager.postItAnnotations.fontInfo.isItalic | boolean |
¿Tiene cursiva de fuente la anotación post-it? |
|
IsStrikeOut
|
annotationManager.postItAnnotations.fontInfo.isStrikeOut | boolean |
¿La fuente sale de la anotación de publicación? |
|
IsUnderline
|
annotationManager.postItAnnotations.fontInfo.isUnderline | boolean |
¿La fuente se subraya desde la anotación posterior? |
|
Nombre
|
annotationManager.postItAnnotations.fontInfo.name | string |
Nombre de fuente de la anotación post it. Valor predeterminado = Arial |
|
Inclinación
|
annotationManager.postItAnnotations.fontInfo.pitch | integer |
Tono de fuente de la anotación post it |
|
Tamaño
|
annotationManager.postItAnnotations.fontInfo.size | integer |
Tamaño de fuente de la anotación post it. Ejemplo: Size:12 es 12000. Necesita factor 1000 |
|
Weight
|
annotationManager.postItAnnotations.fontInfo.weight | integer |
Peso de fuente de la anotación post it |
|
Id
|
annotationManager.postItAnnotations.id | string |
Identificador de la anotación post it |
|
ModifiedDate
|
annotationManager.postItAnnotations.modifiedDate | string |
Fecha de modificación de la anotación post it. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.postItAnnotations.pageNumber | integer |
Número de páginas de la anotación post it |
|
SecurityLevelEnum
|
annotationManager.postItAnnotations.securityLevelEnum | string |
Nivel de seguridad para la anotación post it (PublicAvailable, Personal, PersonalProtected, OnlyEditors). Valor predeterminado = Públicamente disponible |
|
Seleccionable
|
annotationManager.postItAnnotations.selectable | boolean |
Define si el usuario puede seleccionar la anotación después de publicarla. |
|
Mensaje de texto
|
annotationManager.postItAnnotations.text | string |
Texto definido por el usuario para publicarla anotación |
|
X
|
annotationManager.postItAnnotations.x | integer |
Coordenada X en píxel por pulgada para 7200 PPP de anotación post it |
|
S
|
annotationManager.postItAnnotations.y | integer |
Coordenada Y en píxel por pulgada para 7200 PPP de anotación post it |
|
rectánguloAnnotations
|
annotationManager.rectangleAnnotations | array of object |
rectánguloAnnotations |
|
Color
|
annotationManager.rectangleAnnotations.color | integer |
Color del rectángulo (valor ARGB de 32 bits) de la anotación rectángulo Ejemplo: Negro: -16777216 Blanco: -1 Rojo: -65536 Verde: -16744448 Azul: -16776961 |
|
ColorHexCode
|
annotationManager.rectangleAnnotations.colorHexCode | string |
Color del rectángulo (código hexadecimal RGB) de la anotación de rectángulo. Ejemplo: Negro: #000000 Blanco: #FFFFFF Rojo: #FF0000 Verde: #008000 Azul: #0000FF |
|
CreatedDate
|
annotationManager.rectangleAnnotations.createdDate | string |
Fecha de creación de la anotación de rectángulo. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
creatorId
|
annotationManager.rectangleAnnotations.creatorId | string |
CreatorId |
|
Altura
|
annotationManager.rectangleAnnotations.height | integer |
Alto del rectángulo en píxel por pulgada para 7200 PPP |
|
Id
|
annotationManager.rectangleAnnotations.Id | string |
Identificador de la anotación de rectángulo |
|
ModifiedDate
|
annotationManager.rectangleAnnotations.modifiedDate | string |
Fecha de modificación de la anotación de rectángulo. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.rectangleAnnotations.pageNumber | integer |
Número de páginas de la anotación de rectángulo |
|
SecurityLevelEnum
|
annotationManager.rectangleAnnotations.securityLevelEnum | string |
Nivel de seguridad para la anotación de rectángulo (Públicamente Disponible, Personal, PersonalProtected, OnlyEditors). Valor predeterminado = Públicamente disponible |
|
Seleccionable
|
annotationManager.rectangleAnnotations.selectable | boolean |
Define si el usuario puede seleccionar la anotación de rectángulo. |
|
Transparent
|
annotationManager.rectangleAnnotations.transparent | boolean |
El rectángulo debe ser transparente (resaltado) |
|
Ancho
|
annotationManager.rectangleAnnotations.width | integer |
Ancho del rectángulo en píxel por pulgada para 7200 PPP |
|
X
|
annotationManager.rectangleAnnotations.x | integer |
Coordenada X en píxel por pulgada para 7200 PPP de anotación de rectángulo |
|
S
|
annotationManager.rectangleAnnotations.y | integer |
Coordenada Y en píxel por pulgada para 7200 PPP de anotación de rectángulo |
|
textAnnotations
|
annotationManager.textAnnotations | array of object |
textAnnotations |
|
BackgroundColor
|
annotationManager.textAnnotations.backgroundColor | integer |
Color de fondo (valor ARGB de 32 bits) de la anotación de texto Ejemplo: Negro: -16777216 Blanco: -1 Rojo: -65536 Verde: -16744448 Azul: -16776961 |
|
BackgroundColorHexCode
|
annotationManager.textAnnotations.backgroundColorHexCode | string |
Color de fondo (código hexadecimal RGB) de la anotación de texto Ejemplo: Negro: #000000 Blanco: #FFFFFF Rojo: #FF0000 Verde: #008000 Azul: #0000FF |
|
CreatedDate
|
annotationManager.textAnnotations.createdDate | string |
fecha de creación a partir de la anotación de texto. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CreatorId
|
annotationManager.textAnnotations.creatorId | string |
Identificador de usuario del creador de la anotación de texto |
|
IsItalic
|
annotationManager.textAnnotations.fontInfo.isItalic | boolean |
¿Es la letra cursiva de la anotación de texto? |
|
IsStrikeOut
|
annotationManager.textAnnotations.fontInfo.isStrikeOut | boolean |
¿La fuente sale de la anotación de texto? |
|
IsUnderline
|
annotationManager.textAnnotations.fontInfo.isUnderline | boolean |
Es el subrayado de fuente de la anotación de texto. |
|
Nombre
|
annotationManager.textAnnotations.fontInfo.name | string |
Nombre de fuente de la anotación de texto. Valor predeterminado = Arial |
|
Inclinación
|
annotationManager.textAnnotations.fontInfo.pitch | integer |
Tono de fuente de la anotación de texto |
|
Tamaño
|
annotationManager.textAnnotations.fontInfo.size | integer |
Tamaño de fuente de la anotación de texto. Ejemplo: Size:12 es 12000. Necesita factor 1000 |
|
Weight
|
annotationManager.textAnnotations.fontInfo.weight | integer |
Peso de fuente de la anotación de texto |
|
ForegroundColor
|
annotationManager.textAnnotations.foregroundColor | integer |
Color del primer plano (valor ARGB de 32 bits) de la anotación de texto. Ejemplo: Negro: blanco -16777216: -1 rojo: -65536 verde: -16744448 azul: -16776961 |
|
ForegroundColorHexCode
|
annotationManager.textAnnotations.foregroundColorHexCode | string |
Color de primer plano (código hexadecimal RGB) de la anotación de texto. Ejemplo: Negro: #000000 Blanco: #FFFFFF Rojo: #FF0000 Verde: #008000 Azul: #0000FF |
|
Altura
|
annotationManager.textAnnotations.height | integer |
Alto del texto en píxel por pulgada para 7200 PPP de anotación de texto |
|
Id
|
annotationManager.textAnnotations.id | string |
Id. de anotación de texto |
|
ModifiedDate
|
annotationManager.textAnnotations.modifiedDate | string |
Fecha de modificación de la anotación de texto. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.textAnnotations.pageNumber | integer |
Número de páginas de anotación de texto |
|
Rotation
|
annotationManager.textAnnotations.rotation | integer |
Rotación en grados de anotación de texto |
|
SecurityLevelEnum
|
annotationManager.textAnnotations.securityLevelEnum | string |
Nivel de seguridad para la anotación de texto (Públicamente Disponible, Personal, PersonalProtected, OnlyEditors). Valor predeterminado = Públicamente disponible |
|
Seleccionable
|
annotationManager.textAnnotations.selectable | boolean |
Define si el usuario puede seleccionar la anotación de texto. |
|
Mensaje de texto
|
annotationManager.textAnnotations.text | string |
Texto definido por el usuario de la anotación de texto |
|
Transparent
|
annotationManager.textAnnotations.transparent | boolean |
La anotación de texto debe ser transparente |
|
Ancho
|
annotationManager.textAnnotations.width | integer |
Ancho del texto en píxel por pulgada para 7200 PPP de anotación de texto |
|
X
|
annotationManager.textAnnotations.x | integer |
Coordenada X en píxel por pulgada para 7200 PPP de anotación de texto |
|
S
|
annotationManager.textAnnotations.y | integer |
Coordenada Y en píxel por pulgada para 7200 PPP de anotación de texto |
|
blogs
|
blogs | array of object |
blogs |
|
Blogs
|
blogs | object |
Lista de todos los elementos de blog |
|
CheckOutState
|
checkOutStateEnum | string |
Desproteger el estado del documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
Identificador del usuario para el que se desprotegió el documento |
|
documentData
|
documentData | array of object |
documentData |
|
Id
|
documentData.id | string |
Identificador de la representación de documentos |
|
Nombre
|
documentData.name | string |
Nombre del documento de la representación |
|
Copias
|
documentData.renditions | array of |
Copias |
|
HasOverlay
|
hasOverlay | boolean |
Define si el documento debe mostrarse con una superposición. |
|
Id
|
id | string |
Id. del documento |
|
ImportTemplateId
|
importTemplateId | string |
Identificador de la plantilla de importación de este documento |
|
InfoStoreId
|
infoStoreId | string |
Identificador del almacén de información |
|
CheckOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Estado del ciclo de vida de desprotección |
|
LifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Fecha de finalización calculada del ciclo de vida. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Fecha de inicio del ciclo de vida. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Identificador del estado LifeCycle |
|
NextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Siguiente estado de ciclo de vida automático |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of string |
nextLifeCycleStates |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
lifeCycleProtections |
|
DeleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Permitir eliminar el documento después de la expiración de la protección |
|
Id
|
lifeCycleManager.lifeCycleProtections.id | string |
Id. de protección de estado del ciclo de vida |
|
ProtectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Protección contra los cambios de anotación |
|
ProtectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Protección contra la des check out |
|
ProtectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Protección contra el cambio de contenido |
|
ProtectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Protección contra la eliminación |
|
ProtectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Protección contra los cambios de propiedad |
|
ProtectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Protección contra el cambio de seguridad |
|
ProtectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Duración de la protección |
|
LifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Id. de LifeCycle |
|
MainFileLength
|
mainFileLength | integer |
Tamaño del archivo principal |
|
Nombre
|
name | string |
Nombre del documento |
|
PageCount
|
pageCount | integer |
Recuento de páginas del archivo principal |
|
Propiedades
|
properties | array of object |
Propiedades |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultura
|
properties.globalValues.values.culture | string |
Cultura |
|
texto
|
properties.globalValues.values.text | string |
Mensaje de texto |
|
PropertyTypeId
|
properties.propertyTypeId | string |
Identificador de tipo del campo de índice |
|
values
|
properties.values | array of string |
Valores PropertyType |
|
ProtectionDomainId
|
protectionDomainId | string |
Identificador del dominio de protección |
|
Recordatorios
|
reminders | array of object |
Recordatorios |
|
Recordatorios
|
reminders | object |
Lista de todos los recordatorios |
|
SessionCount
|
sessionCount | integer |
Recuento de sesiones |
|
SigningProfileId
|
signingProfileId | string |
Identificador del perfil de firma |
|
VersionId
|
versionId | string |
Identificador de versión del documento |
Crear documento (V2)
Crear documento (V2)
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
DocumentTitle
|
DocumentTitle | True | string |
Título del documento (incl. extensión) |
|
ImportTemplate
|
ImportTemplate | string |
Importe el nombre o el identificador de la plantilla, si están vacíos, se deben proporcionar los valores InfoStore y ProtectionDomain. |
|
|
DocumentProperties
|
DocumentProperties | string |
Formato de inserción de propiedades del documento: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
Blog
|
Blog | string |
Agregar una entrada de texto de blog en el documento |
|
|
Cultura
|
Culture | string |
Referencia cultural en la que se proporcionan los nombres de propiedad (de, en, fr, ...). Valor predeterminado = de |
|
|
InfoStore
|
InfoStore | string |
Se debe proporcionar el nombre o el identificador de InfoStore si ImportTemplate está vacío. |
|
|
LifeCycle
|
LifeCycle | string |
Nombre o identificador de LifeCycle |
|
|
ProtectionDomain
|
ProtectionDomain | string |
Se debe proporcionar el nombre o el identificador de ProtectionDomain si ImportTemplate está vacío. |
|
|
UploadMethod
|
UploadMethod | string |
Método usado para cargar el documento en InfoShare. Default = UploadFileBytesLarge |
|
|
OriginalFileFormat
|
OriginalFileFormat | string |
Formato de archivo original para la conversión, por ejemplo, "html". Convertido a pdf |
|
|
ChunkSize
|
ChunkSize | integer |
Tamaño del fragmento de carga de archivos usado con los métodos uploadStreamChunks y UploadFileBytesLarge, valor predeterminado |
|
|
FileContent
|
FileContent | True | string |
Cadena base64 de contenido del archivo |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string |
nombre |
|
id
|
id | string |
Id. de documento |
|
versionId
|
versionId | string |
Id. de versión |
|
currentVersionId
|
currentVersionId | string |
Identificador de versión actual |
|
protectionDomainId
|
protectionDomainId | string |
Identificador de dominio de protección |
|
infoStoreId
|
infoStoreId | string |
Identificador de InfoStore |
|
checkOutStateEnum
|
checkOutStateEnum | string |
Desproteger el estado del documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
checkOutUserId
|
checkOutUserId | string |
Identificador de usuario desprotegido |
|
Propiedades
|
properties | array of object |
Propiedades |
|
propertyTypeId
|
properties.propertyTypeId | string |
PropertyType Id |
|
values
|
properties.values | array of string |
Valores PropertyType |
|
globalValues
|
properties.globalValues | array of object |
Valores globales |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultura
|
properties.globalValues.values.culture | string |
Referencia cultural de valor global |
|
texto
|
properties.globalValues.values.text | string |
Texto del valor global |
|
propertyTypeName
|
properties.propertyTypeName | string |
Nombre propertyType |
|
propertyName
|
properties.propertyName | string |
Nombre de propiedad |
|
importTemplateId
|
importTemplateId | string |
Importar identificador de plantilla |
|
blogs
|
blogs | array of object |
blogs |
|
fecha de creación
|
blogs.createdDate | string |
Fecha de creación del blog |
|
creatorId
|
blogs.creatorId | string |
Identificador del creador del blog |
|
texto
|
blogs.text | string |
Texto del blog |
|
id
|
blogs.id | string |
Identificador del blog |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
Recordatorios
|
reminders | array of |
Recordatorios |
|
pageCount
|
pageCount | integer |
Recuento de páginas |
|
mainFileLength
|
mainFileLength | integer |
Longitud del archivo principal |
|
abonnements
|
abonnements | array of |
Abonnements |
|
textAnnotations
|
annotationManager.textAnnotations | array of |
Texto de anotaciones |
|
rectánguloAnnotations
|
annotationManager.rectangleAnnotations | array of |
Rectángulo de anotaciones |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of |
Anotaciones después de publicarla |
|
stampAnnotations
|
annotationManager.stampAnnotations | array of |
Marca de anotaciones |
|
documentData
|
documentData | array of object |
Datos del documento |
|
id
|
documentData.id | string |
Id. de datos del documento |
|
nombre
|
documentData.name | string |
Nombre de datos del documento |
|
Copias
|
documentData.renditions | array of object |
Copias |
|
id
|
documentData.renditions.id | string |
Id. de representación |
|
size
|
documentData.renditions.size | string |
Tamaño de la representación |
|
files
|
documentData.renditions.files | array of object |
files |
|
blobStoreId
|
documentData.renditions.files.blobStoreId | string |
Identificador del almacén de blobs |
|
blobPath
|
documentData.renditions.files.blobPath | string |
Ruta de acceso del blob |
|
pageCount
|
documentData.renditions.pageCount | string |
Recuento de páginas de representación |
|
extensión
|
documentData.renditions.extension | string |
Extensión de representación |
|
hashValue
|
documentData.renditions.hashValue | array of integer |
Valor hash de representación |
|
contentProtections
|
documentData.renditions.contentProtections | array of |
Protecciones de contenido de representación |
|
signingProfileId
|
signingProfileId | string |
Identificador de perfil de firma |
|
lifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Identificador del ciclo de vida |
|
lifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Identificador de estado del ciclo de vida |
|
lifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Fecha de inicio del ciclo de vida |
|
lifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Fecha de finalización del ciclo de vida |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of |
Estados del ciclo de vida siguiente |
|
checkOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Consulte el identificador de estado del ciclo de vida. |
|
nextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Siguiente identificador de estado del ciclo de vida automático |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
Protecciones del ciclo de vida |
|
id
|
lifeCycleManager.lifeCycleProtections.id | string |
Identificador de protección del ciclo de vida |
|
protectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Tics de duración de la protección del ciclo de vida |
|
protectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Protección del ciclo de vida |
|
protectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Protección del ciclo de vida del cambio de contenido |
|
protectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Cambio de propiedad de protección del ciclo de vida |
|
protectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Cambio de anotación de protección del ciclo de vida |
|
protectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Cambio del dominio de protección del ciclo de vida |
|
protectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Eliminación de protección del ciclo de vida |
|
deleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Eliminación del ciclo de vida después de la expiración |
|
hasOverlay
|
hasOverlay | boolean |
Tiene superposición |
|
sessionCount
|
sessionCount | integer |
Recuento de sesiones |
|
hasSignature
|
hasSignature | boolean |
Tiene firma |
|
hasBlog
|
hasBlog | boolean |
Tiene blog |
|
hasAnnotation
|
hasAnnotation | boolean |
Tiene anotación |
|
hasTempAccess
|
hasTempAccess | boolean |
Tiene acceso temporal |
|
hasReminders
|
hasReminders | boolean |
Tiene recordatorios |
|
hasLinks
|
hasLinks | boolean |
Tiene vínculos |
|
hasAbonnement
|
hasAbonnement | boolean |
Tiene abonnement |
Crear proceso
Crear proceso
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
ProcessProperties
|
ProcessProperties | string |
Formato de actualización de propiedades de proceso: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
CustomProperties
|
CustomProperties | string |
Propiedades personalizadas. Formato: [<PropertyName>|<PropertyValue>|PropertyType] (por ejemplo, [Proveedor|Muster|String][InvoiceDate|2021-01-29T13:05:45 |Fecha][InvoiceNo|4711|Número]) |
|
|
DocumentIds
|
DocumentIds | string |
Lista de todos los identificadores de documento que se van a adjuntar |
|
|
ProcessTemplateName
|
ProcessTemplateName | True | string |
Nombre de la plantilla de proceso |
|
Fecha de vencimiento
|
DueDate | string |
Fecha de vencimiento del proceso. Formato de fecha: aaaa-MM-ddTHH:mm:ss. Valor predeterminado = fecha actual |
|
|
Priority
|
Priority | string |
Prioridad del proceso (por ejemplo, Baja, Normal, Alta). Valor predeterminado = Normal |
|
|
Comentario
|
Comment | string |
Procesar comentario |
|
|
Cultura
|
Culture | string |
Referencia cultural en la que se da el texto (de, en, fr, ...). Valor predeterminado = de |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutState
|
checkOutStateEnum | string |
Desproteger el estado del documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
Identificador del usuario para el que se desprotegió el proceso |
|
comments
|
comments | array of object |
comments |
|
Fecha
|
comments.date | string |
Fecha de comentario |
|
Id
|
comments.id | string |
Identificador del comentario |
|
Mensaje de texto
|
comments.text | string |
Comentario definido por el usuario |
|
UserId
|
comments.userId | string |
ID de usuario |
|
CompletedDate
|
completedDate | string |
Fecha de finalización. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
completedTasks
|
completedTasks | array of string |
completedTasks |
|
CreatedDate
|
createdDate | string |
Fecha de creación. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
Acción
|
currentTask.action | string |
Texto de acción para el usuario. Se muestra al usuario final |
|
assignedUserIds
|
currentTask.assignedUserIds | array of string |
assignedUserIds |
|
comments
|
currentTask.comments | array of string |
comments |
|
CompletedDate
|
currentTask.completedDate | string |
Fecha de finalización de la tarea actual. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
completedUserIds
|
currentTask.completedUserIds | array of string |
completedUserIds |
|
CreatedDate
|
currentTask.createdDate | string |
Fecha de creación de la tarea actual. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CreatorId
|
currentTask.creatorId | string |
Identificador de usuario del creador de la tarea actual |
|
Description
|
currentTask.description | string |
Descripción de la tarea actual |
|
Fecha de vencimiento
|
currentTask.dueDate | string |
Fecha de vencimiento de la tarea actual. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
intendedUserIds
|
currentTask.intendedUserIds | array of string |
intendedUserIds |
|
ReminderDate
|
currentTask.reminderDate | string |
Fecha para recordar la tarea actual. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
RequireAllRecipients
|
currentTask.requiresAllRecipients | boolean |
Define si todos los destinatarios tienen que cerrar esta tarea. |
|
ShowCloseTaskDialog
|
currentTask.showCloseTaskDialog | boolean |
Mostrar cuadro de diálogo cerrar tarea al final de la tarea |
|
StatusEnum
|
currentTask.statusEnum | string |
Tarea actual de estado (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
currentTask.taskTemplateId | string |
Identificador de plantilla de la tarea actual |
|
customProperties
|
customProperties | array of object |
customProperties |
|
CustomPropertyTypeEnum
|
customProperties.customPropertyTypeEnum | string |
Valor de enumeración de tipo de propiedad personalizada (String, Date, Number) |
|
Nombre
|
customProperties.name | string |
Nombre de la propiedad personalizada |
|
Importancia
|
customProperties.value | string |
Valor de la propiedad personalizada |
|
documentIds
|
documentIds | array of string |
documentIds |
|
Fecha de vencimiento
|
dueDate | string |
Fecha de vencimiento del proceso. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
FolderElementId
|
folderElementId | string |
Identificador del documento como elemento folder |
|
HasLinks
|
hasLinks | boolean |
Identificador del documento como elemento folder |
|
Id
|
id | string |
Id. de proceso |
|
values
|
name.values | array of object |
values |
|
Cultura
|
name.values.culture | string |
Referencia cultural en la que se da el texto (de, en, fr, ...) |
|
Mensaje de texto
|
name.values.text | string |
Texto de este idioma |
|
PriorityEnum
|
priorityEnum | string |
Prioridad del proceso (Alto, Normal, Bajo). Valor predeterminado = Normal |
|
PluginStream
|
pluginStream | string | |
|
ProcessTemplateId
|
processTemplateId | string |
Id. de plantilla de proceso |
|
Propiedades
|
properties | array of object |
Propiedades |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultura
|
properties.globalValues.values.culture | string |
cultura |
|
texto
|
properties.globalValues.values.text | string |
texto |
|
nombre de la propiedad
|
properties.propertyName | string |
Nombre de la propiedad process |
|
PropertyTypeId
|
properties.propertyTypeId | string |
Identificador de la propiedad process |
|
values
|
properties.values | array of string |
values |
|
ProtectionDomainId
|
protectionDomainId | string |
Identificador de dominio de protección del proceso |
|
StatusEnum
|
statusEnum | string |
Estado del proceso (Open, InProcess, Complete, PreparedToComplete, Error) |
Eliminación de filas de tabla de usuario
Eliminación de filas de tabla de usuario
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
UserTable
|
UserTable | True | string |
Nombre de la tabla de usuario |
|
WhereClause
|
WhereClause | string |
Una lista de SQL donde los elementos de la cláusula . Formato: [<PropertyName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,NotLike" RelationEnums:"AND,OR" (por ejemplo, [Firstname|Equals|Jon|AND],[Apellido|Equals|Doe|OR]) |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
userTableDeleteRecordsResult
|
userTableDeleteRecordsResult | integer |
userTableDeleteRecordsResult |
Enumerar procesos (en desuso) [EN DESUSO]
Enumerar procesos (en desuso)
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
Receptor
|
Receiver | string |
Nombres de inicio de sesión de receptores de procesos (por ejemplo, john@sample.com|megan@sample.com). Está vacío, el usuario que ha iniciado sesión se tomará como receptor |
|
|
Estado
|
Status | string |
Estado del proceso. Valor predeterminado = abrir |
|
|
IgnoreReceiver
|
IgnoreReceiver | boolean |
Si es así, se enumeran todos los procesos indipendent del receptor. Valor predeterminado = false |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Número máximo de resultados de búsqueda de procesos. Valor predeterminado = 100 |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
processes
|
processes | array of object |
processes |
|
accessRightsEnumList
|
processes.accessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
processes.checkOutStateEnum | string |
Desproteger el estado del proceso (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
processes.checkOutUserId | string |
Identificador del usuario para el que se desprotegió el documento |
|
comments
|
processes.comments | array of object |
comments |
|
Fecha
|
processes.comments.date | string |
Fecha de comentario |
|
Id
|
processes.comments.id | string |
Identificador del comentario |
|
Mensaje de texto
|
processes.comments.text | string |
Comentario definido por el usuario |
|
UserId
|
processes.comments.userId | string |
Identificador del usuario, que ha establecido el comentario |
|
CompletedDate
|
processes.completedDate | string |
Fecha de finalización del proceso. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
completedTasks
|
processes.completedTasks | array of object |
completedTasks |
|
Acción
|
processes.completedTasks.action | string |
Texto de acción para el usuario. Se muestra al usuario final |
|
assignedUserIds
|
processes.completedTasks.assignedUserIds | array of |
assignedUserIds |
|
comments
|
processes.completedTasks.comments | array of object |
comments |
|
Fecha
|
processes.completedTasks.comments.date | string |
Fecha de comentario |
|
Id
|
processes.completedTasks.comments.id | string |
Identificador del comentario |
|
Mensaje de texto
|
processes.completedTasks.comments.text | string |
Comentario definido por el usuario |
|
UserId
|
processes.completedTasks.comments.userId | string |
Identificador del usuario, que ha establecido el comentario |
|
CompletedDate
|
processes.completedTasks.completedDate | string |
Fecha de finalización. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
completedUserIds
|
processes.completedTasks.completedUserIds | array of string |
completedUserIds |
|
CreatedDate
|
processes.completedTasks.createdDate | string |
Fecha de creación. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CreatorId
|
processes.completedTasks.creatorId | string |
Identificador de usuario del creador |
|
Description
|
processes.completedTasks.description | string |
Descripción de la tarea |
|
Fecha de vencimiento
|
processes.completedTasks.dueDate | string |
Fecha de vencimiento de la tarea. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
intendedUserIds
|
processes.completedTasks.intendedUserIds | array of |
intendedUserIds |
|
ReminderDate
|
processes.completedTasks.reminderDate | string |
Fecha de aviso. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
RequireAllRecipients
|
processes.completedTasks.requiresAllRecipients | boolean |
Define si todos los destinatarios tienen que cerrar esta tarea. |
|
ShowCloseTaskDialog
|
processes.completedTasks.showCloseTaskDialog | boolean |
Mostrar cuadro de diálogo cerrar tarea al final de la tarea |
|
Estado
|
processes.completedTasks.statusEnum | string |
Estado de la tarea (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
processes.completedTasks.taskTemplateId | string |
Id. de plantilla de tarea |
|
CreatedDate
|
processes.createdDate | string |
Fecha de creación del proceso. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CurrentTask
|
processes.currentTask | string |
Tarea activa actualmente |
|
CustomProperties
|
processes.customProperties | string |
Lista de todas las propiedades personalizadas |
|
DocumentIds
|
processes.documentIds | string |
Lista de todos los identificadores de documento adjuntos |
|
Fecha de vencimiento
|
processes.dueDate | string |
Fecha de vencimiento del formato de fecha del proceso: aaaa-MM-ddTHH:mm:ss |
|
FolderElementId
|
processes.folderElementId | string |
Identificador del proceso como elemento folder |
|
HasLinks
|
processes.hasLinks | boolean |
Marcar si el proceso tiene vínculos |
|
Id
|
processes.id | string |
Identificador del proceso |
|
values
|
processes.name.values | array of object |
values |
|
cultura
|
processes.name.values.culture | string |
cultura |
|
texto
|
processes.name.values.text | string |
texto |
|
PriorityEnum
|
processes.priorityEnum | string |
Prioridad del proceso (Alto, Normal, Bajo) |
|
PluginStream
|
processes.pluginStream | string |
Contenedor de datos para complementos |
|
ProcessTemplateId
|
processes.processTemplateId | string |
Id. de plantilla de proceso |
|
Propiedades
|
processes.properties | array of object |
Propiedades |
|
propertyName
|
processes.properties.propertyName | string |
propertyName |
|
propertyTypeId
|
processes.properties.propertyTypeId | string |
propertyTypeId |
|
values
|
processes.properties.values | array of string |
values |
|
ProtectionDomainId
|
processes.protectionDomainId | string |
Identificador de dominio de protección del proceso |
|
StatusEnum
|
processes.statusEnum | string |
Estado del proceso (Open, InProcess, Complete, PreparedToComplete, Error) |
|
HasMore
|
hasMore | boolean |
Indica si existen más resultados o no. La marca se establece en true si hay más resultados disponibles. |
|
ResumePoint
|
resumePoint | string |
Punto de reanudación de las operaciones de búsqueda anteriores. Establecer null para la primera operación de búsqueda |
Iniciar sesión
Iniciar sesión
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
Nombre de usuario
|
Username | True | string |
Nombre de usuario para el inicio de sesión |
|
Contraseña
|
Password | True | string |
Contraseña |
|
Nombre del inquilino
|
Tenantname | string |
Nombre del inquilino en el que iniciar sesión |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
ConnectionId
|
connectionId | string |
Contiene el identificador de conexión si ha iniciado sesión correctamente. |
|
ConnectionTimeoutSeconds
|
connectionTimeoutSeconds | integer |
Tiempo de espera de conexión |
|
IsApplicationLicence
|
isApplicationLicence | string |
Es el tipo de licencia de aplicación. |
|
IsConcurrentLicence
|
isConcurrentLicence | string |
Es el tipo de licencia simultánea |
|
IsNamedLicence
|
isNamedLicence | string |
Se denomina tipo de licencia. |
|
IsVerificationCodeNeeded
|
isVerificationCodeNeeded | string |
¿Es necesario el código de verificación? |
|
PossibleTwoWayAuthenticationType
|
possibleTwoWayAuthenticationType | string |
Posible tipo de autenticación bidireccional (None, Mail, SMS) |
|
TwoWayAuthenticationTargetMail
|
twoWayAuthenticationTargetMail | string |
La dirección de correo enmascarada donde twoWayAuthentication enviará correo a |
Inicio de sesión con contraseña con hash
Inicio de sesión con contraseña con hash
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
Nombre de usuario
|
userName | True | string |
Nombre de usuario para el inicio de sesión |
|
Contraseña con hash
|
passwordHashed | True | string |
Contraseña de usuario para el inicio de sesión (hash SHA 512 codificado en Base64) |
|
Nombre del inquilino
|
tenantName | string |
Nombre del inquilino en el que iniciar sesión |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
ConnectionId
|
LogonResult.ConnectionId | string |
Identificador de conexión para identificar la conexión |
|
ConnectionTimeoutSeconds
|
LogonResult.ConnectionTimeoutSeconds | integer |
Tiempo de espera de la conexión en segundos |
|
IsApplicationLicence
|
LogonResult.IsApplicationLicence | boolean |
Es el tipo de licencia de aplicación. |
|
IsConcurrentLicence
|
LogonResult.IsConcurrentLicence | boolean |
Es el tipo de licencia simultánea |
|
IsNamedLicence
|
LogonResult.IsNamedLicence | boolean |
Tipo de licencia con nombre |
|
IsVerificationCodeNeeded
|
LogonResult.IsVerificationCodeNeeded | boolean |
¿Es necesario el código de verificación? |
|
JWTToken
|
LogonResult.JWTToken | string |
Token JWT para esta conexión |
|
PossibleTwoWayAuthenticationType
|
LogonResult.PossibleTwoWayAuthenticationType | string |
Posible tipo de autenticación bidireccional (None, Mail, SMS) |
|
TwoWayAuthenticationTargetMail
|
LogonResult.TwoWayAuthenticationTargetMail | string |
La dirección de correo enmascarada donde twoWayAuthentication enviará correo a |
Insertar filas en una tabla de usuario
Importación de filas de tabla en una tabla de usuario
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
UserTable
|
UserTable | True | string |
Nombre de la tabla de usuario |
|
Valores
|
Values | True | string |
Lista de valores de fila y columna que se van a insertar (por ejemplo: [John; Coneja; Nueva York],[Peter; Reunir; Bern]) |
|
DeleteAllValues
|
DeleteAllValues | boolean |
Define si se van a eliminar todos los valores de UserTable (valor predeterminado = false) |
|
|
FirstRowContainsColumnHeaders
|
FirstRowContainsColumnHeaders | boolean |
Define si la primera fila del parámetro values contiene encabezados de columna (valor predeterminado = false) |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Tabla de usuarios
|
userTable | string |
Nombre de la tabla de usuario |
|
Filas insertadas
|
insertedRows | integer |
Número de filas insertadas |
Logoff
Logoff
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
LogoffResult
|
LogoffResult | string |
Resultado de logoff |
Obtención de documentos y procesos de selección
Obtener documentos y procesos seleccionados en el cliente web móvil a través de la acción del botón personalizado
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
SelectionId
|
SelectionId | True | string |
El identificador de selección de los documentos y procesos seleccionados en el cliente web móvil a través de la acción del botón personalizado |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador de selección |
|
id
|
parentObjectId.id | string |
Id. de lista del objeto primario en el cliente web móvil |
|
objectId
|
parentObjectId.objectId | string |
Id. de objeto primario (Documento, Proceso,...) |
|
objectTypeEnum
|
parentObjectId.objectTypeEnum | string |
ObjectTypeEnum del objeto primario: por ejemplo, Document, Process, ... |
|
objectIds
|
objectIds | array of object |
Documentos y procesos seleccionados en el cliente web móvil |
|
id
|
objectIds.id | string |
Id. de lista del cliente web móvil |
|
objectId
|
objectIds.objectId | string |
Id. de objeto del documento o proceso seleccionado en el cliente web móvil |
|
objectTypeEnum
|
objectIds.objectTypeEnum | string |
ObjectTypeEnum del documento o proceso seleccionado en el cliente web móvil |
|
allObjectIds
|
allObjectIds | array of object |
Documentos y procesos seleccionados y no seleccionados en el cliente web móvil |
|
id
|
allObjectIds.id | string |
Id. de lista del cliente web móvil |
|
objectId
|
allObjectIds.objectId | string |
Id. de objeto del documento o proceso seleccionados y no seleccionados en el cliente web móvil |
|
objectTypeEnum
|
allObjectIds.objectTypeEnum | string |
ObjectTypeEnum de documento o proceso seleccionados y no seleccionados en el cliente web móvil |
Obtención de filas de una tabla de usuario
Obtención de filas de una tabla de usuario
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
UserTable
|
UserTable | True | string |
Nombre de la tabla de usuario |
|
WhereClause
|
WhereClause | string |
Una lista de SQL donde los elementos de la cláusula . Formato: [<ColumnName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,NotLike" RelationEnums:"AND,OR" (por ejemplo, [Firstname|Equals|Jon|AND],[Apellido|Equals|Doe|AND]) |
|
|
OrderByClause
|
OrderByClause | string |
Lista de elementos de la cláusula order by de SQL (por ejemplo: Firstname[ASC],City[DESC]) |
|
|
AddColumnHeaders
|
AddColumnHeaders | boolean |
Agrega encabezados de columna como primera fila (valor predeterminado = false) |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
UserTableGetRecordsResult
|
UserTableGetRecordsResult | array of array |
UserTableGetRecordsResult |
|
items
|
UserTableGetRecordsResult | array of string |
Obtención de las propiedades del proceso
Obtención de las propiedades del proceso
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
ProcessId
|
ProcessId | True | string |
Identificador del proceso (Guid) |
|
Cultura
|
Culture | string |
Referencia cultural en la que se proporcionan los nombres de propiedad (de, en, fr, ...). Valor predeterminado = de |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
nombre de la propiedad
|
propertyName | string |
Nombre de la propiedad Process |
|
PropertyTypeId
|
propertyTypeId | string |
Id. de tipo de propiedad |
|
values
|
values | array of string |
values |
Obtención del contenido del archivo convertido
Convierta el contenido del archivo en un formato diferente. Agregar anotación o superposición al contenido del archivo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
DocumentId
|
DocumentId | True | string |
Id. del documento |
|
VersionId
|
VersionId | string |
Id. de versión (Guid)Id. de versión (Guid) |
|
|
DocumentDataId
|
DocumentDataId | string |
Id. de datos de documento (Guid) |
|
|
RenditionId
|
RenditionId | string |
Id. de representación de documentos (Guid) |
|
|
TargetFormat
|
TargetFormat | True | string |
Formato de destino (por ejemplo, "png;pdf; tif;...") |
|
AddAnnotations
|
AddAnnotatins | boolean |
Define si el documento se debe exportar con anotaciones. Valor predeterminado = sí |
|
|
AddOverlay
|
AddOverlay | boolean |
Define si el documento se debe exportar con superposiciones. Valor predeterminado = sí |
Devoluciones
Contenido de archivo convertido
- Contenido del archivo
- string
Obtener contenido de archivo
Obtener contenido de archivo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
DocumentId
|
DocumentId | True | string |
Id. del documento |
|
VersionId
|
VersionId | string |
Identificador de la versión (Guid) |
|
|
DocumentDataId
|
DocumentDataId | string |
Id. de datos de documento (Guid) |
|
|
RenditionId
|
RenditionId | string |
Id. de representación de documentos (Guid) |
|
|
IgnoreHashValidation
|
IgnoreHashValidation | boolean |
Omitir la configuración del sistema para la validación de hash. Valor predeterminado = sí |
Devoluciones
Contenido del archivo
- Contenido del archivo
- string
Obtener documento
Obtener documento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
Identificador de conexión para identificar la conexión |
|
DocumentId
|
documentId | True | string |
El identificador del documento |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Abonnements
|
GetDocumentResult.Abonnements | array of object |
Abonnements |
|
OnContentChange
|
GetDocumentResult.Abonnements.OnContentChange | boolean |
Abonnement está activo en los cambios de archivo |
|
OnDelete
|
GetDocumentResult.Abonnements.OnDelete | boolean |
Abonnement está activo al eliminar |
|
OnMetadataChange
|
GetDocumentResult.Abonnements.OnMetadataChange | boolean |
Abonnement está activo en los cambios de índice |
|
UserId
|
GetDocumentResult.Abonnements.UserId | string |
Identificador de usuario de este abonnnement |
|
AccessRightsEnumList
|
GetDocumentResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
PostItAnnotations
|
GetDocumentResult.AnnotationManager.PostItAnnotations | array of object |
PostItAnnotations |
|
CreatedDate
|
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatedDate | string |
Fecha de creación a partir de la anotación posterior |
|
CreatorId
|
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatorId | string |
Identificador de usuario del creador de la anotación post it |
|
IsItalic
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsItalic | boolean |
¿Tiene cursiva de fuente la anotación post-it? |
|
IsStrikeOut
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsStrikeOut | boolean |
¿La fuente sale de la anotación de publicación? |
|
IsUnderline
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsUnderline | boolean |
¿La fuente se subraya desde la anotación posterior? |
|
Nombre
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Name | string |
Nombre de fuente de la anotación post it. Valor predeterminado = Arial |
|
Inclinación
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Pitch | integer |
Tono de fuente de la anotación post it |
|
Tamaño
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Size | integer |
Tamaño de fuente de la anotación post it. Ejemplo: Size:12 es 12000. Necesita factor 1000 |
|
Weight
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Weight | integer |
Peso de fuente de la anotación post it |
|
Id
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Id | string |
Identificador de la anotación post it |
|
ModifiedDate
|
GetDocumentResult.AnnotationManager.PostItAnnotations.ModifiedDate | string |
Fecha de modificación de la anotación post it. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
PageNumber
|
GetDocumentResult.AnnotationManager.PostItAnnotations.PageNumber | integer |
Número de páginas de la anotación post it |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.PostItAnnotations.SecurityLevelEnum | string |
Nivel de seguridad para la anotación post it (PublicAvailable, Personal, PersonalProtected, OnlyEditors). Valor predeterminado = Públicamente disponible |
|
Seleccionable
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Selectable | boolean |
Define si el usuario puede seleccionar la anotación después de publicarla. |
|
Mensaje de texto
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Text | string |
Texto definido por el usuario para publicarla anotación |
|
X
|
GetDocumentResult.AnnotationManager.PostItAnnotations.X | integer |
Coordenada X en píxel por pulgada para 7200 PPP de anotación post it |
|
S
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Y | integer |
Coordenada Y en píxel por pulgada para 7200 PPP de anotación post it |
|
RectánguloAnnotations
|
GetDocumentResult.AnnotationManager.RectangleAnnotations | array of object |
RectánguloAnnotations |
|
Color
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Color | integer |
Color del rectángulo (valor ARGB de 32 bits) de la anotación de rectángulo. Ejemplo: Negro: blanco -16777216: -1 rojo: -65536 verde: -16744448 azul: -16776961 |
|
ColorHexCode
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.ColorHexCode | string |
Color del rectángulo (código hexadecimal RGB) de la anotación de rectángulo. Ejemplo: Negro: #000000 Blanco: #FFFFFF Rojo: #FF0000 Verde: #008000 Azul: #0000FF |
|
CreatedDate
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatedDate | string |
Fecha de creación de la anotación de rectángulo. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatorId | string |
CreatorId |
|
Altura
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Height | integer |
Alto del rectángulo en píxel por pulgada para 7200 PPP |
|
Id
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Id | string |
Identificador de la anotación de rectángulo |
|
ModifiedDate
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.ModifiedDate | string |
Fecha de modificación de la anotación de rectángulo. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
PageNumber
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.PageNumber | integer |
Número de páginas de la anotación de rectángulo |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.SecurityLevelEnum | string |
Nivel de seguridad para la anotación de rectángulo (Públicamente Disponible, Personal, PersonalProtected, OnlyEditors). Valor predeterminado = Públicamente disponible |
|
Seleccionable
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Selectable | boolean |
Define si el usuario puede seleccionar la anotación de rectángulo. |
|
Transparent
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Transparent | boolean |
El rectángulo debe ser transparente (resaltado) |
|
Ancho
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Width | integer |
Ancho del rectángulo en píxel por pulgada para 7200 PPP |
|
X
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.X | integer |
Coordenada X en píxel por pulgada para 7200 PPP de anotación de rectángulo |
|
S
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Y | integer |
Coordenada Y en píxel por pulgada para 7200 PPP de anotación de rectángulo |
|
TextAnnotations
|
GetDocumentResult.AnnotationManager.TextAnnotations | array of object |
TextAnnotations |
|
BackgroundColor
|
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColor | integer |
Color del fondo (valor ARGB de 32 bits) de la anotación de texto. Ejemplo: Negro: blanco -16777216: -1 rojo: -65536 verde: -16744448 azul: -16776961 |
|
BackgroundColorHexCode
|
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColorHexCode | string |
Color del fondo (código hexadecimal RGB) de la anotación de texto. Ejemplo: Negro: #000000 Blanco: #FFFFFF Rojo: #FF0000 Verde: #008000 Azul: #0000FF |
|
CreatedDate
|
GetDocumentResult.AnnotationManager.TextAnnotations.CreatedDate | string |
fecha de creación a partir de la anotación de texto. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.AnnotationManager.TextAnnotations.CreatorId | string |
Identificador de usuario del creador de la anotación de texto |
|
IsItalic
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsItalic | boolean |
¿Es la letra cursiva de la anotación de texto? |
|
IsStrikeOut
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsStrikeOut | boolean |
¿La fuente sale de la anotación de texto? |
|
IsUnderline
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsUnderline | boolean |
Es el subrayado de fuente de la anotación de texto. |
|
Nombre
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Name | string |
Nombre de fuente de la anotación de texto. Valor predeterminado = Arial |
|
Inclinación
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Pitch | integer |
Tono de fuente de la anotación de texto |
|
Tamaño
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Size | integer |
Tamaño de fuente de la anotación de texto. Ejemplo: Size:12 es 12000. Necesita factor 1000 |
|
Weight
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Weight | integer |
Peso de fuente de la anotación de texto |
|
ForegroundColor
|
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColor | integer |
Color del primer plano (valor ARGB de 32 bits) de la anotación de texto. Ejemplo: Negro: blanco -16777216: -1 rojo: -65536 verde: -16744448 azul: -16776961 |
|
ForegroundColorHexCode
|
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColorHexCode | string |
Color de primer plano (código hexadecimal RGB) de la anotación de texto. Ejemplo: Negro: #000000 Blanco: #FFFFFF Rojo: #FF0000 Verde: #008000 Azul: #0000FF |
|
Altura
|
GetDocumentResult.AnnotationManager.TextAnnotations.Height | integer |
Alto del texto en píxel por pulgada para 7200 PPP de anotación de texto |
|
Id
|
GetDocumentResult.AnnotationManager.TextAnnotations.Id | string |
Id. de anotación de texto |
|
ModifiedDate
|
GetDocumentResult.AnnotationManager.TextAnnotations.ModifiedDate | string |
Fecha de modificación de la anotación de texto. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
PageNumber
|
GetDocumentResult.AnnotationManager.TextAnnotations.PageNumber | integer |
Número de páginas de anotación de texto |
|
Rotation
|
GetDocumentResult.AnnotationManager.TextAnnotations.Rotation | integer |
Rotación en grados de anotación de texto |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.TextAnnotations.SecurityLevelEnum | string |
Nivel de seguridad para la anotación de texto (Públicamente Disponible, Personal, PersonalProtected, OnlyEditors). Valor predeterminado = Públicamente disponible |
|
Seleccionable
|
GetDocumentResult.AnnotationManager.TextAnnotations.Selectable | boolean |
Define si el usuario puede seleccionar la anotación de texto. |
|
Mensaje de texto
|
GetDocumentResult.AnnotationManager.TextAnnotations.Text | string |
Texto definido por el usuario de la anotación de texto |
|
Transparent
|
GetDocumentResult.AnnotationManager.TextAnnotations.Transparent | boolean |
La anotación de texto debe ser transparente |
|
Ancho
|
GetDocumentResult.AnnotationManager.TextAnnotations.Width | integer |
Ancho del texto en píxel por pulgada para 7200 PPP de anotación de texto |
|
X
|
GetDocumentResult.AnnotationManager.TextAnnotations.X | integer |
Coordenada X en píxel por pulgada para 7200 PPP de anotación de texto |
|
S
|
GetDocumentResult.AnnotationManager.TextAnnotations.Y | integer |
Coordenada Y en píxel por pulgada para 7200 PPP de anotación de texto |
|
Blogs
|
GetDocumentResult.Blogs | array of object |
Blogs |
|
CreatedDate
|
GetDocumentResult.Blogs.CreatedDate | string |
Fecha en la que se creó el blog. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.Blogs.CreatorId | string |
Identificador de usuario del blog de creación de usuarios |
|
Id
|
GetDocumentResult.Blogs.Id | string |
Identificador del blog |
|
Mensaje de texto
|
GetDocumentResult.Blogs.Text | string |
Texto del elemento de blog |
|
CheckOutStateEnum
|
GetDocumentResult.CheckOutStateEnum | string |
Desproteger el estado del documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
GetDocumentResult.CheckOutUserId | string |
Identificador del usuario para el que se desprotegió el documento |
|
DocumentData
|
GetDocumentResult.DocumentData | array of object |
DocumentData |
|
Id
|
GetDocumentResult.DocumentData.Id | string |
Identificador de la representación de documentos |
|
Nombre
|
GetDocumentResult.DocumentData.Name | string |
Nombre del documento de la representación |
|
Copias
|
GetDocumentResult.DocumentData.Renditions | array of object |
Copias |
|
ContentProtections
|
GetDocumentResult.DocumentData.Renditions.ContentProtections | array of |
ContentProtections |
|
Extension
|
GetDocumentResult.DocumentData.Renditions.Extension | string |
Extension |
|
Archivos
|
GetDocumentResult.DocumentData.Renditions.Files | array of object |
Archivos |
|
BlobPath
|
GetDocumentResult.DocumentData.Renditions.Files.BlobPath | string |
BlobPath |
|
BlobStoreId
|
GetDocumentResult.DocumentData.Renditions.Files.BlobStoreId | string |
BlobStoreId |
|
HashValue
|
GetDocumentResult.DocumentData.Renditions.HashValue | array of integer |
HashValue |
|
Id
|
GetDocumentResult.DocumentData.Renditions.Id | string |
Id |
|
PageCount
|
GetDocumentResult.DocumentData.Renditions.PageCount | integer |
PageCount |
|
Tamaño
|
GetDocumentResult.DocumentData.Renditions.Size | integer |
Tamaño |
|
HasOverlay
|
GetDocumentResult.HasOverlay | boolean |
Define si el documento debe mostrarse con una superposición. |
|
Id
|
GetDocumentResult.Id | string |
Id. del documento |
|
ImportTemplateId
|
GetDocumentResult.ImportTemplateId | string |
Identificador de la plantilla de importación de este documento |
|
InfoStoreId
|
GetDocumentResult.InfoStoreId | string |
Identificador del almacén de información |
|
CheckOutLifeCycleStateId
|
GetDocumentResult.LifeCycleManager.CheckOutLifeCycleStateId | string |
Estado del ciclo de vida de desprotección |
|
LifeCycleEndDate
|
GetDocumentResult.LifeCycleManager.LifeCycleEndDate | string |
Fecha de finalización calculada del ciclo de vida. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
GetDocumentResult.LifeCycleManager.LifeCycleStartDate | string |
Fecha de inicio del ciclo de vida. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
GetDocumentResult.LifeCycleManager.LifeCycleStateId | string |
Identificador del estado LifeCycle |
|
NextAutomaticLifeCycleStateId
|
GetDocumentResult.LifeCycleManager.NextAutomaticLifeCycleStateId | string |
Siguiente estado de ciclo de vida automático |
|
NextLifeCycleStates
|
GetDocumentResult.LifeCycleManager.NextLifeCycleStates | array of string |
NextLifeCycleStates |
|
LifeCycleProtections
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections | array of object |
LifeCycleProtections |
|
DeleteAfterExpiration
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.DeleteAfterExpiration | boolean |
Permitir eliminar el documento después de la expiración de la protección |
|
Id
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.Id | string |
Id. de protección de estado del ciclo de vida |
|
ProtectAnnotationChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectAnnotationChange | boolean |
Protección contra los cambios de anotación |
|
ProtectCheckOut
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectCheckOut | boolean |
Protección contra la des check out |
|
ProtectContentChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectContentChange | boolean |
Protección contra el cambio de contenido |
|
ProtectDelete
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectDelete | boolean |
Protección contra la eliminación |
|
ProtectPropertyChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectPropertyChange | boolean |
Protección contra los cambios de propiedad |
|
ProtectProtectionDomainChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectProtectionDomainChange | boolean |
Protección contra el cambio de seguridad |
|
ProtectionDurationTicks
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectionDurationTicks | integer |
Duración de la protección |
|
LifeCycleId
|
GetDocumentResult.LifeCycleManager.LifeCycleId | string |
Id. de LifeCycle |
|
MainFileLength
|
GetDocumentResult.MainFileLength | integer |
Tamaño del archivo principal |
|
Nombre
|
GetDocumentResult.Name | string |
Nombre del documento |
|
PageCount
|
GetDocumentResult.PageCount | integer |
Recuento de páginas del archivo principal |
|
Propiedades
|
GetDocumentResult.Properties | array of object |
Propiedades |
|
GlobalValues
|
GetDocumentResult.Properties.GlobalValues | array of object |
GlobalValues |
|
Valores
|
GetDocumentResult.Properties.GlobalValues.Values | array of object |
Valores |
|
Cultura
|
GetDocumentResult.Properties.GlobalValues.Values.Culture | string |
Cultura |
|
Mensaje de texto
|
GetDocumentResult.Properties.GlobalValues.Values.Text | string |
Mensaje de texto |
|
PropertyTypeId
|
GetDocumentResult.Properties.PropertyTypeId | string |
Identificador de tipo del campo de índice |
|
Valores
|
GetDocumentResult.Properties.Values | array of string |
Valores |
|
ProtectionDomainId
|
GetDocumentResult.ProtectionDomainId | string |
Identificador del dominio de protección |
|
Recordatorios
|
GetDocumentResult.Reminders | array of object |
Recordatorios |
|
Description
|
GetDocumentResult.Reminders.Description | string |
Descripción del aviso |
|
Intervalo
|
GetDocumentResult.Reminders.Interval | integer |
Intervalo en días entre recordatorios |
|
ProcessTemplateId
|
GetDocumentResult.Reminders.ProcessTemplateId | string |
Identificador de plantilla de proceso para este recordatorio |
|
ReminderDate
|
GetDocumentResult.Reminders.ReminderDate | string |
Fecha del aviso. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
ReminderId
|
GetDocumentResult.Reminders.ReminderId | string |
Identificador del aviso |
|
SubjectIds
|
GetDocumentResult.Reminders.SubjectIds | array of |
subjectIds |
|
UseUserFromProcessTemplate
|
GetDocumentResult.Reminders.UseUserFromProcessTemplate | boolean |
Define si se usará la definición de usuario de la plantilla de proceso. |
|
SessionCount
|
GetDocumentResult.SessionCount | integer |
Recuento de sesiones |
|
SigningProfileId
|
GetDocumentResult.SigningProfileId | string |
Identificador del perfil de firma |
|
VersionId
|
GetDocumentResult.VersionId | string |
Identificador de versión del documento |
Obtener proceso
Obtener proceso
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
Identificador de conexión para identificar la conexión |
|
ProcessId
|
processId | True | string |
Identificador del proceso (Guid) |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
AccessRightsEnumList
|
GetProcessResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
GetProcessResult.CheckOutStateEnum | string |
Desproteger el estado del documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
GetProcessResult.CheckOutUserId | string |
Identificador del usuario para el que se desprotegió el proceso |
|
Comentarios
|
GetProcessResult.Comments | array of object |
Comentarios |
|
Fecha
|
GetProcessResult.Comments.Date | string |
Fecha de comentario |
|
Id
|
GetProcessResult.Comments.Id | string |
Identificador del comentario |
|
Mensaje de texto
|
GetProcessResult.Comments.Text | string |
Comentario definido por el usuario |
|
UserId
|
GetProcessResult.Comments.UserId | string |
Identificador del usuario, que ha establecido el comentario |
|
CompletedDate
|
GetProcessResult.CompletedDate | string |
Fecha de finalización del proceso. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CompletedTasks
|
GetProcessResult.CompletedTasks | array of object |
CompletedTasks |
|
Acción
|
GetProcessResult.CompletedTasks.Action | string |
Texto de acción para el usuario. Se muestra al usuario final |
|
AssignedUserIds
|
GetProcessResult.CompletedTasks.AssignedUserIds | array of |
assignedUserIds |
|
Comentarios
|
GetProcessResult.CompletedTasks.Comments | array of object |
Comentarios |
|
Fecha
|
GetProcessResult.CompletedTasks.Comments.Date | string |
Fecha de comentario |
|
Id
|
GetProcessResult.CompletedTasks.Comments.Id | string |
Identificador del comentario |
|
Mensaje de texto
|
GetProcessResult.CompletedTasks.Comments.Text | string |
Comentario definido por el usuario |
|
UserId
|
GetProcessResult.CompletedTasks.Comments.UserId | string |
Identificador del usuario, que ha establecido el comentario |
|
CompletedDate
|
GetProcessResult.CompletedTasks.CompletedDate | string |
Fecha de finalización. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
GetProcessResult.CompletedTasks.CompletedUserIds | array of string |
completedUserIds |
|
CreatedDate
|
GetProcessResult.CompletedTasks.CreatedDate | string |
Fecha de creación. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CreatorId
|
GetProcessResult.CompletedTasks.CreatorId | string |
Identificador de usuario del creador |
|
Description
|
GetProcessResult.CompletedTasks.Description | string |
Descripción de la tarea |
|
Fecha de vencimiento
|
GetProcessResult.CompletedTasks.DueDate | string |
Fecha de vencimiento de la tarea. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
IntendedUserIds
|
GetProcessResult.CompletedTasks.IntendedUserIds | array of |
intendedUserIds |
|
ReminderDate
|
GetProcessResult.CompletedTasks.ReminderDate | string |
Fecha de aviso. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
RequireAllRecipients
|
GetProcessResult.CompletedTasks.RequiresAllRecipients | boolean |
Define si todos los destinatarios tienen que cerrar esta tarea. |
|
ShowCloseTaskDialog
|
GetProcessResult.CompletedTasks.ShowCloseTaskDialog | boolean |
Mostrar cuadro de diálogo cerrar tarea al final de la tarea |
|
Estado
|
GetProcessResult.CompletedTasks.StatusEnum | string |
Estado de la tarea (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
GetProcessResult.CompletedTasks.TaskTemplateId | string |
Id. de plantilla de tarea |
|
CreatedDate
|
GetProcessResult.CreatedDate | string |
Fecha de creación del proceso. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
Acción
|
GetProcessResult.CurrentTask.Action | string |
Texto de acción para el usuario. Se muestra al usuario final |
|
AssignedUserIds
|
GetProcessResult.CurrentTask.AssignedUserIds | array of string |
AssignedUserIds |
|
Comentarios
|
GetProcessResult.CurrentTask.Comments | array of string |
Comentarios |
|
CompletedDate
|
GetProcessResult.CurrentTask.CompletedDate | string |
Fecha de finalización. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
GetProcessResult.CurrentTask.CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
GetProcessResult.CurrentTask.CreatedDate | string |
Fecha de creación. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
CreatorId
|
GetProcessResult.CurrentTask.CreatorId | string |
Identificador de usuario del creador |
|
Description
|
GetProcessResult.CurrentTask.Description | string |
Descripción de la tarea |
|
Fecha de vencimiento
|
GetProcessResult.CurrentTask.DueDate | string |
Fecha de vencimiento de la tarea. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
Id
|
GetProcessResult.CurrentTask.Id | string |
Identificador de la tarea |
|
IntendedUserIds
|
GetProcessResult.CurrentTask.IntendedUserIds | array of string |
IntendedUserIds |
|
ReminderDate
|
GetProcessResult.CurrentTask.ReminderDate | string |
Fecha de aviso. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
RequireAllRecipients
|
GetProcessResult.CurrentTask.RequiresAllRecipients | boolean |
Define si todos los destinatarios tienen que cerrar esta tarea. |
|
ShowCloseTaskDialog
|
GetProcessResult.CurrentTask.ShowCloseTaskDialog | boolean |
Mostrar cuadro de diálogo cerrar tarea al final de la tarea |
|
StatusEnum
|
GetProcessResult.CurrentTask.StatusEnum | string |
Estado de la tarea (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
GetProcessResult.CurrentTask.TaskTemplateId | string |
Id. de plantilla de tarea |
|
CustomProperties
|
GetProcessResult.CustomProperties | array of object |
CustomProperties |
|
CustomPropertyTypeEnum
|
GetProcessResult.CustomProperties.CustomPropertyTypeEnum | string |
Lista de tipos de datos de propiedad personalizada (String, Date, Number) |
|
Nombre
|
GetProcessResult.CustomProperties.Name | string |
Nombre del tipo de propiedad personalizada |
|
Importancia
|
GetProcessResult.CustomProperties.Value | string |
Valor del tipo de propiedad personalizada |
|
DocumentIds
|
GetProcessResult.DocumentIds | array of string |
DocumentIds |
|
Fecha de vencimiento
|
GetProcessResult.DueDate | string |
Fecha de vencimiento del proceso. Formato de fecha: aaaa-MM-ddTHH:mm:ss |
|
Id
|
GetProcessResult.Id | string |
Identificador del proceso |
|
Valores
|
GetProcessResult.Name.Values | array of object |
Valores |
|
Cultura
|
GetProcessResult.Name.Values.Culture | string |
Referencia cultural en la que se da el texto (de, en, fr, ...) |
|
Mensaje de texto
|
GetProcessResult.Name.Values.Text | string |
Mensaje de texto |
|
PluginStream
|
GetProcessResult.PluginStream | array of |
PluginStream |
|
PriorityEnum
|
GetProcessResult.PriorityEnum | string |
Prioridad del proceso (Alto, Normal, Bajo) |
|
ProcessTemplateId
|
GetProcessResult.ProcessTemplateId | string |
Id. de plantilla de proceso |
|
Propiedades
|
GetProcessResult.Properties | array of object |
Propiedades |
|
GlobalValues
|
GetProcessResult.Properties.GlobalValues | array of object |
GlobalValues |
|
Valores
|
GetProcessResult.Properties.GlobalValues.Values | array of object |
Valores |
|
Cultura
|
GetProcessResult.Properties.GlobalValues.Values.Culture | string |
Cultura |
|
Mensaje de texto
|
GetProcessResult.Properties.GlobalValues.Values.Text | string |
Mensaje de texto |
|
PropertyTypeId
|
GetProcessResult.Properties.PropertyTypeId | string |
Id. de tipo de propiedad |
|
Valores
|
GetProcessResult.Properties.Values | array of string |
Valores |
|
ProtectionDomainId
|
GetProcessResult.ProtectionDomainId | string |
Identificador de dominio de protección del proceso |
|
SessionCount
|
GetProcessResult.SessionCount | integer |
Recuento de sesiones |
|
StatusEnum
|
GetProcessResult.StatusEnum | string |
Estado del proceso (Open, InProcess, Complete, PreparedToComplete, Error) |
Obtener propiedades del documento
Obtener propiedades del documento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
DocumentId
|
DocumentId | True | string |
Id. del documento |
|
Cultura
|
Culture | string |
Referencia cultural en la que se proporcionan los nombres de propiedad (de, en, fr, ...). Valor predeterminado = de |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
globalValues
|
globalValues | array of object |
globalValues |
|
values
|
globalValues.values | array of object |
values |
|
cultura
|
globalValues.values.culture | string |
Cultura |
|
texto
|
globalValues.values.text | string |
Mensaje de texto |
|
nombre de la propiedad
|
propertyName | string |
Nombre de la propiedad |
|
PropertyTypeId
|
propertyTypeId | string |
Identificador de tipo del campo de índice |
|
values
|
values | array of string |
values |
Proceso de actualización (en desuso) [EN DESUSO]
Proceso de actualización (en desuso)
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
ProcessId
|
ProcessId | True | string |
Identificador del proceso (Guid) |
|
AssignUserLoginNames
|
AssignUserLoginNames | string |
Asigne nombres de inicio de sesión de usuario a la tarea actual. (por ejemplo: peter.muster@kendox.com;megan.muster@kendox.com) |
|
|
ProcessProperties
|
ProcessProperties | string |
Formato de actualización de propiedades de proceso: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
Propiedades personalizadas
|
CustomProperties | string |
Propiedades personalizadas. Formato: [<PropertyName>|<PropertyValue>|PropertyType] (por ejemplo, [Proveedor|Muster|String][InvoiceDate|2021-01-29T13:05:45 |Fecha][InvoiceNo|4711|Número]) |
|
|
Comentario
|
Comment | string |
Comentario |
|
|
Cultura
|
Culture | string |
Referencia cultural en la que se proporcionan los nombres de propiedad (de, en, fr, ...). Valor predeterminado = de |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
values
|
name.values | array of object |
values |
|
cultura
|
name.values.culture | string |
cultura |
|
texto
|
name.values.text | string |
texto |
|
values
|
description.values | array of object |
values |
|
cultura
|
description.values.culture | string |
cultura |
|
texto
|
description.values.text | string |
texto |
|
id
|
id | string |
id |
|
protectionDomainId
|
protectionDomainId | string |
protectionDomainId |
|
processTemplateId
|
processTemplateId | string |
processTemplateId |
|
Propiedades
|
properties | array of object |
Propiedades |
|
propertyTypeId
|
properties.propertyTypeId | string |
propertyTypeId |
|
values
|
properties.values | array of string |
values |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultura
|
properties.globalValues.values.culture | string |
cultura |
|
texto
|
properties.globalValues.values.text | string |
texto |
|
propertyTypeName
|
properties.propertyTypeName | string |
propertyTypeName |
|
propertyName
|
properties.propertyName | string |
propertyName |
|
priorityEnum
|
priorityEnum | string |
priorityEnum |
|
pluginStream
|
pluginStream | string |
pluginStream |
|
dueDate
|
dueDate | string |
dueDate |
|
fecha de creación
|
createdDate | string |
fecha de creación |
|
completedDate
|
completedDate | string |
completedDate |
|
comments
|
comments | array of object |
comments |
|
id
|
comments.id | string |
id |
|
date
|
comments.date | string |
date |
|
userId
|
comments.userId | string |
userId |
|
texto
|
comments.text | string |
texto |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
statusEnum
|
statusEnum | string |
statusEnum |
|
customProperties
|
customProperties | array of object |
customProperties |
|
nombre
|
customProperties.name | string |
nombre |
|
value
|
customProperties.value | string |
value |
|
customPropertyTypeEnum
|
customProperties.customPropertyTypeEnum | string |
customPropertyTypeEnum |
|
id
|
currentTask.id | string |
id |
|
acción
|
currentTask.action | string |
acción |
|
creatorId
|
currentTask.creatorId | string |
creatorId |
|
dueDate
|
currentTask.dueDate | string |
dueDate |
|
fecha de creación
|
currentTask.createdDate | string |
fecha de creación |
|
completedDate
|
currentTask.completedDate | string |
completedDate |
|
taskTemplateId
|
currentTask.taskTemplateId | string |
taskTemplateId |
|
comments
|
currentTask.comments | array of |
comments |
|
reminderDate
|
currentTask.reminderDate | string |
reminderDate |
|
statusEnum
|
currentTask.statusEnum | string |
statusEnum |
|
descripción
|
currentTask.description | string |
descripción |
|
requireAllRecipients
|
currentTask.requiresAllRecipients | boolean |
requireAllRecipients |
|
assignedUserIds
|
currentTask.assignedUserIds | array of string |
assignedUserIds |
|
completedUserIds
|
currentTask.completedUserIds | array of string |
completedUserIds |
|
showCloseTaskDialog
|
currentTask.showCloseTaskDialog | boolean |
showCloseTaskDialog |
|
intendedUserIds
|
currentTask.intendedUserIds | array of |
intendedUserIds |
|
values
|
currentTask.nameGlobal.values | array of object |
values |
|
cultura
|
currentTask.nameGlobal.values.culture | string |
cultura |
|
texto
|
currentTask.nameGlobal.values.text | string |
texto |
|
values
|
currentTask.descriptionGlobal.values | array of object |
values |
|
cultura
|
currentTask.descriptionGlobal.values.culture | string |
cultura |
|
texto
|
currentTask.descriptionGlobal.values.text | string |
texto |
|
assignedUserCCIds
|
currentTask.assignedUserCCIds | array of |
assignedUserCCIds |
|
deputyRepresentations
|
currentTask.deputyRepresentations | array of |
deputyRepresentations |
|
taskActionEnum
|
currentTask.taskActionEnum | string |
taskActionEnum |
|
completedTasks
|
completedTasks | array of object |
completedTasks |
|
id
|
completedTasks.id | string |
id |
|
acción
|
completedTasks.action | string |
acción |
|
creatorId
|
completedTasks.creatorId | string |
creatorId |
|
dueDate
|
completedTasks.dueDate | string |
dueDate |
|
fecha de creación
|
completedTasks.createdDate | string |
fecha de creación |
|
completedDate
|
completedTasks.completedDate | string |
completedDate |
|
taskTemplateId
|
completedTasks.taskTemplateId | string |
taskTemplateId |
|
comments
|
completedTasks.comments | array of |
comments |
|
reminderDate
|
completedTasks.reminderDate | string |
reminderDate |
|
statusEnum
|
completedTasks.statusEnum | string |
statusEnum |
|
descripción
|
completedTasks.description | string |
descripción |
|
requireAllRecipients
|
completedTasks.requiresAllRecipients | boolean |
requireAllRecipients |
|
assignedUserIds
|
completedTasks.assignedUserIds | array of string |
assignedUserIds |
|
completedUserIds
|
completedTasks.completedUserIds | array of string |
completedUserIds |
|
showCloseTaskDialog
|
completedTasks.showCloseTaskDialog | boolean |
showCloseTaskDialog |
|
intendedUserIds
|
completedTasks.intendedUserIds | array of |
intendedUserIds |
|
values
|
completedTasks.nameGlobal.values | array of object |
values |
|
cultura
|
completedTasks.nameGlobal.values.culture | string |
cultura |
|
texto
|
completedTasks.nameGlobal.values.text | string |
texto |
|
values
|
completedTasks.descriptionGlobal.values | array of object |
values |
|
cultura
|
completedTasks.descriptionGlobal.values.culture | string |
cultura |
|
texto
|
completedTasks.descriptionGlobal.values.text | string |
texto |
|
assignedUserCCIds
|
completedTasks.assignedUserCCIds | array of |
assignedUserCCIds |
|
deputyRepresentations
|
completedTasks.deputyRepresentations | array of |
deputyRepresentations |
|
taskActionEnum
|
completedTasks.taskActionEnum | string |
taskActionEnum |
|
documentIds
|
documentIds | array of string |
documentIds |
|
checkOutStateEnum
|
checkOutStateEnum | string |
checkOutStateEnum |
|
checkOutUserId
|
checkOutUserId | string |
checkOutUserId |
|
sessionCount
|
sessionCount | integer |
sessionCount |
Proceso de actualización (V2)
Proceso de actualización (V2)
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Dirección URL de la API de archivo (por ejemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identificador de conexión para identificar la conexión |
|
ProcessId
|
ProcessId | True | string |
Identificador del proceso (Guid) |
|
ProcessProperties
|
ProcessProperties | string |
Formato de actualización de propiedades de proceso: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
RemoveProcessProperties
|
RemoveProcessProperties | string |
Lista de nombres o identificadores de propiedad separados por punto y coma que se van a quitar del proceso, como "FistName; b9cfbdf7-f6fb-4179-91c8-d9681fb680dd; Departamentos" |
|
|
CustomProperties
|
CustomProperties | string |
Propiedades personalizadas. Formato: [<PropertyName>|<PropertyValue>|PropertyType] (por ejemplo, [Proveedor|Muster|String][InvoiceDate|2021-01-29T13:05:45 |Fecha][InvoiceNo|4711|Número]) |
|
|
Comentario
|
Comment | string |
Adición de un texto de comentario de proceso |
|
|
AssignUserLoginNames
|
AssignUserLoginNames | string |
Los nombres de inicio de sesión de usuario asignados, separados por punto y coma, como user1; user2 |
|
|
AddDocumentIds
|
AddDocumentIds | string |
Lista separada por punto y coma de identificadores de documento que se van a agregar al proceso, por ejemplo, "1450c90e-2783-419b-b428-6ffa3b7cabe2; 0339a105-e06a-4af4-8fa2-d0b6b837fc16' |
|
|
RemoveDocumentIds
|
RemoveDocumentIds | string |
Lista separada por punto y coma de identificadores de documento que se van a quitar del proceso, por ejemplo, '1450c90e-2783-419b-b428-6ffa3b7cabe2; 0339a105-e06a-4af4-8fa2-d0b6b837fc16' |
|
|
Fecha de vencimiento
|
DueDate | string |
Fecha de vencimiento del proceso. Formato de fecha: aaaa-MM-ddTHH:mm:ss. Valor predeterminado = fecha actual |
|
|
Priority
|
Priority | string |
Prioridad del proceso (por ejemplo, Baja, Normal, Alta). Valor predeterminado = Normal |
|
|
Cultura
|
Culture | string |
Referencia cultural en la que se da el texto (de, en, fr, ...). Valor predeterminado = de |
|
|
ForceUndoCheckout
|
ForceUndoCheckout | boolean |
Forzar la desprotección del proceso si es necesario |
|
|
Dominio de protección
|
ProtectionDomain | string |
Identificador o nombre de dominio de protección |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
values
|
name.values | array of object |
Valores de propiedad |
|
cultura
|
name.values.culture | string |
Referencia cultural de propiedades |
|
texto
|
name.values.text | string |
Texto de la propiedad |
|
values
|
description.values | array of object |
values |
|
cultura
|
description.values.culture | string |
Referencia cultural de propiedades |
|
texto
|
description.values.text | string |
Texto de la propiedad |
|
id
|
id | string |
Id. de proceso |
|
protectionDomainId
|
protectionDomainId | string |
Identificador de dominio de protección de procesos |
|
processTemplateId
|
processTemplateId | string |
Identificador de plantilla de proceso |
|
Propiedades
|
properties | array of object |
Propiedades |
|
propertyTypeId
|
properties.propertyTypeId | string |
PropertyType Id |
|
values
|
properties.values | array of string |
Valores de propiedad |
|
globalValues
|
properties.globalValues | array of object |
Valores globales |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultura
|
properties.globalValues.values.culture | string |
Referencia cultural de valor global |
|
texto
|
properties.globalValues.values.text | string |
Texto del valor global |
|
propertyTypeName
|
properties.propertyTypeName | string |
Nombre propertyType |
|
propertyName
|
properties.propertyName | string |
Nombre de propiedad |
|
priorityEnum
|
priorityEnum | string |
Enumeración de prioridad de proceso |
|
pluginStream
|
pluginStream | string |
Flujo del complemento de proceso |
|
dueDate
|
dueDate | string |
Fecha de vencimiento del proceso |
|
fecha de creación
|
createdDate | string |
Fecha de creación del proceso |
|
completedDate
|
completedDate | string |
Fecha de finalización del proceso |
|
comments
|
comments | array of object |
Comentarios |
|
id
|
comments.id | string |
Id. de comentario de proceso |
|
date
|
comments.date | string |
Fecha de comentario del proceso |
|
userId
|
comments.userId | string |
Procesar identificador de usuario de comentario |
|
texto
|
comments.text | string |
Procesar texto de comentario |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
Lista de enumeraciones de derechos de acceso |
|
statusEnum
|
statusEnum | string |
Enumeración de estado |
|
customProperties
|
customProperties | array of object |
Propiedades personalizadas |
|
nombre
|
customProperties.name | string |
Nombre de propiedad personalizado |
|
value
|
customProperties.value | string |
Valor de propiedad personalizada |
|
customPropertyTypeEnum
|
customProperties.customPropertyTypeEnum | string |
Enumeración de tipo de propiedad personalizada |
|
id
|
currentTask.id | string |
Identificador de tarea actual |
|
acción
|
currentTask.action | string |
Acción de tarea actual |
|
creatorId
|
currentTask.creatorId | string |
Identificador actual del creador de tareas |
|
dueDate
|
currentTask.dueDate | string |
Fecha de vencimiento de la tarea actual |
|
fecha de creación
|
currentTask.createdDate | string |
Fecha de creación de la tarea actual |
|
completedDate
|
currentTask.completedDate | string |
Fecha de finalización de la tarea actual |
|
taskTemplateId
|
currentTask.taskTemplateId | string |
Identificador de plantilla de tarea actual |
|
comments
|
currentTask.comments | array of |
Comentarios de tareas actuales |
|
reminderDate
|
currentTask.reminderDate | string |
Fecha actual del recordatorio de tareas |
|
statusEnum
|
currentTask.statusEnum | string |
Enumeración de estado de tarea actual |
|
descripción
|
currentTask.description | string |
Descripción de la tarea actual |
|
requireAllRecipients
|
currentTask.requiresAllRecipients | boolean |
La tarea actual requiere todos los destinatarios |
|
assignedUserIds
|
currentTask.assignedUserIds | array of string |
Identificadores de usuario asignados a tareas actuales |
|
completedUserIds
|
currentTask.completedUserIds | array of string |
Identificadores de usuario completados por la tarea actual |
|
showCloseTaskDialog
|
currentTask.showCloseTaskDialog | boolean |
Cuadro de diálogo De cierre de tarea actual |
|
intendedUserIds
|
currentTask.intendedUserIds | array of |
Identificadores de usuario previstos para la tarea actual |
|
values
|
currentTask.nameGlobal.values | array of object |
values |
|
cultura
|
currentTask.nameGlobal.values.culture | string |
Referencia cultural de nombres globales |
|
texto
|
currentTask.nameGlobal.values.text | string |
Texto de nombre global |
|
values
|
currentTask.descriptionGlobal.values | array of object |
values |
|
cultura
|
currentTask.descriptionGlobal.values.culture | string |
Referencia cultural de descripción global |
|
texto
|
currentTask.descriptionGlobal.values.text | string |
Texto de descripción global |
|
assignedUserCCIds
|
currentTask.assignedUserCCIds | array of |
Identificadores cc de usuario asignados |
|
deputyRepresentations
|
currentTask.deputyRepresentations | array of |
Representaciones adjuntas |
|
taskActionEnum
|
currentTask.taskActionEnum | string |
Enumeración de acción de tarea |
|
completedTasks
|
completedTasks | array of object |
Tareas completadas |
|
id
|
completedTasks.id | string |
Identificador de tarea completado |
|
acción
|
completedTasks.action | string |
Acción de tarea completada |
|
creatorId
|
completedTasks.creatorId | string |
Identificador de creador de tareas completado |
|
dueDate
|
completedTasks.dueDate | string |
Fecha de vencimiento de la tarea completada |
|
fecha de creación
|
completedTasks.createdDate | string |
Fecha de creación de la tarea completada |
|
completedDate
|
completedTasks.completedDate | string |
Fecha de finalización de la tarea completada |
|
taskTemplateId
|
completedTasks.taskTemplateId | string |
Identificador de plantilla de tarea completada |
|
comments
|
completedTasks.comments | array of |
Comentarios de tareas completados |
|
reminderDate
|
completedTasks.reminderDate | string |
Fecha de recordatorio de tareas completada |
|
statusEnum
|
completedTasks.statusEnum | string |
Enumeración de estado de tarea completada |
|
descripción
|
completedTasks.description | string |
descripción |
|
requireAllRecipients
|
completedTasks.requiresAllRecipients | boolean |
La tarea completada requiere todos los destinatarios |
|
assignedUserIds
|
completedTasks.assignedUserIds | array of string |
Identificadores de usuario asignados a tareas completadas |
|
completedUserIds
|
completedTasks.completedUserIds | array of string |
Tarea completada: identificadores de usuario completados |
|
showCloseTaskDialog
|
completedTasks.showCloseTaskDialog | boolean |
Cuadro de diálogo Cerrar tarea completada |
|
intendedUserIds
|
completedTasks.intendedUserIds | array of |
Identificadores de usuario previstos para la tarea completada |
|
values
|
completedTasks.nameGlobal.values | array of object |
values |
|
cultura
|
completedTasks.nameGlobal.values.culture | string |
Referencia cultural de nombres globales |
|
texto
|
completedTasks.nameGlobal.values.text | string |
Texto de nombre global |
|
values
|
completedTasks.descriptionGlobal.values | array of object |
values |
|
cultura
|
completedTasks.descriptionGlobal.values.culture | string |
Referencia cultural de descripción global |
|
texto
|
completedTasks.descriptionGlobal.values.text | string |
Texto de descripción global |
|
assignedUserCCIds
|
completedTasks.assignedUserCCIds | array of |
Identificadores cc de usuario asignados a la tarea completada |
|
deputyRepresentations
|
completedTasks.deputyRepresentations | array of |
Representaciones adjuntas de tareas completadas |
|
taskActionEnum
|
completedTasks.taskActionEnum | string |
Enumeración de acción de tarea completada |
|
documentIds
|
documentIds | array of string |
Identificadores de documento de tareas completados |
|
checkOutStateEnum
|
checkOutStateEnum | string |
Enumeración de estado de comprobación de estado completada |
|
checkOutUserId
|
checkOutUserId | string |
Tarea completada desproteger el identificador de usuario |
|
sessionCount
|
sessionCount | integer |
Recuento de sesiones de tareas completada |