2.2.2.1. Download-Handler

Zusätzlich zu den Aufrufen im JSON-RPC Format unterstützt die RPC Schnittstelle Download-Endpunkte zum Herunterladen von Inhalten. Diese Download-Endpunkte werden per GET Request aufgerufen und erhalten ihre Parameter in Form von Query-Parametern. Die Authentifizierung findet wie bei den JSON-RPC Aufrufen über den "Authorization" HTTP Header statt (Basic Auth).
Ein Download-Aufruf ist dementsprechend wie folgt aufgebaut:
URL:
1
https://<Hostname/IP>:<Port>/json/<Endpunkt><ID>?<Parameter>
Hierbei werden der Endpunkt und die ID direkt hintereinander geschrieben, ohne Trennzeichen.
Beispiel: Den Anhang mit der ID 123 herunterladen:
URL:
1
https://meinserver:443/json/ItemsAttachment123
Beispiel: Das Element mit der ID 234 als PDF Dokument im DIN A4 Format herunterladen:
URL:
1
https://meinserver:443/json/ItemsRender234?format=pdf&pagewidth=21000&pageheight=29700&dpix=150&dpiy=150

Perma LinkEndpunkte

Folgende Endpunkte werden unterstützt:

Perma LinkCheckingCsv

Lädt eine Eingangsprüfung als CSV herunter. Die ID ist die ID der Eingangsprüfung.

Perma LinkCheckingDif

Lädt eine Eingangsprüfung als Dif herunter. Die ID ist die ID der Eingangsprüfung.

Perma LinkDataExchange

Lädt einen Export herunter. Die ID ist die ID des Exports.

Perma LinkItemsAttachment

Lädt einen Anhang herunter. Die ID ist die ID des Anhangs (nicht des Elements).

Perma LinkItemsCurrentEml

Lädt ein Element als .eml Datei herunter. Die ID ist die ID des Elements.
Parameter:

  • format: "tiff", "pdf"

  • color: "blackwhite", "truecolor"

  • datefield: "created", "startdate", "enddate"

Perma LinkItemsExportEml

Exportiert ein Element als .eml Datei.
Parameter:

  • format: "tiff", "pdf"

  • color: "blackwhite", "truecolor"

  • metadata: "true", "false"

Perma LinkItemsICal

Lädt einen Termin oder eine Aufgabe als .ics Datei (im ICal Format) herunter. Die ID ist die ID des Elements.

Perma LinkItemsOriginalEml

Lädt die Original .eml Datei eines Elements herunter (falls diese noch vorhanden ist). Die ID ist die ID des Elements.

Perma LinkItemsRender

Lädt ein Element als Dokument herunter. Die ID ist die ID des Elements.
Parameter:

  • format: "tiff", "pdf", "pdfzugferd", "pdfdatevxmlincoming", "pdfdatevxmloutgoing", "csv"

  • color: "blackwhite", "truecolor"

  • pagewidth: Seitenbreite in 1/100 Millimeter (z.B. 21000 für DIN A4)

  • pageheight: Seitenhöhe in 1/100 Millimeter (z.B. 29700 für DIN A4)

  • dpix: horizontale Auflösung in DPI (z.B. 150)

  • dpiy: vertikale Auflösung in DPI (z.B. 150)

  • margintop: oberer Rand

  • marginright: rechter Rand

  • marginbottom: unterer Rand

  • marginleft: linker Rand

  • extrainfos: Zusatzinformationen im Dokument aufführen, Bitmaske aus: ireiFields, ireiComLinks, ireiHeader, ireiAttachments, ireiClassified, ireiUserFields, ireiRemarks, ireiProtocol.

  • fields1: Zusatzfelder, Bitmaske aus: irfID, irfGroupRef, irfGroupName, irfGroupPath, irfUserRef, irfUserName, irfTopicRef, irfTopicName, irfTopicPath, irfColorRef, irfColor, irfState, irfKind, irfPriority, irfFlags, irfFrom, irfRecipients, irfSubject, irfNumber, irfSize, irfStartDate, irfEndDate, irfRemind, irfNextWorkflow, irfCreated, irfModified, irfLocation, irfShowAs, irfSalutation, irfTitle, irfFirstname.

  • fields2: Zusatzfelder, Bitmaske aus: irfSecondname, irfLastname, irfCallname, irfCompany, irfBirthday, irfUrl, irfSex, irfCC, irfBCC, irfReplyTo, irfProgress, irfPercent, irfDone, irfEmail, irfTelefax, irfPostalAddress, irfPhone, irfMobile, irfLastRemark.

  • userfields: benutzerdefinierte Felder

Perma LinkItemsThumbnail

Lädt ein Thumbnail eines Elements als JPEG Bild herunter. Die ID ist die ID des Elements.
Parameter:

  • size: Größe in Pixeln

Perma LinkItemsVCard

Lädt einen Kontakt als .vcf Datei (im VCard Format) herunter. Die ID ist die ID des Elements.
Themen dieser Ebene
2.2.2.1. Download-Handler
2.2.2.2. Upload-Handler