Cadastro de Índices de Estrutura do Datalogic

Descrição

Endpoint responsável por criar um ou mais índices sobre as colunas de uma estrutura já existente 🔍.

Cada índice pode ser do tipo key (índice comum, para otimizar buscas) ou unique (índice que impede valores duplicados nas colunas indexadas).

O nome do índice é gerado automaticamente a partir do tipo e das colunas informadas, e não pode ser definido manualmente.

Somente colunas já cadastradas na estrutura podem ser indexadas, e colunas do tipo text não podem ser indexadas.

Ao solicitar um índice do tipo unique, o sistema verifica se os dados já armazenados nas colunas informadas já contêm duplicidade.

Caso contenham, a criação é rejeitada.

A validação da solicitação é feita de forma síncrona, mas a criação física do índice é assíncrona.

Isso significa que o endpoint retorna antes da alteração da tabela ser concluída.

O índice pode levar alguns instantes para aparecer no detalhe 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 POST \
2  --url https://sua-loja-uappi.com.br/api/v3/tools/datalogic/storage/struct/{datalogicStructureId}/index \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "indexes": [
6      {
7        "type": "unique",
8        "columns": ["customer_name"]
9      }
10    ]
11  }'

✅ 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.

Remoção de Índices de Estrutura do Datalogic

Descrição

Endpoint responsável por remover um ou mais índices de uma estrutura de armazenamento já existente 🗑️.

Os índices são identificados pelo nome gerado automaticamente no momento da criação, composto pelo tipo e pelas colunas indexadas.

Todos os nomes de índice informados precisam existir na estrutura; caso algum não seja encontrado, a remoção inteira é rejeitada.

A validação da solicitação é feita de forma síncrona, mas a remoção física do índice é assíncrona.

Isso significa que o endpoint retorna antes da alteração da tabela ser concluída.

O índice pode levar alguns instantes para deixar de aparecer no detalhe da estrutura.

Esta rota não remove as colunas que compõem o índice, apenas a definição do índice em si.

🔐 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}/index \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "indexes": [
6      "unique_customer_name"
7    ]
8  }'

✅ 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.