DocumentVersionService – Scoped, Global

Die DocumentVersionService -API stellt einen Service zum Erstellen und Löschen von Dokumentversionen bereit. 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.

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.

Bevor Sie eine Dokumentversion erstellen, müssen Sie zuerst einen Dokumentdatensatz definieren und hinzufügen.

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

DocumentVersionService – DocumentVersionService()

Instantiiert ein DocumentVersionService -Objekt.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Keine

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

var versionSvc = new sn_doc_services.DocumentVersionService();

DocumentVersionService – createDocumentVersion(SystemDocumentVersion docVersion)

Erstellt einen Dokumentversionsdatensatz in der Versionstabelle [ds_document_version].

Tabelle : 2. Parameter

Name	Typ	Beschreibung
docVersion	SystemDocumentVersion	Eine oder mehrere Eigenschaften, die Felder einer Dokumentversion darstellen.

Tabelle : 3. Ergebnisse

Typ	Beschreibung
Objekt	Sys_id des neuen Datensatzes in der Tabelle „Versionen“ [ds_document_version] mit einer Erfolgsmeldung. Andernfalls Fehlermeldung. { "message": "String", "request_id": "String", "status": "String" }
<Object>.Nachricht	Nachricht, die Erfolg oder Fehler bestätigt. Enthält bei Erfolg die sys_id des Dokumentdatensatzes und die sys_id seiner neuen Dokumentversion. Datentyp: Zeichenfolge
<Object>.request_id	Sys_id des neuen Datensatzes in der Tabelle „Versionen“ [ds_document_version]. 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 SystemDocumentVersion- Objekteigenschaften ausgefüllt und eine neue Dokumentversion erstellt werden. Siehe auch SystemDocumentVersion.

var versionDefinition = new sn_doc_services.SystemDocumentVersion('491efbee24187410f877a6fed1c2b0a9');

versionDefinition.type('url');
versionDefinition.url('http://one/1.0');

var versionSvc = new sn_doc_services.DocumentVersionService();
gs.info(JSON.stringify(versionSvc.createDocumentVersion(versionDefinition), null, 2));

Ausgabe:

{
  "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : d5a340d9242cf810f877a6fed1c2b069 is successful.",
  "request_id": "d5a340d9242cf810f877a6fed1c2b069",
  "status": "success"
}

DocumentVersionService – deleteDocumentVersion(String docVersionSysId)

Löscht eine Dokumentversion.

Tabelle : 4. Parameter

Name	Typ	Beschreibung
docVersionSysId	Zeichenfolge	Sys_id einer Dokumentversion in der Versionstabelle [ds_document_version].

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 der gelöschten Dokumentversion. 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 vorhandene Dokumentversion gelöscht wird.

var vId = "<versionSysId>";
var versionSvc = new sn_doc_services.DocumentVersionService();

gs.info(JSON.stringify(versionSvc.deleteDocumentVersion(vId), null, 2));

Ausgabe:

{
  "message": "Deleting an entry to DocumentVersion for the given documentVersionSysId : , sysId : <versionSysId> is successful.",
  "status": "success"
}