GetAll

Las operaciones disponibles en el endpoint están basadas en la estructura de la entidad correspondiente. Cada entidad representa una tabla, y su estructura es descrita en la documentación para cada objeto.

GetAllOperation

  • Retorna un listado de registros que cumplan con los criterios enviados en el request.
    • Al igual que en Get, los parámetros del request deben seguir la estructura de la entidad.
    • Si se especifican múltiples campos de filtro, también se combinarán con condiciones AND.

      • Esta operación es útil para consultas filtradas, paginadas o para obtener colecciones completas bajo ciertas condiciones.

    • Esta operación devuelve un array de objetos, incluso si es uno solo… o ninguno.
    • Entidades que utilizan GetAllOperation para el parámetro GroupName ➜
¡Código copiado al portapapeles!
📑 Request
🔗 Response

Ejemplo Request

{
"Data": {
"Token": {
"Id": "TokenAsignado"
},
"Operation": {
"Name": "GetAllOperation",
"GroupName": "Customer",
"Payload": "{\"Active\":true,\"IsDeleted\":false,\"IdentificationType\":\"CC\"}"
}
}
}

Ejemplo Response

[
{
"ReferenceCode": "00001",
"Identification": "123456789",
"IdentificationType": "CC",
"ExpeditionDate": "2015-04-20T00:00:00",
"FirstName": "Carlos",
"SecondName": "Eduardo",
"FirstLastName": "Ramírez",
"SecondLastName": "Gómez",
"BirthDate": "1988-09-15T00:00:00",
"Email": "carlos.ramirez@example.com",
"PhoneNumber": "3001234567",
"Active": true,
"IsDeleted": false
},
{
"ReferenceCode": "00002",
"Identification": "987654321",
"IdentificationType": "CC",
"ExpeditionDate": "2010-11-05T00:00:00",
"FirstName": "Laura",
"SecondName": "Marcela",
"FirstLastName": "González",
"SecondLastName": "Pérez",
"BirthDate": "1990-03-08T00:00:00",
"Email": "laura.gonzalez@example.com",
"PhoneNumber": "3119876543",
"Active": true,
"IsDeleted": false
}
]
Descripción general del objeto serializedData dentro del Response
Parámetro Tipo Description
SerializedData String El resultado será el objeto que se describe en la estructura de la entidad, para GetAll será una colección del mismo objeto.
Successful Boolean Estado de ejecución de la operación. TRUE si la operación fue exitosa, FALSE si la operación fallo.
Message String Mensaje de respuesta de la operación.
ErrorCode String Código de error, si aplica.
ExceptionMessage String Descripción de la excepción, si aplica.
UserMessage String Mensaje de respuesta formateada para UI, si aplica.