Entities Data

Estos puntos finales gestionan las operaciones CRUD (crear, leer, actualizar y eliminar) en registros de entidades, incluyendo

Endpoints

Obtener todos los registros de una entidad

GET /api/v1/entities/{entity}

Parámetros:

Nombre	Tipo	Parámetro búsqueda	Descripción	Requerido
enriched	boolean	query	Retorna mas detalles de la entidad	Verdadero
version	string	query	Versión de la aplicación	Verdadero
limit	number	query	límite para paginación	Falso
page	number	query	página para paginación	Falso
relationFilter	array[string]	query	nombre de la relación que se va a filtrar	Falso
relationValue	array[string]	query	valor relacionado que va a ser filtrado	Falso
sort_direction	array[string]	query	Dirección para ordenado. Valores: [ ASC, DESC ]	Falso
sort_field	array[string]	query	Campo para ordenar.	Falso
key	array[string]	query	Nombre/llave del campo para filtrado por campo.	Falso
operator	array[string]	query	Operador para filtrar por campo. Valores: [lt, gt, eq, ne, lk, lte, gte, isNull, isNotNull]	Falso
value	array[string]	query	Valor para del campo a filtrar	Falso
condition	array[string]	query	Condición para encadenar varios filtros de campo. Valores: [ AND, OR]. Por defecto AND.	Falso
domain	string	header	Dominio del registro	Verdadero
entity	string	path	El nombre/id de la entidad	Verdadero

Respuestas:

{
  "error": false,
  "status": 200,
  "message": "string",
  "errors": [{}],
  "data": [
    {
      "id": 0,
      "dateUpdated": "string",
      "dateCreated": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "domain": "string",
      "securityGroup": "string",
      "data": {
        "entityAttribute": "string",
        "entityAttribute2": "string",
        "entityAttribute3": "string"
      }
    }
  ],
  "pagination": {
    "hasPreviousPage": true,
    "hasNextPage": true,
    "previousPage": 0,
    "nextPage": 0,
    "recordsTotal": 0,
    "currentPage": 0,
    "startIndex": 0,
    "numPages": 0,
    "limit": 0
  }
}

Usando filtros:

Filtros por llave:

Los filtros por llave funcionan limitando la solicitud para que solo devuelva las llaves consultadas en la matriz key[] pasada en la URL. Ej: key[]=Nombre,Edad&operator[]=eq,lk&value[]=Carlos,25&condition[]=OR devolvería solo las claves Nombre y Edad para la entidad especificada donde nombre coincide con Carlos o edad coincide con 25.

Dirección de ordenación:

Ordena los resultados de la consulta en orden ascendente o descendente. Ej: sort_direction[]=ASC&sort_field[]=name ordenará todos los registros por su name alfabéticamente en orden ascendente.

Filtros por relaciones:

El filtrado por valores de relación es similar al filtrado por clave. La principal diferencia es que el valor que se filtra es el de la relación especificada. Ej: relationshipFilter[]=77b5b900-7e13-4e18-864a-255fc194481e.related_id_00d4b4b4-d9e3-4a2b -a4e3-209b6f438df9.id&relationshipValue[]=1 filtrará todos los valores que coincidan con 1 para la relación especificada.

Algo que hay que tener en cuenta, es que las relaciones tienen una dirección, lo que significa que cada relación tendrá una entidad izquierda y una derecha, y dependiendo del lado de la relación que se filtre, la consulta será diferente: Si se filtra por la entidad izquierda, el relationValue será el id de la entidad derecha. Si se filtra por la entidad derecha, el relationValue será el campo relacionado de la entidad izquierda.

Crear un nuevo registro

POST /api/v1/entities/{entity}

Parámetros:

Nombre	Tipo	Parámetro búsqueda	Descripción	Requerido
version	string	query	Versión de la aplicación	Verdadero
domain	string	header	Dominio del registro	Verdadero
entity	string	path	El nombre o el id del registro	Verdadero

Cuerpo de la petición:

{
  "textField": "some text",
  "numericField": 123,
  "booleanField": false,
  "dateField": "2025-10-20T18:57:07.092Z",
  "relation1": [
    {
      "record": {
        "primaryKey1": 1,
        "primaryKey2": "asd"
      },
      "operation": "add"
    }
  ],
  "relation2": [
    {
      "record": {
        "primaryKey1": 1
      },
      "operation": "add"
    },
    {
      "record": {
        "primaryKey1": 1
      },
      "operation": "remove"
    }
  ]
}

Respuesta:

{
  "error": true,
  "status": 0,
  "message": "string",
  "data": {
    "id": 1
  },
  "entityName": "string"
}

Obtener un registro por id

GET /api/v1/entities/{entity}/{id}

Parámetros:

Nombre	Tipo	Parámetro búsqueda	Descripción	Requerido
enriched	boolean	query	Retorna mas detalles de la aplicación	Falso
version	string	query	Versión de la aplicación	Verdadero
domain	string	header	Dominio del registro	Verdadero
entity	string	path	Nombre o id de la entidadd	Verdadero
id	string	path	Id del registro	Verdadero

Respuesta:

{
  "error": false,
  "status": 200,
  "message": "string",
  "errors": [{}],
  "data": [
    {
      "id": 0,
      "dateUpdated": "string",
      "dateCreated": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "domain": "string",
      "securityGroup": "string",
      "data": {
        "entityAttribute": "string",
        "entityAttribute2": "string",
        "entityAttribute3": "string"
      }
    }
  ],
  "pagination": {
    "hasPreviousPage": true,
    "hasNextPage": true,
    "previousPage": 0,
    "nextPage": 0,
    "recordsTotal": 0,
    "currentPage": 0,
    "startIndex": 0,
    "numPages": 0,
    "limit": 0
  }
}

Actualizar un registro

PATCH /api/v1/entities/{entity}

Parámetros:

Nombre	Tipo	Parámetro búsqueda	Descripción	Requerido
version	string	query	Versión de la aplicación.	Verdadero
domain	string	header	Dominio del registro.	Verdadero
entity	string	path	Nombre o id de la entidad.	Verdadero
filter	object	query	Filtro para los registros de entidad, filtrando por sus propiedades.	Verdadero

Cuerpo de la petición:

{
  "textField": "some text",
  "numericField": 123,
  "booleanField": false,
  "dateField": "2025-10-20T18:57:07.092Z",
  "relation1": [
    {
      "record": {
        "primaryKey1": 1,
        "primaryKey2": "asd"
      },
      "operation": "add"
    }
  ],
  "relation2": [
    {
      "record": {
        "primaryKey1": 1
      },
      "operation": "add"
    },
    {
      "record": {
        "primaryKey1": 1
      },
      "operation": "remove"
    }
  ]
}

Respuesta:

{
  "error": false,
  "status": 200,
  "message": "string",
  "errors": [{}],
  "data": {
    "totalRecordsUpdated": 1
  },
  "pagination": {
    "hasPreviousPage": true,
    "hasNextPage": true,
    "previousPage": 0,
    "nextPage": 0,
    "recordsTotal": 0,
    "currentPage": 0,
    "startIndex": 0,
    "numPages": 0,
    "limit": 0
  }
}

Borrar un registro

DELETE /api/v1/entities/{entity}/{id}

Parámetros:

Nombre	Tipo	Parámetro búsqueda	Descripción	Requerido
version	string	query	Versión de la aplicación.	Verdadero
domain	string	header	Dominio del registro	Verdadero
entity	string	path	Nombre o id de la entidad.	Verdadero
id	string	path	Id del registro.	Verdadero

Respuesta:

{
  "error": false,
  "status": 200,
  "message": "string",
  "errors": [{}],
  "data": "string",
  "pagination": {
    "hasPreviousPage": true,
    "hasNextPage": true,
    "previousPage": 0,
    "nextPage": 0,
    "recordsTotal": 0,
    "currentPage": 0,
    "startIndex": 0,
    "numPages": 0,
    "limit": 0
  }
}

Actualizar el dueño de un registro

PUT /api/v1/entities/{entity}/{id}/owner

Parámetros:

Nombre	Tipo	Parámetro búsqueda	Descripción	Requerido
version	string	query	Versión de la aplicación.	Verdadero
entity	string	path	Nombre o id de la entidad	Verdadero
id	string	path	Id del registro	Verdadero

Cuerpo de la petición:

{
  "newOwner": 1
}

Respuesta:

{
  "error": false,
  "status": 200,
  "message": "string",
  "errors": [{}],
  "data": [
    {
      "id": 0,
      "dateUpdated": "string",
      "dateCreated": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "domain": "string",
      "securityGroup": "string",
      "data": {
        "entityAttribute": "string",
        "entityAttribute2": "string",
        "entityAttribute3": "string"
      }
    }
  ],
  "pagination": {
    "hasPreviousPage": true,
    "hasNextPage": true,
    "previousPage": 0,
    "nextPage": 0,
    "recordsTotal": 0,
    "currentPage": 0,
    "startIndex": 0,
    "numPages": 0,
    "limit": 0
  }
}