Metadatos

Los metadatos permiten enriquecer entidades con información definida por el usuario. Adjuntas datos personalizados como pares clave-valor dentro de un objeto de metadatos.

Qué son los metadatos

Los metadatos permiten almacenar información complementaria junto al modelo de datos estándar de una entidad, agregando atributos o anotaciones personalizadas sin alterar el esquema predefinido de la entidad. En Midaz, los metadatos son un objeto que admite pares clave-valor en estos tipos de datos: cadenas, enteros, flotantes y booleanos. Las claves admiten hasta 100 bytes y los valores hasta 2,000 bytes.

Los metadatos no admiten valores anidados.

Ejemplo de metadatos

Considera una entidad Organization como se muestra a continuación:

{
  "id": "cc15194a-6bc9-4ebb-b15d-43411a54ba4b",
  "parentOrganizationId": null,
  "legalName": "Empresa Teste Ltda",
  "doingBusinessAs": "Empresa Teste",
  "legalDocument": "86820799000188",
  "address": {
    "line1": "Rua Botucatu, 10",
    "line2": "Casa B",
    "zipCode": "04023060",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR"
  },
  "metadata": null,
  "status": {
    "code": "ACTIVE",
    "description": null
  },
  "createdAt": "2024-02-08T16:59:31+0300",
  "updatedAt": "2024-02-08T16:59:31+0300",
  "deletedAt": null
}

Para enriquecer esta organización con información adicional, como el sector de la industria y el número de empleados, puedes incluir un objeto de metadatos en tus solicitudes POST o PATCH:

{
  "metadata": {
    "sector": "Fintech",
    "employees": "50-100"
  }
}

Crear entidades con metadatos

Al crear una entidad, puedes enviar metadatos a través de nuestros endpoints POST y agregar datos personalizados desde el inicio.

Actualizar y eliminar metadatos

Nuestra API sigue el RFC de JSON Merge Patch para las actualizaciones de metadatos:

Agregar o actualizar valores: enviar una clave con un valor nuevo en una solicitud PATCH actualiza los metadatos existentes.
Eliminar claves: enviar una clave como null en una solicitud PATCH elimina ese par clave-valor. Una clave que omites conserva su valor.
Eliminar todas las claves: enviar metadata como null en una solicitud PATCH elimina todas las claves que definiste. En una transacción o en una operación, las claves que escribe el ledger se mantienen.
Mantener los metadatos sin cambios: enviar metadata como {}, o dejar metadata fuera de la solicitud PATCH, mantiene los metadatos almacenados.

Ejemplo práctico: modificar metadatos

Supongamos que una entidad Organization incluía inicialmente metadatos de sector y número de empleados. Para actualizar el número de empleados y eliminar el sector, envía una solicitud PATCH con los siguientes metadatos:

{
  "metadata": {
    "employees": "100-150",
    "sector": null
  }
}

Después de procesar la solicitud, se eliminará la clave del sector y se actualizará el número de empleados.

Resumen

Fundamentos de integración

Estabilidad y calidad

Diccionario de campos

Streaming de eventos

Qué son los metadatos

Ejemplo de metadatos

Crear entidades con metadatos

Actualizar y eliminar metadatos

Ejemplo práctico: modificar metadatos

​Qué son los metadatos

​Ejemplo de metadatos

​Crear entidades con metadatos

​Actualizar y eliminar metadatos

​Ejemplo práctico: modificar metadatos

Qué son los metadatos

Ejemplo de metadatos

Crear entidades con metadatos

Actualizar y eliminar metadatos

Ejemplo práctico: modificar metadatos