Create account level field definitions | Frame.io API Documentation

from frameio import Frameio, SelectDefinitionParamsFieldConfiguration, SelectDefinitionParamsFieldConfigurationOptionsItem
from frameio.metadata_fields import CreateFieldDefinitionParamsData_Select
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.metadata_fields.metadata_field_definitions_create(
    account_id="8615184d-5eec-49ef-911a-7b4afbe36ce1",
    data=CreateFieldDefinitionParamsData_Select(
        field_configuration=SelectDefinitionParamsFieldConfiguration(
            options=[
                SelectDefinitionParamsFieldConfigurationOptionsItem(
                    display_name="Option 1",
                ),
                SelectDefinitionParamsFieldConfigurationOptionsItem(
                    display_name="Option 2",
                )
            ],
            enable_add_new=False,
        ),
        name="Fields definition name",
    ),
)

{
  "data": {
    "field_type": "select",
    "created_at": "2024-01-25T19:18:29.614189Z",
    "creator_id": "7691308e-06ee-4f08-9adc-8a2d1a2a0acd",
    "field_configuration": {
      "options": [
        {
          "display_name": "Option 1",
          "id": "f079de38-d268-4c62-8c4d-9a258b2efca2"
        },
        {
          "display_name": "Option 2",
          "id": "6288e75c-cff7-48cc-865f-71e0bebe9b16"
        }
      ],
      "enable_add_new": false
    },
    "id": "f8357771-d1e0-4e57-b24d-bbe7907e85a0",
    "mutable": true,
    "name": "Fields definition name",
    "updated_at": "2024-02-07T16:44:41.986478Z"
  }
}

Create account level field definitions.
Rate Limits: 10 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

Request

Request body

dataobjectOptional

Response headers

x-ratelimit-limitinteger

Rate limit

x-ratelimit-remaininginteger

Rate limit remaining

x-ratelimit-windowinteger

Rate limit window in milliseconds

Response

Created

dataobject

Errors

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

1	from frameio import Frameio, SelectDefinitionParamsFieldConfiguration, SelectDefinitionParamsFieldConfigurationOptionsItem
2	from frameio.metadata_fields import CreateFieldDefinitionParamsData_Select
3
4	client = Frameio(
5	token="YOUR_TOKEN_HERE",
6	)
7
8	client.metadata_fields.metadata_field_definitions_create(
9	account_id="8615184d-5eec-49ef-911a-7b4afbe36ce1",
10	data=CreateFieldDefinitionParamsData_Select(
11	field_configuration=SelectDefinitionParamsFieldConfiguration(
12	options=[
13	SelectDefinitionParamsFieldConfigurationOptionsItem(
14	display_name="Option 1",
15	),
16	SelectDefinitionParamsFieldConfigurationOptionsItem(
17	display_name="Option 2",
18	)
19	],
20	enable_add_new=False,
21	),
22	name="Fields definition name",
23	),
24	)

1	{
2	"data": {
3	"field_type": "select",
4	"created_at": "2024-01-25T19:18:29.614189Z",
5	"creator_id": "7691308e-06ee-4f08-9adc-8a2d1a2a0acd",
6	"field_configuration": {
7	"options": [
8	{
9	"display_name": "Option 1",
10	"id": "f079de38-d268-4c62-8c4d-9a258b2efca2"
11	},
12	{
13	"display_name": "Option 2",
14	"id": "6288e75c-cff7-48cc-865f-71e0bebe9b16"
15	}
16	],
17	"enable_add_new": false
18	},
19	"id": "f8357771-d1e0-4e57-b24d-bbe7907e85a0",
20	"mutable": true,
21	"name": "Fields definition name",
22	"updated_at": "2024-02-07T16:44:41.986478Z"
23	}
24	}