Introduction Glossaire Guide utilisateur Guide administrateur fonctionnel Guide administrateur technique Prérequis pour Maarch Courrier Installation Script de migration Exploitation Mise en oeuvre de docker Architecture technique Architecture du produit Architecture d'un projet type Description du modèle de données Description des webservices Attachments Contacts Notes Resources Types de courrier Reconciliation

Création d'une note

Route

POST /rest/res/{resId}/notes

Le paramètre resId de la route représente l'identifiant (int) du courrier auquel on rajoute une note

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
note_text string Oui Texte de la note
entities_chosen array Non Liste des entités autorisées
Exemple
// JSON
{
    "note_text" : "Nouvelle note ajoutée au courrier",
    "entities_chosen" : ["COU", "CAB"]
}

Retour

Code Http Type Description Exemple
200 array La note a bien été ajoutée ['noteId' => 21]
400 array Un paramètre obligatoire est manquant ['errors' => 'Bad Request']
403 array Le document ne fait pas partie du périmètre d'exploitation de l'utilisateur ['errors' => 'Document out of perimeter']
500 array Une erreur s'est produite ['errors' => '[NoteController create] Note creation has failed']

results matching ""

    No results matching ""