DocumentListEntryService : dans le champ d’application, global

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 3 minutes de lecture

    • L’API DocumentListEntryService fournit des méthodes pour gérer les modèles de documents dans une liste de documents.

    Cette API nécessite le module d’extension Gestion de documents (com.snc.platform_document_management) et est fournie dans l’espace de noms sn_doc_services . Pour plus d’informations, consultez Services documentaires.

    Avant d’utiliser les méthodes de cette API, ajoutez un modèle de document avec sa version et créez une liste de documents. Utilisez l’API SystemDocumentListEntry pour ajouter ou supprimer des documents d’une liste de documents.

    Avant d’utiliser les méthodes de cette API, vous devez ajouter un document avec sa version par défaut et créer une liste de documents.
    Pour définir un document en tant que modèle :
    • Définissez l’objet de document en définissant la méthode SystemDocument – template() sur vrai. Créez ou mettez à jour l’enregistrement de document avec les méthodes de l’API DocumentService .
    • Cochez la case Modèle d’un document dans la table Documents [ds_document].

    DocumentListEntryService : DocumentListEntryService()

    Instancie un objet DocumentListEntryService .

    Tableau 1. Paramètres
    Nom Type Description
    Néant

    L’exemple suivant montre comment instancier un objet DocumentListEntryService .

    var s = new sn_doc_services.DocumentListEntryService();

    DocumentListEntryService : createDocumentListEntry(entrée SystemDocumentListEntry)

    Ajoute une entrée de modèle de document à une liste de documents.

    Tableau 2. Paramètres
    Nom Type Description
    entry SystemDocumentListEntry Une ou plusieurs propriétés représentant les champs d’un objet d’entrée de liste de documents.
    Tableau 3. Renvoie
    Type Description
    Objet Sys_id du nouvel enregistrement dans la table Entrées de la liste de documents [ds_document_list_entry] avec un message de réussite. Message d’erreur sinon.
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.Message Message confirmant la réussite ou l’erreur.

    Type de données : chaîne
    <Object>.request_id Sys_id de l’enregistrement dans la table Entrées de la liste de documents [ds_document_list_entry].

    Type de données : chaîne
    <Object>.statut État indiquant si l’opération a réussi.
    Valeurs possibles :
    • réussite : l’opération a réussi.
    • échec : l’opération a échoué. Le message fournit des détails.

    Type de données : chaîne

    L’exemple suivant montre comment définir une entrée de document et l’ajouter à une liste de documents. Voir aussi 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));
    Sortie :
    {
  "message": "Create List Entry , List Entry sysId : d3f0b13624e8fc10f877a6fed1c2b0d9is successful.",
  "request_id": "d3f0b13624e8fc10f877a6fed1c2b0d9",
  "status": "success"
}

    DocumentListEntryService : deleteDocumentListEntry(String listEntryId)

    Supprime une entrée de liste de documents de la table Entrées de la liste de documents [ds_document_list_entry].

    Tableau 4. Paramètres
    Nom Type Description
    listEntryId Chaîne Sys_id d’un enregistrement de liste de documents dans la table Entrées de la liste de documents [ds_document_list_entry].
    Tableau 5. Renvoie
    Type Description
    Objet Message de réussite ou d’erreur. 
    {
  "message": "String",
  "status": "String"
}
    <Object>.Message Message confirmant la réussite ou l’erreur.

    Type de données : chaîne
    <Object>.statut État indiquant si l’opération a réussi.
    Valeurs possibles :
    • réussite : l’opération a réussi.
    • échec : l’opération a échoué. Le message fournit des détails.

    Type de données : chaîne

    L’exemple suivant montre comment supprimer un enregistrement de liste de documents. Voir aussi SystemDocumentList.

    var listEntryId = 'd3f0b13624e8fc10f877a6fed1c2b0d9';

var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
gs.info(JSON.stringify(dlEntrySvc.deleteDocumentListEntry(listEntryId), null, 2));
    Sortie :
    {
  "message": "Deleting an entry for the given documentListEntrySysId : d3f0b13624e8fc10f877a6fed1c2b0d9 is successful.",
  "status": "success"
}

    DocumentListEntryService : updateDocumentListEntry(String listEntryId, entrée SystemDocumentListEntry)

    Met à jour les valeurs de champ d’une entrée de liste de documents existante.

    Tableau 6. Paramètres
    Nom Type Description
    listEntryId Chaîne Sys_id d’un enregistrement de liste de documents dans la table Entrées de la liste de documents [ds_document_list_entry].
    entry SystemDocumentListEntry Une ou plusieurs propriétés représentant les champs d’un objet d’entrée de liste de documents.
    Tableau 7. Renvoie
    Type Description
    Objet Message de réussite ou d’erreur. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.Message Message confirmant la réussite ou l’erreur.

    Type de données : chaîne
    <Object>.request_id Sys_id de l’enregistrement dans la table Entrées de la liste de documents [ds_document_list_entry].

    Type de données : chaîne
    <Object>.statut État indiquant si l’opération a réussi.
    Valeurs possibles :
    • réussite : l’opération a réussi.
    • échec : l’opération a échoué. Le message fournit des détails.

    Type de données : chaîne

    L’exemple suivant montre comment mettre à jour la description d’une entrée de liste de documents. Voir aussi 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));
    Sortie :
    {
  "message": "Updating an entry for the given documentListEntrySysId : d3f0b13624e8fc10f877a6fed1c2b0d9 is successful.",
  "request_id": "d3f0b13624e8fc10f877a6fed1c2b0d9",
  "status": "success"
}