blob: 5cd613c754179d27c73dc2455504b206bfe26ead [file] [log] [blame]
[id='interface-concept-{context}']
= Schnittstellenbeschreibung
Die Kommunikation mit dem {ProjectName} erfolgt über REST-Schnittstellen, welche
im http://wiki.openkonsequenz.de/Dom%C3%A4nen-API[OpenKonsequenz-Wiki] veröffentlicht sind.
Von diesem Service angebotene Schnittstellen.
[%header,cols=1*]
|===
|internes Modell abfragen
|Gibt den Inhalt des internen Modells (Repository) mit der angegeben Kennung als RDF-Dokument zurück.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|GET
|Bezeichnung
|/model
|aktuelle Version
|1.0.0
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/service.model_GET_1_de.open-api.yaml[service.model_GET_1_de.open-api.yaml]
|===
[%header,cols=2*]
|===
|Status-Code
|Beschreibung
|200
|Das interne Modell als RDF-Dokument.
|400
|Die Schnittstelle wurde mit ungültigen Parametern aufgerufen.
|404
|Die interne Modell-Kennung ist unbekannt.
|500
|Es trat ein allgemeiner Fehler bei der Verarbeitung der Anfrage auf.
|===
'''
<<<
[%header,cols=1*]
|===
|internes Modell aktualisieren
|$description.rawData.paths[0].get.summary
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|PUT
|Bezeichnung
|/model
|aktuelle Version
|1.0.0
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/service.model_PUT_1_de.open-api.yaml[service.model_PUT_1_de.open-api.yaml]
|===
[%header,cols=2*]
|===
|Status-Code
|Beschreibung
|200
|Die Antwortnachricht.
|400
|Die Schnittstelle wurde mit ungültigen Parametern aufgerufen.
|500
|Es trat ein allgemeiner Fehler bei der Verarbeitung der Anfrage auf.
|===
'''
<<<
[%header,cols=1*]
|===
|Service-Kommando ausführen
|Führt das angegebene Service-Kommando aus.
|===
[%header,cols=2*]
|===
|Beschreibung
|Wert
|http-Methode
|POST
|Bezeichnung
|/execute
|aktuelle Version
|1.0.0
|Sprache (ISO 639-1)
|de
|Spezifikation
|link:resources/api/service.execute_POST_1_de.open-api.yaml[service.execute_POST_1_de.open-api.yaml]
|===
[%header,cols=2*]
|===
|Status-Code
|Beschreibung
|200
|Die Antwortnachricht.
|400
|Die Schnittstelle wurde mit ungültigen Parametern aufgerufen.
|404
|Das angegebene Service-Kommando wird nicht unterstützt.
|500
|Es trat ein allgemeiner Fehler bei der Verarbeitung der Anfrage auf.
|===
'''
<<<