DocumentReferenceService – Scoped, Global

Die DocumentReferenceService -API stellt Methoden zum Verwalten von Dokumentreferenzen in einer Zieltabelle bereit, z. B. die Tabelle „Incidents“ [incident] oder „Wissen“ [kb_knowledge]. Sie können Dokumentreferenzen verwenden, um Informationen einem Datensatz zuzuordnen.

Diese API erfordert das Plugin Document Management (com.snc.platform_document_management) und wird im Namespace sn_doc_services bereitgestellt. Weitere Informationen finden Sie unter Document Services.

Mit den folgenden APIs können Sie Dokumente definieren und verwalten:

• SystemDocument : Definieren Sie ein Dokumentobjekt.
• DocumentService : Dokument hinzufügen, aktualisieren oder löschen.

DocumentReferenceService – DocumentReferenceService()

Instantiiert ein DocumentReferenceService -Objekt.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Keine

Das folgende Beispiel zeigt, wie ein DocumentReferenceService -Objekt instanziiert wird.

var result = new sn_doc_services.DocumentReferenceService();

DocumentReferenceService – addDocumentReference(String docSysId, String targetTable, String tableSysId)

Fügt eine Dokumentreferenz zu einem Zieltabellendatensatz hinzu.

Tabelle : 2. Parameter

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 : 3. Ergebnisse

Typ	Beschreibung
Objekt	Sys_id des neuen Datensatzes in der Tabelle „Dokumentreferenzen“ [ds_document_reference] mit einer Erfolgsmeldung. Andernfalls Fehlermeldung. { "message": "String", "status": "String" }
<Object>.Nachricht	Nachricht, die Erfolg oder Fehler bestätigt. Enthält bei Erfolg die sys_id des Datensatzes, dem die Dokumentreferenz hinzugefügt wurde. Datentyp: Zeichenfolge
<Object>.Status	Status, der angibt, ob der Vorgang erfolgreich ist. Mögliche Werte: success: Der Vorgang war erfolgreich. failure – Der Vorgang war nicht erfolgreich. message enthält Details. Datentyp: Zeichenfolge

Das folgende Beispiel zeigt, wie eine Dokumentreferenz zu einem Datensatz in der Tabelle „Incidents“ [incident] hinzugefügt wird.

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 – removeDocumentReference(String docSysId, String targetTable, String tableSysId)

Entfernt eine Dokumentreferenz aus der Tabelle „Dokumentreferenzen“ [ds_document_reference].

Tabelle : 4. Parameter

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] aufgelistet.
tableSysId	Zeichenfolge	Sys_id des Datensatzes, aus dem auf das Dokument verwiesen wird. Sie finden zugehörige Informationen mit dem Dokument in der Tabelle „Dokumentreferenzen“ [ds_document_reference].

Tabelle : 5. Ergebnisse

Typ	Beschreibung
Objekt	Erfolgsmeldung. Andernfalls Fehlermeldung. { "message": "String", "status": "String" }
<Object>.Nachricht	Nachricht, die Erfolg oder Fehler bestätigt. Enthält bei Erfolg die sys_id des Datensatzes, aus dem die Dokumentreferenz entfernt wurde. Datentyp: Zeichenfolge
<Object>.Status	Status, der angibt, ob der Vorgang erfolgreich ist. Mögliche Werte: success: Der Vorgang war erfolgreich. failure – Der Vorgang war nicht erfolgreich. message enthält Details. Datentyp: Zeichenfolge

Das folgende Beispiel zeigt, wie eine Dokumentreferenz aus einem Datensatz in der Tabelle „Incidents“ [incident] entfernt wird.

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