Listagem de Dados de Estrutura do Datalogic

Descrição

Endpoint responsável por listar os registros já armazenados na tabela física de uma estrutura do Datalogic 📄.

O formato de cada registro é dinâmico: reflete exatamente as colunas cadastradas na estrutura no momento da consulta.

Além das colunas dinâmicas, todo registro traz os campos fixos id, created_at e updated_at.

O acesso aos dados depende da flag publicRead configurada na estrutura.

Quando publicRead é true, a listagem pode ser consultada sem autenticação de usuário.

Quando publicRead é false, é necessário enviar um token de usuário autenticado; caso contrário, a consulta é rejeitada.

Apenas colunas que compõem algum índice cadastrado na estrutura podem ser usadas nos parâmetros condition e order.

Isso vale além dos campos fixos id, created_at e updated_at, que estão sempre disponíveis para filtro e ordenação.

Os nomes de campo em condition e order devem ser enviados exatamente como estão na tabela física, em snake_case.

Por exemplo, use created_at, e não createdAt.

Colunas sem índice associado não podem ser filtradas nem ordenadas.

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Campos de Condição e Ordenação Disponíveis

Exemplo de Requisição

1curl --request GET \
2  --url https://sua-loja-uappi.com.br/api/v3/tools/datalogic/storage/data/clientes_vip_a1b2c3d4 \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "condition": [
6      {
7        "field": "customer_name",
8        "value": "Maria Silva",
9        "operator": "="
10      }
11    ],
12    "order": [
13      {
14        "field": "created_at",
15        "order": "desc"
16      }
17    ],
18    "limit": 10,
19    "offset": 0
20  }'

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": {
4    "registers": [
5      {
6        "id": 1,
7        "customer_name": "Maria Silva",
8        "total_amount": "150.90",
9        "created_at": "2026-07-14 09:00:00",
10        "updated_at": "2026-07-14 09:00:00"
11      }
12    ],
13    "pagination": {
14      "limit": 10,
15      "offset": 0,
16      "pages": 1,
17      "registers": 1
18    }
19  }
20}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

Cadastro/Atualização em Massa de Dados de Estrutura do Datalogic

Descrição

Endpoint responsável por inserir ou atualizar registros em lote na tabela física de uma estrutura do Datalogic 📥.

O formato de cada linha (row) é dinâmico: os campos aceitos correspondem exatamente às colunas cadastradas na estrutura no momento da requisição.

Enviar uma linha sem o campo id cria um novo registro.

Enviar uma linha com o campo id atualiza o registro correspondente, preenchendo com nulo as colunas não informadas que ainda não possuem valor.

Campos que não correspondem a nenhuma coluna cadastrada na estrutura são ignorados silenciosamente, sem gerar erro.

Os campos created_at e updated_at não podem ser enviados na requisição.

Cada linha é validada individualmente contra o tipo, tamanho e casas decimais de cada coluna.

Uma linha inválida não interrompe o processamento das demais.

O response retorna todas as linhas: as com erro trazem um campo error adicional, e as válidas trazem o registro já persistido.

O lote aceita no máximo 100 linhas por requisição.

🔐 Permissão

• DATALOGIC_DATA_WRITE — Escopo de permissão para escrita de dados nas estruturas do Datalogic.

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Parâmetros do Corpo

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/tools/datalogic/storage/data/clientes_vip_a1b2c3d4 \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "rows": [
6      {
7        "customer_name": "Maria Silva",
8        "total_amount": 150.90
9      },
10      {
11        "id": 2,
12        "customer_name": "João Souza",
13        "total_amount": 99.999
14      }
15    ]
16  }'

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": [
4    {
5      "id": 2,
6      "customer_name": "João Souza",
7      "total_amount": 99.999,
8      "error": {
9        "errorCode": "UAPPI_TOOLS_DATALOGIC_DATA_LENGTH_EXCEEDED",
10        "code": 400,
11        "message": "The value exceeds the column (total_amount) length or decimal places.",
12        "details": []
13      }
14    },
15    {
16      "id": 1,
17      "customer_name": "Maria Silva",
18      "total_amount": "150.90",
19      "created_at": "2026-07-14 09:00:00",
20      "updated_at": "2026-07-14 09:00:00"
21    }
22  ]
23}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

Os erros abaixo, exceto o de estrutura não encontrada, não interrompem a requisição.

Eles aparecem no campo error da linha correspondente, dentro de uma resposta 200.

Remoção em Massa de Dados de Estrutura do Datalogic

Descrição

Endpoint responsável por remover um ou mais registros da tabela física de uma estrutura do Datalogic pelo id 🗑️.

A remoção é feita diretamente pelos ids informados; ids que não correspondem a nenhum registro existente são simplesmente ignorados, sem gerar erro.

O retorno é a quantidade de registros efetivamente removidos, que pode ser menor que a quantidade de ids informados.

🔐 Permissão

• DATALOGIC_DATA_WRITE — Escopo de permissão para escrita de dados nas estruturas do Datalogic.

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Parâmetros do Corpo

Exemplo de Requisição

1curl --request DELETE \
2  --url {{MAIN_URL}}/tools/datalogic/storage/data/clientes_vip_a1b2c3d4 \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "ids": [1, 2]
6  }'

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": 2
4}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.