`$ged.getVersions`¶

Description¶

Énumère les versions existantes d'un document en GED.

Syntaxe¶

$ged.getVersions( nodeid [ , options ] )

Paramètres¶

nodeid string

Identifiant du node dont on souhaite obtenir des informations.

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 true/false demandant d'obtenir la réponse brute de l'API.

Par défaut, la méthode retourne un array dans lequel les entrées sont uniformisées (voir description). En activant le flag, il est possible d'obtenir la réponse brute de l'API au format JSON.

Retour¶

La valeur de retour peut prendre deux formes selon que l'option raw est activée ou non.

Si raw est désactivé (ce qui est le cas par défaut), la méthode retourne un tableau de maps. Chaque map représente une version et contient les propriétés suivantes:

version string: Numéro de version
name string: Nom du document
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: Timestamp de la modification ayant produit la version
modifiedBy string: Auteur de la modification. Cette propriété présente un intérêt limité étant donné que l'auteur de la modification sera l'utilisateur technique utilisé pour la connexion dans la grande majorité des cas.
mimetype string: Mimetype du document
size number: Taille du document en bytes
encoding string: Encoding du document

Si raw est activé, la méthode retourne l'arbre JSON tel que retourné par l'API.

Exemple¶

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

var versions = $ged.getVersions("06553c16-6fbe-4142-aa12-8ee9b7a858ec");

Le contenu de la réponse versions varie selon le système de GED utilisé. Ici l'objet versions est représenté sous forme JSON pour faciliter la lecture.

FileIndexAlfresco

[
    {
        "isFolder": false,
        "size": 12,
        "isFile": true,
        "isDeleted": false,
        "name": "sample.pdf",
        "description": null,
        "mimetype": "application/download",
        "nodeId": "8fe76275-bc28-4a13-8375-c8c3d8ce68a4",
        "version": "1.1",
        "parentId": "009ad10b-b409-45ad-9bad-fd729df4a084",
        "fileId": "ff655848-6d87-440d-95de-abd411640fa6"
    },
    {
        "isFolder": false,
        "size": 5241,
        "isFile": true,
        "isDeleted": false,
        "name": "sample.pdf",
        "description": null,
        "mimetype": "application/pdf",
        "nodeId": "8fe76275-bc28-4a13-8375-c8c3d8ce68a4",
        "version": "1.0",
        "parentId": "009ad10b-b409-45ad-9bad-fd729df4a084",
        "fileId": "b06a6d51-3059-4c68-b92e-2514acffffee"
    }
]

[
    {
        "size": "12",
        "modifiedAt": "2025-04-28 09:02:06.916",
        "name": "sample.pdf",
        "modifiedBy": "admin",
        "mimetype": "application/pdf",
        "encoding": "UTF-8",
        "version": "1.1"
    },
    {
        "size": "5241",
        "modifiedAt": "2025-04-28 09:02:04.538",
        "name": "sample.pdf",
        "modifiedBy": "admin",
        "mimetype": "application/pdf",
        "encoding": "UTF-8",
        "version": "1.0"
    }
]

$ged.getVersions¶