DocumentReferenceService : dans le champ d’application, global

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

    • L’API DocumentReferenceService fournit des méthodes de gestion des références documentaires au sein d’une table cible, telle que la table Incidents [incident] ou Connaissances [kb_knowledge]. Vous pouvez utiliser des références de documents pour associer des informations à un enregistrement.

    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.

    Les API suivantes vous permettent de définir et de gérer des documents :

    DocumentReferenceService : DocumentReferenceService()

    Instancie un objet DocumentReferenceService .

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

    L’exemple suivant montre comment instancier un objet DocumentReferenceService .

    var result = new sn_doc_services.DocumentReferenceService();

    DocumentReferenceService : addDocumentReference(String docSysId, String targetTable, String tableSysId)

    Ajoute une référence de document à un enregistrement de table cible.

    Tableau 2. Paramètres
    Nom Type Description
    docSysId Chaîne Sys_id d’un enregistrement de document dans la table Documents [ds_document].
    targetTable Chaîne Nom de la table cible sur laquelle fournir une référence de document.
    tableSysId Chaîne Sys_id de l’enregistrement de la table cible à laquelle la référence du document doit être ajoutée.
    Tableau 3. Renvoie
    Type Description
    Objet Sys_id du nouvel enregistrement dans la table Références de document [ds_document_reference] avec un message de réussite. Message d’erreur sinon.
    {
  "message": "String",
  "status": "String"
}
    <Object>.Message Message confirmant la réussite ou l’erreur. En cas de réussite, inclut le sys_id de l’enregistrement auquel la référence du document a été ajoutée.

    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 ajouter une référence de document à un enregistrement dans la table Incidents [incident].

    var docReference = new sn_doc_services.DocumentReferenceService();

var result = docReference.addDocumentReference("<docSysId>", "incident", "<tableSysId>");

gs.info(JSON.stringify(result, null, 2));
    Sortie :
    {
  "message": "Adding an entry to DocumentReference for the given docId to target table : incident, sysId : <tableSysId> is successful.",
  "status": "success"
}

    DocumentReferenceService : removeDocumentReference(String docSysId, String targetTable, String tableSysId)

    Supprime une référence de document de la table Références de document [ds_document_reference].

    Tableau 4. Paramètres
    Nom Type Description
    docSysId Chaîne Sys_id d’un enregistrement de document dans la table Documents [ds_document].
    targetTable Chaîne Nom de la table contenant la référence du document. Ces informations sont répertoriées avec le document dans le tableau Références documentaires [ds_document_reference].
    tableSysId Chaîne Sys_id de l’enregistrement à partir duquel le document est référencé. Vous trouverez les informations connexes répertoriées avec le document dans le tableau Références documentaires [ds_document_reference].
    Tableau 5. Renvoie
    Type Description
    Objet Message de réussite. Message d’erreur sinon.
    {
  "message": "String",
  "status": "String"
}
    <Object>.Message Message confirmant la réussite ou l’erreur. En cas de réussite, inclut le sys_id de l’enregistrement duquel la référence de document a été supprimée.

    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 une référence de document d’un enregistrement dans la table Incidents [incident].

    var docReference = new sn_doc_services.DocumentReferenceService();

var result = docReference.removeDocumentReference("<docSysId>", "incident", "<tableSysId>");

gs.info(JSON.stringify(result, null, 2));
    Sortie :
    {
  "message": "Deleting an entry to DocumentReference for the given docId to target table : incident, sysId : <tableSysId> is successful.",
  "status": "success"
}