コメントAPI
コメントAPIを使用して、Coupaドキュメントのコメントを作成、表示、更新します。
はじめに
契約条件にアクセスするためのURLは次のとおりですhttps://<instance>/api/comments。URLの最後に追加することで、コメントに添付ファイルを /attachments 含めることもできます。制限については、以下の警告を参照してください。
アクション
コメントをGETまたはPOSTするには、データを取得するオブジェクトのAPIを使用し、URLの最後に追加します。次のように表示されま /comments す。
/api/{transactional_object}/{object_id}/comments。
GET呼び出しを使用すると、ドキュメントのすべてのコメントが取得されます。POST呼び出しでは、新しいコメントが追加されます。
コメントは、を使用して追加することもできます。こ /api/commentsの場合、ペイロードはGETまたはPOSTを適切に実行するために必要です。
コメント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/requisition/:requisition_id/comments | 作成 | コメントを作成 |
| 取得 | /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/requisition/:requisition_id/comments | インデックス | クエリコメント |
| 取得 | /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/requisition/:requisition_id/comments/:id | 表示 | コメントを表示 |
- ネストされたループを持つエンドポイントに無効なIDを渡すとエアブレーキになり、他のオブジェクトでも同じになりま
/api/comments/{invalid comment id}/attachmentsす - URLタイプの添付IDをエンドポイントに渡して特定の添付ファイルを表示する際
/api/comments/{comment id}/attachments/{URL type attachment id}に、次のエラーが表示されます：添付ファイルにファイルが添付されていません
要素
コメントAPIでは次の要素を使用できます。
| 要素 | 説明 | 必須フィールドですか？ | 一意ですか？ | 許容値 | Api-Inフィールド | Api出力フィールドですか？ | データタイプ |
|---|---|---|---|---|---|---|---|
| 添付ファイル | attachments | はい | 該当なし | ||||
| コメント可能ID | コメント可能ID | はい | はい | 整数 | |||
| コメント可能タイプ | コメント可能タイプ | はい | はい | 文字列（255） | |||
| コメントタイプ | コメントのタイプを表示し、内部使用のみを目的としています | はい | 文字列（255） | ||||
| comments | 投稿するコメント。コメントフィールドの一部としてを含める @[User:{id}]ことで、ユーザーをメンションできます。 |
はい | はい | テキスト | |||
| created-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | はい | 日時 | ||||
| 作成者 | コメントを作成したユーザー。 | はい | ユーザー | ||||
| id | コメントに対するCoupaの一意の識別子。 | はい | 整数 | ||||
| 理由コード | コメント理由コード | はい | 文字列（255） | ||||
| 送信先サプライヤー | サプライヤーに表示しますか？ | はい | はい | ブール値 | |||
| updated-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | はい | 日時 | ||||
| 更新者 | 更新したユーザー | はい | ユーザー |
例：POSTコール
<comment>
<commentable-id type="integer">123456</commentable-id>
<commentable-type>InvoiceHeader</commentable-type>
<comments>COMMENT TEXT</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] please see this comment</comments>
</comment>メンションの詳細については、コメントを参照してくださ い。
このページに表示されている一部、または全ての内容は、機械翻訳によるものです。ご了承ください。