DocumentService : champ d’application, global

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 4 minutes de lecture

    • L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document.

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

    Un document est une collection d’informations sur un enregistrement de document. Les méthodes utilisées pour créer ou mettre à jour un enregistrement modifient les champs à l’aide de l’objet SystemDocument .

    Le contenu d’un document est géré à l’aide des versions. Les API suivantes vous permettent de définir et de gérer les versions de documents :
    • SystemDocumentVersion : définit une version de document comme source du contenu du document. chaque version est un élément contenant le contenu du document et est fournie à l’aide d’une URL unique ou d’une pièce jointe. Une pièce jointe ne peut être ajoutée que dans l’interface utilisateur de la table Versions de documents [ds_document_version] et non avec l’API.
    • DocumentVersionService : le contenu du document est géré à l’aide des versions.

    Utilisez l’API DocumentReferenceService pour gérer les documents référencés dans une table cible, telle que la table Incidents [incident] ou Knowledge [kb_knowledge].

    Le Document Management module d’extension prend également en charge la création de listes de modèles de documents à associer à votre document. Par exemple, une demande d’emploi nécessitant plusieurs documents tels qu’un diplôme, une carte d’identité ou un passeport.

    DocumentService : DocumentService()

    Instancie un objet DocumentService .

    Tableau 1. Paramètres
    Nom Type Description
    Aucun

    L’exemple suivant montre comment instancier un objet DocumentService .

    var s = new sn_doc_services.DocumentService();

    DocumentService : createDocument (document SystemDocument)

    Crée un enregistrement de document dans la table Documents [ds_document].

    Tableau 2. Paramètres
    Nom Type Description
    document Document système Une ou plusieurs propriétés représentant les champs d’un nouvel enregistrement. La propriété name est requise et peut être définie à l’aide du constructeur SystemDocument ou de la méthode name().
    Tableau 3. Renvoie
    Type Description
    Objet Sys_id du nouvel enregistrement dans la table Documents [ds_document] 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.
    Valeurs possibles :
    • Créer un sysId de document : <sys_id> a réussi.
    • Le nom du document est obligatoire et doit être valide.
    • Le nom du document est obligatoire et ne doit pas être nul ou vide.
    • < propriété SystemDocument nécessitant une entrée sys_id > avec SysId : « <sys_id> » n’existe pas

    Type de données : chaîne
    <Object>.request_id Sys_id de l’enregistrement dans la table Documents [ds_document].

    Type de données : chaîne
    <Object>.statut État indiquant si l’opération a réussi.
    Valeurs possibles :
    • réussite : l’opération s’est déroulée correctement.
    • échec : l’opération n’a pas réussi. Fournit message des détails.

    Type de données : chaîne

    L’exemple suivant montre comment renseigner les propriétés de l’objet SystemDocument et créer un nouvel enregistrement de document.

    var d = new sn_doc_services.SystemDocument('My document');

// Define the document fields
var reviewers = '62826bf03710200044e0bfc8bcbe5df1,a8f98bb0eb32010045e1a5115206fe3a';
d.description('description');
d.classification('restricted');
d.state('review');
d.department('93b25282c0a8000b0b55c8ab34e2f1e6');
d.template(false);
d.type('policy');
d.reviewers(reviewers);
d.audience('external');

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Sortie :
    {
  "message": "Create document sysId : 1040420224503410f877a6fed1c2b031 is successful.",
  "request_id": "1040420224503410f877a6fed1c2b031",
  "status": "success"
}

    DocumentService : deleteDocument(String docSysId)

    Supprime un enregistrement de document de la table Documents [ds_document].

    Tableau 4. Paramètres
    Nom Type Description
    ID docSysId Chaîne Sys_id d’un enregistrement de document dans la table Documents [ds_document].
    Tableau 5. 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 Documents [ds_document].

    Type de données : chaîne
    <Object>.statut État indiquant si l’opération a réussi.
    Valeurs possibles :
    • réussite : l’opération s’est déroulée correctement.
    • échec : l’opération n’a pas réussi. Fournit message des détails.

    Type de données : chaîne

    L’exemple suivant montre comment supprimer un enregistrement de document existant.

    var docid = "<sys_id>";
var svc = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(svc.deleteDocument(docid), null, 2));
    Sortie :
    {
  "message": "Delete document sysId : <sys_id> is successful.",
  "request_id": "<sys_id>",
  "status": "success"
}

    DocumentService : updateDocument(String docSysId, doc SystemDocument)

    Met à jour les valeurs de champ d’un enregistrement de document existant.

    Tableau 6. Paramètres
    Nom Type Description
    ID docSysId Chaîne Sys_id d’un enregistrement de document dans la table Documents [ds_document].
    document Document système Une ou plusieurs propriétés représentant les champs du document à mettre à jour.
    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 Documents [ds_document].

    Type de données : chaîne
    <Object>.statut État indiquant si l’opération a réussi.
    Valeurs possibles :
    • réussite : l’opération s’est déroulée correctement.
    • échec : l’opération n’a pas réussi. Fournit message des détails.

    Type de données : chaîne

    L’exemple suivant montre comment modifier le nom d’un document. Voir aussi SystemDocument.

    var dId = "19aab54e24103410f877a6fed1c2b03d";
var d = new sn_doc_services.SystemDocument();
d.name("c22.txt");

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.updateDocument(dId, d), null, 2));
    Sortie :
    {
  "message": "Update document sysId : 19aab54e24103410f877a6fed1c2b03d is successful.",
  "request_id": "19aab54e24103410f877a6fed1c2b03d",
  "status": "success"
}