Commentaires API
Utilisez l'API Commentaires pour créer, afficher et mettre à jour les commentaires sur les documents Coupa.
Introduction
L'URL pour accéder aux termes du contrat est : https ://<instance>/api/comments. Vous pouvez également inclure des pièces jointes à votre commentaire en ajoutant/pièces jointes à la fin de l'URL. Reportez-vous à l'avertissement ci-dessous pour connaître les limitations.
Actions
Pour OBTENIR ou PUBLIER des commentaires, utilisez l'API de l'objet pour lequel vous souhaitez extraire des données et ajoutez/commentaires à la fin de l'URL ; il devrait ressembler à ceci :/api/{transactional_object}/{object_id}/comments.
L'utilisation de l'appel GET obtient tous les commentaires pour le document, où l'appel POST ajoute un nouveau commentaire.
Les commentaires peuvent également être ajoutés en utilisant/api/comments, où une charge utile est nécessaire pour OBTENIR ou PUBLIER correctement.
L'API Commentaires vous permet d'effectuer les actions suivantes :
| Verbe | Chemin d'accès | Action | Description |
|---|---|---|---|
| PUBLIER | /api/INVOICES/:invoice_id/comments | créer | Créer un commentaire |
| PUBLIER | /api/expense_reports/:expense_report_id/comments | créer | Créer un commentaire |
| PUBLIER | /api/purchase_orders/:purchase_order_id/comments | créer | Créer un commentaire |
| PUBLIER | /api/users/:user_id/comments | créer | Créer un commentaire |
| PUBLIER | /api/requisitions/:requisition_id/comments | créer | Créer un commentaire |
| OBTENIR | /api/INVOICES/:invoice_id/comments | index | Demander les commentaires |
| OBTENIR | /api/expense_reports/:expense_report_id/comments | index | Commentaires de la requête |
| OBTENIR | /api/purchase_orders/:purchase_order_id/comments | index | Commentaires de la requête |
| OBTENIR | /api/users/:user_id/comments | index | Demander les commentaires |
| OBTENIR | /api/requisitions/:requisition_id/comments | index | Demander les commentaires |
| OBTENIR | /api/INVOICES/:invoice_id/comments/:id | afficher | Afficher le commentaire |
| OBTENIR | /api/expense_reports/:expense_report_id/comments/:id | afficher | Afficher le commentaire |
| OBTENIR | /api/purchase_orders/:purchase_order_id/comments/:id | afficher | Afficher le commentaire |
| OBTENIR | /api/users/:user_id/comments/:id | afficher | Afficher le commentaire |
| OBTENIR | /api/requisitions/:requisition_id/comments/:id | afficher | Afficher le commentaire |
- Le passage d'un identifiant non valide au point final qui a la boucle imbriquée en tant que
/api/comments/{invalid comment id}/attachmentsentraîne un aérofrein et c'est la même chose pour d'autres objets - Lors de la transmission de l'ID de pièce jointe de type d'URL au point de terminaison
/api/comments/{comment id}/attachments/{URL type attachment id}pour afficher la pièce jointe particulière, l'erreur suivante s'affiche : Aucun fichier n'est joint à la pièce jointe
Éléments
Les éléments suivants sont disponibles pour l'API Commentaires :
| Élément | Description | Champ obligatoire ? | Unique ? | Valeur autorisée | Api-In Field ? | Champ Api-Out ? | Type de données |
|---|---|---|---|---|---|---|---|
| pièces jointes | pièces jointes | oui | S/O | ||||
| commentable-id | commentable-id | oui | oui | nombre entier | |||
| commentable-type | commentable-type | oui | oui | string(255) | |||
| comment-type | Indique le type du commentaire et est destiné à un usage interne uniquement | string(255) | |||||
| commentaires | Le commentaire que vous souhaitez publier. Vous pouvez mentionner un utilisateur en incluant @[User :{id}] dans le champ de commentaire. |
oui | oui | texte | |||
| created-at | Créé automatiquement par Coupa au format AAAA-MM-JJFHH :MM :SS+HH :MMZ | oui | datetime | ||||
| créé par | Créateur du commentaire. | oui | Utilisateur | ||||
| iD | Identifiant unique de Coupa pour le commentaire. | oui | nombre entier | ||||
| reason-code | Code de motif du commentaire | oui | string(255) | ||||
| au fournisseur | à montrer au fournisseur ? | oui | boolean | ||||
| mis-à-jour à | Créé automatiquement par Coupa au format AAAA-MM-JJFHH :MM :SS+HH :MMZ | oui | datetime | ||||
| mis à jour par | Utilisateur ayant réalisé la mise à jour | oui | utilisateur |
Exemple : POSTER UN APPEL
<comment>
<commentable-id type="integer">123456</commentable-id>
<commentable-type>InvoiceHeader</commentable-type>
<comments>TEXTE DU COMMENTAIRE</comments>
</comment>Il est également possible de mentionner un utilisateur spécifique dans un commentaire publié via l'API, cela informera l'utilisateur qu'il a été mentionné dans le commentaire, à condition qu'il ait activé les notifications de mentions de document. Lorsque vous mentionnez un utilisateur dans un commentaire via l'API, référez-vous à lui via l'ID technique de son utilisateur, par exemple, pour mentionner l'utilisateur avec l'ID technique 2 - incluez "@[User :2] " dans le texte du commentaire, comme suit :
<comment>
<commentable-id type="integer">123456</commentable-id>
<commentable-type>InvoiceHeader</commentable-type>
<comments>@[User :2] veuillez voir ce commentaire</comments>
</comment>Pour en savoir plus sur les mentions dans les commentaires, cliquez ici.