1. Zuhause
  2. Wissensdatenbank
  3. Dokumentenliste abrufen

Dokumentenliste abrufen

 

Abrufen einer gefilterten Liste aller Dokumente in der Organisation

URL:

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

Kopfzeilen anfordern:

Inhalt-Typ : anwendung/json
MisKey : siehe Authentifizierung

Anfrage Körper:

JSON-Objekt, das einen oder mehrere der folgenden Filter enthält:

  • SerienNummer
  • Job
  • JobGUID
  • Gerät
  • GeräteGUID
  • MediaType
  • MediaSize
  • Warteschlange
  • Benutzer
  • Produzent
  • StatusList – ein Array mit den folgenden Status(Error, Waiting, InProgress, Completed, Canceled, Deleted, PrintRequest, NotSupported).
    Bei den folgenden Status wird zwischen aktiven und abgeschlossenen Aufträgen unterschieden:

    • Aktive Aufträge (Status „Fehler“, „Warten“, „In Bearbeitung“, „Abgebrochen“, „PrintRequest“ und „NotSupported“)
    • Erledigter Auftrag (Erledigt, Gelöscht)

Antwort:

Liefert die nach dem Filter des Anfragekörpers gefilterten Unternehmensaufträge.

Erfolg:

200 OK : Rückgabe der Auftragsliste

[{
    "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
}]

Fehler:

  • 400 Bad Request : {„Message“: „“DocumentGUID“ Wert erforderlich“}
  • 401 Unerlaubt : {„Nachricht“: „Ungültiger MisKey“}
  • 401 Unerlaubt : {„Meldung“: „“MisKey“ oder „HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header are required“}
  • 415 Nicht unterstützter Medientyp : {„Meldung“: „Erwarteter Typ: application/json“}
  • 500 Interner Serverfehler : {„Meldung“: „Interner Serverfehler“}
Updated on Mai 10, 2022

Was this article helpful?