Batch

Direkte Interaktionen mit der API erfordern ein gültiges Bearer-Token oder einen X-Api-Key-Header, und Ihr Konto oder Schlüssel muss mit einem gültigen, bei RapiD Engineering registrierten Unternehmen verknüpft sein.

Akzeptiertes DateTime-Format

2026-04-10T13:19:47Z
"yyyy-MM-ddTHH:mm:ssZ"

GET /api/Batch

Gibt eine 200 (OK) Antwort mit einer Liste von Batches im angegebenen Datumsbereich zurück. Batches enthalten nicht ihre Produkte.

Erfordert gültige startDate- und endDate-Werte.
Ein optionaler search-Parameter sucht nach Batch-ID, Order Rule-ID, Lieferant oder Produktbeschreibung — wenn angegeben, wird der Datumsbereich ignoriert.

Anfrage

$"{api_url}/api/Batch?startDate={datetime}&endDate={datetime}"

Antwortfelder: Id, OrderRuleId, RapiDVisionDeviceId, BatchStart, LastDateTime, DataCount, Supplier, ProductDescription, SegmentationDefectPercentage, ClassificationDefectPercentage, ColorDefectPercentage, NetWeight, CustomFields.

GET /api/Batch/{id}

Gibt eine 200 (OK) Antwort mit einem einzelnen Batch zurück, oder 404 wenn nicht gefunden.

Anfrage

$"{api_url}/api/Batch/{batch Guid}"

GET /api/Batch/Latest

Gibt eine 200 (OK) Antwort mit dem zuletzt aktualisierten Batch zurück, oder 404 wenn keine vorhanden sind.

Anfrage

$"{api_url}/api/Batch/Latest"

PATCH /api/Batch/{id}

Wendet eine teilweise Aktualisierung auf die bearbeitbaren Felder eines bestehenden Batches an. Gibt eine 204 (No Content) Antwort bei Erfolg zurück, oder 200 mit einer Nachricht wenn sich nichts geändert hat.

Anfragekörper (beliebige Teilmenge von): BatchStart, LastDateTime, DataCount, Supplier, ProductDescription, SegmentationDefectPercentage, ClassificationDefectPercentage, ColorDefectPercentage, NetWeight, CustomFields, RapiDVisionDeviceId.

Anfrage

PATCH $"{api_url}/api/Batch/{batch Guid}"

POST /api/Batch

Erstellt einen neuen Batch, wobei optional die übergeordnete Order und Order Rule im selben Aufruf erstellt werden, falls sie noch nicht existieren (Zuordnung über den Namen). Gibt eine 200 (OK) Antwort mit der erstellten batchId, orderRuleId und orderId zurück, oder eine 409 (Conflict) Antwort wenn bereits ein Batch mit der angegebenen BatchId existiert.

Anfragekörper:

Feld	Beschreibung
`BatchId`	Optional — angeben um die Id des Batches festzulegen, andernfalls wird eine generiert.
`BatchStart` / `LastDateTime`	Batch-Zeitangaben.
`Supplier` / `ProductDescription`	Batch-Details.
`DeviceId`	Das RapiD Vision-Gerät, das diesen Batch erstellt hat.
`Order` / `OrderPrice` / `OrderCreationDate`	Optional — erstellt eine neue Order, falls noch keine mit diesem Namen existiert.
`OrderRule` / `OrderRulePricePerUnit` / `OrderRulePrice` / `OrderRuleGrossWeight`	Optional — erstellt eine neue Order Rule unter der Order. Erfordert, dass `Order` ebenfalls gesetzt ist.
`CustomFields`	Optionale Schlüssel/Wert-Paare, die auf dem Batch gespeichert werden.

Note

Produkte, Batch-bezogene Analysen und Lieferantenstatistiken sind nicht Teil der externen API.