Change history Initial version 10-19-2022 Initial version
Case study:
- Obtain the id (uuid) of a resource.
- Knowing resource ids (folder & tag) when ingesting via webservice.
- List your media.
Limitations:
- Be an Okast client.
- Have an Okast channels instance + credentials.
- One call per owned instance.
List tags present on an instance.
The call URL is as follows :
http://<URL_de_mon_instance>/synthesia/okast-channels/playlist/manager/data/tags.json
Example of an answer
{
"tags": [
{
"id": "5db10798-cfcd-262d-db5e-8f4ce1cd2e49",
"name": "Auto-promo",
"scenario": "32d6d007-8fd1-611f-d4b4-15f3e248e9aa",
"color": "#92FBFF",
"defaultFields": {
"title": "Auto-Promo",
"subtitle": "promo de contenu interne",
"description": "",
"category": "",
"host": "",
"hostFunction": "",
"host2": "",
"host2Function": "",
"host3": "",
"host3Function": "",
"showName": "",
"dateYear": "2022",
"country": "",
"classification": "",
"keywords": ""
},
"parentPath": "Ads"
},
{
"id": "4a808634-a2db-c3c6-0df7-14f93bfde36b",
"name": "Publicités",
"scenario": "65a8384a-9a7b-0bdb-2b12-aaaeb939330a",
"color": "#97FFCB",
"defaultFields": {
"title": "",
"subtitle": "",
"description": "",
"category": "",
"host": "",
"hostFunction": "",
"host2": "",
"host2Function": "",
"host3": "",
"host3Function": "",
"showName": "",
"dateYear": "",
"country": "",
"classification": "",
"keywords": ""
},
"parentPath": "Ads"
},
{
"id": "416d401f-70b4-0902-87e6-d79083bb76f5",
"name": "Tapis_pub",
"scenario": "65a8384a-9a7b-0bdb-2b12-aaaeb939330a",
"color": "#FFF12A",
"defaultFields": {
"title": "",
"subtitle": "",
"description": "",
"category": "",
"host": "",
"hostFunction": "",
"host2": "",
"host2Function": "",
"host3": "",
"host3Function": "",
"showName": "",
"dateYear": "",
"country": "",
"classification": "",
"keywords": ""
},
"parentPath": "Ads"
},
]
}List files on an instance
The calling URL is :
http://<URL_de_mon_instance>/synthesia/okast-channels/playlist/manager/data/folders.json
Example of an answer
{
"folders": [
{
"id": "421adfcc-5b92-356c-9553-609075bf194b",
"name": "Auto-promo Okast",
"color": "#39FFF4",
"status": "work",
"fallbackFolder": "",
"description": "",
"parentPath": "Demo",
"folderVodTitle": "",
"folderVodSubtitle": "",
"folderVodDescription": "",
"folderVodType": "",
"folderVodGenre": "",
"folderVodRubrique": "",
"folderVodGroupe": "",
"folderVodKeywords": "",
"folderVodImage": "",
"folderVodPlIdDm": "",
"folderVodPlIdYt": "",
"folderVodOrangeId": "",
"folderVodOrangeEnable": 0,
"folderVodDmEnable": 0,
"folderVodYtEnable": 0,
"folderVodStartimesEnable": 0,
"folderVodCategoryYt": "1",
"folderVodStatusYt": "public",
"folderVodSamsungEnable": 0,
"folderVodSamsungKind": "",
"folderVodSamsungSeasonNumber": 0,
"folderVodSamsungSeasonTitle": "",
"folderVodSamsungSeasonDescription": "",
"folderVodSamsungSeasonImage": "",
"folderVodSamsungGenre": "",
"folderVodSamsungClassification": 0,
"folderVodSamsungSerialId": 0
},
{
"id": "1b724928-d7c1-a6cc-ff4c-c75cc7ac3d02",
"name": "Blender",
"color": "#31FF1D",
"status": "work",
"fallbackFolder": "",
"description": "",
"parentPath": "Demo",
"folderVodTitle": "",
"folderVodSubtitle": "",
"folderVodDescription": "",
"folderVodType": "",
"folderVodGenre": "",
"folderVodRubrique": "",
"folderVodGroupe": "",
"folderVodKeywords": "",
"folderVodImage": "",
"folderVodPlIdDm": "",
"folderVodPlIdYt": "",
"folderVodOrangeId": "",
"folderVodOrangeEnable": 0,
"folderVodDmEnable": 0,
"folderVodYtEnable": 0,
"folderVodStartimesEnable": 0,
"folderVodCategoryYt": "1",
"folderVodStatusYt": "public",
"folderVodSamsungEnable": 0,
"folderVodSamsungKind": "",
"folderVodSamsungSeasonNumber": 0,
"folderVodSamsungSeasonTitle": "",
"folderVodSamsungSeasonDescription": "",
"folderVodSamsungSeasonImage": "",
"folderVodSamsungGenre": "",
"folderVodSamsungClassification": 0,
"folderVodSamsungSerialId": 0
},
{
"id": "0a5ea2f3-a52f-f0d0-4f57-99e325acf43f",
"name": "Common",
"color": "#2112FF",
"status": "work",
"fallbackFolder": "",
"description": "",
"parentPath": "",
"folderVodTitle": "",
"folderVodSubtitle": "",
"folderVodDescription": "",
"folderVodType": "",
"folderVodGenre": "",
"folderVodRubrique": "",
"folderVodGroupe": "",
"folderVodKeywords": "",
"folderVodImage": "",
"folderVodPlIdDm": "",
"folderVodPlIdYt": "",
"folderVodOrangeId": "",
"folderVodOrangeEnable": 0,
"folderVodDmEnable": 0,
"folderVodYtEnable": 0,
"folderVodStartimesEnable": 0,
"folderVodCategoryYt": "1",
"folderVodStatusYt": "public",
"folderVodSamsungEnable": 0,
"folderVodSamsungKind": "",
"folderVodSamsungSeasonNumber": 0,
"folderVodSamsungSeasonTitle": "",
"folderVodSamsungSeasonDescription": "",
"folderVodSamsungSeasonImage": "",
"folderVodSamsungGenre": "",
"folderVodSamsungClassification": 0,
"folderVodSamsungSerialId": 0
},
{
"id": "b08eef50-881a-146c-6b44-fee5b24f84a4",
"name": "Jingles",
"color": "#987BFF",
"status": "work",
"fallbackFolder": "",
"description": "",
"parentPath": "Demo",
"folderVodTitle": "",
"folderVodSubtitle": "",
"folderVodDescription": "",
"folderVodType": "",
"folderVodGenre": "",
"folderVodRubrique": "",
"folderVodGroupe": "",
"folderVodKeywords": "",
"folderVodImage": "",
"folderVodPlIdDm": "",
"folderVodPlIdYt": "",
"folderVodOrangeId": "",
"folderVodOrangeEnable": 0,
"folderVodDmEnable": 0,
"folderVodYtEnable": 0,
"folderVodStartimesEnable": 0,
"folderVodCategoryYt": "1",
"folderVodStatusYt": "public",
"folderVodSamsungEnable": 0,
"folderVodSamsungKind": "",
"folderVodSamsungSeasonNumber": 0,
"folderVodSamsungSeasonTitle": "",
"folderVodSamsungSeasonDescription": "",
"folderVodSamsungSeasonImage": "",
"folderVodSamsungGenre": "",
"folderVodSamsungClassification": 0,
"folderVodSamsungSerialId": 0
},
{
"id": "3df276f3-b41d-5220-74a0-20990a4dc9f4",
"name": "Jingles jelly",
"color": "#FFFFFF",
"status": "work",
"fallbackFolder": "",
"description": "",
"parentPath": "Demo",
"folderVodTitle": "",
"folderVodSubtitle": "",
"folderVodDescription": "",
"folderVodType": "",
"folderVodGenre": "",
"folderVodRubrique": "",
"folderVodGroupe": "",
"folderVodKeywords": "",
"folderVodImage": "",
"folderVodPlIdDm": "",
"folderVodPlIdYt": "",
"folderVodOrangeId": "",
"folderVodOrangeEnable": 0,
"folderVodDmEnable": 0,
"folderVodYtEnable": 0,
"folderVodStartimesEnable": 0,
"folderVodCategoryYt": "1",
"folderVodStatusYt": "public",
"folderVodSamsungEnable": 0,
"folderVodSamsungKind": "",
"folderVodSamsungSeasonNumber": 0,
"folderVodSamsungSeasonTitle": "",
"folderVodSamsungSeasonDescription": "",
"folderVodSamsungSeasonImage": "",
"folderVodSamsungGenre": "",
"folderVodSamsungClassification": 0,
"folderVodSamsungSerialId": 0
},
{
"id": "36071397-9ea0-a946-ebd5-59cae3eace59",
"name": "Live",
"color": "#FF0E3E",
"status": "work",
"fallbackFolder": "",
"description": "",
"parentPath": "LiveEvent",
"folderVodTitle": "",
"folderVodSubtitle": "",
"folderVodDescription": "",
"folderVodType": "",
"folderVodGenre": "",
"folderVodRubrique": "",
"folderVodGroupe": "",
"folderVodKeywords": "",
"folderVodImage": "",
"folderVodPlIdDm": "",
"folderVodPlIdYt": "",
"folderVodOrangeId": "",
"folderVodOrangeEnable": 0,
"folderVodDmEnable": 0,
"folderVodYtEnable": 0,
"folderVodStartimesEnable": 0,
"folderVodCategoryYt": "1",
"folderVodStatusYt": "public",
"folderVodSamsungEnable": 0,
"folderVodSamsungKind": "",
"folderVodSamsungSeasonNumber": 0,
"folderVodSamsungSeasonTitle": "",
"folderVodSamsungSeasonDescription": "",
"folderVodSamsungSeasonImage": "",
"folderVodSamsungGenre": "",
"folderVodSamsungClassification": 0,
"folderVodSamsungSerialId": 0
},
{
"id": "6bc7881c-4f79-6a63-dd86-454c63062f23",
"name": "Publicités",
"color": "#71FFCD",
"status": "work",
"fallbackFolder": "",
"description": "",
"parentPath": "Ads",
"folderVodTitle": "",
"folderVodSubtitle": "",
"folderVodDescription": "",
"folderVodType": "",
"folderVodGenre": "",
"folderVodRubrique": "",
"folderVodGroupe": "",
"folderVodKeywords": "",
"folderVodImage": "",
"folderVodPlIdDm": "",
"folderVodPlIdYt": "",
"folderVodOrangeId": "",
"folderVodOrangeEnable": 0,
"folderVodDmEnable": 0,
"folderVodYtEnable": 0,
"folderVodStartimesEnable": 0,
"folderVodCategoryYt": "1",
"folderVodStatusYt": "public",
"folderVodSamsungEnable": 0,
"folderVodSamsungKind": "",
"folderVodSamsungSeasonNumber": 0,
"folderVodSamsungSeasonTitle": "",
"folderVodSamsungSeasonDescription": "",
"folderVodSamsungSeasonImage": "",
"folderVodSamsungGenre": "",
"folderVodSamsungClassification": 0,
"folderVodSamsungSerialId": 0
},
{
"id": "17a965b7-123c-8ba2-9674-6d50b7239649",
"name": "tapis pub",
"color": "#F2FF58",
"status": "work",
"fallbackFolder": "",
"description": "",
"parentPath": "Ads",
"folderVodTitle": "",
"folderVodSubtitle": "",
"folderVodDescription": "",
"folderVodType": "",
"folderVodGenre": "",
"folderVodRubrique": "",
"folderVodGroupe": "",
"folderVodKeywords": "",
"folderVodImage": "",
"folderVodPlIdDm": "",
"folderVodPlIdYt": "",
"folderVodOrangeId": "",
"folderVodOrangeEnable": 0,
"folderVodDmEnable": 0,
"folderVodYtEnable": 0,
"folderVodStartimesEnable": 0,
"folderVodCategoryYt": "1",
"folderVodStatusYt": "public",
"folderVodSamsungEnable": 0,
"folderVodSamsungKind": "",
"folderVodSamsungSeasonNumber": 0,
"folderVodSamsungSeasonTitle": "",
"folderVodSamsungSeasonDescription": "",
"folderVodSamsungSeasonImage": "",
"folderVodSamsungGenre": "",
"folderVodSamsungClassification": 0,
"folderVodSamsungSerialId": 0
},
]
}List the automations/slices present on an instance.
The calling URL is :
http://<URL_de_mon_instance>/synthesia/okast-channels/playlist/manager/data/tranches.json
Example of an answer
{
"tranches": [
{
"id": "2140572b-351f-6ce9-eda2-9bb2d82bc3a5",
"name": "Live Event",
"scenario": "",
"duration": "3600000",
"color": "#FF4F4E",
"autoKind": "loop",
"automation": "cedf5f70-4a46-3307-1f03-93e0d09f4ed9:injectKindShuffle:1:false:false:false:folderKindRegular::32d6d007-8fd1-611f-d4b4-15f3e248e9aa:false::false;7b545c32-2809-c10b-d25c-0369a3dcaaa0:injectKindShuffle:1:false:false:false:folderKindRegular:::false::false;6bc7881c-4f79-6a63-dd86-454c63062f23:injectKindShuffle:2:false:false:false:folderKindRegular:::false::false;7b545c32-2809-c10b-d25c-0369a3dcaaa0:injectKindShuffle:1:false:false:false:folderKindRegular:::false::false;cedf5f70-4a46-3307-1f03-93e0d09f4ed9:injectKindShuffle:1:false:false:false:folderKindRegular::32d6d007-8fd1-611f-d4b4-15f3e248e9aa:false::false;7b545c32-2809-c10b-d25c-0369a3dcaaa0:injectKindShuffle:1:false:false:false:folderKindRegular:::false::false;6bc7881c-4f79-6a63-dd86-454c63062f23:injectKindShuffle:2:false:false:false:folderKindRegular:::false::false;7b545c32-2809-c10b-d25c-0369a3dcaaa0:injectKindShuffle:1:false:false:false:folderKindRegular:::false::false;cedf5f70-4a46-3307-1f03-93e0d09f4ed9:injectKindShuffle:1:false:false:false:folderKindRegular::32d6d007-8fd1-611f-d4b4-15f3e248e9aa:false::false;7b545c32-2809-c10b-d25c-0369a3dcaaa0:injectKindShuffle:1:false:false:false:folderKindRegular:::false::false;6bc7881c-4f79-6a63-dd86-454c63062f23:injectKindShuffle:2:false:false:false:folderKindRegular:::false::false;7b545c32-2809-c10b-d25c-0369a3dcaaa0:injectKindShuffle:1:false:false:false:folderKindRegular:::false::false",
"rules": "",
"limit": 1,
"parentPath": "",
"interstitial": "",
"interstitialLimit": "60000",
"interstitialIgnoreFirst": true,
"interstitialIgnoreLast": true,
"interstitialTranche": false,
"interstitialApplyOnA": true,
"interstitialApplyOnB": false,
"interstitialApplyOnC": false,
"interstitialApplyOnD": false,
"interstitialApplyOnFirst": true,
"interstitialApplyOnLast": true
},
{
"id": "6d678547-2cc5-ff89-5138-4c37e82710f5",
"name": "Shorts-films",
"scenario": "",
"duration": "14400000",
"color": "#7B94FF",
"autoKind": "loop",
"automation": "b08eef50-881a-146c-6b44-fee5b24f84a4:injectKindShuffle:1:true:false:false:folderKindRegular:::false::false;022511c0-6a5d-0c13-2107-6cbbd835212a:injectKindShuffle:1:false:false:false:folderKindRegular:::false::false;7b545c32-2809-c10b-d25c-0369a3dcaaa0:injectKindShuffle:1:false:false:false:folderKindRegular:::false::false;CURRENT::0:false:false:false:folderKindLink:::false::false;6bc7881c-4f79-6a63-dd86-454c63062f23:injectKindShuffle:1:false:false:false:folderKindRegular:::false::false;CURRENT::0:false:false:false:folderKindLink:::false::false;421adfcc-5b92-356c-9553-609075bf194b:injectKindShuffle:1:false:false:false:folderKindRegular:::false::false;CURRENT::0:false:false:false:folderKindLink:::false::false;7b545c32-2809-c10b-d25c-0369a3dcaaa0:injectKindShuffle:1:false:false:false:folderKindRegular:::false::false",
"rules": "",
"limit": 1,
"parentPath": "",
"interstitial": "",
"interstitialLimit": "60000",
"interstitialIgnoreFirst": true,
"interstitialIgnoreLast": true,
"interstitialTranche": false,
"interstitialApplyOnA": true,
"interstitialApplyOnB": false,
"interstitialApplyOnC": false,
"interstitialApplyOnD": false,
"interstitialApplyOnFirst": true,
"interstitialApplyOnLast": true
}
]
}List the media present on an instance.
This functionality currently presents a risk of overloading the server when the media base exceeds 100 media. A filtering solution will be deployed shortly.
The calling URL is :
http://<URL_de_mon_instance>/synthesia/okast-channels/playlist/manager/php/_getVideos.php
Example of an answer
{
"Sintel_2010_1080p.mp4": {
"album": "",
"artist": "",
"audioOnly": null,
"author": "",
"category": "",
"classification": "",
"comments": "",
"compositor": "",
"country": "",
"crossFade": 0,
"date": 1661181481,
"dateDay": "",
"dateMonth": "",
"dateYear": "",
"description": "This is a description",
"duration": 888000,
"episode": "",
"guid": "..\/master\/Sintel_2010_1080p.mp4",
"hasAnnonce": null,
"hasOverlay": null,
"host": "",
"host2": "",
"host2Function": "",
"host3": "",
"host3Function": "",
"hostFunction": "",
"image": "",
"internal": "",
"internalRef": "",
"isPub": null,
"isRightMusic": null,
"isan": "",
"isrc": "",
"keywords": "",
"label": "",
"notValidated": false,
"oeCategory": "",
"plurimedia": "",
"qrDescription": "",
"qrInvite": "",
"qrTitle": "",
"qrUrl": "",
"realDuration": 888000,
"replay": "1",
"scte35Id": "",
"scte35Kind": "4",
"season": "",
"showName": "",
"siteUrl": "",
"source": "Local",
"subtitle": "",
"title": "Sintel - Blender Open Movie",
"validityDayEnable": null,
"validityDayFromHour": "",
"validityDayFromMinute": "",
"validityDayToHour": "",
"validityDayToMinute": "",
"validityDays0": "1",
"validityDays1": "1",
"validityDays2": "1",
"validityDays3": "1",
"validityDays4": "1",
"validityDays5": "1",
"validityDays6": "1",
"validityFromDay": "",
"validityFromHour": "",
"validityFromMinute": "",
"validityFromMonth": "",
"validityFromYear": "",
"validityToDay": "",
"validityToHour": "",
"validityToMinute": "",
"validityToMonth": "",
"validityToYear": "",
"year": "",
"tags": "49305f0d-92dc-2f55-295b-79b708149dfa",
"toRemove": false,
"status": {
"available": true,
"converting": false,
"waiting": false,
"priority": 0,
"inCurrentPlaylist": false,
"inNextPlaylist": false,
"inDaysPlaylist": false,
"canRemove": false,
"scheduled": true
}
},
"bbb_sunflower_1080p_30fps_normal.mp4": {
"album": "",
"artist": "",
"audioOnly": null,
"author": "",
"category": "",
"classification": "",
"comments": "",
"compositor": "",
"country": "",
"crossFade": 0,
"date": 1660121159,
"dateDay": "",
"dateMonth": "",
"dateYear": "",
"description": "",
"duration": 634600,
"episode": "",
"guid": "..\/master\/bbb_sunflower_1080p_30fps_normal.mp4",
"hasAnnonce": null,
"hasOverlay": null,
"host": "",
"host2": "",
"host2Function": "",
"host3": "",
"host3Function": "",
"hostFunction": "",
"image": "",
"internal": "",
"internalRef": "",
"isPub": null,
"isRightMusic": null,
"isan": "",
"isrc": "",
"keywords": "",
"label": "",
"notValidated": false,
"oeCategory": "",
"plurimedia": "",
"qrDescription": "",
"qrInvite": "",
"qrTitle": "",
"qrUrl": "",
"realDuration": 634600,
"replay": "1",
"scte35Id": "",
"scte35Kind": "4",
"season": "",
"showName": "",
"siteUrl": "",
"source": "Local",
"subtitle": "",
"title": "Big Buck Bunny - Blender Open Movie",
"validityDayEnable": null,
"validityDayFromHour": "",
"validityDayFromMinute": "",
"validityDayToHour": "",
"validityDayToMinute": "",
"validityDays0": "1",
"validityDays1": "1",
"validityDays2": "1",
"validityDays3": "1",
"validityDays4": "1",
"validityDays5": "1",
"validityDays6": "1",
"validityFromDay": "",
"validityFromHour": "",
"validityFromMinute": "",
"validityFromMonth": "",
"validityFromYear": "",
"validityToDay": "",
"validityToHour": "",
"validityToMinute": "",
"validityToMonth": "",
"validityToYear": "",
"year": "",
"tags": "49305f0d-92dc-2f55-295b-79b708149dfa",
"toRemove": false,
"status": {
"available": true,
"converting": false,
"waiting": false,
"priority": 0,
"inCurrentPlaylist": false,
"inNextPlaylist": false,
"inDaysPlaylist": false,
"canRemove": false,
"scheduled": true
}
},
"Skoda_1920x1080.mp4": {
"album": "",
"artist": "",
"audioOnly": null,
"author": "",
"category": "",
"classification": "",
"comments": "",
"compositor": "",
"country": "",
"crossFade": 0,
"date": 1655894200,
"dateDay": "",
"dateMonth": "",
"dateYear": "",
"description": "",
"duration": 19880,
"episode": "",
"guid": "..\/master\/Skoda_1920x1080.mp4",
"hasAnnonce": null,
"hasOverlay": null,
"host": "",
"host2": "",
"host2Function": "",
"host3": "",
"host3Function": "",
"hostFunction": "",
"image": "",
"internal": "",
"internalRef": "",
"isPub": null,
"isRightMusic": null,
"isan": "",
"isrc": "",
"keywords": "",
"label": "",
"notValidated": false,
"oeCategory": "",
"plurimedia": "",
"qrDescription": "",
"qrInvite": "",
"qrTitle": "",
"qrUrl": "",
"realDuration": 19880,
"replay": "1",
"scte35Id": "16cb4750-c42c-e13e-a5e1-13e5ce302c82",
"scte35Kind": "4",
"season": "",
"showName": "",
"siteUrl": "",
"source": "Local",
"subtitle": "",
"tags": "4a808634-a2db-c3c6-0df7-14f93bfde36b",
"title": "Pub Skoda",
"toRemove": false,
"validityDayEnable": null,
"validityDayFromHour": "",
"validityDayFromMinute": "",
"validityDayToHour": "",
"validityDayToMinute": "",
"validityDays0": null,
"validityDays1": null,
"validityDays2": null,
"validityDays3": null,
"validityDays4": null,
"validityDays5": null,
"validityDays6": null,
"validityFromDay": "",
"validityFromHour": "",
"validityFromMinute": "",
"validityFromMonth": "",
"validityFromYear": "",
"validityToDay": "",
"validityToHour": "",
"validityToMinute": "",
"validityToMonth": "",
"validityToYear": "",
"year": "",
"status": {
"available": true,
"converting": false,
"waiting": false,
"priority": 0,
"inCurrentPlaylist": false,
"inNextPlaylist": false,
"inDaysPlaylist": false,
"canRemove": false,
"scheduled": true
}
}
}