Pular para o conteúdo principal
POST
/
v1
/
settings
/
metadata-indexes
/
entities
/
{entity_name}
Criar um Índice de Metadata
curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes/entities/{entity_name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "metadataKey": "tier",
  "unique": false,
  "sparse": true
}
'
{
  "indexName": "metadata.tier_1",
  "entityName": "transaction",
  "metadataKey": "tier",
  "unique": false,
  "sparse": true
}

Autorizações

​
Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

​
Authorization
string

O token de autorização. Este cabeçalho é obrigatório se o seu ambiente tiver o Access Manager habilitado.

​
Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser application/json.

​
X-Request-Id
string<uuid>

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

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