Criar um Índice de Metadata
Use este endpoint para criar um índice de metadata para um tipo de entidade específico. Índices de metadata melhoram o desempenho das consultas ao filtrar ou pesquisar por campos de metadata personalizados.
Cabeçalhos
O tipo de mídia do recurso. O valor recomendado é application/json.
Um identificador único utilizado para rastrear e acompanhar cada requisição.
Token JWT bearer para autenticação.
Obrigatório quando PLUGIN_AUTH_ENABLED=true (exigido em implantações multi-tenant).
Opcional no modo OSS single-tenant padrão.
Formato: Bearer <token>
Parâmetros de caminho
O nome da entidade para a qual o índice de metadata será criado ou gerenciado.
organization, ledger, asset, segment, portfolio, account, transaction, operation, account_type, operation_route, transaction_route Corpo
O corpo da requisição para criar um índice de metadata.
A chave de metadata a ser indexada. Esta chave deve corresponder ao nome do campo de metadata utilizado em suas entidades.
100^[a-zA-Z][a-zA-Z0-9_]*$"tier"
Indica se o índice exige unicidade. Quando definido como true, valores duplicados para esta chave de metadata não serão permitidos.
false
Indica se o índice é esparso. Quando definido como true, apenas documentos que contêm o campo indexado serão incluídos no índice.
true
Resposta
Indica que o índice de metadata foi criado com sucesso e a operação foi concluída conforme esperado.
O corpo da resposta para um índice de metadata.
O nome do índice no banco de dados.
"metadata.tier_1"
O nome da entidade associada ao índice.
"transaction"
A chave de metadata utilizada no índice.
"tier"
Indica se o índice exige unicidade.
false
Indica se o índice é esparso (ignora documentos sem o campo indexado).
true

