API REST du format de liste de départ 1.0

L'API HCL Web Content Manager pour la récupération de contenu d'application via un liste d'origine est basée sur le style d'architecture REST. Pour obtenir le contenu de la liste de départ, des applications d'administration ou des moteurs de balayage tiers doivent construire et envoyer des demandes HTTP au servlet d'application.

Toutes les requêtes de l'API REST se traduisent par un appel synchrone. L'ordre d'apparition des paramètres dans la requête n'a pas d'importance. Les noms des paramètres distinguent les majuscules des minuscules et doivent être saisis dans le format décrit ci-après. Un message d'erreur HTTP (par exemple, le code d'état 404) est généré dans les cas suivants :
  • La requête soumise contient un paramètre inconnu ou non pris en charge.
  • Web Content Manager ne peut pas résoudre l'ID ou le chemin d'accès de la zone de site.
  • Web Content Manager ne trouve aucun objet.
  • L'application d'entreprise de liste de départ de recherche (Seedlist_Servlet) n'est pas démarrée.

La requête est une commande HTTP GET standard. L'adresse URL est la combinaison du nom d'hôte, du numéro de port et du chemin du servlet de liste de départ, suivie d'une série de paramètres d'entrée séparés par une perluète (&). Les paramètres d'entrée sont saisis sous forme de paires nom-valeur.

Par exemple:
http://host_name:port_number/wps/seedlist/myserver?SeedlistId=library_list&Source=com.ibm.workplace.wcm.plugins.seedlist.retriever.WCMRetrieverFactory&Action=action&Range=number_of_entries
library_list
Une ou plusieurs bibliothèques de contenu Web séparées par des virgules. Si aucune valeur n'est spécifiée, toutes les bibliothèques sont utilisées.
action
Action à exécuter sur la demande. Les actions suivantes sont disponibles :
GetDocuments
Extrait la liste des objets de contenu et les informations associées.
number_of_entries
Pour chaque page de liste de départ renvoyée, cette valeur spécifie le nombre d'entrées dans la liste des objets de contenu. Si aucune valeur n'est spécifiée, 100 objets sont renvoyés.

Exemples

Dans ces exemples, remplacez les variables suivantes par les valeurs appropriées à votre environnement :
  • host_name
  • virtual_portal_host_name
  • http_server
  • port_number
  • library
  • site_area
  • site_area_id
Pour le paramètre SeedlistId, vous pouvez spécifier la valeur aux formats suivants :
  • Aucune valeur
  • une bibliothèque spécifique (par exemple, library1)
  • une zone de site spécifique (par exemple, site_area1)
  • Une liste de bibliothèques séparées par une virgule (par exemple, library1,library2,library3).
  • ID JCR d'une zone de site
Extraction de 100 objets au maximum à partir d'un serveur autonome à l'aide du chemin d'accès à la zone de site
http://host_name:port_number/wps/seedlist/myserver?SeedlistId=library/site_area&Source=com.ibm.workplace.wcm.plugins.seedlist.retriever.WCMRetrieverFactory&Action=GetDocuments
Extraction de 200 objets au maximum à partir d'un serveur autonome à l'aide de l'ID de la zone de site
http://host_name:port_number/wps/seedlist/myserver?SeedlistId=site_area_id&Source=com.ibm.workplace.wcm.plugins.seedlist.retriever.WCMRetrieverFactory&Action=GetDocuments&Range=200
Extraction d'un nombre maximal de 100 éléments à partir d'une bibliothèque spécifique
http://host_name:port_number/wps/seedlist/myserver?SeedlistId=library&Source=com.ibm.workplace.wcm.plugins.seedlist.retriever.WCMRetrieverFactory&Action=GetDocuments
Extraction d'un nombre maximal de 100 éléments à partir de toutes les bibliothèques
Remarque : Pour utiliser toutes les bibliothèques, laissez la valeur SeedlistId vide.
http://host_name:port_number/wps/seedlist/myserver?SeedlistId=&Source=com.ibm.workplace.wcm.plugins.seedlist.retriever.WCMRetrieverFactory&Action=GetDocuments
Extraction d'un nombre maximal de 100 éléments à partir d'une liste de bibliothèques spécifiée
http://host_name:port_number/wps/seedlist/myserver?SeedlistId=library1,library2&Source=com.ibm.workplace.wcm.plugins.seedlist.retriever.WCMRetrieverFactory&Action=GetDocuments
Extraction d'un nombre maximal de 100 éléments à partir d'un cluster
Remarque : Lorsque vous référencez un cluster, spécifiez dans la requête le nom d'hôte et le numéro de port du serveur HTTP.
http://http_server:port_number/wps/seedlist/myserver?SeedlistId=library/site_area&Source=com.ibm.workplace.wcm.plugins.seedlist.retriever.WCMRetrieverFactory&Action=GetDocuments
Extraction de 100 objets au maximum à partir d'un portail virtuel configuré pour utiliser le contexte d'URL comme point d'accès
http://http_server:port_number/wps/seedlist/myserver/virtual_portal_context?SeedlistId=library/site_area&Source=com.ibm.workplace.wcm.plugins.seedlist.retriever.WCMRetrieverFactory&Action=GetDocuments
Extraction de 100 objets au maximum à partir d'un portail virtuel configuré pour utiliser un nom d'hôte différent comme point d'accès
http://virtual_portal_host_name:port_number/wps/seedlist/myserver?SeedlistId=library/site_area&Source=com.ibm.workplace.wcm.plugins.seedlist.retriever.WCMRetrieverFactory&Action=GetDocuments
Important : Vous pouvez accéder à l'API REST pour la liste de départ de la recherche Web Content Manager 1.0 via une connexion sécurisée (HTTPS) ou via une connexion non sécurisée (HTTP). Selon la méthode, assurez-vous d'utiliser le port correct. Toutefois, si vous accédez à cette API REST via une connexion non sécurisée, vous êtes redirigé automatiquement vers une connexion sécurisée.
ParamètreValeur par défautDescription
IDlisteorigineCe paramètre est obligatoire, il n'a pas de valeur par défaut.Identifie la liste d'origine. Vous pouvez spécifier les valeurs suivantes pour ce paramètre :
  • une valeur vide, qui indique que toutes les bibliothèques doivent être utilisées ;
  • une bibliothèque spécifique (par exemple, library1)
  • une zone de site spécifique (par exemple, site_area1)
  • Une liste de bibliothèques, séparées par des virgules. Par exemple, 
    library1,library2,library3
  • ID JCR d'une zone de site
Démarrer0Définit le numéro de départ de la section renvoyée.
Intervalle100Définit le nombre d'entrées de la section renvoyées.
DatePas de valeur par défaut. En l'absence de spécification, tous les résultats pertinents sont renvoyés.Indique que les entrées (documents) qui ont été mises à jour après cette date doivent être extraites. Le format de date (conforme à la norme ISO 8601) est le suivant : dateTtimezone, où date est aaaa-MM-jj, time est HH:mm:ss, et zone est ±hhmm. Ce format inclut l'information de fuseau horaire, qui est essentielle si le client et le serveur sont situés dans des fuseaux horaires différents.
Important : Vous devez appliquer un codage d'URL HTML approprié (par exemple, représentez le symbole plus + comme %2B).
ActionGetDocumentsDéfinit l'action demandée à exécuter.
  • La commande GetDocuments récupère tous les documents sous-jacents.
  • La commande GetNumberOfDocuments renvoie le nombre total de documents sous-jacents existants, en général pour le débogage. Cette valeur doit être identique au nombre total de documents renvoyés à partir d'une demande GetDocuments appropriée.
FormatATOMDéfinit le format de sortie : ATOM / HTML/ XML.
HorodatagePas de valeur par défaut.Indique l'horodate du fournisseur de contenu à partir d'une session d'analyse précédente. L'horodate procure une sorte d'instantané du contenu et permet au moteur d'analyse de récupérer uniquement les contenus modifiés lors de l'analyse suivante. Ce paramètre est utilisé pour l'analyse incrémentielle.