# Dicionário

Ele possibilita a manipulação de dados estruturados, permitindo maior flexibilidade para armazenar e recuperar informações com filtros e parâmetros específicos.

Com ele, é possível adicionar novos registros ao dicionário, modificar dados existentes, remover registros, buscar informações por ID e realizar consultas avançadas filtrando múltiplos critérios.

### 📂 **Operações Disponíveis**

Aqui estão as operações que podem ser realizadas com este componente:

| **Operação**                            | **Descrição**                                         |
| --------------------------------------- | ----------------------------------------------------- |
| **Criar (create)**                      | Adiciona um novo registro ao dicionário.              |
| **Atualizar (update)**                  | Modifica os dados de um registro existente.           |
| **Excluir (delete)**                    | Remove um registro do dicionário.                     |
| **Buscar por ID (get\_by\_id)**         | Obtém os detalhes de um registro específico.          |
| **Buscar por filtro (get\_by\_filter)** | Obtém uma lista de registros filtrados por critérios. |

### 📑 **Variáveis Utilizadas no Componente**

Abaixo estão as variáveis utilizadas no componente **Dicionário**, incluindo seus tipos de dados e obrigatoriedade.

| **Campo**                | **Tipo de Dado** | **Obrigatório?** | **Descrição**                                                                                              |
| ------------------------ | ---------------- | ---------------- | ---------------------------------------------------------------------------------------------------------- |
| **Workspace ID**         | `string`         | ✅ Sim            | ID do workspace onde a tabela do dicionário está localizada.                                               |
| **Nome da Tabela**       | `string`         | ✅ Sim            | Identificador da tabela no dicionário onde os dados estão armazenados.                                     |
| **ID do Registro**       | `string`         | ❌ Não            | Identificador único do registro no dicionário. Necessário para operações que manipulam um item específico. |
| **Campos (JSON)**        | `object`         | ✅ Sim            | Estrutura contendo os dados do registro a ser criado ou atualizado.                                        |
| **Método de Filtro**     | `string`         | ❌ Não            | Define se a busca por filtro será feita utilizando os campos do dicionário ou via query direta.            |
| **Parâmetros de Filtro** | `object`         | ❌ Não            | Estrutura contendo os filtros aplicados para a consulta ao dicionário.                                     |
| **Ordenação**            | `string`         | ❌ Não            | Define o critério de ordenação dos registros retornados.                                                   |
| **Direção da Ordenação** | `string`         | ❌ Não            | Indica se a ordenação será ascendente (`asc`) ou descendente (`desc`).                                     |
| **Paginação (Página)**   | `number`         | ❌ Não            | Número da página a ser recuperada na busca por filtro.                                                     |
| **Paginação (Limite)**   | `number`         | ❌ Não            | Número máximo de registros a serem retornados por página.                                                  |

### 🎯 **Como Configurar uma Operação**

#### 1️⃣ **Acesse o Componente**

1. No **Hablla Studio**, abra o fluxo de automação onde deseja incluir a ação.
2. Adicione o bloco **"Dicionário"**.
3. No **painel lateral direito**, selecione a operação desejada.

#### 2️⃣ **Preencha os Campos Obrigatórios**

Dependendo da operação escolhida, alguns campos são obrigatórios. Consulte a tabela de variáveis acima para entender quais dados devem ser preenchidos para cada operação.

#### 3️⃣ **Salvar a Configuração**

Após preencher os campos, clique no botão **"Salvar"** ✅.

Agora, sempre que essa automação for acionada, os registros do dicionário serão gerenciados conforme a configuração definida.

### 📝 **Detalhamento das Operações**

Cada operação possui campos obrigatórios e opcionais que devem ser preenchidos conforme o caso. Abaixo, detalharemos cada uma delas:

1️⃣ **Criar Registro no Dicionário**\
2️⃣ **Atualizar Registro no Dicionário**\
3️⃣ **Excluir Registro do Dicionário**\
4️⃣ **Buscar Registro por ID**\
5️⃣ **Buscar Registros por Filtro**

🚀 **Continue para os próximos tópicos para configurar cada operação corretamente!**