Metadatos

Adjunta metadatos personalizados en pares clave-valor a las entidades de Midaz para extender el esquema estándar del ledger con datos específicos de tu integración y de tu negocio.

Los metadatos permiten enriquecer entidades con información definida por el usuario. Están disponibles en todas las entidades de nuestra API, y adjuntas datos personalizados como pares clave-valor dentro de un objeto de metadatos.

Puedes agregar metadatos en cualquier momento.

​

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 (hasta 100 caracteres), enteros, flotantes y booleanos.

Los metadatos no admiten valores anidados.

​

Ejemplo de metadatos

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

JSON

{
  "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, PUT o PATCH:

JSON

{
  "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 PUT o PATCH actualiza los metadatos existentes.
• Eliminar claves: omitir una clave incluida anteriormente en una solicitud PUT o PATCH posterior elimina ese par clave-valor de los metadatos de la entidad.

​

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:

JSON

{
  "metadata": {
    "employees": "100-150"
  }
}

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