Campos de respuesta de la API de exportación de datos

Cada punto final de la API de exportación de datos devuelve una matriz JSON de objetos. Utilice las tablas de este apartado para interpretar los campos de cada respuesta.

Convenciones utilizadas en esta referencia

  • Todas las duraciones se expresan en milisegundos.
  • Todos los valores de fecha y hora se formatean según la zona horaria especificada por el parámetro de solicitud timezone, utilizando el formato YYYY-MM-DDTHH:MM:SS.sss.
  • Los campos identificadores (printerId, jobId) se mantienen constantes entre solicitudes y las aplicaciones integradas pueden almacenarlos en caché. printerId nunca cambia, por lo que los valores pueden almacenarse y reutilizarse entre sesiones.

Campos de respuesta de la solicitud GET /printers

El punto final /printers devuelve un objeto por cada impresora identificada en la cuenta y de la que se realiza un seguimiento mediante un recopilador de datos.

Field Tipo Descripción
printerName cadena El nombre de visualización asignado a la impresora en RICOH Predictive Insight.
printerId cadena (UUID) El identificador único de la impresora. Utilice este valor como parámetro printerId cuando llame a las rutas /jobs, /printer-states o /printer-interventions.
engines entero El número de motores de impresión de la impresora. Las impresoras de alimentación continua pueden tener uno o varios motores; las impresoras de hojas sueltas suelen contar con un solo motor. Cada motor aparece como una fila independiente en las respuestas de /printer-states y /printer-interventions.
manufacturer cadena El fabricante de la impresora, por ejemplo, Ricoh o InfoPrint.
modelo cadena El modelo de impresora tal y como lo indica el dispositivo; por ejemplo, RICOH Pro VC80000.
printerMode cadena Si la impresora está funcionando en modo simplex o duplex. Este campo puede ser ausente en aquellos tipos de impresoras en los que el valor no sea aplicable, como, por ejemplo, los dispositivos de hojas sueltas.
printerType cadena Si la impresora admite papel continuous_feed o cut_sheet.
serialNumber cadena El número de serie indicado por la impresora. En el caso de las impresoras con varios motores, este campo puede incluir los números de serie de cada motor en una sola cadena de caracteres; por ejemplo, Impresora 1: 10-11111 e Impresora 2: 10-11112.
connectionStatus cadena Indica si RICOH Predictive Insight puede conectarse actualmente a la impresora. Los valores posibles son connected y not_connected.

Campos de la respuesta de la solicitud GET /jobs

El punto final /jobs devuelve un objeto por cada trabajo procesado por las impresoras solicitadas dentro del intervalo de tiempo indicado.

Field Tipo Descripción
printerId cadena (UUID) El identificador de la impresora que ha procesado el trabajo. Es coincidente con un printerId de la respuesta de /printers.
jobId cadena El identificador único del trabajo.
jobName cadena El nombre del trabajo tal y como se ha enviado a la impresora; normalmente, el nombre del archivo de origen.
jobPrintingSide cadena El lado o los lados en los que se imprime este trabajo, por ejemplo, simplex o duplex.
jobAction cadena El estado del trabajo en el momento en que se tramitó la solicitud. Valores posibles:
  • printing: el trabajo se estaba imprimiendo cuando se envió la solicitud.
  • printed: el trabajo se ha impreso correctamente.
  • aborted: el trabajo se detuvo antes de que terminara la impresión.
  • completed: el trabajo ha alcanzado su estado final. Este valor es un superconjunto que incluye tanto los trabajos iprinted como los aborted. Utilícelo cuando desee recuperar todos los trabajos que ya no estén activos, independientemente de su resultado.
jobStartTime cadena (fecha y hora) La fecha y la hora locales en las que se inició la impresión del trabajo, según la zona horaria indicada en la solicitud.
jobEndTime cadena (fecha y hora) La fecha y la hora locales en las que finalizó el trabajo, según la zona horaria indicada en la solicitud.
jobDuration entero El tiempo de impresión transcurrido para el trabajo, en milisegundos.
printedCopies entero El número de copias generadas por el trabajo.
printedPages entero El número total de páginas lógicas impresas para el trabajo, incluidas todas las copias.
printedImpressions entero El número total de ejemplares impresos. Una impresión corresponde a una cara de una hoja, por lo que un trabajo a doble cara produce dos impresiones por hoja.
printedSheets entero El número total de hojas físicas utilizadas para el trabajo.
printedRollFeet Número En el caso de las impresoras de alimentación continua, la longitud del soporte consumido por el trabajo, en pies.
printedRollMeters Número En el caso de las impresoras de alimentación continua, la longitud del soporte consumido por el trabajo, en metros.
inkC, inkM, inkY, inkK Número La cantidad de tinta cian, magenta, amarilla y negra consumida por el trabajo, expresada por canal de color en centímetros cúbicos (cc).
flushingC, flushingM, flushingY, flushingK Número La cantidad de tinta cian, magenta, amarilla y negra consumida durante las operaciones de vaciado del cabezal de impresión relacionadas con el trabajo, expresada por canal de color en centímetros cúbicos (cc). Los valores de vaciado se registran por separado de lnkC/M/Y/K, de modo que se pueda distinguir el uso productivo de la tinta del uso destinado al mantenimiento.

Campos de respuesta de la solicitud GET /printer-states

El punto final /printer-states devuelve un objeto por motor de impresora y por intervalo de estado. Los campos que aparecen dependen del modo de solicitud:

  • Historial agregado (por defecto): se muestran todos los campos.
  • Solo estado actual (currentState=true): se omiten printerStateDuration, historyStartTime e historyEndTime.
  • Solo categoría de estado (stateCategoryOnly=true): se omite «printerState.
Field Tipo Descripción
printerId cadena (UUID) El identificador de la impresora a la que se refiere esta fila. Es coincidente con un printerId de la respuesta de /printers.
dispositivo cadena El motor de la impresora al que se refiere esta fila; por ejemplo, engine_1, engine_2 o engine_3. Una impresora con varios motores devuelve una fila por cada motor para cada intervalo de estado.
stateCategory cadena La categoría de nivel superior a la que se agrupa el estado del motor. Los valores posibles son up, down, idle y unknown. Utilice este campo para los paneles de control y los informes que requieran categorías uniformes en todos los modelos de impresora.
printerState cadena El estado sin procesar que indica el motor de la impresora, como Printing», Preparing», Maintenance, o Sleeping. Los valores en bruto varían según el modelo de impresora. Se omite cuando stateCategoryOnly=true.
Nota: Consulte Estados de la impresora y categorías de estados para obtener una lista completa de los estados y sus correspondencias.
printerStateDuration entero El tiempo que el motor permaneció en este estado, expresado en milisegundos. Se omite cuando currentState = true.
historyStartTime cadena (fecha y hora) La fecha y la hora locales en las que el motor entró en este estado, según la zona horaria indicada en la solicitud. Se omite cuando currentState = true.
historyEndTime cadena (fecha y hora) La fecha y la hora locales en las que el motor abandonó este estado, según el huso horario indicado en la solicitud. En el caso del intervalo más reciente de una respuesta agregada, este valor puede coincidir con el final del intervalo de tiempo solicitado. Se omite cuando currentState = true.

Campos de respuesta de la solicitud GET /printer-interventions

El punto final /printer-interventions devuelve un objeto por cada evento de intervención, para cada motor de cada impresora solicitada, dentro del intervalo de tiempo solicitado.

Field Tipo Descripción
printerId cadena (UUID) El identificador de la impresora a la que se refiere esta fila. Es coincidente con un printerId de la respuesta de /printers.
interventionStartDate cadena (fecha y hora) La fecha y la hora locales en las que comenzó el evento, en la zona horaria indicada en la solicitud.
interventionEndDate cadena (fecha y hora) La fecha y la hora locales en las que se resolvió el incidente, según la zona horaria indicada en la solicitud.
duración entero La duración del evento, en milisegundos.
description cadena Una breve descripción de la condición que ha provocado la advertencia o el error; por ejemplo, Media emptyl o Paper jaml. Este campo depende del idioma: se muestra en el idioma solicitado mediante el parámetro language, o en inglés si se omite dicho parámetro o si la descripción no está disponible en el idioma solicitado.
dispositivo cadena El motor de la impresora al que se refiere esta fila; por ejemplo, engine_1, engine_2 o engine_3. Una impresora con varios motores devuelve una fila por cada motor para cada evento.
jobName cadena El nombre del trabajo que se estaba imprimiendo cuando se produjo el incidente. El valor es una cadena vacía cuando el evento no está relacionado con ningún trabajo.
interventionCode cadena Un código que identifica la condición. A diferencia de description, este valor es independiente del idioma, por lo que debe utilizarlo cuando necesite agrupar o comparar eventos en distintos idiomas. El formato del código depende de la impresora: las impresoras de hojas sueltas muestran una cadena descriptiva, como coverOpen, mientras que las impresoras de alimentación continua muestran un valor, comoCA00 o 40000006.

In this section:

  1. Estados de la impresora y categorías de estados
    El punto final /printer-states proporciona información tanto sobre el estado bruto de la impresora como sobre una categoría de estado de alto nivel. Utilice las tablas de este apartado para comprender qué estados en bruto se incluyen en cada categoría.
  2. Cómo gestionar los límites de respuesta de la API de exportación de datos
    La API de exportación de datos no paginará las respuestas. Si una solicitud devolviera más datos de los que permite la API en una sola respuesta, la solicitud fallaría y se mostraría un error, en lugar de devolver un resultado parcial. Planifique sus integraciones para mantenerse dentro de los límites, ya sea reduciendo el intervalo de fechas, disminuyendo el número de impresoras por solicitud o ambas cosas.
Tema principal: Cómo trabajar con la API de exportación de datos