Utwórz dokument URL

Utwórz dokument bazy wiedzy wygenerowany przez pobranie danych z podanej strony internetowej.

Nagłówki

xi-api-keystringOpcjonalny

Żądanie

This endpoint expects an object.
urlstringWymagany

URL strony dokumentacji, do której agent będzie mieć dostęp, aby kontaktować się z użytkownikami.

namestring or nullOpcjonalny>=1 character

Niestandardowa, czytelna dla człowieka nazwa dokumentu.

parent_folder_idstring or nullOpcjonalny

Jeśli ustawione, utworzony dokument lub folder zostanie umieszczony w podanym folderze.

enable_auto_syncbooleanOpcjonalnyDomyślnie false

Czy włączyć automatyczną synchronizację dla tego dokumentu URL.

auto_removebooleanOpcjonalnyDomyślnie false

Czy automatycznie usuwać dokument, jeśli URL stanie się niedostępny. Dotyczy tylko włączonej automatycznej synchronizacji.

minimum_frequency_daysinteger or nullOpcjonalny1-180

Minimalna częstotliwość odświeżania dokumentu (w dniach). Rzeczywisty odstęp może być krótszy, ale nigdy dłuższy. Domyślnie 7; jest dostosowywana do częstotliwości folderu nadrzędnego, jeśli jest bardziej restrykcyjna. Dotyczy tylko włączonej automatycznej synchronizacji.

Odpowiedź

Pomyślna odpowiedź

idstring
namestring
folder_pathlist of objectsOpcjonalny

Segmenty ścieżki folderów prowadzące do tego elementu, od katalogu głównego do folderu nadrzędnego.

Błędy

422
Unprocessable Entity Error