DocumentListEntryService - Scoped, Global
-
- UpdatedJan 30, 2025
- 3 minutes to read
- Yokohama
- API reference
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.
Before using the methods in this API, add a document template with its version and create a document list. Use the SystemDocumentListEntry API to add or remove documents from a document list.
- SystemDocument – Define a document object.
- DocumentService – Add, update, or delete a document.
- SystemDocumentVersion – Define a document version.
- DocumentVersionService – Add, update, or delete a document version.
- SystemDocumentList – Define a document list.
- DocumentListService – Add, update, or delete a document list.
- 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.
DocumentListEntryService - DocumentListEntryService()
Instantiates a DocumentListEntryService object.
Name | Type | Description |
---|---|---|
None |
Example
The following example shows how to instantiate a DocumentListEntryService object.
DocumentListEntryService - createDocumentListEntry(SystemDocumentListEntry entry)
Adds a document template entry to a document list.
Name | Type | Description |
---|---|---|
entry | SystemDocumentListEntry | One or more properties representing fields of a document list entry object. |
Example
The following example shows how to define a document entry and add it to a document list. See also SystemDocumentListEntry.
DocumentListEntryService - deleteDocumentListEntry(String listEntryId)
Removes a document list entry from the Document List Entries [ds_document_list_entry] table.
Name | Type | Description |
---|---|---|
listEntryId | String | Sys_id of a document list record in the Document List Entries [ds_document_list_entry] table. |
Type | Description |
---|---|
Object | Success or error message. |
<Object>.message | Message confirming success or error.
Data type: String |
<Object>.status | Status indicating whether the operation is successful. Possible values:
Data type: String |
Example
The following example shows how to delete a document list record. See also SystemDocumentList.
DocumentListEntryService - updateDocumentListEntry(String listEntryId, SystemDocumentListEntry entry)
Updates the field values of an existing document list entry.
Name | Type | Description |
---|---|---|
listEntryId | String | Sys_id of a document list record in the Document List Entries [ds_document_list_entry] table. |
entry | SystemDocumentListEntry | One or more properties representing fields of a document list entry object. |
Example
The following example shows how to update a document list entry description. See also SystemDocumentListEntry.
On this page
- DocumentListEntryService - DocumentListEntryService()
- DocumentListEntryService - createDocumentListEntry(SystemDocumentListEntry entry)
- DocumentListEntryService - deleteDocumentListEntry(String listEntryId)
- DocumentListEntryService - updateDocumentListEntry(String listEntryId, SystemDocumentListEntry entry)