Skip to content
Tilecast Docs

contentDefinitions

GET
/api/v1/content-definitions
curl --request GET \
  --url https://example.com/api/v1/content-definitions

Content definitions. Requires an authenticated dashboard user.

Responses

Section titled “ Responses ”

200

Section titled “200”

Authoritative release-owned Widget and Data Source definitions, schemas, templates, adapters, and capability requirements

Media typeapplication/json
object
data
required
object
revision
required
string
compilerVersion
required
string
widgets
required
Array<object>
object
id
required
string
version
required
integer
>= 1
configVersion

Version of the persisted Widget configuration; omission means version 1.

integer
>= 1
apiVersion
integer
>= 1
source
One of:
object
kind
required
string
Allowed values: core
name
required
string
description
required
string
category
required
string
icon
required
string
thumbnail
string
kind
string
Allowed values: widget app
featured
boolean
keywords
Array<string>
availability
object
enabled
boolean
reason
string
runtime
required
string
Allowed values: native web
configurationSchema
required
object
fields
required
Array<object>
object
key
required
string
label
required
string
labelKey

A Studio translation key in the definitions namespace for label. Optional; label is the literal fallback and stays the English source.

string
description
string
descriptionKey

A Studio translation key in the definitions namespace for description. Optional; description is the literal fallback.

string
control
required

The authoring control. New definitions and plugins can introduce control types, so clients must tolerate values they do not know.

string
required
boolean
default

Release-owned default value of any JSON type.

minimum
number
maximum
number
minLength
integer
maxLength
integer
options
Array<object>
object
value
required
string
label
required
string
labelKey

A Studio translation key in the definitions namespace for label. Optional; label is the fallback.

string
acceptedDataSourceKinds
Array<string>
requiredFields
object
key
additional properties
string
dataSourceFieldTypes
Array<string>
mediaTypes
Array<string>
maximumItems
integer
itemFields
Array<object> recursive
ui

Release-owned authoring hints of any JSON shape.

object
key
additional properties
any
defaultConfiguration
required

Release-owned default Widget configuration.

object | null
acceptedDataSourceKinds
Array<string>
requiredFieldTypes
object
key
additional properties
string
presentationSchemaVersion
required
integer
>= 1
presentationTemplate

Release-owned presentation template.

object
key
additional properties
any
presentationBase
string
requiredCapabilities
required
object
key
additional properties
integer
>= 1
emptyStateBehavior
required
string
legacyEditor
boolean
requiresManifestV13
boolean
setup
object
eyebrow
string
tip
string
steps
Array<string>
emptyState
string
recipe
object
dataSource
required
object
provider
required
string
name
required
string
description
string
configurationTemplate
required

Release-owned Data Source configuration template.

object
key
additional properties
any
webIntegration
object
urlField
required
string
allowedHosts
Array<string>
allowAnyHttpsHost
boolean
requiredPathPrefix
string
transform
required
string
reloadIntervalField
string
loadTimeoutSeconds
integer
lifecycle
string
warmSeconds
integer
fallbackBehavior
string
deprecation
required
object
deprecated
required
boolean
replacement
string
message
string
authoring

Studio authoring capabilities. They never change validation, projection, or playback.

object
preview
required
object
time

The rendered result depends on the current instant, so Studio offers preview-time controls.

boolean
recommendedFrame

A pixel geometry. Studio opens the preview at a Widget’s recommended frame, renders library thumbnails at it, and gives a new Layout placement its aspect ratio. It is an authoring hint only; it never reaches the Player and never changes validation or playback.

object
width
required
integer
>= 32 <= 3840
height
required
integer
>= 32 <= 3840
component
object
type
required
string
version
required
integer
>= 1
tagName
required
string
entrypoint
required
string
configTemplate
required

Release-owned component configuration template.

object
key
additional properties
any
dataSourceFields
Array<string>
empty
required
string
Allowed values: render skip-eligible
compatibility
object
fallback
required
string
Allowed values: legacy template none
dataSources
required
Array<object>
object
id
required
string
version
required
integer
>= 1
source
One of:
object
kind
required
string
Allowed values: core
name
required
string
description
required
string
category
required
string
icon
required
string
configurationSchema
required
object
fields
required
Array<object>
object
key
required
string
label
required
string
labelKey

A Studio translation key in the definitions namespace for label. Optional; label is the literal fallback and stays the English source.

string
description
string
descriptionKey

A Studio translation key in the definitions namespace for description. Optional; description is the literal fallback.

string
control
required

The authoring control. New definitions and plugins can introduce control types, so clients must tolerate values they do not know.

string
required
boolean
default

Release-owned default value of any JSON type.

minimum
number
maximum
number
minLength
integer
maxLength
integer
options
Array<object>
object
value
required
string
label
required
string
labelKey

A Studio translation key in the definitions namespace for label. Optional; label is the fallback.

string
acceptedDataSourceKinds
Array<string>
requiredFields
object
key
additional properties
string
dataSourceFieldTypes
Array<string>
mediaTypes
Array<string>
maximumItems
integer
itemFields
Array<object> recursive
ui

Release-owned authoring hints of any JSON shape.

object
key
additional properties
any
defaultConfiguration
required

Release-owned default Data Source configuration.

object | null
outputSchema
required
object
kind
required
string
Allowed values: scalar records time_series list object
fields
required
Array<object>
object
key
required
string
label
required
string
type
required
string
currency
string
currencyConfigKey
string
required
boolean
fetch
object
urlTemplate
required
string
format
required
string
Allowed values: json csv
accept
string
recordsPath
string
mapping
required
object
key
additional properties
string
maximumRecords
integer
refreshSeconds
integer
adapterId
required
string
refreshBehavior
required
string
attribution
string
legacyEditor
boolean
requiresManifestV13
boolean
setup
object
eyebrow
string
tip
string
steps
Array<string>
emptyState
string
deprecation
required
object
deprecated
required
boolean
replacement
string
message
string
fingerprint
required
string
Example
{
  "data": {
    "widgets": [
      {
        "source": {
          "kind": "core"
        },
        "kind": "widget",
        "runtime": "native",
        "component": {
          "empty": "render"
        },
        "compatibility": {
          "fallback": "legacy"
        }
      }
    ],
    "dataSources": [
      {
        "source": {
          "kind": "core"
        },
        "outputSchema": {
          "kind": "scalar"
        },
        "fetch": {
          "format": "json"
        }
      }
    ]
  }
}