Otras acciones

Además de la creación y consulta de instancias de un formulario, existen múltiples acciones aplicadas al uso de formularios que aportan un valor adicional y ayudan a optimizar el flujo de trabajo.

Veamos algunas de ellas a continuación.

Get Form Instance State

Devuelve el estado de una instancia de formulario, es decir, si se encuentra en estado de borrador o confirmada. Presenta los siguientes parámetros:

Parámetros
Dirección
Tipo de dato
Descripción

formInstanceId

In

Texto

ID de la instancia de formulario

state

Out

Texto

Estado de la instancia de formulario

lastSaved

Out

Texto

Fecha y hora del último guardado

Response

Out

Colección

Colección conteniendo todos los datos anteriores de la instancia de formulario

Get Form Instance Response

Incluye las propiedades de Get Form Instance State pero permite también recopilar los datos que hayan sido ingresados en una instancia de formulario, mostrándolos como valores. Sus propiedades son las siguientes:

Parámetros
Dirección
Tipo de dato
Descripción

formInstanceId

In

Texto

ID de la instancia de formulario

formDefinitionID

Out

Texto

ID de la plantilla a la cual pertenece la instancia

formInstanceId

Out

Texto

ID de la instancia de formulario, ya que se incluirá en la salida final

lastSaved

Out

Texto

Fecha y hora del último guardado

state

Out

Texto

Estado de la instancia de formulario

values

Out

Colección

Valores ingresados en la instancia de formulario

Response

Out

Colección

Colección conteniendo todos los datos anteriores de la instancia de formulario

Get Form Instance Token

Permite generar un nuevo token público para una instancia de formulario (por ejemplo, porque se encuentra vencido) definiendo los siguientes parámetros:

Parámetros
Dirección
Tipo de dato
Descripción

formInstanceId

In

Texto

ID de la instancia de formulario

expiresAt

In

Fecha y hora

Fecha de vencimiento del token

formInstanceId

Out

Texto

ID de la instancia de formulario, ya que se incluirá en la salida final

sharedFormToken

Out

Texto

Token que permite visualizar y modificar la instancia generada

URL

Out

Texto

Dirección accesible desde el navegador formada por la URL básica y el token

Response

Out

Colección

Colección conteniendo todos los datos anteriores de la instancia de formulario

Set Form Instance Process Info

Permite brindar a las personas que utilicen el portal o la aplicación de Teams la posibilidad de revisar el estado de los formularios que hayan enviado, el cual se refleja en las columnas “Estado del Proceso” y “Completado”.

Visualización del estado de un formulario en el Portal

Esta acción se configura con los siguientes parámetros:

Parámetros
Dirección
Tipo de dato
Descripción

formInstanceId

In

Texto

ID de la instancia de formulario

status

In

Texto

Estado de procesamiento de la instancia que se mostrará al usuario

endState

In

Texto

Estado de procesamiento final, cuyas opciones son “OK” o “Error”

completionMessage

In

Texto

Mensaje especificando las condiciones en que finalizó la instancia

Delete Form Instance

Permite borrar una instancia de formulario. Sus principales propiedades son:

Parámetros
Dirección
Tipo de dato
Descripción

formInstanceId

In

Texto

ID de la instancia de formulario

force

In

Flag

Fuerza la eliminación de una instancia

Get Attachments / Download Attachment

Estas acciones se encuentran estrechamente vinculadas, ya que la primera permite listar todos los archivos adjuntos en los campos de este tipo de determinada instancia, y la segunda, permite descargar todos los archivos del listado obtenido.

Veamos las propiedades de la acción Get Attachments:

Parámetros
Dirección
Tipo de dato
Descripción

formInstanceId

In

Texto

ID de la instancia de formulario

stageIndex

In

Número

Stage del cual se obtienen los adjuntos

Attachments

Out

Colección

Lista de URLs para descargar los archivos

Por su parte, la acción Download Attachment incluye los siguientes parámetros:

Parámetros
Dirección
Tipo de dato
Descripción

AttachmentURL

In

Texto

URL de la que descargar el archivo

Path

In

Número

Ruta donde se guardará el archivo descargado

Upload FormInstance Resource / Delete FormInstance Resource

Estas acciones permiten, respectivamente, añadir y eliminar un recurso de una instancia de formulario. El tipo de recursos que se gestionan por esta vía no se encuentran incluidos en el diseño del formulario, sino que se añaden como enlaces externos con material descargable:

Las propiedades a definir para cargar un nuevo recurso son:

Parámetros
Dirección
Tipo de dato
Descripción

formInstanceId

In

Texto

URL de la que descargar el archivo

Path

In

Número

Ruta en la cual se adjuntará el archivo

Para eliminarlo, en cambio, deberá establecerse:

Parámetros
Dirección
Tipo de dato
Descripción

formInstanceId

In

Texto

URL de la que descargar el archivo

ResourceName

In

Texto

Nombre del recurso del cual se quiere eliminar el adjunto

Last updated