DocumentVersionService: Bereichsbezogen, Global

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

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

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

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

DocumentVersionService – DocumentVersionService()

Instanziiert einen DocumentVersionService Objekt.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Keine

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

var versionSvc = new sn_doc_services.DocumentVersionService();

DocumentVersionService – createDocumentVersion(SystemDocumentVersion docVersion)

Erstellt einen Dokumentversionsdatensatz in der Tabelle „Versionen“ [ds_document_Version].

Tabelle : 2. Parameter

Name	Typ	Beschreibung
DocVersion	SystemdokumentVersion	Mindestens eine Eigenschaft, die Felder einer Dokumentversion darstellt.

Tabelle : 3. Rückgaben

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. Wenn erfolgreich, werden die sys_ID des Dokumentdatensatzes und die sys_ID der neuen Dokumentversion hinzugefügt. 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: 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 SystemdokumentVersion Objekteigenschaften und erstellen Sie eine neue Dokumentversion. Siehe auch SystemdokumentVersion .

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(Zeichenfolge docVersionSysId)

Löscht eine Dokumentversion.

Tabelle : 4. Parameter

Name	Typ	Beschreibung
docVersionSysId	Zeichenfolge	SYS_ID einer Dokumentversion in der Tabelle „Versionen“ [ds_document_Version].

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 der gelöschten Dokumentversion hinzugefügt. 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 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"
}