Sign in

v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
content type schemas

List schemas

List all content type schemas for a site

Content types streamline the tasks of content editors, like managing media metadata, by automatically displaying the necessary fields in the JWX dashboard. This applies to various content types such as concerts, teams, matches, venues, and more.

get/v2/sites/{site_id}/content_type_schemas/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

Response

Success

pageinteger

Offset for returned resources

page_lengthinteger

Maximum number of resources to return

totalinteger

Number of resources available before pagination

Example response

{
  "page": 1,
  "page_length": 10,
  "total": 1,
  "content_type_schemas": [
    {
      "schema": "https://schema.jwplayer.com/types/thumbnail.json",
      "id": "Ny05CEfj",
      "created": "2019-09-25T15:29:11.042095+00:00",
      "last_modified": "2019-09-25T15:29:11.042095+00:00",
      "metadata": {
        "display_name": "Concert Venue",
        "name": "concert_venue",
        "sections": [
          {
            "title": "Roku Related Fields",
            "fields": [
              {
                "param": "roku-app-id",
                "label": "Roku App ID",
                "required": true,
                "details": {
                  "inputType": "email",
                  "placeholder": "Input a value here.",
                  "pattern": "[a-z0-9-]+\\.(?:com|org)(?:\\.[a-z]{2,3})?"
                }
              }
            ]
          }
        ],
        "description": "The Concert Venue Schema allows to group Media Items (e.g. Concerts) depending on the Venue where it took place.",
        "is_active": true
      }
    }
  ]
}