コメント作成 Tier 4

POST/api/files/:id/commentsCopied!

コメント、または既存コメントへの返信を作成します。

例

SDKCLIcURL

const comment = await client.comments.createForFile("FX1234567890ABCD", {
  content: "Looks great, approved.",
  anchor: 12000,
  duration: 3000,
  parent: { id: "0efee6f8-5829-41c9-bb4d-90dd7e72cc58" },
});

bash

youvico comment create \
  --file FX1234567890ABCD \
  --content "Looks great, approved." \
  --anchor 12000 \
  --duration 3000 \
  --parent 0efee6f8-5829-41c9-bb4d-90dd7e72cc58

bash

curl -X POST 'https://api.youvico.com/api/files/FX1234567890ABCD/comments' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "content": "Looks great, approved.", "anchor": 12000, "duration": 3000, "parent": { "id": "0efee6f8-5829-41c9-bb4d-90dd7e72cc58" } }'

json

{
  "data": {
    "id": "2fb4e60b-0d9a-46f3-a4dc-cb9fe8ad9be6"
  }
}

リクエスト

パス

idstringrequired

ファイルID

ボディ

contentstring

Maximum 2000 characters

コメント本文

anchornumber

0 or greater

動画ではミリ秒単位のタイムスタンプ、ドキュメントでは1から始まるページ番号

durationnumber

0 or greater

anchorと同じ単位のコメント継続時間

parentobject

親コメントオブジェクト

parent.idstringrequired

親コメントID

Example: 0efee6f8-5829-41c9-bb4d-90dd7e72cc58

attachmentsarray

1-10 items

コメントに紐づけるアップロード済み添付ファイル

attachments[].idstringrequired

コメント添付ファイルID

Example: CA1234567890ABCD

INFO

content、anchor、attachments のいずれか1つ以上を指定する必要があります。duration は anchor がある場合にのみ指定できます。

INFO

各添付ファイルIDは一意で、同じユーザーがこのファイル向けに開始して完了し、まだ別のコメントに紐づけられていないアップロードを参照する必要があります。

WARNING

返信への返信は作成できません。parent.id はトップレベルコメントを指す必要があります。

レスポンス

201 Created を返します。

dataobject

作成されたコメント

data.idstring

作成されたコメントのID

Example: 2fb4e60b-0d9a-46f3-a4dc-cb9fe8ad9be6

コメント作成 Tier 4 ​

例 ​

リクエスト ​

パス ​

ボディ ​

レスポンス ​

コメント作成 Tier 4

例

リクエスト

パス

ボディ

レスポンス