API des commentaires
Utilisez l'API Commentaires pour créer, afficher et mettre à jour des commentaires sur des documents Coupa.
Introduction
L'URL permettant d'accéder aux conditions du contrat est :https://<instance>/api/comments. Vous pouvez également ajouter des pièces jointes à votre commentaire en ajoutant des /attachments éléments à la fin de l'URL. Voir l'avertissement ci-dessous pour les limitations.
Actions
Pour obtenir ou publier des commentaires, utilisez l'API de l'objet pour lequel vous souhaitez extraire des données, puis ajoutez-la /comments à la fin de l'URL. Elle doit ressembler à ceci :
/api/{transactional_object}/{object_id}/comments,
L'appel GET permet d'obtenir tous les commentaires du document, où l'appel POST ajoute un nouveau commentaire.
Vous pouvez également ajouter des commentaires à l'aide de /api/comments, où une charge utile est requise pour obtenir ou valider correctement.
L'API Commentaires vous permet d'effectuer les actions suivantes :
| Verbe | Chemin d'accès | Action | Description |
|---|---|---|---|
| POSTE | /api/voices/:invoice_id/comments | créer | Créer un commentaire |
| POSTE | /api/expense_reports/:expense_report_id/comments | créer | Créer un commentaire |
| POSTE | /api/purchase_orders/:purchase_order_id/comments | créer | Créer un commentaire |
| POSTE | /api/users/:id_utilisateur/commentaires | créer | Créer un commentaire |
| POSTE | /api/requisitions/:id_demande/commentaires | créer | Créer un commentaire |
| OBTENIR | /api/voices/:invoice_id/comments | index | Commentaire de requête |
| OBTENIR | /api/expense_reports/:expense_report_id/comments | index | Commentaire de requête |
| OBTENIR | /api/purchase_orders/:purchase_order_id/comments | index | Commentaire de requête |
| OBTENIR | /api/users/:id_utilisateur/commentaires | index | Commentaire de requête |
| OBTENIR | /api/requisitions/:id_demande/commentaires | index | Commentaire de requête |
| OBTENIR | /api/voices/:invoice_id/comments/:id | montrer | Afficher le commentaire |
| OBTENIR | /api/expense_reports/:expense_report_id/comments/:id | montrer | Afficher le commentaire |
| OBTENIR | /api/purchase_orders/:purchase_order_id/comments/:id | montrer | Afficher le commentaire |
| OBTENIR | /api/users/:id_utilisateur/commentaires/:id | montrer | Afficher le commentaire |
| OBTENIR | /api/requisitions/:id_demande/commentaires/:id | montrer | Afficher le commentaire |
- Passer un ID non valide au point de terminaison qui a la boucle imbriquée comme
/api/comments/{invalid comment id}/attachmentsrésultat dans 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 du type d'URL au point de terminaison
/api/comments/{comment id}/attachments/{URL type attachment id}pour afficher la pièce jointe en question, l'erreur suivante apparaît :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 | Champ Api-In ? | Champ Api-Out ? | Type de données |
|---|---|---|---|---|---|---|---|
| pièces jointes | pièces jointes | oui | S/O | ||||
| id_commentable | id_commentable | oui | oui | entier | |||
| commentable | commentable | oui | oui | string(255) | |||
| type de commentaire | Indique le type de commentaire et est réservé à un usage interne | oui | string(255) | ||||
| commentaires | Le commentaire que vous voulez poster. Vous pouvez mentionner un utilisateur en l'incluant @[User:{id}]dans le champ de commentaire. |
oui | oui | texte | |||
| créé à | Créé automatiquement par Coupa au format AAAA-MM-JJFHH:MM:SS+HH:MMZ | oui | datetime | ||||
| créé par | Utilisateur qui a créé le commentaire. | oui | Utilisateur | ||||
| id | Identifiant unique de Coupa pour le commentaire. | oui | entier | ||||
| reason-code | Code motif du commentaire | oui | string(255) | ||||
| au fournisseur | à montrer au fournisseur ? | oui | oui | booléen | |||
| 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 : Appel POST
<comment>
<commentable-id type="integer">123456</commentable-id>
<commentable-type>InvoiceHeader</commentable-type>
<comments>COMMENT TEXT</comments>
</comment>Il est également possible de mentionner un utilisateur spécifique dans un commentaire posté via l'API, ceci informera l'utilisateur qu'il a été mentionné dans le commentaire, à condition que les notifications de mention de document soient activées. When mentioning a user in a comment via the API refer to them via their user's technical ID, for example, to mention the user with technical ID 2 - include "@[User :2] " in the comment text, like this :
<comment>
<commentable-id type="integer">123456</commentable-id>
<commentable-type>InvoiceHeader</commentable-type>
<comments>@[User:2] please see this comment</comments>
</comment>Pour en savoir plus sur les mentions spéciales, cliquez ici.
Veuillez noter que certaines parties de ce contenu peuvent avoir été générées par traduction automatique.