---
sourceDocument: Xanadu-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/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


---

# DocumentListService: Bereichsbezogen, Global

# DocumentListService: Bereichsbezogen, Global {#ariaid-title1}

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

Die DocumentListService -API bietet Methoden zum Erstellen, Löschen und Aktualisieren einer Dokumentliste.

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).  
Das Plugin Dokumentverwaltung unterstützt auch das Erstellen von Listen mit Dokumentvorlagen, die Ihrem Dokument zugeordnet werden können. Zum Beispiel eine Stellenbewerbung, die mehrere Dokumente erfordert, z. B. Abschlussdiplom, Ausweis oder Reisepass. Nachdem Sie Ihre Dokumentliste hinzugefügt haben, können Sie Dokumentvorlagen hinzufügen:

* [SystemDocumentListEntry](https://servicenow-prod.fluidtopics.net/S17UIqgcESpJr69PaK3SRA#SystemDocumentListEntryBothAPI "Die SystemDocumentListEntry- API bietet Methoden zum Festlegen der Datensatzfelder in der Tabelle „Dokumentlisteneinträge“ [ds_document_list_entry].") : Definiert einen Dokumentvorlagenlisteneintrag.
* [DocumentListEntryService](https://servicenow-prod.fluidtopics.net/DgY92wvOl5qkAu9cbXLKqg#DocumentListEntryServiceBothAPI "Die DocumentListEntryService -API bietet Methoden zum Verwalten von Dokumentvorlagen in einer Dokumentliste.") : Hinzufügen oder Entfernen eines Dokumentvorlagenlisteneintrags.
{#DocumentListServiceBothAPI__ul_asn_gjg_vpb}  
So definieren Sie ein Dokument als Vorlage:

* Definieren Sie das Dokumentobjekt, indem Sie die Methode [„SystemDocument -- template()](https://servicenow-prod.fluidtopics.net/GBnpOCm8cL7B0N320~FDuw#SystemDoc-template_S "Gibt an, ob ein Dokumentdatensatz eine Vorlage ist.") " auf „wahr" festlegen. Erstellen oder aktualisieren Sie den Dokumentdatensatz mit den Methoden in der [DocumentService](https://servicenow-prod.fluidtopics.net/dvWj1BRuOQubJ9bw84l_Ug#DocumentServiceBothAPI "Die DocumentService -API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.") -API.
* Aktivieren Sie das Kontrollkästchen Vorlage eines Dokuments in der Tabelle „Dokumente" \[ds_document\].
{#DocumentListServiceBothAPI__ul_b12_5zv_wpb}  
Mit den folgenden APIs können Sie Dokumente definieren und verwalten:

* [SystemDocument](https://servicenow-prod.fluidtopics.net/GBnpOCm8cL7B0N320~FDuw#SystemDocumentBothAPI "Die SystemDocument- API bietet Methoden zum Festlegen von Feldern eines Datensatzes in der Tabelle „Dokumente“ [ds_document].") : Definiert ein Dokumentobjekt.
* [DocumentService](https://servicenow-prod.fluidtopics.net/dvWj1BRuOQubJ9bw84l_Ug#DocumentServiceBothAPI "Die DocumentService -API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.") : Ein Dokument hinzufügen, aktualisieren oder löschen.
{#DocumentListServiceBothAPI__ul_krc_vmf_vpb}  
So definieren Sie ein Dokument als Vorlage:

* Definieren Sie das Dokumentobjekt, indem Sie die Methode [„SystemDocument -- template()](https://servicenow-prod.fluidtopics.net/GBnpOCm8cL7B0N320~FDuw#SystemDoc-template_S "Gibt an, ob ein Dokumentdatensatz eine Vorlage ist.") " auf „wahr" festlegen. Erstellen oder aktualisieren Sie den Dokumentdatensatz mit den Methoden in der [DocumentService](https://servicenow-prod.fluidtopics.net/dvWj1BRuOQubJ9bw84l_Ug#DocumentServiceBothAPI "Die DocumentService -API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.") -API.
* Aktivieren Sie das Kontrollkästchen Vorlage eines Dokuments in der Tabelle „Dokumente" \[ds_document\].
{#DocumentListServiceBothAPI__d3455e144}

Siehe auch [Systemdokumentliste](https://servicenow-prod.fluidtopics.net/jywGT3OkqjH_jyziK~h9Iw#SystemDocumentListBothAPI "Die SystemDocumentList- API bietet Methoden zum Festlegen der Datensatzfelder in der Tabelle „Dokumentlisten“ [ds_document_lists].").

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

Instanziiert ein DocumentListService -Objekt.
{#DLS-DocumentListService__table_zw5_mcg_tpb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 1. Parameter]

{#DLS-DocumentListService__table_zw5_mcg_tpb}  
Das folgende Beispiel zeigt, wie ein DocumentListService -Objekt instanziiert wird. Siehe auch [Systemdokumentliste](https://servicenow-prod.fluidtopics.net/jywGT3OkqjH_jyziK~h9Iw#SystemDocumentListBothAPI "Die SystemDocumentList- API bietet Methoden zum Festlegen der Datensatzfelder in der Tabelle „Dokumentlisten“ [ds_document_lists].").

    var s = new sn_doc_services.DocumentListService();

## DocumentListService -- createDocumentList(SystemDocumentList doc) {#ariaid-title3}

Erstellt eine Dokumentliste in der Tabelle „Dokumentlisten" \[ds_document_lists\].
Das Plugin Dokumentverwaltung unterstützt auch das Erstellen von Listen mit Dokumentvorlagen, die Ihrem Dokument zugeordnet werden können. Zum Beispiel eine Stellenbewerbung, die mehrere Dokumente erfordert, z. B. Abschlussdiplom, Ausweis oder Reisepass. Nachdem Sie Ihre Dokumentliste hinzugefügt haben, können Sie Dokumentvorlagen hinzufügen:

* [SystemDocumentListEntry](https://servicenow-prod.fluidtopics.net/S17UIqgcESpJr69PaK3SRA#SystemDocumentListEntryBothAPI "Die SystemDocumentListEntry- API bietet Methoden zum Festlegen der Datensatzfelder in der Tabelle „Dokumentlisteneinträge“ [ds_document_list_entry].") : Definiert einen Dokumentvorlagenlisteneintrag.
* [DocumentListEntryService](https://servicenow-prod.fluidtopics.net/DgY92wvOl5qkAu9cbXLKqg#DocumentListEntryServiceBothAPI "Die DocumentListEntryService -API bietet Methoden zum Verwalten von Dokumentvorlagen in einer Dokumentliste.") : Hinzufügen oder Entfernen eines Dokumentvorlagenlisteneintrags.
{#DLS-createDocumentList_O__ul_asn_gjg_vpb}

Verwenden Sie die Methode [createDocumentsFromList()](https://servicenow-prod.fluidtopics.net/Jq8a_9xM4~t91kkthXF5_w#DLS-createDocumentsFromList_S_S_S "Erstellt Dokumente aus einer Liste von Dokumentvorlagen."), um Dokumente aus der Liste der Dokumentvorlagen zu erstellen.
{#DLS-createDocumentList_O__table_w4z_2cg_tpb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| doc | [Systemdokumentliste](https://servicenow-prod.fluidtopics.net/jywGT3OkqjH_jyziK~h9Iw#SystemDocumentListBothAPI "Die SystemDocumentList- API bietet Methoden zum Festlegen der Datensatzfelder in der Tabelle „Dokumentlisten“ [ds_document_lists].") | Eine oder mehrere Eigenschaften, die Felder eines neuen Datensatzes darstellen. Die Eigenschaft „name" ist erforderlich und kann mit dem Konstruktor „SystemDocumentList" oder der Methode „ name() " festgelegt werden. |
[Tabelle : 2. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Objekt | Sys_id des neuen Datensatzes in der Tabelle „Dokumentlisten" \[ds_document_lists\] mit einer Erfolgsmeldung. Andernfalls Fehlermeldung. { "message": "String", "request_id": "String", "status": "String" } |
| \<Object\>.message | Meldung, die den Erfolg oder Fehler bestätigt. Datentyp: Zeichenfolge |
| \<Object\>.request_id | Sys_id des Datensatzes in der Tabelle „Dokumentlisten" \[ds_document_lists\]. Datentyp: Zeichenfolge |
| \<Object\>.status | Status, der angibt, ob der Vorgang erfolgreich ist. Mögliche Werte: * Erfolg -- Der Vorgang war erfolgreich. * Fehler -- Der Vorgang war nicht erfolgreich. message enthält Details. {#DLS-createDocumentList_O__ul_rlv_5cv_j4b} Datentyp: Zeichenfolge |
[Tabelle : 3. Ergebnisse]

{#DLS-createDocumentList_O__table_tj4_p5j_34b}  
Das folgende Beispiel zeigt, wie eine Dokumentliste erstellt wird. Siehe auch [Systemdokumentliste](https://servicenow-prod.fluidtopics.net/jywGT3OkqjH_jyziK~h9Iw#SystemDocumentListBothAPI "Die SystemDocumentList- API bietet Methoden zum Festlegen der Datensatzfelder in der Tabelle „Dokumentlisten“ [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));

Ausgabe:

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

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

Erstellt Dokumente aus einer Liste von Dokumentvorlagen.
Hinweis:  
Erstellen Sie vor der Verwendung dieser Methode eine Dokumentvorlagenliste mit der Methode [createDocumentList()](https://servicenow-prod.fluidtopics.net/Jq8a_9xM4~t91kkthXF5_w#DLS-createDocumentList_O "Erstellt eine Dokumentliste in der Tabelle „Dokumentlisten“ [ds_document_lists].").
{#DLS-createDocumentsFromList_S_S_S__table_w4z_2cg_tpb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| listSysId | Zeichenfolge | Sys_id eines Dokumentlistendatensatzes in der Tabelle „Dokumentlisten" \[ds_document_lists\]. |
| tableName | Zeichenfolge | Name der Tabelle mit dem Datensatz, für den eine Liste von Dokumentvorlagenreferenzen hinzugefügt wird. |
| tableSysId | Zeichenfolge | Sys_id des Datensatzes, der den Inhalt enthält, aus dem eine Liste von Dokumentvorlagenreferenzen hinzugefügt werden soll. |
[Tabelle : 4. Parameter]

{#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}

| Typ | Beschreibung |
|-|-|
| Objekt | Erfolgs- oder Fehlermeldung. { "message": "String", "request_id": "String", "status": "String" } {#DLS-createDocumentsFromList_S_S_S__api_docserv_codeblock_dets} |
| \<Object\>.message | Nachricht, die die Anzahl der Dokumentvorlagen in der Dokumentliste enthält. Datentyp: Zeichenfolge |
| \<Object\>.request_id | Sys_id des Datensatzes in der Tabelle „Dokumentlisten" \[ds_document_lists\]. Datentyp: Zeichenfolge |
| \<Object\>.status | Status, der angibt, ob der Vorgang erfolgreich ist. Mögliche Werte: * Erfolg -- Der Vorgang war erfolgreich. * Fehler -- Der Vorgang war nicht erfolgreich. message enthält Details. {#DLS-createDocumentsFromList_S_S_S__ul_rlv_5cv_j4b} Datentyp: Zeichenfolge |
[Tabelle : 5. Ergebnisse]

{#DLS-createDocumentsFromList_S_S_S__table_tj4_p5j_34b}  
Das folgende Beispiel zeigt, wie Sie einem Datensatz eine Liste von Dokumentvorlagenreferenzen hinzufügen. Die Dokumentation wird einem Datensatz in der Tabelle „Incidents" \[incident\] hinzugefügt.

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

Ausgabe:

    {
      "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(Zeichenfolge listSysId) {#ariaid-title5}

Entfernt einen Dokumentdatensatz aus der Tabelle „Dokumentlisten" \[ds_document_lists\].
{#DLS-deleteDocumentList_S__table_w4z_2cg_tpb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| listSysId | Zeichenfolge | Sys_id eines Dokumentlistendatensatzes in der Tabelle „Dokumentlisten" \[ds_document_lists\]. |
[Tabelle : 6. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Objekt | Erfolgs- oder Fehlermeldung. { "message": "String", "request_id": "String", "status": "String" } {#DLS-deleteDocumentList_S__api_docserv_codeblock_dets} |
| \<Object\>.message | Meldung, die den Erfolg oder Fehler bestätigt. Datentyp: Zeichenfolge |
| \<Object\>.request_id | Sys_id des Datensatzes in der Tabelle „Dokumentlisten" \[ds_document_lists\]. Datentyp: Zeichenfolge |
| \<Object\>.status | Status, der angibt, ob der Vorgang erfolgreich ist. Mögliche Werte: * Erfolg -- Der Vorgang war erfolgreich. * Fehler -- Der Vorgang war nicht erfolgreich. message enthält Details. {#DLS-deleteDocumentList_S__ul_rlv_5cv_j4b} Datentyp: Zeichenfolge |
[Tabelle : 7. Ausgabe]

{#DLS-deleteDocumentList_S__table_x4z_2cg_tpb}  
Das folgende Beispiel zeigt, wie ein Dokumentlistendatensatz gelöscht wird. Siehe auch [Systemdokumentliste](https://servicenow-prod.fluidtopics.net/jywGT3OkqjH_jyziK~h9Iw#SystemDocumentListBothAPI "Die SystemDocumentList- API bietet Methoden zum Festlegen der Datensatzfelder in der Tabelle „Dokumentlisten“ [ds_document_lists].").

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

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

Ausgabe:

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

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

Aktualisiert die Feldwerte einer vorhandenen Dokumentliste.
{#DLS-updateDocumentList_S_O__table_w4z_2cg_tpb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| listSysId | Zeichenfolge | Sys_id eines Dokumentlistendatensatzes in der Tabelle „Dokumentlisten" \[ds_document_lists\]. |
| doc | [Systemdokument](https://servicenow-prod.fluidtopics.net/GBnpOCm8cL7B0N320~FDuw#SystemDocumentBothAPI "Die SystemDocument- API bietet Methoden zum Festlegen von Feldern eines Datensatzes in der Tabelle „Dokumente“ [ds_document].") | Eine oder mehrere Eigenschaften, die zu aktualisierende Dokumentlistenfelder darstellen. |
[Tabelle : 8. Parameter]

{#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}

| Typ | Beschreibung |
|-|-|
| Objekt | Erfolgs- oder Fehlermeldung. { "message": "String", "request_id": "String", "status": "String" } {#DLS-updateDocumentList_S_O__api_docserv_codeblock_dets} |
| \<Object\>.message | Meldung, die den Erfolg oder Fehler bestätigt. Datentyp: Zeichenfolge |
| \<Object\>.request_id | Sys_id des Datensatzes in der Tabelle „Dokumentlisten" \[ds_document_lists\]. Datentyp: Zeichenfolge |
| \<Object\>.status | Status, der angibt, ob der Vorgang erfolgreich ist. Mögliche Werte: * Erfolg -- Der Vorgang war erfolgreich. * Fehler -- Der Vorgang war nicht erfolgreich. message enthält Details. {#DLS-updateDocumentList_S_O__ul_rlv_5cv_j4b} Datentyp: Zeichenfolge |
[Tabelle : 9. Ergebnisse]

{#DLS-updateDocumentList_S_O__table_x4z_2cg_tpb}  
Das folgende Beispiel zeigt, wie Sie den Namen und die Beschreibung einer Dokumentliste aktualisieren. Siehe auch [Systemdokumentliste](https://servicenow-prod.fluidtopics.net/jywGT3OkqjH_jyziK~h9Iw#SystemDocumentListBothAPI "Die SystemDocumentList- API bietet Methoden zum Festlegen der Datensatzfelder in der Tabelle „Dokumentlisten“ [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));

Ausgabe:

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