Alle Wartungsseiten einer Domain auflisten¶

Senden einer GET-Anfrage an den Endpunkt /domain/{domainId}/maintenances.

Beschreibung¶

Mit der List-Maintenances-By-Domain-Anfrage rufen Sie eine Liste aller Wartungsseiten ab, die für alle Subdomains einer Domain der Organisation konfiguriert sind.

Voraussetzungen¶

Werte der Anfrage: Domain-ID {domainId}

Objekte: keine

Anfrage¶

Um eine Liste aller Wartungsseiten einer Domain abzurufen, fügen Sie die Domain-ID {domainId} dem Pfad der Anfrage hinzu. Die Anfrage unterstützt die folgenden optionalen Query-Parameter:

Attribut	Beschreibung	Werte
`search`	Filtert die Ergebnisliste nach einem Suchbegriff.	`string`
`page`	Die Seitenzahl der Ergebnisliste, die zurückgegeben werden soll.	`integer`
`pageSize`	Die Anzahl der Einträge pro Seite.	`integer`
`language`	Die Sprache der Antwort.	`string`
`presentAndFuture`	Filtert das Ergebnis auf Wartungsseiten, die aktuell aktiv oder für die Zukunft geplant sind.	`true` `false`

Als Ergebnis erhalten Sie ein oder mehrere Objekte MaintenanceVO mit den angefragten Informationen.

Das Objekt liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
`fqdn`	Der Name der Subdomain, der die Wartungsseite zugeordnet ist.	`string`
`start`	Das Datum im ISO-8601-Format, ab dem die Wartungsseite aktiviert wird.	`string($date-time)`
`end`	Das Datum im ISO-8601-Format, bis zu dem die Wartungsseite aktiviert ist.	`string($date-time)`
`content`	Der Inhalt der Wartungsseite als HTML.	`string`
`contentFrom`	Die Quelle des Inhalts der Wartungsseite.	`string`
`active`	Die Verfügbarkeit der Wartungsseite.	`true` `false`
`defaultPage`	Ein Array der ausgewählten Standardseiten, die anstelle einer eigenen Inhaltsseite verwendet werden.	`array`
`vhostId`	Die ID der Subdomain, der die Wartungsseite zugeordnet ist.	`integer`
`permissions`	Die Berechtigungen der anfragenden Nutzenden für diese Wartungsseite, zum Beispiel, ob das Bearbeiten erlaubt ist.	`array`
`id`	Die ID der Wartungsseite.	`integer`
`modified`	Das Datum der letzten Änderung im ISO-8601-Format.	`string($date-time)`
`created`	Das Erstellungsdatum im ISO-8601-Format.	`string($date-time)`
`comment`	Der für die Wartungsseite gespeicherte Kommentar.	`string`

Beispiel¶

Beispiel-Antwort:

[
  {
    "search": "string",
    "page": 0,
    "pageSize": 0,
    "language": "string",
    "presentAndFuture": true
  }
]

Antworten¶

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
200	Die Anfrage war erfolgreich.
401	Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war.
403	Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen.
404	Die Anfrage war nicht erfolgreich, da die angeforderte Ressource nicht gefunden wurde.