---
sourceDocument: Xanadu-API-Referenz
sourceDocumentLink: https://www.servicenow.com/docs/r/de-DE/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - de-DE

ft:publication_title :

    - Xanadu-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# SystemDocumentList: Bereichsbezogen, global

# SystemDocumentList: Bereichsbezogen, global {#ariaid-title1}

* Freigeben Version: Xanadu
* 
* Aktualisiert 1. August 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 Minute Lesedauer

Die SystemDocumentList- API bietet Methoden zum Festlegen der Datensatzfelder in der Tabelle „Dokumentlisten" \[ds_document_lists\].

Diese API erfordert das Plugin Dokumentverwaltung (com.snc.platform_document_management) und wird im Namespace `sn_doc_services` bereitgestellt. Weitere Informationen finden Sie unter [Dokumentenservices](https://www.servicenow.com/docs/access?context=document-services-landing-page&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US).

Verwenden Sie zum Erstellen oder Verwalten einer Dokumentliste die [DocumentListService-API](https://www.servicenow.com/docs/Jq8a_9xM4~t91kkthXF5_w#DocumentListServiceBothAPI "Die DocumentListService -API bietet Methoden zum Erstellen, Löschen und Aktualisieren einer Dokumentliste.").

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

Instanziiert ein SystemDocumentList- Objekt.
{#SysDocList-SystemDocumentList_S__table_o12_jrk_spb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| docListName | Zeichenfolge | Name der Dokumentliste. |
[Tabelle : 1. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 2. Ergebnisse]

{#SysDocList-SystemDocumentList_S__table_p12_jrk_spb}  
Das folgende Beispiel zeigt, wie ein SystemDocumentList- Objekt instanziiert wird.

    var docList = new sn_doc_services.SystemDocumentList();

## SystemDocumentList -- Beschreibung (Zeichenfolgenbeschreibung) {#ariaid-title3}

Legt das Beschreibungsfeld eines neuen Dokumentlistendatensatzes fest.
{#SysDocList-description_S__table_o12_jrk_spb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| description | Zeichenfolge | Beschreibung der Dokumentliste. |
[Tabelle : 3. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 4. Ergebnisse]

{#SysDocList-description_S__table_p12_jrk_spb}  
Das folgende Beispiel zeigt, wie der Dokumentliste eine Beschreibung hinzugefügt wird. Siehe auch [DocumentListService-API](https://www.servicenow.com/docs/Jq8a_9xM4~t91kkthXF5_w#DocumentListServiceBothAPI "Die DocumentListService -API bietet Methoden zum Erstellen, Löschen und Aktualisieren einer Dokumentliste.").

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

Ausgabe:

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

## SystemDocumentList -- name(String docListName) {#ariaid-title4}

Legt das Feld Name eines Dokumentlistendatensatzes fest.
Hinweis:  
Sie können den Namen auch als Parameter im Konstruktor SystemDocumentList() festlegen.
{#SysDocList-name_S__table_o12_jrk_spb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| docListName | Zeichenfolge | Name der Dokumentliste. |
[Tabelle : 5. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 6. Ergebnisse]

{#SysDocList-name_S__table_p12_jrk_spb}  
Das folgende Beispiel zeigt, wie Sie eine vorhandene Dokumentliste umbenennen. Siehe auch [DocumentListService](https://www.servicenow.com/docs/Jq8a_9xM4~t91kkthXF5_w#DocumentListServiceBothAPI "Die DocumentListService -API bietet Methoden zum Erstellen, Löschen und Aktualisieren einer Dokumentliste.").

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

Ausgabe:

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