コメントAPI
このページは機械翻訳を使用して翻訳されています。
契約条件にアクセスするためのURL：https://<instance>/api/comments
例：POST呼び出し
<comment> <commentable-id type="integer">123456</commentable-id> <commentable-type>InvoiceHeader</commentable-type> <comments>COMMENT TEXT</comments> </comment>
アクション
コメントを取得または投稿するには、データを取得するオブジェクトの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 / requisitions /：requisition_id / comments | 作成 | コメントを作成 |
| GET | / api / invoices /：invoice_id / comments | インデックス | クエリコメント |
| GET | / api / expense_reports /：expense_report_id / comments | インデックス | クエリコメント |
| GET | / api / purchase_orders /：purchase_order_id / comments | インデックス | クエリコメント |
| GET | / api / users /：user_id / comments | インデックス | クエリコメント |
| GET | / api / requisitions /：requisition_id / comments | インデックス | クエリコメント |
| GET | / api / invoices /：invoice_id / comments /：id | 表示 | コメントを表示 |
| GET | / api / expense_reports /：expense_report_id / comments /：id | 表示 | コメントを表示 |
| GET | / api / purchase_orders /：purchase_order_id / comments /：id | 表示 | コメントを表示 |
| GET | / api / users /：user_id / comments /：id | 表示 | コメントを表示 |
| GET | / api / requisitions /：requisition_id / comments /：id | 表示 | コメントを表示 |
要素
次の要素がComments APIで使用できます。
| 要素 | 説明 | 必須フィールド | 一意ですか？ | 許容値 | Api_Inフィールド？ | Api_Outフィールド？ | データタイプ |
|---|---|---|---|---|---|---|---|
| コメント可能ID | commentable_id | はい | はい | 整数 | |||
| コメント可能なタイプ | commentable_type | はい | はい | 文字列（255） | |||
| comments | 投稿するコメント。コメントフィールドの一部として @[User:{id}]を含めることで、ユーザーについて言及できます。 |
はい | はい | テキスト | |||
| created-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | はい | 日時 | ||||
| created_by | コメントを作成したユーザー。 | はい | ユーザーユーザーAPI（/ users）ユーザーAPI（/ users） | ||||
| id | Coupaのコメントに対する一意の識別子。 | はい | 整数 | ||||
| reason_code | コメント理由コード | no | no | 任意 | はい | 文字列（255） |
API経由で投稿されたコメントで特定のユーザーに言及することもできます。これにより、ドキュメントの言及通知がオンになっている場合、コメントで言及されたことがユーザーに通知されます。APIを介してコメントでユーザーに言及する場合、例えば、技術ID 2のユーザーを言及するために、ユーザーの技術IDを介してそれらを参照します-次のように、コメントテキストに "@ [User：2]"を含めます。
<comment> <commentable-id type="integer">123456</commentable-id> <commentable-type>InvoiceHeader</commentable-type> <comments>@[User:2] please see this comment</comments> </comment>
メンションについての詳細は、コメント こちらで読むことができます。