Pour: Administrateurs
Ajouter des notes aux dossiers avec une clé de hub
Créez des notes internes sur un dossier à partir de votre propre logiciel, fournissez-leur un document et des fichiers, et choisissez les rôles qui peuvent les consulter.
Dans cet article7 sections
Avant de commencer
Cette page traite de la manière d’ajouter et de lire les notesRemarques Notes internes relatives à un dossier, accessibles uniquement aux personnes dont le rôle le permet ; les clients ne peuvent y accéder que si le cabinet modifie cette règle. d’un cas, en utilisant une clé de hub. Les chemins de navigation sont indiqués sous https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.
Appels
| Appel | Ce que cela fait |
|---|---|
GET /notes/templates | Affiche les modèles de notes que vous avez créés. |
POST /notes | Crée une note. |
GET /notes | Cette liste contient les notes relatives à l’affaire, avec les informations les plus récentes en premier. |
GET /notes/<note_id> | Lise une note. |
PUT /notes/<note_id> | Changement du titre d’une note, ou de la personne qui peut la consulter. |
DELETE /notes/<note_id> | Supprime une note, ainsi que tous les fichiers associés. |
Une note est un document conservé dans une base de données pour votre équipe, accompagné de tous les fichiers associés. Son contenu se compose du document lui-même ; il est possible de commencer par un modèle prédéfini, ou de télécharger un fichier PDF ou Word une fois que la note a été créée. Il n’y a pas de champ de texte pour la saisie de texte. Personne ne sait quand une note est ajoutée ou modifiée. De plus, les notes ne transmettent aucun signal webhook.
Créer une note
| Champ | Ce que cela fait | Requis | Défaut |
|---|---|---|---|
name | Le titre de la note : des lettres, des chiffres, des espaces, et le symbole & ' - _ ( ) . /. Pas de virgules, de points virgules, de points d’interrogation ou de guillemets. | Oui. | — |
permissions | Les rôlesRôle Un ensemble d'autorisations qui détermine ce qu'une personne peut voir et faire sur un dossier, qu'il s'agisse de membres du personnel ou de clients. qui peuvent accéder à ces données, comme par exemple ["role::staff"]. Seuls les rôles qui ont le droit de lire les notes peuvent y avoir accès. | Non. | Les rôles du modèle, ou tous les rôles qui peuvent lire les notes. |
template | De {"owner": "host", "template_id": "<asset_id>"} à GET /notes/templates, pour apporter le document et les fichiers d’un modèle ; ou de {"owner": "case", "template_id": "<note_id>"} pour copier une note concernant ce cas. | Non. | Aucun. |
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/notes \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Case representation letter", "permissions": ["role::staff"], "template": {"owner": "host", "template_id": "note::20260915101500_5e4d3c2b1a0f90"}}'
Cela répond à 201 avec note_id.
- À partir d’un modèle, la note conserve les informations relatives au document, aux fichiers et aux rôles associés au modèle. Ses codes, comme le nom du client, sont saisis une seule fois, lors de sa création. Les informations concernant celui qui a créé la note, comme son nom, proviennent des données de l’assistant virtuel, qui contiennent également le nom de votre entreprise. Son titre ne est pas copié : il suffit d’envoyer
name. - Une copie de cette note conserve également les textes ou les dessins qui y ont été écrits ou dessinés, à moins que vous ne soumettiez
schemapour les remplacer. Les codes correspondants sont à nouveau entrés dans la copie, dès le moment où elle est rédigée. - Sans modèle prédéfini, téléchargez votre document ensuite : demandez une adresse à l’aide de
media_group=schemas, téléchargez un fichier PDF ou Word, et attachez-le avecPUT /notes/<note_id>/schema/media. Un fichier Word est converti en fichier PDF. Une note contient un seul document. Veuillez consulter Comment télécharger et attacher des fichiers à l’aide de la clé hub. - D’autres fichiers, tels que des photos ou des enregistrements, doivent être attachés avec
PUT /notes/<note_id>/media.
Qui le voit ?
Les personnes qui occupent les rôles mentionnés dans la note peuvent l’ouvrir. Les membres du personnel, dont le rôle par défaut est de modérer les notes, peuvent voir toutes les notes, quel que soit leur rôle. Les clients ne peuvent pas voir les notes, à moins qu’un administrateur ne leur ait donné les droits nécessaires pour y accéder. Pour en savoir plus, veuillez consulter Comment un rôle peut agir.
Notes de lecture
GET /notes prend limit (valeur par défaut : 20, jusqu’à 1000), ainsi que start_key. Les pages sont traitées comme dans toute liste. Une clé lit chaque note du fichier. Chaque note contient :
| Champ | Ce qu'il contient |
|---|---|
note_id, case_id | leurs identifiants |
name | Son titre |
user_id | Qui l’a créé ? C’est l’identité de l’assistant virtuel qui a été utilisée pour enregistrer ces notes. |
permissions | Les rôles qui pourraient être impliqués… Ils sont négligés, car tous ceux qui peuvent lire les notes peuvent également les voir. |
schema_media | Le media_id de son document |
media, media_ct | Ses documents et fichiers… Combien en existe-t-il ? Téléchargez-les, comme indiqué dans l’instruction « Télécharger et joindre des fichiers avec une clé Hub ». |
schema | Ce que les gens tapent ou dessinent sur le document, en format JSON instantané. |
template_id | Le modèle sur lequel il a été créé |
created_on, updated_on | Lorsque le texte a été rédigé et modifié pour la dernière fois, cela s’est produit dans le fuseau horaire UTC. |
GET /notes/templates liste les modèles de notes que vous avez publiés : modèlesModèle Un flux RSS, un formulaire, une signature électronique, une note ou une tâche réutilisable, conservé dans la bibliothèque et copié dans les dossiers.. Ces modèles sont classés par ordre de date d’ajout, avec pour chaque modèle des informations concernant asset_id, title, description et permissions.
Modification et suppression
PUT /notes/<note_id> prend name et permissions, et ne modifie que les valeurs que vous lui transmettez. Un clé peut modifier n’importe quelle note du cas. Une liste vide de permissions est rejetée : veuillez fournir les valeurs qui doivent être affichées. Un corps sans ces informations est également rejeté.
DELETE /notes/<note_id> supprime toutes les notes, ainsi que leurs documents et fichiers associés. Personne n’est informé de cette action.
Si un appel est refusé
| Statut | message | Pourquoi |
|---|---|---|
| 400 | SchemaFieldsException | Un champ est manquant ou n’est pas valide. Par exemple, une virgule dans name, une liste vide dans permissions, ou un rôle que votre hub ne possède pas. errors indique le nom de ce champ. |
| 400 | SchemaFieldsException, avec ItemCopyNotAllowedException à template | Le modèle n’est pas publié, il n’est pas accessible aux bots, ou ses fichiers sont encore en cours de traitement. |
| 400 | SchemaFieldsException, avec NoteRoleCannotReadNotesException à permissions.<n> | Une valeur dans permissions ne peut pas être lue. |
| 403 | HostModuleDisabledException | Les notes sont désactivées pour votre hub, ou bien elles sont cachées dans cette boîte. |
| 403 | CaseClosedException | L’affaire est close. |
| 404 | ItemNotFoundException | Cette note n’existe pas. |
Pour les corps d’erreur et le reste des codes, veuillez consulter la section Gestion des erreurs et des codes de statut.