Funcionalidad de Entidades

Estos endpoints proporcionan funcionalidades adicionales para la gestión de entidades, como permisos, truncado, validación y operaciones de dominio.

Endpoints

Obtener todas las entidades

Devuelve una lista de todas las entidades en el sistema.

Endpoint:

GET /api/v1/entities?version=:version

Respuesta de ejemplo:

{
    "status": 200,
    "error": false,
    "errors": [ { } ],
    "message": "string",
    "data": [ { <Entity> } ],
    "pagination": { <Pagination> }
}

Obtener todas las entidades (formateadas)

Devuelve todas las entidades en una estructura formateada.

Endpoint:

GET /api/v1/entities/formated?version=:version

Respuesta de ejemplo:

{
    "status": 200,
    "error": false,
    "errors": [ { } ],
    "message": "string",
    "pagination": { <Pagination> },
    "data": [
        {
            "label": "label",
            "name": "entity"
        }
    ]
}

Truncar datos de una entidad

Elimina todos los datos de la entidad (tabla) especificada, pero mantiene la definición de la entidad.

Endpoint:

DELETE /api/v1/entities/:entity/truncate?version=:version

Códigos de respuesta:

• 200 OK: Entidad truncada exitosamente.
• 500 Internal Server Error: Ocurrió un error al truncar la entidad.

Validar un registro de entidad

Valida un registro antes de ser actualizado. Útil para comprobar integridad de datos o reglas de negocio antes de guardar cambios.

Endpoint:

PUT /api/v1/entities/:entity/:id/validate?version=:version

<JSON>

Respuesta de ejemplo:

{
    "data": [],
    "status": 200,
    "error": false,
    "errors": [ { } ],
    "message": "string",
    "pagination": { <Pagination> }
}

Gestión de permisos de entidad

Obtener permisos de una entidad

Recupera los permisos asociados a una entidad específica.

Endpoint:

GET /api/v1/entities/:entity/permissions?version=:version

Respuesta de ejemplo:

{
  "status": 200,
  "error": false,
  "message": "string",
  "entityName": "string",
  "data": [
    {
      "permissionId": "string",
      "roleId": "string",
      "roleItem": "string",
      "actionId": "string",
      "actionItem": "string",
      "active": true
    }
  ]
}

Establecer permisos de una entidad

Establece o actualiza los permisos para una entidad específica.

Endpoint:

POST /api/v1/entities/:entity/permissions?version=:version

Cuerpo de la solicitud:

[
  {
    "permissionId": "string",
    "actionItem": "string",
    "actionId": "string",
    "roleItem": "string",
    "roleId": "string",
    "active": true
  }
]

Respuesta de ejemplo:

{
  "status": 201,
  "error": false,
  "message": "string",
  "entityName": "string",
  "data": [
    {
      "permissionId": "string",
      "actionItem": "string",
      "actionId": "string",
      "roleItem": "string",
      "roleId": "string",
      "active": true
    }
  ]
}

Gestión de entidades dentro de dominios

Mover un registro de entidad a un nuevo dominio

Mueve un registro de entidad de su dominio actual a otro.

Endpoint:

PUT /api/v1/entities/:entity/:id/domain?version=:version

Parámetros:

Nombre	Tipo	De	Descripción
version	string	query	La versión de la aplicación.
entity	string	path	El nombre de la entidad.
id	number	path	El ID de la entidad.

Cuerpo de la solicitud:

{
    "newDomain": 1
}

Respuesta de ejemplo:

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