Aller au contenu

Comment modifier un template

Identifier le Template à modifier

Si vous ne connaissez pas l'id du Template que vous souhaitez modifier, repérer le Template à modifier en appelant la route GET /templates

Modification du Template

Pour modifier un Template, il faut avoir le droit update

Envoyer une requête PUT /templates/{id} avec en body :

{
  "templateFormat": "twig",
  "template": "<p>Le dossier sous la référence citée en objet a été mis en attente d'instruction par nos services pour le motif suivant <br>{{ lastComment }}<br>--<br>MDF</p>",
  "id": "e8a32eb4-0503-4535-aef2-006dc0e626a8",
  "displayName": "Template test pour la doc",
  "description": "Template Twig à utiliser pour l'envoi de mails",
  "identifier": "template_test",
  "attributes": {
    "subject": "Objet du template modifié"
  }
}

Il n'y a que les champs templateFormat, template, displayName, description et attributes qui sont modifiables.

  • template contient le contenu du Template
  • attributes.subject contient l'objet du mail envoyé, si le Template est utilisé pour l'envoi de mail

Variables utilisables dans le contenu d'un Template

Template de mail utilisé dans une Task

Champs disponibles :

Champ Type Description Exempla Type de Task
lastComment string Contenu de la dernière annotation publique ajoutée "Une annotation" acknowledgeStandBy et acknowledgeAdvice
entity object Entité sur laquelle la Task est executé. Tous les champs de l'entité sont accessible (ex: entity.displayName) Objet Entry, objet User acknowledgeStandBy, acknowledgeAdvice et acknowledgeReceipt
recipients string[] Liste des destinataires de l'email ["bblier@maarch.com"] acknowledgeStandBy et acknowledgeAdvice

Templates initialisation / reset du mot de passe utilisateur

Champs disponibles :

Champ Type Description Exempla
firstName string Prénom de l'utilisateur. Utilise le champ attributes.ModelAgent.prenom "Bernard"
lastName string Nom de l'utilisateur. Utilise le champ attributes.ModelAgent.nom "Blier"
hash string Token d'authentification nécessaire pour appeler l'API de changement de mot de passe
expires int Durée de validité du token, en secondes. La durée est paramétrable avec la variable d'environnement RESET_PASSWORD_TOKEN_LIFETIME
duration string Durée formaté en secondes ou minutes "60 minutes"
frontUrl string Url de l'application front. À utiliser pour formatter un lien vers la page front. "https://mdf.maarch.fr/#/"

Template PDF

Les templates utilisés pour la génération de PDF sont au format HTML Twig. Le code HTML sera converti en PDF par le module d'export.

Tous les champs de l'entité exportée sont disponibles, par exemple pour avoir le displayName il suffit d'utiliser displayName

Le SubType de l'entité est accessible via le champ type (ex: type.displayName)