CIB doXiview - Beschreibung der Start Parameter

Repository Aliasse

HTTP Repository

Das HTTP Repository erlaubt es dem Benutzer, ein Dokument per HTTP zu laden, indem die URL dieses Dokuments angegeben wird. Dieses Dokumentenrepository ist ein Spezialfall, denn der Benutzer muss hier den Parameter repo_alias nicht angeben. Aus sicherheitsgründen sind nur URLs erlaubt, die mit „http://“ oder „https://“ beginnen.

Parameter

Erlaubte Werte

repo_alias

http-repository

urlField

die URL des Dokuments, welches geöffnet werden soll.

httpBundle

alternative zu „urlField“ zum Öffnen mehrerer Dokumente.

 

Der Parameter „httpBundle“ erwartet eine JSON Struktur, welche die Parameter aller zu öffnenden Dokumente beinhaltet:

{
   "bundleName": "test-bundle",
   "httpParameters": "Authorization=Baerer abc",
   "documents": [{
        "cacheId": "example_v1",
        "url": "http://...",
        "name": "example document",
        "mimeType": "application/pdf"  }, ...]
}

 

Property

Beschreibung

bundleName

Der Name des Bündels. Optional falls nur ein Dokument geöffnet wird.

httpParameters

Eine Liste von http-header Feldern, die beim Request eines Dokuments mitgegeben werden sollen. Beispielsweise für die Authentifizierung.

documents

Ein JSON-Array, welches mindestens ein JSON-Objekt enthält, welches ein Dokument repräsentiert.

Property

Beschreibung

cacheId

Die ID unter welcher das Dokument im cache abgelegt werden soll oder zu finden ist.

url

Die URL zum download des Dokuments.

name

Der Name des Dokuments wie er in doXiview angezeigt werden soll.

mimeType

Der Mime-Type des Dokuments.