DocumentListService - Scoped, Global

  • Release version: Australia
  • Updated March 12, 2026
  • 5 minutes to read

    • The DocumentListService API provides methods for creating, deleting, and updating a document list.

    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.

    The Document Management plugin also supports creating lists of document templates to associate with your document. For example, a job application requiring multiple documents such as a diploma, ID, or passport. After you add your document list, you can add document templates:
    To define a document as a template:
    • Define the document object setting the SystemDocument – template() method to true. Create or update the document record with the methods in the DocumentService API.
    • Select the Template check box of a document in the Documents [ds_document] table.
    The following APIs enable you to define and manage documents:
    To define a document as a template:
    • Define the document object setting the SystemDocument – template() method to true. Create or update the document record with the methods in the DocumentService API.
    • Select the Template check box of a document in the Documents [ds_document] table.

    See also SystemDocumentList.

    DocumentListService - DocumentListService()

    Instantiates a DocumentListService object.

    Table 1. Parameters
    Name Type Description
    None

    The following example shows how to instantiate a DocumentListService object. See also SystemDocumentList.

    var s = new sn_doc_services.DocumentListService();

    DocumentListService - createDocumentList(SystemDocumentList doc)

    Creates a document list in the Document Lists [ds_document_lists] table.

    The Document Management plugin also supports creating lists of document templates to associate with your document. For example, a job application requiring multiple documents such as a diploma, ID, or passport. After you add your document list, you can add document templates:

    Use the createDocumentsFromList() method to create documents from the document template list.

    Table 2. Parameters
    Name Type Description
    doc SystemDocumentList One or more properties representing fields of a new record. The name property is required and can be set using the SystemDocumentList constructor or name() method.
    Table 3. Returns
    Type Description
    Object Sys_id of the new record in the Document Lists [ds_document_lists] table with a success message. Error message otherwise.
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message Message confirming success or error.

    Data type: String
    <Object>.request_id Sys_id of the record in the Document Lists [ds_document_lists] 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 create a document list. See also SystemDocumentList.

    var dL = new sn_doc_services.SystemDocumentList('My document list');

// Define the document list field
dL.description('description');

var docList = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docList.createDocumentList(dL), null, 2));
    Output:
    {
  "message": "Create List for the given name : My document list, List sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}

    DocumentListService - createDocumentsFromList(String listSysId, String tableName, String tableSysId)

    Creates documents from a list of document templates.

    Note:
    Before using this method, create a document template list using the createDocumentList() method.
    Table 4. Parameters
    Name Type Description
    listSysId String Sys_id of a document list record in the Document Lists [ds_document_lists] table.
    tableName String Name of the table containing the record on which add a list of document template references.
    tableSysId String Sys_id of the record containing the content from which to add a list of document template references.
    Table 5. Returns
    Type Description
    Object Success or error message. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message

    Message containing the number of document templates in the document list.

    Data type: String
    <Object>.request_id Sys_id of the record in the Document Lists [ds_document_lists] 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 add a list of document template references to a record. The documentation is added to a record in the Incidents [incident] table.

    var result = new sn_doc_services.DocumentListService().createDocumentsFromList('21afddea2460fc10f877a6fed1c2b0dd', 'incident', 'd7158da0c0a8016700eef46c8d1f3661');
gs.info(JSON.stringify(result, null, 2));
    Output:
    {
  "message": "Created 1 document references for the given table name: incident, table sysId : d7158da0c0a8016700eef46c8d1f3661 with list SysId 21afddea2460fc10f877a6fed1c2b0dd",
  "request_id": "21afddea2460fc10f877a6fed1c2b0dd",
  "status": "success"
}

    DocumentListService - deleteDocumentList(String listSysId)

    Removes a document record from the Document Lists [ds_document_lists] table.

    Table 6. Parameters
    Name Type Description
    listSysId String Sys_id of a document list record in the Document Lists [ds_document_lists] table.
    Table 7. Returns
    Type Description
    Object Success or error message. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message Message confirming success or error.

    Data type: String
    <Object>.request_id Sys_id of the record in the Document Lists [ds_document_lists] 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 delete a document list record. See also SystemDocumentList.

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

var docListSvc = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docListSvc.deleteDocumentList(docListID), null, 2));
    Output:
    {
  "message": "Delete List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}

    DocumentListService - updateDocumentList(String docSysId, SystemDocumentList doc)

    Updates the field values of an existing document list.

    Table 8. Parameters
    Name Type Description
    listSysId String Sys_id of a document list record in the Document Lists [ds_document_lists] table.
    doc SystemDocument One or more properties representing document list fields to be updated.
    Table 9. Returns
    Type Description
    Object Success or error message. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message Message confirming success or error.

    Data type: String
    <Object>.request_id Sys_id of the record in the Document Lists [ds_document_lists] 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 update a document list name and description. See also SystemDocumentList.

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

var docListUpdate = new sn_doc_services.SystemDocumentList();
docListUpdate.name('name change');
docListUpdate.description('description update');

var docListSvc = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docListSvc.updateDocumentList(docListID , docListUpdate), null, 2));
    Output:
    {
  "message": "Update List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}