DocumentService: Bereichsbezogen, Global

Die DocumentService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.

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

Ein Dokument ist eine Sammlung von Informationen zu einem Dokumentdatensatz. Die Methoden, die zum Erstellen oder Aktualisieren von Datensatzänderungsfeldern mit verwendet werden Systemdokument Objekt.

Dokumentinhalt wird mit Versionen verwaltet. Mit den folgenden APIs können Sie Dokumentversionen definieren und verwalten:

• SystemdokumentVersion – Definieren Sie eine Dokumentversion als Quelle des Dokumentinhalts. Jede Version ist ein Element, das den Dokumentinhalt enthält und wird mithilfe einer einzelnen URL oder eines einzelnen Anhangs bereitgestellt. Ein Anhang kann nur in der UI der Tabelle „Dokumentversionen“ [ds_document_Version] und nicht mit der API hinzugefügt werden.
• DocumentVersionService – Dokumentinhalt wird mit Versionen verwaltet.

Verwenden Sie DocumentReferenceService API zum Verwalten von Dokumenten, auf die in einer Zieltabelle verwiesen wird, z. B. die Tabelle „Incidents“ [Incident] oder „Wissen“ [kb_Knowledge].

Die Dokumentverwaltung Das Plugin unterstützt auch die Erstellung von Listen von Dokumentvorlagen, die Ihrem Dokument zugeordnet werden sollen. Zum Beispiel eine Bewerbung, die mehrere Dokumente wie Diplom, ID oder Reisepass erfordert.

• SystemdokumentListe – Definieren Sie eine Liste von Dokumentvorlagen.
• DocumentListService – Hinzufügen oder Entfernen einer Dokumentvorlagenliste.
• SystemDocumentListEntry – Definieren Sie einen Listeneintrag für eine Dokumentvorlage.
• DocumentListEntryService – Hinzufügen oder Entfernen eines Dokumentvorlagen-Listeneintrags.

DocumentService – DocumentService()

Instanziiert einen DocumentService Objekt.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Keine

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

var s = new sn_doc_services.DocumentService();

DocumentService – createDocument(SystemDocument-Dokument)

Erstellt einen Dokumentdatensatz in der Tabelle „Dokumente“ [ds_document].

Tabelle : 2. Parameter

Name	Typ	Beschreibung
doc	Systemdokument	Mindestens eine Eigenschaft, die Felder eines neuen Datensatzes darstellt. Die Namenseigenschaft ist erforderlich und kann mit festgelegt werden Systemdokument Konstruktor oder Name () Methode.

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>.Nachricht	Nachricht, die Erfolg oder Fehler bestätigt. Mögliche Werte: SYS-ID 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. < Systemdokument Eigenschaft, die sys_ID input> mit SysId „<sys_id>“ erfordert, 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. Die messageStellt Details bereit. Datentyp: Zeichenfolge

Das folgende Beispiel zeigt, wie ausgefüllt wird Systemdokument Objekteigenschaften und erstellen Sie einen neuen Dokumentdatensatz.

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(Zeichenfolge 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>.Nachricht	Nachricht, die 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. Die messageStellt Details bereit. 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(Zeichenfolge docSysId, SystemDocument-Dokument)

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	Mindestens eine Eigenschaft, die Dokumentfelder darstellt, die aktualisiert werden sollen.

Tabelle : 7. Rückgaben

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 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. Die messageStellt Details bereit. Datentyp: Zeichenfolge

Das folgende Beispiel zeigt, wie ein Dokumentname geändert wird. Siehe auch Systemdokument .

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