REST API



Informationen effizient organisieren.
Mit der Dr.DOC Komplettlösung für revisionssichere Archivierung.



  Anfragen Demo anfordern
Mehr über Dr.DOC erfahren




REST API

Der HTTP(S) Response erfolgt als JSON Objekt. System-Eigenschaften wird ein "$" (z.B. $id, $ref, ..) vorangestellt.

Es können Benutzer angemeldet, sowie Metadaten und Dokumente abgerufen/bearbeitet werden.


Anmeldung:

Die REST API für Metadaten ist über folgenden Pfad über HTTP/HTTPS zugänglich: "/user".

Die Parameter werden im POST übergeben.

  • signin: Meldet den User in allen Benutzermanagern (siehe server.conf, [USER]) und zugriffsberechtigten Archiven an.
    • username
    • password
  • signout: Meldet den Benutzer aus alles Archiven ab.
  • status: gint ein JSON-kodiertes Status Objekt des angemeldeten User zurück.


AktionPOST Parameter

Anmelden

Meldet den User in allen Benutzermanagern (siehe server.conf, [USER]) und zugriffsberechtigten Archiven an.

  • action: signin
  • username
  • password

Abmelden

Meldet den Benutzer aus alles Archiven ab.

  • action: signout

Status holen

Gibt ein JSON-kodiertes Status Objekt des angemeldeten User zurück.

  • action: status


Metadaten:

Die REST API für Metadaten ist über folgenden Pfad über HTTP/HTTPS zugänglich: "/model/crud".

Die Request Parameter werden im GET übergeben.

Der Response (JSON) hat folgende Struktur:

  • $ModelType (Dr.DOC Archiv)
  • Result
  • MetaSortTree (nur bei Sortierung)
  • HasArray
  • Count
  • CountTotal
  • HasError
  • Error
    • Message
    • InternalMessage

Als ID wird das eindeutige Systemfeld "Dokumet-Nr." gewählt.

Parameter, die in "[..]" eingefasst sind, sind optional.

AktionGET Parameter
get
  • model: Zu wählendes Archiv
  • action: get
  • id: Dokument-Nr.
  • [lock]: true|false, gibt an, ob der Datensatz zur Bearbeitung gesperrt werden soll.
set
  • model: Zu wählendes Archiv
  • action: get
  • value: zu speichernder Datensatz als JSON-Objekt kodiert.
add
  • model: Zu wählendes Archiv
  • action: get
  • value: zu erstellender Datensatz als JSON-Objekt kodiert.
remove
  • model: Zu wählendes Archiv
  • action: get
  • id: Dokument-Nr. des zu löschenden Datensatzes + Dokuments
searchfields
  • value: Suchbedigung der zu suchenden Datensätze als JSON-Objekt kodiert
  • [selection]: Auswahl-Felder mit ";" separiert
  • [sort]: Sortierungs-Felder mit ";" separiert
  • [duplicate]: Ausgabedubletten-Felder mit ";" separiert
  • [max]: Maximale Anzahl der intern Treffer-Datensätze (nicht der Zurückgegebenen). Für unbegrenzt: -1
  • [start]: Absoluter Startindex in der internen Treffer-Liste
  • [count]: Anzahl der maximal zurückgegebenen Datensätze
  • [recursive]: new, true
textretrieval
  • value: Suchbedingung
  • [selection]: Auswahl-Felder mit ";" separiert
  • [sort]: Sortierungs-Felder mit ";" separiert
  • [duplicate]: Ausgabedubletten-Felder mit ";" separiert
  • [max]: Maximale Anzahl der intern Treffer-Datensätze (nicht der Zurückgegebenen). Für unbegrenzt: -1
  • [start]: Absoluter Startindex in der internen Treffer-Liste
  • [count]: Anzahl der maximal zurückgegebenen Datensätze
  • [recursive]: new, true
unlock
  • model: Zu wählendes Archiv
  • action: unlock
tree
  • model: Zu wählendes Archiv
  • action: tree
wf-set-completed
  • model: Zu wählendes Archiv
  • action: wf-set-completed
thesaurus
  • model: Zu wählendes Archiv
  • action: thesaurus

reo-unlock

Entsperrt alle Datensätze des Archivs. Es müssen sich zuvor alle User abmelden.

  • model: Zu wählendes Archiv
  • action: reo-unlock


Document

Die REST API für Dokumente ist über folgenden Pfad über HTTP/HTTPS zugänglich: "/model/document".

AktionGET Parameter
get
  • model: Zu wählendes Archiv
  • action: get
  • id: ID
  • [id_field]: Feld der ID

set

Erstellt ein Dokument, welches in FILE angegeben ist.
Je nach Versionsverwaltung wird eine neue Version erzeugt.

  • model: Zu wählendes Archiv
  • action: set
  • id: ID
  • [id_field]: Feld der ID

+ Dokument in FILE

create

Erstellt eins oder mehrere Dokumente mit Feldvorbelegung.

  • model: Zu wählendes Archiv
  • action: create
  • [preset]: Feldvorbelegung

+ Dokument(e) in FILE