---
sourceDocument: Brazil API Reference
sourceDocumentLink: https://www.servicenow.com/docs/r/api-reference

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# SystemDocumentListEntry - Scoped, Global

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

Release version: Brazil  
Updated September 10, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read  
The SystemDocumentListEntry API provides methods for setting the
record fields in the Document List Entries \[ds_document_list_entry\]
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=brazil&pubname=brazil-servicenow-platform&ft:locale=en-US).  
Before using the methods in this API, you must add a document with its versions, and create a document list.

* [SystemDocument](https://www.servicenow.com/docs/OVm25ieN5KtwxmwLZqcMhg#SystemDocumentBothAPI "The SystemDocument API provides methods for setting fields of a record in the Documents [ds_document] table.") -- Define a document object.
* [DocumentService](https://www.servicenow.com/docs/x2XhO1Gjo96r~V~TyKniJw#DocumentServiceBothAPI "The DocumentService API provides methods for creating, deleting, and updating a document.") -- Add, update, or delete a document.
* [SystemDocumentVersion](https://www.servicenow.com/docs/Bx38_I3af4lKEOx4FB4jtg#SystemDocumentVersionBothAPI "The SystemDocumentVersion API provides methods for setting the values of a document's source version in the Versions [ds_document_version] table.") -- Define a document version.
* [DocumentVersionService](https://www.servicenow.com/docs/OG53l41lFjeLtabjU4~ayQ#DocumentVersionServiceBothAPI "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.") -- Add, update, or delete a document version.
* [SystemDocumentList](https://www.servicenow.com/docs/lltKOs9k8Z5~09GESCanyA#SystemDocumentListBothAPI "The SystemDocumentList API provides methods for setting the record fields in the Document Lists [ds_document_lists] table.") -- Define a document list.
* [DocumentListService](https://www.servicenow.com/docs/t3xQqlzUEf8LiKR1UT3BmQ#DocumentListServiceBothAPI "The DocumentListService API provides methods for creating, deleting, and updating a document list.") -- Add, update, or delete a document list.
{#SystemDocumentListEntryBothAPI__ul_krc_vmf_vpb}

## SystemDocumentListEntry - SystemDocumentListEntry(String listID) {#ariaid-title2}

Instantiates a SystemDocumentListEntry object.
{#SDLEntry-SystemDocumentListEntry_S__table_o12_jrk_spb__entry__3}

| Name | Type | Description |
|-|-|-|
| listSysId | String | Sys_id of a document list record in the Document Lists \[ds_document_lists\] table. |
[Table 1. Parameters]

{#SDLEntry-SystemDocumentListEntry_S__table_o12_jrk_spb} {#SDLEntry-SystemDocumentListEntry_S__table_p12_jrk_spb__entry__2}

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

{#SDLEntry-SystemDocumentListEntry_S__table_p12_jrk_spb}  
The following example shows how to instantiate a SystemDocumentListEntry
object.

    var docList = new sn_doc_services.SystemDocumentListEntry("<docListSysId>");

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

Sets the Description field of a document list entry record.
{#SDLEntry-description_S__table_o12_jrk_spb__entry__3}

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

{#SDLEntry-description_S__table_o12_jrk_spb} {#SDLEntry-description_S__table_p12_jrk_spb__entry__2}

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

{#SDLEntry-description_S__table_p12_jrk_spb}  
The following example shows how to add a description to the document list entry provided
using the constructor. See also [DocumentListEntryService](https://www.servicenow.com/docs/MsBlqNqv1~QM5p94GfRcwg#DocumentListEntryServiceBothAPI "The DocumentListEntryService API provides methods for maintaining document templates in a document list.") API.

    var docListEntry = new sn_doc_services.SystemDocumentListEntry('21afddea2460fc10f877a6fed1c2b0dd');

    docListEntry.description('birth');

    var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
    gs.info(JSON.stringify(dlEntrySvc.createDocumentListEntry(docListEntry), null, 2));

Output:

    {
      "message": "Create List Entry , List Entry sysId : d3f0b13624e8fc10f877a6fed1c2b0d9is successful.",
      "request_id": "d3f0b13624e8fc10f877a6fed1c2b0d9",
      "status": "success"
    }

## SystemDocumentListEntry - document(String docSysId) {#ariaid-title4}

Specifies the document template to add to a document list.
To define a document as a template:

* Define the document object setting the [SystemDocument --
  template()](https://www.servicenow.com/docs/OVm25ieN5KtwxmwLZqcMhg#SystemDoc-template_S "Specifies whether a document record is a template.") method to true. Create or update the document record with the methods in the [DocumentService](https://www.servicenow.com/docs/x2XhO1Gjo96r~V~TyKniJw#DocumentServiceBothAPI "The DocumentService API provides methods for creating, deleting, and updating a document.") API.
* Select the Template check box of a document in the Documents \[ds_document\] table.
{#SDLEntry-document_S__ul_b12_5zv_wpb}  
The document record specified must have a version. Use the following APIs to define and add a document version:

* [SystemDocumentVersion](https://www.servicenow.com/docs/Bx38_I3af4lKEOx4FB4jtg#SystemDocumentVersionBothAPI "The SystemDocumentVersion API provides methods for setting the values of a document's source version in the Versions [ds_document_version] table.") -- Define a document version.
* [DocumentVersionService](https://www.servicenow.com/docs/OG53l41lFjeLtabjU4~ayQ#DocumentVersionServiceBothAPI "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.") -- Add, update, or delete a document version.
{#SDLEntry-document_S__ul_krc_kax_vpb}
{#SDLEntry-document_S__table_o12_jrk_spb__entry__3}

| Name | Type | Description |
|-|-|-|
| docSysId | String | Sys_id of a document record in the Documents \[ds_document\] table. The document specified must be a template and have a version. |
[Table 5. Parameters]

{#SDLEntry-document_S__table_o12_jrk_spb} {#SDLEntry-document_S__table_p12_jrk_spb__entry__2}

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

{#SDLEntry-document_S__table_p12_jrk_spb}  
The following example shows how to add a document template as a document list entry. See
also [DocumentListEntryService API](https://www.servicenow.com/docs/MsBlqNqv1~QM5p94GfRcwg#DocumentListEntryServiceBothAPI "The DocumentListEntryService API provides methods for maintaining document templates in a document list.").

    var docListEntry = new sn_doc_services.SystemDocumentListEntry('21afddea2460fc10f877a6fed1c2b0dd');
    docListEntry.document("9acd7fea24587410f877a6fed1c2b060");
    docListEntry.description('birth certificate');

    var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
    gs.info(JSON.stringify(dlEntrySvc.createDocumentListEntry(docListEntry), null, 2));

Output:

    {
      "message": "Create List Entry , List Entry sysId : d3f0b13624e8fc10f877a6fed1c2b0d9is successful.",
      "request_id": "d3f0b13624e8fc10f877a6fed1c2b0d9",
      "status": "success"
    }

## SystemDocumentListEntry - documentList(String listSysId) {#ariaid-title5}

Specifies the document list in which to add a document.
Note:  
You can alternatively set the document list as a parameter in the SystemDocumentListEntry() constructor.  
Use the following APIs to define and create a document list:

* [SystemDocumentList](https://www.servicenow.com/docs/lltKOs9k8Z5~09GESCanyA#SystemDocumentListBothAPI "The SystemDocumentList API provides methods for setting the record fields in the Document Lists [ds_document_lists] table.") -- Define a document list.
* [DocumentListService](https://www.servicenow.com/docs/t3xQqlzUEf8LiKR1UT3BmQ#DocumentListServiceBothAPI "The DocumentListService API provides methods for creating, deleting, and updating a document list.") -- Add, update, or delete a document list.
{#SDLEntry-documentList_S__ul_axf_tsr_wpb}
{#SDLEntry-documentList_S__table_o12_jrk_spb__entry__3}

| Name | Type | Description |
|-|-|-|
| listSysId | String | Sys_id of a document list record in the Document Lists \[ds_document_lists\] table. |
[Table 7. Parameters]

{#SDLEntry-documentList_S__table_o12_jrk_spb} {#SDLEntry-documentList_S__table_p12_jrk_spb__entry__2}

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

{#SDLEntry-documentList_S__table_p12_jrk_spb}  
The following example shows how to set the document list in which to add a document. See
also [DocumentListEntryService API](https://www.servicenow.com/docs/MsBlqNqv1~QM5p94GfRcwg#DocumentListEntryServiceBothAPI "The DocumentListEntryService API provides methods for maintaining document templates in a document list.").

    var docListEntry = new sn_doc_services.SystemDocumentListEntry();

    docListEntry.documentList('21afddea2460fc10f877a6fed1c2b0dd');
    docListEntry.document('deaef1ce24103410f877a6fed1c2b085');
    docListEntry.description('passport');

    var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
    gs.info(JSON.stringify(dlEntrySvc.createDocumentListEntry(docListEntry), null, 2));

Output:

    {
      "message": "Create List Entry , List Entry sysId : c4ccaa8b24283050f877a6fed1c2b003is successful.",
      "request_id": "c4ccaa8b24283050f877a6fed1c2b003",
      "status": "success"
    }