{ "info": { "_postman_id": "3f36793f-3c32-4dc9-af38-7df4ada03cc4", "name": "One folder", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Dokumente abrufen", "request": { "method": "GET", "header": [], "url": { "raw": "127.0.0.1:3000/api/documents?api_key=1234&limit=40&offset=0", "host": [ "127", "0", "0", "1" ], "port": "3000", "path": [ "api", "documents" ], "query": [ { "key": "api_key", "value": "1234", "description": "API-Key - nötig zur Authentifizierung" }, { "key": "search", "value": "test", "description": "Suchbegriff", "disabled": true }, { "key": "limit", "value": "40", "description": "Maximale Anzahl der zurückgegebenen Werte - Standardwert = 40" }, { "key": "offset", "value": "0", "description": "Wieviele Einträge sollen übersprungen werden bei der Rückgabe - Standardwert 0" }, { "key": "space_id", "value": "123", "description": "Zeige nur Dokumente von dem Space mit der angegebenen ID", "disabled": true } ] } }, "response": [] }, { "name": "Spaces abrufen", "request": { "method": "GET", "header": [], "url": { "raw": "127.0.0.1:3000/api/spaces?api_key=1234&limit=40&offset=0", "host": [ "127", "0", "0", "1" ], "port": "3000", "path": [ "api", "spaces" ], "query": [ { "key": "api_key", "value": "1234", "description": "API-Key - nötig zur Authentifizierung" }, { "key": "limit", "value": "40", "description": "Maximale Anzahl der zurückgegebenen Werte - Standardwert = 40" }, { "key": "offset", "value": "0", "description": "Wieviele Einträge sollen übersprungen werden bei der Rückgabe - Standardwert 0" }, { "key": "id", "value": "123", "description": "Zeige nur Space mit der angegeben ID", "disabled": true } ] } }, "response": [] }, { "name": "Benutzer abrufen", "request": { "method": "GET", "header": [], "url": { "raw": "127.0.0.1:3000/api/users?api_key=1234&limit=40&offset=0", "host": [ "127", "0", "0", "1" ], "port": "3000", "path": [ "api", "users" ], "query": [ { "key": "api_key", "value": "1234", "description": "API-Key - nötig zur Authentifizierung" }, { "key": "limit", "value": "40", "description": "Maximale Anzahl der zurückgegebenen Werte - Standardwert = 40" }, { "key": "offset", "value": "0", "description": "Wieviele Einträge sollen übersprungen werden bei der Rückgabe - Standardwert 0" }, { "key": "id", "value": "123", "description": "Zeige nur Benutzer mit der angegeben ID", "disabled": true } ] } }, "response": [] }, { "name": "Dokument herunterladen", "request": { "method": "GET", "header": [], "url": { "raw": "127.0.0.1:3000/api/documents/show?api_key=1234&id=7", "host": [ "127", "0", "0", "1" ], "port": "3000", "path": [ "api", "documents", "show" ], "query": [ { "key": "api_key", "value": "1234", "description": "API-Key - nötig zur Authentifizierung" }, { "key": "id", "value": "7", "description": "Zeige nur Dokument mit der angegeben ID" } ] } }, "response": [] }, { "name": "Space erstellen / aktualisieren", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "api_key", "value": "1234", "description": "API-Key - nötig zur Authentifizierung", "type": "text" }, { "key": "space[id]", "value": "50", "description": "Space mit der angegebenen ID überschreiben / aktualisieren", "type": "text", "disabled": true }, { "key": "space[name]", "value": "test", "description": "Space-Name", "type": "text" }, { "key": "space[parent_id]", "value": "", "description": "ID des übergeordneten Space - nicht nötig", "type": "text", "disabled": true }, { "key": "space[pop_host]", "value": "", "description": "Host des E-Mail-Server / POP3 - falls E-Mails in diesen Space importiert werden sollen", "type": "text", "disabled": true }, { "key": "space[pop_port]", "value": "", "description": "Port des E-Mail-Server / POP3 - falls E-Mails in diesen Space importiert werden sollen", "type": "text", "disabled": true }, { "key": "space[pop_user]", "value": "", "description": "Username des E-Mail-Server / POP3 - falls E-Mails in diesen Space importiert werden sollen", "type": "text", "disabled": true }, { "key": "space[pop_password]", "value": "", "description": "Passwort des E-Mail-Server / POP3 - falls E-Mails in diesen Space importiert werden sollen", "type": "text", "disabled": true }, { "key": "space[pop_ssl]", "value": "", "description": "Benutzt der E-Mail-Server SSL? true oder false / POP3 - falls E-Mails in diesen Space importiert werden sollen", "type": "text", "disabled": true }, { "key": "space[path]", "value": "", "description": "Pfad zum automatischen Import von Dateien / nicht nötig", "type": "text", "disabled": true }, { "key": "space[is_auto]", "value": "", "description": "Space dient zur automatischen Zuweisung? true oder false", "type": "text", "disabled": true }, { "key": "space[auto_regex]", "value": "", "description": "Regex-Code zur automatischen Zuweisung", "type": "text", "disabled": true }, { "key": "space[retention_period_value]", "value": "", "description": "Aufbewahrungsfrist wird mit dem nächsten Feld multipliziert", "type": "text", "disabled": true }, { "key": "space[retention_period_days]", "value": "", "description": "Aufbewahrungsfrist / 1= Tag, 7 = Woche, 30 = Monat, 365 = Jahr", "type": "text", "disabled": true }, { "key": "space[client]", "value": "", "description": "Mandant / nicht nötig", "type": "text", "disabled": true } ] }, "url": { "raw": "127.0.0.1:3000/api/spaces", "host": [ "127", "0", "0", "1" ], "port": "3000", "path": [ "api", "spaces" ] } }, "response": [] }, { "name": "Benutzer erstellen / aktualisieren", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "api_key", "value": "1234", "description": "API-Key - nötig zur Authentifizierung", "type": "text" }, { "key": "user[id]", "value": "6", "description": "Benutzer mit der angegebenen ID überschreiben / aktualisieren", "type": "text" }, { "key": "user[email]", "value": "newmail@test.de", "description": "E-Mail des Benutzers", "type": "text" }, { "key": "user[password]", "value": "12341234", "description": "Passwort des Benutzers", "type": "text" }, { "key": "user[lang]", "value": "de", "description": "Sprache des Benutzers / de = deutsch oder en = englisch", "type": "text" }, { "key": "user[user_level]", "value": "0", "description": "Benutzer-Typ / 0 = Benutzer, 100 = Admin, 101 = Super-Admin", "type": "text" }, { "key": "user[client]", "value": "", "description": "Mandant / nicht nötig", "type": "text", "disabled": true }, { "key": "user[spaces]", "value": "1,2", "description": "IDs der Spaces auf die der Benutzer Zugriff erhalten soll kommagetrennt", "type": "text", "disabled": true } ] }, "url": { "raw": "127.0.0.1:3000/api/users", "host": [ "127", "0", "0", "1" ], "port": "3000", "path": [ "api", "users" ] } }, "response": [] }, { "name": "Dokument erstellen / aktualisieren", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "api_key", "value": "1234", "description": "API-Key - nötig zur Authentifizierung", "type": "text" }, { "key": "document[id]", "value": "19", "description": "Dokument mit der angegebenen ID überschreiben / aktualisieren", "type": "text" }, { "key": "document[file_name]", "value": "test.txt", "description": "Dateiname / Ist nur bei Neuerstellung füllbar", "type": "text" }, { "key": "document[file_content]", "value": "MTIzNAo=", "description": "Inhalt der Datei in Base64 / Ist nur bei Neuerstellung füllbar", "type": "text" }, { "key": "document[space_id]", "value": "1", "description": "ID des Space zu welchen das Dokument zugeordnet wird", "type": "text" }, { "key": "field[2]", "value": "test12", "description": "Inhalt des Felds mit der ID 2 ändern", "type": "text" } ] }, "url": { "raw": "127.0.0.1:3000/api/documents", "host": [ "127", "0", "0", "1" ], "port": "3000", "path": [ "api", "documents" ] } }, "response": [] }, { "name": "Dokument löschen", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "127.0.0.1:3000/api/documents/18?api_key=1234", "host": [ "127", "0", "0", "1" ], "port": "3000", "path": [ "api", "documents", "18" ], "query": [ { "key": "api_key", "value": "1234", "description": "API-Key - nötig zur Authentifizierung" } ] } }, "response": [] }, { "name": "Space löschen", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "127.0.0.1:3000/api/spaces/33?api_key=1234", "host": [ "127", "0", "0", "1" ], "port": "3000", "path": [ "api", "spaces", "33" ], "query": [ { "key": "api_key", "value": "1234", "description": "API-Key - nötig zur Authentifizierung" } ] } }, "response": [] }, { "name": "Benutzer löschen", "request": { "method": "DELETE", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "127.0.0.1:3000/api/users/6?api_key=1234", "host": [ "127", "0", "0", "1" ], "port": "3000", "path": [ "api", "users", "6" ], "query": [ { "key": "api_key", "value": "1234", "description": "API-Key - nötig zur Authentifizierung" } ] } }, "response": [] } ] }