Buscar cards do flow

Executa uma busca de cards dentro de um único flow, usando uma linguagem de condições que aceita árvores de filtros aninhadas e agregações sobre coleções.

Este endpoint não deve ser confundido com os filtros salvos (/v1/flows/{id}/filters): ali é persistida uma configuração de visualização reutilizável; aqui é executada uma consulta pontual, que retorna diretamente os cards encontrados.

A requisição não é paginada — os campos page e pageSize não são aceitos e retornam erro 400 caso estejam presentes no corpo. O envelope exige obrigatoriamente order, orderBy, fields (a projeção de caminhos retornada por card) e conditions, este último uma lista não vazia de nós de condição.

Cada nó de condição é um grupo (com logic e uma lista de subcondições) ou uma folha (com um caminho de campo e, opcionalmente, operador e valor de comparação); em ambos os casos, o campo scope — any, all ou sum — é obrigatório e define a semântica de agregação sobre coleções.

Os caminhos válidos para orderBy, fields e conditions dependem do catálogo de campos do flow. O uso de um caminho ou operador incompatível pode não ser barrado pela validação inicial do envelope e resultar em um erro interno do servidor em vez de uma mensagem de validação amigável — recomendamos consultar previamente os caminhos disponíveis para o flow antes de montar a busca.

Note que, diferentemente dos filtros salvos, o parâmetro de flow neste caminho é {flowId}, e não {id}.

application/json

Lista de cards do flow que atendem às condições informadas, projetados pelos caminhos indicados em fields e ordenados conforme order/orderBy.

Bodyapplication/json

curl --location '/v1/filters/flows//search' \ --header 'Content-Type: application/json' \ --data '{ "order": "asc", "orderBy": "card.enteredCurrentPhaseAt", "fields": [ { "path": "card.title" }, { "path": "card.value" } ], "conditions": [ { "scope": "any", "path": "card.value", "operator": "gte", "value": 0 } ] }'

Buscar cards do flow

Requisição

Respostas