SystemDocumentList - Scoped, Global

The SystemDocumentList API provides methods for setting the record fields in the Document Lists [ds_document_lists] table.

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.

To create or manage a document list, use the DocumentListService API.

Parent Topic:Server API reference

SystemDocumentList - SystemDocumentList(String docListName)

Instantiates a SystemDocumentList object.

The following example shows how to instantiate a SystemDocumentList object.

var docList = new sn_doc_services.SystemDocumentList();

SystemDocumentList - description(String description)

Sets the Description field of a new document list record.

The following example shows how to add a description to the document list. See also DocumentListService API.

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"
}

SystemDocumentList - name(String docListName)

Sets the Name field of a document list record.

Note: You can also set the name as a parameter in the SystemDocumentList() constructor.

The following example shows how to rename an existing document list. See also DocumentListService.

var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';
var docListUpdate = new sn_doc_services.SystemDocumentList();

docListUpdate.name('name change');

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"
}