DocumentListEntryService - Scoped, Global

  • Release version: Xanadu
  • Updated August 1, 2024
  • 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.

    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.

    Before using the methods in this API, you must add a document with its default version and create a document list.
    To define a document as a template:
    • 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.

    Table 1. Parameters
    Name Type Description
    None

    The following example shows how to instantiate a DocumentListEntryService object.

    var s = new sn_doc_services.DocumentListEntryService();

    DocumentListEntryService - createDocumentListEntry(SystemDocumentListEntry entry)

    Adds a document template entry to a document list.

    Table 2. Parameters
    Name Type Description
    entry SystemDocumentListEntry One or more properties representing fields of a document list entry object.
    Table 3. Returns
    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.

    Data type: String

    The following example shows how to define a document entry and add it to a document list. See also SystemDocumentListEntry.

    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)

    Removes a document list entry from the Document List Entries [ds_document_list_entry] table.

    Table 4. Parameters
    Name Type Description
    listEntryId String Sys_id of a document list record in the Document List Entries [ds_document_list_entry] table.
    Table 5. Returns
    Type Description
    Object Success or error message. 
    {
  "message": "String",
  "status": "String"
}
    <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.

    Data type: String

    The following example shows how to delete a document list record. See also SystemDocumentList.

    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)

    Updates the field values of an existing document list entry.

    Table 6. Parameters
    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.
    Table 7. Returns
    Type Description
    Object Success or error message. 
    {
  "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.

    Data type: String

    The following example shows how to update a document list entry description. See also SystemDocumentListEntry.

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