Seitenhierarchie
Zum Ende der Metadaten springen
Zum Anfang der Metadaten


ValueRequired for addingRequired for editingDescriptionTypeExample
$ID
(Warnung)The host documentation IDinteger1
$UUID(Warnung)(Warnung)The uuid of the hoststring"48c1065d-18d0-47bc-8032-ac5f1f758379t"
$CONTENT(Warnung)(Warnung)The content of the documentationstring"my documentation"


1. Add host documentation

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

Method: POST

Response: JSON

JSON to add a host documentation via REST API
{
	"Documentation": {
		"content": $CONTENT,
		"uuid": $UUID
	}
}
Response on successful API call
{
	"id": $ID
}


2. Edit host documentation

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

Method: POST

Response: JSON

JSON to edit a host documentation via REST API
{
	"Documentation": {
		"content": $CONTENT,
		"id": $ID,
		"uuid": $UUID
	}
}
Response on successful API call
{
	"id": $ID
}


3. Get host documentation

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

Method: GET

Response: JSON

Response on successful API call
{
    "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