DocumentService – Scoped, Global

Die DocumentService -API stellt Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments bereit.

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.

Ein Dokument ist eine Sammlung von Informationen zu einem Dokumentdatensatz. Die zum Erstellen oder Aktualisieren eines Datensatzes verwendeten Methoden ändern Felder mit dem SystemDocument- Objekt.

Dokumentinhalte werden mithilfe von Versionen verwaltet. Mit den folgenden APIs können Sie Dokumentversionen definieren und verwalten:

• SystemDocumentVersion : Definieren Sie 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 Benutzeroberfläche der Tabelle „Dokumentversionen“ [ds_document_version] und nicht mit der API hinzugefügt werden.
• DocumentVersionService : Dokumentinhalte werden mithilfe von Versionen verwaltet.

Verwenden Sie die DocumentReferenceService -API, um Dokumente zu verwalten, auf die in einer Zieltabelle verwiesen wird, z. B. die Tabelle „Incidents“ [incident] oder „Wissen“ [kb_knowledge].

Das Plugin Document Management unterstützt auch das Erstellen von Listen von Dokumentvorlagen, die Ihrem Dokument zugeordnet werden sollen. Zum Beispiel eine Bewerbung, die mehrere Dokumente erfordert, z. B. ein Diplom, einen Personalausweis oder einen Reisepass.

• SystemDocumentList : Definieren Sie eine Liste von Dokumentvorlagen.
• DocumentListService : Dokumentvorlagenliste hinzufügen oder entfernen.
• SystemDocumentListEntry : Definieren Sie einen Dokumentvorlagen-Listeneintrag.
• DocumentListEntryService : Dokumentvorlagen-Listeneintrag hinzufügen oder entfernen.

DocumentService – DocumentService()

Instantiiert ein DocumentService -Objekt.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Keine

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

var s = new sn_doc_services.DocumentService();

DocumentService – createDocument(SystemDocument doc)

Erstellt einen Dokumentdatensatz in der Dokumenttabelle [ds_document].

Tabelle : 2. Parameter

Name	Typ	Beschreibung
doc	Systemdokument	Eine oder mehrere Eigenschaften, die Felder eines neuen Datensatzes darstellen. Die name-Eigenschaft ist erforderlich und kann mit dem SystemDocument- Konstruktor oder der name()- Methode festgelegt werden.

Tabelle : 3. Ergebnisse

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" }
<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. <SystemDocument- Eigenschaft, die sys_id-Eingabe erfordert> mit SysId: "<sys_id> „“ ist nicht vorhanden Datentyp: Zeichenfolge
<Object>.request_id	Sys_id des Datensatzes in der Dokumenttabelle [ds_document]. 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 SystemDocument- Objekteigenschaften ausgefüllt und ein neuer Dokumentdatensatz erstellt werden.

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)

Entfernt einen Dokumentdatensatz aus der Dokumenttabelle [ds_document].

Tabelle : 4. Parameter

Name	Typ	Beschreibung
docSysId	Zeichenfolge	Sys_id eines Dokumentdatensatzes in der Tabelle „Dokumente“ [ds_document].

Tabelle : 5. Ausgabe

Typ	Beschreibung
Objekt	Erfolgs- oder Fehlermeldung. { "message": "String", "request_id": "String", "status": "String" }
<Object>.Nachricht	Nachricht, die Erfolg oder Fehler bestätigt. Datentyp: Zeichenfolge
<Object>.request_id	Sys_id des Datensatzes in der Dokumenttabelle [ds_document]. 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 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(String docSysId, SystemDocument doc)

Aktualisiert die Feldwerte eines vorhandenen Dokumentdatensatzes.

Tabelle : 6. Parameter

Name	Typ	Beschreibung
docSysId	Zeichenfolge	Sys_id eines Dokumentdatensatzes in der Tabelle „Dokumente“ [ds_document].
doc	Systemdokument	Eine oder mehrere Eigenschaften, die zu aktualisierende Dokumentfelder darstellen.

Tabelle : 7. Ergebnisse

Typ	Beschreibung
Objekt	Erfolgs- oder Fehlermeldung. { "message": "String", "request_id": "String", "status": "String" }
<Object>.Nachricht	Nachricht, die Erfolg oder Fehler bestätigt. Datentyp: Zeichenfolge
<Object>.request_id	Sys_id des Datensatzes in der Dokumenttabelle [ds_document]. 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 ein Dokumentname geändert wird. Siehe auch SystemDocument.

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