Velden in het antwoord van de gegevensexport-API

Elk eindpunt van de gegevensexport-API retourneert een JSON-array met objecten. Gebruik de tabellen in dit onderwerp om de velden in elk antwoord te interpreteren.

In deze referentie gehanteerde conventies

  • Alle tijdsduur wordt uitgedrukt in milliseconden.
  • Alle datum- en tijdwaarden worden weergegeven in de tijdzone die is opgegeven via de parameter timezone, volgens het patroon JJJJ-MM-DDTHH:MM:SS.sss.
  • Identificatievelden (printerId, jobId) blijven bij alle verzoeken hetzelfde en kunnen door geïntegreerde applicaties in de cache worden opgeslagen. De printerId verandert nooit, zodat waarden kunnen worden opgeslagen en gedurende meerdere sessies kunnen worden hergebruikt.

GET /printers – responsvelden

Het eindpunt /printers retourneert één object per printer die in het account is geïdentificeerd en door een data collector wordt bijgehouden.

Veld Type Beschrijving
printerName tekenreeks De weergavenaam die aan de printer is toegewezen in RICOH Predictive Insight.
printerId tekenreeks (UUID) De unieke identificatiecode van de printer. Gebruik deze waarde als de parameter printerId wanneer u de /jobs, /printer-states of /printer-interventions aanroept.
engines integer Het aantal afdrukmotoren in de printer. Printers voor continu-invoer kunnen één of meer printmodules hebben; printers voor losse vellen beschikken doorgaans over één printmodule. Elke motor wordt als een afzonderlijke rij weergegeven in de reacties op /printer-states en /printer-interventions.
manufacturer tekenreeks De fabrikant van de printer, bijvoorbeeld Ricoh of InfoPrint.
model tekenreeks Het printermodel zoals door het apparaat wordt aangegeven, bijvoorbeeld RICOH Pro VC80000.
printerMode tekenreeks Of de printer nu in de simplex of duplex modus werkt. Dit veld is afwezig bij printertypes waarvoor de waarde niet van toepassing is, zoals printers voor losse vellen.
printerType tekenreeks Of de printer papier in doorloopvorm ( continuous_feed ) of losse vellen ( cut_sheet ) ondersteunt.
serialNumber tekenreeks Het serienummer dat door de printer wordt weergegeven. Bij printers met meerdere printkoppen kunnen in dit veld de serienummers van elke printkop in één tekenreeks worden opgenomen, bijvoorbeeld Printer 1: 10-11111 en Printer 2: 10-11112.
connectionStatus tekenreeks Geeft aan of RICOH Predictive Insight momenteel verbinding kan maken met de printer. Mogelijke waarden zijn connected en not_connected.

GET /jobs-antwoordvelden

Het eindpunt /jobs retourneert één object per taak die door de opgegeven printers binnen het opgegeven tijdsbestek is verwerkt.

Veld Type Beschrijving
printerId tekenreeks (UUID) De identificatiecode van de printer die de taak heeft verwerkt. Is overeenkomend met een printerId uit het /printers -antwoord.
jobId tekenreeks De unieke identificatiecode van de taak.
jobName tekenreeks De naam van de taak zoals deze bij de drukker is ingediend; doorgaans de bestandsnaam van het bronbestand.
jobPrintingSide tekenreeks De zijde of zijden die voor deze taak worden bedrukt, bijvoorbeeld enkelzijdig of dubbelzijdig.
jobAction tekenreeks De status van de taak op het moment dat de aanvraag werd verwerkt. Mogelijke waarden:
  • printing: de taak werd afgedrukt toen het verzoek werd verzonden.
  • printed: de afdruktaak is succesvol voltooid.
  • aborted: de taak is beëindigd voordat het afdrukken was voltooid.
  • completed: de taak heeft de eindstatus bereikt. Deze waarde vormt een bovenliggende verzameling die zowel afgedrukte als afgebroken taken omvat. Gebruik deze optie wanneer u alle taken wilt ophalen die niet langer actief zijn, ongeacht de uitkomst.
jobStartTime tekenreeks (datum en tijd) De lokale datum en tijd waarop de taak is begonnen met afdrukken, in de tijdzone die in het verzoek is opgegeven.
jobEndTime tekenreeks (datum en tijd) De lokale datum en tijd waarop de taak is voltooid, in de tijdzone die in de aanvraag is opgegeven.
jobDuration integer De verstreken afdruktijd voor de taak, in milliseconden.
printedCopies integer Het aantal exemplaren dat van de taken is geproduceerd.
printedPages integer Het totale aantal logische pagina’s dat voor de taak is afgedrukt, inclusief alle exemplaren.
printedImpressions integer Het totale aantal gedrukte exemplaren. Een afdruk is één zijde van één vel; bij een dubbelzijdige afdrukopdracht worden dus twee afdrukken per vel geproduceerd.
printedSheets integer Het totale aantal fysieke vellen dat voor deze taak is gebruikt.
printedRollFeet number Voor printers met doorloopvoeding: de lengte van het door de taak verbruikte drukmedium, in feet.
printedRollMeters number Voor printers met doorvoer: de lengte van het medium dat voor de taak wordt verbruikt, in meters.
inkC, inkM, inkY, inkK number De hoeveelheid cyaan-, magenta-, gele en zwarte inkt die door de opdracht is verbruikt, uitgedrukt per kleurkanaal in kubieke centimeter (cc).
flushingC, flushingM, flushingY, flushingK number De hoeveelheid cyaan-, magenta-, gele en zwarte inkt die is verbruikt tijdens het spoelen van de printkop in verband met de opdracht, weergegeven per kleurkanaal in kubieke centimeter (cc). De spoelwaarden worden apart bijgehouden van de inkt (C/M/Y/K), zodat een onderscheid kan worden gemaakt tussen productief inktverbruik en onderhoudsverbruik.

GET /printer-states - responsvelden

Het eindpunt /printer-states retourneert één object per printerengine, per statusinterval. Welke velden aanwezig zijn, hangt af van de verzoekmodus:

  • Geaggregeerde geschiedenis (standaard): alle velden worden weergegeven.
  • Alleen de huidige status (currentState=true): printerStateDuration, historyStartTime en historyEndTime worden weggelaten.
  • Alleen statuscategorie (stateCategoryOnly=true): printerState wordt weggelaten.
Veld Type Beschrijving
printerId tekenreeks (UUID) De identificatiecode van de printer waarop deze rij betrekking heeft. Is overeenkomend met een printerId uit het /printers -antwoord.
engine tekenreeks De motor in de printer die in deze rij wordt beschreven, bijvoorbeeld engine_1, engine_2 of engine_3. Een printer met meerdere printkoppen geeft per statusinterval één rij per printkop weer.
stateCategory tekenreeks De overkoepelende categorie waarnaar de motortoestand wordt samengevat. Mogelijke waarden zijn up, down, idle en unknown. Gebruik dit veld voor dashboards en rapportages waarbij voor alle printermodellen dezelfde categorieën moeten worden gebruikt.
printerState tekenreeks De door de printermotor gerapporteerde ruwe status, zoals Afdrukken, Voorbereiden, Onderhoud of Slaapstand. De onbewerkte statuswaarden verschillen per printermodel. Wordt weggelaten wanneer stateCategoryOnly=true.
Opmerking: Zie Printertoestanden en toestandscategorieën voor een volledige lijst van staten en de bijbehorende toewijzingen.
printerStateDuration integer De tijd dat de motor in deze toestand verbleef, uitgedrukt in milliseconden. Wordt weggelaten wanneer currentState=true.
historyStartTime tekenreeks (datum en tijd) De lokale datum en tijd waarop de engine in deze toestand is gekomen, in de tijdzone die in het verzoek is opgegeven. Wordt weggelaten wanneer currentState=true.
historyEndTime tekenreeks (datum en tijd) De lokale datum en tijd waarop de engine deze status heeft verlaten, in de tijdzone die in het verzoek is opgegeven. Voor het meest recente interval in een geaggregeerd antwoord kan deze waarde gelijk zijn aan het einde van het opgevraagde tijdsbereik. Wordt weggelaten wanneer currentState=true.

GET /printer-interventions - responsvelden

Het eindpunt /printer-interventions retourneert één object per interventiegebeurtenis, voor elke printermotor van elke opgevraagde printer, binnen het opgegeven tijdsbereik.

Veld Type Beschrijving
printerId tekenreeks (UUID) De identificatiecode van de printer waarop deze rij betrekking heeft. Is overeenkomend met een printerId uit het /printers -antwoord.
interventionStartDate tekenreeks (datum en tijd) De lokale datum en tijd waarop de gebeurtenis begon, in de tijdzone die in het verzoek is opgegeven.
interventionEndDate tekenreeks (datum en tijd) De lokale datum en tijd waarop het voorval is opgelost, in de tijdzone die in het verzoek is opgegeven.
duration integer De duur van de gebeurtenis, uitgedrukt in milliseconden.
description tekenreeks Een korte beschrijving van de voorwaarde die aanleiding gaf tot de waarschuwing of foutmelding, bijvoorbeeld Geen media of Papierstoring. Dit veld is taalafhankelijk: het wordt weergegeven in de taal die via de language-parameter is opgegeven, of in het Engels indien die parameter is weggelaten of de beschrijving niet beschikbaar is in de opgegeven taal.
engine tekenreeks De motor in de printer die in deze rij wordt beschreven, bijvoorbeeld engine_1, engine_2 of engine_3. Een printer met meerdere motoren retourneert voor elke gebeurtenis één rij per motor.
jobName tekenreeks De naam van de taak die op dat moment werd afgedrukt toen de gebeurtenis plaatsvond. De waarde is een lege tekenreeks wanneer er geen taak bij de gebeurtenis betrokken was.
interventionCode tekenreeks Een code die de voorwaarde aanduidt. In tegenstelling tot de description is deze waarde taalonafhankelijk; gebruik deze daarom wanneer u gebeurtenissen over verschillende talen heen wilt groeperen of vergelijken. De indeling van de code is afhankelijk van de printer: printers voor losse vellen geven een beschrijvende tekenreeks weer, zoals coverOpen, terwijl printers voor doorlooppapier een waarde weergeven, zoals CA00 of 40000006.

In this section:

  1. Printertoestanden en toestandscategorieën
    Het eindpunt /printer-states geeft zowel de ruwe status van de printer als een algemene statuscategorie weer. Gebruik de tabellen in dit onderwerp om te begrijpen welke ruwe statussen in welke categorieën worden ondergebracht.
  2. Omgaan met responslimieten van de gegevensexport-API
    De gegevensexport-API voert geen paginering van de antwoorden uit. Indien een verzoek meer gegevens zou opleveren dan de API in één enkel antwoord toestaat, mislukt het verzoek met een foutmelding in plaats van dat er een gedeeltelijk resultaat wordt teruggegeven. Plan uw integraties zodanig dat u binnen de limieten blijft door de datumperiode te beperken, het aantal printers per verzoek te verminderen, of beide.
Ouder onderwerp: Werken met de gegevensexport-API