Elenca gli elementi figlio della cartella | Frame.io API Documentation

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.folders.index(
    account_id="5c77ab31-41ee-432a-8013-5ec57eb95e6b",
    folder_id="2cf94114-e51a-44d7-809f-3582226192a1",
    include="media_links.original",
)

{
  "data": [
    {
      "type": "file",
      "created_at": "2023-09-25T19:18:29.614189Z",
      "file_size": 1137444,
      "id": "b4c00e24-9beb-4c38-91ad-8f58a88f5a8a",
      "media_type": "image/png",
      "name": "asset.png",
      "parent_id": "6ecaf9c3-23ab-4031-8dc8-8acbfec1afbd",
      "project_id": "70e467b0-c8ab-4881-9c63-836664103a26",
      "status": "created",
      "updated_at": "2024-02-07T16:44:41.986478Z",
      "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/view/5a89a9fb-0900-4b23-826b-127b90e4db4c",
      "adobe_id": "urn:aaid:sc:US:a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "adobe_version_id": "2",
      "creator": {
        "active": true,
        "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",
        "email": "user_email@example.com",
        "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
        "name": "Jon Doe"
      },
      "media_links": {
        "high_quality": {
          "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"
        },
        "original": {
          "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",
          "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"
        },
        "thumbnail": {
          "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",
          "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"
        }
      },
      "metadata": [
        {
          "field_type": "select",
          "field_definition_id": "36279dd3-a607-432e-ad85-2005522b3c4e",
          "field_definition_name": "Fields definition name",
          "mutable": true,
          "value": [
            {
              "display_name": "Display name",
              "id": "6711d43d-b717-4765-bde4-994bf39f88df"
            }
          ],
          "field_options": [
            {
              "display_name": "Display name",
              "id": "6711d43d-b717-4765-bde4-994bf39f88df"
            },
            {
              "display_name": "Display name 2",
              "id": "6f10a133-919f-43f0-8e67-13efc50ba439"
            }
          ]
        }
      ],
      "project": {
        "created_at": "2024-01-25T19:18:29.614189Z",
        "id": "90d3f72c-abed-463f-8d1b-1c3c084556e1",
        "name": "My Project",
        "root_folder_id": "a8426cb1-5056-4010-92d0-416e2c0d3a78",
        "status": "active",
        "storage": 15000,
        "updated_at": "2024-02-07T16:44:41.986478Z",
        "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/",
        "workspace_id": "f9cc69f8-c0f8-4176-9eb1-3049c4b6b647",
        "description": "Project Description",
        "adobe_id": "urn:aaid:sc:US:9f4e4d7a-4b6b-4c4f-9f00-b31a91cfc6f3",
        "restricted": false,
        "owner": {
          "active": true,
          "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",
          "email": "user_email@example.com",
          "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
          "name": "Jon Doe"
        }
      }
    }
  ],
  "links": {
    "next": "/v4/accounts/123/folders/123/folders"
  },
  "total_count": 10
}

Elenca gli elementi figlio nella cartella specificata.

Usa il parametro di query include per includere in modo selettivo proprietà aggiuntive nella risposta.

Nota: se includi media_links.original e l’utente non ha l’autorizzazione per scaricare i file nel progetto corrispondente, questo endpoint restituisce un errore 403 Forbidden. Se il contenuto non è accessibile perché per questo Utente è richiesta l’applicazione di filigrana e non è supportata dai media_links richiesti, la richiesta va a buon fine, ma i link multimediali non supportati vengono impostati su null. Allo stesso modo, se per un file specifico non esiste un link di transcodifica richiesto (ad es. includendo media_links.video_h264_180 in un file di immagine statico) o il processo di transcodifica non è terminato (ad es. lo stato del file è “uploaded” anziché “transcoded”), anche il link multimediale viene impostato su null nel payload della risposta. In breve, il client deve gestire correttamente i link multimediali di tipo null.
Limiti di frequenza: 100 chiamate per 1,00 minuto per account_user

Elenca gli elementi figlio nella cartella specificata. <br/> Usa il parametro di query `include` per includere in modo selettivo proprietà aggiuntive nella risposta. <br/> Nota: se includi `media_links.original` e l’utente non ha l’autorizzazione per scaricare i file nel progetto corrispondente, questo endpoint restituisce un errore `403 Forbidden`. Se il contenuto non è accessibile perché per questo Utente è richiesta l’applicazione di filigrana e non è supportata dai media_links richiesti, la richiesta va a buon fine, ma i link multimediali non supportati vengono impostati su null. Allo stesso modo, se per un file specifico non esiste un link di transcodifica richiesto (ad es. includendo `media_links.video_h264_180` in un file di immagine statico) o il processo di transcodifica non è terminato (ad es. lo `stato` del file è “uploaded” anziché “transcoded”), anche il link multimediale viene impostato su null nel payload della risposta. In breve, il client deve gestire correttamente i link multimediali di tipo null. <br/>Limiti di frequenza: 100 chiamate per 1,00 minuto per account_user

Autenticazione

AuthorizationBearer

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

Parametri di percorso

account_idstringObbligatorio

Un identificatore di entità Frame.io o Adobe. Di solito è un UUID Frame.io, ma per account, progetti, cartelle, file e stack di versioni che risiedono nell’archiviazione cloud Adobe (ad esempio gli account e i progetti connessi a Workfront) puoi usare anche un ID assegnato da Adobe in modo intercambiabile. Questi ID devono avere il prefisso adobe: (ad esempio adobe:<adobe_org_id> per un account, adobe:<adobe_asset_id> per un progetto o una cartella, adobe:adobe:<adobe_asset_id>|<version>` per una risorsa file).

Un identificatore di entità Frame.io o Adobe. Di solito è un UUID Frame.io, ma per account, progetti, cartelle, file e stack di versioni che risiedono nell'archiviazione cloud Adobe (ad esempio gli account e i progetti connessi a Workfront) puoi usare anche un ID assegnato da Adobe in modo intercambiabile. Questi ID devono avere il prefisso `adobe:` (ad esempio `adobe:<adobe_org_id>` per un account, `adobe:<adobe_asset_id>` per un progetto o una cartella, `adobe:`adobe:<adobe_asset_id>|<version>` per una risorsa file).

folder_idstringObbligatorio

Parametri di query

includeenumOpzionale

Sono supportati i valori dei parametri di query per gli endpoint che restituiscono file con link multimediali

typestringOpzionale

Filtro del tipo per gli elementi figlio della cartella

afterstringOpzionale

Parametro di query del cursore opaco per le richieste che restituiscono risultati paginati.

NOTA: questo valore viene generato automaticamente e incluso come parte dei link di una risposta precedente. Non è leggibile dall’uomo.

page_sizeintegerOpzionale1-500Predefinito a 50

Parametro di richiesta delle dimensioni della pagina per le richieste dell’elenco risorse

include_total_countbooleanOpzionalePredefinito a false

Parametro di query della pagina per includere il conteggio di tutte le entità

Header di risposta

x-ratelimit-limitinteger

Limite di frequenza

x-ratelimit-remaininginteger

Limite di frequenza rimanente

x-ratelimit-windowinteger

Finestra del limite di frequenza in millisecondi

Risposta

datalist of objects

Risorse

linksobject

Link ai dati paginati

total_countinteger or nullOpzionale

Conteggio totale

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

Elenca gli elementi figlio nella cartella specificata.

Usa il parametro di query include per includere in modo selettivo proprietà aggiuntive nella risposta.