Qualität – Vollständige API-Referenz

Fach-API für Prüfpläne, die Zuordnung zum Artikel und Qualitätsdokumente. Basis ist https://core-backend.reybex.com/api (Staging: https://io-staging-partner.reybex.com/api). Authentifizierung wie im API: --header "authorization: Basic $TOKEN".

Der Artikel steht unter Artikelstamm-Verwaltung. Wareneingang unter Lager und Inventur. Der Lieferant unter Kunden- und Lieferantenverwaltung. Der Fertigungsarbeitsgang unter Produktion.

Der schreibende Weg des Prüfplans ist POST /api/qualityPlan/. Der des Dokuments ist POST /api/qualityHead/. Der Körper ist der Datensatz selbst, ohne Umschlag. items werden getrennt gespeichert. Leere Objekte werden zu null.

1. Grundlagen

Objekt	Rolle
QualityPlan	Plan mit Nummer, Zeitraum und Prüfpunkten
QualityHead	Prüfung eines Artikels, einer Charge oder eines Arbeitsgangs
QualityPlanArea	Bereich der Prüfung
QualityPlanCheckType	Prüfart

Die Zahlen in den Beispielen sind Beispiel-Ids eines Mandanten. 100100 ist Artikel ART-1000. 30020 ist Lieferant LF-200. 501 ist der Benutzer, der prüft. Fehlt controlledBy, setzt das Dokument den angemeldeten Benutzer.

Die Plannummer und die Dokumentnummer vergibt die API, wenn sie leer sind.

1.1 Suchschlüssel

Ziel	Suchschlüssel
Artikel	matCode, sonst sku
Lieferant	customerNo
Bereich und Prüfart	code, sonst name

1.2 Antwort- und Fehlerformat

Speichern von Plan und Dokument liefert { "id": … }.

Situation	Körper
Datensatz nicht gefunden	nicht gefunden
Fehlende Anmeldung	HTTP 401

2. Prüfplan

POST /api/qualityPlan/ legt an, wenn keine id im Körper steht.

2.1 Felder

Feld	Bedeutung
qualityNumber	Plannummer. Sonst vergibt die API sie
qualityPlanArea	Bereich
qualityPlanCheckType	Prüfart
dateFrom, dateUntil	Gültigkeit, yyyy-MM-dd
vendor	Lieferant
description	Text
drawingNumber, drawingIndex, drawingDate	Zeichnung
items	Prüfpunkte. Nicht genannte bestehende Punkte werden gelöscht

2.2 Pflichtfelder

Auflösung, wenn ein Pflichtfeld fehlt

Die API setzt Pflicht-Referenzen nicht von selbst. Fehlt ein Feld, in dieser Reihenfolge füllen. Der erste Treffer gilt.

1. Angabe – Wert aus dem Auftrag für dieses Feld.
2. Vorlage – dasselbe Feld aus GET /api/qualityPlan/{id}. id und qualityNumber nicht übernehmen. Ist eine Vorlage genannt, diese lesen. Ist keine genannt, keine raten, mit Schritt 3 weiter.
3. Standard – Wert aus der Tabelle.
4. Domäne – GET /api/domains/qualityPlanArea?take=1&sort=code und GET /api/domains/qualityPlanCheckType?take=1&sort=code. Den Treffer per Suchschlüssel setzen.
5. Stopp – Bereich oder Prüfart ist leer. Plan nicht anlegen.

Feld	Pflicht	Vorlage	Standard	Domäne
qualityPlanArea	ja	qualityPlanArea	—	qualityPlanArea
qualityPlanCheckType	ja	qualityPlanCheckType	—	qualityPlanCheckType
description	nein	description	—	—
qualityNumber	nein	nicht übernehmen	Nummernkreis	—

2.3 Plan anlegen

{
  "description": "Wareneingang Schrauben",
  "qualityPlanArea": { "id": 71 },
  "qualityPlanCheckType": { "id": 81 },
  "dateFrom": "2026-10-01",
  "vendor": { "customerNo": "LF-200" },
  "items": [
    { "checkName": "Maß", "description": "Maß prüfen", "position": 10 }
  ]
}

71 ist der Bereich, 81 die Prüfart. Response: { "id": 99501 }

Lesen: GET /api/qualityPlan/99501. Löschen: DELETE /api/qualityPlan/ mit den Ids.

Artikel zuordnen: POST /api/qualityPlan/planAssignToMaterial

{
  "qualityPlan": { "id": 99501 },
  "material": { "matCode": "ART-1000" }
}

Anhang: POST /api/qualityPlan/saveAttachment. Entfernen: DELETE /api/qualityPlan/deleteAttachment.

3. Qualitätsdokument

POST /api/qualityHead/ legt an, wenn keine id im Körper steht. controlledBy wird der angemeldete Benutzer, wenn es fehlt.

{
  "qualityPlan": { "id": 99501 },
  "material": { "matCode": "ART-1000" },
  "vendor": { "customerNo": "LF-200" },
  "checkCount": 1,
  "description": "Los 2026-10",
  "items": [
    { "checkName": "Maß", "position": 10, "checkedOk": true }
  ]
}

Response: { "id": 99601 }

Bewertung: POST /api/qualityHead/createQualityAssessment. Prüfung abschließen: POST /api/qualityHead/controlQuality. Checkliste: GET /api/qualityHead/checkList/99601.

decisionStatus ist die Entscheidung. createClaim true legt einen Anspruch an. prodOrderOperation bindet die Prüfung an einen Arbeitsgang. stockItem bindet sie an eine Charge.

Lesen: GET /api/qualityHead/99601.

4. Weitere Beispiele

4.1 Wareneingang prüfen

1. Prüfplan anlegen, Abschnitt Plan.
2. Plan dem Artikel zuordnen.
3. Dokument mit Lieferant und Menge anlegen.
4. POST /api/qualityHead/controlQuality.

5. Endpoint-Katalog

Methode	Pfad	Bedeutung
GET	/api/qualityPlan/{id}	Ein Plan oder die Liste
POST	/api/qualityPlan/	Plan speichern
DELETE	/api/qualityPlan/	Plan löschen
POST	/api/qualityPlan/planAssignToMaterial	Plan einem Artikel zuordnen
POST	/api/qualityPlan/saveAttachment	Anhang
DELETE	/api/qualityPlan/deleteAttachment	Anhang löschen
GET	/api/qualityHead/{id}	Ein Dokument oder die Liste
POST	/api/qualityHead/	Dokument speichern
POST	/api/qualityHead/createQualityAssessment	Bewertung
POST	/api/qualityHead/controlQuality	Prüfung abschließen
GET	/api/qualityHead/checkList/{id}	Checkliste

6. Häufige Fehler

Situation	Ursache
Prüfpunkte verschwinden	items ohne die bisherigen id. Nicht genannte Punkte werden gelöscht
Artikel nicht zugeordnet	planAssignToMaterial ohne Plan oder ohne Artikel