--- 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 --- # DocumentService: Bereichsbezogen, Global # DocumentService: Bereichsbezogen, Global {#ariaid-title1} * Freigeben Version: Xanadu * * Aktualisiert 1. August 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 Minuten Lesedauer Die DocumentService -API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments. 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). Ein Dokument ist eine Sammlung von Informationen zu einem Dokumentdatensatz. Die zum Erstellen oder Aktualisieren eines Datensatzes verwendeten Methoden ändern Felder mithilfe des [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].") Objekts. Dokumentinhalte werden mithilfe von Versionen verwaltet. Mit den folgenden APIs können Sie Dokumentversionen definieren und verwalten: * [SystemDocumentVersion](https://servicenow-prod.fluidtopics.net/CzmiMuavJBLXjP3LP_FWYQ#SystemDocumentVersionBothAPI "Die SystemDocumentVersion- API bietet Methoden zum Festlegen der Werte der Quellversion eines Dokuments in der Versionstabelle [ds_document_version].") : Definiert eine Dokumentversion als Quelle des Dokumentinhalts. Jede Version ist ein Element, das den Dokumentinhalt enthält und über eine einzelne URL oder einen Anhang bereitgestellt wird. Ein Anhang kann nur in der UI der Tabelle „Dokumentversionen" \[ds_document_version\] und nicht mit der API hinzugefügt werden. * [DocumentVersionService](https://servicenow-prod.fluidtopics.net/PJiPfaBRF44iAp8cJq3EaQ#DocumentVersionServiceBothAPI "Die DocumentVersionService -API bietet einen Service zum Erstellen und Löschen von Dokumentversionen. Jede Version ist ein Element, das den Dokumentinhalt enthält und über eine einzelne URL oder einen Anhang bereitgestellt wird. Ein Anhang kann nur in der UI der Tabelle „Dokumentversionen“ [ds_document_version] und nicht mit der API hinzugefügt werden.") : Dokumentinhalte werden mithilfe von Versionen verwaltet. {#DocumentServiceBothAPI__ul_krc_vmf_vpb} Verwenden Sie die [DocumentReferenceService](https://servicenow-prod.fluidtopics.net/8_bXa_mSS4OdPE2KZPS7Dg#DocumentReferenceServiceBothAPI "Die DocumentReferenceService -API bietet Methoden zum Verwalten von Dokumentreferenzen in einer Zieltabelle, z. B. die Tabelle „Incidents“ [incident] oder „Wissen“ [kb_knowledge]. Sie können Dokumentreferenzen verwenden, um einem Datensatz Informationen zuzuordnen.") -API zum Verwalten von Dokumenten, auf die in einer Zieltabelle verwiesen wird, z. B. in der Tabelle „Incidents" \[incident\] oder „Wissen" \[kb_knowledge\]. 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. * [SystemDocumentList](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].") : Definieren Sie eine Liste von Dokumentvorlagen. * [DocumentListService](https://servicenow-prod.fluidtopics.net/Jq8a_9xM4~t91kkthXF5_w#DocumentListServiceBothAPI "Die DocumentListService -API bietet Methoden zum Erstellen, Löschen und Aktualisieren einer Dokumentliste.") : Hinzufügen oder Entfernen einer Dokumentvorlagenliste. * [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. {#DocumentServiceBothAPI__ul_asn_gjg_vpb} ## DocumentService: DocumentService() {#ariaid-title2} Instanziiert ein 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 DocumentService -Objekt instanziiert wird. var s = new sn_doc_services.DocumentService(); ## DocumentService -- createDocument(SystemDocument doc) {#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/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 Felder eines neuen Datensatzes darstellen. Die Eigenschaft „name" ist erforderlich und kann mit dem SystemDocument- Konstruktor oder der name()- Methode festgelegt werden. | [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. Andernfalls Fehlermeldung. { "message": "String", "request_id": "String", "status": "String" } | | \.message | Meldung, die den Erfolg oder Fehler bestätigt. Mögliche Werte: * Sys-ID für Dokument erstellen:\ ist erfolgreich. * „Dokumentname" ist obligatorisch und muss gültig sein. * Der Dokumentname ist obligatorisch und darf nicht NULL oder leer sein. * \<[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].") Eigenschaft, die sys_id-Eingabe erfordert\> mit SysId: „\ „" ist nicht vorhanden {#DocumentService-createDocument_O__ul_hwn_lbh_tpb} Datentyp: Zeichenfolge | | \.request_id | Sys_id des Datensatzes in der Tabelle „Dokumente" \[ds_document\]. Datentyp: Zeichenfolge | | \.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. {#DocumentService-createDocument_O__ul_rlv_5cv_j4b} Datentyp: Zeichenfolge | [Tabelle : 3. Ergebnisse] {#DocumentService-createDocument_O__table_tj4_p5j_34b} Das folgende Beispiel zeigt, wie Sie SystemDocument- Objekteigenschaften ausfüllen und einen neuen Dokumentdatensatz erstellen. 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(String 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} | | \.message | Meldung, die den Erfolg oder Fehler bestätigt. Datentyp: Zeichenfolge | | \.request_id | Sys_id des Datensatzes in der Tabelle „Dokumente" \[ds_document\]. Datentyp: Zeichenfolge | | \.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. {#DocumentService-deleteDocument_S__ul_rlv_5cv_j4b} Datentyp: Zeichenfolge | [Tabelle : 5. Ausgabe] {#DocumentService-deleteDocument_S__table_x4z_2cg_tpb} Das folgende Beispiel zeigt, wie ein vorhandener Dokumentdatensatz gelöscht wird. var docid = ""; var svc = new sn_doc_services.DocumentService(); gs.info(JSON.stringify(svc.deleteDocument(docid), null, 2)); Ausgabe: { "message": "Delete document sysId : is successful.", "request_id": "", "status": "success" } ## DocumentService -- updateDocument(String docSysId, SystemDocument doc) {#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/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 Dokumentfelder darstellen. | [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} | | \.message | Meldung, die den Erfolg oder Fehler bestätigt. Datentyp: Zeichenfolge | | \.request_id | Sys_id des Datensatzes in der Tabelle „Dokumente" \[ds_document\]. Datentyp: Zeichenfolge | | \.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. {#DocumentService-updateDocument_S_O__ul_rlv_5cv_j4b} Datentyp: Zeichenfolge | [Tabelle : 7. Ergebnisse] {#DocumentService-updateDocument_S_O__table_x4z_2cg_tpb} Das folgende Beispiel zeigt, wie Sie einen Dokumentnamen ändern. Siehe auch [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]."). 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" }