DocumentVersionService : champ d’application, global

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 2 minutes de lecture

    • L’API DocumentVersionService fournit un service de création et de suppression de versions de documents. Chaque version est un élément contenant le contenu du document et est fournie à l’aide d’une URL ou d’une pièce jointe unique. Une pièce jointe ne peut être ajoutée que dans l’interface utilisateur de la table des versions de document [ds_document_version] et non avec l’API.

    Cette API nécessite le module d’extension Gestion de documents (com.snc.platform_document_management) et est fournie dans l’espace de noms sn_doc_services . Pour plus d’informations, consultez Services documentaires.

    Avant de créer une version de document, vous devez d’abord définir et ajouter un enregistrement de document.

    DocumentVersionService : DocumentVersionService()

    Instancie un objet DocumentVersionService .

    Tableau 1. Paramètres
    Nom Type Description
    Néant

    L’exemple suivant montre comment instancier un objet DocumentVersionService .

    var versionSvc = new sn_doc_services.DocumentVersionService();

    DocumentVersionService : createDocumentVersion(SystemDocumentVersion docVersion)

    Crée un enregistrement de version de document dans la table Versions [ds_document_version].

    Tableau 2. Paramètres
    Nom Type Description
    Version docVersion Version du document système Une ou plusieurs propriétés représentant les champs d’une version de document.
    Tableau 3. Renvoie
    Type Description
    Objet Sys_id du nouvel enregistrement dans la table Versions [ds_document_version] avec un message de réussite. Message d’erreur sinon.
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.Message Message confirmant la réussite ou l’erreur. En cas de réussite, comprend la sys_id de l’enregistrement de document et la sys_id de sa nouvelle version de document.

    Type de données : chaîne
    <Object>.request_id Sys_id du nouvel enregistrement dans la table Versions [ds_document_version].

    Type de données : chaîne
    <Object>.statut État indiquant si l’opération a réussi.
    Valeurs possibles :
    • réussite : l’opération a réussi.
    • échec : l’opération a échoué. Le message fournit des détails.

    Type de données : chaîne

    L’exemple suivant montre comment renseigner les propriétés d’objet SystemDocumentVersion et créer une nouvelle version de document. Voir aussi SystemDocumentVersion.

    var versionDefinition = new sn_doc_services.SystemDocumentVersion('491efbee24187410f877a6fed1c2b0a9');

versionDefinition.type('url');
versionDefinition.url('http://one/1.0');

var versionSvc = new sn_doc_services.DocumentVersionService();
gs.info(JSON.stringify(versionSvc.createDocumentVersion(versionDefinition), null, 2));
    Sortie :
    {
  "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : d5a340d9242cf810f877a6fed1c2b069 is successful.",
  "request_id": "d5a340d9242cf810f877a6fed1c2b069",
  "status": "success"
}

    DocumentVersionService : deleteDocumentVersion(String docVersionSysId)

    Supprime une version de document.

    Tableau 4. Paramètres
    Nom Type Description
    docVersionSysId Chaîne Sys_id d’une version de document dans la table Versions [ds_document_version].
    Tableau 5. Renvoie
    Type Description
    Objet Message de réussite. Message d’erreur sinon.
    {
  "message": "String",
  "status": "String"
}
    <Object>.Message Message confirmant la réussite ou l’erreur. En cas de réussite, inclut le sys_id de la version du document supprimé.

    Type de données : chaîne
    <Object>.statut État indiquant si l’opération a réussi.
    Valeurs possibles :
    • réussite : l’opération a réussi.
    • échec : l’opération a échoué. Le message fournit des détails.

    Type de données : chaîne

    L’exemple suivant montre comment supprimer une version de document existante.

    var vId = "<versionSysId>";
var versionSvc = new sn_doc_services.DocumentVersionService();

gs.info(JSON.stringify(versionSvc.deleteDocumentVersion(vId), null, 2));
    Sortie :
    {
  "message": "Deleting an entry to DocumentVersion for the given documentVersionSysId : , sysId : <versionSysId> is successful.",
  "status": "success"
}