Создание списка комментариев

GET

https://api.frame.io/v4/accounts/:account_id/files/:file_id/comments

GET

/v4/accounts/:account_id/files/:file_id/comments

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN_HERE",
5 )
6 
7 client.comments.index(
8     account_id="31fdeef3-fc77-4fb6-bd42-b04d1aa8de19",
9     file_id="14ec6395-07ad-44b9-be0e-f1414867a71f",
10 )

1 {
2   "data": [
3     {
4       "annotation": "annotation",
5       "attachments": [
6         {
7           "created_at": "2024-02-02T21:19:24.828948Z",
8           "file_size": 1024000,
9           "id": "971093ae-46ee-47c5-b227-1757be688848",
10           "media_type": "image/png",
11           "name": "screenshot.png",
12           "upload_urls": [
13             "https://s3.amazonaws.com/bucket/part1?signature=..."
14           ]
15         }
16       ],
17       "completed_at": null,
18       "completer_id": null,
19       "created_at": "2024-02-02T21:19:24.828948Z",
20       "duration": 10,
21       "file_id": "4ae08df1-b419-4897-aba5-560198a18237",
22       "id": "29de1290-df8e-4908-91bf-090a628b44e7",
23       "links": [
24         {
25           "end_index": 13,
26           "start_index": 5,
27           "text": "Test User",
28           "url": "https://www.example.com"
29         }
30       ],
31       "mentions": [
32         {
33           "end_index": 13,
34           "start_index": 5,
35           "text": "Test User",
36           "user_id": "8b9259a4-384f-4406-bb47-7d94293636dd"
37         }
38       ],
39       "page": 1,
40       "text": "This is great!",
41       "text_edited_at": "2024-02-02T21:19:24.828948Z",
42       "text_review_annotation": {
43         "bounds": [
44           {
45             "height": 42,
46             "width": 130,
47             "x": 12.5,
48             "y": 24
49           }
50         ],
51         "selection_text": "existing copy",
52         "suggested_text": "updated copy",
53         "text_review_annotation_type": "replace"
54       },
55       "timestamp": 123,
56       "updated_at": "2024-02-02T21:19:24.828948Z",
57       "anchor": {
58         "x": 0.5,
59         "y": 0.5
60       },
61       "owner": {
62         "active": true,
63         "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN",
64         "email": "user_email@example.com",
65         "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
66         "name": "Jon Doe"
67       },
68       "replies": []
69     },
70     {
71       "annotation": "annotation",
72       "attachments": [
73         {
74           "created_at": "2024-02-02T21:19:24.828948Z",
75           "file_size": 1024000,
76           "id": "971093ae-46ee-47c5-b227-1757be688848",
77           "media_type": "image/png",
78           "name": "screenshot.png",
79           "upload_urls": [
80             "https://s3.amazonaws.com/bucket/part1?signature=..."
81           ]
82         }
83       ],
84       "completed_at": null,
85       "completer_id": null,
86       "created_at": "2024-02-02T21:19:24.828948Z",
87       "duration": 10,
88       "file_id": "4ae08df1-b419-4897-aba5-560198a18237",
89       "id": "29de1290-df8e-4908-91bf-090a628b44e7",
90       "links": [
91         {
92           "end_index": 13,
93           "start_index": 5,
94           "text": "Test User",
95           "url": "https://www.example.com"
96         }
97       ],
98       "mentions": [
99         {
100           "end_index": 13,
101           "start_index": 5,
102           "text": "Test User",
103           "user_id": "8b9259a4-384f-4406-bb47-7d94293636dd"
104         }
105       ],
106       "page": 1,
107       "text": "This is great!",
108       "text_edited_at": "2024-02-02T21:19:24.828948Z",
109       "text_review_annotation": {
110         "bounds": [
111           {
112             "height": 42,
113             "width": 130,
114             "x": 12.5,
115             "y": 24
116           }
117         ],
118         "selection_text": "existing copy",
119         "suggested_text": "updated copy",
120         "text_review_annotation_type": "replace"
121       },
122       "timestamp": 123,
123       "updated_at": "2024-02-02T21:19:24.828948Z",
124       "anchor": {
125         "x": 0.5,
126         "y": 0.5
127       },
128       "owner": {
129         "active": true,
130         "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN",
131         "email": "user_email@example.com",
132         "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
133         "name": "Jon Doe"
134       },
135       "replies": [
136         {
137           "annotation": "annotation",
138           "attachments": [
139             {
140               "created_at": "2024-02-02T21:19:24.828948Z",
141               "file_size": 1024000,
142               "id": "971093ae-46ee-47c5-b227-1757be688848",
143               "media_type": "image/png",
144               "name": "screenshot.png",
145               "upload_urls": [
146                 "https://s3.amazonaws.com/bucket/part1?signature=..."
147               ]
148             }
149           ],
150           "completed_at": null,
151           "completer_id": null,
152           "created_at": "2024-02-02T21:19:24.828948Z",
153           "duration": 10,
154           "file_id": "4ae08df1-b419-4897-aba5-560198a18237",
155           "id": "29de1290-df8e-4908-91bf-090a628b44e7",
156           "links": [
157             {
158               "end_index": 13,
159               "start_index": 5,
160               "text": "Test User",
161               "url": "https://www.example.com"
162             }
163           ],
164           "mentions": [
165             {
166               "end_index": 13,
167               "start_index": 5,
168               "text": "Test User",
169               "user_id": "8b9259a4-384f-4406-bb47-7d94293636dd"
170             }
171           ],
172           "page": 1,
173           "text": "This is great!",
174           "text_edited_at": "2024-02-02T21:19:24.828948Z",
175           "text_review_annotation": {
176             "bounds": [
177               {
178                 "height": 42,
179                 "width": 130,
180                 "x": 12.5,
181                 "y": 24
182               }
183             ],
184             "selection_text": "existing copy",
185             "suggested_text": "updated copy",
186             "text_review_annotation_type": "replace"
187           },
188           "timestamp": 123,
189           "updated_at": "2024-02-02T21:19:24.828948Z",
190           "anchor": {
191             "x": 0.5,
192             "y": 0.5
193           }
194         }
195       ]
196     }
197   ],
198   "links": {
199     "next": "/v4/accounts/123/files/123/comments"
200   },
201   "total_count": 10
202 }

Создание списка комментариев для указанного ресурса.
Лимиты запросов: 100 вызовов за 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> для файла).

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

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

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

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

Включить параметр запроса для комментариев

Допустимые значения:

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

Сортировка комментариев по параметрам запроса

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

Параметр запроса “Непрозрачный курсор” для запросов, возвращающих результаты с разбивкой на страницы.

ПРИМЕЧАНИЕ. Это автоматически создаваемое значение, которое включается как часть ссылок из предыдущего ответа. Оно не предназначено для чтения пользователями.

Параметр запроса "Непрозрачный курсор" для запросов, возвращающих результаты с разбивкой на страницы. <br/> ПРИМЕЧАНИЕ. Это автоматически создаваемое значение, которое включается как часть ссылок из предыдущего ответа. Оно не предназначено для чтения пользователями.

page_sizeintegerОпциональный1-100По умолчанию 50

Параметр запроса размера страницы для запросов

include_total_countbooleanОпциональныйПо умолчанию false

Параметр запроса страницы для включения количества всех объектов

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

x-ratelimit-limitinteger

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

x-ratelimit-remaininginteger

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

x-ratelimit-windowinteger

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

Ответ

ОК

datalist of objects

Комментарии

linksobject

Ссылки на данные с разбиением на страницы

total_countinteger or nullОпциональный

Общее количество

Ошибки

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