$ged.getChildren

Description

Récupère les nodeId fils. La méthode génère une réponse standardisée pour les différents types de GED. Il est également possible d'obtenir la réponse brute de l'API en activant l'option raw.

Syntaxe

$ged.getChildren( nodeid [ , options ] )

Paramètres

nodeid string

Identifiant du noeud de départ

options map

Les propriétés suivantes sont reconnues:

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.

Lorsque cette propriété est activée, les propriétés recursive et levels ci-dessous sont ignorées.

recursive boolean

Flag demandant à la méthode de descendre dans l'arborescence.

Attention, le traitement peut être relativement long selon la taille de l'arborescence. Il est possible de restreindre la récursivité au moyen de l'option levels.

levels number

Nombre de niveaux de profondeur à descendre en cas d'appel récursif. Si non défini, la méthode parcourt tous les sous-éléments du noeud courant.

Alfresco

Options spécifiques à Alfresco. Pour le détail, veuillez vous reporter à la documentation de l'API.

skipCount number

Nombre d'entités à ignorer avant d'alimenter la réponse

maxItems number

Nombre maximum d'éléments à retourner.

La valeur par défaut est 100.

orderBy string

Règle de tri des résultats.

where string

Condition de filtre

Retour

Tableau décrivant les éléments fils ou null en cas d'erreur.

Si l'option raw est activée, la méthode retourne l'arbre JSON reçu de l'API.

Exemple

Exemple d'appel et de réponse obtenue sur Alfresco:

var res = $ged.getChildren("c46cef0b-cd89-4c21-b4d5-12ad7ea71f9b",
                           { recursive: true, levels: 5 });