1. Inicio
  2. Base de conocimientos
  3. Obtener la lista de documentos

Obtener la lista de documentos

 

Obtener una lista filtrada de todos los documentos de la organización

URL:

POST http://api.aurelon.com/api/v2/document/list

Cabeceras de solicitud:

Content-Type : application/json
MisKey : ver Autenticación

Cuerpo de la solicitud:

Objeto JSON que contiene uno o más de los siguientes filtros:

  • Número de serie
  • Trabajo
  • JobGUID
  • Dispositivo
  • DeviceGUID
  • MediaType
  • MediaSize
  • Cola de espera
  • Usuario
  • Productor
  • StatusList – una matriz con los siguientes estados(Error, Esperando, EnProceso, Completado, Cancelado, Borrado, PeticiónDeImpresión, NoSoportado).
    Los siguientes estados diferencian entre trabajos activos y completos:

    • Trabajosactivos (estados Error, En espera, En curso, Cancelado, Solicitud de impresión y No admitido)
    • Trabajocompletado (Completado, Borrado)

Respuesta:

Devuelve los trabajos de la empresa filtrados por el filtro del cuerpo de la solicitud.

El éxito:

200 OK : Devuelve la lista de trabajos

[{
    "DocumentGUID": "3dfd53fd-2d6b-11e6-853c-793ef2c92c66",
    "Document": "Ducky.tif",
    "Jobs": [
"29F9ED80-F45D-4A2B-B067-BDD638D1E6FD",
"29680F35-4C41-4025-8915-3C688DABD456"
    ],
    "Devices": [
        "03ca4950-0f14-4e58-9bf9-a036c2e1b316",
        "0cc6bcfe-8ada-4c4a-852a-952d720d3b51"
    ],
    "Media": ["Roll 10 inch", "Roll 17 inch"],
    "MediaType": ["SemiMatte 250g/m2"],
    "Queue": [ "AD3AFA36-BF8B-4AE7-9553-206A0AD339B8" ],
    "Status": "InProgress",
    "Users": ["wendell.lucas"],
    "Producer": "Hotfolder",
    "Progress": 70
}, {
    "DocumentGUID": "a7dcef15-7283-4eb1-ac96-94a6d5e859bd",
    "Document": "Lemonade.jpg",
    "Jobs": [
"65eec7e8-c05b-429c-8b8a-8ce16fc55010",
       "d43e9158-39c1-46b9-98b3-3418126e5255"
    }],
    "Media": ["100 inch roll"],
    "MediaType": ["Paper 250g 09.05.2016"],
    "Queue": [],
    "Status": "Completed",
    "Users": ["julia.bailey"],
    "Producer": "Layout",
    "Progress": 0
}]

Error:

  • 400 Bad Request : {«Mensaje»: «»DocumentGUID» valor requerido»}
  • 401 No autorizado : {«Mensaje»: «Invalid MisKey»}
  • 401 No autorizado : {«Mensaje»: «»MisKey» o «HardwareHash», «SerialNumber» y «ApplicationVersion» header are required»}
  • 415 Tipo de medio no soportado : {«Mensaje»: «Tipo esperado: application/json»}
  • 500 Internal Server Error : {«Mensaje»: «Internal Server Error»}
Updated on mayo 10, 2022

Was this article helpful?