Показать общий ресурс

GET

https://api.frame.io/v4/accounts/:account_id/shares/:share_id

GET

/v4/accounts/:account_id/shares/:share_id

1 from frameio_experimental import FrameioExperimental
2 
3 client = FrameioExperimental(
4     token="YOUR_TOKEN_HERE",
5 )
6 
7 client.shares.show(
8     account_id="a578da1b-8e57-4e31-a28b-99f5bd187210",
9     share_id="404789f2-e9f9-4a30-99c2-2f188cc9c191",
10 )

1 {
2   "data": {
3     "enabled": true,
4     "access": "public",
5     "last_viewed_at": "2024-03-02T21:19:24.828948Z",
6     "updated_at": "2024-02-02T21:19:24.828948Z",
7     "editable_fields_enabled": false,
8     "commenting_enabled": true,
9     "description": "Description of share",
10     "sort_by": {
11       "direction": "asc",
12       "field_definition_id": "8b5f9b2b-51a8-4da1-89bc-d980d0de50fb"
13     },
14     "created_at": "2024-02-02T21:19:24.828948Z",
15     "forensic_watermark_enabled": false,
16     "name": "Test Share",
17     "collection_id": "781974b4-8857-4abf-b1d1-ca11cd424988",
18     "short_url": "https://f.io/GGa9wPw5",
19     "drm_enabled": false,
20     "watermark_enabled": true,
21     "featured_field_definition_id": "fb2f1f6b-bcd3-4733-a98a-9841be2ac8a2",
22     "downloading_enabled": true,
23     "id": "43e37c33-d2b7-4461-b8f0-dce4a3c8761b",
24     "expiration": "2026-08-06T01:02:17.474223Z",
25     "visible_field_definition_ids": [
26       "db852331-2055-412d-8aaf-c4b753837fd8"
27     ],
28     "card_info_enabled": true,
29     "icons_visible_on_list": true,
30     "theme": "dark",
31     "card_aspect_ratio": "square",
32     "passphrase": "as!dfj39sd(*",
33     "list_row_size": "small",
34     "card_size": "medium",
35     "reel_card_aspect_ratio": "square",
36     "show_asset_name_in_reel_layout": false,
37     "captions_enabled": true,
38     "transcripts_enabled": true,
39     "reel_card_fit_image": false,
40     "open_in_viewer_enabled": true,
41     "accent_color": "#FF0000",
42     "layout": "grid",
43     "show_all_asset_versions": true,
44     "name_column_width": null,
45     "thumbnail_scale": "fill",
46     "title_line_count": 1,
47     "featured_field_definition": {
48       "created_at": "2024-01-25T19:18:29.614189Z",
49       "creator_id": "8965d4bf-9515-4b64-9196-93d2770da03d",
50       "field_configuration": {
51         "enable_add_new": false,
52         "options": [
53           {
54             "display_name": "Option 1",
55             "id": "6b339ab4-0bef-4e63-af8f-ed38d3b5e9bb"
56           },
57           {
58             "display_name": "Option 2",
59             "id": "2d486991-30e1-40e8-96fd-32ddb1cd26da"
60           }
61         ]
62       },
63       "field_type": "select",
64       "id": "19536695-8b55-4ac9-81d8-bdbca7b7c2fb",
65       "mutable": true,
66       "name": "Fields definition name",
67       "updated_at": "2024-02-07T16:44:41.986478Z"
68     },
69     "visible_field_definitions": [
70       {
71         "field_type": "select",
72         "created_at": "2024-01-25T19:18:29.614189Z",
73         "creator_id": "8965d4bf-9515-4b64-9196-93d2770da03d",
74         "field_configuration": {
75           "options": [
76             {
77               "display_name": "Option 1",
78               "id": "6b339ab4-0bef-4e63-af8f-ed38d3b5e9bb"
79             },
80             {
81               "display_name": "Option 2",
82               "id": "2d486991-30e1-40e8-96fd-32ddb1cd26da"
83             }
84           ],
85           "enable_add_new": false
86         },
87         "id": "19536695-8b55-4ac9-81d8-bdbca7b7c2fb",
88         "mutable": true,
89         "name": "Fields definition name",
90         "updated_at": "2024-02-07T16:44:41.986478Z"
91       }
92     ]
93   }
94 }

Show a share.
Rate Limits: 100 calls per 1.00 minute(s) per account_user

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

AuthorizationBearer

Аутентификация Bearer в форме Bearer <token>, где 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).

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).

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

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

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

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

Include query parameter for shares — expands featured_field_definition and/or visible_field_definitions into full objects in the response.

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

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

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