Kaltura batch API

swagger: '2.0'
info:
  description: The Kaltura OTT API
  title: Kaltura OTT accessControl batch 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: "batch service lets you handle different batch process from remote machines.\n As opposed to other objects in the system, locking mechanism is critical in this case.\n For this reason the GetExclusiveXX, UpdateExclusiveXX and FreeExclusiveXX actions are important for the system's integrity.\n In general - updating batch object should be done only using the UpdateExclusiveXX which in turn can be called only after\n acquiring a batch object properly (using  GetExclusiveXX).\n If an object was acquired and should be returned to the pool in it's initial state - use the FreeExclusiveXX action\n Terminology:\n LocationId\n ServerID\n ParternGroups"
  name: batch
paths:
  /service/batch/action/addBulkUploadResult:
    post:
      description: batch addBulkUploadResultAction action adds KalturaBulkUploadResult to the DB
      operationId: batch.addBulkUploadResult
      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:
            bulkUploadResult:
              $ref: '#/definitions/KalturaBulkUploadResult'
            pluginDataArray:
              items:
                $ref: '#/definitions/KalturaBulkUploadPluginData'
              type: array
          required:
          - bulkUploadResult
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaBulkUploadResult'
      tags:
      - batch
      x-kaltura-format: post
      x-kaltura-parameters:
      - bulkUploadResult
      - pluginDataArray
  /service/batch/action/addMediaInfo:
    post:
      description: batch addMediaInfoAction action saves a media info object
      operationId: batch.addMediaInfo
      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:
            mediaInfo:
              $ref: '#/definitions/KalturaMediaInfo'
          required:
          - mediaInfo
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaMediaInfo'
        x-Errors:
          description: '* `FLAVOR_ASSET_ID_NOT_FOUND`: Flavor asset id "@ID@" not found'
      tags:
      - batch
      x-kaltura-format: post
      x-kaltura-parameters:
      - mediaInfo
  /service/batch/action/checkEntryIsDone:
    post:
      description: batch checkEntryIsDone Check weather a specified entry is done converting and changes it to ready.
      operationId: batch.checkEntryIsDone
      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:
            batchJobId:
              type: string
          required:
          - batchJobId
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: boolean
      tags:
      - batch
      x-kaltura-format: post
      x-kaltura-parameters:
      - batchJobId
  /service/batch/action/checkFileExists:
    post:
      description: batch checkFileExists action check if the file exists
      operationId: batch.checkFileExists
      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:
            localPath:
              type: string
            size:
              type: number
          required:
          - localPath
          - size
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaFileExistsResponse'
      tags:
      - batch
      x-kaltura-format: post
      x-kaltura-parameters:
      - localPath
      - size
  /service/batch/action/cleanExclusiveJobs:
    post:
      description: batch cleanExclusiveJobs action mark as fatal error all expired jobs
      operationId: batch.cleanExclusiveJobs
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      responses:
        '200':
          description: Success
          schema:
            type: integer
      tags:
      - batch
      x-kaltura-format: post
      x-kaltura-parameters: []
  /service/batch/action/countBulkUploadEntries:
    post:
      description: Returns total created entries count and total error entries count
      operationId: batch.countBulkUploadEntries
      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:
            bulkUploadJobId:
              type: integer
            bulkUploadObjectType:
              enum:
              - bulkUploadFilter.JOB
              - scheduleBulkUpload.SCHEDULE_EVENT
              - scheduleBulkUpload.SCHEDULE_RESOURCE
              - '1'
              - '2'
              - '3'
              - '4'
              - '5'
              - '6'
              - '7'
              type: string
              x-enumLabels:
              - JOB
              - SCHEDULE_EVENT
              - SCHEDULE_RESOURCE
              - ENTRY
              - CATEGORY
              - USER
              - CATEGORY_USER
              - CATEGORY_ENTRY
              - USER_ENTRY
              - VENDOR_CATALOG_ITEM
              x-enumType: KalturaBulkUploadObjectType
          required:
          - bulkUploadJobId
          type: object
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/KalturaKeyValue'
            type: array
      tags:
      - batch
      x-kaltura-format: post
      x-kaltura-parameters:
      - bulkUploadJobId
      - bulkUploadObjectType
  /service/batch/action/extendLockExpiration:
    post:
      description: batch extendLockExpiration action allows to extend the expiration of a BatchJobLock by job id
      operationId: batch.extendLockExpiration
      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:
            jobId:
              type: integer
            maxExecutionTime:
              type: integer
          required:
          - jobId
          - maxExecutionTime
          type: object
      responses:
        '200':
          description: Success
      tags:
      - batch
      x-kaltura-format: post
      x-kaltura-parameters:
      - jobId
      - maxExecutionTime
  /service/batch/action/freeExclusiveJob:
    post:
      description: batch freeExclusiveJobAction action allows to get a generic BatchJob
      operationId: batch.freeExclusiveJob
      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
            jobType:
              enum:
              - ReachInternal.ReachInternalQueueHandler
              - '0'
              - caption.convertcaptionasset
              - caption.parsemultilanguagecaptionasset
              - captionSearch.parseCaptionAsset
              - contentDistribution.DistributionDelete
              - contentDistribution.DistributionDisable
              - contentDistribution.DistributionEnable
              - contentDistribution.DistributionFetchReport
              - contentDistribution.DistributionSubmit
              - contentDistribution.DistributionSync
              - contentDistribution.DistributionUpdate
              - dropFolder.DropFolderContentProcessor
              - dropFolder.DropFolderWatcher
              - eventNotification.EventNotificationHandler
              - integration.Integration
              - reach.EntryVendorTasksCsv
              - reach.SyncReachCreditTask
              - scheduledTask.ScheduledTask
              - tagSearch.IndexTagsByPrivacyContext
              - tagSearch.TagResolve
              - virusScan.VirusScan
              - widevine.WidevineRepositorySync
              - '1'
              - '2'
              - '3'
              - '4'
              - '5'
              - '6'
              - '7'
              - '10'
              - '11'
              - '14'
              - '15'
              - '16'
              - '17'
              - '18'
              - '19'
              - '20'
              - '21'
              - '22'
              - '23'
              - '24'
              - '25'
              - '26'
              - '27'
              - '28'
              - '29'
              - '30'
              - '31'
              - '32'
              - '33'
              - '34'
              - '35'
              - '36'
              - '37'
              - '38'
              - '39'
              - '40'
              - '41'
              - '42'
              - '43'
              - '44'
              - '45'
              - '46'
              - '47'
              - '48'
              - '49'
              - '50'
              - '51'
              - '52'
              - '53'
              - '54'
              - '55'
              - '56'
              type: string
              x-enumLabels:
              - REACH_INTERNAL_QUEUE_HANDLER
              - CONVERT
              - CONVERT_CAPTION_ASSET
              - PARSE_MULTI_LANGUAGE_CAPTION_ASSET
              - PARSE_CAPTION_ASSET
              - DISTRIBUTION_DELETE
              - DISTRIBUTION_DISABLE
              - DISTRIBUTION_ENABLE
              - DISTRIBUTION_FETCH_REPORT
              - DISTRIBUTION_SUBMIT
              - DISTRIBUTION_SYNC
              - DISTRIBUTION_UPDATE
              - DROP_FOLDER_CONTENT_PROCESSOR
              - DROP_FOLDER_WATCHER
              - EVENT_NOTIFICATION_HANDLER
              - INTEGRATION
              - ENTRY_VENDOR_TASK_CSV
              - SYNC_REACH_CREDIT_TASK
              - SCHEDULED_TASK
              - INDEX_TAGS
              - TAG_RESOLVE
              - VIRUS_SCAN
              - WIDEVINE_REPOSITORY_SYNC
              - IMPORT
              - DELETE
              - FLATTEN
              - BULKUPLOAD
              - DVDCREATOR
              - DOWNLOAD
              - OOCONVERT
              - CONVERT_PROFILE
              - POSTCONVERT
              - EXTRACT_MEDIA
              - MAIL
              - NOTIFICATION
              - CLEANUP
              - SCHEDULER_HELPER
              - BULKDOWNLOAD
              - DB_CLEANUP
              - PROVISION_PROVIDE
              - CONVERT_COLLECTION
              - STORAGE_EXPORT
              - PROVISION_DELETE
              - STORAGE_DELETE
              - EMAIL_INGESTION
              - METADATA_IMPORT
              - METADATA_TRANSFORM
              - FILESYNC_IMPORT
              - CAPTURE_THUMB
              - DELETE_FILE
              - INDEX
              - MOVE_CATEGORY_ENTRIES
              - COPY
              - CONCAT
              - CONVERT_LIVE_SEGMENT
              - COPY_PARTNER
              - VALIDATE_LIVE_MEDIA_SERVERS
              - SYNC_CATEGORY_PRIVACY_CONTEXT
              - LIVE_REPORT_EXPORT
              - RECALCULATE_CACHE
              - LIVE_TO_VOD
              - COPY_CAPTIONS
              - CHUNKED_ENCODE_JOB_SCHEDULER
              - SERVER_NODE_MONITOR
              - USERS_CSV
              - CLIP_CONCAT
              - COPY_CUE_POINTS
              - EXPORT_CSV
              - REPORT_EXPORT
              - LIVE_ENTRY_ARCHIVE
              - STORAGE_UPDATE
              - STORAGE_PERIODIC_EXPORT
              - STORAGE_PERIODIC_PURGE
              - STORAGE_PERIODIC_DELETE_LOCAL
              - REACH_JOB_CLEANER
              x-enumType: KalturaBatchJobType
            lockKey:
              $ref: '#/definitions/KalturaExclusiveLockKey'
            resetExecutionAttempts:
              default: false
              type: boolean
          required:
          - id
          - lockKey
          - jobType
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaFreeJobResponse'
      tags:
      - batch
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
      - lockKey
      - jobType
      - resetExecutionAttempts
  /service/batch/action/getBulkUploadLastResult:
    post:
      description: batch getBulkUploadLastResultAction action returns the last result of the bulk upload
      operationId: batch.getBulkUploadLastResult
      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:
            bulkUploadJobId:
              type: integer
          required:
          - bulkUploadJobId
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaBulkUploadResult'
      tags:
      - batch
      x-kaltura-format: post
      x-kaltura-parameters:
      - bulkUploadJobId
  /service/batch/action/getExclusiveAlmostDone:
    post:
      description: batch getExclusiveAlmostDone action allows to get a BatchJob that wait for remote closure
      operationId: batch.getExclusiveAlmostDone
      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/KalturaBatchJobFilter'
            jobType:
              enum:
              - ReachInternal.ReachInternalQueueHandler
              - '0'
              - caption.convertcaptionasset
              - caption.parsemultilanguagecaptionasset
              - captionSearch.parseCaptionAsset
              - contentDistribution.DistributionDelete
              - contentDistribution.DistributionDisable
              - contentDistribution.DistributionEnable
              - contentDistribution.DistributionFetchReport
              - contentDistribution.DistributionSubmit
              - contentDistribution.DistributionSync
              - contentDistribution.DistributionUpdate
              - dropFolder.DropFolderContentProcessor
              - dropFolder.DropFolderWatcher
              - eventNotification.EventNotificationHandler
              - integration.Integration
              - reach.EntryVendorTasksCsv
              - reach.SyncReachCreditTask
              - scheduledTask.ScheduledTask
              - tagSearch.IndexTagsByPrivacyContext
              - tagSearch.TagResolve
              - virusScan.VirusScan
              - widevine.WidevineRepositorySync
              - '1'
              - '2'
              - '3'
              - '4'
              - '5'
              - '6'
              - '7'
              - '10'
              - '11'
              - '14'
              - '15'
              - '16'
              - '17'
              - '18'
              - '19'
              - '20'
              - '21'
              - '22'
              - '23'
              - '24'
              - '25'
              - '26'
              - '27'
              - '28'
              - '29'
              - '30'
              - '31'
              - '32'
              - '33'
              - '34'
              - '35'
              - '36'
              - '37'
              - '38'
              - '39'
              - '40'
              - '41'
              - '42'
              - '43'
              - '44'
              - '45'
              - '46'
              - '47'
              - '48'
              - '49'
              - '50'
              - '51'
              - '52'
              - '53'
              - '54'
              - '55'
              - '56'
              type: string
              x-enumLabels:
              - REACH_INTERNAL_QUEUE_HANDLER
              - CONVERT
              - CONVERT_CAPTION_ASSET
              - PARSE_MULTI_LANGUAGE_CAPTION_ASSET
              - PARSE_CAPTION_ASSET
              - DISTRIBUTION_DELETE
              - DISTRIBUTION_DISABLE
              - DISTRIBUTION_ENABLE
              - DISTRIBUTION_FETCH_REPORT
              - DISTRIBUTION_SUBMIT
              - DISTRIBUTION_SYNC
              - DISTRIBUTION_UPDATE
              - DROP_FOLDER_CONTENT_PROCESSOR
              - DROP_FOLDER_WATCHER
              - EVENT_NOTIFICATION_HANDLER
              - INTEGRATION
              - ENTRY_VENDOR_TASK_CSV
              - SYNC_REACH_CREDIT_TASK
              - SCHEDULED_TASK
              - INDEX_TAGS
              - TAG_RESOLVE
              - VIRUS_SCAN
              - WIDEVINE_REPOSITORY_SYNC
              - IMPORT
              - DELETE
              - FLATTEN
              - BULKUPLOAD
              - DVDCREATOR
              - DOWNLOAD
              - OOCONVERT
              - CONVERT_PROFILE
              - POSTCONVERT
              - EXTRACT_MEDIA
              - MAIL
              - NOTIFICATION
              - CLEANUP
              - SCHEDULER_HELPER
              - BULKDOWNLOAD
              - DB_CLEANUP
              - PROVISION_PROVIDE
              - CONVERT_COLLECTION
              - STORAGE_EXPORT
              - PROVISION_DELETE
              - STORAGE_DELETE
              - EMAIL_INGESTION
              - METADATA_IMPORT
              - METADATA_TRANSFORM
              - FILESYNC_IMPORT
              - CAPTURE_THUMB
              - DELETE_FILE
              - INDEX
              - MOVE_CATEGORY_ENTRIES
              - COPY
              - CONCAT
              - CONVERT_LIVE_SEGMENT
              - COPY_PARTNER
              - VALIDATE_LIVE_MEDIA_SERVERS
              - SYNC_CATEGORY_PRIVACY_CONTEXT
              - LIVE_REPORT_EXPORT
              - RECALCULATE_CACHE
              - LIVE_TO_VOD
              - COPY_CAPTIONS
              - CHUNKED_ENCODE_JOB_SCHEDULER
              - SERVER_NODE_MONITOR
              - USERS_CSV
              - CLIP_CONCAT
              - COPY_CUE_POINTS
              - EXPORT_CSV
              - REPORT_EXPORT
              - LIVE_ENTRY_ARCHIVE
              - STORAGE_UPDATE
              - STORAGE_PERIODIC_EXPORT
              - STORAGE_PERIODIC_PURGE
              - STORAGE_PERIODIC_DELETE_LOCAL
              - REACH_JOB_CLEANER
              x-enumType: KalturaBatchJobType
            lockKey:
              $ref: '#/definitions/KalturaExclusiveLockKey'
            maxExecutionTime:
              type: integer
            numberOfJobs:
              type: integer
          required:
          - lockKey
          - maxExecutionTime
          - numberOfJobs
          type: object
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/KalturaBatchJob'
            type: array
      tags:
      - batch
      x-kaltura-format: post
      x-kaltura-parameters:
      - lockKey
      - maxExecutionTime
      - numberOfJobs
      - filter
      - jobType
  /service/batch/action/getExclusiveJobs:
    post:
      description: batch getExclusiveJobsAction action allows to get a BatchJob
      operationId: batch.getExclusiveJobs
      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/KalturaBatchJobFilter'
            jobType:
              enum:
              - ReachInternal.ReachInternalQueueHandler
              - '0'
              - caption.convertcaptionasset
              - caption.parsemultilanguagecaptionasset
              - captionSearch.parseCaptionAsset
              - contentDistribution.DistributionDelete
              - contentDistribution.DistributionDisable
              - contentDistribution.DistributionEnable
              - contentDistribution.DistributionFetchReport
              - contentDistribution.DistributionSubmit
              - contentDistribution.DistributionSync
              - contentDistribution.DistributionUpdate
              - dropFolder.DropFolderContentProcessor
              - dropFolder.DropFolderWatcher
              - eventNotification.EventNotificationHandler
              - integration.Integration
              - reach.EntryVendorTasksCsv
              - reach.SyncReachCreditTask
              - scheduledTask.ScheduledTask
              - tagSearch.IndexTagsByPrivacyContext
              - tagSearch.TagResolve
              - virusScan.VirusScan
              - widevine.WidevineRepositorySync
              - '1'
              - '2'
              - '3'
              - '4'
              - '5'
              - '6'
              - '7'
              - '10'
              - '11'
              - '14'
              - '15'
              - '16'
              - '17'
              - '18'
              - '19'
              - '20'
              - '21'
              - '22'
              - '23'
              - '24'
              - '25'
              - '26'
              - '27'
              - '28'
              - '29'
              - '30'
              - '31'
              - '32'
              - '33'
              - '34'
              - '35'
              - '36'
              - '37'
              - '38'
              - '39'
              - '40'
              - '41'
              - '42'
              - '43'
              - '44'
              - '45'
              - '46'
              - '47'
              - '48'
              - '49'
              - '50'
              - '51'
              - '52'
              - '53'
              - '54'
              - '55'
              - '56'
              type: string
              x-enumLabels:
              - REACH_INTERNAL_QUEUE_HANDLER
              - CONVERT
              - CONVERT_CAPTION_ASSET
              - PARSE_MULTI_LANGUAGE_CAPTION_ASSET
              - PARSE_CAPTION_ASSET
              - DISTRIBUTION_DELETE
              - DISTRIBUTION_DISABLE
              - DISTRIBUTION_ENABLE
              - DISTRIBUTION_FETCH_REPORT
              - DISTRIBUTION_SUBMIT
              - DISTRIBUTION_SYNC
              - DISTRIBUTION_UPDATE
              - DROP_FOLDER_CONTENT_PROCESSOR
              - DROP_FOLDER_WATCHER
              - EVENT_NOTIFICATION_HANDLER
              - INTEGRATION
              - ENTRY_VENDOR_TASK_CSV
              - SYNC_REACH_CREDIT_TASK
              - SCHEDULED_TASK
              - INDEX_TAGS
              - TAG_RESOLVE
              - VIRUS_SCAN
              - WIDEVINE_REPOSITORY_SYNC
              - IMPORT
              - DELETE
              - FLATTEN
              - BULKUPLOAD
              - DVDCREATOR
              - DOWNLOAD
              - OOCONVERT
              - CONVERT_PROFILE
              - POSTCONVERT
              - EXTRACT_MEDIA
              - MAIL
              - NOTIFICATION
              - CLEANUP
              - SCHEDULER_HELPER
              - BULKDOWNLOAD
              - DB_CLEANUP
              - PROVISION_PROVIDE
              - CONVERT_COLLECTION
              - STORAGE_EXPORT
              - PROVISION_DELETE
              - STORAGE_DELETE
              - EMAIL_INGESTION
              - METADATA_IMPORT
              - METADATA_TRANSFORM
              - FILESYNC_IMPORT
              - CAPTURE_THUMB
              - DELETE_FILE
              - INDEX
              - MOVE_CATEGORY_ENTRIES
              - COPY
              - CONCAT
              - CONVERT_LIVE_SEGMENT
              - COPY_PARTNER
              - VALIDATE_LIVE_MEDIA_SERVERS
              - SYNC_CATEGORY_PRIVACY_CONTEXT
              - LIVE_REPORT_EXPORT
              - RECALCULATE_CACHE
              - LIVE_TO_VOD
              - COPY_CAPTIONS
              - CHUNKED_ENCODE_JOB_SCHEDULER
              - SERVER_NODE_MONITOR
              - USERS_CSV
              - CLIP_CONCAT
              - COPY_CUE_POINTS
              - EXPORT_CSV
              - REPORT_EXPORT
              - LIVE_ENTRY_ARCHIVE
              - STORAGE_UPDATE
              - STORAGE_PERIODIC_EXPORT
              - STORAGE_PERIODIC_PURGE
              - STORAGE_PERIODIC_DELETE_LOCAL
              - REACH_JOB_CLEANER
              x-enumType: KalturaBatchJobType
            lockKey:
              $ref: '#/definitions/KalturaExclusiveLockKey'
            maxExecutionTime:
              type: integer
            maxJobToPullForCache:
              default: 0
              type: integer
            numberOfJobs:
              type: integer
          required:
          - lockKey
          - maxExecutionTime
          - numberOfJobs
          type: object
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/KalturaBatchJob'
            type: array
      tags:
      - batch
      x-kaltura-format: post
      x-kaltura-parameters:
      - lockKey
      - maxExecutionTime
      - numberOfJobs
      - filter
      - jobType
      - maxJobToPullForCache
  /service/batch/action/getExclusiveNotificationJobs:
    post:
      description: batch getExclusiveNotificationJob action allows to get a BatchJob of type NOTIFICATION
      operationId: batch.getExclusiveNotificationJobs
      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/KalturaBatchJobFilter'
            lockKey:
              $ref: '#/definitions/KalturaExclusiveLockKey'
            maxExecutionTime:
              type: integer
            numberOfJobs:
              type: integer
          required:
          - lockKey
          - maxExecutionTime
          - numberOfJobs
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaBatchGetExclusiveNotificationJobsResponse'
      tags:
      - batch
      x-kaltura-format: post
      x-kaltura-parameters:
      - lockKey
      - maxExecutionTime
      - numberOfJobs
      - filter
  /service/batch/action/getQueueSize:
    post:
      description: batch getQueueSize action get the queue size for job type
      operationId: batch.getQueueSize
      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:
            workerQueueFilter:
              $ref: '#/definitions/KalturaWorkerQueueFilter'
          required:
          - workerQueueFilter
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: integer
      tags:
      - batch
      x-kaltura-format: post
      x-kaltura-parameters:
      - workerQueueFilter
  /service/batch/action/logConversion:
    post:
      description: Add the data to the flavor asset conversion log, creates it if doesn't exists
      operationId: batch.logConversion
      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:
            data:
              type: string
            flavorAssetId:
              type: string
          required:
          - flavorAssetId
          - data
          type: object
      responses:
        '200':
          description: Success
        x-Errors:
          description: '* `INVALID_FLAVOR_ASSET_ID`:  Invalid flavor asset id @FLAV_ASSET_ID@'
      tags:
      - batch
      x-kaltura-format: post
      x-kaltura-parameters:
      - flavorAssetId
      - data
  /service/batch/action/putFile:
    post:
      description: batch putFileAction action allows put file on server via http
      operationId: batch.putFile
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - in: query
        name: destPath
        required: true
        type: string
      - in: formData
        name: data
        required: true
        type: file
      responses:
        '200':
          description: Success
          schema:
            type: integer
      tags:
      - batch
      x-kaltura-format: file
      x-kaltura-parameters:
      - destPath
      - data
  /service/batch/action/resetJobExecutionAttempts:
    post:
      description: batch resetJobExecutionAttempts action resets the execution attempts of the job
      operationId: batch.resetJobExecutionAttempts
      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
            jobType:
              enum:
              - ReachInternal.ReachInternalQueueHandler
              - '0'
              - caption.convertcaptionasset
              - caption.parsemultilanguagecaptionasset
              - captionSearch.parseCaptionAsset
              - contentDistribution.DistributionDelete
              - contentDistribution.DistributionDisable
              - contentDistribution.DistributionEnable
              - contentDistribution.DistributionFetchReport
              - contentDistribution.DistributionSubmit
              - contentDistribution.DistributionSync
              - contentDistribution.DistributionUpdate
              - dropFolder.DropFolderContentProcessor
              - dropFolder.DropFolderWatcher
              - eventNotification.EventNotificationHandler
              - integration.Integration
              - reach.EntryVendorTasksCsv
              - reach.SyncReachCreditTask
              - scheduledTask.ScheduledTask
              - tagSearch.IndexTagsByPrivacyContext
              - tagSearch.TagResolve
              - virusScan.VirusScan
              - widevine.WidevineRepositorySync
              - '1'
              - '2'
              - '3'
              - '4'
              - '5'
              - '6'
              - '7'
              - '10'
              - '11'
              - '14'
              - '15'
              - '16'
              - '17'
         

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