Cadastro de Estrutura de Armazenamento do Datalogic

Descrição

Endpoint responsável por criar uma nova estrutura de armazenamento personalizada para a loja 🗄️.

Ao ser criada, a estrutura recebe um nome físico gerado automaticamente a partir do nome informado.

Junto com a estrutura, é criada uma tabela física própria.

Essa tabela já nasce contendo as colunas de controle id, created_at e updated_at.

A estrutura é criada sem colunas e sem índices adicionais.

Esses recursos devem ser configurados posteriormente por meio dos endpoints específicos de coluna e índice.

O campo publicRead determina se os dados da estrutura poderão ser lidos sem autenticação de usuário.

Esse comportamento é relevante para o gerenciamento futuro do acesso aos registros.

🔐 Permissão

• DATALOGIC_STRUCT_WRITE — Escopo de permissão para escrita das estruturas do Datalogic.

Parâmetros

Headers Obrigatórios

Parâmetros do Corpo

Exemplo de Requisição

1curl --request POST \
2  --url https://sua-loja-uappi.com.br/api/v3/tools/datalogic/storage/struct \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "name": "Clientes VIP",
6    "description": "Cadastro auxiliar de clientes VIP",
7    "publicRead": false
8  }'

✅ Resposta de Sucesso

HTTP Status: 201 Created

1{
2  "status": true,
3  "data": {
4    "id": 1,
5    "name": "Clientes VIP",
6    "description": "Cadastro auxiliar de clientes VIP",
7    "publicRead": false,
8    "tableName": "clientes_vip_a1b2c3d4",
9    "columns": [],
10    "indexes": [],
11    "createdAt": "2026-07-10 09:00:00",
12    "updatedAt": "2026-07-10 09:00:00"
13  }
14}

⚠️ 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.

Detalhe de Estrutura de Armazenamento do Datalogic

Descrição

Endpoint responsável por retornar o detalhe de uma estrutura de armazenamento específica pelo id 🔎.

O retorno inclui o nome interno, a descrição, a flag de leitura pública e o nome físico gerado para a tabela.

Também retorna as coleções de colunas e índices já cadastrados na estrutura.

🔐 Permissão

• DATALOGIC_STRUCT_READ — Escopo de permissão para leitura das estruturas do Datalogic.
• DATALOGIC_STRUCT_WRITE — Escopo de permissão para escrita das estruturas do Datalogic.

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/tools/datalogic/storage/struct/{datalogicStructureId} \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": {
4    "id": 1,
5    "name": "Clientes VIP",
6    "description": "Cadastro auxiliar de clientes VIP",
7    "publicRead": false,
8    "tableName": "clientes_vip_a1b2c3d4",
9    "columns": [],
10    "indexes": [],
11    "createdAt": "2026-07-10 09:00:00",
12    "updatedAt": "2026-07-10 09:00:00"
13  }
14}

⚠️ 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.

Atualização de Estrutura de Armazenamento do Datalogic

Descrição

Endpoint responsável por atualizar as informações de uma estrutura de armazenamento já cadastrada ✏️.

Este endpoint atualiza apenas os dados da estrutura: nome interno, descrição e flag de leitura pública.

O nome físico da tabela, as colunas e os índices já cadastrados não são alterados por esta rota.

🔐 Permissão

• DATALOGIC_STRUCT_READ — Escopo de permissão para leitura das estruturas do Datalogic.
• DATALOGIC_STRUCT_WRITE — Escopo de permissão para escrita das estruturas do Datalogic.

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Parâmetros do Corpo

Exemplo de Requisição

1curl --request PUT \
2  --url {{MAIN_URL}}/tools/datalogic/storage/struct/{datalogicStructureId} \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "name": "Clientes VIP",
6    "description": "Cadastro auxiliar de clientes VIP atualizado",
7    "publicRead": true
8  }'

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": {
4    "id": 1,
5    "name": "Clientes VIP",
6    "description": "Cadastro auxiliar de clientes VIP atualizado",
7    "publicRead": true,
8    "tableName": "clientes_vip_a1b2c3d4",
9    "columns": [],
10    "indexes": [],
11    "createdAt": "2026-07-10 09:00:00",
12    "updatedAt": "2026-07-14 10:00:00"
13  }
14}

⚠️ 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.

Remoção de Estrutura de Armazenamento do Datalogic

Descrição

Endpoint responsável por remover uma estrutura de armazenamento do Datalogic 🗑️.

Caso a estrutura contenha registros, a remoção é bloqueada por padrão, evitando a perda acidental de dados já armazenados.

Para remover uma estrutura com registros existentes, é necessário informar o parâmetro force como true.

Isso força a exclusão da tabela física e do cadastro da estrutura.

Ao ser removida, a tabela física é excluída do repositório de armazenamento, junto com o registro da estrutura.

🔐 Permissão

• DATALOGIC_STRUCT_READ — Escopo de permissão para leitura das estruturas do Datalogic.
• DATALOGIC_STRUCT_WRITE — Escopo de permissão para escrita das 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/struct/{datalogicStructureId} \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "force": true
6  }'

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": true
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.