Pular para o conteúdo principal
GET
/
v1
/
settings
/
metadata-indexes
Listar Índices de Metadata
curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes \
  --header 'Authorization: Bearer <token>'
[
  {
    "indexName": "metadata.tier_1",
    "entityName": "transaction",
    "metadataKey": "tier",
    "unique": false,
    "sparse": true,
    "stats": {
      "accesses": 150,
      "statsSince": "2024-01-15T10:30:00Z"
    }
  },
  {
    "indexName": "metadata.externalId_1",
    "entityName": "account",
    "metadataKey": "externalId",
    "unique": true,
    "sparse": false,
    "stats": {
      "accesses": 1200,
      "statsSince": "2024-01-10T08:00:00Z"
    }
  }
]

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 Access Manager habilitado.

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

Parâmetros de consulta

​
entity_name
string

O nome da entidade para filtrar os índices de metadata.

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

​
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

​
stats
object
obrigatório

Estatísticas de uso do índice.