Saltar al contenido principal
GET
/
v1
/
settings
/
metadata-indexes
Listar Índices de Metadatos
curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>'
[
  {
    "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"
    }
  }
]

Autorizaciones

​
Authorization
string
header
requerido

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

Encabezados

​
Authorization
string

El token de autorización. Este encabezado es requerido si su entorno tiene el Access Manager habilitado.

​
Content-Type
string
requerido

El tipo de medio del recurso. Debe ser application/json.

​
X-Request-Id
string<uuid>

Un identificador único utilizado para rastrear y seguir cada solicitud.

Parámetros de consulta

​
entity_name
string

El nombre de la entidad para filtrar los índices de metadatos.

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos esperados.

​
indexName
string
requerido

El nombre del índice en la base de datos.

Ejemplo:

"metadata.tier_1"

​
entityName
string
requerido

El nombre de la entidad asociada con el índice.

Ejemplo:

"transaction"

​
metadataKey
string
requerido

La clave de metadatos utilizada en el índice.

Ejemplo:

"tier"

​
unique
boolean
requerido

Indica si el índice exige unicidad.

Ejemplo:

false

​
sparse
boolean
requerido

Indica si el índice es disperso (ignora documentos sin el campo indexado).

Ejemplo:

true

​
stats
object
requerido

Estadísticas de uso del índice.