/
DocumentFileService (/documentfiles)

DocumentFileService (/documentfiles)

Owned by Team Dodo
Last updated: Apr 01, 2025 by Technische Redaktion

/osrest/api/documentfiles/[id]

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Die Methode liefert Detailinformationen für das Objekt mit der gegebenen ID.

Das Ergebnis enthält folgende Informationen:

  • fav: Das Dokument wurde vom Benutzer als Favorit markiert.

  • typeless: Es handelt sich um ein typlosees Dokument.

  • contentviewerUrl: URL zum Öffnen des Objekts in der kombinierten Ansicht von enaio® contentviewer.

  • contentviewerDocumentUrl: URL zum Öffnen des Objekts in der Dokumentenansicht von enaio® contentviewer.

  • contentviewerIndexdataUrl: URL zum Öffnen des Objekts in der Indexdatenansicht von enaio® contentviewer.

  • oswebLinkUrl: URL zum Öffnen des Objekts in enaio® webclient.

  • files: Die Liste der mit dem Dokument verbundenen Dateien.

{ fav: false typeless: false contentviewerUrl: "https://..." contentviewerDocumentUrl: "https://..." contentviewerIndexdataUrl: "https://..." oswebLinkUrl: "https://..." pageCount: 1 -files: [ "1.doc" ] }

/osrest/api/documentfiles/[id]/[page]

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: application/octet-stream

Die Methode liefert eine bestimmte Seite für das Objekt mit dem gegebenen Seitennamen bzw. der Seitennummer (siehe /osrest/api/documentfiles/[id]) zurück. Bei einseitigen Dokumenten kann also immer die 1 übergeben werden.

/osrest/api/documentfiles/[id]/pdf

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: application/octet-stream

Optionale Parameter sind:

  • forceprint (Boolean): Wenn gesetzt, wird Programmcode in das PDF eingefügt, der den PDF-Reader veranlasst, den Drucken-Dialog zu öffnen.

  • watermark (Boolean): Wenn gesetzt, wird die im Administrator konfigurierte Druckkennzeichnung ins PDF eingebrannt. 

Die Methode konvertiert die Dokumente des Objekts mit der gegeben ID ins PDF-Format.

/osrest/api/documentfiles/pdf

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: application/pdf

Optionale Parameter sind:

  • whitepage (Boolean): Wenn true, wird zwischen jedem Dokument im zusammengeführten Dokument eine leere Seite als Trenner eingefügt.

  • forceprint (Boolean): Wenn true, wird Programmcode in das PDF eingefügt, der den PDF-Reader veranlasst, den Drucken-Dialog zu öffnen.

Die Methode führt die PDF-Version mehrerer Originaldokumente, welche mittels ID im POST-Body übermittelt wurden, in ein PDF-Dokument zusammen und liefert dieses im Anschluss aus. Über den GET-Parameter forceprint kann dem Ziel-PDF-Dokument Programmcode hinzugefügt werden, der den PDF-Reader dazu veranlasst, nach dem Öffnen des PDFs direkt den Drucken-Dialog anzuzeigen. Maximal 200 Dokumente können in ein PDF zusammengeführt werden. Wenn ein oder mehrere Dokumente nicht verarbeitet werden können, so wird kein PDF als Ergebnis zurückgeliefert. Stattdessen ist das Ergebnis ein JSON-Objekt, das die fehlgeschlagenen Objekt-IDs enthält.

{ "pdfname" : "merge.pdf", "ids" : [ 14024030, 14024032, ] }

/osrest/api/documentfiles/[id]/zip

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: application/octet-stream

Optionale Parameter sind:

  • filename (String): Dateiname für die ZIP-Datei und die enthaltene Datei. Der Wert wird statt der Objekt-ID eingesetzt. Der Dateiname wird um für Windows ungültige Zeichen bereinigt und kann somit final vom angegebenen Dateinamen abweichen. Bitte beachten Sie dies und sorgen vorab dafür, dass der Dateiname keine ungültigen Zeichen enthält.

Die Methode fasst die Dokumente des Objekts mit der gegebenen ID in einer ZIP-Datei zusammen.

/osrest/api/documentfiles/zip

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: application/zip

Die Methode packt die Originaldokumente, welche mittels ID im POST-Body übermittelt wurden, in ein ZIP-Archiv und liefert dieses im Anschluss aus. Wahlweise kann für jedes angeführte Dokument neben der ID auch der Name im ZIP-Archiv angegeben werden. Dateinamen werden um für Windows ungültige Zeichen bereinigt und können somit final abweichen. Bitte beachten Sie dies und sorgen vorab dafür, dass die Dateinamen keine ungültigen Zeichen enthalten. Zuzüglich zu den zu packenden Dokumenten muss über den Tag archivename der Dateiname für das zurück zu liefernde ZIP-Archiv angegeben werden. Maximal 200 Dateien kann ein ZIP-Archiv enthalten. Wenn ein oder mehrere Dokumente nicht verarbeitet werden können, so wird kein ZIP als Ergebnis zurückgeliefert. Stattdessen ist das Ergebnis ein JSON-Objekt, das die fehlgeschlagenen Objekt-IDs enthält.

{ "archivename" : "myArchive.zip", "ids" : [ { "id": 14024030, "name": "file one" }, { "id": 14024032, "name": "file two" }] }

/osrest/api/documentfiles/[id]/osfile

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: application/octet-stream

Die Methode erstellt eine enaio®-interne Linkdatei für das Objekt mit der gegebene ID.

/osrest/api/documentfiles/addtotray

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: JSON

Der Request muss den Contenttyp multipart/form-data haben (RFC 1867).

Über diese Methode kann eine Datei in die Benutzerablage hochgeladen werden. Die Datei muss eine Content Disposition 'form-data' und das Attribut filename mit dem Dateinamen enthalten.

content-disposition: form-data; name="imagefile"; filename="image.jpg"

/osrest/api/documentfiles/move/[id]?targetLocation=[id des Ordners oder Registers]&sourceLocation=[id des aktuellen Ordners/Registers]

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: HTTP/204 (No Content)

Die Methode verschiebt das Objekt an den in "targetLocation" angegebenen Ort und ist somit eine Pflichtangabe. Wenn erfolgreich, wird "OK" zurückgesendet, ansonsten eine Exception. Wenn das zu verschiebende Objekt ein Ordner oder Register ist, kann zusätzlich über "recursive" angegeben werden, ob sein Inhalt mit verschoben werden soll.

Optionale Parameter sind:

  • recursive (Boolean): Wenn Objekt ein Ordner oder Register ist, kann darüber angegeben werden, ob sein Inhalt mit verschoben werden soll, wenn der Parameter 'true' ist.

  • sourceLocation (Integer): Gibt den aktuellen Standort (direktes Elternobjekt) des Objekts an. Nur Pflicht, wenn das Dokument mehrere Standorte besitzt.

/osrest/api/documentfiles/move

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: HTTP/204 (No Content)

Die Methode verschiebt ein Objekt von einem Standort zu einem anderen. Wenn das zu verschiebende Objekt ein Register ist, kann zusätzlich über "recursive" angegeben werden, ob sein Inhalt mit verschoben werden soll. Im Gegensatz zum anderen Move-Aufruf, können hier weitere Informationen zu den einzelnen Objekten mitgegeben werden, wodurch der Move-Aufruf beschleunigt wird. Alle Angaben außer der item ID und der target ID sind optional.

Optionale Parameter sind:

  • recursive (Boolean): Wenn Objekt ein Ordner oder Register ist, kann darüber angegeben werden, ob sein Inhalt mit verschoben werden soll, wenn der Parameter 'true' ist.

Beispiel JSON

{ item: { id: "1114", objectTypeId: "34586" }, target: { id: "61", objectTypeId: "485239" }, source: { // die source property wird nur benötigt, wenn sich das zu verschiebende Objekt an mehreren Standorten befindet id: "88" }, archive: { // Die ObjektTypeId vom Schrank-Objekt. Durch diese Angabe wird die Verschiebung beschleunigt. Ist jedoch optional. id: "26" }  }

/osrest/api/documentfiles/droptargets

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Die zurückgegebene Liste enthält die Namen verfügbarer Droptargets mit ihren jeweiligen Variablen. Ist zwischen einer Variable und einem Feld in enaio® eine 1:1-Zuordnung gegeben, wird die für das enaio®-Feld gültige maximale Feldlänge, der Pflichtfeldstatus und mögliche Katalogdaten zurückgegeben. Ist keine eindeutige Zuordnung, z. B. bei mehrfacher Verwendung der Variable, möglich, wird nur der Variablenname zurückgegeben.

{ demo: { regtype: { catalog: [ "Rechnungen", "Altbestand", "Sonstiges", "Support-Infos", "Projekt", "Meilenstein", "Schriftverkehr", "Marketing", ] required: true, size: "15" }, dkreditor: { }, dstatus: { }, fname: { required: true, size: "80" }, gposition": { columns: [ "Artikelnummer" "Bezeichnung", "Einzelpreis", "Menge", "Positionspreis" ] type: "GRID", }   } }

In enaio® appconnector können Droptarget-Scripts für spezifische Benutzer abgelegt werden. Dafür müssen die Skripte unterhalb des Verzeichnisses droptargets in der enaio® appconnector-Konfiguration in ein Verzeichnis namens user/<benutzername> abgelegt werden. Für den Benutzer demo würde die Verzeichnissstruktur z. B. so aussehen:

droptargets/users/demo

/osrest/api/documentfiles/droptargets/[targetname]

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: JSON

Der Request muss den Contenttyp multipart/form-data haben (RFC 1867).

Über die Methode kann eine Datei an ein Droptarget übergeben werden. Der Multipart Request muss aus zwei Teilen bestehen:

  • Variablen Daten: Dieser Teil muss die Content Disposition 'form-data' und das Attribut name mit dem Namen data enthalten.

    content-disposition: form-data; name="data"

  • Datei Upload: Dieser Teil muss die Content Disposition 'form-data' und das Attribut filename mit dem Dateinamen enthalten. Das Attribut name hat hier keine Bedeutung.

    content-disposition: form-data; name="imagefile"; filename="image.jpg"

Um Tabellen (type: GRID) zu befüllen, müssen die einzelnen Zeilen mit Ihren Spaltenübeschriften als Parameter übergeben werden. Leere Spalten können weggelassen werden:

{ fname:"0008-OS", regtype:"Projekt", dkreditor:"indat", gposition:{ row_1:{ Artikelnummer:123, Bezeichnung:"Katze", Einzelpreis:1000 }, row_2:{ Artikelnummer:666, Bezeichnung:"Maus", Einzelpreis:12, Menge:55 } } }

Notation 2.0:

"position":[{"Typ":"Artikel","Nummer":"1"},{..}]

 

Die Methode gibt die enaio®-Objekt-ID des neu angelegten Dokuments zurück, der genaue Rückgabewert hängt jedoch von der Einstellung im Droptarget-Script selbst ab.

/osrest/api/documentfiles/delete

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: JSON

Über die Methode können mehrere Objekte im Archiv gelöscht werden. Bei Erfolg gibt die Methode den String "true" zurück. Der Post-Body der Anfrage besteht aus einer JSON-Array.
Sollte ein Fehler beim Löschen eintreten, gibt die Methode eine Liste mit den Objekte zurück, die nicht gelöscht werden konnten.

Optionale Parameter sind:

  • recursive (Boolean): Wenn Objekt ein Ordner oder Register ist, kann darüber angegeben werden, ob sein Inhalt mit gelöscht werden soll, wenn der Parameter 'true' ist.

{ "ids": [14118033,14117993,14117994, ....] }

/osrest/api/documentfiles/delete/[id]

  • Unterstützte Anfragemethoden: GET, DELETE

  • Unterstützte Ergebnisformate: JSON

Über die Methode kann ein Objekt im Archiv gelöscht werden. Bei Erfolg gibt die Methode den String "true" zurück.

Optionale Parameter sind:

  • recursive (Boolean): Wenn Objekt ein Ordner oder Register ist, kann darüber angegeben werden, ob sein Inhalt mit gelöscht werden soll, wenn der Parameter 'true' ist. Dieser Parameter steht nur für die Anfragemethode DELETE zur Verfügung.

/osrest/api/documentfiles/update/[id]

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: HTTP/204 (No Content)

Der Request muss den Contenttyp multipart/form-data haben (RFC 1867). 

Über die Methode kann die Datei zu einem Dokument geändert werden. Der Multipart Request muss wie folgt aufgebaut sein:

  • Datei Upload: Der Teil muss die Content Disposition 'form-data' und das Attribut filename mit dem Dateinamen enthalten. Das Attribut name hat hier keine Bedeutung.

    content-disposition: form-data; name="imagefile"; filename="image.jpg"

    Optionale Parameter sind:

    • maintype (int): Es kann ein bestimmter Haupttyp (siehe Server-API-Dokumentation) erzwungen werden.

    • page (int): Bei mehrseitigen Dokumenttypen (Bilder) kann hier die übertragene Seite angegeben werden, damit nicht alle Seiten übertragen werden müssen.

/osrest/api/documentfiles/processmetadata/[id][?override=[true|false]&preview=[true|false]]

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Die Methode kann ein Dokument (ID) mit Daten aus dem ExtractionService anreichern. Was gemappt wird, legt das Mapping fest.

Optionale Parameter sind:

  • override (bool): Legt fest, ob auch nicht leere Indexfelder gefüllt werden sollen (optional). Diese Option, kann auch dediziert im Mapping festgelegt werden.

  • preview (bool): Wenn true, wird statt einem Update des Dokuments, das Mapping als "Vorschlag" zurück gesendet, als JSON formatiert.

Hinweis: Bei der Übernahme von Indexdaten werden nur noch Daten bis zur maximale Länge des zugeordneten Datenbankfelds eingetragen. Kürzungen werden als Warnung protokolliert.

/osrest/api/documentfiles/processmetadata/[objectTypeId]

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: JSON

Die Methode kann ein Dokument (ID) mit Daten aus dem ExtractionService anreichern, wobei das Dokument nicht in enaio® existieren muss. Die Datei wird als Multipart-Post-Request gesendet. In der URL wird der Objekttyp angegeben, mit dem das Dokument ablegt wird. Mit dem Mapping des Objekttyps wird ein ExtractionMapping von der Datei als JSON zurückgeliefert.

/osrest/api/documentfiles/checkout/{id}

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: HTTP/204 (No Content)

Pflichtparameter sind:

  • objectTypeId (int): ObjectTypeId des Objekts

Die Methode setzt ein Dokument (ID) für den über enaio® appconnector angemeldeten Benutzer auf den Status 'ausgecheckt'. Im Erfolgsfall wird ein HTTP 204 (No Content) zurückgegeben. Wenn das Dokument bereits von einem anderen Benutzer ausgecheckt wurde, werden dessen Benutzerdaten als JSON zurückgegeben und ein HTTP 409 (Conflict).

/osrest/api/documentfiles/checkout/undo/{id}

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: HTTP/204 (No Content)

Pflichtparameter sind:

  • objectTypeId (int): ObjectTypeId des Objekts

Die Methode setzt ein Dokument (ID), welches vom über enaio® appconnector angemeldeten Benutzer ausgecheckt wurde, auf den Status 'nicht ausgecheckt'. Im Erfolgsfall wird ein HTTP 204 (No Content) zurückgegeben. Wenn das Dokument von einem anderen Benutzer ausgecheckt wurde, so werden dessen Benutzerdaten als JSON zurückgegeben und ein HTTP 409 (Conflict).

/osrest/api/documentfiles/checkedout

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

  • Ab: 8.50.1.90, 9.00.1.90

Die Methode ermittelt alle vom aktuellen Benutzer ausgecheckte Objekte. Das Ergebnis beinhaltet alle vom aktuellen Benutzer konfigurierten Trefferlistenfelder.Ab Version 9.10 werden zusätzlich ausgecheckte inaktive Varianten aufgeführt.

Inhalt: