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


---

# DocumentService: Bereichsbezogen, global

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

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

Die DocumentService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.

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

Ein Dokument ist eine Sammlung von Informationen zu einem Dokumentdatensatz. Die Methoden, die zum Erstellen oder Aktualisieren von Datensatzänderungsfeldern mit verwendet werden [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].")Objekt.  
Dokumentinhalt wird mit Versionen verwaltet. Mit den folgenden APIs können Sie Dokumentversionen definieren und verwalten:

* [SystemdokumentVersion](https://servicenow-prod.fluidtopics.net/Kllhw_M6oOHp9V5rwAy1hQ#SystemDocumentVersionBothAPI "Die SystemdokumentVersion Die API bietet Methoden zum Festlegen der Werte der Quellversion eines Dokuments in der Tabelle „Versionen“ [ds_document_Version].")-- Definieren Sie eine Dokumentversion als Quelle des Dokumentinhalts. Jede Version ist ein Element, das den Dokumentinhalt enthält und wird mithilfe einer einzelnen URL oder eines einzelnen Anhangs bereitgestellt. Ein Anhang kann nur in der Tabellen-UI „Dokumentversionen" \[ds_document_Version\] und nicht mit der API hinzugefügt werden.
* [DocumentVersionService](https://servicenow-prod.fluidtopics.net/M7FhlAVg1QqKrJLOgaXywQ#DocumentVersionServiceBothAPI "Die DocumentVersionService Die API bietet einen Service zum Erstellen und Löschen von Dokumentversionen. Jede Version ist ein Element, das den Dokumentinhalt enthält und wird mithilfe einer einzelnen URL oder eines einzelnen Anhangs bereitgestellt. Ein Anhang kann nur in der Tabellen-UI „Dokumentversionen“ [ds_document_Version] und nicht mit der API hinzugefügt werden.")-- Dokumentinhalt wird mit Versionen verwaltet.
{#DocumentServiceBothAPI__ul_krc_vmf_vpb}

Verwenden Sie [DocumentReferenceService](https://servicenow-prod.fluidtopics.net/ndE2PFAz3x2_5ycTXLGx3g#DocumentReferenceServiceBothAPI "Die DocumentReferenceService Die API bietet Methoden zum Verwalten von Dokumentreferenzen innerhalb einer Zieltabelle, z. B. die Tabelle „Incidents“ [Incident] oder „Wissen“ [kb_Knowledge]. Sie können Dokumentreferenzen verwenden, um Informationen einem Datensatz zuzuordnen.")API zum Verwalten von Dokumenten, auf die in einer Zieltabelle verwiesen wird, z. B. die Tabelle „Incidents" \[Incident\] oder „Wissen" \[kb_Knowledge\].  
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.

* [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].")-- Definieren Sie eine Liste von Dokumentvorlagen.
* [DocumentListService](https://servicenow-prod.fluidtopics.net/zjZrSUpgPqD3L1SsUDDtZg#DocumentListServiceBothAPI "Die DocumentListService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren einer Dokumentliste.")-- Hinzufügen oder Entfernen einer Dokumentvorlagenliste.
* [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.
{#DocumentServiceBothAPI__ul_asn_gjg_vpb}

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

Instanziiert einen DocumentService Objekt.
{#DocumentService-DocumentService__table_zw5_mcg_tpb__entry__3}

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

{#DocumentService-DocumentService__table_zw5_mcg_tpb}  
Das folgende Beispiel zeigt, wie ein instanziiert wird DocumentService Objekt.

    var s = new sn_doc_services.DocumentService();

## DocumentService -- createDocument(SystemDocument-Dokument) {#ariaid-title3}

Erstellt einen Dokumentdatensatz in der Tabelle „Dokumente" \[ds_document\].
{#DocumentService-createDocument_O__table_w4z_2cg_tpb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| 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 Felder eines neuen Datensatzes darstellt. Die Namenseigenschaft ist erforderlich und kann mit festgelegt werden Systemdokument Konstruktor oder Name() Methode. |
[Tabelle : 2. Parameter]

{#DocumentService-createDocument_O__table_w4z_2cg_tpb} {#DocumentService-createDocument_O__table_tj4_p5j_34b__entry__2}{#DocumentService-createDocument_O__row_pdfgen_ret_msgCnv}

| Typ | Beschreibung |
|-|-|
| Objekt | SYS_ID des neuen Datensatzes in der Tabelle „Dokumente" \[ds_document\] mit einer Erfolgsmeldung. Fehlermeldung andernfalls. { "message": "String", "request_id": "String", "status": "String" } |
| \<Object\>.Nachricht | Nachricht, die Erfolg oder Fehler bestätigt. Mögliche Werte: * SysId des Dokuments erstellen: \<sys_id\> ist erfolgreich. * Dokumentname ist obligatorisch und muss gültig sein. * Dokumentname ist obligatorisch und darf nicht null oder leer sein. * \< [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].")Eigenschaft, die die Eingabe „sys_ID" erfordert, mit der SYS-ID „\<sys_id\>" ist nicht vorhanden {#DocumentService-createDocument_O__ul_hwn_lbh_tpb} Datentyp: Zeichenfolge |
| \<Object\>.Request_ID | SYS_ID des Datensatzes in der Tabelle „Dokumente" \[ds_document\]. 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. {#DocumentService-createDocument_O__ul_rlv_5cv_j4b} Datentyp: Zeichenfolge |
[Tabelle : 3. Rückgaben]

{#DocumentService-createDocument_O__table_tj4_p5j_34b}  
Das folgende Beispiel zeigt, wie ausgefüllt wird Systemdokument Objekteigenschaften, und erstellen Sie einen neuen Dokumentdatensatz.

    var d = new sn_doc_services.SystemDocument('My document');

    // Define the document fields
    var reviewers = '62826bf03710200044e0bfc8bcbe5df1,a8f98bb0eb32010045e1a5115206fe3a';
    d.description('description');
    d.classification('restricted');
    d.state('review');
    d.department('93b25282c0a8000b0b55c8ab34e2f1e6');
    d.template(false);
    d.type('policy');
    d.reviewers(reviewers);
    d.audience('external');

    var s = new sn_doc_services.DocumentService();
    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Ausgabe:

    {
      "message": "Create document sysId : 1040420224503410f877a6fed1c2b031 is successful.",
      "request_id": "1040420224503410f877a6fed1c2b031",
      "status": "success"
    }

## DocumentService -- deleteDocument(Zeichenfolge docSysId) {#ariaid-title4}

Entfernt einen Dokumentdatensatz aus der Tabelle „Dokumente" \[ds_document\].
{#DocumentService-deleteDocument_S__table_w4z_2cg_tpb__entry__3}{#DocumentService-deleteDocument_S__ph_docserv_parm_docID}

| Name | Typ | Beschreibung |
|-|-|-|
| DocSysId | Zeichenfolge | SYS_ID eines Dokumentdatensatzes in der Tabelle „Dokumente" \[ds_document\]. |
[Tabelle : 4. Parameter]

{#DocumentService-deleteDocument_S__table_w4z_2cg_tpb} {#DocumentService-deleteDocument_S__table_x4z_2cg_tpb__entry__2}{#DocumentService-deleteDocument_S__ph-docserv-ret-obj-basic}

| Typ | Beschreibung |
|-|-|
| Objekt | Erfolgs- oder Fehlermeldung. { "message": "String", "request_id": "String", "status": "String" } {#DocumentService-deleteDocument_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 „Dokumente" \[ds_document\]. 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. {#DocumentService-deleteDocument_S__ul_rlv_5cv_j4b} Datentyp: Zeichenfolge |
[Tabelle : 5. Rückgaben]

{#DocumentService-deleteDocument_S__table_x4z_2cg_tpb}  
Das folgende Beispiel zeigt, wie ein vorhandener Dokumentdatensatz gelöscht wird.

    var docid = "<sys_id>";
    var svc = new sn_doc_services.DocumentService();
    gs.info(JSON.stringify(svc.deleteDocument(docid), null, 2));

Ausgabe:

    {
      "message": "Delete document sysId : <sys_id> is successful.",
      "request_id": "<sys_id>",
      "status": "success"
    }

## DocumentService -- updateDocument(Zeichenfolge docSysId, SystemDocument-Dokument) {#ariaid-title5}

Aktualisiert die Feldwerte eines vorhandenen Dokumentdatensatzes.
{#DocumentService-updateDocument_S_O__table_w4z_2cg_tpb__entry__3}{#DocumentService-updateDocument_S_O__ph_docserv_parm_docID}

| Name | Typ | Beschreibung |
|-|-|-|
| DocSysId | Zeichenfolge | SYS_ID eines Dokumentdatensatzes in der Tabelle „Dokumente" \[ds_document\]. |
| 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 Dokumentfelder darstellt, die aktualisiert werden sollen. |
[Tabelle : 6. Parameter]

{#DocumentService-updateDocument_S_O__table_w4z_2cg_tpb} {#DocumentService-updateDocument_S_O__table_x4z_2cg_tpb__entry__2}{#DocumentService-updateDocument_S_O__ph-docserv-ret-obj-basic}

| Typ | Beschreibung |
|-|-|
| Objekt | Erfolgs- oder Fehlermeldung. { "message": "String", "request_id": "String", "status": "String" } {#DocumentService-updateDocument_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 „Dokumente" \[ds_document\]. 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. {#DocumentService-updateDocument_S_O__ul_rlv_5cv_j4b} Datentyp: Zeichenfolge |
[Tabelle : 7. Rückgaben]

{#DocumentService-updateDocument_S_O__table_x4z_2cg_tpb}  
Das folgende Beispiel zeigt, wie ein Dokumentname geändert wird. Siehe auch [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].").

    var dId = "19aab54e24103410f877a6fed1c2b03d";
    var d = new sn_doc_services.SystemDocument();
    d.name("c22.txt");

    var s = new sn_doc_services.DocumentService();
    gs.info(JSON.stringify(s.updateDocument(dId, d), null, 2));

Ausgabe:

    {
      "message": "Update document sysId : 19aab54e24103410f877a6fed1c2b03d is successful.",
      "request_id": "19aab54e24103410f877a6fed1c2b03d",
      "status": "success"
    }


