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

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# DocumentListEntryService - Scoped, Global

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

Release version: Australia  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes to read  
The DocumentListEntryService API provides methods for maintaining document templates in 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](https://www.servicenow.com/docs/access?context=document-services-landing-page&version=australia&pubname=australia-servicenow-platform&ft:locale=en-US).

Before using the methods in this API, add a document template with its version and create a document list. Use the [SystemDocumentListEntry](https://servicenow-prod.fluidtopics.net/O5A8Ahe0GzPNnwLjJ8QBEw#SystemDocumentListEntryBothAPI "The SystemDocumentListEntry API provides methods for setting the record fields in the Document List Entries [ds_document_list_entry] table.") API to add or remove documents from a document list.  
Before using the methods in this API, you must add a document with its default version and create a document list.

* [SystemDocument](https://servicenow-prod.fluidtopics.net/89XyrAmnEWzLsX~QSFFIiQ#SystemDocumentBothAPI "The SystemDocument API provides methods for setting fields of a record in the Documents [ds_document] table.") -- Define a document object.
* [DocumentService](https://servicenow-prod.fluidtopics.net/CNb3ZUryqeTQvxL2snplIA#DocumentServiceBothAPI "The DocumentService API provides methods for creating, deleting, and updating a document.") -- Add, update, or delete a document.
* [SystemDocumentVersion](https://servicenow-prod.fluidtopics.net/_lnNVXVul1WxLSiAksrTrw#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://servicenow-prod.fluidtopics.net/NrP7GeHE4~Y15ZH_ImVz1g#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://servicenow-prod.fluidtopics.net/0vkF5dc33UABmBr~6ASqXg#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://servicenow-prod.fluidtopics.net/Wzk4FRVz0RNT90Vq7XbMhA#DocumentListServiceBothAPI "The DocumentListService API provides methods for creating, deleting, and updating a document list.") -- Add, update, or delete a document list.
{#DocumentListEntryServiceBothAPI__ul_krc_kgb_vpb}  
To define a document as a template:

* Define the document object setting the [SystemDocument --
  template()](https://servicenow-prod.fluidtopics.net/89XyrAmnEWzLsX~QSFFIiQ#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://servicenow-prod.fluidtopics.net/CNb3ZUryqeTQvxL2snplIA#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.
{#DocumentListEntryServiceBothAPI__ul_b12_5zv_wpb}

## DocumentListEntryService - DocumentListEntryService() {#ariaid-title2}

Instantiates a DocumentListEntryService object.
{#DLES-DocumentListEntryService__table_zw5_mcg_tpb__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 1. Parameters]

{#DLES-DocumentListEntryService__table_zw5_mcg_tpb}  
The following example shows how to instantiate a
DocumentListEntryService object.

    var s = new sn_doc_services.DocumentListEntryService();

## DocumentListEntryService - createDocumentListEntry(SystemDocumentListEntry entry) {#ariaid-title3}

Adds a document template entry to a document list.
{#DLES-createDocumentListEntry_O__table_w4z_2cg_tpb__entry__3}

| Name | Type | Description |
|-|-|-|
| entry | [SystemDocumentListEntry](https://servicenow-prod.fluidtopics.net/0vkF5dc33UABmBr~6ASqXg#SystemDocumentListBothAPI "The SystemDocumentList API provides methods for setting the record fields in the Document Lists [ds_document_lists] table.") | One or more properties representing fields of a document list entry object. |
[Table 2. Parameters]

{#DLES-createDocumentListEntry_O__table_w4z_2cg_tpb} {#DLES-createDocumentListEntry_O__table_tj4_p5j_34b__entry__2}

| Type | Description |
|-|-|
| Object | Sys_id of the new record in the Document List Entries \[ds_document_list_entry\] 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 List Entries \[ds_document_list_entry\] 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. {#DLES-createDocumentListEntry_O__ul_rlv_5cv_j4b} Data type: String |
[Table 3. Returns]

{#DLES-createDocumentListEntry_O__table_tj4_p5j_34b}  
The following example shows how to define a document entry and add it to a document list.
See also [SystemDocumentListEntry](https://servicenow-prod.fluidtopics.net/O5A8Ahe0GzPNnwLjJ8QBEw#SystemDocumentListEntryBothAPI "The SystemDocumentListEntry API provides methods for setting the record fields in the Document List Entries [ds_document_list_entry] table.").

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

## DocumentListEntryService - deleteDocumentListEntry(String listEntryId) {#ariaid-title4}

Removes a document list entry from the Document List Entries \[ds_document_list_entry\]
table.
{#DLES-deleteDocumentListEntry_S__table_w4z_2cg_tpb__entry__3}

| Name | Type | Description |
|-|-|-|
| listEntryId | String | Sys_id of a document list record in the Document List Entries \[ds_document_list_entry\] table. |
[Table 4. Parameters]

{#DLES-deleteDocumentListEntry_S__table_w4z_2cg_tpb} {#DLES-deleteDocumentListEntry_S__table_x4z_2cg_tpb__entry__2}

| Type | Description |
|-|-|
| Object | Success or error message. { "message": "String", "status": "String" } {#DLES-deleteDocumentListEntry_S__api_docserv_codeblock_dets} |
| \<Object\>.message | Message confirming success or error. 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. {#DLES-deleteDocumentListEntry_S__ul_rlv_5cv_j4b} Data type: String |
[Table 5. Returns]

{#DLES-deleteDocumentListEntry_S__table_x4z_2cg_tpb}  
The following example shows how to delete a document list record. See also [SystemDocumentList](https://servicenow-prod.fluidtopics.net/0vkF5dc33UABmBr~6ASqXg#SystemDocumentListBothAPI "The SystemDocumentList API provides methods for setting the record fields in the Document Lists [ds_document_lists] table.").

    var listEntryId = 'd3f0b13624e8fc10f877a6fed1c2b0d9';

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

Output:

    {
      "message": "Deleting an entry for the given documentListEntrySysId : d3f0b13624e8fc10f877a6fed1c2b0d9 is successful.",
      "status": "success"
    }

## DocumentListEntryService - updateDocumentListEntry(String listEntryId, SystemDocumentListEntry entry) {#ariaid-title5}

Updates the field values of an existing document list entry.
{#DLES-updateDocumentListEntry_S_O__table_w4z_2cg_tpb__entry__3}

| Name | Type | Description |
|-|-|-|
| listEntryId | String | Sys_id of a document list record in the Document List Entries \[ds_document_list_entry\] table. |
| entry | [SystemDocumentListEntry](https://servicenow-prod.fluidtopics.net/0vkF5dc33UABmBr~6ASqXg#SystemDocumentListBothAPI "The SystemDocumentList API provides methods for setting the record fields in the Document Lists [ds_document_lists] table.") | One or more properties representing fields of a document list entry object. |
[Table 6. Parameters]

{#DLES-updateDocumentListEntry_S_O__table_w4z_2cg_tpb} {#DLES-updateDocumentListEntry_S_O__table_x4z_2cg_tpb__entry__2}{#DLES-updateDocumentListEntry_S_O__ph-docserv-ret-obj-basic}

| Type | Description |
|-|-|
| Object | Success or error message. { "message": "String", "request_id": "String", "status": "String" } {#DLES-updateDocumentListEntry_S_O__api_docserv_codeblock_dets} |
| \<Object\>.message | Message confirming success or error. Data type: String |
| \<Object\>.request_id | Sys_id of the record in the Document List Entries \[ds_document_list_entry\] 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. {#DLES-updateDocumentListEntry_S_O__ul_rlv_5cv_j4b} Data type: String |
[Table 7. Returns]

{#DLES-updateDocumentListEntry_S_O__table_x4z_2cg_tpb}  
The following example shows how to update a document list entry description. See also [SystemDocumentListEntry](https://servicenow-prod.fluidtopics.net/O5A8Ahe0GzPNnwLjJ8QBEw#SystemDocumentListEntryBothAPI "The SystemDocumentListEntry API provides methods for setting the record fields in the Document List Entries [ds_document_list_entry] table.").

    var listEntryId = 'd3f0b13624e8fc10f877a6fed1c2b0d9';

    var entry = new sn_doc_services.SystemDocumentListEntry();
    entry.description('description update');

    var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
    gs.info(JSON.stringify(dlEntrySvc.updateDocumentListEntry(listEntryId, entry), null, 2));

Output:

    {
      "message": "Updating an entry for the given documentListEntrySysId : d3f0b13624e8fc10f877a6fed1c2b0d9 is successful.",
      "request_id": "d3f0b13624e8fc10f877a6fed1c2b0d9",
      "status": "success"
    }