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


---

# DocumentReferenceService: Bereichsbezogen, global

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

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

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.

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).  
Mit den folgenden APIs können Sie Dokumente definieren und verwalten:

* [SystemDocument](https://www.servicenow.com/docs/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://www.servicenow.com/docs/dvWj1BRuOQubJ9bw84l_Ug#DocumentServiceBothAPI "Die DocumentService -API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.") : Ein Dokument hinzufügen, aktualisieren oder löschen.
{#DocumentReferenceServiceBothAPI__ul_krc_vmf_vpb}

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

Instanziiert ein DocumentReferenceService -Objekt.
{#DRS-DocumentReferenceService__table_zw5_mcg_tpb__entry__3}

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

{#DRS-DocumentReferenceService__table_zw5_mcg_tpb}  
Das folgende Beispiel zeigt, wie ein DocumentReferenceService -Objekt instanziiert wird.

    var result = new sn_doc_services.DocumentReferenceService();

## DocumentReferenceService -- addDocumentReference(Zeichenfolge docSysId, Zeichenfolge targetTable, Zeichenfolge tableSysId) {#ariaid-title3}

Fügt einem Zieltabellendatensatz eine Dokumentreferenz hinzu.
{#DRS-addDocumentReference_S_S_S__table_w4z_2cg_tpb__entry__3}{#DRS-addDocumentReference_S_S_S__ph_docserv_parm_docID}

| Name | Typ | Beschreibung |
|-|-|-|
| docSysId | Zeichenfolge | Sys_id eines Dokumentdatensatzes in der Tabelle „Dokumente" \[ds_document\]. |
| targetTable | Zeichenfolge | Name der Zieltabelle, für die eine Dokumentreferenz bereitgestellt werden soll. |
| tableSysId | Zeichenfolge | Sys_id des Zieltabellendatensatzes, dem die Dokumentreferenz hinzugefügt werden soll. |
[Tabelle : 2. Parameter]

{#DRS-addDocumentReference_S_S_S__table_w4z_2cg_tpb} {#DRS-addDocumentReference_S_S_S__table_x4z_2cg_tpb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Sys_id des neuen Datensatzes in der Tabelle „Dokumentreferenzen" \[ds_document_reference\] mit einer Erfolgsmeldung. Andernfalls Fehlermeldung. { "message": "String", "status": "String" } {#DRS-addDocumentReference_S_S_S__api_docserv_codeblock_dets} |
| \<Object\>.message | Meldung, die den Erfolg oder Fehler bestätigt. Bei Erfolg wird die sys_id des Datensatzes einbezogen, dem die Dokumentreferenz hinzugefügt wurde. 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. {#DRS-addDocumentReference_S_S_S__ul_rlv_5cv_j4b} Datentyp: Zeichenfolge |
[Tabelle : 3. Ergebnisse]

{#DRS-addDocumentReference_S_S_S__table_x4z_2cg_tpb}  
Das folgende Beispiel zeigt, wie Sie einem Datensatz in der Tabelle „Incidents" \[incident\] eine Dokumentreferenz hinzufügen.

    var docReference = new sn_doc_services.DocumentReferenceService();

    var result = docReference.addDocumentReference("<docSysId>", "incident", "<tableSysId>");

    gs.info(JSON.stringify(result, null, 2));

Ausgabe:

    {
      "message": "Adding an entry to DocumentReference for the given docId to target table : incident, sysId : <tableSysId> is successful.",
      "status": "success"
    }

## DocumentReferenceService -- entfernenDokumentReferenz(Zeichenfolge docSysId, Zeichenfolge targetTable, Zeichenfolge tableSysId) {#ariaid-title4}

Entfernt eine Dokumentreferenz aus der Tabelle „Dokumentreferenzen" \[ds_document_reference\].
{#DRS-removeDocumentReference_S_S_S__table_w4z_2cg_tpb__entry__3}{#DRS-removeDocumentReference_S_S_S__ph_docserv_parm_docID}

| Name | Typ | Beschreibung |
|-|-|-|
| docSysId | Zeichenfolge | Sys_id eines Dokumentdatensatzes in der Tabelle „Dokumente" \[ds_document\]. |
| targetTable | Zeichenfolge | Name der Tabelle, die die Dokumentreferenz enthält. Diese Informationen werden mit dem Dokument in der Tabelle „Dokumentreferenzen" \[ds_document_reference\] aufgeführt. |
| tableSysId | Zeichenfolge | Sys_id des Datensatzes, aus dem auf das Dokument verwiesen wird. Zugehörige Informationen, die mit dem Dokument in der Tabelle „Dokumentreferenzen" \[ds_document_reference\] aufgeführt sind. |
[Tabelle : 4. Parameter]

{#DRS-removeDocumentReference_S_S_S__table_w4z_2cg_tpb} {#DRS-removeDocumentReference_S_S_S__table_x4z_2cg_tpb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Erfolgsmeldung. Andernfalls Fehlermeldung. { "message": "String", "status": "String" } {#DRS-removeDocumentReference_S_S_S__api_docserv_codeblock_dets} |
| \<Object\>.message | Meldung, die den Erfolg oder Fehler bestätigt. Bei Erfolg wird die sys_id des Datensatzes einbezogen, aus dem die Dokumentreferenz entfernt wurde. 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. {#DRS-removeDocumentReference_S_S_S__ul_rlv_5cv_j4b} Datentyp: Zeichenfolge |
[Tabelle : 5. Ergebnisse]

{#DRS-removeDocumentReference_S_S_S__table_x4z_2cg_tpb}  
Das folgende Beispiel zeigt, wie Sie eine Dokumentreferenz aus einem Datensatz in der Incident-Tabelle \[Incident\] entfernen.

    var docReference = new sn_doc_services.DocumentReferenceService();

    var result = docReference.removeDocumentReference("<docSysId>", "incident", "<tableSysId>");

    gs.info(JSON.stringify(result, null, 2));

Ausgabe:

    {
      "message": "Deleting an entry to DocumentReference for the given docId to target table : incident, sysId : <tableSysId> is successful.",
      "status": "success"
    }