API para obtener datos de documentos por proceso - Automate_Evolve - Automate_Studio_Manager - 20.3

Información general de la API

1. En los procesos basados en formularios, el documento de formulario se devolverá en formato JSON o XML según el valor especificado para el parámetro Formato. Si no se especifica el formato, la aplicación considerará el formato JSON como formato predeterminado.

2. En los procesos de workflow de Excel, el documento se devolverá siempre en formato Excel.

Ejemplo de solicitud y respuesta

Esta API devuelve la última copia del documento del proceso para el id. del proceso especificado. La estructura de la solicitud y la respuesta serán similares a las siguientes:

Contrato de datos de solicitud:

No se requiere un cuerpo de solicitud.

A continuación, se indican los parámetros de la URL de solicitud.

• DocumentType: Puede ser Excel o formulario.

• ProcessID: Es el GUID del proceso.

• Formato del resultado (opcional): Puede ser «json» o «xml». Funciona solo para documentos de formulario.

A continuación, se muestran los ejemplos de la solicitud:

Ejemplo 1

<Route Prefix>/api/v1/Processextn/GetDocumentDataByProcess/Excel/EDE8CF75-248C-407D-A5B8-0209759003D4

Ejemplo 2

<Route Prefix>/api/v1/Processextn/GetDocumentDataByProcess/Form/DC135B5A-DE73-4D84-BCB5-01CB5A0EBFC0

Ejemplo 3

<Route Prefix>/api/v1/Processextn/GetDocumentDataByProcess/Form/DC135B5A-DE73-4D84-BCB5-01CB5A0EBFC0/xml

Contrato de datos de respuesta:

1. Solución de formularios (formato JSON):

   Los datos de los campos de formulario (añadidos en la solución de formularios) se devolverán en formato JSON como se muestra a continuación:

   {     "my:myFields":      {         <<Form Data in json as per Form solution feilds added to the Form solution.>>           } }

2. Solución de formularios (formato XML):

   Los datos de los campos de formulario (añadidos en la solución de formularios) se devolverán en formato XML como se muestra a continuación:

   "<my:myFields xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"  xmlns:xhtml=\"http://www.w3.org/1999/xhtml\"  xmlns:pc=\"http://schemas.microsoft.com/office/infopath/2007/PartnerControls\"  xmlns:d=\"http://schemas.microsoft.com/office/infopath/2003/ado/dataFields\"  xmlns:dfs=\"http://schemas.microsoft.com/office/infopath/2003/dataFormSolution\"  xmlns:my=\"http://schemas.microsoft.com/office/infopath/2003/myXSD\"  xmlns:xd=\"http://schemas.microsoft.com/office/infopath/2003\">

   Datos de formulario en XML según los campos de la solución de formularios añadidos a esta solución.

   </my:myFields>

3. Solución de Excel:

   Esto devolverá los datos en base64:

   {   “Title”:”DocumentName”,   “content”:”base64string” }