SystemDocumentList : champ d’application, global

L’API SystemDocumentList fournit des méthodes pour définir les champs d’enregistrement dans la table Listes de documents [ds_document_lists].

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.

Pour créer ou gérer une liste de documents, utilisez l’API DocumentListService.

SystemDocumentList : SystemDocumentList(String docListName)

Instancie un objet SystemDocumentList .

Tableau 1. Paramètres

Nom	Type	Description
nom de liste de documents	Chaîne	Nom de la liste de documents.

Tableau 2. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment instancier un objet SystemDocumentList .

var docList = new sn_doc_services.SystemDocumentList();

SystemDocumentList : description (description de chaîne)

Définit le champ Description d’un nouvel enregistrement de liste de documents.

Tableau 3. Paramètres

Nom	Type	Description
description	Chaîne	Description de la liste de documents.

Tableau 4. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment ajouter une description à la liste de documents. Voir aussi API DocumentListService.

var dL = new sn_doc_services.SystemDocumentList('My document list');

// Define the document list field
dL.description('description');

var docList = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docList.createDocumentList(dL), null, 2));

Sortie :

{
  "message": "Create List for the given name : My document list, List sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}

SystemDocumentList : nom(String docListName)

Définit le champ Nom d’un enregistrement de liste de documents.

Remarque :

Vous pouvez également définir le nom comme paramètre dans le constructeur SystemDocumentList( ).

Tableau 5. Paramètres

Nom	Type	Description
nom de liste de documents	Chaîne	Nom de la liste de documents.

Tableau 6. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment renommer une liste de documents existante. Voir aussi DocumentListService.

var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';
var docListUpdate = new sn_doc_services.SystemDocumentList();

docListUpdate.name('name change');

var docListSvc = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docListSvc.updateDocumentList(docListID , docListUpdate), null, 2));

Sortie :

{
  "message": "Update List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}