Processes
Processes
Processes BackEnd
Permite hacer el CRUD de procesos y tareas y a la vez obtener los roles de los usuarios.
Para utilizar el backend de Processes el endpoint que debe utilizarse es: https://api.aurapps.com/proc
o local: http://localhost:8022/proc
Endpoints
API Reference
/process
Get de todos los procesos.
POST /process
Se utiliza para traer todos los procesos o procesos especificos. Tambien indica si los procesos que trae son los ultimos a traves del campo "is_last_page" dentro de "pagination" en la respuesta.
Ejemplo respuesta de la api:
{
"code": 0,
"data": {
"results": [ {
"id": 1,
"def_process_id": 1,
"last_task_id": 11,
"created_at": "2025-02-21T14:42:14Z",
"deleted_at": null,
"completed_at": null,
"updated_at": "2025-02-21T14:44:32Z",
"created_by": 50891,
"data": {
"status": 1,
"creador": {
"name": "desarrollador auravant",
"uuid": "UID-52557d1330edff2afd2eac1bb53b5190",
"email": "devhelp@auravant.com"
},
"tipo_insumo": "Agroquimicos",
}
},],
"pagination": {
"is_last_page": true
}
}
}
o si incluye el parametro: "only_count"
{
"code": 0,
"total_count": 100
}
Los siguientes parametros (opcionales) se deben enviar en la URL como query param.
| Parameter | Type | Description |
|---|---|---|
def_procces_id | number | Required. Se utiliza para seleccionar que procesos que devuelve la api. |
columns_filter | array string | Se utiliza para filtrar las columnas de datos (dentro de data) que devuelve la api. |
page_number | number | Se utiliza para dentro de la paginación indicar que pagina devuelve la api. |
page_size | number | Se utiliza para dentro de la paginación indicar cuantos items devuelve la api. |
only_count | number | Se utiliza para saber el total de items de un proceso. |
| EJEMPLO: |
|---|
Si la pegada es: /proc/process?def_process_id=1&columns_filter=status,creador&page_size=10&page_number=1, la api respondera solo mostrando status y creador dentro de data en los primeros 10 procesos que def_process_id sea igual a 1 |
Body:
El body se utiliza para filtrar los procesos por alguna condicion dentro de data. Enviando las condiciones dentro de "data_filter". Las condiciones que se pueden utilizar son las siguientes:
| Operadores | Description |
|---|---|
= | igual a |
> o < | mayor o menor a |
=> o =< | mayor igual o menor igual a |
!= | distinto a |
LIKE | coincidencia parcial |
ILIKE | coincidencia parcial sin importar mayusculas |
IN | pertenece a un conjunto de datos |
| EJEMPLO: |
|---|
{
"data_filter": ["'tipo_insumo' ILIKE '%%Agro%%'","'status' = '1'"]
}
En este caso la API respondera con todos los procesos que dentro de data exista el campo "tipo_insumo" y que el valor contenga "agro" y status sea igual a 1
Error codes.
| code | Description |
|---|---|
1 | No se pudo obtener procesos. Inputs ingresados incorrectamente. |
/task
- Metodos:
GET /task
Se utiliza para traer todas las tareas o tareas especificas.
Ejemplo respuesta de la api:
{
"code": 0,
"data": {
...
}
}
| Parameter | Type | Description |
|---|---|---|
def_task_id | number | Required. Se utiliza para seleccionar que tareas que devuelve la api. |
PUT /task
Se utiliza para crear una nueva tarea.
| Parameter | Type | Description |
|---|---|---|
def_task_id | number | Required. Se utiliza para seleccionar la definicion de tarea a crear por la api. |
process_id | number | Required. Se utiliza para seleccionar a que proceso corresponde la tarea a crear. |
Body:
En el body se le pasara el schema de la definicion de tarea en formato JSON.
| EJEMPLO: |
|---|
{
"status": 1,
"fecha_entrega_estimada": "2025-02-15",
"creador": {
"email": "Laito.Laito@empresa.com",
"name": "Laito",
"uuid": "c68a4678-0f5e-45b7-80d7-68b58f7a7c2e"
},
"observaciones_operador": "Este es un pedido urgente, por favor verificar los tiempos de entrega.",
"tipo_insumo": "Electronica",
"opcion_retiro": 1
}
Error codes.
| code | Description |
|---|---|
1 | No se pudo obtener tareas. Inputs ingresados incorrectamente |
2 | No se especificó def_task_id |
7 | El usuario no tiene permisos para crear esta tarea. |
8 | Hay más de una definición de tarea que puede crear esta tarea. esta tarea. |
12 | No se especificó un process_id |
17 | Error al actualizar proceso. (Quizas no tienes permiso para actualizar este proceso o el proceso ha finalizado.) |
18 | Esta tarea no es la siguiente a la tarea anterior. |
20 | Error al intentar enviar notificaciones. |
/role
Get user roles
GET /role
Pegandole solo con el token te devolvera a que rol/roles pertenece el usuario
Error codes.
| code | Description |
|---|---|
1 | No se pudo obtener los roles del usuario. |