REST-Routen-Übersicht

Diese Seite bietet eine Liste aller REST-Routen mit einer kurzen Beschreibung und Links zu Seiten mit weiteren Details.
Bevor Sie sich mit den einzelnen Routen befassen, empfiehlt es sich, den Abschnitt Arbeiten mit dem Server zu lesen.

---

Info

Zur schnellen Navigation können Sie eine der beiden folgenden Registerkarten verwenden:

• Routen nach Datenobjekten – um einen Überblick zu erhalten, welche Routen für welche Operationen geeignet sind
• Routen nach Methoden – um einen schnellen Überblick über Routen nach HTTP-Methoden und die jeweiligen Server-Antworten zu erhalten

Routen nach Datenobjekten

tasks

Verwenden Sie die folgenden Routen, um Operationen auf Aufgaben durchzuführen:

HTTP-Methode	Route	Beschreibung
GET	/tasks	Ruft Daten zu allen Aufgaben ab und gibt ein JSON-Objekt mit einem Array von Aufgaben-Objekten zurück
GET	/tasks/projects	Ruft Daten zu allen Aufgaben des angegebenen Projekts ab und gibt ein JSON-Objekt mit einem Array aller Aufgaben-Objekte für dieses Projekt zurück
POST	/tasks	Erstellt eine neue Aufgabe und gibt ein Aufgaben-Objekt mit der ID der neuen Aufgabe zurück
POST	/clone	Erstellt eine Kopie einer Aufgabe und gibt ein JSON-Objekt mit der Client-Aufgaben-ID und der duplizierten Aufgaben-ID des Servers zurück
PUT	/tasks	Aktualisiert Daten der angegebenen Aufgabe(n) und gibt ein leeres JSON-Objekt zurück
PUT	/move	Verschiebt eine Aufgabe an die angegebene Position und gibt ein leeres JSON-Objekt zurück
PUT	/sort	Sortiert alle Aufgaben eines aktiven Projekts nach den angegebenen Parametern und gibt ein leeres JSON-Objekt zurück
DELETE	/tasks	Löscht Daten einer Aufgabe und gibt ein leeres JSON-Objekt zurück

projects

Verwenden Sie die folgenden Routen, um Operationen auf Projekten durchzuführen:

HTTP-Methode	Route	Beschreibung
GET	/projects	Ruft Daten zu allen Projekten ab und gibt ein JSON-Objekt mit einem Array von Projekt-Objekten zurück
POST	/projects	Erstellt ein neues Projekt und gibt ein Projekt-Objekt mit der Projekt-ID zurück
PUT	/projects	Aktualisiert Daten eines Projekts und gibt ein leeres JSON-Objekt zurück
DELETE	/projects	Löscht Daten eines Projekts und gibt ein leeres JSON-Objekt zurück

users

Verwenden Sie die folgenden Routen, um Operationen auf Benutzern durchzuführen:

HTTP-Methode	Route	Beschreibung
GET	/users	Ruft Daten zu allen Benutzern ab und gibt ein JSON-Objekt mit einem Array von Benutzer-Objekten zurück

tags

Verwenden Sie die folgenden Routen, um Operationen auf Tags durchzuführen:

HTTP-Methode	Route	Beschreibung
GET	/tags	Ruft Daten zu allen Tags ab und gibt ein JSON-Objekt mit einem Array dieser Tags zurück

Routen nach Methoden

GET

Name	Beschreibung
GET /users	Gibt ein JSON-Objekt mit einem Array aller Benutzer-Objekte zurück
GET /tasks	Gibt ein JSON-Objekt mit einem Array aller Aufgaben-Objekte zurück
GET /projects	Gibt ein JSON-Objekt mit einem Array aller verfügbaren Projekt-Objekte zurück
GET /tags	Gibt ein JSON-Objekt mit einem Array aller Standard-Tags zurück
GET /tasks/projects	Gibt ein JSON-Objekt mit einem Array aller Aufgaben-Objekte für das angegebene Projekt zurück

POST

Name	Beschreibung
POST /clone	Gibt ein JSON-Objekt mit der Client-Aufgaben-ID und der duplizierten Aufgaben-ID des Servers zurück.
POST /projects	Gibt ein neues Projekt-Objekt mit der Projekt-ID zurück
POST /tasks	Gibt ein neues Aufgaben-Objekt mit der ID der neuen Aufgabe zurück

PUT

Name	Beschreibung
PUT /move	Gibt ein leeres JSON-Objekt zurück, wenn die Aufgaben erfolgreich wie gewünscht verschoben wurden
PUT /sort	Gibt ein leeres JSON-Objekt zurück, wenn die Aufgaben wie gewünscht sortiert wurden
PUT /tasks	Gibt ein leeres JSON-Objekt zurück, wenn eine Aufgabe wie gewünscht geändert wurde
PUT /projects	Gibt ein leeres JSON-Objekt zurück, wenn ein Projekt wie gewünscht geändert wurde

DELETE

Name	Beschreibung
DELETE /tasks	Gibt ein leeres JSON-Objekt zurück, wenn eine Aufgabe erfolgreich entfernt wurde
DELETE /projects	Gibt ein leeres JSON-Objekt zurück, wenn ein Projekt erfolgreich entfernt wurde