swagger: '2.0'
info:
description: The Kaltura OTT API
title: Kaltura OTT accessControl entryVendorTask API
version: 3.6.287.20720
host: tvpapi-us-preprod.ott.kaltura.com
basePath: /api_v3
schemes:
- https
- http
produces:
- application/json
- text/xml
security:
- ks: []
tags:
- description: Entry Vendor Task Service
name: entryVendorTask
x-plugin: reach
paths:
/service/reach_entryvendortask/action/abort:
post:
description: Cancel entry task. will only occur for task in PENDING or PENDING_MODERATION status
operationId: entryVendorTask.abort
parameters:
- $ref: '#/parameters/ks'
- $ref: '#/parameters/format'
- $ref: '#/parameters/clientTag'
- $ref: '#/parameters/partnerId'
- $ref: '#/parameters/language'
- $ref: '#/parameters/responseProfile'
- in: body
name: body
schema:
properties:
abortReason:
type: string
id:
type: integer
required:
- id
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaEntryVendorTask'
x-Errors:
description: '* `ENTRY_VENDOR_TASK_NOT_FOUND`: Entry vendor task item with id provided not found [@ID@]'
tags:
- entryVendorTask
x-kaltura-format: post
x-kaltura-parameters:
- id
- abortReason
/service/reach_entryvendortask/action/add:
post:
description: Allows you to add a entry vendor task
operationId: entryVendorTask.add
parameters:
- $ref: '#/parameters/ks'
- $ref: '#/parameters/format'
- $ref: '#/parameters/clientTag'
- $ref: '#/parameters/partnerId'
- $ref: '#/parameters/language'
- $ref: '#/parameters/responseProfile'
- in: body
name: body
schema:
properties:
entryVendorTask:
$ref: '#/definitions/KalturaEntryVendorTask'
required:
- entryVendorTask
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaEntryVendorTask'
x-Errors:
description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found
* `REACH_PROFILE_NOT_FOUND`: Reach profile with id provided not found [@ID@]
* `CATALOG_ITEM_NOT_FOUND`: Catalog item with id provided not found [@ID@]
* `ENTRY_VENDOR_TASK_DUPLICATION`: Entry vendor task already exists for entry [@ENTRY_ID@] and catalog item [@CATALOG_ITEM_ID@] and version [@VERSION@]
* `EXCEEDED_MAX_CREDIT_ALLOWED`: Exceeded max credit allowed, task could not be added for entry [@ENTRY_ID@] and catalog item [@CATALOG_ITEM_ID@]'
tags:
- entryVendorTask
x-kaltura-format: post
x-kaltura-parameters:
- entryVendorTask
/service/reach_entryvendortask/action/approve:
post:
description: Approve entry vendor task for execution.
operationId: entryVendorTask.approve
parameters:
- $ref: '#/parameters/ks'
- $ref: '#/parameters/format'
- $ref: '#/parameters/clientTag'
- $ref: '#/parameters/partnerId'
- $ref: '#/parameters/language'
- $ref: '#/parameters/responseProfile'
- in: body
name: body
schema:
properties:
id:
type: integer
required:
- id
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaEntryVendorTask'
x-Errors:
description: '* `ENTRY_VENDOR_TASK_NOT_FOUND`: Entry vendor task item with id provided not found [@ID@]
* `CANNOT_APPROVE_NOT_MODERATED_TASK`: Cannot approve task which is not pending moderation
* `EXCEEDED_MAX_CREDIT_ALLOWED`: Exceeded max credit allowed, task could not be added for entry [@ENTRY_ID@] and catalog item [@CATALOG_ITEM_ID@]'
tags:
- entryVendorTask
x-kaltura-format: post
x-kaltura-parameters:
- id
/service/reach_entryvendortask/action/exportToCsv:
post:
description: add batch job that sends an email with a link to download an updated CSV that contains list of users
operationId: entryVendorTask.exportToCsv
parameters:
- $ref: '#/parameters/ks'
- $ref: '#/parameters/format'
- $ref: '#/parameters/clientTag'
- $ref: '#/parameters/partnerId'
- $ref: '#/parameters/language'
- $ref: '#/parameters/responseProfile'
- in: body
name: body
schema:
properties:
filter:
$ref: '#/definitions/KalturaEntryVendorTaskFilter'
required:
- filter
type: object
responses:
'200':
description: Success
schema:
type: string
tags:
- entryVendorTask
x-kaltura-format: post
x-kaltura-parameters:
- filter
/service/reach_entryvendortask/action/extendAccessKey:
post:
description: Extend access key in case the existing one has expired.
operationId: entryVendorTask.extendAccessKey
parameters:
- $ref: '#/parameters/ks'
- $ref: '#/parameters/format'
- $ref: '#/parameters/clientTag'
- $ref: '#/parameters/partnerId'
- $ref: '#/parameters/language'
- $ref: '#/parameters/responseProfile'
- in: body
name: body
schema:
properties:
id:
type: integer
required:
- id
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaEntryVendorTask'
x-Errors:
description: '* `ENTRY_VENDOR_TASK_NOT_FOUND`: Entry vendor task item with id provided not found [@ID@]
* `CANNOT_EXTEND_ACCESS_KEY`: Extending accessKey for non processing task is not allowed'
tags:
- entryVendorTask
x-kaltura-format: post
x-kaltura-parameters:
- id
/service/reach_entryvendortask/action/get:
post:
description: Retrieve specific entry vendor task by id
operationId: entryVendorTask.get
parameters:
- $ref: '#/parameters/ks'
- $ref: '#/parameters/format'
- $ref: '#/parameters/clientTag'
- $ref: '#/parameters/partnerId'
- $ref: '#/parameters/language'
- $ref: '#/parameters/responseProfile'
- in: body
name: body
schema:
properties:
id:
type: integer
required:
- id
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaEntryVendorTask'
x-Errors:
description: '* `REACH_PROFILE_NOT_FOUND`: Reach profile with id provided not found [@ID@]'
tags:
- entryVendorTask
x-kaltura-format: post
x-kaltura-parameters:
- id
/service/reach_entryvendortask/action/getJobs:
post:
description: get KalturaEntryVendorTask objects for specific vendor partner
operationId: entryVendorTask.getJobs
parameters:
- $ref: '#/parameters/ks'
- $ref: '#/parameters/format'
- $ref: '#/parameters/clientTag'
- $ref: '#/parameters/partnerId'
- $ref: '#/parameters/language'
- $ref: '#/parameters/responseProfile'
- in: body
name: body
schema:
properties:
filter:
$ref: '#/definitions/KalturaEntryVendorTaskFilter'
pager:
$ref: '#/definitions/KalturaFilterPager'
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaEntryVendorTaskListResponse'
tags:
- entryVendorTask
x-kaltura-format: post
x-kaltura-parameters:
- filter
- pager
/service/reach_entryvendortask/action/getServeUrl:
post:
operationId: entryVendorTask.getServeUrl
parameters:
- $ref: '#/parameters/ks'
- $ref: '#/parameters/format'
- $ref: '#/parameters/clientTag'
- $ref: '#/parameters/partnerId'
- $ref: '#/parameters/language'
- $ref: '#/parameters/responseProfile'
- in: body
name: body
schema:
properties:
dueDate:
type: string
x-inputType: datetime
filterInput:
type: integer
filterType:
type: string
status:
type: integer
type: object
responses:
'200':
description: Success
schema:
type: string
tags:
- entryVendorTask
x-kaltura-format: post
x-kaltura-parameters:
- filterType
- filterInput
- status
- dueDate
/service/reach_entryvendortask/action/list:
post:
description: List KalturaEntryVendorTask objects
operationId: entryVendorTask.list
parameters:
- $ref: '#/parameters/ks'
- $ref: '#/parameters/format'
- $ref: '#/parameters/clientTag'
- $ref: '#/parameters/partnerId'
- $ref: '#/parameters/language'
- $ref: '#/parameters/responseProfile'
- in: body
name: body
schema:
properties:
filter:
$ref: '#/definitions/KalturaEntryVendorTaskFilter'
pager:
$ref: '#/definitions/KalturaFilterPager'
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaEntryVendorTaskListResponse'
tags:
- entryVendorTask
x-kaltura-format: post
x-kaltura-parameters:
- filter
- pager
/service/reach_entryvendortask/action/reject:
post:
description: Reject entry vendor task for execution.
operationId: entryVendorTask.reject
parameters:
- $ref: '#/parameters/ks'
- $ref: '#/parameters/format'
- $ref: '#/parameters/clientTag'
- $ref: '#/parameters/partnerId'
- $ref: '#/parameters/language'
- $ref: '#/parameters/responseProfile'
- in: body
name: body
schema:
properties:
id:
type: integer
rejectReason:
type: string
required:
- id
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaEntryVendorTask'
x-Errors:
description: '* `ENTRY_VENDOR_TASK_NOT_FOUND`: Entry vendor task item with id provided not found [@ID@]
* `CANNOT_REJECT_NOT_MODERATED_TASK`: Cannot reject task which is not pending moderation'
tags:
- entryVendorTask
x-kaltura-format: post
x-kaltura-parameters:
- id
- rejectReason
/service/reach_entryvendortask/action/serve:
post:
operationId: entryVendorTask.serve
parameters:
- $ref: '#/parameters/ks'
- $ref: '#/parameters/format'
- $ref: '#/parameters/clientTag'
- $ref: '#/parameters/partnerId'
- $ref: '#/parameters/language'
- $ref: '#/parameters/responseProfile'
- in: body
name: body
schema:
properties:
dueDate:
type: string
x-inputType: datetime
partnerId:
type: integer
status:
type: integer
vendorPartnerId:
type: integer
type: object
responses:
'200':
description: Success
schema:
type: string
tags:
- entryVendorTask
x-kaltura-format: post
x-kaltura-parameters:
- vendorPartnerId
- partnerId
- status
- dueDate
/service/reach_entryvendortask/action/serveCsv:
post:
deprecated: true
description: Will serve a requested csv
operationId: entryVendorTask.serveCsv
parameters:
- $ref: '#/parameters/ks'
- $ref: '#/parameters/format'
- $ref: '#/parameters/clientTag'
- $ref: '#/parameters/partnerId'
- $ref: '#/parameters/language'
- $ref: '#/parameters/responseProfile'
- in: body
name: body
schema:
properties:
id:
type: string
required:
- id
type: object
responses:
'200':
description: Success
schema:
type: string
tags:
- entryVendorTask
x-kaltura-format: post
x-kaltura-parameters:
- id
/service/reach_entryvendortask/action/update:
post:
description: Update entry vendor task. Only the properties that were set will be updated.
operationId: entryVendorTask.update
parameters:
- $ref: '#/parameters/ks'
- $ref: '#/parameters/format'
- $ref: '#/parameters/clientTag'
- $ref: '#/parameters/partnerId'
- $ref: '#/parameters/language'
- $ref: '#/parameters/responseProfile'
- in: body
name: body
schema:
properties:
entryVendorTask:
$ref: '#/definitions/KalturaEntryVendorTask'
id:
type: integer
required:
- id
- entryVendorTask
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaEntryVendorTask'
x-Errors:
description: '* `ENTRY_VENDOR_TASK_NOT_FOUND`: Entry vendor task item with id provided not found [@ID@]'
tags:
- entryVendorTask
x-kaltura-format: post
x-kaltura-parameters:
- id
- entryVendorTask
/service/reach_entryvendortask/action/updateJob:
post:
description: Update entry vendor task. Only the properties that were set will be updated.
operationId: entryVendorTask.updateJob
parameters:
- $ref: '#/parameters/ks'
- $ref: '#/parameters/format'
- $ref: '#/parameters/clientTag'
- $ref: '#/parameters/partnerId'
- $ref: '#/parameters/language'
- $ref: '#/parameters/responseProfile'
- in: body
name: body
schema:
properties:
entryVendorTask:
$ref: '#/definitions/KalturaEntryVendorTask'
id:
type: integer
required:
- id
- entryVendorTask
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaEntryVendorTask'
x-Errors:
description: '* `ENTRY_VENDOR_TASK_NOT_FOUND`: Entry vendor task item with id provided not found [@ID@]'
tags:
- entryVendorTask
x-kaltura-format: post
x-kaltura-parameters:
- id
- entryVendorTask
definitions:
KalturaPushToNewsDistributionProfile:
allOf:
- $ref: '#/definitions/KalturaConfigurableDistributionProfile'
properties:
basePath:
type: string
bodyXslt:
type: string
certificateKey:
type: string
host:
type: string
ips:
type: string
namedItem:
type: string
password:
type: string
x-inputType: password
port:
type: integer
protocol:
description: '`insertOnly`
Enum Type: `KalturaDistributionProtocol`'
enum:
- 1
- 2
- 3
- 4
- 5
- 10
type: integer
x-enumLabels:
- FTP
- SCP
- SFTP
- HTTP
- HTTPS
- ASPERA
x-enumType: KalturaDistributionProtocol
recentNewsTimeInterval:
type: integer
username:
type: string
title: KalturaPushToNewsDistributionProfile
type: object
KalturaBatchJobListResponse:
allOf:
- $ref: '#/definitions/KalturaListResponse'
properties:
objects:
items:
$ref: '#/definitions/KalturaBatchJob'
type: array
title: KalturaBatchJobListResponse
type: object
KalturaUverseDistributionProfile:
allOf:
- $ref: '#/definitions/KalturaConfigurableDistributionProfile'
properties:
channelCopyright:
type: string
channelDescription:
type: string
channelImageLink:
type: string
channelImageTitle:
type: string
channelImageUrl:
type: string
channelLanguage:
type: string
channelLink:
type: string
channelTitle:
type: string
feedUrl:
description: '`readOnly`'
readOnly: true
type: string
ftpHost:
type: string
ftpLogin:
type: string
ftpPassword:
type: string
title: KalturaUverseDistributionProfile
type: object
KalturaServerNode:
anyOf:
- $ref: '#/definitions/KalturaConferenceServerNode'
- $ref: '#/definitions/KalturaSipServerNode'
- $ref: '#/definitions/KalturaEdgeServerNode'
- $ref: '#/definitions/KalturaLiveClusterMediaServerNode'
- $ref: '#/definitions/KalturaWowzaMediaServerNode'
description: '`abstract`'
discriminator: objectType
properties:
createdAt:
description: '`readOnly`'
readOnly: true
type: integer
dc:
description: '`readOnly`
DC where the serverNode is located'
readOnly: true
type: integer
description:
type: string
environment:
description: Environment
type: string
heartbeatTime:
description: '`readOnly`'
readOnly: true
type: integer
hostName:
description: serverNode hostName
type: string
id:
description: '`readOnly`'
readOnly: true
type: integer
name:
description: serverNode name
type: string
objectType:
enum:
- KalturaConferenceServerNode
- KalturaSipServerNode
- KalturaEdgeServerNode
- KalturaLiveClusterMediaServerNode
- KalturaWowzaMediaServerNode
type: string
parentId:
description: Id of the parent serverNode
type: string
partnerId:
description: '`readOnly`'
readOnly: true
type: integer
status:
description: '`readOnly`
Enum Type: `KalturaServerNodeStatus`'
enum:
- 1
- 2
- 3
- 4
- 5
readOnly: true
type: integer
x-enumLabels:
- ACTIVE
- DISABLED
- DELETED
- NOT_REGISTERED
- NOT_OPERATIONAL
x-enumType: KalturaServerNodeStatus
systemName:
description: serverNode uniqe system name
type: string
tags:
description: serverNode tags
type: string
type:
description: '`readOnly`
Enum Type: `KalturaServerNodeType`'
enum:
- conference.CONFERENCE_SERVER
- liveCluster.LIVE_CLUSTER_MEDIA_SERVER
- sip.SIP_SERVER
- wowza.WOWZA_MEDIA_SERVER
- '1'
readOnly: true
type: string
x-enumLabels:
- CONFERENCE_SERVER
- LIVE_CLUSTER_MEDIA_SERVER
- SIP_SERVER
- WOWZA_MEDIA_SERVER
- EDGE
x-enumType: KalturaServerNodeType
updatedAt:
description: '`readOnly`'
readOnly: true
type: integer
title: KalturaServerNode
type: object
x-abstract: true
KalturaIdeticDistributionProfileFilter:
allOf:
- $ref: '#/definitions/KalturaIdeticDistributionProfileBaseFilter'
properties:
orderBy:
enum:
- +createdAt
- +updatedAt
- -createdAt
- -updatedAt
type: string
x-enumLabels:
- CREATED_AT_ASC
- UPDATED_AT_ASC
- CREATED_AT_DESC
- UPDATED_AT_DESC
x-enumType: KalturaIdeticDistributionProfileOrderBy
title: KalturaIdeticDistributionProfileFilter
type: object
KalturaQuizUserEntry:
allOf:
- $ref: '#/definitions/KalturaUserEntry'
properties:
calculatedScore:
description: '`readOnly`'
readOnly: true
type: number
feedback:
type: string
score:
description: '`readOnly`'
readOnly: true
type: number
version:
description: '`readOnly`'
readOnly: true
type: integer
title: KalturaQuizUserEntry
type: object
KalturaYahooDistributionProviderBaseFilter:
allOf:
- $ref: '#/definitions/KalturaDistributionProviderFilter'
anyOf:
- $ref: '#/definitions/KalturaYahooDistributionProviderFilter'
description: '`abstract`'
discriminator: objectType
properties:
objectType:
enum:
- KalturaYahooDistributionProviderFilter
type: string
title: KalturaYahooDistributionProviderBaseFilter
type: object
x-abstract: true
KalturaEmailNotificationUserRecipientJobData:
allOf:
- $ref: '#/definitions/KalturaEmailNotificationRecipientJobData'
description: JobData representing the dynamic user receipient array
properties:
filter:
$ref: '#/definitions/KalturaUserFilter'
title: KalturaEmailNotificationUserRecipientJobData
type: object
KalturaPodcastDistributionProfileBaseFilter:
allOf:
- $ref: '#/definitions/KalturaDistributionProfileFilter'
anyOf:
- $ref: '#/definitions/KalturaPodcastDistributionProfileFilter'
description: '`abstract`'
discriminator: objectType
properties:
objectType:
enum:
- KalturaPodcastDistributionProfileFilter
type: string
title: KalturaPodcastDistributionProfileBaseFilter
type: object
x-abstract: true
KalturaDrmProfile:
anyOf:
- $ref: '#/definitions/KalturaDrmProfile'
- $ref: '#/definitions/KalturaFairplayDrmProfile'
- $ref: '#/definitions/KalturaPlayReadyProfile'
- $ref: '#/definitions/KalturaWidevineProfile'
discriminator: objectType
properties:
createdAt:
description: '`readOnly`'
readOnly: true
type: integer
defaultPolicy:
type: string
description:
type: string
id:
description: '`readOnly`'
readOnly: true
type: integer
licenseServerUrl:
type: string
name:
type: string
objectType:
enum:
- KalturaDrmProfile
- KalturaFairplayDrmProfile
- KalturaPlayReadyProfile
- KalturaWidevineProfile
type: string
partnerId:
description: '`insertOnly`'
type: integer
provider:
description: 'Enum Type: `KalturaDrmProviderType`'
enum:
- fairplay.FAIRPLAY
- playReady.PLAY_READY
- widevine.WIDEVINE
- '1'
type: string
x-enumLabels:
- FAIRPLAY
- PLAY_READY
- WIDEVINE
- CENC
x-enumType: KalturaDrmProviderType
signingKey:
type: string
status:
description: 'Enum Type: `KalturaDrmProfileStatus`'
enum:
- 1
- 2
type: integer
x-enumLabels:
- ACTIVE
- DELETED
x-enumType: KalturaDrmProfileStatus
updatedAt:
description: '`readOnly`'
readOnly: true
type: integer
title: KalturaDrmProfile
type: object
KalturaStorageProfile:
anyOf:
- $ref: '#/definitions/KalturaStorageProfile'
- $ref: '#/definitions/KalturaAmazonS3StorageProfile'
- $ref: '#/definitions/KalturaKontikiStorageProfile'
discriminator: objectType
properties:
allowAutoDelete:
description: Flag sugnifying that the storage exported content should be deleted when soure entry is deleted
type: integer
createFileLink:
description: Indicates to the local file transfer manager to create a link to the file instead of copying it
type: boolean
createdAt:
description: '`readOnly`'
readOnly: true
type: integer
deliveryPriority:
description: Delivery Priority
type: integer
deliveryProfileIds:
items:
$ref: '#/definitions/KalturaKeyValue'
type: array
deliveryStatus:
description: 'Enum Type: `KalturaStorageProfileDeliveryStatus`'
enum:
- 1
- 2
type: integer
x-enumLabels:
- ACTIVE
- BLOCKED
x-enumType: KalturaStorageProfileDeliveryStatus
desciption:
type: string
excludedEntryTypes:
type: string
excludedFlavorParamsIds:
type: string
exportPeriodically:
type: boolean
flavorParamsIds:
type: string
id:
description: '`readOnly`'
readOnly: true
type: integer
maxConcurrentConnections:
type: integer
maxFileSize:
type: integer
minFileSize:
type: integer
name:
type: string
objectType:
enum:
- KalturaStorageProfile
- KalturaAmazonS3StorageProfile
- KalturaKontikiStorageProfile
type: string
packagerUrl:
type: string
partnerId:
description: '`readOnly`'
readOnly: true
type: integer
passPhrase:
type: string
pathManagerClass:
type: string
pathManagerParams:
items:
$ref: '#/definitions/KalturaKeyValue'
type: array
pathPrefix:
type: string
port:
type: integer
privateKey:
type: string
protocol:
description: 'Enum Type: `KalturaStorageProfileProtocol`'
enum:
- kontiki.KONTIKI
- '0'
- '1'
- '2'
- '3'
- '6'
- '7'
type: string
x-enumLabels:
- KONTIKI
- KALTURA_DC
- FTP
- SCP
- SFTP
- S3
- LOCAL
x-enumType: KalturaStorageProfileProtocol
publicKey:
type: string
readyBehavior:
description: 'Enum Type: `KalturaStorageProfileReadyBehavior`'
enum:
- 0
- 1
type: integer
x-enumLabels:
- NO_IMPACT
- REQUIRED
x-enumType: KalturaStorageProfileReadyBehavior
rules:
items:
$ref: '#/definitions/KalturaRule'
type: array
shouldExportCaptions:
type: boolean
shouldExportThumbs:
type: boolean
status:
description: 'Enum Type: `KalturaStorageProfileStatus`'
enum:
- 1
- 2
- 3
type: integer
x-enumLabels:
- DISABLED
- AUTOMATIC
- MANUAL
x-enumType: KalturaStorageProfileStatus
storageBaseDir:
type: string
storageFtpPassiveMode:
type: boolean
storagePassword:
type: string
storageUrl:
type: string
storageUsername:
type: string
systemName:
type: string
trigger:
description: No need to create enum for temp field
type: integer
updatedAt:
description: '`readOnly`'
readOnly: true
type: integer
title: KalturaStorageProfile
type: object
KalturaEntryVendorTaskCsvJobData:
allOf:
- $ref: '#/definitions/KalturaExportCsvJobData'
properties:
filter:
$ref: '#/definitions/KalturaEntryVendorTaskFilter'
title: KalturaEntryVendorTaskCsvJobData
type: object
KalturaUserLoginDataListResponse:
allOf:
- $ref: '#/definitions/KalturaListResponse'
properties:
objects:
items:
$ref: '#/definitions/KalturaUserLoginData'
type: array
title: KalturaUserLoginDataListResponse
type: object
KalturaMsnDistributionProfileBaseFilter:
allOf:
- $ref: '#/definitions/KalturaConfigurableDistributionProfileFilter'
anyOf:
- $ref: '#/definitions/KalturaMsnDistributionProfileFilter'
description: '`abstract`'
discriminator: objectType
properties:
objectType:
enum:
- KalturaMsnDistributionProfileFilter
type: string
title: KalturaMsnDistributionProfileBaseFilter
type: object
x-abstract: true
KalturaUrlTokenizerCht:
allOf:
- $ref: '#/definitions/KalturaUrlTokenizer'
properties: {}
title: KalturaUrlTokenizerCht
type: object
KalturaFtpDropFolderBaseFilter:
allOf:
- $ref: '#/definitions/KalturaRemoteDropFolderFilter'
anyOf:
- $ref: '#/definitions/KalturaFtpDropFolderFilter'
description: '`abstract`'
discriminator: objectType
properties:
objectType:
enum:
- KalturaFtpDropFolderFilter
type: string
title: KalturaFtpDropFolderBaseFilter
type: object
x-abstract: true
KalturaAttUverseDistributionFile:
properties:
assetId:
type: string
assetType:
description: 'Enum Type: `KalturaAssetType`'
enum:
- attachment.Attachment
- caption.Caption
- document.Document
- document.Image
- document.PDF
- document.SWF
- thumbCuePoint.timedThumb
- transcript.Transcript
- widevine.WidevineFlavor
- '1'
- '2'
- '3'
type: string
x-enumLabels:
- ATTACHMENT
- CAPTION
- DOCUMENT
- IMAGE
- PDF
- SWF
- TIMED_THUMB_ASSET
- TRANSCRIPT
- WIDEVINE_FLAVOR
- FLAVOR
- THUMBNAIL
- LIVE
x-enumType: KalturaAssetType
localFilePath:
type: string
remoteFilename:
type: string
title: KalturaAttUverseDistributionFile
type: object
KalturaString:
description: A string representation to return an array of strings
properties:
value:
type: string
title: KalturaString
type: object
KalturaDistributionProviderListResponse:
allOf:
- $ref: '#/definitions/KalturaListResponse'
properties:
objects:
items:
$ref: '#/definitions/KalturaDistributionProvider'
type: array
title: KalturaDistributionProviderListResponse
type: object
KalturaFreewheelDistributionProfileBaseFilter:
allOf:
- $ref: '#/definitions/KalturaDistributionProfileFilter'
anyOf:
- $ref: '#/definitions/KalturaFreewheelDistributionProfileFilter'
description: '`abstract`'
discriminator: objectType
properties:
objectType:
enum:
- KalturaFreewheelDistributionProfileFilter
type: string
title: KalturaFreewheelDistributionProfileBaseFilter
type: object
x-abstract: true
KalturaScheduleEventResourceListResponse:
allOf:
- $ref: '#/definitions/KalturaListResponse'
properties:
objects:
items:
$ref: '#/definitions/KalturaScheduleEventResource'
type: array
title: KalturaScheduleEventResourceListResponse
type: object
KalturaThumbAssetFilter:
allOf:
- $ref: '#/definitions/KalturaThumbAssetBaseFilter'
anyOf:
- $ref: '#/definitions/KalturaThumbAssetFilter'
- $ref: '#/definitions/KalturaTimedThumbAssetFilter'
discriminator: objectType
properties:
objectType:
enum:
- KalturaThumbAssetFilter
- KalturaTimedThumbAssetFilter
type: string
orderBy:
enum:
- +createdAt
- +deletedAt
- +size
- +updatedAt
- -createdAt
- -deletedAt
- -size
- -updatedAt
type: string
x-enumLabels:
- CREATED_AT_ASC
- DELETED_AT_ASC
- SIZE_ASC
- UPDATED_AT_ASC
- CREATED_AT_DESC
- DELETED_AT_DESC
- SIZE_DESC
- UPDATED_AT_DESC
x-enumType: KalturaThumbAssetOrderBy
title: KalturaThumbAssetFilter
type: object
KalturaPermissionItem:
anyOf:
- $ref: '#/definitions/KalturaApiActionPermissionItem'
- $ref: '#/definitions/KalturaApiParameterPermissionItem'
description: '`abstract`'
discriminator: objectType
properties:
createdAt:
description: '`readOnly`'
readOnly: true
type: integer
id:
description: '`readOnly`'
readOnly: true
type: integer
objectType:
enum:
- KalturaApiActionPe
# --- truncated at 32 KB (1460 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kaltura/refs/heads/main/openapi/kaltura-entryvendortask-api-openapi.yml