Herramientas
Una herramienta es una operación que un asistente puede llamar. El servidor expone 73: 68 herramientas de lectura agrupadas por ámbito, 4 herramientas de escritura y 1 herramienta genérica de consulta OData. Un asistente las descubre preguntando al servidor, así que esta lista es para usted: para saber a qué puede llegar antes de conectarlo.
Las cuatro herramientas de escritura solo aparecen cuando EnableWriteTools está activado, y la
herramienta de consulta OData solo cuando EnableODataQueryTool está activado. Consulte
Conexión.
Órdenes de trabajo
| Herramienta | Descripción |
|---|---|
| work_orders_search | Busca órdenes de trabajo. Devuelve datos de cabecera: estado, cliente, artículo, fechas y cantidades. |
| work_orders_get | Obtiene la cabecera de una orden de trabajo por su entrada de documento. |
| work_order_positions_list | Enumera las posiciones de una orden de trabajo: artículo, cantidades planificadas y fabricadas, fechas y estado. |
| work_order_routings_list | Enumera las operaciones de ruta de una orden de trabajo: recurso, tiempos de preparación y de ejecución planificados. |
| work_order_materials_list | Enumera las líneas de material de una orden de trabajo: componentes, cantidades planificadas y contabilizadas, almacén y ubicación. |
Tiempos de producción
| Herramienta | Descripción |
|---|---|
| active_work_order_times_list | Enumera los registros de tiempo en operaciones, en curso y cerrados, con el contexto de personal, recurso, operación y orden de trabajo. |
| production_times_list | Enumera los partes de tiempo contabilizados con duraciones, cantidades buenas y de rechazo, personal y recurso. |
Artículos
| Herramienta | Descripción |
|---|---|
| items_search | Busca artículos por código o nombre. Devuelve datos maestros, incluidos los totales de stock, el método de aprovisionamiento y el almacén predeterminado. |
| items_get | Obtiene un artículo por su código exacto, con todos sus datos maestros. |
| item_warehouses_list | Enumera el stock por almacén de un artículo: disponible, comprometido, pedido, mínimo y máximo. |
| item_materials_list | Enumera la lista de materiales de un artículo: componentes, cantidades, unidades, rechazo y operaciones vinculadas. |
| item_routings_list | Enumera la ruta de un artículo: operaciones, recursos, tiempos de preparación y de proceso. |
| item_versions_list | Enumera las versiones de un artículo, con el estado de la versión y los números de plano. |
Pedidos de venta
| Herramienta | Descripción |
|---|---|
| sales_orders_search | Busca pedidos de venta por cliente o estado. Devuelve el número de documento, el cliente, las fechas y el estado. |
| sales_orders_get | Obtiene la cabecera de un pedido de venta por su entrada de documento. |
Recursos
| Herramienta | Descripción |
|---|---|
| resources_list | Enumera los recursos de producción con datos de capacidad, coste y agrupación. |
| resources_get | Obtiene un recurso de producción por su código exacto. |
| resource_downtimes_list | Enumera los tiempos de inactividad de los recursos, planificados y no planificados, con el motivo y el intervalo de fechas. |
Control de calidad
| Herramienta | Descripción |
|---|---|
| qc_orders_search | Busca órdenes QC con el contexto de artículo, lote, inspección y documento de origen. |
| qc_orders_get | Obtiene las filas de la orden QC de un lote, que puede tener varios nodos. |
| qc_inspection_plans_search | Busca planes de inspección por artículo, grupo o cliente. |
| qc_templates_search | Busca plantillas QC (características de inspección) por código, descripción o grupo. |
| qc_groups_list | Enumera los grupos QC por código o descripción. |
| qc_valuations_list | Enumera las valoraciones QC (códigos de evaluación), opcionalmente dentro de un grupo. |
| qc_samples_search | Busca muestras QC por artículo o por número de documento de inspección. |
| qc_batches_to_verify_search | Busca lotes pendientes de verificación por artículo o almacén. |
| qc_blockage_reasons_list | Enumera los motivos de bloqueo por código o grupo. |
Datos maestros
| Herramienta | Descripción |
|---|---|
| business_partners_search | Busca interlocutores comerciales (clientes, proveedores y clientes potenciales) por código o nombre. |
| warehouses_list | Enumera los almacenes con datos de código, nombre y dirección. |
| bin_locations_search | Busca ubicaciones, opcionalmente dentro de un almacén. |
| personnel_list | Enumera el personal con ID, nombres, grupo y presencia actual. |
| tools_list | Enumera las herramientas de producción con código, descripción y tipo. |
| units_of_measure_list | Enumera las unidades de medida, opcionalmente solo las válidas para un artículo determinado. |
Ruta y operaciones
| Herramienta | Descripción |
|---|---|
| operations_search | Busca operaciones por código, descripción o recurso. |
| operation_types_list | Enumera los tipos de operación por código o descripción. |
| routing_headers_search | Busca cabeceras de ruta por artículo, tipo o estado. |
| operation_alternative_list | Enumera los recursos alternativos configurados en las operaciones. |
| operation_parallel_list | Enumera los recursos paralelos configurados en las operaciones. |
| operation_tool_list | Enumera las herramientas asignadas a las operaciones. |
| operation_utility_list | Enumera los medios auxiliares asignados a las operaciones. |
Planificación
| Herramienta | Descripción |
|---|---|
| mrp_scenarios_search | Busca escenarios de MRP por descripción, sucursal o estado del cálculo. |
| mrp_orders_search | Busca órdenes de MRP por clase de orden, interlocutor comercial o almacén. |
| mrp_results_list | Enumera los resultados del cálculo de MRP, opcionalmente de un escenario o de un interlocutor comercial. |
| mrp_details_list | Enumera las líneas de detalle de los resultados de MRP, opcionalmente de un escenario o de una clase de documento. |
| reservations_search | Busca reservas de inventario por artículo, almacén o documento base. |
Cálculo de costes
| Herramienta | Descripción |
|---|---|
| calculation_schemas_list | Enumera los esquemas de cálculo de costes por código o descripción. |
| cost_centers_search | Busca centros de coste por código o nombre. |
| cost_carriers_search | Busca portadores de costes por código o descripción. |
| precalculations_search | Busca precálculos (estimaciones de costes) por artículo o cliente. |
| work_order_calculation_headers_search | Busca cabeceras de cálculo de órdenes de trabajo por entrada de documento o esquema. |
| work_order_calculation_schemas_list | Enumera las líneas del esquema de cálculo de órdenes de trabajo, opcionalmente de una entrada de documento. |
| material_groups_list | Enumera los grupos de material por código o descripción. |
| material_group_surcharges_list | Enumera las líneas de recargo de los grupos de material, opcionalmente de un grupo. |
Mantenimiento
| Herramienta | Descripción |
|---|---|
| maintenance_objects_search | Busca objetos de mantenimiento por ID de mantenimiento, estado o artículo. |
| maintenance_orders_search | Busca órdenes de mantenimiento por estado o por la orden de trabajo vinculada. |
| maintenance_statuses_list | Enumera los códigos de estado de mantenimiento con sus descripciones. |
| internal_maintenances_search | Busca mantenimientos internos por estado, artículo o interlocutor comercial. |
| external_maintenances_search | Busca mantenimientos externos (subcontratados) por estado, artículo o interlocutor comercial. |
Calendarios y turnos
| Herramienta | Descripción |
|---|---|
| resource_calendars_search | Busca entradas del calendario de recursos por recurso o grupo. |
| shift_definitions_list | Enumera las definiciones de turno, opcionalmente dentro de un grupo de turnos. |
| day_templates_list | Enumera las plantillas de día que se usan para crear los horarios de turnos. |
| personnel_shift_models_search | Busca asignaciones de modelos de turno del personal por ID de personal. |
| personnel_special_shifts_search | Busca excepciones de turno especial del personal por ID de personal. |
| period_rules_list | Enumera las reglas de período del tiempo de trabajo: horario flexible y horas extra. |
| absence_types_list | Enumera los tipos de ausencia, como vacaciones, baja por enfermedad y formación. |
Análisis
Estas herramientas responden a preguntas agregadas con recuentos, de modo que un asistente no tiene que obtener filas para sumarlas.
| Herramienta | Descripción |
|---|---|
| work_orders_kpis | Recuentos principales: abiertas, cerradas y abiertas con retraso (una fecha de entrega ya vencida en una orden todavía abierta). Se puede limitar a un cliente o artículo. |
| work_orders_by_status | Recuento por ID de estado, de mayor a menor. Se puede restringir a órdenes abiertas o cerradas. |
Descubrimiento y consulta genérica
| Herramienta | Descripción |
|---|---|
| beas_entity_schema | Describe los campos, los tipos y la clave de un conjunto de entidades de la API, para que una consulta sobre él se pueda escribir correctamente. Si se llama sin conjunto de entidades, enumera todos los nombres disponibles. |
| beas_odata_query | Ejecuta una consulta de solo lectura sobre cualquier conjunto de entidades que no tenga una herramienta específica, con los parámetros estándar $filter, $select y $orderby. Necesita una sesión de usuario; un llamante con clave de API se rechaza. Devuelve como máximo 200 filas, 50 de forma predeterminada. |
consejo
Un asistente que llama a beas_entity_schema antes de beas_odata_query obtiene los nombres de
campo exactos y deja de adivinarlos. Un nombre de conjunto de entidades incorrecto tampoco es un
callejón sin salida: el servidor responde con la lista de nombres válidos.
Herramientas que modifican datos
Cuatro herramientas escriben. Cada una requiere una sesión de usuario y el mismo permiso Control total que exige el Web Client para la acción equivalente, de modo que un asistente nunca puede ir más allá de los permisos del usuario con el que está conectado.
| Herramienta | Descripción | Permiso necesario |
|---|---|---|
| work_orders_create | Crea una orden de trabajo con una posición para un artículo y una cantidad determinados, y devuelve su entrada de documento. | Control total en Órdenes de trabajo |
| work_orders_update | Actualiza campos de cabecera de una orden de trabajo existente. Solo cambian los campos que se facilitan. | Control total en Órdenes de trabajo |
| production_times_create | Contabiliza un parte de tiempo manual en una operación de una orden de trabajo, en la unidad de medida de la posición. | Control total en Tiempos de OT activos |
| resource_downtimes_create | Registra un tiempo de inactividad para un recurso, bloqueando su capacidad durante el intervalo de fechas. | Control total en Recursos |
precaución
work_orders_create y production_times_create crean datos de producción reales, y ninguna
herramienta de aquí los deshace. Corrija o anule el resultado en el Web Client, igual que cualquier
otro registro.
Funcionalidad relacionada
- Prompts y recursos: los flujos de trabajo guiados y el material de referencia que un asistente puede leer.
- Seguridad y permisos: cómo funcionan la barrera de escritura y la clave de API de solo lectura.