Mostra condivisione | Frame.io API Documentation

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

{
  "data": {
    "enabled": true,
    "access": "public",
    "last_viewed_at": "2024-03-02T21:19:24.828948Z",
    "updated_at": "2024-02-02T21:19:24.828948Z",
    "editable_fields_enabled": false,
    "commenting_enabled": true,
    "description": "Description of share",
    "sort_by": {
      "direction": "asc",
      "field_definition_id": "8b5f9b2b-51a8-4da1-89bc-d980d0de50fb"
    },
    "created_at": "2024-02-02T21:19:24.828948Z",
    "forensic_watermark_enabled": false,
    "name": "Test Share",
    "collection_id": "781974b4-8857-4abf-b1d1-ca11cd424988",
    "short_url": "https://f.io/GGa9wPw5",
    "drm_enabled": false,
    "watermark_enabled": true,
    "featured_field_definition_id": "fb2f1f6b-bcd3-4733-a98a-9841be2ac8a2",
    "downloading_enabled": true,
    "id": "43e37c33-d2b7-4461-b8f0-dce4a3c8761b",
    "expiration": "2026-08-06T01:02:17.474223Z",
    "visible_field_definition_ids": [
      "db852331-2055-412d-8aaf-c4b753837fd8"
    ],
    "card_info_enabled": true,
    "icons_visible_on_list": true,
    "theme": "dark",
    "card_aspect_ratio": "square",
    "passphrase": "as!dfj39sd(*",
    "list_row_size": "small",
    "card_size": "medium",
    "reel_card_aspect_ratio": "square",
    "show_asset_name_in_reel_layout": false,
    "captions_enabled": true,
    "transcripts_enabled": true,
    "reel_card_fit_image": false,
    "open_in_viewer_enabled": true,
    "accent_color": "#FF0000",
    "layout": "grid",
    "show_all_asset_versions": true,
    "name_column_width": null,
    "thumbnail_scale": "fill",
    "title_line_count": 1,
    "featured_field_definition": {
      "created_at": "2024-01-25T19:18:29.614189Z",
      "creator_id": "8965d4bf-9515-4b64-9196-93d2770da03d",
      "field_configuration": {
        "enable_add_new": false,
        "options": [
          {
            "display_name": "Option 1",
            "id": "6b339ab4-0bef-4e63-af8f-ed38d3b5e9bb"
          },
          {
            "display_name": "Option 2",
            "id": "2d486991-30e1-40e8-96fd-32ddb1cd26da"
          }
        ]
      },
      "field_type": "select",
      "id": "19536695-8b55-4ac9-81d8-bdbca7b7c2fb",
      "mutable": true,
      "name": "Fields definition name",
      "updated_at": "2024-02-07T16:44:41.986478Z"
    },
    "visible_field_definitions": [
      {
        "field_type": "select",
        "created_at": "2024-01-25T19:18:29.614189Z",
        "creator_id": "8965d4bf-9515-4b64-9196-93d2770da03d",
        "field_configuration": {
          "options": [
            {
              "display_name": "Option 1",
              "id": "6b339ab4-0bef-4e63-af8f-ed38d3b5e9bb"
            },
            {
              "display_name": "Option 2",
              "id": "2d486991-30e1-40e8-96fd-32ddb1cd26da"
            }
          ],
          "enable_add_new": false
        },
        "id": "19536695-8b55-4ac9-81d8-bdbca7b7c2fb",
        "mutable": true,
        "name": "Fields definition name",
        "updated_at": "2024-02-07T16:44:41.986478Z"
      }
    ]
  }
}

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

Autenticazione

AuthorizationBearer

Autenticazione bearer nella forma Bearer <token>, dove token è il tuo token di autenticazione.

Parametri di percorso

account_idstringObbligatorio

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_idstringObbligatorioformat: "uuid"

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

Parametri di query

includeenumOpzionale

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

Valori consentiti:

Header di risposta

x-ratelimit-limitinteger

Rate limit

x-ratelimit-remaininginteger

Rate limit remaining

x-ratelimit-windowinteger

Rate limit window in milliseconds

Risposta

dataobject

Errori

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