Formato compute

GET /api/event-criterias/:id?format=compute

Retorna um filtro de eventos como uma lista plana de condições, em vez da árvore completa. É o outro ramo do query param format de GET /event-criterias/:id.

Auth: Obrigatória — permissão event-criteria:view

Esta representação é mais estreita que a definição: transporta condições de linha sobre um único bloco de consulta. Um filtro cuja definição não cabe nela é rejeitado com 422 e um código que diz exatamente o que não cabe — nunca se retorna uma versão degradada do filtro.

Parâmetros de rota

Parâmetros de consulta

Exemplo

curl "https://api.reten.ai/api/event-criterias/9f3a1c22-4b7e-4c31-9a8d-2f5e6b7c8d90?format=compute" \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "x-project-id: <project-id>"

import axios from 'axios';

const id = '9f3a1c22-4b7e-4c31-9a8d-2f5e6b7c8d90';
const response = await axios.get(
  `https://api.reten.ai/api/event-criterias/${id}`,
  {
    headers: { Authorization: 'Bearer <token>', 'x-tenant-id': '<tenant-id>', 'x-project-id': '<project-id>' },
    params: { format: 'compute' },
  },
);
const computeCriteria = response.data;

Forma da resposta 200 OK

IComputeEventCriteria:

Cada elemento de conditions é uma de duas formas, distinguíveis pelo seu operator:

Condição escalar

Condição de registro

Os quatro casos

1 · Condição escalar

Eventos cujo status é Facturada.

{
  "id": "9f3a1c22-4b7e-4c31-9a8d-2f5e6b7c8d90",
  "name": "Venta oficial — solo facturada",
  "conditions": [
    {
      "field": "status",
      "operator": "=",
      "value": "Facturada",
      "source": "event_transactions"
    }
  ]
}

2 · Registro com dois sub-filtros

Eventos com um atributo cuja key é documento_tipo e cujo value é factura.

{
  "id": "1c7d2e83-5a90-4f62-8b31-6d4e5f70a1b2",
  "name": "Documentos tipo factura",
  "conditions": [
    {
      "field": "attributes",
      "operator": "CONTAINS_RECORD",
      "source": "event_transactions",
      "match_all": true,
      "sub_filters": [
        { "field": "key", "operator": "=", "value": "documento_tipo" },
        { "field": "value", "operator": "=", "value": "factura" }
      ]
    }
  ]
}

3 · Escalar + registro

Vendas faturadas com pelo menos uma linha que não é uma devolução.

{
  "id": "4b8e0f15-2c76-4a03-9d58-7e1f2a3b4c5d",
  "name": "Ventas con ítems no-devolución",
  "conditions": [
    {
      "field": "status",
      "operator": "=",
      "value": "Facturada",
      "source": "event_transactions"
    },
    {
      "field": "items",
      "operator": "CONTAINS_RECORD",
      "source": "event_transactions",
      "match_all": true,
      "sub_filters": [
        { "field": "category", "operator": "NOT IN", "value": ["devolucion"] }
      ]
    }
  ]
}

4 · Escalar + tabela relacionada

Vendas faturadas com pelo menos uma linha cujo produto é da categoria Food Service ou HORECA. A condição sobre a tabela relacionada chega no mesmo nível que as demais, distinguida pelo seu source: o caminho até product_properties não viaja.

{
  "id": "6d2a9c41-7e35-48b0-b1c9-0f8e7d6c5b4a",
  "name": "Proyecto Food Service",
  "conditions": [
    {
      "field": "status",
      "operator": "=",
      "value": "Facturada",
      "source": "event_transactions"
    },
    {
      "field": "categorization.category_name",
      "operator": "IN",
      "value": ["Food Service", "HORECA"],
      "source": "product_properties"
    }
  ]
}

O que significa match_all

É onde uma integração mais facilmente erra, então fica explícito:

1. match_all combina os sub_filters dentro do elemento, não entre os elementos. match_all: true significa que existe um elemento do array que satisfaz todos os sub_filters. Um elemento que corresponde só em key ou só em value não o satisfaz.
2. match_all: false é o mesmo existencial com OR dentro: existe um elemento que satisfaz pelo menos um dos sub_filters. Nunca significa "todos os elementos".
3. Com um único sub_filter sempre viaja match_all: true. Com menos de dois sub-filtros o conectivo não muda o resultado, e true é a forma canônica.
4. CONTAINS_RECORD é existencial também com operadores negativos. items com category NOT IN ["devolucion"] e match_all: true significa "existe um item que não é devolução", não "nenhum item é devolução". Esta representação não consegue expressar quantificação universal.
5. Um array vazio ou NULL nunca satisfaz um CONTAINS_RECORD, e um sub-campo em NULL não corresponde, nem mesmo com um operador negativo.

O que significa field

O field é o caminho completo relativo ao seu escopo, e o escopo nunca se repete:

Subconjunto de operadores

Os operadores viajam como literais SQL, não como os membros do enum da definição:

CONTAINS_RECORD não traduz nenhum operador de comparação: quem o emite é a folha de registro.

Tipo JSON do value

Com qual tipo JSON o valor viaja é fixado pelo tipo da coluna no catálogo, não pela forma em que a definição ficou salva:

Resposta 422 Unprocessable Entity

O filtro é válido e compila para SQL; o que não existe é a sua projeção para esta representação. O corpo traz o diagnóstico:

{
  "code": "TIME_WINDOW_UNSUPPORTED",
  "path": "queryBlocks[0].timeWindow",
  "message": "No se puede proyectar queryBlocks[0].timeWindow (TIME_WINDOW_UNSUPPORTED): el wire no transporta la ventana IN_THE_LAST"
}

Os doze códigos

Relação com conditionCount

Respostas de erro