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 'Content-Type: application/json' \
  --data '
{
  "metadataKey": "tier",
  "unique": false,
  "sparse": true
}
'
import requests

url = "https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes/entities/{entity_name}"

payload = {
"metadataKey": "tier",
"unique": False,
"sparse": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({metadataKey: 'tier', unique: false, sparse: true})
};

fetch('https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes/entities/{entity_name}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes/entities/{entity_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'metadataKey' => 'tier',
'unique' => false,
'sparse' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes/entities/{entity_name}"

payload := strings.NewReader("{\n \"metadataKey\": \"tier\",\n \"unique\": false,\n \"sparse\": true\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes/entities/{entity_name}")
.header("Content-Type", "application/json")
.body("{\n \"metadataKey\": \"tier\",\n \"unique\": false,\n \"sparse\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes/entities/{entity_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadataKey\": \"tier\",\n \"unique\": false,\n \"sparse\": true\n}"

response = http.request(request)
puts response.read_body
{
  "indexName": "metadata.tier_1",
  "entityName": "transaction",
  "metadataKey": "tier",
  "unique": false,
  "sparse": true
}

Encabezados

Content-Type
string

El tipo de medio del recurso. El valor recomendado es application/json.

X-Request-Id
string<uuid>

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

Authorization
string

Token JWT bearer para autenticación. Requerido cuando PLUGIN_AUTH_ENABLED=true (obligatorio en despliegues multiinquilino). Opcional en el modo OSS de inquilino único predeterminado. Formato: Bearer <token>

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
Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
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