Kaltura documents API

swagger: '2.0'
info:
  description: The Kaltura OTT API
  title: Kaltura OTT accessControl documents 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: Document service lets you upload and manage document files
  name: documents
  x-plugin: document
paths:
  /service/document_documents/action/addFromEntry:
    post:
      description: Copy entry into new entry
      operationId: documents.addFromEntry
      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:
            documentEntry:
              $ref: '#/definitions/KalturaDocumentEntry'
            sourceEntryId:
              type: string
            sourceFlavorParamsId:
              type: integer
          required:
          - sourceEntryId
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaDocumentEntry'
        x-Errors:
          description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found

            * `ORIGINAL_FLAVOR_ASSET_IS_MISSING`: The original flavor asset is missing

            * `FLAVOR_PARAMS_NOT_FOUND`: Flavor params not found

            * `ORIGINAL_FLAVOR_ASSET_NOT_CREATED`: The original flavor asset could not be created [@DATA@]'
      tags:
      - documents
      x-kaltura-format: post
      x-kaltura-parameters:
      - sourceEntryId
      - documentEntry
      - sourceFlavorParamsId
  /service/document_documents/action/addFromFlavorAsset:
    post:
      description: Copy flavor asset into new entry
      operationId: documents.addFromFlavorAsset
      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:
            documentEntry:
              $ref: '#/definitions/KalturaDocumentEntry'
            sourceFlavorAssetId:
              type: string
          required:
          - sourceFlavorAssetId
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaDocumentEntry'
        x-Errors:
          description: '* `FLAVOR_ASSET_ID_NOT_FOUND`: Flavor asset id "@ID@" not found

            * `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found

            * `ORIGINAL_FLAVOR_ASSET_NOT_CREATED`: The original flavor asset could not be created [@DATA@]'
      tags:
      - documents
      x-kaltura-format: post
      x-kaltura-parameters:
      - sourceFlavorAssetId
      - documentEntry
  /service/document_documents/action/addFromUploadedFile:
    post:
      description: Add new document entry after the specific document file was uploaded and the upload token id exists
      operationId: documents.addFromUploadedFile
      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:
            documentEntry:
              $ref: '#/definitions/KalturaDocumentEntry'
            uploadTokenId:
              type: string
          required:
          - documentEntry
          - uploadTokenId
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaDocumentEntry'
        x-Errors:
          description: '* `PROPERTY_VALIDATION_MIN_LENGTH`: The property "@PROP_NAME@" must have a min length of @MIN_LEN@ characters

            * `PROPERTY_VALIDATION_CANNOT_BE_NULL`: The property "@PROP_NAME@" cannot be null

            * `UPLOADED_FILE_NOT_FOUND_BY_TOKEN`: The uploaded file was not found by the given token id, or was already used'
      tags:
      - documents
      x-kaltura-format: post
      x-kaltura-parameters:
      - documentEntry
      - uploadTokenId
  /service/document_documents/action/approveReplace:
    post:
      description: Approves document replacement
      operationId: documents.approveReplace
      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:
            $ref: '#/definitions/KalturaDocumentEntry'
        x-Errors:
          description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found'
      tags:
      - documents
      x-kaltura-format: post
      x-kaltura-parameters:
      - entryId
  /service/document_documents/action/cancelReplace:
    post:
      description: Cancels document replacement
      operationId: documents.cancelReplace
      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:
            $ref: '#/definitions/KalturaDocumentEntry'
        x-Errors:
          description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found'
      tags:
      - documents
      x-kaltura-format: post
      x-kaltura-parameters:
      - entryId
  /service/document_documents/action/convert:
    post:
      description: Convert entry
      operationId: documents.convert
      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:
            conversionProfileId:
              type: integer
            dynamicConversionAttributes:
              items:
                $ref: '#/definitions/KalturaConversionAttribute'
              type: array
            entryId:
              type: string
          required:
          - entryId
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: integer
        x-Errors:
          description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found

            * `CONVERSION_PROFILE_ID_NOT_FOUND`: Conversion profile id "@ID@" not found

            * `FLAVOR_PARAMS_NOT_FOUND`: Flavor params not found'
      tags:
      - documents
      x-kaltura-format: post
      x-kaltura-parameters:
      - entryId
      - conversionProfileId
      - dynamicConversionAttributes
  /service/document_documents/action/convertPptToSwf:
    post:
      description: 'This will queue a batch job for converting the document file to swf


        Returns the URL where the new swf will be available'
      operationId: documents.convertPptToSwf
      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:
            type: string
      tags:
      - documents
      x-kaltura-format: post
      x-kaltura-parameters:
      - entryId
  /service/document_documents/action/delete:
    post:
      description: Delete a document entry.
      operationId: documents.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:
            entryId:
              type: string
          required:
          - entryId
          type: object
      responses:
        '200':
          description: Success
        x-Errors:
          description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found'
      tags:
      - documents
      x-kaltura-format: post
      x-kaltura-parameters:
      - entryId
  /service/document_documents/action/get:
    post:
      description: Get document entry by ID.
      operationId: documents.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:
            entryId:
              type: string
            version:
              default: -1
              type: integer
          required:
          - entryId
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaDocumentEntry'
        x-Errors:
          description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found'
      tags:
      - documents
      x-kaltura-format: post
      x-kaltura-parameters:
      - entryId
      - version
  /service/document_documents/action/list:
    post:
      description: List document entries by filter with paging support.
      operationId: documents.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/KalturaDocumentEntryFilter'
            pager:
              $ref: '#/definitions/KalturaFilterPager'
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaDocumentListResponse'
      tags:
      - documents
      x-kaltura-format: post
      x-kaltura-parameters:
      - filter
      - pager
  /service/document_documents/action/serve:
    post:
      description: Serves the file content
      operationId: documents.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:
            entryId:
              type: string
            flavorAssetId:
              type: string
            forceProxy:
              default: false
              type: boolean
          required:
          - entryId
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: string
        x-Errors:
          description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found

            * `FLAVOR_ASSET_IS_NOT_READY`: The flavor asset is not ready

            * `FLAVOR_ASSET_ID_NOT_FOUND`: Flavor asset id "@ID@" not found'
      tags:
      - documents
      x-kaltura-format: post
      x-kaltura-parameters:
      - entryId
      - flavorAssetId
      - forceProxy
  /service/document_documents/action/serveByFlavorParamsId:
    post:
      description: Serves the file content
      operationId: documents.serveByFlavorParamsId
      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
            flavorParamsId:
              type: string
            forceProxy:
              default: false
              type: boolean
          required:
          - entryId
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: string
        x-Errors:
          description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found

            * `FLAVOR_ASSET_IS_NOT_READY`: The flavor asset is not ready

            * `FLAVOR_ASSET_ID_NOT_FOUND`: Flavor asset id "@ID@" not found'
      tags:
      - documents
      x-kaltura-format: post
      x-kaltura-parameters:
      - entryId
      - flavorParamsId
      - forceProxy
  /service/document_documents/action/update:
    post:
      description: Update document entry. Only the properties that were set will be updated.
      operationId: documents.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:
            documentEntry:
              $ref: '#/definitions/KalturaDocumentEntry'
            entryId:
              type: string
          required:
          - entryId
          - documentEntry
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaDocumentEntry'
        x-Errors:
          description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found'
      tags:
      - documents
      x-kaltura-format: post
      x-kaltura-parameters:
      - entryId
      - documentEntry
  /service/document_documents/action/updateContent:
    post:
      description: Replace content associated with the given document entry.
      operationId: documents.updateContent
      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:
            conversionProfileId:
              type: integer
            entryId:
              type: string
            resource:
              $ref: '#/definitions/KalturaResource'
          required:
          - entryId
          - resource
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaDocumentEntry'
        x-Errors:
          description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found

            * `ENTRY_REPLACEMENT_ALREADY_EXISTS`: Entry already in replacement

            * `INVALID_OBJECT_ID`: Invalid object id [@ID@]'
      tags:
      - documents
      x-kaltura-format: post
      x-kaltura-parameters:
      - entryId
      - resource
      - conversionProfileId
  /service/document_documents/action/upload:
    post:
      deprecated: true
      description: Upload a document file to Kaltura, then the file can be used to create a document entry.
      operationId: documents.upload
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - description: The file data
        in: formData
        name: fileData
        required: true
        type: file
      responses:
        '200':
          description: Success
          schema:
            type: string
      tags:
      - documents
      x-kaltura-format: file
      x-kaltura-parameters:
      - fileData
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:
    - 

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