Feldnamen der Antwort der Datenexport-API

Jeder Endpunkt der Datenexport-API gibt ein JSON-Array aus Objekten zurück. Verwenden Sie die Tabellen in diesem Abschnitt, um die Felder in den einzelnen Antworten zu interpretieren.

In dieser Referenz verwendete Konventionen

  • Alle Zeitangaben werden in Millisekunden angegeben.
  • Alle Datums- und Zeitangaben werden in der durch den timezone Anfrageparameter angegebenen Zeitzone nach dem Muster JJJJ-MM-DDTHH:MM:SS.sss formatiert.
  • Identifikationsfelder (printerId, jobId) bleiben über mehrere Anfragen hinweg unverändert und können von integrierten Anwendungen zwischengespeichert werden. Da sich die printerId niemals ändert, können die Werte gespeichert und über mehrere Sitzungen hinweg wiederverwendet werden.

GET /printers – Antwortfelder

Der Endpunkt /printers gibt pro Drucker, der im Konto identifiziert und von einem Data Collector erfasst wird, ein Objekt zurück.

Feld Typ Beschreibung
printerName Zeichenfolge Der Anzeigename, der dem Drucker unter RICOH Predictive Insight zugewiesen wurde.
printerId Zeichenfolge (UUID) Die eindeutige Kennung des Druckers. Verwenden Sie diesen Wert als printerId-Parameter, wenn Sie die Endpunkte /Jobs, /printer-states oder /printer-interventions aufrufen.
engines ganze-zahl Die Anzahl der Druckwerke im Drucker. Endlosdrucker können über eine oder mehrere Druckwerke verfügen; bei Einzelblattdruckern ist in der Regel ein einziges Druckwerk vorhanden. Jeder Motor wird in den Antworten auf die Anfragen /printer-states und /printer-interventions als eigene Zeile aufgeführt.
manufacturer Zeichenfolge Der Hersteller des Druckers, beispielsweise Ricoh oder InfoPrint.
model Zeichenfolge Das vom Gerät gemeldete Druckermodell, beispielsweise RICOH Pro VC80000.
printerMode Zeichenfolge Ob der Drucker im simplex- oder im duplex-Modus arbeitet. Dieses Feld ist bei Druckertypen, für die der Wert nicht zutrifft – wie beispielsweise bei Einzelblattdruckern –, abwesend.
printerType Zeichenfolge Ob der Drucker continuous_feed oder cut_sheet unterstützt.
serialNumber Zeichenfolge Die vom Drucker angezeigte Seriennummer. Bei Druckern mit mehreren Druckwerken können in diesem Feld die Seriennummern der einzelnen Druckwerke in einer einzigen Zeichenfolge angegeben werden, beispielsweise Printer 1: 10-11111 and Printer 2: 10-11112.
connectionStatus Zeichenfolge Gibt an, ob RICOH Predictive Insight derzeit eine Verbindung zum Drucker herstellen kann. Mögliche Werte sind connected und not_connected.

GET /Jobs – Antwortfelder

Der Endpunkt /jobs gibt pro Job, der von den angeforderten Druckern innerhalb des angegebenen Zeitraums verarbeitet wurde, ein Objekt zurück.

Feld Typ Beschreibung
printerId Zeichenfolge (UUID) Die Kennung des Druckers, der den Job verarbeitet hat. Ist mit einer printerId aus der Antwort unter /printers übereinstimmend.
jobId Zeichenfolge Die eindeutige Kennung des Jobs.
jobName Zeichenfolge Der Name des Jobs, wie er an den Drucker übermittelt wurde; in der Regel der Name der Quelldatei.
jobPrintingSide Zeichenfolge Die Seite(n), die für diesen Job bedruckt werden, beispielsweise simplex oder duplex.
jobAction Zeichenfolge Der Status der Jobs zum Zeitpunkt der Bearbeitung der Anfrage. Mögliche Werte:
  • printing: Der Job wurde gerade gedruckt, als die Anfrage gestellt wurde.
  • printed: Der Job wurde erfolgreich abgeschlossen.
  • aborted: Der Job wurde beendet, bevor der Druckvorgang abgeschlossen war.
  • completed: Der Job hat seinen Endzustand erreicht. Dieser Wert ist eine Obermenge, die sowohl printed Jobs als auch aborted Jobs umfasst. Verwenden Sie diese Funktion, wenn Sie alle Jobs abrufen möchten, die nicht mehr aktiv sind, unabhängig vom Ergebnis.
jobStartTime Zeichenfolge (Datum/Uhrzeit) Das lokale Datum und die Uhrzeit, zu denen der Job gestartet wurde, in der in der Anfrage angegebenen Zeitzone.
jobEndTime Zeichenfolge (Datum/Uhrzeit) Das lokale Datum und die lokale Uhrzeit, zu denen der Job beendet wurde, in der in der Anfrage angegebenen Zeitzone.
jobDuration ganze-zahl Die verstrichene Druckzeit für den Job in Millisekunden.
printedCopies ganze-zahl Die Anzahl der erstellten Exemplare der Jobs.
printedPages ganze-zahl Die Gesamtzahl der für den Job gedruckten logischen Seiten, einschließlich aller Kopien.
printedImpressions ganze-zahl Die Gesamtzahl der gedruckten Exemplare. Ein Druckbild entspricht einer Seite eines Blattes; bei einem Duplex-Job entstehen somit zwei Druckbilder pro Blatt.
printedSheets ganze-zahl Die Gesamtzahl der für die Jobs verwendeten physischen Blätter.
printedRollFeet number Bei Endlosdruckern die Länge des für den Job verbrauchten Druckmediums in Fuß.
printedRollMeters number Bei Endlosdruckern die Länge des für den Job verbrauchten Druckmediums in Metern.
inkC, inkM, inkY, inkK number Die Menge an Cyan-, Magenta-, Gelb- und Schwarztinte, die für den Job verbraucht wurde, angegeben pro Farbkanal in Kubikzentimetern (cc).
flushingC, flushingM, flushingY, flushingK number Die Menge an Cyan-, Magenta-, Gelb- und Schwarztinte, die während der mit dem Job verbundenen Spülvorgänge des Druckkopfs verbraucht wurde, angegeben pro Farbkanal in Kubikzentimetern (cc). Die Werte zum Spülen werden getrennt von den inkC/M/Y/K erfasst, sodass der produktive Tintenverbrauch vom Verbrauch für Wartungszwecke unterschieden werden kann.

GET /printer-states – Antwortfelder

Der Endpunkt /printer-states gibt pro Drucker-Engine und pro Zustandsintervall ein Objekt zurück. Welche Felder vorhanden sind, hängt vom Anforderungsmodus ab:

  • Aggregierte Historie (Standard): Es werden alle Felder zurückgegeben.
  • Nur aktueller Status (currentState=true): printerStateDuration, historyStartTime und historyEndTime werden weggelassen.
  • Nur Zustandskategorie (stateCategoryOnly=true): printerState wird weggelassen.
Feld Typ Beschreibung
printerId Zeichenfolge (UUID) Die Kennung des Druckers, auf den sich diese Zeile bezieht. Ist mit einer printerId aus der Antwort unter /printers übereinstimmend.
engine Zeichenfolge Der Motor im Drucker, auf den sich diese Zeile bezieht, beispielsweise engine_1, engine_2 oder engine_3. Ein Drucker mit mehreren Druckwerken gibt für jedes Zustandsintervall eine Zeile pro Druckwerk zurück.
stateCategory Zeichenfolge Die übergeordnete Kategorie, in die der Motorstatus zusammengefasst wird. Mögliche Werte sind up, down, idle und unknown. Verwenden Sie dieses Feld für Kontrollanzeigen und Berichte, bei denen über alle Druckermodelle hinweg einheitliche Kategorien erforderlich sind.
printerState Zeichenfolge Der von der Drucker-Engine gemeldete Rohzustand, wie beispielsweise Printing, Preparing, Maintenance oder Sleeping. Die Rohwerte variieren je nach Druckermodell. Wird weggelassen, wenn stateCategoryOnly=true ist.
Hinweis: Eine vollständige Liste der Bundesstaaten und ihrer Zuordnungen finden Sie unter Druckerzustände und Zustandskategorien.
printerStateDuration ganze-zahl Die Dauer, während der sich der Motor in diesem Zustand befand, in Millisekunden. Wird weggelassen, wenn currentState=true ist.
historyStartTime Zeichenfolge (Datum/Uhrzeit) Das lokale Datum und die Uhrzeit, zu denen der Motor diesen Zustand erreicht hat, in der in der Anfrage angegebenen Zeitzone. Wird weggelassen, wenn currentState=true ist.
historyEndTime Zeichenfolge (Datum/Uhrzeit) Das lokale Datum und die Uhrzeit, zu der die Engine diesen Zustand verlassen hat, in der in der Anfrage angegebenen Zeitzone. Für das jüngste Intervall in einer aggregierten Antwort kann dieser Wert dem Ende des angeforderten Zeitraums entsprechen. Wird weggelassen, wenn currentState=true ist.

GET /printer-interventions – Antwortfelder

Der Endpunkt /printer-interventions gibt für jedes Interventionsereignis ein Objekt zurück, und zwar für jede Druckereinheit jedes angeforderten Druckers innerhalb des angeforderten Zeitraums.

Feld Typ Beschreibung
printerId Zeichenfolge (UUID) Die Kennung des Druckers, auf den sich diese Zeile bezieht. Ist mit einer printerId aus der Antwort unter /printers übereinstimmend.
interventionStartDate Zeichenfolge (Datum/Uhrzeit) Das lokale Datum und die Uhrzeit des Beginns des Ereignisses in der in der Anfrage angegebenen Zeitzone.
interventionEndDate Zeichenfolge (Datum/Uhrzeit) Das lokale Datum und die Uhrzeit, zu denen das Ereignis abgewickelt wurde, in der in der Anfrage angegebenen Zeitzone.
duration ganze-zahl Die Dauer des Ereignisses in Millisekunden.
description Zeichenfolge Eine kurze Beschreibung der Bedingung, die die Warnung oder den Fehler ausgelöst hat, beispielsweise Medien leer oder Papierstau. Dieses Feld ist sprachabhängig: Es wird in der durch den language-Parameter angeforderten Sprache zurückgegeben oder auf Englisch, falls dieser Parameter weggelassen wird oder die Beschreibung in der angeforderten Sprache nicht verfügbar ist.
engine Zeichenfolge Der Motor im Drucker, auf den sich diese Zeile bezieht, beispielsweise engine_1, engine_2 oder engine_3. Ein Drucker mit mehreren Modulen gibt für jedes Ereignis eine Zeile pro Modul zurück.
jobName Zeichenfolge Der Name des Jobs, der zum Zeitpunkt des Ereignisses gerade gedruckt wurde. Der Wert ist eine leere Zeichenfolge, wenn kein Job an dem Ereignis beteiligt war.
interventionCode Zeichenfolge Ein Code, der die Bedingung kennzeichnet. Im Gegensatz zur description ist dieser Wert sprachunabhängig; verwenden Sie ihn daher, wenn Sie Ereignisse sprachübergreifend gruppieren oder vergleichen möchten. Das Format des Codes hängt vom Drucker ab: Einzelblattdrucker geben eine beschreibende Zeichenfolge wie coverOpen aus, während Endlosdrucker einen Wert wie CA00 oder 40000006 ausgeben.

In this section:

  1. Druckerzustände und Zustandskategorien
    Der Endpunkt /printer-states gibt sowohl den Rohzustand des Druckers als auch eine übergeordnete Zustandskategorie zurück. Anhand der Tabellen in diesem Abschnitt können Sie nachvollziehen, welche Rohdaten in welche Kategorien zusammengefasst werden.
  2. Umgang mit den Antwortbeschränkungen der Datenexport-API
    Die Datenexport-API führt keine Paginierung der Antworten durch. Sollte eine Anfrage mehr Daten zurückgeben, als die API in einer einzelnen Antwort zulässt, schlägt die Anfrage mit einer Fehlermeldung fehl, anstatt ein Teilergebnis zurückzugeben. Planen Sie Ihre Integrationen so, dass Sie die Grenzwerte einhalten, indem Sie den Datumsbereich eingrenzen, die Anzahl der Drucker pro Anfrage reduzieren oder beides tun.
Übergeordnetes Thema: Arbeiten mit der Datenexport-API