Tools
A tool is one operation an assistant can call. The server exposes 73: 68 read tools grouped by domain, 4 write tools, and 1 generic OData query tool. An assistant discovers them by asking the server, so this list is for you — to know what it can reach before you connect it.
The four write tools appear only when EnableWriteTools is on, and the OData query tool only when
EnableODataQueryTool is on. See Connecting.
Work orders
| Tool | Description |
|---|---|
| work_orders_search | Searches work orders. Returns header data: status, customer, item, dates and quantities. |
| work_orders_get | Gets one work order header by its document entry. |
| work_order_positions_list | Lists the positions of one work order: item, planned and made quantities, dates and status. |
| work_order_routings_list | Lists the routing operations of one work order: resource, planned setup and run times. |
| work_order_materials_list | Lists the material lines of one work order: components, planned and booked quantities, warehouse and bin. |
Production times
| Tool | Description |
|---|---|
| active_work_order_times_list | Lists time bookings against operations, running and closed, with personnel, resource, operation and work-order context. |
| production_times_list | Lists posted time receipts with durations, good and scrap quantities, personnel and resource. |
Items
| Tool | Description |
|---|---|
| items_search | Searches items by code or name. Returns master data including stock totals, procurement method and default warehouse. |
| items_get | Gets one item by its exact code, with full master data. |
| item_warehouses_list | Lists per-warehouse stock for one item: on hand, committed, ordered, minimum and maximum. |
| item_materials_list | Lists the bill of materials of one item: components, quantities, units, scrap and linked operations. |
| item_routings_list | Lists the routing of one item: operations, resources, setup and process times. |
| item_versions_list | Lists the versions of one item, with version status and drawing numbers. |
Sales orders
| Tool | Description |
|---|---|
| sales_orders_search | Searches sales orders by customer or status. Returns document number, customer, dates and status. |
| sales_orders_get | Gets one sales order header by its document entry. |
Resources
| Tool | Description |
|---|---|
| resources_list | Lists production resources with capacity, cost and grouping data. |
| resources_get | Gets one production resource by its exact code. |
| resource_downtimes_list | Lists resource downtimes, planned and unplanned, with reason and date range. |
Quality control
| Tool | Description |
|---|---|
| qc_orders_search | Searches QC orders with item, batch, inspection and origin-document context. |
| qc_orders_get | Gets the QC order rows for one charge, which may have several nodes. |
| qc_inspection_plans_search | Searches inspection plans by item, group or customer. |
| qc_templates_search | Searches QC templates (inspection characteristics) by code, description or group. |
| qc_groups_list | Lists QC groups by code or description. |
| qc_valuations_list | Lists QC valuations (assessment codes), optionally within one group. |
| qc_samples_search | Searches QC samples by item or inspection document number. |
| qc_batches_to_verify_search | Searches batches pending verification by item or warehouse. |
| qc_blockage_reasons_list | Lists blockage reasons by code or group. |
Master data
| Tool | Description |
|---|---|
| business_partners_search | Searches business partners — customers, vendors and leads — by code or name. |
| warehouses_list | Lists warehouses with code, name and address data. |
| bin_locations_search | Searches bin locations, optionally within one warehouse. |
| personnel_list | Lists personnel with id, names, group and current presence. |
| tools_list | Lists production tooling with code, description and type. |
| units_of_measure_list | Lists units of measure, optionally only those valid for a given item. |
Routing and operations
| Tool | Description |
|---|---|
| operations_search | Searches operations by code, description or resource. |
| operation_types_list | Lists operation types by code or description. |
| routing_headers_search | Searches routing headers by item, type or status. |
| operation_alternative_list | Lists alternative resources configured on operations. |
| operation_parallel_list | Lists parallel resources configured on operations. |
| operation_tool_list | Lists tools assigned to operations. |
| operation_utility_list | Lists utilities (auxiliary means) assigned to operations. |
Planning
| Tool | Description |
|---|---|
| mrp_scenarios_search | Searches MRP scenarios by description, branch or calculation status. |
| mrp_orders_search | Searches MRP orders by order type, business partner or warehouse. |
| mrp_results_list | Lists MRP calculation results, optionally for one scenario or business partner. |
| mrp_details_list | Lists MRP result detail lines, optionally for one scenario or document type. |
| reservations_search | Searches inventory reservations by item, warehouse or base document. |
Costing
| Tool | Description |
|---|---|
| calculation_schemas_list | Lists costing calculation schemas by code or description. |
| cost_centers_search | Searches cost centers by code or name. |
| cost_carriers_search | Searches cost carriers by code or description. |
| precalculations_search | Searches precalculations (cost estimates) by item or customer. |
| work_order_calculation_headers_search | Searches Work order calculation headers by document entry or schema. |
| work_order_calculation_schemas_list | Lists work-order calculation schema lines, optionally for one document entry. |
| material_groups_list | Lists material groups by code or description. |
| material_group_surcharges_list | Lists material-group surcharge lines, optionally for one group. |
Maintenance
| Tool | Description |
|---|---|
| maintenance_objects_search | Searches maintenance objects by maintenance ID, status or item. |
| maintenance_orders_search | Searches maintenance orders by status or linked Work order. |
| maintenance_statuses_list | Lists maintenance status codes with descriptions. |
| internal_maintenances_search | Searches internal maintenances by status, item or business partner. |
| external_maintenances_search | Searches external (subcontracted) maintenances by status, item or Business partner. |
Calendars and shifts
| Tool | Description |
|---|---|
| resource_calendars_search | Searches resource calendar entries by resource or group. |
| shift_definitions_list | Lists shift definitions, optionally within one shift group. |
| day_templates_list | Lists day templates used to build shift schedules. |
| personnel_shift_models_search | Searches personnel shift-model assignments by personnel ID. |
| personnel_special_shifts_search | Searches personnel special-shift overrides by personnel ID. |
| period_rules_list | Lists working-time period rules — flex-time and overtime. |
| absence_types_list | Lists absence types such as vacation, sick leave and training. |
Analytics
These answer aggregate questions as counts, so an assistant does not fetch rows in order to tally them.
| Tool | Description |
|---|---|
| work_orders_kpis | Headline counts: open, closed, and overdue-open — a delivery date already passed on an order still open. Can be scoped to one customer or item. |
| work_orders_by_status | Count per status ID, largest first. Can be restricted to open or closed orders. |
Discovery and generic query
| Tool | Description |
|---|---|
| beas_entity_schema | Describes the fields, types and key of one API entity set, so a query against it can be written correctly. Called without an entity set, it lists every available name. |
| beas_odata_query | Runs a read-only query against any entity set that has no dedicated tool, with standard $filter, $select and $orderby. Needs a user session; an API-key caller is refused. Returns at most 200 rows, 50 by default. |
tip
An assistant that calls beas_entity_schema before beas_odata_query gets the exact field names
and stops guessing them. A wrong entity-set name is not a dead end either — the server answers with
the list of valid names.
Tools that change data
Four tools write. Each one requires a user session and the same Full Control permission the web client demands for the equivalent action, so an assistant can never reach past the permissions of the user it is connected as.
| Tool | Description | Permission required |
|---|---|---|
| work_orders_create | Creates a work order with one position for a given item and quantity, and returns its document entry. | Full control on Work orders |
| work_orders_update | Updates header fields of an existing work order. Only the fields supplied change. | Full control on Work orders |
| production_times_create | Posts a manual time receipt against a work-order operation, in the position's unit of measure. | Full control on Active Work order times |
| resource_downtimes_create | Records a downtime for a resource, blocking its capacity for the date range. | Full control on Resources |
caution
work_orders_create and production_times_create create real production data, and no tool here
undoes them. Correct or reverse the result in the web client, the same as any other booking.
Related functionality
- Prompts and resources — the guided workflows and the reference material an assistant can read.
- Security and permissions — how the write gate and the read-only API key work.