코멘트 목록

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 }

지정된 에셋의 코멘트를 나열합니다.
요청 제한: account_user당 1.00분당 100회 호출

인증

AuthorizationBearer

Bearer <token> 형식의 Bearer 인증. 여기서 token은 인증 토큰입니다.

경로 매개변수

account_idstring필수

Frame.io 또는 Adobe 엔터티 식별자입니다. 일반적으로 Frame.IO UUID입니다. 그러나 Workfront에 연결된 계정 및 프로젝트의 경우 Adobe 클라우드 스토리지에 상주하는 계정, 프로젝트, 폴더, 파일 및 버전 스택의 경우 Adobe에서 할당한 ID를 서로 바꿔 사용할 수도 있습니다. 이러한 ID는 접두사로 adobe:(예: 계정의 경우 adobe:<adobe_org_id>, 프로젝트나 폴더의 경우 adobe:<adobe_asset_id>, 파일 에셋의 경우 adobe:adobe:<adobe_asset_id>|<version>`)를 붙여야 합니다.

Frame.io 또는 Adobe 엔터티 식별자입니다. 일반적으로 Frame.IO UUID입니다. 그러나 Workfront에 연결된 계정 및 프로젝트의 경우 Adobe 클라우드 스토리지에 상주하는 계정, 프로젝트, 폴더, 파일 및 버전 스택의 경우 Adobe에서 할당한 ID를 서로 바꿔 사용할 수도 있습니다. 이러한 ID는 접두사로 `adobe:`(예: 계정의 경우 `adobe:<adobe_org_id>`, 프로젝트나 폴더의 경우 `adobe:<adobe_asset_id>`, 파일 에셋의 경우 `adobe:`adobe:<adobe_asset_id>|<version>`)를 붙여야 합니다.

file_idstring필수

쿼리 매개변수

timestamp_as_timecodeboolean선택 사항

includeenum선택 사항

코멘트용 include 쿼리 매개변수

허용된 값:

sortenum선택 사항

쿼리 매개변수로 코멘트 정렬

afterstring선택 사항

페이지네이션 결과를 반환하는 요청에 사용되는 불투명 커서 쿼리 매개변수입니다.

참고: 이 값은 자동으로 생성되어 이전 응답 링크의 일부로 포함됩니다. 사람이 직접 읽을 수 있도록 고안된 값은 아닙니다.

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