Batch
Directe interacties met de API vereisen een geldig Bearer-token of een X-Api-Key-header, en uw account of sleutel moet gekoppeld zijn aan een geldig bedrijf dat geregistreerd is bij RapiD Engineering.
GET /api/Batch
Retourneert een 200 (OK) respons met een lijst van batches in het opgegeven datumbereik. Batches bevatten niet hun producten.
- Vereist geldige
startDate- enendDate-waarden. - Een optionele
search-parameter zoekt op batch-ID, order rule-ID, leverancier of productomschrijving — wanneer opgegeven wordt het datumbereik genegeerd.
Antwoordvelden: Id, OrderRuleId, RapiDVisionDeviceId, BatchStart, LastDateTime, DataCount, Supplier, ProductDescription, SegmentationDefectPercentage, ClassificationDefectPercentage, ColorDefectPercentage, NetWeight, CustomFields.
GET /api/Batch/{id}
Retourneert een 200 (OK) respons met een enkele batch, of 404 als deze niet gevonden is.
GET /api/Batch/Latest
Retourneert een 200 (OK) respons met de meest recent bijgewerkte batch, of 404 als er geen bestaan.
PATCH /api/Batch/{id}
Past een gedeeltelijke update toe op de bewerkbare velden van een bestaande batch. Retourneert een 204 (No Content) respons bij succes, of 200 met een bericht als er niets is gewijzigd.
Verzoekinhoud (elke subset van): BatchStart, LastDateTime, DataCount, Supplier, ProductDescription, SegmentationDefectPercentage, ClassificationDefectPercentage, ColorDefectPercentage, NetWeight, CustomFields, RapiDVisionDeviceId.
POST /api/Batch
Maakt een nieuwe batch aan, waarbij optioneel de bovenliggende Order en Order Rule in dezelfde aanroep worden aangemaakt als deze nog niet bestaan (gematcht op naam). Retourneert een 200 (OK) respons met de aangemaakte batchId, orderRuleId en orderId, of een 409 (Conflict) respons als er al een batch met de opgegeven BatchId bestaat.
Verzoekinhoud:
| Veld | Omschrijving |
|---|---|
BatchId |
Optioneel — geef op om het Id van de batch te bepalen, anders wordt er een gegenereerd. |
BatchStart / LastDateTime |
Batchtiming. |
Supplier / ProductDescription |
Batchgegevens. |
DeviceId |
Het RapiD Vision-apparaat dat deze batch heeft aangemaakt. |
Order / OrderPrice / OrderCreationDate |
Optioneel — maakt een nieuwe Order aan als er nog geen met deze naam bestaat. |
OrderRule / OrderRulePricePerUnit / OrderRulePrice / OrderRuleGrossWeight |
Optioneel — maakt een nieuwe Order Rule aan onder de Order. Vereist dat Order ook is ingesteld. |
CustomFields |
Optionele sleutel/waarde-paren die op de batch worden opgeslagen. |
Note
Producten, analyses per batch en leveranciersstatistieken maken geen deel uit van de externe API.