Mercurial > gemma

annotate docs/server-interface.txt @ 2414:4625ae70f076

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Changed selection, to make more sensible values available. LDC and LNWL are synonyms, which are actually used in the gauge reference water levels for AT and HR...
author Sascha Wilde <wilde@intevation.de>
date Thu, 28 Feb 2019 12:45:40 +0100
parents 815f5e2ed974
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
722
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
1 | Route | Methode | Daten | *PUC | JSON | HTTP-Code | Anmerkung |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
2 |----------------------------------+----------+-----------------------------------------------+--------------+----------------------------------------------------+---------------+------------------------------------------------|
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
3 | /api/users | GET | Liste an Usern | | | 200, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
4 | /api/users | POST | user, password, role, email, country, *extent | APUC3, APUC4 | | 201, 400, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
5 | /api/users/{user} | GET | | APUC3, APUC4 | login, password, role, email, country, extent zoom | 201, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
6 | /api/users/{user} | DELETE | | APUC3 | | 204, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
7 | /api/users/{user} | PUT | user, password, role, email, country, *extent | APUC3 | login, password, role, email, country, extent zoom | 200, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
8 | /api/users/passwordreset | POST | user | GPUC3 | user | 200, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
9 | /api/login | GET/POST | user, password -> token im Result-JSON | APUC1 | | 200, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
10 | /api/logout | GET/POST | | APUC2 | | 200, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
11 | /api/renew | GET/POST | | APUC2 | | 200, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
12 | /api/system/log/{service}/{file} | GET | | APUC8 | path, content | 200, 500 | Later: add limiting parameters |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
13 | /api/system/hardware | GET | | APUC8 | | 200, 500 | Optionale Queryparameter: limit, from, from+to |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
14 | /api/system/system | GET | | APUC8 | | 200, 500 | Optionale Queryparameter: limit, from, from+to |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
15 | /api/system/access | GET | | APUC8 | | 200, 500 | Optionale Queryparameter: limit, from, from+to |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
16 | /api/sendtestmail | POST | recipients: userids / an SAdmins, an WWAdmins | APUC9 | | 200, 500 | !Throttle! |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
17 | /api/management | GET | aktuelle Konfiguration | APUC10 | | 200, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
18 | /api/management | PATCH | zu ändernde Parameter | APUC10 | | 200, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
19 | /api/templates | GET | Liste an Templates | APUC6 | | 200, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
20 | /api/templates | POST | Daten für ein neues Template | APUC6 | | 201, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
21 | /api/templates/{id} | GET | Metadaten für das Template | APUC6 | | 200, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
22 | /api/template/{id} | PATCH | zu ändernde Parameter | APUC6 | | 200, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
23 | /api/template/{id} | DELETE | | APUC6 | | 200, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
24 | /api/maps/print | POST | Metadaten für den Druck(?) | GPUC7 | | 200, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
25 | /api/search (?) | POST | Das zu suchende | GPUC10 | | 200, 500 | |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
26 | /api/bottlenecks | GET | | SPUC1 | | 200, 500 | Limit? |
815f5e2ed974 Added simple endpoint to view system logs.
Sascha Wilde <wilde@intevation.de>
parents: 388
diff changeset
27 | /api/fairwaydimension | GET | Flusskilometerangabe, Zeitpunkt(?) | SPUC3 | | 200, 500 | SVG? |