Workflows
Listar workflows
Devuelve los workflows de la cuenta con cómo se inicia cada uno y, para los manuales, el formulario de ejecución: los campos que POST /api exige en payload, leídos de la versión publicada.
workflows:readworkflows:read- 120/min
- Anotación del servidor: Solo lectura
- Anotación del servidor: Idempotente
Resultado
generado desde el esquema
No emite ninguna definición. Solo administradores. Ordenados por nombre.
Argumentos
Tamaño de página (1-500). Por defecto es 50.
Límites: mín. 1, máx. 500
Cursor opaco de la página que se devuelve. Pasa el valor de pagination. de la respuesta anterior; trátalo como opaco.
Límites: longitud máx. 200
Orden: hasta 3 campos separados por comas, cada uno con un "-" inicial para descendente (p. ej. "-updatedAt,name"). Campos ordenables: name, isActive, triggerType, createdAt, updatedAt. Por defecto, "name". Los empates se resuelven por id, así que el orden es estable entre páginas, y un cursor queda ligado al orden con el que se emitió.
Límites: longitud máx. 200
Filtra según si el workflow está activo (true) o en pausa (false).
Filtra por cómo se inicia el workflow: manual, schedule, webhook, event, signal o entity.
Opciones disponibles: manual, schedule, webhook, event, signal, entity
Filtra por triggerType, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.
Opciones disponibles: manual, schedule, webhook, event, signal, entity
Límites: mín. 1 elementos, máx. 50 elementos
Ponlo en true para incluir pagination., el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.
Filtros de fecha por campo. Una fecha sin hora (YYYY-MM-DD) se lee en la zona horaria del negocio; un instante ISO 8601 con desplazamiento se aplica tal cual con gte, lte, gt y lt, mientras que on lo amplía al día completo del negocio que lo contiene. Campos: created, updated.
Mostrar atributos hijosOcultar atributos hijos
Mostrar atributos hijosOcultar atributos hijos
Desde este día o instante, inclusive.
Hasta este día o instante, inclusive.
Estrictamente posterior; una fecha sin hora significa después del final de ese día.
Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.
Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.
Mostrar atributos hijosOcultar atributos hijos
Desde este día o instante, inclusive.
Hasta este día o instante, inclusive.
Estrictamente posterior; una fecha sin hora significa después del final de ese día.
Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.
Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.
Resultado
En un éxito el resultado lleva structuredContent con data y meta. Estos son los atributos de data.
Ver los atributos de data
Identificador único del workflow.
Nombre del workflow.
true cuando el workflow está activo; false cuando está en pausa.
Fecha en que se archivó en ISO 8601 UTC; null si no está archivado.
Cómo se inicia el workflow y, si es manual, qué pide.
Mostrar atributos hijosOcultar atributos hijos
Cómo se inicia el workflow: manual (una persona o la API lo ejecuta), schedule (cron), webhook (una petición entrante), event (ocurre algo en Filmo), signal (otro workflow) o entity (se ejecuta desde la página de un registro). Null si no tiene versión publicada.
Opciones disponibles: manual, schedule, webhook, event, signal, entity
Para los triggers event, el evento de Filmo que escucha; null en caso contrario.
Para los triggers entity, el tipo de entidad sobre el que se ejecuta; null en caso contrario.
Para los triggers manual, el formulario de ejecución: todos los campos listados son OBLIGATORIOS en payload al llamar a POST /api. Vacío cuando el workflow no pide nada.
Mostrar atributos hijosOcultar atributos hijos
Clave del campo en payload al ejecutar el workflow.
Texto que ve la persona que lo ejecuta.
Tipo declarado del valor, en el lenguaje de tipos de los workflows: {"type":"string"}, {"type":"number"}, {"type":"boolean"}, {"type":"date","mode":"date"|"datetime"}, {"type":"enum","options":[{"value","label"}]}, {"type":"shape","shape":[{"key","label","value":<type>}]}, {"type":"list","item":<type>}, {"type":"record","value":<type>} o {"type":"tuple","tuple":[<type>]}. El valor enviado en payload se valida contra él.
La versión publicada, que es la que se ejecuta y de la que se lee el formulario de ejecución; null cuando el workflow nunca se ha guardado.
Mostrar atributos hijosOcultar atributos hijos
Número de la versión publicada.
Cuándo se publicó, en ISO 8601 UTC.
Fecha de creación en ISO 8601 UTC.
Fecha de la última modificación en ISO 8601 UTC.
Un error es un resultado con isError: true y el problema en content[0].; no hay structuredContent. Consulta Errores.
Prompts de ejemplo
¿Qué workflows puedo ejecutar desde aquí?
La misma operación por REST
Esta herramienta ejecuta GET /api/v1/workflows.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasWorkflows
Listar workflows
Devuelve los workflows de la cuenta con cómo se inicia cada uno y, para los manuales, el formulario de ejecución: los campos que
POST /apiexige en/v1 /workflows /{workflowId} /runs payload, leídos de la versión publicada.Guías
Escrituras seguras
Un asistente que puede escribir también puede escribir lo equivocado. Decide qué herramientas necesitan a una persona, reintenta sin duplicar y sabe qué pone en marcha una escritura.
Guías
Errores
Un error de herramienta es un resultado con
isError: truey el problema en el primer bloque de texto. Ramifica por sucode.
¿Te ha resultado útil esta página?