Domänen-API: Unterschied zwischen den Versionen
FKorb (Diskussion | Beiträge) (→basePath: /domain/dynamic-topology) |
FKorb (Diskussion | Beiträge) (→basePath: /domain/dynamic-topology) |
||
| Zeile 21: | Zeile 21: | ||
|Topologie | |Topologie | ||
|{{REST-GET|cim-version = 17v07|name = topology|language = de|protocol = http|host = api.openk.de|base-path = domain/dynamic-topology|revision = 2}} | |{{REST-GET|cim-version = 17v07|name = topology|language = de|protocol = http|host = api.openk.de|base-path = domain/dynamic-topology|revision = 2}} | ||
| − | | | + | |{| class="wikitable sortable" |
| + | |-class="hintergrundfarbe6" | ||
| + | !Parameter | ||
| + | !Type | ||
| + | |} | ||
|- | |- | ||
|[[topologische Elemente]] | |[[topologische Elemente]] | ||
Version vom 24. Oktober 2017, 18:58 Uhr
Die Domänen-API (Domain API) bildet die Gesamtheit aller angebotenen Schnittstellen der fachlichen Domänen-Module. Da der Einsatz der Domänen-Module pro Netzbetreiber individuell sein kann, können die jeweils unterstützten Anwendungsfälle und Schnittstellen-Methoden varieren (z. B.: Wer Anlagestammdaten abfragen möchte, muss das Domänen-Modul AnlageDatenManagement (ADM) betreiben.)
Grundsätzlich bieten Domänen-Module fachlich wiederverwendbare Funktionen an. Im Gegensatz zur Quellsystem-API ermöglichen die Schnittellen der Domänen-Module komfortable, fachliche Abfragen sowie umfassende Selektions- und Filtermöglichkeiten.
Es ist grundsätzlich denkbar, dass auf Ebene der Domänen-Module Software eingesetzt wird, die nicht im Standard-oK-Portfolie enthalten ist. An dieser Stelle wird daher ausschließlich die Domänen-API (Domain API) definiert, die als gemeinsamer oK-Standard Verwendung findet. Im Folgenden werden die Schnittstellen-Methoden vorgestellt, die durch die Domänen-Module des oK-CIM-Caches (1. Ausbaustufe) (TopologieDatenManagement (TDM), MessDatenManagement (MDM)) implementiert werden:
Inhaltsverzeichnis
basePath: /domain/dynamic-topology
| Bezeichnung | Typ | Beschreibung | Ertüchtigung Stufe 1 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Topologie | Topologie |
|
class="wikitable sortable" | ||||||||||||
| Parameter | Type |
|- |topologische Elemente |Eigenschaften
|| http-Methode: | GET |
| Bezeichnung: | elements |
| aktuelle Version: | 1 |
| Sprache (ISO 639-1): | de |
| Quelltext: | api.openk.de |
| Spezifikation: | Swagger UI |
| |- |topologische Elementtypen |Eigenschaften
|| http-Methode: | GET |
| Bezeichnung: | element-types |
| aktuelle Version: | 1 |
| Sprache (ISO 639-1): | de |
| Quelltext: | api.openk.de |
| Spezifikation: | Swagger UI |
| |}
