---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# DocumentVersionService : inclus, global

# DocumentVersionService : inclus, global {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes de lecture

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

Cette API nécessite le module d'extension Document Management (com.snc.platform_document_management) et est fournie dans l'espace de noms `sn_doc_services` . Pour plus d'informations, consultez [Services documentaires](https://www.servicenow.com/docs/access?context=document-services-landing-page&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US).

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

* [SystemDocument](https://servicenow-prod.fluidtopics.net/0Q_RcHYN1RnUW4tDfGZdcw#SystemDocumentBothAPI "L’API SystemDocument fournit des méthodes pour définir les champs d’un enregistrement dans la table Documents [ds_document].") : définit un objet de document.
* [DocumentService](https://servicenow-prod.fluidtopics.net/2olPnwzicityLTQGD2Rxlw#DocumentServiceBothAPI "L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document.") : ajouter, mettre à jour ou supprimer un document.
{#DocumentVersionServiceBothAPI__ul_qyt_tpr_wpb}

## DocumentVersionService : DocumentVersionService() {#ariaid-title2}

Instancie un objet DocumentVersionService .
{#DocVersSvc-DocumentVersionService__table_zw5_mcg_tpb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 1. Paramètres]

{#DocVersSvc-DocumentVersionService__table_zw5_mcg_tpb}  
L'exemple suivant montre comment instancier un objet DocumentVersionService .

    var versionSvc = new sn_doc_services.DocumentVersionService();

## DocumentVersionService : createDocumentVersion(SystemDocumentVersion, docVersion) {#ariaid-title3}

Crée un enregistrement de version de document dans la table Versions \[ds_document_version\].
{#DocVersSvc-createDocumentVersion_O__table_w4z_2cg_tpb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Version Doc | [SystemDocumentVersion (en anglais seulement)](https://servicenow-prod.fluidtopics.net/UFkDetAXkMJemIoCuI0seg#SystemDocumentVersionBothAPI "L’API SystemDocumentVersion fournit des méthodes pour définir les valeurs de la version source d’un document dans la table Versions [ds_document_version].") | Une ou plusieurs propriétés représentant des champs d'une version de document. |
[Tableau 2. Paramètres]

{#DocVersSvc-createDocumentVersion_O__table_w4z_2cg_tpb} {#DocVersSvc-createDocumentVersion_O__table_tj4_p5j_34b__entry__2}{#DocVersSvc-createDocumentVersion_O__row_pdfgen_ret_msgCnv}

| 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, inclut le 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 s'est déroulée correctement. * échec : l'opération n'a pas réussi. Fournit message des détails. {#DocVersSvc-createDocumentVersion_O__ul_rlv_5cv_j4b} Type de données : chaîne |
[Tableau 3. Renvoie]

{#DocVersSvc-createDocumentVersion_O__table_tj4_p5j_34b}  
L'exemple suivant montre comment renseigner les propriétés de l'objet SystemDocumentVersion et créer une nouvelle version de document. Voir aussi [SystemDocumentVersion](https://servicenow-prod.fluidtopics.net/UFkDetAXkMJemIoCuI0seg#SystemDocumentVersionBothAPI "L’API SystemDocumentVersion fournit des méthodes pour définir les valeurs de la version source d’un document dans la table Versions [ds_document_version].").

    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) {#ariaid-title4}

Supprime une version du document.
{#DocVersSvc-deleteDocumentVersion_S__table_w4z_2cg_tpb__entry__3}

| Nom | Type | Description |
|-|-|-|
| docVersionSysId | Chaîne | Sys_id d'une version de document dans la table Versions \[ds_document_version\]. |
[Tableau 4. Paramètres]

{#DocVersSvc-deleteDocumentVersion_S__table_w4z_2cg_tpb} {#DocVersSvc-deleteDocumentVersion_S__table_x4z_2cg_tpb__entry__2}

| Type | Description |
|-|-|
| Objet | Message de réussite. Message d'erreur sinon. { "message": "String", "status": "String" } {#DocVersSvc-deleteDocumentVersion_S__api_docserv_codeblock_dets} |
| \<Object\>.Message | Message confirmant la réussite ou l'erreur. En cas de réussite, inclut l'sys_id de la version du document supprimée. Type de données : chaîne |
| \<Object\>.statut | État indiquant si l'opération a réussi. Valeurs possibles : * réussite : l'opération s'est déroulée correctement. * échec : l'opération n'a pas réussi. Fournit message des détails. {#DocVersSvc-deleteDocumentVersion_S__ul_rlv_5cv_j4b} Type de données : chaîne |
[Tableau 5. Renvoie]

{#DocVersSvc-deleteDocumentVersion_S__table_x4z_2cg_tpb}  
L'exemple suivant montre comment supprimer une version existante d'un document.

    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"
    }