La API para iniciar procesos de formulario permite iniciar un proceso de workflow de formularios. Esta API usa el método POST para iniciar un proceso de workflow. Los datos de formulario iniciales deben enviarse en formato XML. Debe ser un XML de formulario válido, ya que no se realiza ninguna validación de datos ni se ejecutan reglas al guardar los datos de formulario.
Información general de la API
A continuación, se ofrece información general sobre la API para iniciar procesos:
-
Admite la función de Plantilla de nombre. La plantilla de nombre debe configurarse con el control de Nombre de formulario. La propiedad del control de Nombre del formulario Ejecutar en debe establecerse en Finalizar. Al llamar a la API de acceso digital, el campo de formulario asignado a la propiedad Nombre de campo del control Nombre de formulario debe estar vacío.
-
El usuario de Evolve especificado como remitente del formulario debe tener el rol Originador en la solución para la que se debe iniciar el proceso de formulario nuevo.
-
Opcionalmente, se puede especificar el participante del proceso o el usuario de fase en la solicitud de API.
-
Un proceso de workflow de formularios iniciado desde la API se etiquetará como documento de API y, si se vuelve a enviar manualmente, el documento de proceso cancelado se seguirá considerando como documento de API. Esta información se tendrá en cuenta para la facturación de las licencias.
-
Al copiar un documento de formulario, se crea un documento nuevo en el sistema. El documento copiado de un documento de API e iniciado o enviado manualmente desde la interfaz de usuario web se considerará como un documento que no es de API (por ejemplo, un documento enviado de forma manual).
Cuerpo de solicitud y respuesta
Para iniciar un proceso de formularios a través de la API, la estructura de solicitud y respuesta será la siguiente:
Contrato de datos de solicitud:
| Nombre | Tipo | Restricción | Descripción |
|---|---|---|---|
| AppName | cadena | Necesario | Nombre de aplicación de la «solución de formularios». |
| Comentarios | cadena | - | Comentarios sobre el nodo Inicio. |
| FormXML | cadena | - | Son los datos de formulario del proceso de formulario nuevo. Debe ser un XML de formulario válido para la solución de formularios. |
| LibName | cadena | Necesario | Nombre de biblioteca de la «solución de formularios». |
| ParticipantsInfoArray | Jarray de { «SwimlaneName»: «abc», «UserName»: «xyz» } | - |
Debe ser el nombre de la fase, que debe resolverse con los usuarios indicados.
Si este parámetro se deja en blanco o no se proporcionan detalles específicos de las fases, la aplicación resolverá estas fases según el comportamiento definido en el proceso de workflow. Para la fase de tipo Persona en el proceso de workflow de formularios, el valor del usuario de fase no puede reemplazarse cuando se inicia el formulario a través de la API. |
| TemplateName | cadena | Necesario | Nombre de la «solución de formularios». |
| UserName | cadena | Necesario | Nombre del usuario que se establecerá como originador del proceso. El usuario debe tener el rol Originador en la solución para la que se debe iniciar el proceso de formulario nuevo. |
Contrato de datos de respuesta:
| Nombre | Tipo | Restricción | Descripción |
|---|---|---|---|
| processId | Guid | - | Id. de devolución del proceso. |
| FormItemId | Guid | - | Id. de devolución del documento de formulario. |
Ejemplo de solicitud y respuesta
El siguiente ejemplo muestra el uso de la API:
Ruta: http://Winshuttle.EvolveUrl/svr/api/v1/Processextn/StartFormProcess
Carga útil de solicitud
{ "AppName":"My API", "LibName": "Form Process Ext", "TemplateName": "API Product Example", "UserName": "mydomain\\user1", "Comments": "Process from API2", "FormXml": "<my:myFields xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xhtml=\"http://www.w3.org/1999/xhtml\" 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\" xmlns:msxsl=\"urn:schemas-microsoft-com:xslt\"> <my:Product_Name>Evolve</my:Product_Name><my:Product_Description>Evolve product desc</my:Product_Description></my:myFields>", "ParticipantsInfoArray": [ { "SwimLaneName": "PersonSwimlane", "UsersName": "mydomain\\user1" }, { "SwimLaneName": "TeamSwimlane", "UsersName": "mydomain\\user1,mydomain\\user2" } ] }Carga útil de respuesta
{ "ProcessId": "93ae1e24-366e-4e54-af5c-dbf34ec15797", "FormItemId": "0e6c9998-3e3d-4e89-9fd4-e8086312cb32" }