コメントスレッドからすべてのコメントと返信を取得

GET

https://api.frame.io/v2/assets/:asset_id/comments

GET

/v2/assets/:asset_id/comments

1 import requests
2 
3 url = "https://api.frame.io/v2/assets/asset_id/comments"
4 
5 headers = {"Authorization": "Bearer <token>"}
6 
7 response = requests.get(url, headers=headers)
8 
9 print(response.json())

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

このエンドポイントは、すべてのコメントと返信をフラットなリストで返します。

認証

AuthorizationBearer

Bearer <token>形式のBearer認証。tokenは認証トークンです。

パスパラメータ

asset_idstring必須形式: "uuid"

クエリパラメータ

includestringオプション

レスポンスヘッダー

linkstringオプション

Pagination links

page-numberinteger

Current page of results

per-pageinteger

Number of entries per page

totalinteger

Total entries across all pagess

total-pagesinteger

Number of pages

レスポンス

Comments success response

annotationstringオプション

completedbooleanオプション

completed_atstringオプション

completer_idstringオプション形式: "uuid"

has_repliesbooleanオプション

idstringオプション形式: "uuid"

like_countintegerオプション

ownerobjectオプション

ユーザーモデル

owner_idstringオプション形式: "uuid"

textstringオプション

timestampintegerオプション

エラー

401

Unauthorized Error

404

Not Found Error