---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# DocumentListService: Bereichsbezogen, global

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

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 Minuten Lesedauer

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

Diese API erfordert DokumentverwaltungPlugin (com.snc.platform_document_management) und wird in bereitgestellt `sn_doc_Services `Namespace. Informationen finden Sie unter [Dokumentservices](https://www.servicenow.com/docs/access?context=document-services-landing-page&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US).  
Die DokumentverwaltungDas Plugin unterstützt auch das Erstellen von Listen von Dokumentvorlagen, die Ihrem Dokument zugeordnet werden sollen. Beispiel: Eine Bewerbung, die mehrere Dokumente wie Diplom, Personalausweis oder Reisepass erfordert. Nachdem Sie Ihre Dokumentliste hinzugefügt haben, können Sie Dokumentvorlagen hinzufügen:

* [SystemDocumentListEintrag](https://servicenow-prod.fluidtopics.net/s7qz0sueVDQgdd85KylMYw#SystemDocumentListEntryBothAPI "Die SystemDocumentListEintrag Die API bietet Methoden zum Festlegen der Datensatzfelder in der Tabelle „Dokumentlisteneinträge“ [ds_document_list_entry].")-- Definieren Sie einen Listeneintrag für eine Dokumentvorlage.
* [DocumentListEntryService](https://servicenow-prod.fluidtopics.net/~HUzBBKvVBcP~vWYv~S71g#DocumentListEntryServiceBothAPI "Die DocumentListEntryService Die 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 festlegen [Systemdokument -- Vorlage()](https://servicenow-prod.fluidtopics.net/TbmTybFy91fR9ZQugSmgFw#SystemDoc-template_S "Gibt an, ob ein Dokumentdatensatz eine Vorlage ist.")Methode auf „wahr". Erstellen oder aktualisieren Sie den Dokumentdatensatz mit den Methoden in [DocumentService](https://servicenow-prod.fluidtopics.net/_goxCLzTWhfVJff2X~tfJQ#DocumentServiceBothAPI "Die DocumentService Die 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:

* [Systemdokument](https://servicenow-prod.fluidtopics.net/TbmTybFy91fR9ZQugSmgFw#SystemDocumentBothAPI "Die Systemdokument Die API bietet Methoden zum Festlegen von Feldern eines Datensatzes in der Tabelle „Dokumente“ [ds_document].")-- Definieren Sie ein Dokumentobjekt.
* [DocumentService](https://servicenow-prod.fluidtopics.net/_goxCLzTWhfVJff2X~tfJQ#DocumentServiceBothAPI "Die DocumentService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.")-- 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 festlegen [Systemdokument -- Vorlage()](https://servicenow-prod.fluidtopics.net/TbmTybFy91fR9ZQugSmgFw#SystemDoc-template_S "Gibt an, ob ein Dokumentdatensatz eine Vorlage ist.")Methode auf „wahr". Erstellen oder aktualisieren Sie den Dokumentdatensatz mit den Methoden in [DocumentService](https://servicenow-prod.fluidtopics.net/_goxCLzTWhfVJff2X~tfJQ#DocumentServiceBothAPI "Die DocumentService Die 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__d3346e144}

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

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

Instanziiert einen 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 instanziiert wird DocumentListService Objekt. Siehe auch [Systemdokumentliste](https://servicenow-prod.fluidtopics.net/sDbBROjGSE7QMdf0P2FHKA#SystemDocumentListBothAPI "Die Systemdokumentliste Die API bietet Methoden zum Festlegen der Datensatzfelder in der Tabelle „Dokumentlisten“ [ds_document_lists].").

    var s = new sn_doc_services.DocumentListService();

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

Erstellt eine Dokumentliste in der Tabelle „Dokumentlisten" \[ds_document_lists\].
Die DokumentverwaltungDas Plugin unterstützt auch das Erstellen von Listen von Dokumentvorlagen, die Ihrem Dokument zugeordnet werden sollen. Beispiel: Eine Bewerbung, die mehrere Dokumente wie Diplom, Personalausweis oder Reisepass erfordert. Nachdem Sie Ihre Dokumentliste hinzugefügt haben, können Sie Dokumentvorlagen hinzufügen:

* [SystemDocumentListEintrag](https://servicenow-prod.fluidtopics.net/s7qz0sueVDQgdd85KylMYw#SystemDocumentListEntryBothAPI "Die SystemDocumentListEintrag Die API bietet Methoden zum Festlegen der Datensatzfelder in der Tabelle „Dokumentlisteneinträge“ [ds_document_list_entry].")-- Definieren Sie einen Listeneintrag für eine Dokumentvorlage.
* [DocumentListEntryService](https://servicenow-prod.fluidtopics.net/~HUzBBKvVBcP~vWYv~S71g#DocumentListEntryServiceBothAPI "Die DocumentListEntryService Die 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 [CreateDocumentsFromList()](https://servicenow-prod.fluidtopics.net/zjZrSUpgPqD3L1SsUDDtZg#DLS-createDocumentsFromList_S_S_S "Erstellt Dokumente aus einer Liste von Dokumentvorlagen.")Methode zum Erstellen von Dokumenten aus der Dokumentvorlagenliste.
{#DLS-createDocumentList_O__table_w4z_2cg_tpb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| doc | [Systemdokumentliste](https://servicenow-prod.fluidtopics.net/sDbBROjGSE7QMdf0P2FHKA#SystemDocumentListBothAPI "Die Systemdokumentliste Die API bietet Methoden zum Festlegen der Datensatzfelder in der Tabelle „Dokumentlisten“ [ds_document_lists].") | Mindestens eine Eigenschaft, die Felder eines neuen Datensatzes darstellt. Die Namenseigenschaft ist erforderlich und kann mit festgelegt werden Systemdokumentliste Konstruktor oder Name() Methode. |
[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. Fehlermeldung andernfalls. { "message": "String", "request_id": "String", "status": "String" } |
| \<Object\>.Nachricht | Nachricht, die 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. Die messageStellt Details bereit. {#DLS-createDocumentList_O__ul_rlv_5cv_j4b} Datentyp: Zeichenfolge |
[Tabelle : 3. Rückgaben]

{#DLS-createDocumentList_O__table_tj4_p5j_34b}  
Das folgende Beispiel zeigt, wie eine Dokumentliste erstellt wird. Siehe auch [Systemdokumentliste](https://servicenow-prod.fluidtopics.net/sDbBROjGSE7QMdf0P2FHKA#SystemDocumentListBothAPI "Die Systemdokumentliste Die 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 [CreateDocumentList()](https://servicenow-prod.fluidtopics.net/zjZrSUpgPqD3L1SsUDDtZg#DLS-createDocumentList_O "Erstellt eine Dokumentliste in der Tabelle „Dokumentlisten“ [ds_document_lists].")Methode.
{#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, die den Datensatz enthält, 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\>.Nachricht | 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. Die messageStellt Details bereit. {#DLS-createDocumentsFromList_S_S_S__ul_rlv_5cv_j4b} Datentyp: Zeichenfolge |
[Tabelle : 5. Rückgaben]

{#DLS-createDocumentsFromList_S_S_S__table_tj4_p5j_34b}  
Das folgende Beispiel zeigt, wie einem Datensatz eine Liste von Dokumentvorlagenreferenzen hinzugefügt wird. 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\>.Nachricht | Nachricht, die 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. Die messageStellt Details bereit. {#DLS-deleteDocumentList_S__ul_rlv_5cv_j4b} Datentyp: Zeichenfolge |
[Tabelle : 7. Rückgaben]

{#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/sDbBROjGSE7QMdf0P2FHKA#SystemDocumentListBothAPI "Die Systemdokumentliste Die 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(Zeichenfolge docSysId, SystemDocumentList-Dokument) {#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/TbmTybFy91fR9ZQugSmgFw#SystemDocumentBothAPI "Die Systemdokument Die API bietet Methoden zum Festlegen von Feldern eines Datensatzes in der Tabelle „Dokumente“ [ds_document].") | Mindestens eine Eigenschaft, die Dokumentlistenfelder darstellt, die aktualisiert werden sollen. |
[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\>.Nachricht | Nachricht, die 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. Die messageStellt Details bereit. {#DLS-updateDocumentList_S_O__ul_rlv_5cv_j4b} Datentyp: Zeichenfolge |
[Tabelle : 9. Rückgaben]

{#DLS-updateDocumentList_S_O__table_x4z_2cg_tpb}  
Das folgende Beispiel zeigt, wie der Name und die Beschreibung einer Dokumentliste aktualisiert werden. Siehe auch [Systemdokumentliste](https://servicenow-prod.fluidtopics.net/sDbBROjGSE7QMdf0P2FHKA#SystemDocumentListBothAPI "Die Systemdokumentliste Die 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"
    }


