Comments API
コメントAPIを使用して、Coupaドキュメントのコメントを作成、表示、更新します。
はじめに
契約条件にアクセスするためのURLはhttps ://<instance>/api/commentsです。また、URLの最後に/attachmentsを追加して、コメントに添付ファイルを含めることもできます。制限については、以下の警告を参照してください。
アクション
コメントを取得または投稿するには、データを取得したいオブジェクトのAPIを使用し、URLの最後に/commentsを追加します。/api /{ transactional_object }/{ object_id }/ commentsのようになります。
GET呼び出しを使用すると、ドキュメントのすべてのコメントが取得され、POST呼び出しによって新しいコメントが追加されます。
ペイロードが適切に取得または投稿するために必要な/api/commentsを使用してコメントを追加することもできます。
コメントAPIを使用すると、以下の操作を実行できます。
| 動詞 | パス | アクション | 説明 |
|---|---|---|---|
| 投稿 | /api/invoices /: invoice_id/comments | 作成 | コメントを作成 |
| 投稿 | /api/expense_reports /: expense_report_id/comments | 作成 | コメントを作成 |
| 投稿 | /api/purchase_orders /: purchase_order_id/comments | 作成 | コメントを作成 |
| 投稿 | /api/users /: user_id/comments | 作成 | コメントを作成 |
| 投稿 | /api/requisitions /: requisition_id/comments | 作成 | コメントを作成 |
| 取得 | /api/invoices /: invoice_id/comments | index | 質問コメント |
| 取得 | /api/expense_reports /: expense_report_id/comments | index | コメントに質問 |
| 取得 | /api/purchase_orders /: purchase_order_id/comments | index | コメントに質問 |
| 取得 | /api/users /: user_id/comments | index | コメントに質問 |
| 取得 | /api/requisitions /: requisition_id/comments | index | コメントに質問 |
| 取得 | /api/invoices /: invoice_id/comments /: id | 表示 | コメントを表示 |
| 取得 | /api/expense_reports /: expense_report_id/comments /: id | 表示 | コメントを表示 |
| 取得 | /api/purchase_orders /: purchase_order_id/comments /: id | 表示 | コメントを表示 |
| 取得 | /api/users /: user_id/comments /: id | 表示 | コメントを表示 |
| 取得 | /api/requisitions /: requisition_id/comments /: id | 表示 | コメントを表示 |
警告
/api/comments /{ invalid comment id }/ attachmentsとしてネストされたループを持つエンドポイントに無効なIDを渡すと、エアブレーキが発生し、他のオブジェクトでも同じです- URLタイプの添付ファイルIDをエンドポイント
/api/comments /{ comment id }/ attachments /{ URLタイプの添付ファイルID}に渡して特定の添付ファイルを表示すると、次のエラーが表示されます。添付ファイルには添付ファイルがありません
要素
Comments APIでは次の要素を使用できます。
| 要素 | 説明 | 必須フィールドですか？ | 一意ですか？ | 許容される値 | Api - Inフィールド？ | Api - Outフィールド？ | データタイプ |
|---|---|---|---|---|---|---|---|
| 添付ファイル | 添付ファイル | はい | 該当なし | ||||
| commentable - id | commentable - id | はい | はい | 整数 | |||
| commentable - type | commentable - type | はい | はい | string (255) | |||
| comment - type | コメントのタイプを示し、内部でのみ使用 | string (255) | |||||
| コメント | 投稿したいコメント。コメントフィールドに@[ User :{ id}]を含めることで、ユーザーをメンションできます。 |
はい | はい | テキスト | |||
| created - at | CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました | はい | 日時 | ||||
| created - by | コメントを作成したユーザー。 | はい | ユーザー | ||||
| iD | コメントのCoupaの一意の識別子。 | はい | 整数 | ||||
| reason - code | コメント理由コード | はい | string (255) | ||||
| to - supplier | サプライヤーに表示しますか？ | はい | boolean | ||||
| updated - at | CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました | はい | 日時 | ||||
| 更新者： | 更新したユーザー | はい | ユーザー |
例：通話後
<comment>
<commentable-id type="integer">123456</commentable-id>
<commentable-type>InvoiceHeader</commentable-type>
<comments>コメントテキスト</comments>
</comment>また、APIを介して投稿されたコメントで特定のユーザーをメンションすることもできます。これにより、ドキュメントのメンション通知がオンになっている場合に、コメントでメンションされたことがユーザーに通知されます。APIを介してコメント内でユーザーに言及する場合は、ユーザーのテクニカルIDを介してユーザーを参照します。たとえば、テクニカルIDが2のユーザーに言及する場合は、次のようにコメントテキストに「@[ User: 2 ]」を含めます。
<comment>
<commentable-id type="integer">123456</commentable-id>
<commentable-type>InvoiceHeader</commentable-type>
<comments>@ [User: 2]こちらのコメントをご覧ください</comments>
</comment>コメントのメンションについて詳しくは、こちらをご覧ください。