Batch
Direkte interaksjoner med API-et krever et gyldig Bearer-token eller en X-Api-Key-header, og kontoen eller nøkkelen din må være knyttet til et gyldig selskap registrert hos RapiD Engineering.
GET /api/Batch
Returnerer en 200 (OK) respons med en liste over batcher i det angitte datointervallet. Batcher inkluderer ikke sine produkter.
- Krever gyldige
startDate- ogendDate-verdier. - En valgfri
search-parameter søker etter batch-ID, order rule-ID, leverandør eller produktbeskrivelse — når oppgitt ignoreres datointervallet.
Responsfelt: Id, OrderRuleId, RapiDVisionDeviceId, BatchStart, LastDateTime, DataCount, Supplier, ProductDescription, SegmentationDefectPercentage, ClassificationDefectPercentage, ColorDefectPercentage, NetWeight, CustomFields.
GET /api/Batch/{id}
Returnerer en 200 (OK) respons med en enkelt batch, eller 404 hvis den ikke finnes.
GET /api/Batch/Latest
Returnerer en 200 (OK) respons med den sist oppdaterte batchen, eller 404 hvis ingen finnes.
PATCH /api/Batch/{id}
Utfører en delvis oppdatering av en eksisterende batchs redigerbare felt. Returnerer en 204 (No Content) respons ved suksess, eller 200 med en melding hvis ingenting ble endret.
Forespørselsinnhold (et hvilket som helst delsett av): BatchStart, LastDateTime, DataCount, Supplier, ProductDescription, SegmentationDefectPercentage, ClassificationDefectPercentage, ColorDefectPercentage, NetWeight, CustomFields, RapiDVisionDeviceId.
POST /api/Batch
Oppretter en ny batch, og oppretter eventuelt den overordnede Order og Order Rule i samme kall hvis de ikke allerede eksisterer (matchet på navn). Returnerer en 200 (OK) respons med den opprettede batchId, orderRuleId og orderId, eller en 409 (Conflict) respons hvis en batch med den angitte BatchId allerede eksisterer.
Forespørselsinnhold:
| Felt | Beskrivelse |
|---|---|
BatchId |
Valgfritt — oppgi for å kontrollere batchens Id, ellers genereres en. |
BatchStart / LastDateTime |
Batch-tidspunkt. |
Supplier / ProductDescription |
Batch-detaljer. |
DeviceId |
RapiD Vision-enheten som opprettet denne batchen. |
Order / OrderPrice / OrderCreationDate |
Valgfritt — oppretter en ny Order hvis det ikke allerede finnes en med dette navnet. |
OrderRule / OrderRulePricePerUnit / OrderRulePrice / OrderRuleGrossWeight |
Valgfritt — oppretter en ny Order Rule under Order. Krever at Order også er satt. |
CustomFields |
Valgfrie nøkkel/verdi-par som lagres på batchen. |
Note
Produkter, analyse per batch og leverandørstatistikk er ikke en del av det eksterne API-et.