Mehrere Projekte anzeigen
GET /ws/2.0/projects.json
Beispiel
Anfrage: GET /ws/2.0/projects.json?parent=10
Antwort: 200 OK
[{
"id": 12,
"name": "Website Telematicx AG",
"description": "Neuentwicklung Webauftritt ...",
"active": true,
"parent": 10,
...
}, {
"id": 31,
"name": "Marktforschung Nordicx GmbH",
"description": null,
"active": false,
"parent": 10,
...
}]
Anfrage-Parameter zur Filterung und Sortierung
Sie können einen oder mehrere der folgenden Parameter verwenden, um die Ergebnisliste einzuschränken:
Parameter | Datentyp | Standardwert | Beschreibung |
---|---|---|---|
limit |
int | 100 | Beschränkt die Anzahl der zurückgegeben Datensätze. |
offset |
int | 0 |
Gibt die Datensätze ab dem mit offset angegeben Datensatz aus. Die Zählung beginnt bei 0. Die limit-Einschränkung bleibt bestehen. Beispiel: |
orderBy |
string | array | (ohne) |
Gibt die Sortierreihenfolge der Datensätze an. Beispiele:
|
name |
string | (ohne) | Gibt nur Projekte zurück, die den angegebenen Namen haben. Als Platzhalterzeichen ist * zulässig. |
description |
string | (ohne) | Gibt nur Projekte zurück, die die angegebene Beschreibung besitzen. Als Platzhalterzeichen ist * zulässig. |
active |
boolean | (ohne) | Gibt nur Projekte zurück, die entweder aktiv (active = true ) oder abgeschlossen (active = false ) sind. |
parent |
integer | (ohne) | Gibt alle direkten Unterprojekte des mit parent angegeben Projektes zurück. Um die Unterprojekte des Root-Projektes zu erhalten (also die Projekte auf oberster Ebene in der Timicx-Oberfläche), setzen Sie parent auf `null`. |
Wenn kein Parameter angegeben ist, werden alle vorhandenen Projekte ausgegeben. Wenn mehrere Parameter angegeben sind, werden diese UND-verknüpft. Sie können nur die Projekte sehen, für die Sie die entsprechende Berechtigung haben.
HTTP-Statuscodes
Statuscode | Beschreibung |
---|---|
200 OK | Die Anfrage war erfolgreich. |
400 Bad Request | Die Anfrage hat ein ungültiges Format. |