Skip to content

$ged.searchDocument

Description

Méthode de recherche de document par contenu dans la GED (recherche "full text").

Remarque : si vous souhaitez effectuer une recherche d'objet par nom, veuillez utiliser la méthode $ged.searchNode.

Syntaxe

$ged.searchDocument( nodeid , searchRules [ , options ] )

Paramètres

nodeid string
Identifiant de l'élément de départ (référence en principe un dossier)
searchRule any

Critères de recherche. La forme du paramètre varie selon le type de GED.

Sur Alfresco, le paramètre attendu est un map pouvant contenir l'une des propriétés suivantes:

term
Critère de recherche. La méthode recherchera alors les nœuds correspondant au terme indiqué.
query
Requête de recherche fournie en json. La forme des la requête doit utiliser la syntaxe décrite dans la documentation en ligne

Si les deux éléments sont définis, la méthode ne tient compte que de la propriété query.

Le paramètre attendu est un string ou un tableau des noms de fichiers ou de dossiers à chercher. Les noms peuvent utiliser des wildcards.

options map

Map d'options pouvant contenir les propriétés suivantes:

connection string
Nom de connexion à utiliser. Fait référence à un name d'entrée ged.connection du config.
raw boolean
Flag indiquant à la méthode de retourner la réponse brute reçue de l'API.

Retour

Tableau contenant des maps ayant les propriétés suivantes:

id string
Identifiant de l'élément
name string
Nom de l'élément
score number
Score de l'élément dans le résultat de recherche sous forme de valeur flottante.
createdAt timestamp
Date/Heure de création
createdBy string
Auteur de la création. Cette propriété présente un intérêt limité étant donné que l'auteur est généralement l'utilisateur technique utilisé pour la connexion à la GED.
modifiedAt timestamp
Date/Heure de dernière modification
modifiedBy string
Auteur de la modification. Cette propriété présente un intérêt limité étant donné que l'auteur de la modification est généralement l'utilisateur technique utilisé pour la connexion à la GED.
mimetype string
Mimetype (si l'élément est un fichier)
size number
Taille du fichier en bytes
parentId string
Identifiant de l'élément parent

Exemple

1
2
var res = $ged.searchNode("ef91d4c2-cd8f-4058-b538-662e63041cd8",
                          { term: "epilogic" });