Kaltura thumbAsset API

Retrieve information and invoke actions on Thumb Asset

OpenAPI Specification

kaltura-thumbasset-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  description: The Kaltura OTT API
  title: Kaltura OTT accessControl thumbAsset 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: Retrieve information and invoke actions on Thumb Asset
  name: thumbAsset
paths:
  /service/thumbasset/action/add:
    post:
      description: Add thumbnail asset
      operationId: thumbAsset.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:
            entryId:
              type: string
            thumbAsset:
              $ref: '#/definitions/KalturaThumbAsset'
          required:
          - entryId
          - thumbAsset
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaThumbAsset'
        x-Errors:
          description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found

            * `THUMB_ASSET_ALREADY_EXISTS`: Thumbnail asset id "@ASSET_ID@" already use thumbnail params id "@PARAMS_ID@"

            * `UPLOAD_TOKEN_INVALID_STATUS_FOR_ADD_ENTRY`: Upload token is in an invalid status for adding entry, maybe the a file was not uploaded or the token was used

            * `UPLOADED_FILE_NOT_FOUND_BY_TOKEN`: The uploaded file was not found by the given token id, or was already used

            * `RECORDED_WEBCAM_FILE_NOT_FOUND`: The recorded webcam file was not found by the given token id, or was already used

            * `THUMB_ASSET_ID_NOT_FOUND`: The Thumbnail asset id "@ID@" not found

            * `STORAGE_PROFILE_ID_NOT_FOUND`: Storage profile id @ID@ not found

            * `RESOURCE_TYPE_NOT_SUPPORTED`: Resource type "@RES_TYPE@" not supported'
      tags:
      - thumbAsset
      x-kaltura-format: post
      x-kaltura-parameters:
      - entryId
      - thumbAsset
  /service/thumbasset/action/addFromImage:
    post:
      operationId: thumbAsset.addFromImage
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - in: query
        name: entryId
        required: true
        type: string
      - in: formData
        name: fileData
        required: true
        type: file
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaThumbAsset'
        x-Errors:
          description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found'
      tags:
      - thumbAsset
      x-kaltura-format: file
      x-kaltura-parameters:
      - entryId
      - fileData
  /service/thumbasset/action/addFromUrl:
    post:
      deprecated: true
      operationId: thumbAsset.addFromUrl
      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:
            entryId:
              type: string
            url:
              type: string
          required:
          - entryId
          - url
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaThumbAsset'
      tags:
      - thumbAsset
      x-kaltura-format: post
      x-kaltura-parameters:
      - entryId
      - url
  /service/thumbasset/action/delete:
    post:
      operationId: thumbAsset.delete
      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:
            thumbAssetId:
              type: string
          required:
          - thumbAssetId
          type: object
      responses:
        '200':
          description: Success
        x-Errors:
          description: '* `THUMB_ASSET_ID_NOT_FOUND`: The Thumbnail asset id "@ID@" not found'
      tags:
      - thumbAsset
      x-kaltura-format: post
      x-kaltura-parameters:
      - thumbAssetId
  /service/thumbasset/action/export:
    post:
      description: manually export an asset
      operationId: thumbAsset.export
      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:
            assetId:
              type: string
            storageProfileId:
              type: integer
          required:
          - assetId
          - storageProfileId
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaFlavorAsset'
        x-Errors:
          description: '* `INVALID_FLAVOR_ASSET_ID`:  Invalid flavor asset id @FLAV_ASSET_ID@

            * `STORAGE_PROFILE_ID_NOT_FOUND`: Storage profile id @ID@ not found

            * `INTERNAL_SERVERL_ERROR`: Internal server error occurred'
      tags:
      - thumbAsset
      x-kaltura-format: post
      x-kaltura-parameters:
      - assetId
      - storageProfileId
  /service/thumbasset/action/generate:
    post:
      operationId: thumbAsset.generate
      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:
            entryId:
              type: string
            sourceAssetId:
              type: string
            thumbParams:
              $ref: '#/definitions/KalturaThumbParams'
          required:
          - entryId
          - thumbParams
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaThumbAsset'
        x-Errors:
          description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found

            * `ENTRY_TYPE_NOT_SUPPORTED`: Entry type "@ENTRY_TYPE@" not supported

            * `ENTRY_MEDIA_TYPE_NOT_SUPPORTED`: Entry media type "@MEDIA_TYPE@" not supported

            * `THUMB_ASSET_PARAMS_ID_NOT_FOUND`

            * `INVALID_ENTRY_STATUS`: Invalid entry status

            * `THUMB_ASSET_IS_NOT_READY`: The thumbnail asset is not ready'
      tags:
      - thumbAsset
      x-kaltura-format: post
      x-kaltura-parameters:
      - entryId
      - thumbParams
      - sourceAssetId
  /service/thumbasset/action/generateByEntryId:
    post:
      operationId: thumbAsset.generateByEntryId
      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:
            destThumbParamsId:
              type: integer
            entryId:
              type: string
          required:
          - entryId
          - destThumbParamsId
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaThumbAsset'
        x-Errors:
          description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found

            * `ENTRY_TYPE_NOT_SUPPORTED`: Entry type "@ENTRY_TYPE@" not supported

            * `ENTRY_MEDIA_TYPE_NOT_SUPPORTED`: Entry media type "@MEDIA_TYPE@" not supported

            * `THUMB_ASSET_PARAMS_ID_NOT_FOUND`

            * `INVALID_ENTRY_STATUS`: Invalid entry status

            * `THUMB_ASSET_IS_NOT_READY`: The thumbnail asset is not ready'
      tags:
      - thumbAsset
      x-kaltura-format: post
      x-kaltura-parameters:
      - entryId
      - destThumbParamsId
  /service/thumbasset/action/get:
    post:
      operationId: thumbAsset.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:
            thumbAssetId:
              type: string
          required:
          - thumbAssetId
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaThumbAsset'
        x-Errors:
          description: '* `THUMB_ASSET_ID_NOT_FOUND`: The Thumbnail asset id "@ID@" not found'
      tags:
      - thumbAsset
      x-kaltura-format: post
      x-kaltura-parameters:
      - thumbAssetId
  /service/thumbasset/action/getByEntryId:
    post:
      deprecated: true
      operationId: thumbAsset.getByEntryId
      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:
            entryId:
              type: string
          required:
          - entryId
          type: object
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/KalturaThumbAsset'
            type: array
        x-Errors:
          description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found'
      tags:
      - thumbAsset
      x-kaltura-format: post
      x-kaltura-parameters:
      - entryId
  /service/thumbasset/action/getRemotePaths:
    post:
      description: Get remote storage existing paths for the asset
      operationId: thumbAsset.getRemotePaths
      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:
            $ref: '#/definitions/KalturaRemotePathListResponse'
        x-Errors:
          description: '* `THUMB_ASSET_ID_NOT_FOUND`: The Thumbnail asset id "@ID@" not found

            * `THUMB_ASSET_IS_NOT_READY`: The thumbnail asset is not ready'
      tags:
      - thumbAsset
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
  /service/thumbasset/action/getUrl:
    post:
      description: Get download URL for the asset
      operationId: thumbAsset.getUrl
      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
            storageId:
              type: integer
            thumbParams:
              $ref: '#/definitions/KalturaThumbParams'
          required:
          - id
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: string
        x-Errors:
          description: '* `THUMB_ASSET_ID_NOT_FOUND`: The Thumbnail asset id "@ID@" not found

            * `THUMB_ASSET_IS_NOT_READY`: The thumbnail asset is not ready'
      tags:
      - thumbAsset
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
      - storageId
      - thumbParams
  /service/thumbasset/action/list:
    post:
      description: List Thumbnail Assets by filter and pager
      operationId: thumbAsset.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/KalturaAssetFilter'
            pager:
              $ref: '#/definitions/KalturaFilterPager'
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaThumbAssetListResponse'
      tags:
      - thumbAsset
      x-kaltura-format: post
      x-kaltura-parameters:
      - filter
      - pager
  /service/thumbasset/action/regenerate:
    post:
      operationId: thumbAsset.regenerate
      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:
            thumbAssetId:
              type: string
          required:
          - thumbAssetId
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaThumbAsset'
        x-Errors:
          description: '* `THUMB_ASSET_ID_NOT_FOUND`: The Thumbnail asset id "@ID@" not found

            * `ENTRY_TYPE_NOT_SUPPORTED`: Entry type "@ENTRY_TYPE@" not supported

            * `ENTRY_MEDIA_TYPE_NOT_SUPPORTED`: Entry media type "@MEDIA_TYPE@" not supported

            * `THUMB_ASSET_PARAMS_ID_NOT_FOUND`

            * `INVALID_ENTRY_STATUS`: Invalid entry status'
      tags:
      - thumbAsset
      x-kaltura-format: post
      x-kaltura-parameters:
      - thumbAssetId
  /service/thumbasset/action/serve:
    post:
      description: Serves thumbnail by its id
      operationId: thumbAsset.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:
            options:
              $ref: '#/definitions/KalturaThumbnailServeOptions'
            thumbAssetId:
              type: string
            thumbParams:
              $ref: '#/definitions/KalturaThumbParams'
            version:
              type: integer
          required:
          - thumbAssetId
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: string
        x-Errors:
          description: '* `THUMB_ASSET_IS_NOT_READY`: The thumbnail asset is not ready

            * `THUMB_ASSET_ID_NOT_FOUND`: The Thumbnail asset id "@ID@" not found'
      tags:
      - thumbAsset
      x-kaltura-format: post
      x-kaltura-parameters:
      - thumbAssetId
      - version
      - thumbParams
      - options
  /service/thumbasset/action/serveByEntryId:
    post:
      description: Serves thumbnail by entry id and thumbnail params id
      operationId: thumbAsset.serveByEntryId
      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:
            entryId:
              type: string
            thumbParamId:
              type: integer
          required:
          - entryId
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: string
        x-Errors:
          description: '* `THUMB_ASSET_IS_NOT_READY`: The thumbnail asset is not ready

            * `THUMB_ASSET_PARAMS_ID_NOT_FOUND`

            * `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found'
      tags:
      - thumbAsset
      x-kaltura-format: post
      x-kaltura-parameters:
      - entryId
      - thumbParamId
  /service/thumbasset/action/setAsDefault:
    post:
      description: 'Tags the thumbnail as DEFAULT_THUMB and removes that tag from all other thumbnail assets of the entry.


        Create a new file sync link on the entry thumbnail that points to the thumbnail asset file sync.'
      operationId: thumbAsset.setAsDefault
      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:
            thumbAssetId:
              type: string
          required:
          - thumbAssetId
          type: object
      responses:
        '200':
          description: Success
        x-Errors:
          description: '* `THUMB_ASSET_ID_NOT_FOUND`: The Thumbnail asset id "@ID@" not found'
      tags:
      - thumbAsset
      x-kaltura-format: post
      x-kaltura-parameters:
      - thumbAssetId
  /service/thumbasset/action/setContent:
    post:
      description: Update content of thumbnail asset
      operationId: thumbAsset.setContent
      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:
            contentResource:
              $ref: '#/definitions/KalturaContentResource'
            id:
              type: string
          required:
          - id
          - contentResource
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaThumbAsset'
        x-Errors:
          description: '* `THUMB_ASSET_ID_NOT_FOUND`: The Thumbnail asset id "@ID@" not found

            * `UPLOAD_TOKEN_INVALID_STATUS_FOR_ADD_ENTRY`: Upload token is in an invalid status for adding entry, maybe the a file was not uploaded or the token was used

            * `UPLOADED_FILE_NOT_FOUND_BY_TOKEN`: The uploaded file was not found by the given token id, or was already used

            * `RECORDED_WEBCAM_FILE_NOT_FOUND`: The recorded webcam file was not found by the given token id, or was already used

            * `THUMB_ASSET_ID_NOT_FOUND`: The Thumbnail asset id "@ID@" not found

            * `STORAGE_PROFILE_ID_NOT_FOUND`: Storage profile id @ID@ not found

            * `RESOURCE_TYPE_NOT_SUPPORTED`: Resource type "@RES_TYPE@" not supported'
      tags:
      - thumbAsset
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
      - contentResource
  /service/thumbasset/action/update:
    post:
      description: Update thumbnail asset
      operationId: thumbAsset.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:
            id:
              type: string
            thumbAsset:
              $ref: '#/definitions/KalturaThumbAsset'
          required:
          - id
          - thumbAsset
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaThumbAsset'
        x-Errors:
          description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found'
      tags:
      - thumbAsset
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
      - thumbAsset
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:
    

# --- truncated at 32 KB (1467 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kaltura/refs/heads/main/openapi/kaltura-thumbasset-api-openapi.yml