Kommentare-API
Verwenden Sie die Kommentar-API, um Kommentare zu Coupa-Dokumenten zu erstellen, anzuzeigen und zu aktualisieren.
Einleitung
Die URL für den Zugriff auf die Vertragsbedingungen lautet: https:/<instance>//api/comments. Sie können auch Anhänge zu Ihrem Kommentar hinzufügen, indem Sie/Anhänge am Ende der URL hinzufügen. Weitere Informationen zu den Einschränkungen finden Sie in der folgenden Warnung.
Aktionen
Verwenden SIE ZUM ABRUFEN oder POSTEN von Kommentaren die API für das Objekt, für das Sie Daten abrufen möchten, und fügen Sie/comments am Ende der URL hinzu. Sie sollte wie folgt aussehen:/api/{transactional_object}/{object_id}/comments.
Die Verwendung des GET-Anrufs ERHÄLT alle Kommentare für das Dokument, wo der POST-Anruf einen neuen Kommentar hinzufügt.
Kommentare können auch mit/api/comments hinzugefügt werden, wobei eine Nutzlast erforderlich ist, um sie richtig ABZURUFEN oder zu POSTEN.
Mit der Kommentar-API können Sie folgende Aktionen ausführen:
| Verb | Pfad | Aktion | Beschreibung |
|---|---|---|---|
| BEITRAG | /api/invoices/:invoice_id/comments | erstellen | Kommentar erstellen |
| BEITRAG | /api/expense_reports/:expense_report_id/comments | erstellen | Kommentar erstellen |
| BEITRAG | /api/purchase_orders/:purchase_order_id/comments | erstellen | Kommentar erstellen |
| BEITRAG | /api/users/:user_id/comments | erstellen | Kommentar erstellen |
| BEITRAG | /api/requisitions/:requisition_id/comments | erstellen | Kommentar erstellen |
| ABFRAGEN | /api/invoices/:invoice_id/comments | index | Query-Kommentare |
| ABFRAGEN | /api/expense_reports/:expense_report_id/comments | index | Query-Kommentare |
| ABFRAGEN | /api/purchase_orders/:purchase_order_id/comments | index | Fragekommentare |
| ABFRAGEN | /api/users/:user_id/comments | index | Fragekommentare |
| ABFRAGEN | /api/requisitions/:requisition_id/comments | index | Fragekommentare |
| ABFRAGEN | /api/invoices/:invoice_id/comments/:id | anzeigen | Kommentar anzeigen |
| ABFRAGEN | /api/expense_reports/:expense_report_id/comments/:id | anzeigen | Kommentar anzeigen |
| ABFRAGEN | /api/purchase_orders/:purchase_order_id/comments/:id | anzeigen | Kommentar anzeigen |
| ABFRAGEN | /api/users/:user_id/comments/:id | anzeigen | Kommentar anzeigen |
| ABFRAGEN | /api/requisitions/:requisition_id/comments/:id | anzeigen | Kommentar anzeigen |
- Das Übergeben einer ungültigen ID an den Endpunkt, der die verschachtelte Schleife als
/api/comments/{invalid comment id}/attachmentshat, führt zu einer Luftbremse, und dies gilt auch für andere Objekte - Beim Übergeben der URL-Typ-Anhangs-ID an den Endpunkt
/api/comments/{comment id}/attachments/{URL type attachment id}zum Anzeigen des jeweiligen Anhangs wird der folgende Fehler angezeigt: Anhang hat keine Datei angehängt
Elemente
Die folgenden Elemente sind für die Kommentar-API verfügbar:
| Element | Beschreibung | Pflichtfeld? | Eindeutig? | Zulässiger Wert | API-In-Feld? | Api-Out Feld? | Datentyp |
|---|---|---|---|---|---|---|---|
| anhänge | anhänge | ja | Nicht zutreffend | ||||
| commentable-id | commentable-id | ja | ja | ganze Zahl | |||
| kommentierbarer Typ | kommentierbarer Typ | ja | ja | string(255) | |||
| kommentar-Typ | Bezeichnet den Typ des Kommentars und ist nur für den internen Gebrauch bestimmt | string(255) | |||||
| kommentare | Der Kommentar, den Sie veröffentlichen möchten. Sie können einen Benutzer erwähnen, indem Sie @[User:{id}] in das Kommentarfeld aufnehmen. |
ja | ja | text | |||
| created-at | Automatisch von Coupa erstellt im Format JJJJ-MM-TTTHH:MM:SS+HH:MMZ | ja | datum/Uhrzeit | ||||
| erstellt von | Benutzer, der den Kommentar erstellt hat. | ja | Benutzer | ||||
| iD | Eindeutige Kennung von Coupa für diesen Kommentar. | ja | ganze Zahl | ||||
| reason-code | Kommentar-Grundcode | ja | string(255) | ||||
| an-Lieferant | dem Lieferanten gezeigt werden? | ja | boolean | ||||
| updated-at | Automatisch von Coupa erstellt im Format JJJJ-MM-TTTHH:MM:SS+HH:MMZ | ja | datum/Uhrzeit | ||||
| aktualisiert von | Benutzer der Aktualisierung | ja | benutzer |
Beispiel: NACH dem Anruf
<comment>
<commentable-id type="integer">123456</commentable-id>
<commentable-type>InvoiceHeader</commentable-type>
<comments>KOMMENTARTEXT</comments>
</comment>Es ist auch möglich, einen bestimmten Benutzer in einem Kommentar zu erwähnen, der über die API gepostet wird. Dadurch wird der Benutzer benachrichtigt, dass er in dem Kommentar erwähnt wurde, vorausgesetzt, er hat Benachrichtigungen zu Dokumentenerwähnungen aktiviert. Wenn Sie einen Benutzer in einem Kommentar über die API erwähnen, verweisen Sie ihn über die technische ID seines Benutzers, z. B. um den Benutzer mit der technischen ID 2 zu erwähnen - fügen Sie "@[User:2] " in den Kommentartext ein, wie folgt:
<comment>
<commentable-id type="integer">123456</commentable-id>
<commentable-type>InvoiceHeader</commentable-type>
<comments>@[User:2] Bitte lesen Sie diesen Kommentar</comments>
</comment>Hier können Sie mehr über Erwähnungen in Kommentaren lesen.