DocumentVersionService - Scoped, Global

The DocumentVersionService API provides a service for creating and deleting document versions. Each version is an element containing the document content and is provided using a single URL or attachment. An attachment can only be added in the Document Versions [ds_document_version] table UI and not with the API.

This API requires the Document Management plugin (com.snc.platform_document_management) and is provided within the sn_doc_services namespace. For information, see Document Services.

Before creating a document version, you must first define and add a document record.

• SystemDocument – Define a document object.
• DocumentService – Add, update, or delete a document.

Parent Topic:Server API reference

DocumentVersionService - DocumentVersionService()

Instantiates a DocumentVersionService object.

The following example shows how to instantiate a DocumentVersionService object.

var versionSvc = new sn_doc_services.DocumentVersionService();

DocumentVersionService - createDocumentVersion(SystemDocumentVersion docVersion)

Creates a document version record in the Versions [ds_document_version] table.

{
  "message": "String",
  "request_id": "String",
  "status": "String"
}

The following example shows how to populate SystemDocumentVersion object properties and create a new document version. See also 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));

Output:

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

DocumentVersionService - deleteDocumentVersion(String docVersionSysId)

Deletes a document version.

{
  "message": "String",
  "status": "String"
}

The following example shows how to delete an existing document version.

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

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

Output:

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