Show metadata | Frame.io API Documentation

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.metadata.show(
    account_id="4d57cf24-0667-479c-a6af-4c9817fbdf9a",
    file_id="711f8734-cebc-4ed7-94fa-7c59f34d8659",
)

{
  "data": {
    "file_id": "32da4167-6171-4bee-9d1e-081572081975",
    "metadata": [
      {
        "field_type": "select_multi",
        "field_definition_id": "bfcf8f07-2f7d-413e-99ac-9c4eec9266fa",
        "field_definition_name": "Fields definition name",
        "mutable": true,
        "value": [
          {
            "display_name": "Display name",
            "id": "6ec91e7f-6411-4bd5-98fe-202662275123"
          }
        ],
        "field_options": [
          {
            "display_name": "Display name",
            "id": "6ec91e7f-6411-4bd5-98fe-202662275123"
          },
          {
            "display_name": "Display name 2",
            "id": "4b4147a7-59e7-48eb-a779-03a2e18259d1"
          }
        ]
      },
      {
        "field_type": "text",
        "field_definition_id": "bfcf8f07-2f7d-413e-99ac-9c4eec9266fa",
        "field_definition_name": "Fields definition name",
        "mutable": true,
        "value": "text value"
      }
    ]
  }
}

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.metadata.show(
    account_id="4d57cf24-0667-479c-a6af-4c9817fbdf9a",
    file_id="711f8734-cebc-4ed7-94fa-7c59f34d8659",
)

{
  "data": {
    "file_id": "32da4167-6171-4bee-9d1e-081572081975",
    "metadata": [
      {
        "field_type": "select_multi",
        "field_definition_id": "bfcf8f07-2f7d-413e-99ac-9c4eec9266fa",
        "field_definition_name": "Fields definition name",
        "mutable": true,
        "value": [
          {
            "display_name": "Display name",
            "id": "6ec91e7f-6411-4bd5-98fe-202662275123"
          }
        ],
        "field_options": [
          {
            "display_name": "Display name",
            "id": "6ec91e7f-6411-4bd5-98fe-202662275123"
          },
          {
            "display_name": "Display name 2",
            "id": "4b4147a7-59e7-48eb-a779-03a2e18259d1"
          }
        ]
      },
      {
        "field_type": "text",
        "field_definition_id": "bfcf8f07-2f7d-413e-99ac-9c4eec9266fa",
        "field_definition_name": "Fields definition name",
        "mutable": true,
        "value": "text value"
      }
    ]
  }
}

Show the metadata of a file.
Rate Limits: 100 calls per 1.00 minute(s) per account_user

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequiredformat: "uuid"

A UUID String

file_idstringRequiredformat: "uuid"

A UUID String

Query parameters

show_nullbooleanOptional

Response

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

1	from frameio import Frameio
2
3	client = Frameio(
4	token="YOUR_TOKEN_HERE",
5	)
6
7	client.metadata.show(
8	account_id="4d57cf24-0667-479c-a6af-4c9817fbdf9a",
9	file_id="711f8734-cebc-4ed7-94fa-7c59f34d8659",
10	)

1	{
2	"data": {
3	"file_id": "32da4167-6171-4bee-9d1e-081572081975",
4	"metadata": [
5	{
6	"field_type": "select_multi",
7	"field_definition_id": "bfcf8f07-2f7d-413e-99ac-9c4eec9266fa",
8	"field_definition_name": "Fields definition name",
9	"mutable": true,
10	"value": [
11	{
12	"display_name": "Display name",
13	"id": "6ec91e7f-6411-4bd5-98fe-202662275123"
14	}
15	],
16	"field_options": [
17	{
18	"display_name": "Display name",
19	"id": "6ec91e7f-6411-4bd5-98fe-202662275123"
20	},
21	{
22	"display_name": "Display name 2",
23	"id": "4b4147a7-59e7-48eb-a779-03a2e18259d1"
24	}
25	]
26	},
27	{
28	"field_type": "text",
29	"field_definition_id": "bfcf8f07-2f7d-413e-99ac-9c4eec9266fa",
30	"field_definition_name": "Fields definition name",
31	"mutable": true,
32	"value": "text value"
33	}
34	]
35	}
36	}