Saltar al contenido principal
POST
/
v1
/
settings
/
metadata-indexes
/
entities
/
{entity_name}
Crear un Índice de Metadatos
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
}

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 ruta

​
entity_name
enum<string>
requerido

El nombre de la entidad para la cual se creará o gestionará el índice de metadatos. Entidades soportadas: organization, ledger, asset, segment, portfolio, account, transaction, operation, account_type, operation_route, transaction_route.

Opciones disponibles:
organization,
ledger,
asset,
segment,
portfolio,
account,
transaction,
operation,
account_type,
operation_route,
transaction_route

Cuerpo

application/json

El cuerpo de la solicitud para crear un índice de metadatos.

​
metadataKey
string
requerido

La clave de metadatos a indexar. Esta clave debe coincidir con el nombre del campo de metadatos utilizado en sus entidades.

Maximum string length: 100
Ejemplo:

"tier"

​
unique
boolean
predeterminado:false

Indica si el índice exige unicidad. Cuando se establece en true, no se permitirán valores duplicados para esta clave de metadatos.

Ejemplo:

false

​
sparse
boolean
predeterminado:true

Indica si el índice es disperso. Cuando se establece en true, solo los documentos que contengan el campo indexado se incluirán en el índice.

Ejemplo:

true

Respuesta

Indica que el índice de metadatos fue creado exitosamente y la operación se completó como se esperaba.

El cuerpo de la respuesta para un índice de metadatos.

​
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