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


---

# SystemDocumentList : champ d'application, global

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

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

L'API SystemDocumentList fournit des méthodes pour définir les champs d'enregistrement dans la table Listes de documents \[ds_document_lists\].

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

Pour créer ou gérer une liste de documents, utilisez [l'API DocumentListService](https://servicenow-prod.fluidtopics.net/lmh7SAsqglQjkA~y0ZxQTA#DocumentListServiceBothAPI "L’API DocumentListService fournit des méthodes pour créer, supprimer et mettre à jour une liste de documents.").

## SystemDocumentList : SystemDocumentList(String docListName) {#ariaid-title2}

Instancie un objet SystemDocumentList .
{#SysDocList-SystemDocumentList_S__table_o12_jrk_spb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Nom de liste de documents | Chaîne | Nom de la liste de documents. |
[Tableau 1. Paramètres]

{#SysDocList-SystemDocumentList_S__table_o12_jrk_spb} {#SysDocList-SystemDocumentList_S__table_p12_jrk_spb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 2. Renvoie]

{#SysDocList-SystemDocumentList_S__table_p12_jrk_spb}  
L'exemple suivant montre comment instancier un objet SystemDocumentList .

    var docList = new sn_doc_services.SystemDocumentList();

## SystemDocumentList : description (description de chaîne) {#ariaid-title3}

Définit le champ Description d'un nouvel enregistrement de liste de documents.
{#SysDocList-description_S__table_o12_jrk_spb__entry__3}

| Nom | Type | Description |
|-|-|-|
| description | Chaîne | Description de la liste de documents. |
[Tableau 3. Paramètres]

{#SysDocList-description_S__table_o12_jrk_spb} {#SysDocList-description_S__table_p12_jrk_spb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 4. Renvoie]

{#SysDocList-description_S__table_p12_jrk_spb}  
L'exemple suivant montre comment ajouter une description à la liste de documents. Voir aussi [API DocumentListService](https://servicenow-prod.fluidtopics.net/lmh7SAsqglQjkA~y0ZxQTA#DocumentListServiceBothAPI "L’API DocumentListService fournit des méthodes pour créer, supprimer et mettre à jour une liste de documents.").

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

## SystemDocumentList : nom (String docListName) {#ariaid-title4}

Définit le champ Nom d'un enregistrement de liste de documents.
Remarque :  
Vous pouvez également définir le nom en tant que paramètre dans le constructeur SystemDocumentList().
{#SysDocList-name_S__table_o12_jrk_spb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Nom de liste de documents | Chaîne | Nom de la liste de documents. |
[Tableau 5. Paramètres]

{#SysDocList-name_S__table_o12_jrk_spb} {#SysDocList-name_S__table_p12_jrk_spb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 6. Renvoie]

{#SysDocList-name_S__table_p12_jrk_spb}  
L'exemple suivant montre comment renommer une liste de documents existante. Voir aussi [DocumentListService](https://servicenow-prod.fluidtopics.net/lmh7SAsqglQjkA~y0ZxQTA#DocumentListServiceBothAPI "L’API DocumentListService fournit des méthodes pour créer, supprimer et mettre à jour une liste de documents.").

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';
    var docListUpdate = new sn_doc_services.SystemDocumentList();

    docListUpdate.name('name change');

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