Instructivo para la integración

con WorkManager E.D. ® v11

(API SOAP v.2)

1
Tabla de contenido
Tabla de contenido.............................................................................................................................. 2
1. Introducción ................................................................................................................................ 4
2. Alcance ........................................................................................................................................ 4
3. Formularios en WorkManager E.D. ® .......................................................................................... 5
4. Método Form_Insert ................................................................................................................... 7
5. Método Form_Update ................................................................................................................ 9
6. Método Form_Delete. ............................................................................................................... 10
7. Método Form_GetData ............................................................................................................. 11
8. Método Form_AttachFiles ........................................................................................................ 13
9. Método Form_GetFilesCodes. .................................................................................................. 14
10. Método Form_GetBase64String ........................................................................................... 15
11. Método Workflow_Start ....................................................................................................... 16
12. Método Workflow_AttachFiles ............................................................................................. 17
13. Método Workflow_RunTask ................................................................................................. 19
14. Método List_GetItems .......................................................................................................... 20
15. Método Form_GetFilesDirectories........................................................................................ 21
16. Método Form_GetParameters .............................................................................................. 22
17. Método File_Delete............................................................................................................... 22
18. Método Workflow_GetCases ................................................................................................ 23
19. Método Workflow_GetTasks ................................................................................................ 24
20. Método Field_GetValues....................................................................................................... 25
21. Método GetToken ................................................................................................................. 26
22. Método Workflow_StepsForReturn ...................................................................................... 27
23. Método Workflow_ReturnTasks ........................................................................................... 27
24. Método Workflow_AbortProcess ......................................................................................... 28
25. Método Workflow_GetFileCodes.......................................................................................... 29
26. Método File_CopyToFather .................................................................................................. 30
27. Método File_CopyToEP ......................................................................................................... 30

2
3
1. Introducción
Este documento describe la metodología que debe seguirse para la interacción o conexión
de cualquier aplicación (CRM, ERP, etc.) con WorkManager E.D. ® mediante un API SOAP
(Simple Object Access Protocol). SOAP es un protocolo estándar que define cómo dos
objetos en diferentes procesos pueden comunicarse por medio de intercambio de
datos XML.

2. Alcance
El API Soap de integración de WorkManger E.D® expone varios métodos u operaciones
básicas para interactuar con cualquiera de los formularios que se pueden generar en la
aplicación (clientes, proveedores, historias laborales, etc.), y además, podrá trabajar con
flujos de trabajo y muchas otras opciones que se exponen. Los métodos que expone el API
son los siguientes:

• Form_Insert
Crea un registro en un formulario de WorkManager E.D. ® y, opcionalmente, puede
adjuntar uno o varios archivos al registro insertado.
• Form_Update
Modifica o actualiza un registro en un formulario de WorkManager E.D. ®.
• Form_Delete
Elimina un registro en un formulario de WorkManager E.D. ®.
• Form_GetData
Recupera uno o varios registros desde un formulario de WorkManager E.D. ®.
• Form_AttachFiles
Adjunta uno o varios archivos en un formulario de WorkManager E.D®.
• Form_GetFilesCodes
Recupera los código de archivo (y otros atributos adicionales) suministrando el
número de radicado de un formulario particular de WorkManager E.D®.
• Form_GetBase64String
Retorna un archivo particular como una cadena (o string) codificada en base 64
suministrando el codigo de archivo.
• Workflow_Start
Inicia una instancia de un flujo de trabajo en WorkManager E.D®.
• Workflow_AttachFiles
Adjunta uno o varios archivos a una instancia de un flujo de trabajo iniciado en
WorkManager E.D®.
• WorkFlow_RunTask
Cumple una tarea en un paso determinado de un flujo de trabajo en WorkManager
E. D®.
• List_GetItems
Recupera los ítems de una lista de WorkManager E. D®.

4
 • Form_GetFilesDirectories
Recupera los directorios de un formulario de WorkManager E. D®.
• Form_GetParameters
Recupera la información de creación relacionada a un formulario de WorkManager
E. D®.
• File_Delete
Elimina cualquier archivo cargado a WorkManager E. D®.
• Workflow_GetCases
Recupera uno o varios procesos (Workflow) de un registro de un formulario de
WorkManager E. D®.
• Workflow_GetTasks
Recupera la información (Trazabilidad) de un proceso (Workflow) relacionado a un
registro de un formulario de WorkManager E. D®.
• Field_GetValues
Recupera los ítems de un campo asociado a una lista en un formulario de
WorkManager E. D®.
• GetToken
Genera el token dinámico para consumo de los métodos de la Api Soap V2 de
WorkManager E.D, cuando se haga la solicitud el token generado tendrá un tiempo
de expiración, el cual va entre 1 y 5 minutos.
• Workflow_StepsForReturn
Recupera los pasos a los cuales se puede realizar una devolución desde la actividad
actual de un flujo de trabajo en curso.
• Workflow_ReturnTasks
Devuelve la actividad actual de un flujo de trabajo al paso seleccionado.
• Workflow_AbortProcess
Interrumpe un flujo de trabajo activo.
• Workflow_GetFileCodes
Recupera los códigos de archivo (y otros atributos adicionales) suministrando el
número de proceso del flujo de trabajo.
• File_CopyToFather
Realiza copia de un archivo cargado a un registro de un formulario hijo en una
carpeta de la estructura del formulario padre.
• File_CopyToEP
Realiza copia de un archivo cargado en WorkManager E.D. a un directorio de la
estructura principal

3. Formularios en WorkManager E.D. ®

A continuación, se explica cómo almacena WorkManager E.D. ® los datos en la base de datos
de SQL Server al crear un formulario.

5
 Cuando creamos un formulario en WorkManager E.D. ®, se genera un registro en la tabla
Formularios, el campo más importante es el nombre de la tabla que se genera en la base
de datos de SQL Server (Ver figura 1 a continuación):

Figura 1 Tabla Formularios.

A partir del campo IdFormulario o Codigo, podemos consultar los campos o

columnas que posee la tabla donde se almacenan los registros del formulario en la tabla
Campos:

Figura 2 Tabla Campos.

En la tabla de la figura anterior (Figura 2), puede observarse que la tabla Campos es básicamente
un diccionario donde se especifica el nombre de la columna en la tabla de la base de datos y el
nombre que se presenta al usuario en el formulario de WorkManager E.D. ®

La tabla en la base de datos tiene el siguiente aspecto:

6
 Figura 3 Diseño Tabla de un formulario

Las columnas ID, Usuario, Fecha, Host, Imagen, Radicado, Id Sucursal, Id Formulario, ID_EXT,
Estado, Cod_Barras y Anio, son columnas por defecto y están presentes en todos los
formularios de WorkManager E.D. ®, las columnas con el formato C000X, son columnas que
crean los usuarios de la aplicación.

4. Método Form_Insert
Este método inserta un registro en cualquiera de los formularios generados en
WorkManager E.D. ®.
Firma del método:
Function Form_Insert (request As InsertRequestDto) As InsertResponseDto

InsertRequestDto
Nombre Tipo de dato Descripción Requerido
Usuario del sistema que quedará registrado cómo autor de la
OperationUser String SI
inserción del registro en la base de datos.
FormCode String Código del formulario. SI
OfficeCode String Código de la sucursal. SI
Es el usuario responsable del paso 2 después iniciar el flujo
de trabajo. Solo debe enviarse si el responsable del paso 2 se
NextStepUser String NO
configura como selección desde una lista de usuarios del
sistema.

7
 ProcessId Long Identificador del flujo de trabajo. NO
Si el valor enviado es 1 verifica si debe iniciar un flujo de
CheckWorkflow Boolean NO
trabajo automático.
Diccionario o colección de valores tipo “Key – Value” con los
datos que se insertarán en el formulario. Debe enviarse el
campo “Field” del diccionario que corresponde al nombre
Data DictionaryDto SI
del campo en la tabla que representa al formulario y el
campo “value” corresponde al valor del mismo. El campo
“Key” no debe enviarse.
Objeto para enviar los datos de uno o varios archivos que se
Files FileDto NO
adjuntarán al registro del formulario que se está creando.
Objeto para enviar los datos de autenticación para poder
Header HeaderDto SI
consumir el servicio.

DictionaryDto
Nombre Tipo de dato Descripción Requerido
Nombre de la columna en la tabla que representa al formulario en
Field String SI
la base de datos SQL Server.
Value String Valor del campo descrito en ítem Field. SI
Key String Este atributo no debe enviarse NO

FileDto
Nombre Tipo de dato Descripción Requerido
Representación del archivo que se va a almacenar como
una cadena (string) base 64.
Este parámetro será opcional si en su proceso de
Base64String String integración así lo requiere, ejemplo: donde un tercero sea SI
quien haga el traslado de las imágenes, de lo contrario
siempre deberá enviar el archivo representado en una
cadena (string) base 64.
Extensión del tipo de archivo que se almacenará
Ext String SI
(Ej:.pdf,.docx,.xls)
Descripción del archivo que será presentado al usuario
Description String SI
cuando lo consulte en WorkManager E.D. ®.
Código del tipo documental para clasificar el archivo, se
DocumentTypeCode String SI
identifica desde WorkManager E.D.
Código del directorio en donde se almacenará el archivo,
DirectoryCode String SI
se identifica desde WorkManager E.D.
Es un número pseudoaleatorio empleado en aplicaciones
de software ejemplo:
* 3F2504E0-4F89-11D3-9A0C-0305E82C3301 el
GUID String valor debe ser enviado sin guiones NO
* 3F2504E04F8911D39A0C0305E82C3301.
no se recomienda utilizar este parámetro a menos que su
proceso de integración así lo requiera.
Version String Versión del documento que se está cargando. NO
Length Long Tamaño de archivo NO
Identificador del archivo principal para manejo de
MainFileId Long NO
versiones

8
 HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del
User String API SOAP de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

Repuesta del método:

InsertResponseDto.
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de
Message String
lo contrario, retorna el mensaje con la descripción del error.
BarCode String Retorna el radicado correspondiente de WorkManager E.D.
RecordId Long Retorna Id registro Insertado en la Tabla del formulario seleccionado.
WorkFlow Long Retorna Id del proceso iniciado asociado al Formulario de WorkManager E.D.
FileCodes List (Of String) Retorna el código del Archivo Insertado en el radicado.
FileIdList List(Of Long) Retorna el identificador único del Archivo Insertado en el radicado.
DestinationPath List (Of String) Retorna la ruta física del Archivo Insertado en el radicado.

5. Método Form_Update
Este Método modifica o actualiza un registro en un formulario de WorkManager E.D. ®.
Firma del método:
Function Form_Update (request As UpdateRequestDto) As ResponseDto

UpdateRequestDto
Nombre Tipo de dato Descripción Requerido
Usuario del sistema que quedará registrado cómo autor
OperationUser String de la modificación o actualización del registro en la base SI
de datos.
FormCode String Código del formulario. SI
Diccionario o colección de valores tipo “Key – Value”
con los datos que se insertarán en el formulario. Debe
enviarse el campo “Field” del diccionario que
Data DictionaryDto corresponde al nombre del campo en la tabla que SI
representa al formulario y el campo “value”
corresponde al valor del mismo. El campo “Key” no
debe enviarse.
Objeto para enviar los datos de autenticación para
Header HeaderDto SI
poder consumir el servicio.
Objeto para enviar los datos del filtro de búsqueda para
FilterParameters FilterParametersDto NO
modificar o actualizar el registro.
Recibe una cadena con de caracteres donde se indica el
filtro compuesto, si este parámetro se diligencia, se hará
caso omiso a el valor diligenciado en la propiedad
Filter String FilterParameters. NO

Ejemplo: “C0001 = ‘1234567890’ AND C0002 =

‘Bogota’”

9
 DictionaryDto
Nombre Tipo de dato Descripción Requerido
Nombre de la columna en la tabla que representa al formulario en
Field String la base de datos SQL Server, las cual va a ser modificadas o SI
actualizada.
Value String Valor del campo descrito en ítem Field SI
Key String Este atributo no debe enviarse NO

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del
User String API SOAP de integración. Este dato es suministrado por SI
Estrategias Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

FilterParametersDto.
Nombre Tipo de dato Descripción Requerido
Nombre de la columna en la tabla que representa al formulario en
Field String la base de datos SQL Server por la cual se desea realizar el filtro de SI
búsqueda del registro a modificar o actualizar.
Operador que se aplica entre los atributos Field y value en la
Operator String SI
tabla. Los valores posibles son: =, <>, >=, <=, Like
Valor del campo descrito anteriormente (Field) por el cual se
Value String filtrará(n) el(los) registro(s) para realizar la operación de SI
actualización.

Repuesta del método:

ResponseDto.
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de lo
Message String
contrario, retorna el mensaje con la descripción del error.
Rows Integer Retorna un el número de registros actualizados.

6. Método Form_Delete.
Elimina un registro en un formulario de WorkManager E.D. ®.
Firma del método:
Function Form_Delete (request As DeleteRequestDto) As ResponseDto

DeleteRequestDto.
Nombre Tipo de dato Descripción Requerido
Usuario del sistema que quedará registrado cómo autor
OperationUser String SI
de la eliminación del registro en la base de datos.
FormCode String Código del formulario. SI
Objeto para enviar los datos de autenticación para poder
Header HeaderDto SI
consumir el servicio.
Objeto para enviar los datos del filtro de búsqueda para
FilterParameters FilterParametersDto NO
eliminar el radicado en WorkManager E.D. ®.

10
 Recibe una cadena con de caracteres donde se indica el
filtro compuesto, si este parámetro se diligencia, se hará
caso omiso a el valor diligenciado en la propiedad
Filter String NO
FilterParameters.

Ejemplo: “C0001 = ‘1234567890’ AND C0002 = ‘Bogota’”

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del
User String API SOAP de integración. Este dato es suministrado por SI
Estrategias Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

FilterParametersDto.
Nombre Tipo de dato Descripción Requerido
Nombre de la columna en la tabla que representa al formulario en
Field String la base de datos SQL Server por la cual se desea realizar el filtro de SI
búsqueda del registro a eliminar.
Operador que se aplica entre los atributos Field y value en la
Operator String SI
tabla. Los valores posibles son: =, <>, >=, <=, Like
Valor del campo descrito anteriormente (Field) por el cual se
Value String filtrará(n) el(los) registro(s) para realizar la operación de SI
eliminación.

Repuesta del método:

ResponseDto.
Nombre Tipo de dato Descripción
Retorna los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de lo
Message String
contrario retorna el mensaje con la descripción del error.
Rows Integer Retorna un el número de registros borrados.

7. Método Form_GetData
Recupera uno o varios registros desde un formulario de WorkManager E.D. ®.
Firma del método:
Function Form_GetData (request As QueryRequestDto) As ResponseDto

QueryRequestDto.
Nombre Tipo de dato Descripción Requerido
FormCode String Código del formulario. SI
Objeto para enviar los datos de autenticación para poder
Header HeaderDto SI
consumir el servicio.
Objeto para enviar los datos del filtro de búsqueda para
FilterParameters FilterParametersDto NO
consultar los registros de un formulario.
Recibe una cadena con de caracteres donde se indica el
filtro compuesto, si este parámetro se diligencia, se hará
Filter String NO
caso omiso a el valor diligenciado en la propiedad
FilterParameters.

11
 Ejemplo: “C0001 = ‘1234567890’ AND C0002 = ‘Bogota’”
Valor que determina el numero de registros que se
Top String NO
desea consultar.
Nombre de la columna en la tabla que representa al
formulario en la base de datos SQL Server por la cual se
OrderColumn String NO
desea realizar el ordenamiento de los registros a
consultar.
Ordenamiento de datos, solo recibe dos valores válidos
OrderType String “ASC” y “DESC”, si no se envía por defecto será NO
ascendente.

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del
User String API SOAP de integración. Este dato es suministrado por SI
Estrategias Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

FilterParametersDto.
Nombre Tipo de dato Descripción Requerido
Nombre de la columna en la tabla que representa al formulario en
Field String la base de datos SQL Server por la cual se desea realizar el filtro de SI
búsqueda del registro a consultar.
Operador que se aplica entre los atributos Field y value en la
Operator String SI
tabla. Los valores posibles son: =, <>, >=, <=, Like
Valor del campo descrito anteriormente (Field) por el cual se
Value String SI
filtrará(n) el(los) registro(s) para realizar la operación de consulta.

Repuesta del método:

ResponseDto.
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de lo
Message String
contrario, retorna el mensaje con la descripción del error.
Diccionario tipo “key – value” con los resultados de la consulta. La parte “key”
Data DictionaryDto
representa el nombre del campo y la parte “value” representa el valor del mismo.
Rows Integer Retorna un el número de registros consultados.

DictionaryDto.
Nombre Tipo de dato Descripción
Field String Nombre del campo en el formulario de Workmanager E.D. ®
Value String Valor del campo descrito anteriormente (Field).
Nombre de la columna en la tabla que representa al formulario en la base de datos
Key String
SQL Server. Ejemplo: Key-> C0002 Field -> Nombre Completo

12
8. Método Form_AttachFiles
Adjunta uno o varios archivos en un formulario de WorkManager E. D®.
Firma del método:
Function Form_AttachFiles (request As AttachRequestDto) As
InsertResponseDto

AttachRequestDto.
Nombre Tipo de dato Descripción Requerido
Usuario del sistema que quedará registrado cómo autor de
OperationUser String SI
la carga del documento a un radicado en la base de datos.
BarCode String Número de radicado de WorkManager E.D. ®. SI
Objeto para enviar los datos de uno o varios archivos que se
Files FileDto SI
adicionaran al radicado de WorkManager E.D. ®.
Objeto para enviar los datos de autenticación para poder
Header HeaderDto SI
consumir el servicio

FileDto
Nombre Tipo de dato Descripción Requerido
Representación del archivo que se va a almacenar como
una cadena (string) base 64.
Este parámetro será opcional si en su proceso de
Base64String String integración así lo requiere, ejemplo: donde un tercero sea SI
quien haga el traslado de las imágenes, de lo contrario
siempre deberá enviar el archivo representado en una
cadena (string) base 64.
Extensión del tipo de archivo que se almacenará
Ext String SI
(Ej:.pdf,.docx,.xls)
Descripción del archivo que será presentado al usuario
Description String SI
cuando lo consulte en WorkManager E.D. ®.
Código del tipo documental para clasificar el archivo, se
DocumentTypeCode String SI
identifica desde WorkManager E.D.
Código del directorio en donde se almacenará el archivo,
DirectoryCode String SI
se identifica desde WorkManager E.D.
Es un número pseudoaleatorio empleado en aplicaciones
de software ejemplo:
* 3F2504E0-4F89-11D3-9A0C-0305E82C3301 el
GUID String valor debe ser enviado sin guiones NO
* 3F2504E04F8911D39A0C0305E82C3301.
no se recomienda utilizar este parámetro a menos que su
proceso de integración así lo requiera.
Version String Versión del documento que se está cargando. NO
Length Long Tamaño de archivo NO
Identificador del archivo principal para manejo de
MainFileId Long NO
versiones

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del
User String API SOAP de integración. Este dato es suministrado por SI
Estrategias Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

13
 Repuesta del método:
InsertResponseDto.
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de
Message String
lo contrario, retorna el mensaje con la descripción del error.
BarCode String Retorna el radicado correspondiente de WorkManager E.D.
RecordId Long No aplica para este método.
WorkFlow Long No aplica para este método.
FileCodes List (Of String) Retorna el código del Archivo Insertado en el radicado.
FileIdList List(Of Long) Retorna el identificador único del Archivo Insertado en el radicado.
DestinationPath List (Of String) Retorna la ruta física del Archivo Insertado en el radicado.

9. Método Form_GetFilesCodes.
Recupera los códigos de archivo (y otros atributos adicionales) suministrando el número de
radicado de un formulario particular de WorkManager E. D®.
Firma del método:
Function Form_GetFileCodes (request As FileRequestDto) As FileResponseDto

FileRequestDto.
Nombre Tipo de dato Descripción Requerido
BarCode String Numero de radicado WorkManager E.D. SI
Este valor es opcional y representa el código del directorio en el
formulario de WorkManager E.D. ® donde se encuentran los
archivos o documentos.
DirectoryCode String NO
Si se envía, el método retorna los archivos asociados a este
código de directorio, sino se envía ningún valor, el método
retornará todos los archivos asociados al radicado.
Objeto para enviar los datos de autenticación para poder
Header HeaderDto SI
consumir el servicio.

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del API
User String SOAP de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

Repuesta del método:

FileResponseDto.
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de lo
Message String
contrario retorna el mensaje con la descripción del error.

14
 IEnumerable(Of
FileProperties Encapsula la información del archivo asociado al radicado.
FilePropertiesDto)
Rows Integer Retorna un el número de registros consultados.

FilePropertiesDto.
Nombre Tipo de dato Descripción
Code String Código o identificador de archivo en WorkManager E.D. ®.
Description String Nombre o descripción del archivo tal y como se visualiza en WorkManager E.D. ®.
Ext String Extensión de archivo.
Size Long Tamaño del archivo en Bytes.
FileId Long Identificador único de archivo en WorkManager E.D. ®.
DocDate Datetime Fecha de documento en WorkManager E.D. ®.
PublishDate Datetime Fecha de publicación en WorkManager E.D. ®.

10. Método Form_GetBase64String

Retorna un archivo particular como una cadena (o string) codificada en base 64, se debe
suministrar el código de archivo.
Firma del método:
Function Form_GetBase64StringFile (request As StringFileRequestDto) As
StringFileResponseDto

StringFileRequestDto.
Nombre Tipo de dato Descripción Requerido
FileCode String Código del archivo almacenado en WorkManager E.D. ®. SI
Objeto para enviar los datos de autenticación para poder consumir
Header HeaderDto SI
el servicio.

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del
User String API SOAP de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

Repuesta del método:

StringFileResponseDto.
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de lo
Message String
contrario retorna el mensaje con la descripción del error.
File FilePropertiesDto Retorna la información del archivo asociado al radicado.

FilePropertiesDto.
Nombre Tipo de dato Descripción
Code String Valor de texto cuyo valor es una cadena en base64 que representa el archivo.

15
 Nombre o descripción del archivo tal y como se visualiza el archivo en WorkManager
Description String
E.D. ®.
Ext String Extensión de archivo.
Size Long Tamaño del archivo en Bytes.
FileId Long Identificador único de archivo en WorkManager E.D. ®.
DocDate Datetime Fecha de documento en WorkManager E.D. ®.
PublishDate Datetime Fecha de publicación en WorkManager E.D. ®.

11. Método Workflow_Start

Inicia una instancia de un flujo de trabajo en WorkManager E. D®.
Firma del método:
Function Workflow_Start (request As StartWorkflowRequestDto) As
StartWorkflowResponseDto

StarWorkFlowRequestDto.
Nombre Tipo de dato Descripción Requerido
Usuario del sistema que quedará registrado cómo la persona
OperationUser String SI
que inició el flujo de trabajo.
Usuario al que se le asigna la tarea una vez inicia el flujo de
trabajo. Solo debe enviarse este valor, si el responsable del
NextStepUser String NO
paso 2 del flujo de trabajo se configura como selección desde
una lista de usuarios del sistema.
BarCode String Número de radicado WorkManager E.D. ®. SI
Identificador del proceso a iniciar en WorkManager E.D. ®.
ProcessId Long Recordar que el proceso debe estar asociado al formulario y su SI
estado debe ser “Producción”.
Objeto para enviar los datos de autenticación para poder
Header HeaderDto SI
consumir el servicio
Objeto para enviar los datos de uno o varios archivos que se
Files FileDto SI
adicionaran al radicado de WorkManager E.D. ®.

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del
User String API SOAP de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

FileDto
Nombre Tipo de dato Descripción Requerido
Representación del archivo que se va a almacenar como
una cadena (string) base 64.
Este parámetro será opcional si en su proceso de
Base64String String integración así lo requiere, ejemplo: donde un tercero sea SI
quien haga el traslado de las imágenes, de lo contrario
siempre deberá enviar el archivo representado en una
cadena (string) base 64.

16
 Extensión del tipo de archivo que se almacenará
Ext String SI
(Ej:.pdf,.docx,.xls)
Descripción del archivo que será presentado al usuario
Description String SI
cuando lo consulte en WorkManager E.D. ®.
Código del tipo documental para clasificar el archivo, se
DocumentTypeCode String SI
identifica desde WorkManager E.D.
Código del directorio en donde se almacenará el archivo,
DirectoryCode String SI
se identifica desde WorkManager E.D.
Es un número pseudoaleatorio empleado en aplicaciones
de software ejemplo:
* 3F2504E0-4F89-11D3-9A0C-0305E82C3301 el
GUID String valor debe ser enviado sin guiones NO
* 3F2504E04F8911D39A0C0305E82C3301.
no se recomienda utilizar este parámetro a menos que su
proceso de integración así lo requiera.
Version String Versión del documento que se está cargando. NO
Length Long Tamaño de archivo NO
Identificador del archivo principal para manejo de
MainFileId Long NO
versiones

Respuesta del método:

StartWorkflowResponseDto.
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de lo
Message String
contrario retorna el mensaje con la descripción del error.
WorkflowId Long Retorna el ID del proceso iniciado en WorKmanager E.D. ®.
FileCodes List (Of String) Retorna los códigos de archivo que se adjuntaron al radicado.

12. Método Workflow_AttachFiles

Adjunta uno o varios archivos a una instancia de un flujo de trabajo iniciado en
WorkManager E. D®.
Firma del método:
Function Workflow_AttachFiles (request As WorkflowAttachFilesRequestDto)
As InsertResponseDto.

WorkflowAttachFilesRequestDto.
Nombre Tipo de dato Descripción Requerido
Parámetro que determina si el archivo cargado al Workflow
debe también copiarse al registro.
CopyToForm Boolean NO
Por defecto de envía 0 (False), si se desea hacer copia al
registro se debe enviar 1 (True)
Usuario del sistema que quedará registrado cómo autor de la
OperationUser String SI
carga de los documentos al flujo de trabajo.
Identificador de la instancia de workflow en WorkManager E.D.
WorkflowId Long SI
®.
Objeto para enviar los datos de uno o varios archivos que se
Files FileDto SI
adicionaran al workflow de WorkManager E.D. ®.
Objeto para enviar los datos de autenticación para poder
Header HeaderDto SI
consumir el servicio

17
FileDto
Nombre Tipo de dato Descripción Requerido
Representación del archivo que se va a almacenar como
una cadena (string) base 64.
Este parámetro será opcional si en su proceso de
Base64String String integración así lo requiere, ejemplo: donde un tercero sea SI
quien haga el traslado de las imágenes, de lo contrario
siempre deberá enviar el archivo representado en una
cadena (string) base 64.
Extensión del tipo de archivo que se almacenará
Ext String SI
(Ej:.pdf,.docx,.xls)
Descripción del archivo que será presentado al usuario
Description String SI
cuando lo consulte en WorkManager E.D. ®.
Código del tipo documental para clasificar el archivo, se
DocumentTypeCode String SI
identifica desde WorkManager E.D.
Código del directorio en donde se almacenará el archivo,
se identifica desde WorkManager E.D.
DirectoryCode String SI
Nota: Para este método si el código no existe no se
realizará la copia al registro en caso de tener como True el
parámetro CopyToForm.
Es un número pseudoaleatorio empleado en aplicaciones
de software ejemplo:
* 3F2504E0-4F89-11D3-9A0C-0305E82C3301 el
GUID String valor debe ser enviado sin guiones NO
* 3F2504E04F8911D39A0C0305E82C3301.
no se recomienda utilizar este parámetro a menos que su
proceso de integración así lo requiera.
Version String Versión del documento que se está cargando. NO
Length Long Tamaño de archivo NO
Identificador del archivo principal para manejo de
MainFileId Long NO
versiones

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del
User String API SOAP de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

Respuesta del método:

InsertResponseDto.
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de lo
Message String
contrario, retorna el mensaje con la descripción del error.
BarCode String No aplica para este método.
RecordId Long No aplica para este método.

18
 WorkFlow Long No aplica para este método.
FileCodes List (Of String) Retorna el código del Archivo Insertado en el radicado.
FileIdList List(Of Long) No aplica para este método.
DestinationPath List (Of String) Retorna la ruta física del Archivo Insertado en el radicado.

13. Método Workflow_RunTask

Cumple una tarea en un paso determinado de un flujo de trabajo en WorkManager E. D®
Firma del método:
Function Workflow_RunTask (request As RunTaskRequestDto) As ResponseDto

RunTaskRequestDto.
Nombre Tipo de dato Descripción Requerido
Número de radicado WorkManager E.D. ®.
BarCode String Si se envía este parámetro, debe enviarse obligatoriamente el NO
parámetro ProcessId.
Identificador del proceso, obligatorio si se envía el parámetro
ProcessId Integer NO
BarCode.
Identificador de la instancia de workflow en WorkManager E.D. ®.
WorkflowId Long NO
Debe enviarse si el parámetro BarCode no se envía.
Paso que se desea ejecutar o cumplir en la instancia de workflow
Step Integer SI
especificada.
Comentario asociado a la tarea que se va a cumplir en
Comment String NO
WorkManager E.D. ®.
Usuario al que se le asigna la tarea una vez se cumple el paso en el
NextStepUser String flujo de trabajo. Debe enviarse sólo si el paso siguiente está NO
configurado como una lista de selección de usuarios del sistema.
Objeto para enviar los datos de autenticación para poder consumir
Header HeaderDto SI
el servicio

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del API
User String SOAP de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

Respuesta del método:

ResponseDto
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de lo
Message String
contrario, retorna el mensaje con la descripción del error.

19
14. Método List_GetItems
Recupera los ítems de una lista de WorkManager E. D®.
Firma del método:
Function List_GetItems (request As ListRequestDto) As ListResponseDto (Of
ItemLista)

ListRequestDto
Nombre Tipo de dato Descripción Requerido
ListId Long Identificador de lista en WorkManager E.D. ®. SI
Identificador de ítem de la lista padre. Por
ejemplo, el identificador del ítem “Colombia”,
FatherItemId Long NO
para retornar o consultar las ciudades de este
país.
Objeto para enviar los datos de autenticación
Header HeaderDto SI
para poder consumir el servicio

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de
integración del API SOAP de integración. Este
User String SI
dato es suministrado por Estrategias
Documentales S.A.S.
Token de Autenticación. Este dato es
Token String SI
suministrado por Estrategias Documentales S.A.S.

Respuesta del método:

ListResponseDto.
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de lo
Message String
contrario, retorna el mensaje con la descripción del error.
IEnumerable(Of
Data Colección con los datos de los ítems de la lista consultada.
ItemLista)
Rows Integer Retorna un el número de registros consultados.

ItemLista
Nombre Tipo de dato Descripción
IdItem Long Identificador único del Ítem
IdLista Long Identificador único de la Lista a la que pertenece el ítem
Codigo String Código del ítem
Nombre String Nombre o Valor del ítem de la lista
Identificador del ítem de lista padre (ejemplo si es un departamento sería el
IdItemPadre Long
IdItem de un País)
Activo Boolean Ítem activo valores de True o False
Usuario String Usuario que creo el ítem
Fecha Date Fecha de creación del ítem
Host String Terminal de creación

20
15. Método Form_GetFilesDirectories
Recupera los directorios de un formulario de WorkManager E. D®.
Firma del método:
Function Form_GetFilesDirectories(request As FileDirectoryRequestDto) As
ListResponseDto(Of Directorio)

FileDirectoryRequestDto
Nombre Tipo de dato Descripción Requerido
FormCode String Código del formulario. SI
Objeto para enviar los datos de autenticación para poder consumir
Header HeaderDto SI
el servicio

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del
User String API SOAP de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

Respuesta del método:

ListResponseDto.
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de lo
Message String
contrario, retorna el mensaje con la descripción del error.
IEnumerable(Of
Data Colección con los datos de los directorios del formulario consultados.
Directorio)
Rows Integer Retorna un el número de registros consultados.

Directorio
Tipo de
Nombre Descripción
dato
IdDirectorio Long Identificador único del directorio
IdFormulario Long Identificador único del formulario
IdDirectorioPadre Long Identificador único del directorio padre
Codigo String Código del directorio
Nombre String Nombre del directorio
IdEstado Integer Estado en el que se encuentra el directorio
Usuario String Usuario que creo el directorio
Fecha Date Fecha de creación del directorio
Host String Terminal de creación

21
16. Método Form_GetParameters
Recupera la información de creación relacionada a un formulario de WorkManager E. D®.
Firma del método:
Function Form_GetParameters(request As FormParametersRequestDto) As
FormParametersResponseDto

FormParametersRequestDto
Nombre Tipo de dato Descripción Requerido
FormCode String Código del formulario. SI
Objeto para enviar los datos de autenticación para poder
Header HeaderDto SI
consumir el servicio

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del
User String API SOAP de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

Respuesta del método:

FormParametersResponseDto.
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de lo
Message String
contrario, retorna el mensaje con la descripción del error.

Form Formulario Datos de configuración del formulario consultado.

Formulario
Nombre Tipo de dato Descripción
IdFormulario Long Identificador único del formulario
Codigo String Código del formulario
Tabla String Nombre de la tabla que representa el formulario en Base de Datos
Nombre String Nombre del formulario
Descripcion String Descripción del formulario
IdPadre Long Identificador único del formulario padre
Estado Integer Estado del formulario
ArchivoRequerido Boolean Valor entre 0 y 1 que determina si es obligatorio subir un archivo al radicar
WorkflowUnico Boolean Valor entre 0 y 1 que determina si un registro solo puede tener un proceso

17. Método File_Delete

Elimina cualquier archivo cargado a WorkManager E. D®.
Firma del método:

22
 Function File_Delete(request As StringFileRequestDto) As
FileDeleteResponseDto

StringFileRequestDto
Nombre Tipo de dato Descripción Requerido
FileCode String Código del archivo almacenado en WorkManager E.D. ®. SI
Objeto para enviar los datos de autenticación para poder consumir
Header HeaderDto SI
el servicio.

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del
User String API SOAP de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

Respuesta del método:

FileDeleteResponseDto.
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta,
Message String
de lo contrario, retorna el mensaje con la descripción del error.

18. Método Workflow_GetCases

Recupera los procesos (Workflow) de uno o varios registros de un formulario de
WorkManager E. D®.
Firma del método:
Function Workflow_GetCases(request As WorkflowCasesRequestDto) As
WorkflowCasesResponseDto

WorkflowCasesRequestDto
Nombre Tipo de dato Descripción Requerido
Objeto para enviar los datos del filtro de búsqueda para
FilterParameters FilterParametersDto SI
consultar los registros de un formulario.
Objeto para enviar los datos de autenticación para poder
Header HeaderDto SI
consumir el servicio.
FormCode String Código del formulario SI
Identificador del proceso en WorkManager E.D. ®.
ProcessId Int Recordar que el proceso debe estar asociado al SI
formulario y su estado debe ser “Producción”.

HeaderDto.
Nombre Tipo de dato Descripción Requerido

23
 Usuario autorizado para consumir los servicios de integración del
User String API SOAP de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

FilterParametersDto.
Nombre Tipo de dato Descripción Requerido
Nombre de la columna en la tabla que representa al formulario en la
Field String base de datos SQL Server por la cual se desea realizar el filtro de SI
búsqueda del registro a consultar.
Operador que se aplica entre los atributos Field y value en la tabla.
Operator String SI
Los valores posibles son: =, <>, >=, <=, Like
Valor del campo descrito anteriormente (Field) por el cual se
Value String SI
filtrará(n) el(los) registro(s) para realizar la operación de consulta.

Respuesta del método:

WorkflowCasesResponseDto.
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera
Message String
correcta, de lo contrario, retorna el mensaje con la descripción del error.
As List(Of
WorkflowCases Retorna la lista de flujos de trabajo asociados a la consulta.
WorkflowCaseDto)
Rows Integer Retorna un el número de registros consultados.

WorkflowCaseDto.
Nombre Tipo de dato Descripción
CreateDate DateTime Fecha inicio del flujo de trabajo.
FinishDate DateTime Fecha de finalización del flujo de trabajo
ProcessId Int Identificador del proceso asociado al formulario en WorkManager E.D. ®..
RecordId Long Identificador del registro en el formulario de WorkManager E.D. ®.
State String Estado en el que se encuentra el flujo de trabajo.
Identificador del flujo de trabajo asociado al registro del formulario de
WorkflowId Long
WorkManager E.D. ®.

19. Método Workflow_GetTasks

Recupera la información (Trazabilidad) de un proceso (Workflow) relacionado a un registro
de un formulario de WorkManager E. D®.
Firma del método:
Function Workflow_GetTasks(request As WorkflowTasksRequestDto) As
WorkflowTasksResponseDto.

WorkflowTasksRequestDto
Nombre Tipo de dato Descripción Requerido
Objeto para enviar los datos de autenticación para poder
Header HeaderDto SI
consumir el servicio.

24
 Identificador del flujo de trabajo asociado al registro del
WorkflowId Long SI
formulario de WorkManager E.D. ®.

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del
User String API SOAP de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

Respuesta del método:

WorkflowTasksResponseDto.
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de lo
Message String
contrario, retorna el mensaje con la descripción del error.
As List(Of
Tasks Retorna la lista del resumen del flujo de trabajo asociado a la consulta.
WorkflowTaskDto)
Rows Integer Retorna un el número de registros consultados.

WorkflowTaskDto.
Nombre Tipo de dato Descripción
CreateDate DateTime Fecha recepción de la tarea.
Description String Descripción de la tarea.
ExpirationDate DateTime Fecha de vencimiento de la tarea.
OwnerUser String Responsable de la tarea.
Priority String Prioridad de la tarea.
State String Estado en el que se encuentra la tarea.
Step Int Numero de paso (ejemplo: 1,2,3, etc).

20. Método Field_GetValues

Recupera los ítems de un campo asociado a una lista en un formulario de WorkManager
E. D®.
Firma del método:
Function Field_GetValues(request As FieldValuesRequestDto) As
FieldValuesResponseDto.

FieldValuesRequestDto
Nombre Tipo de dato Descripción Requerido
Objeto para enviar los datos de autenticación para
Header HeaderDto SI
poder consumir el servicio.
Nombre de la columna en la tabla que representa
ColumnName String SI
al formulario en la base de datos SQL Server.
FormCode String Código del formulario SI

HeaderDto.

25
 Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del
User String API SOAP de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

Respuesta del método:

FieldValuesResponseDto.
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de lo
Message String
contrario, retorna el mensaje con la descripción del error.
As List(Of
Items Retorna la lista de los ítems asociados a un campo tipo lista del formulario.
ListItemsDto)
Rows Integer Retorna un el número de registros consultados.

ListItemsDto.
Nombre Tipo de dato Descripción
Text String Texto del ítem asociado a la lista (descripción ejemplo: WorkManager E.D.).
Value String Código del ítem asociado a la lista (Ejemplo: 01, 02, etc).

21. Método GetToken

Genera el token dinámico para consumo de los métodos de la Api Soap V2 de
WorkManager E.D, cuando se haga la solicitud el token generado tendrá un tiempo de
expiración, el cual va entre 1 y 5 minutos.

Firma del método:

Function GetToken(request As TokenRequestDto) As TokenResponseDto

TokenRequestDto
Nombre Tipo de dato Descripción Requerido
Tiempo de expiración en segundos del token
ExpirationTimeSeconds String SI
generado por el método.
Usuario al cual se le generara el token
Password String SI
dinamico.
Contraseña del usuario al cual se le generara el
User String SI
token dinámico.

Respuesta del método:

TokenResponseDto.
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de lo
Message String
contrario, retorna el mensaje con la descripción del error.

26
 Si la operación es exitosa, genera el token dinámico, de lo contrario, retornara
Token String
“null=true”.
TokenDate String Fecha y hora en la que se generó el token.
User String Cuenta de usuario a la cual se le generó el token dinamico.

22. Método Workflow_StepsForReturn

Recupera los pasos a los cuales se puede realizar una devolución desde la actividad actual
de un flujo de trabajo en curso.

Firma del método:

Function Workflow_StepsForReturn(request As StepsForReturnRequestDto) As
StepsForReturnReturnResponseDto

StepsForReturnRequestDto
Nombre Tipo de dato Descripción Requerido
Objeto para enviar los datos de autenticación para poder
Header HeaderDto SI
consumir el servicio.
Nombre de la columna en la tabla que representa al formulario
ColumnName String SI
en la base de datos SQL Server.
WorkflowId Long Número de proceso SI

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del API
User String REST de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

Respuesta del método:

TokenResponseDto
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera
Message String
correcta, de lo contrario, retorna el mensaje con la descripción del error.
As List(Of
StepList Retorna la lista de los pasos a los cuales se puede realizar una devolución.
PosiblesPasosDevolucion)

23. Método Workflow_ReturnTasks

Devuelve la actividad actual de un flujo de trabajo al paso seleccionado.

Firma del método:

Function Workflow_ReturnTask(request As ReturnTasksRequestDto) As
ReturnTasksResponseDTO

27
 ReturnTasksRequestDto
Nombre Tipo de dato Descripción Requerido
Objeto para enviar los datos de autenticación para poder
Header HeaderDto SI
consumir el servicio.
Nombre de la columna en la tabla que representa al formulario
ColumnName String SI
en la base de datos SQL Server.
WorkflowId Long Número de proceso SI
Indica si la notificación e-mail debe ser generada utilizando
SealMail Boolean SI
SealMail
ReturnStep Long Paso al cual se realizará la devolución SI
Usuario del sistema que quedará registrado cómo autor de la
OperationUser String SI
inserción del registro en la base de datos.
Comment String Comentario que será insertado en la actividad SI

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del API
User String REST de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

Respuesta del método:

ReturnTasksResponseDTO
Tipo de
Nombre Descripción
dato
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de lo
Message String
contrario, retorna el mensaje con la descripción del error.

24. Método Workflow_AbortProcess

Interrumpe un flujo de trabajo activo.

Firma del método:

Function Workflow_AbortProcess(request As AbortProcessRequestDto) As
AbortProcessResponseDTO

AbortProcessRequestDto
Nombre Tipo de dato Descripción Requerido
Objeto para enviar los datos de autenticación para poder
Header HeaderDto SI
consumir el servicio.
Nombre de la columna en la tabla que representa al
ColumnName String SI
formulario en la base de datos SQL Server.
WorkflowId Long Número de proceso SI
Usuario del sistema que quedará registrado cómo autor de la
OperationUser String SI
inserción del registro en la base de datos.
Comment String Comentario que será insertado en la actividad SI

28
 HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del API
User String REST de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

Respuesta del método:

AbortProcessResponseDTO
Tipo de
Nombre Descripción
dato
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de lo
Message String
contrario, retorna el mensaje con la descripción del error.

25. Método Workflow_GetFileCodes

Recupera los códigos de archivo (y otros atributos adicionales) suministrando el número de
proceso del flujo de trabajo.

Firma del método:

Function Workflow_GetFileCodes(request As FileCodesRequestDto) As FileResponseDto

FileCodesRequestDto
Nombre Tipo de dato Descripción Requerido
Objeto para enviar los datos de autenticación para poder
Header HeaderDto SI
consumir el servicio.
Nombre de la columna en la tabla que representa al
ColumnName String SI
formulario en la base de datos SQL Server.
WorkflowId Long Número de proceso SI
Usuario del sistema que quedará registrado cómo autor de la
OperationUser String SI
inserción del registro en la base de datos.
Comment String Comentario que será insertado en la actividad SI

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del API
User String REST de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

Respuesta del método:

FileResponseDto
Nombre Tipo de dato Descripción
Success Boolean Retorna uno de los siguientes valores al realizar la operación:

29
 True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de
Message String
lo contrario retorna el mensaje con la descripción del error.
IEnumerable(Of
FileProperties Encapsula la información del archivo asociado al radicado.
FilePropertiesDto)
Rows Integer Retorna el número de registros consultados.

26. Método File_CopyToFather

Realiza copia de un archivo cargado a un registro de un formulario hijo en una carpeta de la
estructura del formulario padre.

Firma del método:

Function File_CopyToFather(request As FileCopyToFatherRequestDto) As
FileCopyResponseDto

FileCopyToFatherRequestDto
Nombre Tipo de dato Descripción Requerido
Objeto para enviar los datos de autenticación para poder
Header HeaderDto SI
consumir el servicio.
BarCodeSon String Número de radicado WorkManager E.D. del formulario hijo. SI
FileCode String Código del archivo almacenado en WorkManager E.D. SI
Código del directorio del formulario padre en donde se
DirectoryCodeFather String almacenará el archivo, se identifica desde WorkManager SI
E.D.

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del API
User String REST de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

Respuesta del método:

FileCopyResponseDto
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de
Message String
lo contrario retorna el mensaje con la descripción del error.

27. Método File_CopyToEP

Realiza copia de un archivo cargado en WorkManager E.D. a un directorio de la estructura
principal.

30
Firma del método:
Function File_ CopyToEP (request As FileCopyToEPRequestDto) As FileCopyResponseDto

FileCopyToEPRequestDto
Nombre Tipo de dato Descripción Requerido
Objeto para enviar los datos de autenticación para poder
Header HeaderDto SI
consumir el servicio.
FileCode String Código del archivo almacenado en WorkManager E.D. SI
Código del directorio de la estructura principal de
DirectoryCodeEP String SI
WorkManager E.D.

HeaderDto.
Nombre Tipo de dato Descripción Requerido
Usuario autorizado para consumir los servicios de integración del API
User String REST de integración. Este dato es suministrado por Estrategias SI
Documentales S.A.S.
Token de Autenticación. Este dato es suministrado por Estrategias
Token String SI
Documentales S.A.S.

Respuesta del método:

FileCopyResponseDto
Nombre Tipo de dato Descripción
Retorna uno de los siguientes valores al realizar la operación:
Success Boolean True: Si la operación se realiza de manera correcta.
False: Si la operación presenta errores o inconvenientes.
Retorna el valor de “OK” cuando la operación se realiza de manera correcta, de
Message String
lo contrario retorna el mensaje con la descripción del error.

31