Channel Controller

Channels are collections of mediacontainers that can be added to publicareas of type mediahub.

Reference

Find channels

Find a specific channel or all channels for a given publicareaId.

Channels are restricted by securitygroups of the requesting user.
The returned list is always populated with metadata (title, description) for this channel.
The response also contains the number of mediacontainers per channel

GET/v5/channel/:channelId

Request Parameters

Field	Type	Required	Description
channelId	integer	✗	Fetch specific channel. Can be sent as path or query parameter
publicAreaId	integer	✗	Fetch channels for a given publicarea
refresh	boolean	✗	If true, data is fetched from database, not from cache. Setting to true will cost performance!
withMediaContainers	boolean	✗	Fetch specific channel. Can be sent as path or query parameter
withOriginalMeta	boolean	✗	Fetch specific channel. Can be sent as path or query parameter

Response

Field	Type	Description
channels	arrayOfObjects	Array of channels.
└ id	integer	id of this channel
└ addMode	integer	If 0 means, new mediacontainers are added at bottom, if 1 new mediacontainers are added at top Deprecated
└ connectedDropSites	array	Array of dropSiteIds connected to this channel.
└ countMediaContainers	integer	Number of mediaContainers linked to this channel.
└ countMediaContainersByType	object	Number of mediaContainers linked to this channel grouped by type
└ video	integer	Number of videos linked to this channel
└ audio	integer	Number of audios linked to this channel
└ image	integer	Number of images linked to this channel
└ document	integer	Number of documents linked to this channel
└ publish	boolean	If true, the channel is published and available on external routes Deprecated
└ thumbnailMediaId	integer	Id of the preview image used for this channel
└ creatorId	integer	Creator id for this channel
└ controlGroups	array	Array of Control Group ids for this channel
└ tags	array	Tags assigned to this channel
└ channelId	integer	channelId Deprecated
└ tagId	integer	Id of the tag
└ flag	integer	Flag of the relation, defaults to 0 (active). If 1 the relation is in trash.
└ lastEditorId	integer	UserId of the last editing user
└ formatIds	array	Array of format ids to use for this channel. Takes precedence over mediahub/publicarea formats.
└ createdAt	dateTime	Date and time of the creation
└ flag	integer	Do not use any longer. Retired
└ publicAreaId	integer	Do not use any longer. Retired
└ settings	object	TBA Beta
└ updatedAt	dateTime	Date and time of the latest update
└ metadata	arrayOfObjects	Metadata for this channel
└ title	string	title of the metadata entry (e.g. channel_name)
└ content	string	content for this metadata entry
└ language	string	language of the metadata entry
└ channelId	integer	channel ID of the metadata entry
└ id	integer	ID of the metadata entry
└ channelId	integer	channel ID of the metadata entry
└ mediaContainers	arrayOfObjects	List of mediaContainers in this channel
└ sorting	object	Sorting object Deprecated
totalHits	integer	Total number of channels

Examples

Channel list (standard)

Request

/v5/channel?channelId=1

Response

{
    "body": [
        {
            "totalHits": 12,
            "channels": [
                {
                    "addMode": 0,
                    "publish": false,
                    "thumbnailMediaId": null,
                    "creatorId": 123,
                    "id": 1,
                    "createdAt": null,
                    "updatedAt": null,
                    "controlGroups": [
                        1,
                        2,
                        4
                    ],
                    "metadata": [
                        {
                            "title": "channel_name",
                            "content": "Flugzeuge",
                            "language": "de"
                        },
                        []
                    ]
                },
                []
            ]
        }
    ]
}

Create channel

POST/v5/channel

Request Parameters

Field	Type	Required	Description
addMode	integer	✗	If set to 0, new mediacontainers are added at top position. Otherwise at bottom position. Defaults to 0.
connectedDropSites	array	✗	Array of dropSiteIds. If set, the user is able to connect the channel with dropsites. From now on all uploaded medias to the dropsite will be automatically added to the channel as well.
controlGroups	array	✗	Array of securityGroupIds. If the user has an individual configuration with "preferredControlGroups" then controlGroups is changed to reflect that. However the user`s parent controlgroup is always used.
metadata	array	✗	If set to 0, new mediacontainers are added at top position. Otherwise at bottom position. Defaults to 0.
publish	boolean	✗	If set to 1 this channel is online and will be used with on delivery. Defaults to 0 (offline).
settings	object	✗	Optional settings for this channel.
└ publicationDate	string	✗	TBA
└ lockUser	integer	✗	TBA
└ deletionProtection	boolean	✗	TBA
└ deletionProtector	integer	✗	TBA
└ formatIds	array	✗	TBA
thumbnailMediaId	integer	✗	If set, the preview image with this mediaId is used for this channel.
thumbnailMediaMode	boolean	✗	If set to true, the preview image is always the preview image of the first mediacontainer in this channel. Defaults to false.

Response

Field	Type	Description
channels	arrayOfObjects	Array of channels.
└ id	integer	id of this channel
└ addMode	integer	If 0 means, new mediacontainers are added at bottom, if 1 new mediacontainers are added at top Deprecated
└ connectedDropSites	array	Array of dropSiteIds connected to this channel.
└ countMediaContainers	integer	Number of mediaContainers linked to this channel.
└ countMediaContainersByType	object	Number of mediaContainers linked to this channel grouped by type
└ video	integer	Number of videos linked to this channel
└ audio	integer	Number of audios linked to this channel
└ image	integer	Number of images linked to this channel
└ document	integer	Number of documents linked to this channel
└ publish	boolean	If true, the channel is published and available on external routes Deprecated
└ thumbnailMediaId	integer	Id of the preview image used for this channel
└ creatorId	integer	Creator id for this channel
└ controlGroups	array	Array of Control Group ids for this channel
└ tags	array	Tags assigned to this channel
└ channelId	integer	channelId Deprecated
└ tagId	integer	Id of the tag
└ flag	integer	Flag of the relation, defaults to 0 (active). If 1 the relation is in trash.
└ lastEditorId	integer	UserId of the last editing user
└ formatIds	array	Array of format ids to use for this channel. Takes precedence over mediahub/publicarea formats.
└ createdAt	dateTime	Date and time of the creation
└ flag	integer	Do not use any longer. Retired
└ publicAreaId	integer	Do not use any longer. Retired
└ settings	object	TBA Beta
└ updatedAt	dateTime	Date and time of the latest update
└ metadata	arrayOfObjects	Metadata for this channel
└ title	string	title of the metadata entry (e.g. channel_name)
└ content	string	content for this metadata entry
└ language	string	language of the metadata entry
└ channelId	integer	channel ID of the metadata entry
└ id	integer	ID of the metadata entry
└ channelId	integer	channel ID of the metadata entry
└ mediaContainers	arrayOfObjects	List of mediaContainers in this channel
└ sorting	object	Sorting object Deprecated
totalHits	integer	Total number of channels

Update channel

Updates a channel. If you update settings.formatIds, misssing formats for mediacontainers related to this channel will be automatically created.

PUT/v5/channel/:channelId

Request Parameters

Field	Type	Required	Description
addMode	integer	✗	If set to 0, new mediacontainers are added at top position. Otherwise at bottom position. Defaults to 0.
channelId	integer	✓	Update this channel
connectedDropSites	array	✗	Array of dropSiteIds. If set, the user is able to connect the channel with dropsites. From now on all uploaded medias to the dropsite will be automatically added to the channel as well.
controlGroups	array	✗	Array of securityGroupIds. If the user has an individual configuration with "preferredControlGroups" then controlGroups is changed to reflect that. However the user`s parent controlgroup is always used.
publish	boolean	✗	If set to 1 this channel is online and will be used with on delivery. Defaults to 0 (offline).
settings	object	✗	Optional settings for this channel.
└ publicationDate	string	✗	TBA
└ lockUser	integer	✗	TBA
└ deletionProtection	boolean	✗	TBA
└ deletionProtector	integer	✗	TBA
└ formatIds	array	✗	TBA
thumbnailMediaId	integer	✗	If set, the preview image with this mediaId is used for this channel.
thumbnailMediaMode	boolean	✗	If set to true, the preview image is always the preview image of the first mediacontainer in this channel. Defaults to false.

Response

Field	Type	Description
channels	arrayOfObjects	Array of channels.
└ id	integer	id of this channel
└ addMode	integer	If 0 means, new mediacontainers are added at bottom, if 1 new mediacontainers are added at top Deprecated
└ connectedDropSites	array	Array of dropSiteIds connected to this channel.
└ countMediaContainers	integer	Number of mediaContainers linked to this channel.
└ countMediaContainersByType	object	Number of mediaContainers linked to this channel grouped by type
└ video	integer	Number of videos linked to this channel
└ audio	integer	Number of audios linked to this channel
└ image	integer	Number of images linked to this channel
└ document	integer	Number of documents linked to this channel
└ publish	boolean	If true, the channel is published and available on external routes Deprecated
└ thumbnailMediaId	integer	Id of the preview image used for this channel
└ creatorId	integer	Creator id for this channel
└ controlGroups	array	Array of Control Group ids for this channel
└ tags	array	Tags assigned to this channel
└ channelId	integer	channelId Deprecated
└ tagId	integer	Id of the tag
└ flag	integer	Flag of the relation, defaults to 0 (active). If 1 the relation is in trash.
└ lastEditorId	integer	UserId of the last editing user
└ formatIds	array	Array of format ids to use for this channel. Takes precedence over mediahub/publicarea formats.
└ createdAt	dateTime	Date and time of the creation
└ flag	integer	Do not use any longer. Retired
└ publicAreaId	integer	Do not use any longer. Retired
└ settings	object	TBA Beta
└ updatedAt	dateTime	Date and time of the latest update
└ metadata	arrayOfObjects	Metadata for this channel
└ title	string	title of the metadata entry (e.g. channel_name)
└ content	string	content for this metadata entry
└ language	string	language of the metadata entry
└ channelId	integer	channel ID of the metadata entry
└ id	integer	ID of the metadata entry
└ channelId	integer	channel ID of the metadata entry
└ mediaContainers	arrayOfObjects	List of mediaContainers in this channel
└ sorting	object	Sorting object Deprecated
totalHits	integer	Total number of channels

Destroy channel

DELETE/v5/channel/:channelId

Request Parameters

Field	Type	Required	Description
channelId	integer	✓	Delete this channel
forceDelete	boolean	✗	Set to true if you do not want to check for related mediacontainers.

Response

Field	Type	Description
channels	arrayOfObjects	Array of channels.
└ id	integer	id of this channel
└ addMode	integer	If 0 means, new mediacontainers are added at bottom, if 1 new mediacontainers are added at top Deprecated
└ connectedDropSites	array	Array of dropSiteIds connected to this channel.
└ countMediaContainers	integer	Number of mediaContainers linked to this channel.
└ countMediaContainersByType	object	Number of mediaContainers linked to this channel grouped by type
└ video	integer	Number of videos linked to this channel
└ audio	integer	Number of audios linked to this channel
└ image	integer	Number of images linked to this channel
└ document	integer	Number of documents linked to this channel
└ publish	boolean	If true, the channel is published and available on external routes Deprecated
└ thumbnailMediaId	integer	Id of the preview image used for this channel
└ creatorId	integer	Creator id for this channel
└ controlGroups	array	Array of Control Group ids for this channel
└ tags	array	Tags assigned to this channel
└ channelId	integer	channelId Deprecated
└ tagId	integer	Id of the tag
└ flag	integer	Flag of the relation, defaults to 0 (active). If 1 the relation is in trash.
└ lastEditorId	integer	UserId of the last editing user
└ formatIds	array	Array of format ids to use for this channel. Takes precedence over mediahub/publicarea formats.
└ createdAt	dateTime	Date and time of the creation
└ flag	integer	Do not use any longer. Retired
└ publicAreaId	integer	Do not use any longer. Retired
└ settings	object	TBA Beta
└ updatedAt	dateTime	Date and time of the latest update
└ metadata	arrayOfObjects	Metadata for this channel
└ title	string	title of the metadata entry (e.g. channel_name)
└ content	string	content for this metadata entry
└ language	string	language of the metadata entry
└ channelId	integer	channel ID of the metadata entry
└ id	integer	ID of the metadata entry
└ channelId	integer	channel ID of the metadata entry
└ mediaContainers	arrayOfObjects	List of mediaContainers in this channel
└ sorting	object	Sorting object Deprecated
totalHits	integer	Total number of channels

API

Reference

Find channels

Create channel

Update channel

Destroy channel

Add channel to publicarea/mediahub

Remove channel from publicarea/mediahub

Reorder channel

Related Articles