Actualizado: 7 de junio de 2024
Afectar a la versión: 2.8.13 o superior
Se ha añadido una nueva API para la asistencia de tiempo con BioStar 2.8.13.
Para 'Cómo usar TA API swagger', consulte el siguiente enlace:
[API de BioStar 2 TA] Cómo usar e iniciar la API de BioStar 2 TA
Otras funciones de la API disponibles en TA Swagger (se tratarán en otros documentos de guía)
- Funciones relacionadas con el código de tiempo
- Funciones relacionadas con el turno
- Funciones relacionadas con la plantilla de programación
- La regla relaciona las funciones
- Funciones relacionadas con la programación
- Funciones relacionadas con el registro de perforación
Cómo usar el informe de TA
[POST] /report.json API recupera los datos de informe adecuados en formato JSON.
* El informe TA tiene una variedad de tipos de informes: Informe diario, Informe individual, Informe de ausencia, Informe de excepto, Informe de historial de edición y más. En este artículo se tratarán algunos de ellos al proporcionar cuerpos de solicitud sugeridos para dichos informes.
Parte 1. Llamada a la API y parámetros
[PUBLICACIÓN]: /report.json
Parámetros del cuerpo:
Parámetro | Tipo | Obligatorio | Descripción |
límite | Número | Y | Número de resultados. Mín.: 1, Máx.: 100 |
compensar | Número | Y | Desplazamiento de datos de resultados. Mínimo: 0 |
start_datetime | Cuerda | Y | Fecha y hora de inicio del intervalo de informes. Formato AAAA-MM-DD |
end_datetime | Cuerda | Y | Fecha y hora de finalización del intervalo de informes. Formato AAAA-MM-DD |
user_id_list | Número | Y | Lista de identificadores de usuario de los usuarios que se incluirán en el informe. Se requiere al menos un elemento user_id_list. |
report_type | Cuerda | Y | Tipo de informe que se va a generar:[REPORT_DAILY, REPORT_DAILY_SUMMARY, REPORT_INDIVIDUAL, REPORT_INDIVIDUAL_SUMMARY, REPORT_LEAVE, REPORT_EXCEPTION, REPORT_EDIT_HISTORY, REPORT_WORKWEEK] |
group_id_list | Cuerda | N | Lista de ID de grupo. |
report_filter_type | Cuerda | N | Obligatorio para el tipo "REPORT_INDIVIDUAL"[INDIVIDUAL_FILTER_SUMMARY, INDIVIDUAL_FILTER_DETAIL] |
filtro | Cuerda | N | Requerido para los tipos "REPORT_LEAVE" y "REPORT_EXCEPTION"Valores posibles para "REPORT_LEAVE"- ID de código de pago (número)Valores posibles para "REPORT_EXCEPTION"- TODOS- 1: NORMAL- 2: AUSENCIA- 3: LATE_IN- 4: EARLY_OUT- 5: MISSING_PUNCH_IN- 6: MISSING_PUNCH_OUT- 7: MISSING_PUNCH_MEAL_START- 8: MISSING_PUNCH_MEAL_END- 9: MISSING_PUNCH_BREAK_START- 10: MISSING_PUNCH_BREAK_END- 11: MISSING_EVENT_TYPE a 12: INSUFFICIENT_WORK_TIME |
Workweek | Entero | N | Requerido para "REPORT_WORKWEEK" |
Columnas | N | Columnas a mostrar. - si columns no existe, todas las columnas se eligen de forma predeterminada | |
:campo | cuerda | campo de la columna que se va a incluir: [datetime, userName, userId, userGroupName, shift, leave, inTime, outTime, exceptionForView, normalRegular, normalOvertime, totalWorkTime, punchBreak, overBreak, mealTime, regularByTimeRate, overtimeByTimeRate] | |
tipo | Cuerda | Y | "custom" |
rebuild_time_card | Booleano | Y | 'true' o 'false' - el valor no afecta al resultado |
Cuerpos de solicitud sugeridos para diferentes tipos de informes
Cambiar el parámetro "report_type" le permite llamar a diferentes informes desde BioStar 2.
Nota:
Los siguientes ejemplos son para v2.9.6 o superior.
Tenga en cuenta que los campos 'tipo', 'rebuild_time_card', 'columnas' también son obligatorios si está utilizando versiones anteriores a la v2.9.6. Puede encontrar la información en la tabla de parámetros anterior.
Simplemente puede agregar esos campos a los ejemplos a continuación para versiones anteriores a v2.9.6.
Reporte Diario
Informe individual
El tipo "REPORT_INDIVIDUAL" requiere un parámetro "report_filter_type".
Informe de abandono
El tipo "REPORT_LEAVE" requiere un parámetro "filter". Coloque el ID del código de tiempo de salida que le gustaría ver.
Informe de excepciones
El tipo "REPORT_EXCEPTION" requiere un parámetro "filter".
