Seitenhierarchie
Zum Ende der Metadaten springen
Zum Anfang der Metadaten



VariableBenötigt zum ErstellenBenötigt zum EditierenBeschreibungTypBeispiel
$ID
(Warnung)Die Id der Service Dokumentationinteger1
$UUID(Warnung)(Warnung)Die UUID des Servicesstring"48c1065d-18d0-47bc-8032-ac5f1f758379t"
$CONTENT(Warnung)(Warnung)Der Inhalt der Service Dokumentationstring"Meine Dokumentation"


1. Erstelle Service Dokumentation

URL: https://123.123.123.123/documentations/view/$UUID/service.json

Methode: POST

Antwort: JSON

JSON zum Erstellen einer Service Dokumentation über die REST API
{
	"Documentation": {
		"content": $CONTENT,
		"uuid": $UUID
	}
}
Antwort bei erfolgreichem API Aufruf
{
	"id": $ID
}


2. Editiere Service Dokumentation

URL: https://123.123.123.123/documentations/view/$UUID/service.json

Methode: POST

Antwort: JSON

JSON zum Editieren einer Service Dokumentation über die REST API
{
	"Documentation": {
		"content": $CONTENT,
		"id": $ID,
		"uuid": $UUID
	}
}
Antwort bei erfolgreichem API Aufruf
{
	"id": $ID
}


3. Erhalte Service Dokumentation

URL: https://123.123.123.123/documentations/view/$UUID/service.json

Methode: GET

Antwort: JSON

Antwort bei erfolgreichem API Aufruf
{
    "post": {
        "Documentation": {
            "id": "$ID",
            "uuid": "$UUID",
            "content": "$CONTENT",
            "created": "2018-10-26 11:44:19",
            "modified": "2018-10-26 11:44:19"
        }
    }
}
  • Keine Stichwörter