Tools

Ein Tool ist ein einzelner Vorgang, den ein Assistent aufrufen kann. Der Server stellt 73 bereit: 68 Lese-Tools, nach Bereich gruppiert, 4 Schreib-Tools und 1 generisches OData-Abfrage-Tool. Ein Assistent ermittelt sie, indem er den Server fragt; diese Liste ist also für Sie — damit Sie wissen, was er erreichen kann, bevor Sie ihn verbinden.

Die vier Schreib-Tools erscheinen nur, wenn EnableWriteTools eingeschaltet ist, und das OData-Abfrage-Tool nur, wenn EnableODataQueryTool eingeschaltet ist. Siehe Verbindung.

Fertigungsaufträge

Tool	Beschreibung
work_orders_search	Sucht Fertigungsaufträge. Gibt Kopfdaten zurück: Status, Kunde, Artikel, Termine und Mengen.
work_orders_get	Ruft den Kopf eines Fertigungsauftrags über seine Beleg-ID ab.
work_order_positions_list	Listet die Positionen eines Fertigungsauftrags auf: Artikel, geplante und gefertigte Mengen, Termine und Status.
work_order_routings_list	Listet die Arbeitsgänge des Arbeitsplans eines Fertigungsauftrags auf: Ressource, geplante Rüst- und Laufzeiten.
work_order_materials_list	Listet die Materialpositionen eines Fertigungsauftrags auf: Komponenten, geplante und gebuchte Mengen, Lager und Lagerplatz.

Produktionszeiten

Tool	Beschreibung
active_work_order_times_list	Listet Zeitbuchungen auf Arbeitsgänge auf, laufende und abgeschlossene, mit Angaben zu Personal, Ressource, Arbeitsgang und Fertigungsauftrag.
production_times_list	Listet gebuchte Zeitmeldungen mit Dauer, Gut- und Ausschussmengen, Personal und Ressource auf.

Artikel

Tool	Beschreibung
items_search	Sucht Artikel nach Code oder Name. Gibt Stammdaten zurück, einschließlich Bestandssummen, Beschaffungsart und Standardlager.
items_get	Ruft einen Artikel über seinen exakten Code mit vollständigen Stammdaten ab.
item_warehouses_list	Listet den Bestand eines Artikels je Lager auf: Bestand, disponiert, bestellt, Minimum und Maximum.
item_materials_list	Listet die Stückliste eines Artikels auf: Komponenten, Mengen, Einheiten, Ausschuss und verknüpfte Arbeitsgänge.
item_routings_list	Listet den Arbeitsplan eines Artikels auf: Arbeitsgänge, Ressourcen, Rüst- und Bearbeitungszeiten.
item_versions_list	Listet die Versionen eines Artikels mit Versionsstatus und Zeichnungsnummern auf.

Kundenaufträge

Tool	Beschreibung
sales_orders_search	Sucht Kundenaufträge nach Kunde oder Status. Gibt Belegnummer, Kunde, Termine und Status zurück.
sales_orders_get	Ruft den Kopf eines Kundenauftrags über seine Beleg-ID ab.

Ressourcen

Tool	Beschreibung
resources_list	Listet Produktionsressourcen mit Kapazitäts-, Kosten- und Gruppierungsdaten auf.
resources_get	Ruft eine Produktionsressource über ihren exakten Code ab.
resource_downtimes_list	Listet geplante und ungeplante Ausfallzeiten von Ressourcen mit Grund und Zeitraum auf.

Qualitätskontrolle

Tool	Beschreibung
qc_orders_search	Sucht QC-Aufträge mit Angaben zu Artikel, Charge, Prüfung und Ursprungsbeleg.
qc_orders_get	Ruft die Zeilen des QC-Auftrags für eine Charge ab, die mehrere Knoten haben kann.
qc_inspection_plans_search	Sucht Prüfpläne nach Artikel, Gruppe oder Kunde.
qc_templates_search	Sucht QC-Vorlagen (Prüfmerkmale) nach Code, Beschreibung oder Gruppe.
qc_groups_list	Listet QC-Gruppen nach Code oder Beschreibung auf.
qc_valuations_list	Listet QC-Bewertungen (Bewertungscodes) auf, optional innerhalb einer Gruppe.
qc_samples_search	Sucht QC-Stichproben nach Artikel oder Belegnummer der Prüfung.
qc_batches_to_verify_search	Sucht Chargen, deren Prüfung aussteht, nach Artikel oder Lager.
qc_blockage_reasons_list	Listet Sperrgründe nach Code oder Gruppe auf.

Stammdaten

Tool	Beschreibung
business_partners_search	Sucht Geschäftspartner — Kunden, Lieferanten und Interessenten — nach Code oder Name.
warehouses_list	Listet Lager mit Code, Name und Adressdaten auf.
bin_locations_search	Sucht Lagerplätze, optional innerhalb eines Lagers.
personnel_list	Listet das Personal mit ID, Namen, Gruppe und aktueller Anwesenheit auf.
tools_list	Listet Fertigungswerkzeuge mit Code, Beschreibung und Typ auf.
units_of_measure_list	Listet Maßeinheiten auf, optional nur die für einen bestimmten Artikel gültigen.

Arbeitspläne und Arbeitsgänge

Tool	Beschreibung
operations_search	Sucht Arbeitsgänge nach Code, Beschreibung oder Ressource.
operation_types_list	Listet Vorgangsarten nach Code oder Beschreibung auf.
routing_headers_search	Sucht Arbeitsplanköpfe nach Artikel, Typ oder Status.
operation_alternative_list	Listet die an Arbeitsgängen hinterlegten alternativen Ressourcen auf.
operation_parallel_list	Listet die an Arbeitsgängen hinterlegten parallelen Ressourcen auf.
operation_tool_list	Listet die Arbeitsgängen zugeordneten Werkzeuge auf.
operation_utility_list	Listet die Arbeitsgängen zugeordneten Hilfsmittel auf.

Planung

Tool	Beschreibung
mrp_scenarios_search	Sucht MRP-Szenarien nach Beschreibung, Niederlassung oder Berechnungsstatus.
mrp_orders_search	Sucht MRP-Aufträge nach Auftragsart, Geschäftspartner oder Lager.
mrp_results_list	Listet MRP-Berechnungsergebnisse auf, optional für ein Szenario oder einen Geschäftspartner.
mrp_details_list	Listet Detailzeilen der MRP-Ergebnisse auf, optional für ein Szenario oder eine Belegart.
reservations_search	Sucht Bestandsreservierungen nach Artikel, Lager oder Basisbeleg.

Kalkulation

Tool	Beschreibung
calculation_schemas_list	Listet Kalkulationsschemata nach Code oder Beschreibung auf.
cost_centers_search	Sucht Kostenstellen nach Code oder Name.
cost_carriers_search	Sucht Kostenträger nach Code oder Beschreibung.
precalculations_search	Sucht Vorkalkulationen (Kostenschätzungen) nach Artikel oder Kunde.
work_order_calculation_headers_search	Sucht Kalkulationsköpfe von Fertigungsaufträgen nach Beleg-ID oder Schema.
work_order_calculation_schemas_list	Listet Kalkulationsschemazeilen von Fertigungsaufträgen auf, optional für eine Beleg-ID.
material_groups_list	Listet Materialgruppen nach Code oder Beschreibung auf.
material_group_surcharges_list	Listet Zuschlagszeilen von Materialgruppen auf, optional für eine Gruppe.

Wartung

Tool	Beschreibung
maintenance_objects_search	Sucht Wartungsobjekte nach Wartungs-ID, Status oder Artikel.
maintenance_orders_search	Sucht Wartungsaufträge nach Status oder verknüpftem Fertigungsauftrag.
maintenance_statuses_list	Listet Wartungsstatuscodes mit Beschreibungen auf.
internal_maintenances_search	Sucht interne Wartungen nach Status, Artikel oder Geschäftspartner.
external_maintenances_search	Sucht externe (fremdvergebene) Wartungen nach Status, Artikel oder Geschäftspartner.

Kalender und Schichten

Tool	Beschreibung
resource_calendars_search	Sucht Einträge des Ressourcenkalenders nach Ressource oder Gruppe.
shift_definitions_list	Listet Schichtdefinitionen auf, optional innerhalb einer Schichtgruppe.
day_templates_list	Listet die Tagmuster auf, aus denen Schichtpläne aufgebaut werden.
personnel_shift_models_search	Sucht Zuordnungen von Schichtmodellen zum Personal nach Personal-ID.
personnel_special_shifts_search	Sucht Sonderschichten des Personals, die den Plan übersteuern, nach Personal-ID.
period_rules_list	Listet Stundenregeln für die Arbeitszeit auf — Gleitzeit und Überstunden.
absence_types_list	Listet Abwesenheitsarten wie Urlaub, Krankheit und Schulung auf.

Analysen

Diese Tools beantworten Fragen nach Summen als Anzahlen, sodass ein Assistent keine Zeilen abrufen muss, um sie zu zählen.

Tool	Beschreibung
work_orders_kpis	Kennzahlen als Anzahlen: offen, abgeschlossen und überfällig offen — ein bereits überschrittener Liefertermin bei einem noch offenen Auftrag. Kann auf einen Kunden oder Artikel eingeschränkt werden.
work_orders_by_status	Anzahl je Status-ID, die größte zuerst. Kann auf offene oder abgeschlossene Aufträge beschränkt werden.

Ermittlung und generische Abfrage

Tool	Beschreibung
beas_entity_schema	Beschreibt die Felder, Typen und den Schlüssel einer API-Entitätsmenge, damit eine Abfrage darauf korrekt formuliert werden kann. Ohne Entitätsmenge aufgerufen, listet es alle verfügbaren Namen auf.
beas_odata_query	Führt eine Abfrage nur mit Lesezugriff auf jede Entitätsmenge aus, für die es kein eigenes Tool gibt, mit den Standardoptionen `$filter`, `$select` und `$orderby`. Benötigt eine Benutzersitzung; ein Aufrufer mit API-Schlüssel wird abgewiesen. Gibt höchstens 200 Zeilen zurück, standardmäßig 50.

tipp

Ein Assistent, der beas_entity_schema vor beas_odata_query aufruft, erhält die exakten Feldnamen und muss sie nicht mehr raten. Auch ein falscher Name einer Entitätsmenge ist keine Sackgasse — der Server antwortet mit der Liste der gültigen Namen.

Tools, die Daten ändern

Vier Tools schreiben. Jedes verlangt eine Benutzersitzung und dieselbe Berechtigung Vollzugriff, die der Web Client für die entsprechende Aktion verlangt; ein Assistent kann daher nie über die Berechtigungen des Benutzers hinausgehen, als der er verbunden ist.

Tool	Beschreibung	Erforderliche Berechtigung
work_orders_create	Legt einen Fertigungsauftrag mit einer Position für einen angegebenen Artikel und eine Menge an und gibt seine Beleg-ID zurück.	Vollzugriff auf Fertigungsaufträge
work_orders_update	Aktualisiert Kopffelder eines bestehenden Fertigungsauftrags. Nur die übergebenen Felder ändern sich.	Vollzugriff auf Fertigungsaufträge
production_times_create	Bucht eine manuelle Zeitmeldung auf einen Arbeitsgang eines Fertigungsauftrags, in der Maßeinheit der Position.	Vollzugriff auf Aktive Auftragszeiten
resource_downtimes_create	Erfasst eine Ausfallzeit für eine Ressource und sperrt ihre Kapazität für den Zeitraum.	Vollzugriff auf Ressourcen

vorsicht

work_orders_create und production_times_create erzeugen echte Produktionsdaten, und kein Tool hier macht sie rückgängig. Korrigieren oder stornieren Sie das Ergebnis im Web Client, wie jede andere Buchung.

Fertigungsaufträge​

Produktionszeiten​

Artikel​

Kundenaufträge​

Ressourcen​

Qualitätskontrolle​

Stammdaten​

Arbeitspläne und Arbeitsgänge​

Planung​

Kalkulation​

Wartung​

Kalender und Schichten​

Analysen​

Ermittlung und generische Abfrage​

Tools, die Daten ändern​

Verwandte Funktionen​