Einführung

In diesem Dokument werden einfache API Abfragen erstellt. Für mehr Details sollte man die dazugehörige Dokumentation anschauen. ProMos DMS JSON Data Exchange

Aufbau REST API

Beim Aufbau einer REST API Abfrage, benötigt es einen URL, einen Payload (Body) und einen Custom Header.

URL

Der URL setzt sich aus dem Protocol, Host, Port und Endpoint zusammen.

Protocol: Standard ‘HTTP’ beim Port 9020

Host: IP-Adresse von ProMos NT

Port: Port, welcher bei den Verbindungseinstellungen im DMS gewählt wurde.

Payload (Body)

Das sind die einzelnen Befehle, welche man ausführen möchte. Alle Befehle und die darauf erhaltene Antworten sind im JSON-Format. Diese werden im Kapitel Befehle genauer beschrieben.

Custom Header

Wird angegeben, um bei der Anfrage nach den korrekten Medientypen zu suchen. In diesem Dokument wird nur einer verwendet:

Header Name	Header Value
Content-Type	application/json

Befehle

Set

Mit Set können neue Datenelemente erstellt werden oder Werte ändern. 

Jeder Set-Befehl hat die Namenswerte Whois, User und Set. Im Set befindet sich dann ein Object Array 

Set hat folgende Inhalte:

Feld	Beschreibung	Typ	Optional
path	Pfad vom Datenelement (DMS-Name)	string	nein
value	Wert vom Datenelement	number, string, boolean, null	nein
type	Typ vom Datenelement	string	ja
create	Auf true setzen wenn ein neues Datenelement erstellt werden soll	boolean	ja
createDefault	Ein nicht vorhandenes Datenelement erstellen. Vorhandene Datenelemente werden nicht überschrieben.	boolean	ja

Beispiel:

{
    "whois": "test_client",
    "user": "",
    "set": [
        {
            "path": "Test:NewValue",
            "value": "Hello World",
            "create": true
        },
        {
            "path": "Test:AnotherValue",
            "value": "Hello there",
            "create": true
        },
    ]
}

Get

Mit Get können Werte von Datenelemente ausgelesen werden.

Jeder Get-Befehl hat die Namenswerte Tag und Get. Im Get befindet sich dann ein Object Array

Get hat folgende Inhalte:

Feld	Beschreibung	Typ	Optional
path	Pfad vom Datenelement (DMS-Name)	string	nein
query	Ein Query-Objekt (Inhalt ist unterhalb)	object	ja
tag	Alle Daten, die in der Rückmeldung wiedergegeben werden sollen.	any	ja

Query hat folgende Inhalte:

Feld	Beschreibung	Typ	Optional
regExPath	Regulärer Ausdruck (RegEx) vom Pfad. Standard ist leer.	string	ja
regExValue	Regulärer Ausdruck (RegEx) vom Wert. Standard ist leer.	string	ja
regExStamp	Regulärer Ausdruck (RegEx) vom Zeitstempel. Standard ist leer.	string	ja
maxDepth	Maximale Tiefe für rekursive Suchpfade. Standard ist 1 (aktueller Pfad). 0 bedeutet keine Einschränkungen, alle Unterpfade werden durchsucht.	number	ja

Beispiel:

{
    "tag": "",
    "get": [
        {
            "path": "",
            "query": {
                "regExPath": "Test.*",
                "maxDepth": "0"
            }
        }
    ]
}

Rename

Mit Rename können Datenelemente umbenannt werden.

Jeder Rename-Befehl hat die Namenswerte Whois, User und Rename. Im Rename befindet sich dann ein Object Array 

Rename hat folgende Inhalte:

Feld	Beschreibung	Typ	Optional
path	Pfad vom Datenelement (DMS-Name)	string	nein
newPath	Neuer Pfad vom Datenelement (DMS-Name)	string	nein

Beispiel:

{
    "whois": "test_client",
    "user": "",
    "rename": [
        {
            "path": "Test:NewValue",
            "newPath": "Test:NewName"
        }
    ]
}

Copy

Mit Copy können Datenelemente kopiert werden.

Jeder Copy-Befehl hat die Namenswerte Whois und Copy. Im Copy befindet sich dann ein Object Array 

Copy hat folgende Inhalte:

Feld	Beschreibung	Typ	Optional
path	Pfad vom Datenelement (DMS-Name)	string	nein
destPath	Neuer Pfad vom Datenelement (DMS-Name)	string	nein

Beispiel:

{
    "whois": "test_client",
    "user": "",
    "copy": [
        {
            "path": "Test:NewName",
            "destPath": "Test:CopyName"
        }
    ]
}

Delete

Mit Delete können Datenelemente gelöscht werden.

Jeder Delete-Befehl hat die Namenswerte Whois und Delete. Im Delete befindet sich dann ein Object Array 

Delete hat folgenden Inhalt:

Feld	Beschreibung	Typ	Optional
path	Pfad vom Datenelement (DMS-Name)	string	nein

Beispiel:

{
    "whois": "test_client",
    "user": "",
    "delete": [
        {
            "path": "Test:CopyName"
        }
    ]
}