Créer une tâche d’exploration

Crée une tâche d’exploration pour explorer l’URL fournie selon la profondeur et les limites de pages spécifiées.

En-têtes

xi-api-keystringOptionnel

Requête

This endpoint expects an object.
urlstringRequis

URL d’une page de documentation à laquelle l’agent aura accès afin d’interagir avec les utilisateurs.

max_pagesintegerOptionnel1-10000Par défaut 1000

Nombre maximal de pages à explorer (1 à 10 000), 1 000 par défaut.

patternstring or nullOptionnel<=2048 characters

Si défini, seules les URL correspondant à ce modèle sont incluses.

sitemap_urlslist of strings or nullOptionnel

Liste des URL à explorer depuis le plan du site, facultative et prioritaire sur la découverte automatique des URL.

parent_folder_idstring or nullOptionnel

Si défini, le document ou dossier créé sera placé dans le dossier indiqué.

enable_auto_syncbooleanOptionnelPar défaut false
Indique s'il faut activer la synchronisation automatique pour ce document URL.
auto_removebooleanOptionnelPar défaut false

Indique s’il faut supprimer automatiquement le document si l’URL devient indisponible. S’applique uniquement lorsque la synchronisation automatique est activée.

auto_discoverbooleanOptionnelPar défaut false

Découvre et ajoute automatiquement les nouvelles pages liées aux pages déjà explorées lors de la synchronisation automatique. Nécessite enable_auto_sync=true.

minimum_frequency_daysinteger or nullOptionnel1-180

Fréquence minimale, en jours, à laquelle les documents sous-jacents éligibles sont actualisés. L’intervalle réel peut être plus court, mais jamais plus long. La valeur par défaut est 7, réduite à la fréquence du dossier parent si celle-ci est plus stricte. S’applique uniquement lorsque la synchronisation automatique est activée.

max_depthintegerOptionnelPar défaut 3Deprecated

Obsolète : ce champ n’a aucun effet et sera supprimé dans une prochaine version.

Réponse

Réponse réussie

idstring
typeenumPar défaut discovery
Valeurs autorisées:
root_folder_idstring
statusstring
created_atinteger
folder_pathlist of objectsOptionnel
Les segments du chemin du dossier menant au dossier racine, de la racine au dossier parent.

Erreurs

422
Unprocessable Entity Error