DocumentService: Bereichsbezogen, Global

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.

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

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

• SystemDocumentVersion : 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 : Dokumentinhalte werden mithilfe von Versionen verwaltet.

Verwenden Sie die DocumentReferenceService -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 : Definieren Sie eine Liste von Dokumentvorlagen.
• DocumentListService : Hinzufügen oder Entfernen einer Dokumentvorlagenliste.
• SystemDocumentListEntry : Definiert einen Dokumentvorlagenlisteneintrag.
• DocumentListEntryService : Hinzufügen oder Entfernen eines Dokumentvorlagenlisteneintrags.

DocumentService: DocumentService()

Instanziiert 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 Tabelle „Dokumente“ [ds_document].

Tabelle : 2. Parameter

Name	Typ	Beschreibung
doc	Systemdokument	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 : 3. Rückgaben

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>.message	Meldung, die den Erfolg oder Fehler bestätigt. Mögliche Werte: Sys-ID für Dokument erstellen:<sys_id> ist erfolgreich. „Dokumentname“ ist obligatorisch und muss gültig sein. Der 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 Tabelle „Dokumente“ [ds_document]. 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. Datentyp: Zeichenfolge

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)

Entfernt einen Dokumentdatensatz aus der Tabelle „Dokumente“ [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>.message	Meldung, die den Erfolg oder Fehler bestätigt. Datentyp: Zeichenfolge
<Object>.request_id	Sys_id des Datensatzes in der Tabelle „Dokumente“ [ds_document]. 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. 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. Rückgaben

Typ	Beschreibung
Objekt	Erfolgs- oder Fehlermeldung. { "message": "String", "request_id": "String", "status": "String" }
<Object>.message	Meldung, die den Erfolg oder Fehler bestätigt. Datentyp: Zeichenfolge
<Object>.request_id	Sys_id des Datensatzes in der Tabelle „Dokumente“ [ds_document]. 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. Datentyp: Zeichenfolge

Das folgende Beispiel zeigt, wie Sie einen Dokumentnamen ändern. 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"
}