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


---

# DocumentListService : champ d'application, global

# DocumentListService : champ d'application, global {#ariaid-title1}

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

L'API DocumentListService fournit des méthodes pour créer, supprimer et mettre à jour une liste de documents.

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).  
Le Document Management module d'extension prend également en charge la création de listes de modèles de documents à associer à votre document. Par exemple, une demande d'emploi nécessitant plusieurs documents tels qu'un diplôme, une carte d'identité ou un passeport. Après avoir ajouté votre liste de documents, vous pouvez ajouter des modèles de documents :

* [SystemDocumentListEntry](https://servicenow-prod.fluidtopics.net/cndZR1uh4IPAXEpOIuN3MA#SystemDocumentListEntryBothAPI "L’API SystemDocumentListEntry fournit des méthodes pour définir les champs d’enregistrement dans la table Entrées de la liste de documents [ds_document_list_entry].") : définit une entrée de liste de modèles de documents.
* [DocumentListEntryService](https://servicenow-prod.fluidtopics.net/FwA7c62zKCVLC0XJaXkyZg#DocumentListEntryServiceBothAPI "L’API DocumentListEntryService fournit des méthodes pour gérer les modèles de documents dans une liste de documents.") : ajouter ou supprimer une entrée de liste de modèles de documents.
{#DocumentListServiceBothAPI__ul_asn_gjg_vpb}  
Pour définir un document en tant que modèle :

* Définissez l'objet document en définissant la méthode [SystemDocument -- template()](https://servicenow-prod.fluidtopics.net/0Q_RcHYN1RnUW4tDfGZdcw#SystemDoc-template_S "Spécifie si un enregistrement de document est un modèle.") sur true. Créez ou mettez à jour l'enregistrement de document avec les méthodes de l'API [DocumentService](https://servicenow-prod.fluidtopics.net/2olPnwzicityLTQGD2Rxlw#DocumentServiceBothAPI "L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document.") .
* Cochez la case Modèle d'un document dans la table Documents \[ds_document\].
{#DocumentListServiceBothAPI__ul_b12_5zv_wpb}  
Les API suivantes vous permettent de définir et de gérer des documents :

* [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.
{#DocumentListServiceBothAPI__ul_krc_vmf_vpb}  
Pour définir un document en tant que modèle :

* Définissez l'objet document en définissant la méthode [SystemDocument -- template()](https://servicenow-prod.fluidtopics.net/0Q_RcHYN1RnUW4tDfGZdcw#SystemDoc-template_S "Spécifie si un enregistrement de document est un modèle.") sur true. Créez ou mettez à jour l'enregistrement de document avec les méthodes de l'API [DocumentService](https://servicenow-prod.fluidtopics.net/2olPnwzicityLTQGD2Rxlw#DocumentServiceBothAPI "L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document.") .
* Cochez la case Modèle d'un document dans la table Documents \[ds_document\].
{#DocumentListServiceBothAPI__d3455e144}

Voir aussi [SystemDocumentList](https://servicenow-prod.fluidtopics.net/EvcAlSG7FpW_ORN2hK7csA#SystemDocumentListBothAPI "L’API SystemDocumentList fournit des méthodes pour définir les champs d’enregistrement dans la table Listes de documents [ds_document_lists].").

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

Instancie un objet DocumentListService .
{#DLS-DocumentListService__table_zw5_mcg_tpb__entry__3}

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

{#DLS-DocumentListService__table_zw5_mcg_tpb}  
L'exemple suivant montre comment instancier un objet DocumentListService . Voir aussi [SystemDocumentList](https://servicenow-prod.fluidtopics.net/EvcAlSG7FpW_ORN2hK7csA#SystemDocumentListBothAPI "L’API SystemDocumentList fournit des méthodes pour définir les champs d’enregistrement dans la table Listes de documents [ds_document_lists].").

    var s = new sn_doc_services.DocumentListService();

## DocumentListService : createDocumentList(document SystemDocumentList) {#ariaid-title3}

Crée une liste de documents dans la table Listes de documents \[ds_document_lists\].
Le Document Management module d'extension prend également en charge la création de listes de modèles de documents à associer à votre document. Par exemple, une demande d'emploi nécessitant plusieurs documents tels qu'un diplôme, une carte d'identité ou un passeport. Après avoir ajouté votre liste de documents, vous pouvez ajouter des modèles de documents :

* [SystemDocumentListEntry](https://servicenow-prod.fluidtopics.net/cndZR1uh4IPAXEpOIuN3MA#SystemDocumentListEntryBothAPI "L’API SystemDocumentListEntry fournit des méthodes pour définir les champs d’enregistrement dans la table Entrées de la liste de documents [ds_document_list_entry].") : définit une entrée de liste de modèles de documents.
* [DocumentListEntryService](https://servicenow-prod.fluidtopics.net/FwA7c62zKCVLC0XJaXkyZg#DocumentListEntryServiceBothAPI "L’API DocumentListEntryService fournit des méthodes pour gérer les modèles de documents dans une liste de documents.") : ajouter ou supprimer une entrée de liste de modèles de documents.
{#DLS-createDocumentList_O__ul_asn_gjg_vpb}

Utilisez la méthode [createDocumentsFromList()](https://servicenow-prod.fluidtopics.net/lmh7SAsqglQjkA~y0ZxQTA#DLS-createDocumentsFromList_S_S_S "Crée des documents à partir d’une liste de modèles de documents.") pour créer des documents à partir de la liste des modèles de documents.
{#DLS-createDocumentList_O__table_w4z_2cg_tpb__entry__3}

| Nom | Type | Description |
|-|-|-|
| document | [Liste des documents système](https://servicenow-prod.fluidtopics.net/EvcAlSG7FpW_ORN2hK7csA#SystemDocumentListBothAPI "L’API SystemDocumentList fournit des méthodes pour définir les champs d’enregistrement dans la table Listes de documents [ds_document_lists].") | Une ou plusieurs propriétés représentant les champs d'un nouvel enregistrement. La propriété name est requise et peut être définie à l'aide du constructeur SystemDocumentList ou de la méthode name(). |
[Tableau 2. Paramètres]

{#DLS-createDocumentList_O__table_w4z_2cg_tpb} {#DLS-createDocumentList_O__table_tj4_p5j_34b__entry__2}

| Type | Description |
|-|-|
| Objet | Sys_id du nouvel enregistrement dans la table Listes de documents \[ds_document_lists\] 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. Type de données : chaîne |
| \<Object\>.request_id | Sys_id de l'enregistrement dans la table Listes de documents \[ds_document_lists\]. 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. {#DLS-createDocumentList_O__ul_rlv_5cv_j4b} Type de données : chaîne |
[Tableau 3. Renvoie]

{#DLS-createDocumentList_O__table_tj4_p5j_34b}  
L'exemple suivant montre comment créer une liste de documents. Voir aussi [SystemDocumentList](https://servicenow-prod.fluidtopics.net/EvcAlSG7FpW_ORN2hK7csA#SystemDocumentListBothAPI "L’API SystemDocumentList fournit des méthodes pour définir les champs d’enregistrement dans la table Listes de documents [ds_document_lists].").

    var dL = new sn_doc_services.SystemDocumentList('My document list');

    // Define the document list field
    dL.description('description');

    var docList = new sn_doc_services.DocumentListService();
    gs.info(JSON.stringify(docList.createDocumentList(dL), null, 2));

Sortie :

    {
      "message": "Create List for the given name : My document list, List sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
      "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
      "status": "success"
    }

## DocumentListService : createDocumentsFromList(String listSysId, String tableName, String tableSysId) {#ariaid-title4}

Crée des documents à partir d'une liste de modèles de documents.
Remarque :  
Avant d'utiliser cette méthode, créez une liste de modèles de documents à l'aide de la méthode [createDocumentList().](https://servicenow-prod.fluidtopics.net/lmh7SAsqglQjkA~y0ZxQTA#DLS-createDocumentList_O "Crée une liste de documents dans la table Listes de documents [ds_document_lists].")
{#DLS-createDocumentsFromList_S_S_S__table_w4z_2cg_tpb__entry__3}

| Nom | Type | Description |
|-|-|-|
| listSysId (en anglais seulement) | Chaîne | Sys_id d'un enregistrement de liste de documents dans la table Listes de documents \[ds_document_lists\]. |
| tableName | Chaîne | Nom de la table contenant l'enregistrement sur lequel ajouter une liste de références de modèle de document. |
| tableSysId | Chaîne | Sys_id de l'enregistrement contenant le contenu à partir duquel ajouter une liste de références de modèle de document. |
[Tableau 4. Paramètres]

{#DLS-createDocumentsFromList_S_S_S__table_w4z_2cg_tpb} {#DLS-createDocumentsFromList_S_S_S__table_tj4_p5j_34b__entry__2}{#DLS-createDocumentsFromList_S_S_S__ph-docserv-ret-obj-basic}{#DLS-createDocumentsFromList_S_S_S__row_pdfgen_ret_msgCnv}

| Type | Description |
|-|-|
| Objet | Message de réussite ou d'erreur. { "message": "String", "request_id": "String", "status": "String" } {#DLS-createDocumentsFromList_S_S_S__api_docserv_codeblock_dets} |
| \<Object\>.Message | Message contenant le nombre de modèles de documents dans la liste de documents. Type de données : chaîne |
| \<Object\>.request_id | Sys_id de l'enregistrement dans la table Listes de documents \[ds_document_lists\]. 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. {#DLS-createDocumentsFromList_S_S_S__ul_rlv_5cv_j4b} Type de données : chaîne |
[Tableau 5. Renvoie]

{#DLS-createDocumentsFromList_S_S_S__table_tj4_p5j_34b}  
L'exemple suivant montre comment ajouter une liste de références de modèle de document à un enregistrement. La documentation est ajoutée à un enregistrement dans la table Incidents \[incident\].

    var result = new sn_doc_services.DocumentListService().createDocumentsFromList('21afddea2460fc10f877a6fed1c2b0dd', 'incident', 'd7158da0c0a8016700eef46c8d1f3661');
    gs.info(JSON.stringify(result, null, 2));

Sortie :

    {
      "message": "Created 1 document references for the given table name: incident, table sysId : d7158da0c0a8016700eef46c8d1f3661 with list SysId 21afddea2460fc10f877a6fed1c2b0dd",
      "request_id": "21afddea2460fc10f877a6fed1c2b0dd",
      "status": "success"
    }

## DocumentListService : deleteDocumentList(String listSysId) {#ariaid-title5}

Supprime un enregistrement de document de la table Listes de documents \[ds_document_lists\].
{#DLS-deleteDocumentList_S__table_w4z_2cg_tpb__entry__3}

| Nom | Type | Description |
|-|-|-|
| listSysId (en anglais seulement) | Chaîne | Sys_id d'un enregistrement de liste de documents dans la table Listes de documents \[ds_document_lists\]. |
[Tableau 6. Paramètres]

{#DLS-deleteDocumentList_S__table_w4z_2cg_tpb} {#DLS-deleteDocumentList_S__table_x4z_2cg_tpb__entry__2}{#DLS-deleteDocumentList_S__ph-docserv-ret-obj-basic}

| Type | Description |
|-|-|
| Objet | Message de réussite ou d'erreur. { "message": "String", "request_id": "String", "status": "String" } {#DLS-deleteDocumentList_S__api_docserv_codeblock_dets} |
| \<Object\>.Message | Message confirmant la réussite ou l'erreur. Type de données : chaîne |
| \<Object\>.request_id | Sys_id de l'enregistrement dans la table Listes de documents \[ds_document_lists\]. 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. {#DLS-deleteDocumentList_S__ul_rlv_5cv_j4b} Type de données : chaîne |
[Tableau 7. Renvoie]

{#DLS-deleteDocumentList_S__table_x4z_2cg_tpb}  
L'exemple suivant montre comment supprimer un enregistrement de liste de documents. Voir aussi [SystemDocumentList](https://servicenow-prod.fluidtopics.net/EvcAlSG7FpW_ORN2hK7csA#SystemDocumentListBothAPI "L’API SystemDocumentList fournit des méthodes pour définir les champs d’enregistrement dans la table Listes de documents [ds_document_lists].").

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

    var docListSvc = new sn_doc_services.DocumentListService();
    gs.info(JSON.stringify(docListSvc.deleteDocumentList(docListID), null, 2));

Sortie :

    {
      "message": "Delete List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
      "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
      "status": "success"
    }

## DocumentListService : updateDocumentList(String docSysId, SystemDocumentList doc) {#ariaid-title6}

Met à jour les valeurs de champ d'une liste de documents existante.
{#DLS-updateDocumentList_S_O__table_w4z_2cg_tpb__entry__3}

| Nom | Type | Description |
|-|-|-|
| listSysId (en anglais seulement) | Chaîne | Sys_id d'un enregistrement de liste de documents dans la table Listes de documents \[ds_document_lists\]. |
| document | [Document système](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].") | Une ou plusieurs propriétés représentant les champs de liste de documents à mettre à jour. |
[Tableau 8. Paramètres]

{#DLS-updateDocumentList_S_O__table_w4z_2cg_tpb} {#DLS-updateDocumentList_S_O__table_x4z_2cg_tpb__entry__2}{#DLS-updateDocumentList_S_O__ph-docserv-ret-obj-basic}

| Type | Description |
|-|-|
| Objet | Message de réussite ou d'erreur. { "message": "String", "request_id": "String", "status": "String" } {#DLS-updateDocumentList_S_O__api_docserv_codeblock_dets} |
| \<Object\>.Message | Message confirmant la réussite ou l'erreur. Type de données : chaîne |
| \<Object\>.request_id | Sys_id de l'enregistrement dans la table Listes de documents \[ds_document_lists\]. 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. {#DLS-updateDocumentList_S_O__ul_rlv_5cv_j4b} Type de données : chaîne |
[Tableau 9. Renvoie]

{#DLS-updateDocumentList_S_O__table_x4z_2cg_tpb}  
L'exemple suivant montre comment mettre à jour le nom et la description d'une liste de documents. Voir aussi [SystemDocumentList](https://servicenow-prod.fluidtopics.net/EvcAlSG7FpW_ORN2hK7csA#SystemDocumentListBothAPI "L’API SystemDocumentList fournit des méthodes pour définir les champs d’enregistrement dans la table Listes de documents [ds_document_lists].").

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

    var docListUpdate = new sn_doc_services.SystemDocumentList();
    docListUpdate.name('name change');
    docListUpdate.description('description update');

    var docListSvc = new sn_doc_services.DocumentListService();
    gs.info(JSON.stringify(docListSvc.updateDocumentList(docListID , docListUpdate), null, 2));

Sortie :

    {
      "message": "Update List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
      "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
      "status": "success"
    }