---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# SystemDocumentList - Scoped, Global

# SystemDocumentList - Scoped, Global {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read

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](https://www.servicenow.com/docs/access?context=document-services-landing-page&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US).

To create or manage a document list, use the [DocumentListService
API](https://servicenow-prod.fluidtopics.net/0dw9H_Qgi6UOWxUD~Znlew#DocumentListServiceBothAPI "The DocumentListService API provides methods for creating, deleting, and updating a document list.").

## SystemDocumentList - SystemDocumentList(String docListName) {#ariaid-title2}

Instantiates a SystemDocumentList object.
{#SysDocList-SystemDocumentList_S__table_o12_jrk_spb__entry__3}

| Name | Type | Description |
|-|-|-|
| docListName | String | Name of the document list. |
[Table 1. Parameters]

{#SysDocList-SystemDocumentList_S__table_o12_jrk_spb} {#SysDocList-SystemDocumentList_S__table_p12_jrk_spb__entry__2}

| Type | Description |
|-|-|
| None |   |
[Table 2. Returns]

{#SysDocList-SystemDocumentList_S__table_p12_jrk_spb}  
The following example shows how to instantiate a SystemDocumentList
object.

    var docList = new sn_doc_services.SystemDocumentList();

## SystemDocumentList - description(String description) {#ariaid-title3}

Sets the Description field of a new document list record.
{#SysDocList-description_S__table_o12_jrk_spb__entry__3}

| Name | Type | Description |
|-|-|-|
| description | String | Description of the document list. |
[Table 3. Parameters]

{#SysDocList-description_S__table_o12_jrk_spb} {#SysDocList-description_S__table_p12_jrk_spb__entry__2}

| Type | Description |
|-|-|
| None |   |
[Table 4. Returns]

{#SysDocList-description_S__table_p12_jrk_spb}  
The following example shows how to add a description to the document list. See also [DocumentListService API](https://servicenow-prod.fluidtopics.net/0dw9H_Qgi6UOWxUD~Znlew#DocumentListServiceBothAPI "The DocumentListService API provides methods for creating, deleting, and updating a document list.").

    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) {#ariaid-title4}

Sets the Name field of a document list record.
Note:  
You can also set the name as a parameter in the SystemDocumentList() constructor.
{#SysDocList-name_S__table_o12_jrk_spb__entry__3}

| Name | Type | Description |
|-|-|-|
| docListName | String | Name of the document list. |
[Table 5. Parameters]

{#SysDocList-name_S__table_o12_jrk_spb} {#SysDocList-name_S__table_p12_jrk_spb__entry__2}

| Type | Description |
|-|-|
| None |   |
[Table 6. Returns]

{#SysDocList-name_S__table_p12_jrk_spb}  
The following example shows how to rename an existing document list. See also [DocumentListService](https://servicenow-prod.fluidtopics.net/0dw9H_Qgi6UOWxUD~Znlew#DocumentListServiceBothAPI "The DocumentListService API provides methods for creating, deleting, and updating a document list.").

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