Kompaktübersicht

Basisadresse

https://www-net.scc.kit.edu       "Produktionsumgebung"
https://www-net-test.scc.kit.edu  "Testumgebung"
https://www-net-devel.scc.kit.edu "Entwicklungsumgebung"

[-> Haupt-Dokumentation]

Ebenen im URI-Schema unterhalb der Basisadresse

Das URI-Schema ist hierarchisch (Baumstruktur), 4stufig, und jede Ebene ist über Pfadangaben erreichbar. Jede Ebene außer der untersten (4.) liefert durch Indexabfragen Informationen über die Elemente der nächsten darunterliegenden Ebene. Indexabfragen sind durch einen abschließenden Schrägstrich / (Slash) im URI gekennzeichnet und parameterlos. Die oberste Ebene /api/ (Stamm- oder Wurzelebene) ist konstant; alle darunterliegenden Ebenen sind potentiell als veränderbar zu betrachten.

/api/<majorversion>.<minorversion>/wapi/system/list
/api/<majorversion>.<minorversion>/wapi/object_type/list?system_list=["<system_name>"]
/api/<majorversion>.<minorversion>/wapi/function/list?system_list=["<system_name>"]&object_type_list=["<object_type_name>"]

[-> Haupt-Dokumentation]

Erforderliche Daten für Transaktion vorbereiten

/api/<majorversion>.<minorversion>/wapi/object_type/list?system_list=["<system_name>"]
/api/<majorversion>.<minorversion>/wapi/function/list?system_list=["<system_name>"]&object_type_list=["<object_type_name>"]

GET-Request (Einzelbefehls-Transaktion, nur für nicht-datenmodifizierende Funktionen)

/api/<majorversion>.<minorversion>/<system_name>/<object_type_name>/<function_name>?<query_string>

[-> Haupt-Dokumentation]

POST-Request (Einzelbefehls-Transaktion)

{
  "old": { "<param_name>": "param_value" },
  "new": { "<param_name>": "param_value" }
}
/api/<majorversion>.<minorversion>/<system_name>/<object_type_name>/<function_name>

[-> Haupt-Dokumentation]

POST-Request (generische Transaktion)

[
  {
    "name": "<system_name>.<object_type_name>.<function_name>",
    "old": { "<param_name>": "param_value" },
    "old_ref": { "<param_name>": { "idx": <ref_stmt_idx>, "param": "<ref_param_name>", "allow_no_data": true | false } },
    "new": { "<param_name>": "param_value" },
    "new_ref": { "<param_name>": { "idx": <ref_stmt_idx>, "param": "<ref_param_name>", "allow_no_data": true | false } },
    "join": {"<join_stmt_idx>": "<ref_constraint_name>" | null}
  }
]
/api/<majorversion>.<minorversion>/wapi/transaction/execute
/api/<majorversion>.<minorversion>/wapi/transaction/execute?dry_mode=true | false

[-> Haupt-Dokumentation]