Update comment | Frame.io API Documentation

from frameio import Frameio, Anchor, LinkParams, TextReviewAnnotationUpdate
from frameio.comments import UpdateCommentParamsData
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.comments.update(
    account_id="101a9789-2648-419d-b579-8f4dc1302416",
    comment_id="59d111ee-e8b8-472c-bb33-1690a15a83d2",
    data=UpdateCommentParamsData(
        anchor=Anchor(
            x=0.5,
            y=0.5,
        ),
        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}]",
        completed=False,
        duration=10,
        links=[
            LinkParams(
                end_index=13,
                start_index=5,
                url="https://www.example.com",
            )
        ],
        page=4,
        text="This is great!",
        text_review_annotation=TextReviewAnnotationUpdate(
            selection_text="existing copy",
            suggested_text="updated copy",
        ),
        timestamp=100,
    ),
)

{
  "data": {
    "annotation": "annotation",
    "attachments": [
      {
        "created_at": "2024-02-02T21:19:24.828948Z",
        "file_size": 1024000,
        "id": "0905c4d9-a42b-40d6-a102-131249330016",
        "media_type": "image/png",
        "name": "screenshot.png",
        "upload_urls": [
          "https://s3.amazonaws.com/bucket/part1?signature=..."
        ]
      }
    ],
    "completed_at": null,
    "completer_id": null,
    "created_at": "2024-02-02T21:19:24.828948Z",
    "duration": 10,
    "file_id": "4ae08df1-b419-4897-aba5-560198a18237",
    "id": "e033ea2d-f46f-4cb0-a3e5-0b1ff6567874",
    "links": [
      {
        "end_index": 13,
        "start_index": 5,
        "text": "Test User",
        "url": "https://www.example.com"
      }
    ],
    "mentions": [
      {
        "end_index": 13,
        "start_index": 5,
        "text": "Test User",
        "user_id": "59a23df3-ba2f-40ba-b432-332c7109ea01"
      }
    ],
    "page": 1,
    "text": "This is great!",
    "text_edited_at": "2024-02-02T21:19:24.828948Z",
    "text_review_annotation": {
      "bounds": [
        {
          "height": 42,
          "width": 130,
          "x": 12.5,
          "y": 24
        }
      ],
      "selection_text": "existing copy",
      "suggested_text": "updated copy",
      "text_review_annotation_type": "replace"
    },
    "timestamp": 123,
    "updated_at": "2024-02-02T21:19:24.828948Z",
    "anchor": {
      "x": 0.5,
      "y": 0.5
    }
  }
}

Update comment on given asset.
Rate Limits: 10 calls per 1.00 minute(s) per account_user

認証

AuthorizationBearer

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

パスパラメータ

account_idstring必須

A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be prefixed with `adobe:` (e.g. `adobe:<adobe_org_id>` for an account, `adobe:<adobe_asset_id>` for a project or folder, `adobe:`adobe:<adobe_asset_id>|<version>` for a file asset).

comment_idstring必須形式: "uuid"

A UUID string that uniquely identifies a Frame.io entity.

クエリパラメータ

timestamp_as_timecodebooleanオプション

リクエスト

Comment params body

dataobject必須

レスポンスヘッダー

x-ratelimit-limitinteger

Rate limit

x-ratelimit-remaininginteger

Rate limit remaining

x-ratelimit-windowinteger

Rate limit window in milliseconds

レスポンス

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