Создание списка дочерних элементов в стеке версий

GET

https://api.frame.io/v4/accounts/:account_id/version_stacks/:version_stack_id/children

GET

/v4/accounts/:account_id/version_stacks/:version_stack_id/children

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN_HERE",
5 )
6 
7 client.version_stacks.index(
8     account_id="a17fe10b-3d45-4fad-b695-fa92651520ec",
9     version_stack_id="bbdfd455-6868-4519-b43c-11485e8e9ee3",
10     include="media_links.original",
11 )

1 {
2   "data": [
3     {
4       "type": "file",
5       "created_at": "2023-09-25T19:18:29.614189Z",
6       "file_size": 1137444,
7       "id": "b4c00e24-9beb-4c38-91ad-8f58a88f5a8a",
8       "media_type": "image/png",
9       "name": "asset.png",
10       "parent_id": "6ecaf9c3-23ab-4031-8dc8-8acbfec1afbd",
11       "project_id": "70e467b0-c8ab-4881-9c63-836664103a26",
12       "status": "created",
13       "updated_at": "2024-02-07T16:44:41.986478Z",
14       "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/view/5a89a9fb-0900-4b23-826b-127b90e4db4c",
15       "adobe_id": "urn:aaid:sc:US:a1b2c3d4-e5f6-7890-abcd-ef1234567890",
16       "adobe_version_id": "2",
17       "creator": {
18         "active": true,
19         "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",
20         "email": "user_email@example.com",
21         "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
22         "name": "Jon Doe"
23       },
24       "media_links": {
25         "high_quality": {
26           "download_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"
27         },
28         "original": {
29           "download_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",
30           "inline_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=inline%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragSDFXDFh&1Key-Pair-Id=KKI497NESTHMN"
31         },
32         "thumbnail": {
33           "download_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",
34           "url": "https://picture2.frame.io/image/s3://frameio-assets-development/image/cd58cb8e-24b3-4498-8d0f-9532fcd04d11/image_full.png?alg=HS256&sig=0_u7w_wz2MwQHOXp000ibbQSMRijujyaUu8V3YYPxu4&exp=1729857600"
35         }
36       },
37       "metadata": [
38         {
39           "field_type": "select",
40           "field_definition_id": "36279dd3-a607-432e-ad85-2005522b3c4e",
41           "field_definition_name": "Fields definition name",
42           "mutable": true,
43           "value": [
44             {
45               "display_name": "Display name",
46               "id": "6711d43d-b717-4765-bde4-994bf39f88df"
47             }
48           ],
49           "field_options": [
50             {
51               "display_name": "Display name",
52               "id": "6711d43d-b717-4765-bde4-994bf39f88df"
53             },
54             {
55               "display_name": "Display name 2",
56               "id": "6f10a133-919f-43f0-8e67-13efc50ba439"
57             }
58           ]
59         }
60       ],
61       "project": {
62         "created_at": "2024-01-25T19:18:29.614189Z",
63         "id": "90d3f72c-abed-463f-8d1b-1c3c084556e1",
64         "name": "My Project",
65         "root_folder_id": "a8426cb1-5056-4010-92d0-416e2c0d3a78",
66         "status": "active",
67         "storage": 15000,
68         "updated_at": "2024-02-07T16:44:41.986478Z",
69         "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/",
70         "workspace_id": "f9cc69f8-c0f8-4176-9eb1-3049c4b6b647",
71         "description": "Project Description",
72         "adobe_id": "urn:aaid:sc:US:9f4e4d7a-4b6b-4c4f-9f00-b31a91cfc6f3",
73         "restricted": false,
74         "owner": {
75           "active": true,
76           "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",
77           "email": "user_email@example.com",
78           "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
79           "name": "Jon Doe"
80         }
81       }
82     }
83   ],
84   "links": {
85     "next": "/v4/accounts/123/folders/123/version_stacks"
86   },
87   "total_count": 10
88 }

Создание списка дочерних (файлов) в указанном стеке версий.

Использовать параметр запроса “включить” для избирательного включения дополнительных свойств в ответ.

Примечание. Если вы включаете “media_links.original”, а у пользователя нет разрешения на загрузку файлов в соответствующем проекте, тогда эта конечная точка ответит ошибкой “403 запрещено”. Если контент недоступен, так как для этого пользователя требуется наложение водяных знаков, а запрашиваемые media_links не поддерживают этот контент, запрос будет выполнен, но для неподдерживаемых ссылок на медиафайлы будет установлено значение null. Аналогично, если запрошенная ссылка на транскодирование не существует для определенного файла (например, включая “media_links.video_h264_180” на файл со статичным изображением) или процесс транскодирования не завершен (например, статус файла “добавлен”, а не “транскодирован”), тогда для ссылки на медиафайлы будет установлено значение null в теле ответа. Одним словом, клиенту необходимо уметь работать со ссылками на медиафайлы со значением null.
Лимиты запросов: 100 вызовов за 1 мин. для account_user

Создание списка дочерних (файлов) в указанном стеке версий. <br/> Использовать параметр запроса "включить" для избирательного включения дополнительных свойств в ответ. <br/> Примечание. Если вы включаете "media_links.original", а у пользователя нет разрешения на загрузку файлов в соответствующем проекте, тогда эта конечная точка ответит ошибкой "403 запрещено". Если контент недоступен, так как для этого пользователя требуется наложение водяных знаков, а запрашиваемые media_links не поддерживают этот контент, запрос будет выполнен, но для неподдерживаемых ссылок на медиафайлы будет установлено значение null. Аналогично, если запрошенная ссылка на транскодирование не существует для определенного файла (например, включая "media_links.video_h264_180" на файл со статичным изображением) или процесс транскодирования не завершен (например, статус файла "добавлен", а не "транскодирован"), тогда для ссылки на медиафайлы будет установлено значение null в теле ответа. Одним словом, клиенту необходимо уметь работать со ссылками на медиафайлы со значением null. <br/>Лимиты запросов: 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> для файла).

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

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

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

Поддерживаемые значения параметра запроса для включения конечных точек, которые возвращают файлы со ссылками на медиафайлы

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