annotation-express-update-doc-list

Synopsis

crawler-service-enqueue-response nodeset annotation-express-update-doc-list(collection, subcollection, content, content-old, documents, username, acl, synchronization, priority, datesecs);
nmtoken collection;
enum subcollection;
content nodeset content;
content nodeset content-old;
document nodeset documents;
string username;
string acl;
enum synchronization;
int priority;
int datesecs;

Paramètres

• nmtoken collection - Nom de la collection contenant le document auquel vous voulez ajouter une annotation (obligatoire).
• enum subcollection - Sous-collection dans laquelle le contenu sera mis en file d'attente. Valeur par défaut : live. Valeurs possibles : live|staging.
• content nodeset content - Nouveau nœud <content> devant être inséré dans les documents. Requiert au minimum un attribut de nom et une valeur (obligatoire).
• content nodeset content-old - Ancien nœud <content> devant être changé dans un document. Requiert au minimum un attribut de nom ; si aucune valeur n'est spécifiée, tous les documents de la liste seront identifiés avec le nouveau contenu et tous les paramètres <content> affichant l'attribut de nom donné par l'utilisateur seront écrasés (obligatoire).
• document nodeset documents - Nœuds <document> dont le contenu spécifié doit être mis à jour dans tous les résultats. Chaque nœud <document> requiert au minimum un attribut @vse-key (obligatoire).
• string username - Nom d'utilisateur auquel cette annotation doit être attribuée (obligatoire).
• string acl - ACL à utiliser (obligatoire).
• enum synchronization - Mode de synchronisation à utiliser. Valeur par défaut : indexed-no-sync. Valeurs possibles : enqueued|indexed|none|to-be-crawled|to-be-indexed|indexed-no-sync|none.
• int priority - Priorité que cette mise en file d'attente de contenu doit afficher pour tout élément exploré simultanément. Valeur par défaut : 1.
• int datesecs - Date et heure, en secondes depuis l'epoch, indiquant le moment où l'annotation a été mise à jour. Si elles ne sont pas définies, l'heure actuelle et la date du jour seront utilisées. Ce paramètre est utile pour restaurer les annotations à partir d'un fichier de sauvegarde.

Valeur de retour

• crawler-service-enqueue-response nodeset

Exceptions

• annotation-content-missing-name-attribute
• annotation-content-missing-value
• search-collection-invalid-name
• search-collection-enqueue

Authentification

Comme toutes les fonctions de l'API de Watson Explorer Engine, à l'exception de ping, la fonction annotation-express-update-doc-list requiert une authentification.

Lorsque vous utilisez l'interface REST, vous pouvez simplement transmettre v.username et v.password comme paramètres CGI via le protocole HTTP ou HTTPS afin d'authentifier l'appel REST pour la fonction annotation-express-update-doc-list.

Lorsque vous utilisez l'API SOAP, vous pouvez transmettre les données d'identification comme paramètres à un nœud final ou utiliser la méthode d'authentification prise en charge par toutes les fonctions de Watson Explorer Engine. Chacune fournit une méthode setAuthentication qui peut être transmise comme objet d'authentification afin de fournir le nom d'utilisateur et le mot de passe sous lesquels s'exécute une fonction. Par exemple, dans Java, pour adresser un appel SOAP à la fonction annotation-express-update-doc-list, la méthode d'authentification sera la suivante :

    Authentication authentication = new Authentication();
    authentication.setUsername("joe-user");
    authentication.setPassword("joes-password");

    AnnotationExpressUpdateDocList foo = new AnnotationExpressUpdateDocList();
    foo.setAuthentication(authentication);

Un objet d'authentification unique est généralement réutilisé dans chaque application individuelle.