DocumentReferenceService: Bereichsbezogen, Global

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.

Diese API erfordert Dokumentverwaltung Plugin (com.snc.platform_document_management) und wird in bereitgestellt sn_doc_Services Namespace. Informationen finden Sie unter Dokumentservices .

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

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

DocumentReferenceService: DocumentReferenceService()

Instanziiert einen DocumentReferenceService Objekt.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Keine

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

var result = new sn_doc_services.DocumentReferenceService();

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

Fügt einem Zieltabellendatensatz eine Dokumentreferenz 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. Rückgaben

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. Wenn erfolgreich, wird die sys_ID des Datensatzes hinzugefügt, 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. Die messageStellt Details bereit. Datentyp: Zeichenfolge

Das folgende Beispiel zeigt, wie einem Datensatz in der Tabelle „Incidents“ [Incident] eine Dokumentreferenz 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(Zeichenfolge docSysId, Zeichenfolge targetTable, Zeichenfolge 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 zusammen 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 aufgeführt sind, finden Sie in der Tabelle „Dokumentreferenzen“ [ds_document_reference].

Tabelle : 5. Rückgaben

Typ	Beschreibung
Objekt	Erfolgsmeldung. Andernfalls Fehlermeldung. { "message": "String", "status": "String" }
<Object>.Nachricht	Nachricht, die Erfolg oder Fehler bestätigt. Wenn erfolgreich, wird die sys_ID des Datensatzes hinzugefügt, 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. Die messageStellt Details bereit. Datentyp: Zeichenfolge

Das folgende Beispiel zeigt, wie Sie eine Dokumentreferenz aus einem Datensatz in der Tabelle „Incidents“ [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"
}