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

PATCH

https://api.frame.io/v4/accounts/:account_id/comments/:comment_id

PATCH

/v4/accounts/:account_id/comments/:comment_id

1 from frameio import Frameio, Anchor, LinkParams, TextReviewAnnotationUpdate
2 from frameio.comments import UpdateCommentParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN_HERE",
6 )
7 
8 client.comments.update(
9     account_id="693e9823-7c02-48d1-b354-70745deeff4a",
10     comment_id="870ab4a2-3ba0-4394-a682-5d097d569278",
11     data=UpdateCommentParamsData(
12         anchor=Anchor(
13             x=0.5,
14             y=0.5,
15         ),
16         annotation="[{\"tool\":\"rect\",\"color\":\"#F22237\",\"size\":8,\"x\":0.277726001863933,\"y\":0.12909555568499534,\"w\":0.3153168321877913,\"h\":0.5308131407269339,\"ix\":0.277726001863933,\"iy\":0.12909555568499534,\"radius\":8}]",
17         completed=False,
18         duration=10,
19         links=[
20             LinkParams(
21                 end_index=13,
22                 start_index=5,
23                 url="https://www.example.com",
24             )
25         ],
26         page=4,
27         text="This is great!",
28         text_review_annotation=TextReviewAnnotationUpdate(
29             selection_text="existing copy",
30             suggested_text="updated copy",
31         ),
32         timestamp=100,
33     ),
34 )

1 {
2   "data": {
3     "annotation": "annotation",
4     "attachments": [
5       {
6         "created_at": "2024-02-02T21:19:24.828948Z",
7         "file_size": 1024000,
8         "id": "971093ae-46ee-47c5-b227-1757be688848",
9         "media_type": "image/png",
10         "name": "screenshot.png",
11         "upload_urls": [
12           "https://s3.amazonaws.com/bucket/part1?signature=..."
13         ]
14       }
15     ],
16     "completed_at": null,
17     "completer_id": null,
18     "created_at": "2024-02-02T21:19:24.828948Z",
19     "duration": 10,
20     "file_id": "4ae08df1-b419-4897-aba5-560198a18237",
21     "id": "29de1290-df8e-4908-91bf-090a628b44e7",
22     "links": [
23       {
24         "end_index": 13,
25         "start_index": 5,
26         "text": "Test User",
27         "url": "https://www.example.com"
28       }
29     ],
30     "mentions": [
31       {
32         "end_index": 13,
33         "start_index": 5,
34         "text": "Test User",
35         "user_id": "8b9259a4-384f-4406-bb47-7d94293636dd"
36       }
37     ],
38     "page": 1,
39     "text": "This is great!",
40     "text_edited_at": "2024-02-02T21:19:24.828948Z",
41     "text_review_annotation": {
42       "bounds": [
43         {
44           "height": 42,
45           "width": 130,
46           "x": 12.5,
47           "y": 24
48         }
49       ],
50       "selection_text": "existing copy",
51       "suggested_text": "updated copy",
52       "text_review_annotation_type": "replace"
53     },
54     "timestamp": 123,
55     "updated_at": "2024-02-02T21:19:24.828948Z",
56     "anchor": {
57       "x": 0.5,
58       "y": 0.5
59     }
60   }
61 }

Обновление комментария для указанного ресурса.
Лимиты запросов: 10 вызовов за 1 мин. для account_user

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

AuthorizationBearer

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

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

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

Идентификатор сущности Frame.io или Adobe. Обычно это UUID Frame.io. Но для учетных записей, проектов, папок, файлов и стеков версий, которые хранятся в облачном хранилище Adobe (что характерно для учетных записей и проектов, подключенных к Workfront), в качестве идентификатора также может использоваться назначенный идентификатор Adobe. Эти идентификаторы должны иметь префикс adobe: (например, adobe:<adobe_org_id> для учетной записи, adobe:<adobe_asset_id> для проекта или папки, adobe:adobe:<adobe_asset_id>|<version> для файла).

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

Строка UUID, которая однозначно идентифицирует сущность Frame.io.

Параметры запроса

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

Запрос

Тело параметров комментария

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

Заголовки ответа

x-ratelimit-limitinteger

Лимит запросов

x-ratelimit-remaininginteger

Остаток лимита запросов

x-ratelimit-windowinteger

Окно лимита запросов (в мс)

Ответ

ОК

dataobject

Ошибки

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error