Crawl-Job erstellen

Erstellen Sie einen Crawl-Job, um die angegebene URL mit festgelegter Tiefe und Seitenlimits zu crawlen.

Header

xi-api-keystringOptional

Anfrage

This endpoint expects an object.
urlstringErforderlich

URL zu einer Dokumentationsseite, auf die der Agent für die Interaktion mit Nutzern zugreifen kann.

max_pagesintegerOptional1-10000Standardwert ist 1000

Maximale Anzahl zu crawlender Seiten (1–10.000), Standardwert ist 1000.

patternstring or nullOptional<=2048 characters
Wenn gesetzt, werden nur URLs einbezogen, die diesem Muster entsprechen.
sitemap_urlslist of strings or nullOptional

Liste der aus der Sitemap zu crawlenden URLs (optional, überschreibt die automatische URL-Erkennung).

parent_folder_idstring or nullOptional
Falls gesetzt, wird das erstellte Dokument oder der erstellte Ordner im angegebenen Ordner abgelegt.
enable_auto_syncbooleanOptionalStandardwert ist false

Ob die automatische Synchronisierung für dieses URL-Dokument aktiviert werden soll.

auto_removebooleanOptionalStandardwert ist false

Ob das Dokument automatisch entfernt werden soll, wenn die URL nicht mehr verfügbar ist. Nur anwendbar, wenn die automatische Synchronisierung aktiviert ist.

auto_discoverbooleanOptionalStandardwert ist false

Während der automatischen Synchronisierung neue Seiten, die von bereits gecrawlten Seiten verlinkt sind, automatisch erkennen und hinzufügen. Erfordert enable_auto_sync=true.

minimum_frequency_daysinteger or nullOptional1-180

Minimale Häufigkeit (in Tagen), mit der die zugrunde liegenden berechtigten Dokumente aktualisiert werden. Das tatsächliche Intervall kann kürzer, aber nie länger sein. Standardwert ist 7 und wird an die Häufigkeit des übergeordneten Ordners angepasst, falls diese strenger ist. Gilt nur bei aktiviertem Auto-Sync.

max_depthintegerOptionalStandardwert ist 3Deprecated

Veraltet – dieses Feld hat keine Wirkung und wird in einer künftigen Version entfernt.

Antwort

Erfolgreiche Antwort
idstring
typeenumStandardwert ist discovery
Erlaubte Werte:
root_folder_idstring
statusstring
created_atinteger
folder_pathlist of objectsOptional

Die Ordnerpfadsegmente zum Stammordner, vom Stammordner bis zum übergeordneten Ordner.

Fehler

422
Unprocessable Entity Error