Skip to navigation

URL-document maken

Maak een kennisbankdocument door de opgegeven webpagina te scrapen.

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.
urlstringRequired
URL naar een documentatiepagina waartoe de agent toegang heeft om met gebruikers te communiceren.
namestringOptional>=1 character
Een aangepaste, leesbare naam voor het document.
parent_folder_idstringOptional
Als dit is ingesteld, wordt het gemaakte document of de gemaakte map in de opgegeven map geplaatst.
enable_auto_syncbooleanOptionalDefaults to false

Of automatisch synchroniseren voor dit URL-document moet worden ingeschakeld.

auto_removebooleanOptionalDefaults to false
Of het document automatisch moet worden verwijderd als de URL niet meer beschikbaar is. Alleen van toepassing wanneer automatisch synchroniseren is ingeschakeld.
minimum_frequency_daysintegerOptional1-180

Minimale frequentie (in dagen) waarmee het document wordt vernieuwd. Het werkelijke interval kan korter zijn, maar nooit langer. Standaard is dit 7, aangescherpt tot de frequentie van de bovenliggende map als die strenger is. Alleen van toepassing wanneer automatische synchronisatie is ingeschakeld.

Response

Geslaagde response
idstring
namestring
folder_pathlist of objectsOptional
De segmenten van het mappad naar deze entiteit, van de hoofdmap naar de bovenliggende map.

Errors

422
Documents Create from URL Request Unprocessable Entity Error