DocumentVersionService - Scoped, Global

  • 릴리스 버전: Australia
  • 업데이트 날짜 2026년 03월 12일
  • 소요 시간: 6분

    • 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.

    DocumentVersionService - DocumentVersionService()

    Instantiates a DocumentVersionService object.

    표 1. Parameters
    Name Type Description
    None

    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.

    표 2. Parameters
    Name Type Description
    docVersion SystemDocumentVersion One or more properties representing fields of a document version.
    표 3. Returns
    Type Description
    Object Sys_id of the new record in the Versions [ds_document_version] table with a success message. Error message otherwise.
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message Message confirming success or error. If successful, includes the sys_id of the document record and the sys_id of its new document version.

    Data type: String
    <Object>.request_id Sys_id of the new record in the Versions [ds_document_version] table.

    Data type: String
    <Object>.status Status indicating whether the operation is successful.
    Possible values:
    • success - The operation was successful.
    • failure – The operation was not successful. The message provides details.

    Data type: 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.

    표 4. Parameters
    Name Type Description
    docVersionSysId String Sys_id of a document version in the Versions [ds_document_version] table.
    표 5. Returns
    Type Description
    Object Success message. Error message otherwise.
    {
  "message": "String",
  "status": "String"
}
    <Object>.message Message confirming success or error. If successful, includes the sys_id of the deleted document version.

    Data type: String
    <Object>.status Status indicating whether the operation is successful.
    Possible values:
    • success - The operation was successful.
    • failure – The operation was not successful. The message provides details.

    Data type: 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"
}