Création d'une note

Route

POST /rest/notes

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
value string Oui Contenu de la note
resId integer Oui Identifiant du courrier auquel on ajoute la note (res_letterbox.res_id)
entities array Non Liste des identifiants des entités autorisées à voir la note (entities.entity_id)
Exemple
{
    "value" : "Nouvelle note ajoutée au courrier",
    "resId" : 101,
    "entities" : ["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 ""