v50

latestOpenAPI 3.0.3raw.githubusercontent.com2025-01-2810050281.4 KB
Custom Fields

Get Video Fields

Gets a list of custom fields for the account (note that this operation may later return standard fields as well - current it returns an empty array for standard_fields)

get/v1/accounts/{{account_id}}/video_fields

Path parameters

account_idstring required

Video Cloud account ID.

Headers

Content-Typestring required

Content-Type: application/json

Authorizationstring required

Authorization: Bearer {access_token} - see Getting Access Tokens

Response

200

max_custom_fieldsstring

maximum number of custom fields for the account

Example response

{
  "custom_fields": [
    {
      "description": "Add a topic",
      "display_name": "Subject",
      "enum_values": [
        "Reptiles",
        "Mammals",
        "Other",
        "wildlife",
        "Fish",
        "Birds",
        "Insects"
      ],
      "id": "subject",
      "required": false,
      "type": "enum"
    },
    {
      "description": null,
      "display_name": "Uploader UserID",
      "id": "uploader-userid",
      "required": false,
      "type": "string"
    },
    {
      "description": null,
      "display_name": "Rating",
      "id": "rating",
      "required": false,
      "type": "string"
    },
    {
      "description": null,
      "display_name": "Duration",
      "id": "duration",
      "required": false,
      "type": "string"
    },
    {
      "description": null,
      "display_name": "Associatedtopics",
      "id": "associated-topics",
      "required": false,
      "type": "string"
    },
    {
      "description": null,
      "display_name": "Custom Theme Path",
      "enum_values": [
        "https://files.brightcove.com/BCL_customLabelTheme2.css",
        "https://files.brightcove.com/BCL_customLabelTheme.css"
      ],
      "id": "customthemepath",
      "required": false,
      "type": "enum"
    },
    {
      "description": null,
      "display_name": "Text Color",
      "enum_values": [
        "#4C4D4F",
        "#CF0050",
        "#F4901E",
        "#619FA8"
      ],
      "id": "textcolor",
      "required": false,
      "type": "enum"
    },
    {
      "description": null,
      "display_name": "Captions File URL",
      "id": "dfxppath",
      "required": false,
      "type": "string"
    },
    {
      "description": null,
      "display_name": "Purpose",
      "enum_values": [
        "Training",
        "Demo",
        "Sample",
        "Solution"
      ],
      "id": "purpose",
      "required": false,
      "type": "enum"
    },
    {
      "description": null,
      "display_name": "Downloadable",
      "enum_values": [
        "yes",
        "no"
      ],
      "id": "downloadable",
      "required": false,
      "type": "enum"
    }
  ],
  "max_custom_fields": 10,
  "standard_fields": [
    {
      "description": null,
      "id": "description",
      "required": false
    },
    {
      "description": null,
      "id": "tags",
      "required": false
    }
  ]
}