Обновить комментарий

PUT

https://api.frame.io/v2/comments/:comment_id

PUT

/v2/comments/:comment_id

1 import requests
2 
3 url = "https://api.frame.io/v2/comments/eefb57e0-79f2-4bc7-9b70-99fbc175175c"
4 
5 payload = { "text": "string" }
6 headers = {
7     "Authorization": "Bearer <token>",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.put(url, json=payload, headers=headers)
12 
13 print(response.json())

1 {
2   "annotation": "[...]",
3   "completed": false,
4   "completed_at": "2020-07-15T17:30:00.906305Z",
5   "completer_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
6   "has_replies": true,
7   "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
8   "like_count": 10,
9   "owner": {
10     "email": "jane@frame.io",
11     "name": "Jane Doe",
12     "account_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
13     "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
14   },
15   "owner_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
16   "text": "This is a comment.",
17   "timestamp": 60
18 }

Обновление комментария по его ИД, перезаписав только переданные пары “ключ/значение”

Аутентификация

AuthorizationBearer

Аутентификация Bearer в форме Bearer <token>, где token — ваш токен аутентификации.

Параметры пути

comment_idstringОбязательныйformat: "uuid"

Comment ID

Запрос

Comment to create or update

textstringОбязательный

The body of the comment.

annotationstringОпциональный

Serialized list of geometry and/or drawing data.

Learn more here

Serialized list of geometry and/or drawing data. Learn more [here](https://developer.frame.io/docs/workflows-assets/working-with-annotations)

pageintegerОпциональный

Page number for a comment (documents only).

timestampdoubleОпциональный

Timestamp for the comment, in frames, starting at 0.

Comments can “global” to an asset in which you don’t provide the timestamp, or if you’re reviewing a “document” like a PDF then you would use page instead of timestamp to identify where the comment belongs.

durationintegerОпциональный

Used to produce range-based comments, this is the duration measured in frames.

privatebooleanОпциональный

Set to true to make your comment a “Team-only Comment” that won’t be visible to anonymous reviewers or Collaborators.

pitchintegerОпциональныйDeprecated

Pitch measurement for the comment (360deg video only).

yawintegerОпциональныйDeprecated

Yaw measurement for the comment (360deg video only).

Ответ

Comment success response

annotationstringОпциональный

completedbooleanОпциональный

completed_atstringОпциональный

completer_idstringОпциональныйformat: "uuid"

has_repliesbooleanОпциональный

idstringОпциональныйformat: "uuid"

like_countintegerОпциональный

ownerobjectОпциональный

Модель пользователя

owner_idstringОпциональныйformat: "uuid"

textstringОпциональный

timestampintegerОпциональный

Ошибки

401

Unauthorized Error

404

Not Found Error