Pular para o conteúdo principal
POST
Criar um Índice de Metadata

Cabeçalhos

Content-Type
string

O tipo de mídia do recurso. O valor recomendado é application/json.

X-Request-Id
string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

Authorization
string

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

entity_name
enum<string>
obrigatório

O nome da entidade para a qual o índice de metadata será criado ou gerenciado.

Opções disponíveis:
organization,
ledger,
asset,
segment,
portfolio,
account,
transaction,
operation,
account_type,
operation_route,
transaction_route

Corpo

application/json

O corpo da requisição para criar um índice de metadata.

metadataKey
string
obrigatório

A chave de metadata a ser indexada. Esta chave deve corresponder ao nome do campo de metadata utilizado em suas entidades.

Maximum string length: 100
Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
Exemplo:

"tier"

unique
boolean
padrão:false

Indica se o índice exige unicidade. Quando definido como true, valores duplicados para esta chave de metadata não serão permitidos.

Exemplo:

false

sparse
boolean
padrão:true

Indica se o índice é esparso. Quando definido como true, apenas documentos que contêm o campo indexado serão incluídos no índice.

Exemplo:

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.

indexName
string
obrigatório

O nome do índice no banco de dados.

Exemplo:

"metadata.tier_1"

entityName
string
obrigatório

O nome da entidade associada ao índice.

Exemplo:

"transaction"

metadataKey
string
obrigatório

A chave de metadata utilizada no índice.

Exemplo:

"tier"

unique
boolean
obrigatório

Indica se o índice exige unicidade.

Exemplo:

false

sparse
boolean
obrigatório

Indica se o índice é esparso (ignora documentos sem o campo indexado).

Exemplo:

true