{ "opencollection": "1.0.0", "info": { "name": "Kaltura OTT accessControl baseEntry API", "version": "3.6.287.20720" }, "items": [ { "info": { "name": "baseEntry", "type": "folder" }, "items": [ { "info": { "name": "baseEntry.add", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/add", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Generic add entry, should be used when the uploaded entry type is not known." }, { "info": { "name": "baseEntry.addContent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/addContent", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Attach content resource to entry in status NO_MEDIA" }, { "info": { "name": "baseEntry.addFromUploadedFile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/addFromUploadedFile", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Generic add entry using an uploaded file, should be used when the uploaded entry type is not known." }, { "info": { "name": "baseEntry.anonymousRank", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/anonymousRank", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Anonymously rank an entry, no validation is done on duplicate rankings." }, { "info": { "name": "baseEntry.approve", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/approve", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Approve the entry and mark the pending flags (if any) as moderated (this will make the entry playable)." }, { "info": { "name": "baseEntry.clone", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/clone", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Clone an entry with optional attributes to apply to the clone" }, { "info": { "name": "baseEntry.count", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/count", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Count base entries by filter." }, { "info": { "name": "baseEntry.delete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/delete", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Delete an entry." }, { "info": { "name": "baseEntry.export", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/export", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] } }, { "info": { "name": "baseEntry.exportToCsv", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/exportToCsv", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "add batch job that sends an email with a link to download an updated CSV that contains list of entries" }, { "info": { "name": "baseEntry.flag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/flag", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Flag inappropriate entry for moderation." }, { "info": { "name": "baseEntry.get", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/get", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Get base entry by ID." }, { "info": { "name": "baseEntry.getByIds", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/getByIds", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Get an array of KalturaBaseEntry objects by a comma-separated list of ids." }, { "info": { "name": "baseEntry.getContextData", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/getContextData", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "This action delivers entry-related data, based on the user's context: access control, restriction, playback format and storage information." }, { "info": { "name": "baseEntry.getPlaybackContext", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/getPlaybackContext", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "This action delivers all data relevant for player" }, { "info": { "name": "baseEntry.getRemotePaths", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/getRemotePaths", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Get remote storage existing paths for the asset." }, { "info": { "name": "baseEntry.index", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/index", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Index an entry by id." }, { "info": { "name": "baseEntry.list", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/list", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "List base entries by filter with paging support." }, { "info": { "name": "baseEntry.listByReferenceId", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/listByReferenceId", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "List base entries by filter according to reference id" }, { "info": { "name": "baseEntry.listFlags", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/listFlags", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "List all pending flags for the entry." }, { "info": { "name": "baseEntry.reject", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/reject", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Reject the entry and mark the pending flags (if any) as moderated (this will make the entry non-playable)." }, { "info": { "name": "baseEntry.servePlaybackKey", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/servePlaybackKey", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "This action serves HLS encrypted key if access control is validated" }, { "info": { "name": "baseEntry.update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/update", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Update base entry. Only the properties that were set will be updated." }, { "info": { "name": "baseEntry.updateContent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/updateContent", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Update the content resource associated with the entry." }, { "info": { "name": "baseEntry.updateThumbnailFromSourceEntry", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/updateThumbnailFromSourceEntry", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Update entry thumbnail from a different entry by a specified time offset (in seconds)." }, { "info": { "name": "baseEntry.updateThumbnailFromUrl", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/updateThumbnailFromUrl", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Update entry thumbnail using URL." }, { "info": { "name": "baseEntry.updateThumbnailJpeg", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/updateThumbnailJpeg", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "entryId", "value": "", "type": "query", "description": "Media entry id" } ] }, "docs": "Update entry thumbnail using a raw jpeg file." }, { "info": { "name": "baseEntry.upload", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/baseentry/action/upload", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" } ] }, "docs": "Upload a file to Kaltura, that can be used to create an entry." } ] } ], "bundled": true }