Last active
May 14, 2023 11:52
-
-
Save zoharbabin/f55bd528f5c6c3c9c3e542eb8cd96f85 to your computer and use it in GitHub Desktop.
This file has been truncated, but you can view the full file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"openapi": "3.0.1", | |
"info": { | |
"title": "Kaltura Video Experience Cloud API", | |
"description": "Kaltura Media Services offers a feature-rich API for seamless integration of high-quality video streaming and management. It provides scalability, flexibility, and extensive customization options, empowering developers to build robust media-centric applications.", | |
"version": "19.4.0" | |
}, | |
"servers": [ | |
{ | |
"url": "https://cdnapi-ev.kaltura.com/api_v3" | |
} | |
], | |
"security": [ | |
{ | |
"ks": [] | |
} | |
], | |
"tags": [ | |
{ | |
"name": "accessControl", | |
"description": "Add & Manage Access Controls" | |
}, | |
{ | |
"name": "accessControlProfile", | |
"description": "Manage access control profiles" | |
}, | |
{ | |
"name": "adminUser", | |
"description": "Manage details for the administrative user" | |
}, | |
{ | |
"name": "analytics", | |
"description": "api for getting analytics data" | |
}, | |
{ | |
"name": "annotation", | |
"description": "Annotation service - Video Annotation", | |
"x-plugin": "annotation" | |
}, | |
{ | |
"name": "appToken", | |
"description": "Manage application authentication tokens" | |
}, | |
{ | |
"name": "aspera", | |
"description": "Aspera service", | |
"x-plugin": "aspera" | |
}, | |
{ | |
"name": "attachmentAsset", | |
"description": "Retrieve information and invoke actions on attachment Asset", | |
"x-plugin": "attachment" | |
}, | |
{ | |
"name": "attUverse", | |
"description": "Att Uverse Service", | |
"x-plugin": "attUverseDistribution" | |
}, | |
{ | |
"name": "auditTrail", | |
"description": "The Audit Trail service allows you to keep track of changes made to various Kaltura objects. \n This service is disabled by default.", | |
"x-plugin": "audit" | |
}, | |
{ | |
"name": "avn", | |
"description": "AVN service", | |
"x-plugin": "avnDistribution" | |
}, | |
{ | |
"name": "baseEntry", | |
"description": "Base Entry Service" | |
}, | |
{ | |
"name": "batch", | |
"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": "batchcontrol", | |
"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": "beacon", | |
"description": "Sending beacons on objects", | |
"x-plugin": "beacon" | |
}, | |
{ | |
"name": "bulk", | |
"description": "Bulk upload service is used to upload & manage bulk uploads", | |
"x-plugin": "bulkUpload" | |
}, | |
{ | |
"name": "bulkUpload", | |
"description": "Bulk upload service is used to upload & manage bulk uploads using CSV files.\n This service manages only entry bulk uploads." | |
}, | |
{ | |
"name": "bumper", | |
"x-plugin": "bumper" | |
}, | |
{ | |
"name": "businessProcessCase", | |
"description": "Business-process case service lets you get information about processes", | |
"x-plugin": "businessProcessNotification" | |
}, | |
{ | |
"name": "businessProcessServer", | |
"description": "Business-Process server service lets you create and manage servers", | |
"x-plugin": "businessProcessNotification" | |
}, | |
{ | |
"name": "captionAsset", | |
"description": "Retrieve information and invoke actions on caption Asset", | |
"x-plugin": "caption" | |
}, | |
{ | |
"name": "captionAssetItem", | |
"description": "Search caption asset items", | |
"x-plugin": "captionSearch" | |
}, | |
{ | |
"name": "captionParams", | |
"description": "Add & Manage Caption Params", | |
"x-plugin": "caption" | |
}, | |
{ | |
"name": "captureSpace", | |
"x-plugin": "captureSpace" | |
}, | |
{ | |
"name": "category", | |
"description": "Add & Manage Categories" | |
}, | |
{ | |
"name": "categoryEntry", | |
"description": "Add & Manage CategoryEntry - assign entry to category" | |
}, | |
{ | |
"name": "categoryUser", | |
"description": "Add & Manage CategoryUser - membership of a user in a category" | |
}, | |
{ | |
"name": "comcastMrss", | |
"description": "Comcast Mrss Service", | |
"x-plugin": "comcastMrssDistribution" | |
}, | |
{ | |
"name": "confMaps", | |
"x-plugin": "confMaps" | |
}, | |
{ | |
"name": "contentDistributionBatch", | |
"x-plugin": "contentDistribution" | |
}, | |
{ | |
"name": "conversionProfile", | |
"description": "Add & Manage Conversion Profiles" | |
}, | |
{ | |
"name": "conversionProfileAssetParams", | |
"description": "Manage the connection between Conversion Profiles and Asset Params" | |
}, | |
{ | |
"name": "cuePoint", | |
"description": "Cue Point service", | |
"x-plugin": "cuePoint" | |
}, | |
{ | |
"name": "data", | |
"description": "Data service lets you manage data content (textual content)" | |
}, | |
{ | |
"name": "deliveryProfile", | |
"description": "delivery service is used to control delivery objects" | |
}, | |
{ | |
"name": "distributionProfile", | |
"description": "Distribution Profile service", | |
"x-plugin": "contentDistribution" | |
}, | |
{ | |
"name": "distributionProvider", | |
"description": "Distribution Provider service", | |
"x-plugin": "contentDistribution" | |
}, | |
{ | |
"name": "document", | |
"description": "Document service" | |
}, | |
{ | |
"name": "documents", | |
"description": "Document service lets you upload and manage document files", | |
"x-plugin": "document" | |
}, | |
{ | |
"name": "doubleClick", | |
"description": "DoubleClick Service", | |
"x-plugin": "doubleClickDistribution" | |
}, | |
{ | |
"name": "drmLicenseAccess", | |
"description": "Retrieve information and invoke actions on Flavor Asset", | |
"x-plugin": "drm" | |
}, | |
{ | |
"name": "drmPolicy", | |
"x-plugin": "drm" | |
}, | |
{ | |
"name": "drmProfile", | |
"x-plugin": "drm" | |
}, | |
{ | |
"name": "dropFolder", | |
"description": "DropFolder service lets you create and manage drop folders", | |
"x-plugin": "dropFolder" | |
}, | |
{ | |
"name": "dropFolderFile", | |
"description": "DropFolderFile service lets you create and manage drop folder files", | |
"x-plugin": "dropFolder" | |
}, | |
{ | |
"name": "EmailIngestionProfile", | |
"description": "EmailIngestionProfile service lets you manage email ingestion profile records" | |
}, | |
{ | |
"name": "entryDistribution", | |
"description": "Entry Distribution service", | |
"x-plugin": "contentDistribution" | |
}, | |
{ | |
"name": "entryServerNode", | |
"description": "Base class for entry server node" | |
}, | |
{ | |
"name": "entryVendorTask", | |
"description": "Entry Vendor Task Service", | |
"x-plugin": "reach" | |
}, | |
{ | |
"name": "eSearch", | |
"x-plugin": "elasticSearch" | |
}, | |
{ | |
"name": "eventNotificationTemplate", | |
"description": "Event notification template service lets you create and manage event notification templates", | |
"x-plugin": "eventNotification" | |
}, | |
{ | |
"name": "exportcsv", | |
"description": "Export CSV service is used to manage CSV exports of objects" | |
}, | |
{ | |
"name": "externalMedia", | |
"description": "External media service lets you upload and manage embed codes and external playable content", | |
"x-plugin": "externalMedia" | |
}, | |
{ | |
"name": "fileAsset", | |
"description": "Manage file assets" | |
}, | |
{ | |
"name": "fileSync", | |
"description": "System user service", | |
"x-plugin": "fileSync" | |
}, | |
{ | |
"name": "filesyncImportBatch", | |
"x-plugin": "multiCenters" | |
}, | |
{ | |
"name": "flavorAsset", | |
"description": "Retrieve information and invoke actions on Flavor Asset" | |
}, | |
{ | |
"name": "flavorParams", | |
"description": "Add & Manage Flavor Params" | |
}, | |
{ | |
"name": "flavorParamsOutput", | |
"description": "Flavor Params Output service" | |
}, | |
{ | |
"name": "genericDistributionProvider", | |
"description": "Generic Distribution Provider service", | |
"x-plugin": "contentDistribution" | |
}, | |
{ | |
"name": "genericDistributionProviderAction", | |
"description": "Generic Distribution Provider Actions service", | |
"x-plugin": "contentDistribution" | |
}, | |
{ | |
"name": "group", | |
"x-plugin": "group" | |
}, | |
{ | |
"name": "groupUser", | |
"description": "Add & Manage GroupUser" | |
}, | |
{ | |
"name": "integration", | |
"description": "Integration service lets you dispatch integration tasks", | |
"x-plugin": "integration" | |
}, | |
{ | |
"name": "interactivity", | |
"x-plugin": "interactivity" | |
}, | |
{ | |
"name": "jobs", | |
"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 acuiring a batch objet properly (using GetExclusiveXX).\n If an object was aquired 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": "like", | |
"description": "Allows user to 'like' or 'unlike' and entry", | |
"x-plugin": "like" | |
}, | |
{ | |
"name": "liveChannel", | |
"description": "Live Channel service lets you manage live channels" | |
}, | |
{ | |
"name": "liveChannelSegment", | |
"description": "Manage live channel segments" | |
}, | |
{ | |
"name": "liveConversionProfile", | |
"description": "Enable serving live conversion profile to the Wowza servers as XML", | |
"x-plugin": "wowza" | |
}, | |
{ | |
"name": "liveReports" | |
}, | |
{ | |
"name": "liveStats", | |
"description": "Stats Service" | |
}, | |
{ | |
"name": "liveStream", | |
"description": "Live Stream service lets you manage live stream entries" | |
}, | |
{ | |
"name": "media", | |
"description": "Media service lets you upload and manage media files (images / videos & audio)" | |
}, | |
{ | |
"name": "mediaInfo", | |
"description": "Media Info service" | |
}, | |
{ | |
"name": "metadata", | |
"description": "Metadata service", | |
"x-plugin": "metadata" | |
}, | |
{ | |
"name": "metadataBatch", | |
"x-plugin": "metadata" | |
}, | |
{ | |
"name": "metadataProfile", | |
"description": "Metadata Profile service", | |
"x-plugin": "metadata" | |
}, | |
{ | |
"name": "mixing", | |
"description": "A Mix is an XML unique format invented by Kaltura, it allows the user to create a mix of videos and images, in and out points, transitions, text overlays, soundtrack, effects and much more...\n Mixing service lets you create a new mix, manage its metadata and make basic manipulations." | |
}, | |
{ | |
"name": "ndn", | |
"description": "Ndn Service", | |
"x-plugin": "ndnDistribution" | |
}, | |
{ | |
"name": "notification", | |
"description": "Notification Service" | |
}, | |
{ | |
"name": "partner", | |
"description": "partner service allows you to change/manage your partner personal details and settings as well" | |
}, | |
{ | |
"name": "PartnerCatalogItem", | |
"description": "Partner Catalog Item Service", | |
"x-plugin": "reach" | |
}, | |
{ | |
"name": "permission", | |
"description": "Permission service lets you create and manage user permissions" | |
}, | |
{ | |
"name": "permissionItem", | |
"description": "PermissionItem service lets you create and manage permission items" | |
}, | |
{ | |
"name": "pexip", | |
"x-plugin": "sip" | |
}, | |
{ | |
"name": "playlist", | |
"description": "Playlist service lets you create,manage and play your playlists\n Playlists could be static (containing a fixed list of entries) or dynamic (based on a filter)" | |
}, | |
{ | |
"name": "playReadyDrm", | |
"x-plugin": "playReady" | |
}, | |
{ | |
"name": "poll", | |
"description": "Poll service\n The poll service works against the cache entirely no DB instance should be used here", | |
"x-plugin": "poll" | |
}, | |
{ | |
"name": "quiz", | |
"description": "Allows user to handle quizzes", | |
"x-plugin": "quiz" | |
}, | |
{ | |
"name": "rating", | |
"description": "Allows user to manipulate their entry rating", | |
"x-plugin": "rating" | |
}, | |
{ | |
"name": "reachProfile", | |
"description": "Reach Profile Service", | |
"x-plugin": "reach" | |
}, | |
{ | |
"name": "report", | |
"description": "api for getting reports data by the report type and some inputFilter" | |
}, | |
{ | |
"name": "responseProfile", | |
"description": "Manage response profiles" | |
}, | |
{ | |
"name": "scheduledTaskProfile", | |
"description": "Schedule task service lets you create and manage scheduled task profiles", | |
"x-plugin": "scheduledTask" | |
}, | |
{ | |
"name": "scheduleEvent", | |
"description": "The ScheduleEvent service enables you to create and manage (update, delete, retrieve, etc.) scheduled recording events.", | |
"x-plugin": "schedule" | |
}, | |
{ | |
"name": "scheduleEventResource", | |
"description": "The ScheduleEventResource service enables you create and manage (update, delete, retrieve, etc.) the connections between recording events and the resources required for these events (cameras, capture devices, etc.).", | |
"x-plugin": "schedule" | |
}, | |
{ | |
"name": "scheduleResource", | |
"description": "The ScheduleResource service enables you to create and manage (update, delete, retrieve, etc.) the resources required for scheduled events (cameras, capture devices, etc.).", | |
"x-plugin": "schedule" | |
}, | |
{ | |
"name": "schema", | |
"description": "Expose the schema definitions for syndication MRSS, bulk upload XML and other schema types." | |
}, | |
{ | |
"name": "search", | |
"description": "Search service allows you to search for media in various media providers\n This service is being used mostly by the CW component" | |
}, | |
{ | |
"name": "searchHistory", | |
"x-plugin": "searchHistory" | |
}, | |
{ | |
"name": "serverNode", | |
"description": "Server Node service" | |
}, | |
{ | |
"name": "session", | |
"description": "Session service" | |
}, | |
{ | |
"name": "sharepointExtension", | |
"description": "Kaltura Sharepoint Extension Service", | |
"x-plugin": "KalturaSharepointExtension" | |
}, | |
{ | |
"name": "shortLink", | |
"description": "Short link service", | |
"x-plugin": "shortLink" | |
}, | |
{ | |
"name": "sso", | |
"x-plugin": "sso" | |
}, | |
{ | |
"name": "stats", | |
"description": "Stats Service" | |
}, | |
{ | |
"name": "storageProfile", | |
"description": "The Storage Profile service allows you to export your Kaltura content to external storage volumes.\n This service is disabled by default, please contact your account manager if you wish to enable it for your partner." | |
}, | |
{ | |
"name": "synacorHbo", | |
"description": "Synacor HBO Service", | |
"x-plugin": "synacorHboDistribution" | |
}, | |
{ | |
"name": "syndicationFeed", | |
"description": "Add & Manage Syndication Feeds" | |
}, | |
{ | |
"name": "system", | |
"description": "System service is used for internal system helpers & to retrieve system level information" | |
}, | |
{ | |
"name": "systemPartner", | |
"description": "System partner service", | |
"x-plugin": "systemPartner" | |
}, | |
{ | |
"name": "tag", | |
"description": "Search object tags", | |
"x-plugin": "tagSearch" | |
}, | |
{ | |
"name": "thumbAsset", | |
"description": "Retrieve information and invoke actions on Thumb Asset" | |
}, | |
{ | |
"name": "thumbnail", | |
"x-plugin": "thumbnail" | |
}, | |
{ | |
"name": "thumbParams", | |
"description": "Add & Manage Thumb Params" | |
}, | |
{ | |
"name": "thumbParamsOutput", | |
"description": "Thumbnail Params Output service" | |
}, | |
{ | |
"name": "timeWarner", | |
"description": "Time Warner Service", | |
"x-plugin": "timeWarnerDistribution" | |
}, | |
{ | |
"name": "tvCom", | |
"description": "TVCom service", | |
"x-plugin": "contentDistribution" | |
}, | |
{ | |
"name": "uiConf", | |
"description": "UiConf service lets you create and manage your UIConfs for the various flash components\n This service is used by the KMC-ApplicationStudio" | |
}, | |
{ | |
"name": "unicorn", | |
"description": "Unicorn Service", | |
"x-plugin": "unicornDistribution" | |
}, | |
{ | |
"name": "upload" | |
}, | |
{ | |
"name": "uploadToken" | |
}, | |
{ | |
"name": "user", | |
"description": "Manage partner users on Kaltura's side\n The userId in kaltura is the unique ID in the partner's system, and the [partnerId,Id] couple are unique key in kaltura's DB" | |
}, | |
{ | |
"name": "userEntry" | |
}, | |
{ | |
"name": "userRole", | |
"description": "UserRole service lets you create and manage user roles" | |
}, | |
{ | |
"name": "userScore", | |
"x-plugin": "game" | |
}, | |
{ | |
"name": "uverse", | |
"description": "Uverse Service", | |
"x-plugin": "uverseDistribution" | |
}, | |
{ | |
"name": "uverseClickToOrder", | |
"description": "Uverse Click To Order Service", | |
"x-plugin": "uverseClickToOrderDistribution" | |
}, | |
{ | |
"name": "varConsole", | |
"description": "Utility service for the Multi-publishers console", | |
"x-plugin": "varConsole" | |
}, | |
{ | |
"name": "vendorCatalogItem", | |
"description": "Vendor Catalog Item Service", | |
"x-plugin": "reach" | |
}, | |
{ | |
"name": "vendorIntegration", | |
"x-plugin": "vendor" | |
}, | |
{ | |
"name": "virtualEvent", | |
"x-plugin": "virtualEvent" | |
}, | |
{ | |
"name": "virusScanProfile", | |
"description": "Virus scan profile service", | |
"x-plugin": "virusScan" | |
}, | |
{ | |
"name": "volatileInteractivity", | |
"x-plugin": "interactivity" | |
}, | |
{ | |
"name": "webexVendor", | |
"x-plugin": "WebexAPIDropFolder" | |
}, | |
{ | |
"name": "widevineDrm", | |
"description": "WidevineDrmService serves as a license proxy to a Widevine license server", | |
"x-plugin": "widevine" | |
}, | |
{ | |
"name": "widget", | |
"description": "widget service for full widget management" | |
}, | |
{ | |
"name": "xInternal", | |
"description": "Internal Service is used for actions that are used internally in Kaltura applications and might be changed in the future without any notice." | |
}, | |
{ | |
"name": "zoomVendor", | |
"x-plugin": "vendor" | |
} | |
], | |
"paths": { | |
"/service/accesscontrol/action/add": { | |
"post": { | |
"tags": [ | |
"accessControl" | |
], | |
"description": "Add new Access Control Profile", | |
"operationId": "accessControl.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"accessControl" | |
], | |
"type": "object", | |
"properties": { | |
"accessControl": { | |
"$ref": "#/components/schemas/KalturaAccessControl" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAccessControl" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"accessControl" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/accesscontrol/action/delete": { | |
"post": { | |
"tags": [ | |
"accessControl" | |
], | |
"description": "Delete Access Control Profile by id", | |
"operationId": "accessControl.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/accesscontrol/action/get": { | |
"post": { | |
"tags": [ | |
"accessControl" | |
], | |
"description": "Get Access Control Profile by id", | |
"operationId": "accessControl.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAccessControl" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/accesscontrol/action/list": { | |
"post": { | |
"tags": [ | |
"accessControl" | |
], | |
"description": "List Access Control Profiles by filter and pager", | |
"operationId": "accessControl.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaAccessControlFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAccessControlListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/accesscontrol/action/update": { | |
"post": { | |
"tags": [ | |
"accessControl" | |
], | |
"description": "Update Access Control Profile by id", | |
"operationId": "accessControl.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"accessControl", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"accessControl": { | |
"$ref": "#/components/schemas/KalturaAccessControl" | |
}, | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAccessControl" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"accessControl" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/accesscontrolprofile/action/add": { | |
"post": { | |
"tags": [ | |
"accessControlProfile" | |
], | |
"description": "Add new access control profile", | |
"operationId": "accessControlProfile.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"accessControlProfile" | |
], | |
"type": "object", | |
"properties": { | |
"accessControlProfile": { | |
"$ref": "#/components/schemas/KalturaAccessControlProfile" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAccessControlProfile" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"accessControlProfile" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/accesscontrolprofile/action/delete": { | |
"post": { | |
"tags": [ | |
"accessControlProfile" | |
], | |
"description": "Delete access control profile by id", | |
"operationId": "accessControlProfile.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/accesscontrolprofile/action/get": { | |
"post": { | |
"tags": [ | |
"accessControlProfile" | |
], | |
"description": "Get access control profile by id", | |
"operationId": "accessControlProfile.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAccessControlProfile" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/accesscontrolprofile/action/list": { | |
"post": { | |
"tags": [ | |
"accessControlProfile" | |
], | |
"description": "List access control profiles by filter and pager", | |
"operationId": "accessControlProfile.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaAccessControlProfileFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAccessControlProfileListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/accesscontrolprofile/action/update": { | |
"post": { | |
"tags": [ | |
"accessControlProfile" | |
], | |
"description": "Update access control profile by id", | |
"operationId": "accessControlProfile.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"accessControlProfile", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"accessControlProfile": { | |
"$ref": "#/components/schemas/KalturaAccessControlProfile" | |
}, | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAccessControlProfile" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"accessControlProfile" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/adminuser/action/login": { | |
"post": { | |
"tags": [ | |
"adminUser" | |
], | |
"description": "Get an admin session using admin email and password (Used for login to the KMC application)", | |
"operationId": "adminUser.login", | |
"parameters": [ | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"email", | |
"password" | |
], | |
"type": "object", | |
"properties": { | |
"email": { | |
"type": "string" | |
}, | |
"partnerId": { | |
"type": "integer" | |
}, | |
"password": { | |
"type": "string", | |
"x-inputType": "password" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"email", | |
"password", | |
"partnerId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/adminuser/action/resetPassword": { | |
"post": { | |
"tags": [ | |
"adminUser" | |
], | |
"description": "Reset admin user password and send it to the users email address", | |
"operationId": "adminUser.resetPassword", | |
"parameters": [ | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"email" | |
], | |
"type": "object", | |
"properties": { | |
"email": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"email" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/adminuser/action/setInitialPassword": { | |
"post": { | |
"tags": [ | |
"adminUser" | |
], | |
"description": "Set initial users password", | |
"operationId": "adminUser.setInitialPassword", | |
"parameters": [ | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"hashKey", | |
"newPassword" | |
], | |
"type": "object", | |
"properties": { | |
"hashKey": { | |
"type": "string" | |
}, | |
"newPassword": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAuthentication" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"hashKey", | |
"newPassword" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/adminuser/action/updatePassword": { | |
"post": { | |
"tags": [ | |
"adminUser" | |
], | |
"description": "Update admin user password and email", | |
"operationId": "adminUser.updatePassword", | |
"parameters": [ | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"email", | |
"password" | |
], | |
"type": "object", | |
"properties": { | |
"email": { | |
"type": "string" | |
}, | |
"newEmail": { | |
"type": "string" | |
}, | |
"newPassword": { | |
"type": "string" | |
}, | |
"otp": { | |
"type": "string" | |
}, | |
"password": { | |
"type": "string", | |
"x-inputType": "password" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAdminUser" | |
} | |
} | |
} | |
} | |
}, | |
"deprecated": true, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"email", | |
"password", | |
"newEmail", | |
"newPassword", | |
"otp" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/analytics/action/query": { | |
"post": { | |
"tags": [ | |
"analytics" | |
], | |
"description": "report query action allows to get a analytics data for specific query dimensions, metrics and filters.", | |
"operationId": "analytics.query", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"filter" | |
], | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaAnalyticsFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaReportResponse" | |
} | |
} | |
} | |
} | |
}, | |
"deprecated": true, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/annotation_annotation/action/add": { | |
"post": { | |
"tags": [ | |
"annotation" | |
], | |
"description": "Allows you to add an annotation object associated with an entry", | |
"operationId": "annotation.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"annotation" | |
], | |
"type": "object", | |
"properties": { | |
"annotation": { | |
"$ref": "#/components/schemas/KalturaCuePoint" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAnnotation" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"annotation" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/annotation_annotation/action/addFromBulk": { | |
"post": { | |
"tags": [ | |
"annotation" | |
], | |
"description": "Allows you to add multiple cue points objects by uploading XML that contains multiple cue point definitions", | |
"operationId": "annotation.addFromBulk", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
} | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"required": [ | |
"fileData" | |
], | |
"properties": { | |
"fileData": { | |
"type": "string", | |
"format": "binary" | |
} | |
} | |
} | |
} | |
}, | |
"required": true | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCuePointListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "file", | |
"x-kaltura-parameters": [ | |
"fileData" | |
] | |
} | |
}, | |
"/service/annotation_annotation/action/clone": { | |
"post": { | |
"tags": [ | |
"annotation" | |
], | |
"description": "Clone cuePoint with id to given entry", | |
"operationId": "annotation.clone", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
}, | |
"id": { | |
"type": "string" | |
}, | |
"parentId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAnnotation" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"entryId", | |
"parentId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/annotation_annotation/action/count": { | |
"post": { | |
"tags": [ | |
"annotation" | |
], | |
"description": "count cue point objects by filter", | |
"operationId": "annotation.count", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaCuePointFilter" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/annotation_annotation/action/delete": { | |
"post": { | |
"tags": [ | |
"annotation" | |
], | |
"description": "delete cue point by id, and delete all children cue points", | |
"operationId": "annotation.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/annotation_annotation/action/get": { | |
"post": { | |
"tags": [ | |
"annotation" | |
], | |
"description": "Retrieve an CuePoint object by id", | |
"operationId": "annotation.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCuePoint" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/annotation_annotation/action/list": { | |
"post": { | |
"tags": [ | |
"annotation" | |
], | |
"description": "List annotation objects by filter and pager", | |
"operationId": "annotation.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaCuePointFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAnnotationListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/annotation_annotation/action/serveBulk": { | |
"post": { | |
"tags": [ | |
"annotation" | |
], | |
"description": "Download multiple cue points objects as XML definitions", | |
"operationId": "annotation.serveBulk", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaCuePointFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/annotation_annotation/action/update": { | |
"post": { | |
"tags": [ | |
"annotation" | |
], | |
"description": "Update annotation by id", | |
"operationId": "annotation.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"annotation", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"annotation": { | |
"$ref": "#/components/schemas/KalturaCuePoint" | |
}, | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAnnotation" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"annotation" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/annotation_annotation/action/updateCuePointsTimes": { | |
"post": { | |
"tags": [ | |
"annotation" | |
], | |
"operationId": "annotation.updateCuePointsTimes", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id", | |
"startTime" | |
], | |
"type": "object", | |
"properties": { | |
"endTime": { | |
"type": "integer" | |
}, | |
"id": { | |
"type": "string" | |
}, | |
"startTime": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCuePoint" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"startTime", | |
"endTime" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/annotation_annotation/action/updateStatus": { | |
"post": { | |
"tags": [ | |
"annotation" | |
], | |
"description": "Update cuePoint status by id", | |
"operationId": "annotation.updateStatus", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id", | |
"status" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string" | |
}, | |
"status": { | |
"type": "integer", | |
"x-enumLabels": [ | |
"READY", | |
"DELETED", | |
"HANDLED", | |
"PENDING" | |
], | |
"x-enumType": "KalturaCuePointStatus" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"status" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/apptoken/action/add": { | |
"post": { | |
"tags": [ | |
"appToken" | |
], | |
"description": "Add new application authentication token", | |
"operationId": "appToken.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"appToken" | |
], | |
"type": "object", | |
"properties": { | |
"appToken": { | |
"$ref": "#/components/schemas/KalturaAppToken" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAppToken" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"appToken" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/apptoken/action/delete": { | |
"post": { | |
"tags": [ | |
"appToken" | |
], | |
"description": "Delete application authentication token by ID", | |
"operationId": "appToken.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/apptoken/action/get": { | |
"post": { | |
"tags": [ | |
"appToken" | |
], | |
"description": "Get application authentication token by ID", | |
"operationId": "appToken.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAppToken" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/apptoken/action/list": { | |
"post": { | |
"tags": [ | |
"appToken" | |
], | |
"description": "List application authentication tokens by filter and pager", | |
"operationId": "appToken.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaAppTokenFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAppTokenListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/apptoken/action/startSession": { | |
"post": { | |
"tags": [ | |
"appToken" | |
], | |
"description": "Starts a new KS (kaltura Session) based on an application authentication token ID", | |
"operationId": "appToken.startSession", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id", | |
"tokenHash" | |
], | |
"type": "object", | |
"properties": { | |
"expiry": { | |
"type": "integer" | |
}, | |
"id": { | |
"type": "string" | |
}, | |
"sessionPrivileges": { | |
"type": "string" | |
}, | |
"tokenHash": { | |
"type": "string" | |
}, | |
"type": { | |
"type": "integer", | |
"x-enumLabels": [ | |
"USER", | |
"ADMIN" | |
], | |
"x-enumType": "KalturaSessionType" | |
}, | |
"userId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaSessionInfo" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"tokenHash", | |
"userId", | |
"type", | |
"expiry", | |
"sessionPrivileges" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/apptoken/action/update": { | |
"post": { | |
"tags": [ | |
"appToken" | |
], | |
"description": "Update application authentication token by ID", | |
"operationId": "appToken.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"appToken", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"appToken": { | |
"$ref": "#/components/schemas/KalturaAppToken" | |
}, | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAppToken" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"appToken" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/aspera_aspera/action/getFaspUrl": { | |
"post": { | |
"tags": [ | |
"aspera" | |
], | |
"operationId": "aspera.getFaspUrl", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"flavorAssetId" | |
], | |
"type": "object", | |
"properties": { | |
"flavorAssetId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"flavorAssetId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/attachment_attachmentasset/action/add": { | |
"post": { | |
"tags": [ | |
"attachmentAsset" | |
], | |
"description": "Add attachment asset", | |
"operationId": "attachmentAsset.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"attachmentAsset", | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"attachmentAsset": { | |
"$ref": "#/components/schemas/KalturaAttachmentAsset" | |
}, | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAttachmentAsset" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"attachmentAsset" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/attachment_attachmentasset/action/delete": { | |
"post": { | |
"tags": [ | |
"attachmentAsset" | |
], | |
"operationId": "attachmentAsset.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"attachmentAssetId" | |
], | |
"type": "object", | |
"properties": { | |
"attachmentAssetId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"attachmentAssetId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/attachment_attachmentasset/action/get": { | |
"post": { | |
"tags": [ | |
"attachmentAsset" | |
], | |
"operationId": "attachmentAsset.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"attachmentAssetId" | |
], | |
"type": "object", | |
"properties": { | |
"attachmentAssetId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAttachmentAsset" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"attachmentAssetId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/attachment_attachmentasset/action/getRemotePaths": { | |
"post": { | |
"tags": [ | |
"attachmentAsset" | |
], | |
"description": "Get remote storage existing paths for the asset", | |
"operationId": "attachmentAsset.getRemotePaths", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaRemotePathListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/attachment_attachmentasset/action/getUrl": { | |
"post": { | |
"tags": [ | |
"attachmentAsset" | |
], | |
"description": "Get download URL for the asset", | |
"operationId": "attachmentAsset.getUrl", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string" | |
}, | |
"storageId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"storageId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/attachment_attachmentasset/action/list": { | |
"post": { | |
"tags": [ | |
"attachmentAsset" | |
], | |
"description": "List attachment Assets by filter and pager", | |
"operationId": "attachmentAsset.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaAssetFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAttachmentAssetListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/attachment_attachmentasset/action/serve": { | |
"post": { | |
"tags": [ | |
"attachmentAsset" | |
], | |
"description": "Serves attachment by its id", | |
"operationId": "attachmentAsset.serve", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"attachmentAssetId" | |
], | |
"type": "object", | |
"properties": { | |
"attachmentAssetId": { | |
"type": "string" | |
}, | |
"serveOptions": { | |
"$ref": "#/components/schemas/KalturaAttachmentServeOptions" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"attachmentAssetId", | |
"serveOptions" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/attachment_attachmentasset/action/setContent": { | |
"post": { | |
"tags": [ | |
"attachmentAsset" | |
], | |
"description": "Update content of attachment asset", | |
"operationId": "attachmentAsset.setContent", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"contentResource", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"contentResource": { | |
"$ref": "#/components/schemas/KalturaContentResource" | |
}, | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAttachmentAsset" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"contentResource" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/attachment_attachmentasset/action/update": { | |
"post": { | |
"tags": [ | |
"attachmentAsset" | |
], | |
"description": "Update attachment asset", | |
"operationId": "attachmentAsset.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"attachmentAsset", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"attachmentAsset": { | |
"$ref": "#/components/schemas/KalturaAttachmentAsset" | |
}, | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAttachmentAsset" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"attachmentAsset" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/attuversedistribution_attuverse/action/getFeed": { | |
"post": { | |
"tags": [ | |
"attUverse" | |
], | |
"operationId": "attUverse.getFeed", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"distributionProfileId", | |
"hash" | |
], | |
"type": "object", | |
"properties": { | |
"distributionProfileId": { | |
"type": "integer" | |
}, | |
"hash": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"distributionProfileId", | |
"hash" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/audit_audittrail/action/add": { | |
"post": { | |
"tags": [ | |
"auditTrail" | |
], | |
"description": "Allows you to add an audit trail object and audit trail content associated with Kaltura object", | |
"operationId": "auditTrail.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"auditTrail" | |
], | |
"type": "object", | |
"properties": { | |
"auditTrail": { | |
"$ref": "#/components/schemas/KalturaAuditTrail" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAuditTrail" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"auditTrail" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/audit_audittrail/action/get": { | |
"post": { | |
"tags": [ | |
"auditTrail" | |
], | |
"description": "Retrieve an audit trail object by id", | |
"operationId": "auditTrail.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAuditTrail" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/audit_audittrail/action/list": { | |
"post": { | |
"tags": [ | |
"auditTrail" | |
], | |
"description": "List audit trail objects by filter and pager", | |
"operationId": "auditTrail.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaAuditTrailFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaAuditTrailListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/avndistribution_avn/action/getFeed": { | |
"post": { | |
"tags": [ | |
"avn" | |
], | |
"operationId": "avn.getFeed", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"distributionProfileId", | |
"hash" | |
], | |
"type": "object", | |
"properties": { | |
"distributionProfileId": { | |
"type": "integer" | |
}, | |
"hash": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"distributionProfileId", | |
"hash" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/add": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Generic add entry, should be used when the uploaded entry type is not known.", | |
"operationId": "baseEntry.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entry" | |
], | |
"type": "object", | |
"properties": { | |
"entry": { | |
"$ref": "#/components/schemas/KalturaBaseEntry" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
-1, | |
"conference.CONFERENCE_ENTRY_SERVER", | |
"externalMedia.externalMedia", | |
"sip.SIP_ENTRY_SERVER", | |
"1", | |
"2", | |
"5", | |
"6", | |
"7", | |
"8", | |
"10" | |
], | |
"x-enumLabels": [ | |
"AUTOMATIC", | |
"CONFERENCE_ENTRY_SERVER", | |
"EXTERNAL_MEDIA", | |
"SIP_ENTRY_SERVER", | |
"MEDIA_CLIP", | |
"MIX", | |
"PLAYLIST", | |
"DATA", | |
"LIVE_STREAM", | |
"LIVE_CHANNEL", | |
"DOCUMENT" | |
], | |
"x-enumType": "KalturaEntryType" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBaseEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entry", | |
"type" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/addContent": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Attach content resource to entry in status NO_MEDIA", | |
"operationId": "baseEntry.addContent", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId", | |
"resource" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
}, | |
"resource": { | |
"$ref": "#/components/schemas/KalturaResource" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBaseEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"resource" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/addFromUploadedFile": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Generic add entry using an uploaded file, should be used when the uploaded entry type is not known.", | |
"operationId": "baseEntry.addFromUploadedFile", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entry", | |
"uploadTokenId" | |
], | |
"type": "object", | |
"properties": { | |
"entry": { | |
"$ref": "#/components/schemas/KalturaBaseEntry" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
-1, | |
"conference.CONFERENCE_ENTRY_SERVER", | |
"externalMedia.externalMedia", | |
"sip.SIP_ENTRY_SERVER", | |
"1", | |
"2", | |
"5", | |
"6", | |
"7", | |
"8", | |
"10" | |
], | |
"x-enumLabels": [ | |
"AUTOMATIC", | |
"CONFERENCE_ENTRY_SERVER", | |
"EXTERNAL_MEDIA", | |
"SIP_ENTRY_SERVER", | |
"MEDIA_CLIP", | |
"MIX", | |
"PLAYLIST", | |
"DATA", | |
"LIVE_STREAM", | |
"LIVE_CHANNEL", | |
"DOCUMENT" | |
], | |
"x-enumType": "KalturaEntryType" | |
}, | |
"uploadTokenId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBaseEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entry", | |
"uploadTokenId", | |
"type" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/anonymousRank": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Anonymously rank an entry, no validation is done on duplicate rankings.", | |
"operationId": "baseEntry.anonymousRank", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId", | |
"rank" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
}, | |
"rank": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"rank" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/approve": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Approve the entry and mark the pending flags (if any) as moderated (this will make the entry playable).", | |
"operationId": "baseEntry.approve", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/clone": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Clone an entry with optional attributes to apply to the clone", | |
"operationId": "baseEntry.clone", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"cloneOptions": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/KalturaBaseEntryCloneOptionItem" | |
} | |
}, | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBaseEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"cloneOptions" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/count": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Count base entries by filter.", | |
"operationId": "baseEntry.count", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaBaseEntryFilter" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/delete": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Delete an entry.", | |
"operationId": "baseEntry.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/export": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"operationId": "baseEntry.export", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId", | |
"storageProfileId" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
}, | |
"storageProfileId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBaseEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"storageProfileId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/exportToCsv": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "add batch job that sends an email with a link to download an updated CSV that contains list of entries", | |
"operationId": "baseEntry.exportToCsv", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"additionalFields": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/KalturaCsvAdditionalFieldInfo" | |
} | |
}, | |
"filter": { | |
"$ref": "#/components/schemas/KalturaBaseEntryFilter" | |
}, | |
"mappedFields": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/KalturaKeyValue" | |
} | |
}, | |
"metadataProfileId": { | |
"type": "integer" | |
}, | |
"options": { | |
"$ref": "#/components/schemas/KalturaExportToCsvOptions" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"metadataProfileId", | |
"additionalFields", | |
"mappedFields", | |
"options" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/flag": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Flag inappropriate entry for moderation.", | |
"operationId": "baseEntry.flag", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"moderationFlag" | |
], | |
"type": "object", | |
"properties": { | |
"moderationFlag": { | |
"$ref": "#/components/schemas/KalturaModerationFlag" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"moderationFlag" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/get": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Get base entry by ID.", | |
"operationId": "baseEntry.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
}, | |
"version": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBaseEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"version" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/getByIds": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Get an array of KalturaBaseEntry objects by a comma-separated list of ids.", | |
"operationId": "baseEntry.getByIds", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryIds" | |
], | |
"type": "object", | |
"properties": { | |
"entryIds": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/KalturaBaseEntry" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryIds" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/getContextData": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "This action delivers entry-related data, based on the user's context: access control, restriction, playback format and storage information.", | |
"operationId": "baseEntry.getContextData", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"contextDataParams", | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"contextDataParams": { | |
"$ref": "#/components/schemas/KalturaEntryContextDataParams" | |
}, | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaEntryContextDataResult" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"contextDataParams" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/getPlaybackContext": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "This action delivers all data relevant for player", | |
"operationId": "baseEntry.getPlaybackContext", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"contextDataParams", | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"contextDataParams": { | |
"$ref": "#/components/schemas/KalturaPlaybackContextOptions" | |
}, | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaPlaybackContext" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"contextDataParams" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/getRemotePaths": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Get remote storage existing paths for the asset.", | |
"operationId": "baseEntry.getRemotePaths", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaRemotePathListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/index": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Index an entry by id.", | |
"operationId": "baseEntry.index", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string" | |
}, | |
"shouldUpdate": { | |
"type": "boolean", | |
"default": true | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"shouldUpdate" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/list": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "List base entries by filter with paging support.", | |
"operationId": "baseEntry.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaBaseEntryFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBaseEntryListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/listByReferenceId": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "List base entries by filter according to reference id", | |
"operationId": "baseEntry.listByReferenceId", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"refId" | |
], | |
"type": "object", | |
"properties": { | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
}, | |
"refId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBaseEntryListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"refId", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/listFlags": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "List all pending flags for the entry.", | |
"operationId": "baseEntry.listFlags", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaModerationFlagListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/recycle": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Move the entry to the recycle bin", | |
"operationId": "baseEntry.recycle", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBaseEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/reject": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Reject the entry and mark the pending flags (if any) as moderated (this will make the entry non-playable).", | |
"operationId": "baseEntry.reject", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/restoreRecycled": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Restore the entry from the recycle bin", | |
"operationId": "baseEntry.restoreRecycled", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBaseEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/servePlaybackKey": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "This action serves HLS encrypted key if access control is validated", | |
"operationId": "baseEntry.servePlaybackKey", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/update": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Update base entry. Only the properties that were set will be updated.", | |
"operationId": "baseEntry.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"baseEntry", | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"baseEntry": { | |
"$ref": "#/components/schemas/KalturaBaseEntry" | |
}, | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBaseEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"baseEntry" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/updateContent": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Update the content resource associated with the entry.", | |
"operationId": "baseEntry.updateContent", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId", | |
"resource" | |
], | |
"type": "object", | |
"properties": { | |
"advancedOptions": { | |
"$ref": "#/components/schemas/KalturaEntryReplacementOptions" | |
}, | |
"conversionProfileId": { | |
"type": "integer" | |
}, | |
"entryId": { | |
"type": "string" | |
}, | |
"resource": { | |
"$ref": "#/components/schemas/KalturaResource" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBaseEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"resource", | |
"conversionProfileId", | |
"advancedOptions" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/updateThumbnailFromSourceEntry": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Update entry thumbnail from a different entry by a specified time offset (in seconds).", | |
"operationId": "baseEntry.updateThumbnailFromSourceEntry", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId", | |
"sourceEntryId", | |
"timeOffset" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
}, | |
"sourceEntryId": { | |
"type": "string" | |
}, | |
"timeOffset": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBaseEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"sourceEntryId", | |
"timeOffset" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/updateThumbnailFromUrl": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Update entry thumbnail using URL.", | |
"operationId": "baseEntry.updateThumbnailFromUrl", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId", | |
"url" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
}, | |
"url": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBaseEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"url" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/baseentry/action/updateThumbnailJpeg": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Update entry thumbnail using a raw jpeg file.", | |
"operationId": "baseEntry.updateThumbnailJpeg", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "entryId", | |
"in": "query", | |
"description": "Media entry id", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"required": [ | |
"fileData" | |
], | |
"properties": { | |
"fileData": { | |
"type": "string", | |
"description": "Jpeg file data", | |
"format": "binary" | |
} | |
} | |
} | |
} | |
}, | |
"required": true | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBaseEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "file", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"fileData" | |
] | |
} | |
}, | |
"/service/baseentry/action/upload": { | |
"post": { | |
"tags": [ | |
"baseEntry" | |
], | |
"description": "Upload a file to Kaltura, that can be used to create an entry.", | |
"operationId": "baseEntry.upload", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
} | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"required": [ | |
"fileData" | |
], | |
"properties": { | |
"fileData": { | |
"type": "string", | |
"description": "The file data", | |
"format": "binary" | |
} | |
} | |
} | |
} | |
}, | |
"required": true | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"deprecated": true, | |
"x-kaltura-format": "file", | |
"x-kaltura-parameters": [ | |
"fileData" | |
] | |
} | |
}, | |
"/service/batch/action/addBulkUploadResult": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch addBulkUploadResultAction action adds KalturaBulkUploadResult to the DB", | |
"operationId": "batch.addBulkUploadResult", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"bulkUploadResult" | |
], | |
"type": "object", | |
"properties": { | |
"bulkUploadResult": { | |
"$ref": "#/components/schemas/KalturaBulkUploadResult" | |
}, | |
"pluginDataArray": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/KalturaBulkUploadPluginData" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBulkUploadResult" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"bulkUploadResult", | |
"pluginDataArray" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batch/action/addMediaInfo": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch addMediaInfoAction action saves a media info object", | |
"operationId": "batch.addMediaInfo", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"mediaInfo" | |
], | |
"type": "object", | |
"properties": { | |
"mediaInfo": { | |
"$ref": "#/components/schemas/KalturaMediaInfo" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaMediaInfo" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"mediaInfo" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batch/action/checkEntryIsDone": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch checkEntryIsDone Check weather a specified entry is done converting and changes it to ready.", | |
"operationId": "batch.checkEntryIsDone", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"batchJobId" | |
], | |
"type": "object", | |
"properties": { | |
"batchJobId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "boolean" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"batchJobId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batch/action/checkFileExists": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch checkFileExists action check if the file exists", | |
"operationId": "batch.checkFileExists", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"localPath", | |
"size" | |
], | |
"type": "object", | |
"properties": { | |
"localPath": { | |
"type": "string" | |
}, | |
"size": { | |
"type": "number" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaFileExistsResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"localPath", | |
"size" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batch/action/cleanExclusiveJobs": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch cleanExclusiveJobs action mark as fatal error all expired jobs", | |
"operationId": "batch.cleanExclusiveJobs", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"responseProfile": { | |
"$ref": "#/components/schemas/KalturaBaseResponseProfile" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [], | |
"x-codegen-request-body-name": "responseProfile" | |
} | |
}, | |
"/service/batch/action/countBulkUploadEntries": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "Returns total created entries count and total error entries count", | |
"operationId": "batch.countBulkUploadEntries", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"bulkUploadJobId" | |
], | |
"type": "object", | |
"properties": { | |
"bulkUploadJobId": { | |
"type": "integer" | |
}, | |
"bulkUploadObjectType": { | |
"type": "string", | |
"enum": [ | |
"bulkUploadFilter.JOB", | |
"scheduleBulkUpload.SCHEDULE_EVENT", | |
"scheduleBulkUpload.SCHEDULE_RESOURCE", | |
"1", | |
"2", | |
"3", | |
"4", | |
"5", | |
"6", | |
"7" | |
], | |
"x-enumLabels": [ | |
"JOB", | |
"SCHEDULE_EVENT", | |
"SCHEDULE_RESOURCE", | |
"ENTRY", | |
"CATEGORY", | |
"USER", | |
"CATEGORY_USER", | |
"CATEGORY_ENTRY", | |
"USER_ENTRY", | |
"VENDOR_CATALOG_ITEM" | |
], | |
"x-enumType": "KalturaBulkUploadObjectType" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/KalturaKeyValue" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"bulkUploadJobId", | |
"bulkUploadObjectType" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batch/action/extendLockExpiration": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch extendLockExpiration action allows to extend the expiration of a BatchJobLock by job id", | |
"operationId": "batch.extendLockExpiration", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"jobId", | |
"maxExecutionTime" | |
], | |
"type": "object", | |
"properties": { | |
"jobId": { | |
"type": "integer" | |
}, | |
"maxExecutionTime": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"jobId", | |
"maxExecutionTime" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batch/action/freeExclusiveJob": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch freeExclusiveJobAction action allows to get a generic BatchJob", | |
"operationId": "batch.freeExclusiveJob", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id", | |
"jobType", | |
"lockKey" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
}, | |
"jobType": { | |
"type": "string", | |
"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" | |
], | |
"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": "#/components/schemas/KalturaExclusiveLockKey" | |
}, | |
"resetExecutionAttempts": { | |
"type": "boolean", | |
"default": false | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaFreeJobResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"lockKey", | |
"jobType", | |
"resetExecutionAttempts" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batch/action/getBulkUploadLastResult": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch getBulkUploadLastResultAction action returns the last result of the bulk upload", | |
"operationId": "batch.getBulkUploadLastResult", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"bulkUploadJobId" | |
], | |
"type": "object", | |
"properties": { | |
"bulkUploadJobId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBulkUploadResult" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"bulkUploadJobId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batch/action/getExclusiveAlmostDone": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch getExclusiveAlmostDone action allows to get a BatchJob that wait for remote closure", | |
"operationId": "batch.getExclusiveAlmostDone", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"lockKey", | |
"maxExecutionTime", | |
"numberOfJobs" | |
], | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaBatchJobFilter" | |
}, | |
"jobType": { | |
"type": "string", | |
"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" | |
], | |
"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": "#/components/schemas/KalturaExclusiveLockKey" | |
}, | |
"maxExecutionTime": { | |
"type": "integer" | |
}, | |
"numberOfJobs": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/KalturaBatchJob" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"lockKey", | |
"maxExecutionTime", | |
"numberOfJobs", | |
"filter", | |
"jobType" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batch/action/getExclusiveJobs": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch getExclusiveJobsAction action allows to get a BatchJob", | |
"operationId": "batch.getExclusiveJobs", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"lockKey", | |
"maxExecutionTime", | |
"numberOfJobs" | |
], | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaBatchJobFilter" | |
}, | |
"jobType": { | |
"type": "string", | |
"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" | |
], | |
"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": "#/components/schemas/KalturaExclusiveLockKey" | |
}, | |
"maxExecutionTime": { | |
"type": "integer" | |
}, | |
"maxJobToPullForCache": { | |
"type": "integer" | |
}, | |
"numberOfJobs": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/KalturaBatchJob" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"lockKey", | |
"maxExecutionTime", | |
"numberOfJobs", | |
"filter", | |
"jobType", | |
"maxJobToPullForCache" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batch/action/getExclusiveNotificationJobs": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch getExclusiveNotificationJob action allows to get a BatchJob of type NOTIFICATION", | |
"operationId": "batch.getExclusiveNotificationJobs", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"lockKey", | |
"maxExecutionTime", | |
"numberOfJobs" | |
], | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaBatchJobFilter" | |
}, | |
"lockKey": { | |
"$ref": "#/components/schemas/KalturaExclusiveLockKey" | |
}, | |
"maxExecutionTime": { | |
"type": "integer" | |
}, | |
"numberOfJobs": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBatchGetExclusiveNotificationJobsResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"lockKey", | |
"maxExecutionTime", | |
"numberOfJobs", | |
"filter" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batch/action/getQueueSize": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch getQueueSize action get the queue size for job type", | |
"operationId": "batch.getQueueSize", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"workerQueueFilter" | |
], | |
"type": "object", | |
"properties": { | |
"workerQueueFilter": { | |
"$ref": "#/components/schemas/KalturaWorkerQueueFilter" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"workerQueueFilter" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batch/action/logConversion": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "Add the data to the flavor asset conversion log, creates it if doesn't exists", | |
"operationId": "batch.logConversion", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"data", | |
"flavorAssetId" | |
], | |
"type": "object", | |
"properties": { | |
"data": { | |
"type": "string" | |
}, | |
"flavorAssetId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"flavorAssetId", | |
"data" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batch/action/putFile": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch putFileAction action allows put file on server via http", | |
"operationId": "batch.putFile", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "destPath", | |
"in": "query", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"required": [ | |
"data" | |
], | |
"properties": { | |
"data": { | |
"type": "string", | |
"format": "binary" | |
} | |
} | |
} | |
} | |
}, | |
"required": true | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "file", | |
"x-kaltura-parameters": [ | |
"destPath", | |
"data" | |
] | |
} | |
}, | |
"/service/batch/action/resetJobExecutionAttempts": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch resetJobExecutionAttempts action resets the execution attempts of the job", | |
"operationId": "batch.resetJobExecutionAttempts", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id", | |
"jobType", | |
"lockKey" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
}, | |
"jobType": { | |
"type": "string", | |
"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" | |
], | |
"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": "#/components/schemas/KalturaExclusiveLockKey" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"lockKey", | |
"jobType" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batch/action/suspendJobs": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch suspendJobs action suspends jobs from running.", | |
"operationId": "batch.suspendJobs", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"responseProfile": { | |
"$ref": "#/components/schemas/KalturaBaseResponseProfile" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [], | |
"x-codegen-request-body-name": "responseProfile" | |
} | |
}, | |
"/service/batch/action/updateBulkUploadResults": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch updateBulkUploadResults action adds KalturaBulkUploadResult to the DB", | |
"operationId": "batch.updateBulkUploadResults", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"bulkUploadJobId" | |
], | |
"type": "object", | |
"properties": { | |
"bulkUploadJobId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"bulkUploadJobId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batch/action/updateExclusiveConvertCollectionJob": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch updateExclusiveConvertCollectionJobAction action updates a BatchJob of type CONVERT_PROFILE that was claimed using the getExclusiveConvertJobs", | |
"operationId": "batch.updateExclusiveConvertCollectionJob", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id", | |
"job", | |
"lockKey" | |
], | |
"type": "object", | |
"properties": { | |
"flavorsData": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/KalturaConvertCollectionFlavorData" | |
} | |
}, | |
"id": { | |
"type": "integer" | |
}, | |
"job": { | |
"$ref": "#/components/schemas/KalturaBatchJob" | |
}, | |
"lockKey": { | |
"$ref": "#/components/schemas/KalturaExclusiveLockKey" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBatchJob" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"lockKey", | |
"job", | |
"flavorsData" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batch/action/updateExclusiveJob": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch updateExclusiveJobAction action updates a BatchJob of extended type that was claimed using the getExclusiveJobs", | |
"operationId": "batch.updateExclusiveJob", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id", | |
"job", | |
"lockKey" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
}, | |
"job": { | |
"$ref": "#/components/schemas/KalturaBatchJob" | |
}, | |
"lockKey": { | |
"$ref": "#/components/schemas/KalturaExclusiveLockKey" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBatchJob" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"lockKey", | |
"job" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batch/action/updatePartnerLoadTable": { | |
"post": { | |
"tags": [ | |
"batch" | |
], | |
"description": "batch updatePartnerLoadTable action cleans the partner load table", | |
"operationId": "batch.updatePartnerLoadTable", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"responseProfile": { | |
"$ref": "#/components/schemas/KalturaBaseResponseProfile" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [], | |
"x-codegen-request-body-name": "responseProfile" | |
} | |
}, | |
"/service/batchcontrol/action/configLoaded": { | |
"post": { | |
"tags": [ | |
"batchcontrol" | |
], | |
"description": "batch configLoaded action saves the configuration as loaded by a remote scheduler", | |
"operationId": "batchcontrol.configLoaded", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"configParam", | |
"configValue", | |
"scheduler" | |
], | |
"type": "object", | |
"properties": { | |
"configParam": { | |
"type": "string" | |
}, | |
"configParamPart": { | |
"type": "string" | |
}, | |
"configValue": { | |
"type": "string" | |
}, | |
"scheduler": { | |
"$ref": "#/components/schemas/KalturaScheduler" | |
}, | |
"workerConfigId": { | |
"type": "integer" | |
}, | |
"workerName": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaSchedulerConfig" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"scheduler", | |
"configParam", | |
"configValue", | |
"configParamPart", | |
"workerConfigId", | |
"workerName" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batchcontrol/action/getCommand": { | |
"post": { | |
"tags": [ | |
"batchcontrol" | |
], | |
"description": "batch getCommand action returns the command with its current status", | |
"operationId": "batchcontrol.getCommand", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"commandId" | |
], | |
"type": "object", | |
"properties": { | |
"commandId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaControlPanelCommand" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"commandId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batchcontrol/action/getFullStatus": { | |
"post": { | |
"tags": [ | |
"batchcontrol" | |
], | |
"description": "batch getFullStatus action returns the status of all schedulers and queues", | |
"operationId": "batchcontrol.getFullStatus", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"responseProfile": { | |
"$ref": "#/components/schemas/KalturaBaseResponseProfile" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaFullStatusResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [], | |
"x-codegen-request-body-name": "responseProfile" | |
} | |
}, | |
"/service/batchcontrol/action/getOrCreateScheduler": { | |
"post": { | |
"tags": [ | |
"batchcontrol" | |
], | |
"operationId": "batchcontrol.getOrCreateScheduler", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"scheduler" | |
], | |
"type": "object", | |
"properties": { | |
"scheduler": { | |
"$ref": "#/components/schemas/KalturaScheduler" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaScheduler" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"scheduler" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batchcontrol/action/kill": { | |
"post": { | |
"tags": [ | |
"batchcontrol" | |
], | |
"description": "batch kill action forces stop of a batch on a remote scheduler", | |
"operationId": "batchcontrol.kill", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"adminId", | |
"batchIndex", | |
"cause", | |
"workerId" | |
], | |
"type": "object", | |
"properties": { | |
"adminId": { | |
"type": "integer" | |
}, | |
"batchIndex": { | |
"type": "integer" | |
}, | |
"cause": { | |
"type": "string" | |
}, | |
"workerId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaControlPanelCommand" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"workerId", | |
"batchIndex", | |
"adminId", | |
"cause" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batchcontrol/action/listCommands": { | |
"post": { | |
"tags": [ | |
"batchcontrol" | |
], | |
"description": "list batch control commands", | |
"operationId": "batchcontrol.listCommands", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaControlPanelCommandFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaControlPanelCommandListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batchcontrol/action/listSchedulers": { | |
"post": { | |
"tags": [ | |
"batchcontrol" | |
], | |
"description": "list all Schedulers", | |
"operationId": "batchcontrol.listSchedulers", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"responseProfile": { | |
"$ref": "#/components/schemas/KalturaBaseResponseProfile" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaSchedulerListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [], | |
"x-codegen-request-body-name": "responseProfile" | |
} | |
}, | |
"/service/batchcontrol/action/listWorkers": { | |
"post": { | |
"tags": [ | |
"batchcontrol" | |
], | |
"description": "list all Workers", | |
"operationId": "batchcontrol.listWorkers", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"responseProfile": { | |
"$ref": "#/components/schemas/KalturaBaseResponseProfile" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaSchedulerWorkerListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [], | |
"x-codegen-request-body-name": "responseProfile" | |
} | |
}, | |
"/service/batchcontrol/action/reportStatus": { | |
"post": { | |
"tags": [ | |
"batchcontrol" | |
], | |
"description": "batch reportStatus action saves the status attribute from a remote scheduler and returns pending commands for the scheduler", | |
"operationId": "batchcontrol.reportStatus", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"scheduler", | |
"schedulerStatuses", | |
"workerQueueFilters" | |
], | |
"type": "object", | |
"properties": { | |
"scheduler": { | |
"$ref": "#/components/schemas/KalturaScheduler" | |
}, | |
"schedulerStatuses": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/KalturaSchedulerStatus" | |
} | |
}, | |
"workerQueueFilters": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/KalturaWorkerQueueFilter" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaSchedulerStatusResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"scheduler", | |
"schedulerStatuses", | |
"workerQueueFilters" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batchcontrol/action/setCommandResult": { | |
"post": { | |
"tags": [ | |
"batchcontrol" | |
], | |
"description": "batch setCommandResult action saves the results of a command as received from a remote scheduler", | |
"operationId": "batchcontrol.setCommandResult", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"commandId", | |
"status" | |
], | |
"type": "object", | |
"properties": { | |
"commandId": { | |
"type": "integer" | |
}, | |
"errorDescription": { | |
"type": "string" | |
}, | |
"status": { | |
"type": "integer", | |
"x-enumLabels": [ | |
"PENDING", | |
"HANDLED", | |
"DONE", | |
"FAILED" | |
], | |
"x-enumType": "KalturaControlPanelCommandStatus" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaControlPanelCommand" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"commandId", | |
"status", | |
"errorDescription" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batchcontrol/action/setSchedulerConfig": { | |
"post": { | |
"tags": [ | |
"batchcontrol" | |
], | |
"description": "batch sets a configuration parameter to be loaded by a scheduler", | |
"operationId": "batchcontrol.setSchedulerConfig", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"adminId", | |
"configParam", | |
"configValue", | |
"schedulerId" | |
], | |
"type": "object", | |
"properties": { | |
"adminId": { | |
"type": "integer" | |
}, | |
"cause": { | |
"type": "string" | |
}, | |
"configParam": { | |
"type": "string" | |
}, | |
"configParamPart": { | |
"type": "string" | |
}, | |
"configValue": { | |
"type": "string" | |
}, | |
"schedulerId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaControlPanelCommand" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"schedulerId", | |
"adminId", | |
"configParam", | |
"configValue", | |
"configParamPart", | |
"cause" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batchcontrol/action/setWorkerConfig": { | |
"post": { | |
"tags": [ | |
"batchcontrol" | |
], | |
"description": "batch sets a configuration parameter to be loaded by a worker", | |
"operationId": "batchcontrol.setWorkerConfig", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"adminId", | |
"configParam", | |
"configValue", | |
"workerId" | |
], | |
"type": "object", | |
"properties": { | |
"adminId": { | |
"type": "integer" | |
}, | |
"cause": { | |
"type": "string" | |
}, | |
"configParam": { | |
"type": "string" | |
}, | |
"configParamPart": { | |
"type": "string" | |
}, | |
"configValue": { | |
"type": "string" | |
}, | |
"workerId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaControlPanelCommand" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"workerId", | |
"adminId", | |
"configParam", | |
"configValue", | |
"configParamPart", | |
"cause" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batchcontrol/action/startWorker": { | |
"post": { | |
"tags": [ | |
"batchcontrol" | |
], | |
"description": "batch start action starts a job", | |
"operationId": "batchcontrol.startWorker", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"adminId", | |
"workerId" | |
], | |
"type": "object", | |
"properties": { | |
"adminId": { | |
"type": "integer" | |
}, | |
"cause": { | |
"type": "string" | |
}, | |
"workerId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaControlPanelCommand" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"workerId", | |
"adminId", | |
"cause" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batchcontrol/action/stopScheduler": { | |
"post": { | |
"tags": [ | |
"batchcontrol" | |
], | |
"description": "batch stop action stops a scheduler", | |
"operationId": "batchcontrol.stopScheduler", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"adminId", | |
"cause", | |
"schedulerId" | |
], | |
"type": "object", | |
"properties": { | |
"adminId": { | |
"type": "integer" | |
}, | |
"cause": { | |
"type": "string" | |
}, | |
"schedulerId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaControlPanelCommand" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"schedulerId", | |
"adminId", | |
"cause" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/batchcontrol/action/stopWorker": { | |
"post": { | |
"tags": [ | |
"batchcontrol" | |
], | |
"description": "batch stop action stops a worker", | |
"operationId": "batchcontrol.stopWorker", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"adminId", | |
"cause", | |
"workerId" | |
], | |
"type": "object", | |
"properties": { | |
"adminId": { | |
"type": "integer" | |
}, | |
"cause": { | |
"type": "string" | |
}, | |
"workerId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaControlPanelCommand" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"workerId", | |
"adminId", | |
"cause" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/beacon_beacon/action/add": { | |
"post": { | |
"tags": [ | |
"beacon" | |
], | |
"operationId": "beacon.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"beacon" | |
], | |
"type": "object", | |
"properties": { | |
"beacon": { | |
"$ref": "#/components/schemas/KalturaBeacon" | |
}, | |
"shouldLog": { | |
"type": "integer", | |
"x-enumLabels": [ | |
"NULL_VALUE", | |
"FALSE_VALUE", | |
"TRUE_VALUE" | |
], | |
"x-enumType": "KalturaNullableBoolean" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "boolean" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"beacon", | |
"shouldLog" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/beacon_beacon/action/enhanceSearch": { | |
"post": { | |
"tags": [ | |
"beacon" | |
], | |
"operationId": "beacon.enhanceSearch", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaBeaconEnhanceFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBeaconListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/beacon_beacon/action/list": { | |
"post": { | |
"tags": [ | |
"beacon" | |
], | |
"operationId": "beacon.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaBeaconFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBeaconListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/beacon_beacon/action/searchScheduledResource": { | |
"post": { | |
"tags": [ | |
"beacon" | |
], | |
"operationId": "beacon.searchScheduledResource", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"searchParams" | |
], | |
"type": "object", | |
"properties": { | |
"pager": { | |
"$ref": "#/components/schemas/KalturaPager" | |
}, | |
"searchParams": { | |
"$ref": "#/components/schemas/KalturaBeaconSearchParams" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBeaconListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"searchParams", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/bulkupload/action/abort": { | |
"post": { | |
"tags": [ | |
"bulkUpload" | |
], | |
"description": "Aborts the bulk upload and all its child jobs", | |
"operationId": "bulkUpload.abort", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBulkUpload" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/bulkupload/action/add": { | |
"post": { | |
"tags": [ | |
"bulkUpload" | |
], | |
"description": "Add new bulk upload batch job\n\nConversion profile id can be specified in the API or in the CSV file, the one in the CSV file will be stronger.\n\nIf no conversion profile was specified, partner's default will be used", | |
"operationId": "bulkUpload.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "conversionProfileId", | |
"in": "query", | |
"description": "Conversion profile id to use for converting the current bulk (-1 to use partner's default)", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "bulkUploadType", | |
"in": "query", | |
"description": "Enum Type: `KalturaBulkUploadType`", | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"bulkUploadCsv.CSV", | |
"bulkUploadFilter.FILTER", | |
"bulkUploadXml.XML", | |
"dropFolderXmlBulkUpload.DROP_FOLDER_XML", | |
"scheduleBulkUpload.ICAL", | |
"scheduleDropFolder.DROP_FOLDER_ICAL" | |
], | |
"x-enumLabels": [ | |
"CSV", | |
"FILTER", | |
"XML", | |
"DROP_FOLDER_XML", | |
"ICAL", | |
"DROP_FOLDER_ICAL" | |
], | |
"x-enumType": "KalturaBulkUploadType" | |
}, | |
"x-enumLabels": [ | |
"CSV", | |
"FILTER", | |
"XML", | |
"DROP_FOLDER_XML", | |
"ICAL", | |
"DROP_FOLDER_ICAL" | |
], | |
"x-enumType": "KalturaBulkUploadType" | |
}, | |
{ | |
"name": "uploadedBy", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "fileName", | |
"in": "query", | |
"description": "Friendly name of the file, used to be recognized later in the logs.", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"required": [ | |
"csvFileData" | |
], | |
"properties": { | |
"csvFileData": { | |
"type": "string", | |
"description": "bulk upload file", | |
"format": "binary" | |
} | |
} | |
} | |
} | |
}, | |
"required": true | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBulkUpload" | |
} | |
} | |
} | |
} | |
}, | |
"deprecated": true, | |
"x-kaltura-format": "file", | |
"x-kaltura-parameters": [ | |
"conversionProfileId", | |
"csvFileData", | |
"bulkUploadType", | |
"uploadedBy", | |
"fileName" | |
] | |
} | |
}, | |
"/service/bulkupload/action/get": { | |
"post": { | |
"tags": [ | |
"bulkUpload" | |
], | |
"description": "Get bulk upload batch job by id", | |
"operationId": "bulkUpload.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBulkUpload" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/bulkupload/action/list": { | |
"post": { | |
"tags": [ | |
"bulkUpload" | |
], | |
"description": "List bulk upload batch jobs", | |
"operationId": "bulkUpload.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBulkUploadListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/bulkupload/action/serve": { | |
"post": { | |
"tags": [ | |
"bulkUpload" | |
], | |
"description": "serve action return the original file.", | |
"operationId": "bulkUpload.serve", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/bulkupload/action/serveLog": { | |
"post": { | |
"tags": [ | |
"bulkUpload" | |
], | |
"description": "serveLog action return the original file.", | |
"operationId": "bulkUpload.serveLog", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/bulkupload_bulk/action/abort": { | |
"post": { | |
"tags": [ | |
"bulk" | |
], | |
"description": "Aborts the bulk upload and all its child jobs", | |
"operationId": "bulk.abort", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBulkUpload" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/bulkupload_bulk/action/get": { | |
"post": { | |
"tags": [ | |
"bulk" | |
], | |
"description": "Get bulk upload batch job by id", | |
"operationId": "bulk.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBulkUpload" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/bulkupload_bulk/action/list": { | |
"post": { | |
"tags": [ | |
"bulk" | |
], | |
"description": "List bulk upload batch jobs", | |
"operationId": "bulk.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"bulkUploadFilter": { | |
"$ref": "#/components/schemas/KalturaBulkUploadFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBulkUploadListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"bulkUploadFilter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/bulkupload_bulk/action/serve": { | |
"post": { | |
"tags": [ | |
"bulk" | |
], | |
"description": "serve action returns the original file.", | |
"operationId": "bulk.serve", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/bulkupload_bulk/action/serveLog": { | |
"post": { | |
"tags": [ | |
"bulk" | |
], | |
"description": "serveLog action returns the log file for the bulk-upload job.", | |
"operationId": "bulk.serveLog", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/bumper_bumper/action/add": { | |
"post": { | |
"tags": [ | |
"bumper" | |
], | |
"description": "Adds a bumper to an entry", | |
"operationId": "bumper.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"bumper", | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"bumper": { | |
"$ref": "#/components/schemas/KalturaBumper" | |
}, | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBumper" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"bumper" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/bumper_bumper/action/delete": { | |
"post": { | |
"tags": [ | |
"bumper" | |
], | |
"description": "Delete bumper by EntryId", | |
"operationId": "bumper.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBumper" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/bumper_bumper/action/get": { | |
"post": { | |
"tags": [ | |
"bumper" | |
], | |
"description": "Allows to get the bumper", | |
"operationId": "bumper.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBumper" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/bumper_bumper/action/update": { | |
"post": { | |
"tags": [ | |
"bumper" | |
], | |
"description": "Allows to update a bumper", | |
"operationId": "bumper.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"bumper", | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"bumper": { | |
"$ref": "#/components/schemas/KalturaBumper" | |
}, | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBumper" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"bumper" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/businessprocessnotification_businessprocesscase/action/abort": { | |
"post": { | |
"tags": [ | |
"businessProcessCase" | |
], | |
"description": "Abort business-process case", | |
"operationId": "businessProcessCase.abort", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"businessProcessStartNotificationTemplateId", | |
"objectId", | |
"objectType" | |
], | |
"type": "object", | |
"properties": { | |
"businessProcessStartNotificationTemplateId": { | |
"type": "integer" | |
}, | |
"objectId": { | |
"type": "string" | |
}, | |
"objectType": { | |
"type": "string", | |
"enum": [ | |
"adCuePointEventNotifications.AdCuePoint", | |
"annotationEventNotifications.Annotation", | |
"attachmentAssetEventNotifications.AttachmentAsset", | |
"captionAssetEventNotifications.CaptionAsset", | |
"codeCuePointEventNotifications.CodeCuePoint", | |
"contentDistributionEventNotifications.DistributionProfile", | |
"contentDistributionEventNotifications.EntryDistribution", | |
"cuePointEventNotifications.CuePoint", | |
"dropFolderEventNotifications.DropFolder", | |
"dropFolderEventNotifications.DropFolderFile", | |
"metadataEventNotifications.Metadata", | |
"transcriptAssetEventNotifications.TranscriptAsset", | |
"1", | |
"2", | |
"3", | |
"4", | |
"5", | |
"8", | |
"9", | |
"10", | |
"11", | |
"12", | |
"14", | |
"15", | |
"16", | |
"17", | |
"18", | |
"19", | |
"20", | |
"21", | |
"22", | |
"23", | |
"24", | |
"25", | |
"26", | |
"27", | |
"28", | |
"29", | |
"31", | |
"32", | |
"33", | |
"34", | |
"35", | |
"36", | |
"37", | |
"38", | |
"39", | |
"40", | |
"41", | |
"42" | |
], | |
"x-enumLabels": [ | |
"AD_CUE_POINT", | |
"ANNOTATION", | |
"ATTACHMENT_ASSET", | |
"CAPTION_ASSET", | |
"CODE_CUE_POINT", | |
"DISTRIBUTION_PROFILE", | |
"ENTRY_DISTRIBUTION", | |
"CUE_POINT", | |
"DROP_FOLDER", | |
"DROP_FOLDER_FILE", | |
"METADATA", | |
"TRANSCRIPT_ASSET", | |
"ENTRY", | |
"CATEGORY", | |
"ASSET", | |
"FLAVORASSET", | |
"THUMBASSET", | |
"KUSER", | |
"ACCESSCONTROL", | |
"BATCHJOB", | |
"BULKUPLOADRESULT", | |
"CATEGORYKUSER", | |
"CONVERSIONPROFILE2", | |
"FLAVORPARAMS", | |
"FLAVORPARAMSCONVERSIONPROFILE", | |
"FLAVORPARAMSOUTPUT", | |
"GENERICSYNDICATIONFEED", | |
"KUSERTOUSERROLE", | |
"PARTNER", | |
"PERMISSION", | |
"PERMISSIONITEM", | |
"PERMISSIONTOPERMISSIONITEM", | |
"SCHEDULER", | |
"SCHEDULERCONFIG", | |
"SCHEDULERSTATUS", | |
"SCHEDULERWORKER", | |
"STORAGEPROFILE", | |
"SYNDICATIONFEED", | |
"THUMBPARAMS", | |
"THUMBPARAMSOUTPUT", | |
"UPLOADTOKEN", | |
"USERLOGINDATA", | |
"USERROLE", | |
"WIDGET", | |
"CATEGORYENTRY", | |
"LIVE_STREAM", | |
"SERVER_NODE", | |
"ENTRY_SERVER_NODE", | |
"REACH_PROFILE", | |
"ENTRY_VENDOR_TASK" | |
], | |
"x-enumType": "KalturaEventNotificationEventObjectType" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"objectType", | |
"objectId", | |
"businessProcessStartNotificationTemplateId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/businessprocessnotification_businessprocesscase/action/list": { | |
"post": { | |
"tags": [ | |
"businessProcessCase" | |
], | |
"description": "list business-process cases", | |
"operationId": "businessProcessCase.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"objectId", | |
"objectType" | |
], | |
"type": "object", | |
"properties": { | |
"objectId": { | |
"type": "string" | |
}, | |
"objectType": { | |
"type": "string", | |
"enum": [ | |
"adCuePointEventNotifications.AdCuePoint", | |
"annotationEventNotifications.Annotation", | |
"attachmentAssetEventNotifications.AttachmentAsset", | |
"captionAssetEventNotifications.CaptionAsset", | |
"codeCuePointEventNotifications.CodeCuePoint", | |
"contentDistributionEventNotifications.DistributionProfile", | |
"contentDistributionEventNotifications.EntryDistribution", | |
"cuePointEventNotifications.CuePoint", | |
"dropFolderEventNotifications.DropFolder", | |
"dropFolderEventNotifications.DropFolderFile", | |
"metadataEventNotifications.Metadata", | |
"transcriptAssetEventNotifications.TranscriptAsset", | |
"1", | |
"2", | |
"3", | |
"4", | |
"5", | |
"8", | |
"9", | |
"10", | |
"11", | |
"12", | |
"14", | |
"15", | |
"16", | |
"17", | |
"18", | |
"19", | |
"20", | |
"21", | |
"22", | |
"23", | |
"24", | |
"25", | |
"26", | |
"27", | |
"28", | |
"29", | |
"31", | |
"32", | |
"33", | |
"34", | |
"35", | |
"36", | |
"37", | |
"38", | |
"39", | |
"40", | |
"41", | |
"42" | |
], | |
"x-enumLabels": [ | |
"AD_CUE_POINT", | |
"ANNOTATION", | |
"ATTACHMENT_ASSET", | |
"CAPTION_ASSET", | |
"CODE_CUE_POINT", | |
"DISTRIBUTION_PROFILE", | |
"ENTRY_DISTRIBUTION", | |
"CUE_POINT", | |
"DROP_FOLDER", | |
"DROP_FOLDER_FILE", | |
"METADATA", | |
"TRANSCRIPT_ASSET", | |
"ENTRY", | |
"CATEGORY", | |
"ASSET", | |
"FLAVORASSET", | |
"THUMBASSET", | |
"KUSER", | |
"ACCESSCONTROL", | |
"BATCHJOB", | |
"BULKUPLOADRESULT", | |
"CATEGORYKUSER", | |
"CONVERSIONPROFILE2", | |
"FLAVORPARAMS", | |
"FLAVORPARAMSCONVERSIONPROFILE", | |
"FLAVORPARAMSOUTPUT", | |
"GENERICSYNDICATIONFEED", | |
"KUSERTOUSERROLE", | |
"PARTNER", | |
"PERMISSION", | |
"PERMISSIONITEM", | |
"PERMISSIONTOPERMISSIONITEM", | |
"SCHEDULER", | |
"SCHEDULERCONFIG", | |
"SCHEDULERSTATUS", | |
"SCHEDULERWORKER", | |
"STORAGEPROFILE", | |
"SYNDICATIONFEED", | |
"THUMBPARAMS", | |
"THUMBPARAMSOUTPUT", | |
"UPLOADTOKEN", | |
"USERLOGINDATA", | |
"USERROLE", | |
"WIDGET", | |
"CATEGORYENTRY", | |
"LIVE_STREAM", | |
"SERVER_NODE", | |
"ENTRY_SERVER_NODE", | |
"REACH_PROFILE", | |
"ENTRY_VENDOR_TASK" | |
], | |
"x-enumType": "KalturaEventNotificationEventObjectType" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/KalturaBusinessProcessCase" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"objectType", | |
"objectId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/businessprocessnotification_businessprocesscase/action/serveDiagram": { | |
"post": { | |
"tags": [ | |
"businessProcessCase" | |
], | |
"description": "Server business-process case diagram", | |
"operationId": "businessProcessCase.serveDiagram", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"businessProcessStartNotificationTemplateId", | |
"objectId", | |
"objectType" | |
], | |
"type": "object", | |
"properties": { | |
"businessProcessStartNotificationTemplateId": { | |
"type": "integer" | |
}, | |
"objectId": { | |
"type": "string" | |
}, | |
"objectType": { | |
"type": "string", | |
"enum": [ | |
"adCuePointEventNotifications.AdCuePoint", | |
"annotationEventNotifications.Annotation", | |
"attachmentAssetEventNotifications.AttachmentAsset", | |
"captionAssetEventNotifications.CaptionAsset", | |
"codeCuePointEventNotifications.CodeCuePoint", | |
"contentDistributionEventNotifications.DistributionProfile", | |
"contentDistributionEventNotifications.EntryDistribution", | |
"cuePointEventNotifications.CuePoint", | |
"dropFolderEventNotifications.DropFolder", | |
"dropFolderEventNotifications.DropFolderFile", | |
"metadataEventNotifications.Metadata", | |
"transcriptAssetEventNotifications.TranscriptAsset", | |
"1", | |
"2", | |
"3", | |
"4", | |
"5", | |
"8", | |
"9", | |
"10", | |
"11", | |
"12", | |
"14", | |
"15", | |
"16", | |
"17", | |
"18", | |
"19", | |
"20", | |
"21", | |
"22", | |
"23", | |
"24", | |
"25", | |
"26", | |
"27", | |
"28", | |
"29", | |
"31", | |
"32", | |
"33", | |
"34", | |
"35", | |
"36", | |
"37", | |
"38", | |
"39", | |
"40", | |
"41", | |
"42" | |
], | |
"x-enumLabels": [ | |
"AD_CUE_POINT", | |
"ANNOTATION", | |
"ATTACHMENT_ASSET", | |
"CAPTION_ASSET", | |
"CODE_CUE_POINT", | |
"DISTRIBUTION_PROFILE", | |
"ENTRY_DISTRIBUTION", | |
"CUE_POINT", | |
"DROP_FOLDER", | |
"DROP_FOLDER_FILE", | |
"METADATA", | |
"TRANSCRIPT_ASSET", | |
"ENTRY", | |
"CATEGORY", | |
"ASSET", | |
"FLAVORASSET", | |
"THUMBASSET", | |
"KUSER", | |
"ACCESSCONTROL", | |
"BATCHJOB", | |
"BULKUPLOADRESULT", | |
"CATEGORYKUSER", | |
"CONVERSIONPROFILE2", | |
"FLAVORPARAMS", | |
"FLAVORPARAMSCONVERSIONPROFILE", | |
"FLAVORPARAMSOUTPUT", | |
"GENERICSYNDICATIONFEED", | |
"KUSERTOUSERROLE", | |
"PARTNER", | |
"PERMISSION", | |
"PERMISSIONITEM", | |
"PERMISSIONTOPERMISSIONITEM", | |
"SCHEDULER", | |
"SCHEDULERCONFIG", | |
"SCHEDULERSTATUS", | |
"SCHEDULERWORKER", | |
"STORAGEPROFILE", | |
"SYNDICATIONFEED", | |
"THUMBPARAMS", | |
"THUMBPARAMSOUTPUT", | |
"UPLOADTOKEN", | |
"USERLOGINDATA", | |
"USERROLE", | |
"WIDGET", | |
"CATEGORYENTRY", | |
"LIVE_STREAM", | |
"SERVER_NODE", | |
"ENTRY_SERVER_NODE", | |
"REACH_PROFILE", | |
"ENTRY_VENDOR_TASK" | |
], | |
"x-enumType": "KalturaEventNotificationEventObjectType" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"objectType", | |
"objectId", | |
"businessProcessStartNotificationTemplateId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/businessprocessnotification_businessprocessserver/action/add": { | |
"post": { | |
"tags": [ | |
"businessProcessServer" | |
], | |
"description": "Allows you to add a new Business-Process server object", | |
"operationId": "businessProcessServer.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"businessProcessServer" | |
], | |
"type": "object", | |
"properties": { | |
"businessProcessServer": { | |
"$ref": "#/components/schemas/KalturaBusinessProcessServer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBusinessProcessServer" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"businessProcessServer" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/businessprocessnotification_businessprocessserver/action/delete": { | |
"post": { | |
"tags": [ | |
"businessProcessServer" | |
], | |
"description": "Delete an Business-Process server object", | |
"operationId": "businessProcessServer.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/businessprocessnotification_businessprocessserver/action/get": { | |
"post": { | |
"tags": [ | |
"businessProcessServer" | |
], | |
"description": "Retrieve an Business-Process server object by id", | |
"operationId": "businessProcessServer.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBusinessProcessServer" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/businessprocessnotification_businessprocessserver/action/list": { | |
"post": { | |
"tags": [ | |
"businessProcessServer" | |
], | |
"description": "list Business-Process server objects", | |
"operationId": "businessProcessServer.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaBusinessProcessServerFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBusinessProcessServerListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/businessprocessnotification_businessprocessserver/action/update": { | |
"post": { | |
"tags": [ | |
"businessProcessServer" | |
], | |
"description": "Update an existing Business-Process server object", | |
"operationId": "businessProcessServer.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"businessProcessServer", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"businessProcessServer": { | |
"$ref": "#/components/schemas/KalturaBusinessProcessServer" | |
}, | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBusinessProcessServer" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"businessProcessServer" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/businessprocessnotification_businessprocessserver/action/updateStatus": { | |
"post": { | |
"tags": [ | |
"businessProcessServer" | |
], | |
"description": "Update Business-Process server status by id", | |
"operationId": "businessProcessServer.updateStatus", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id", | |
"status" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
}, | |
"status": { | |
"type": "string", | |
"enum": [ | |
"1", | |
"2", | |
"3" | |
], | |
"x-enumLabels": [ | |
"DISABLED", | |
"ENABLED", | |
"DELETED" | |
], | |
"x-enumType": "KalturaBusinessProcessServerStatus" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBusinessProcessServer" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"status" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionasset/action/add": { | |
"post": { | |
"tags": [ | |
"captionAsset" | |
], | |
"description": "Add caption asset", | |
"operationId": "captionAsset.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"captionAsset", | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"captionAsset": { | |
"$ref": "#/components/schemas/KalturaCaptionAsset" | |
}, | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCaptionAsset" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"captionAsset" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionasset/action/delete": { | |
"post": { | |
"tags": [ | |
"captionAsset" | |
], | |
"operationId": "captionAsset.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"captionAssetId" | |
], | |
"type": "object", | |
"properties": { | |
"captionAssetId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"captionAssetId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionasset/action/export": { | |
"post": { | |
"tags": [ | |
"captionAsset" | |
], | |
"description": "manually export an asset", | |
"operationId": "captionAsset.export", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"assetId", | |
"storageProfileId" | |
], | |
"type": "object", | |
"properties": { | |
"assetId": { | |
"type": "string" | |
}, | |
"storageProfileId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaFlavorAsset" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"assetId", | |
"storageProfileId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionasset/action/get": { | |
"post": { | |
"tags": [ | |
"captionAsset" | |
], | |
"operationId": "captionAsset.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"captionAssetId" | |
], | |
"type": "object", | |
"properties": { | |
"captionAssetId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCaptionAsset" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"captionAssetId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionasset/action/getRemotePaths": { | |
"post": { | |
"tags": [ | |
"captionAsset" | |
], | |
"description": "Get remote storage existing paths for the asset", | |
"operationId": "captionAsset.getRemotePaths", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaRemotePathListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionasset/action/getUrl": { | |
"post": { | |
"tags": [ | |
"captionAsset" | |
], | |
"description": "Get download URL for the asset", | |
"operationId": "captionAsset.getUrl", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string" | |
}, | |
"storageId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"storageId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionasset/action/list": { | |
"post": { | |
"tags": [ | |
"captionAsset" | |
], | |
"description": "List caption Assets by filter and pager", | |
"operationId": "captionAsset.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaAssetFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCaptionAssetListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionasset/action/serve": { | |
"post": { | |
"tags": [ | |
"captionAsset" | |
], | |
"description": "Serves caption by its id", | |
"operationId": "captionAsset.serve", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"captionAssetId" | |
], | |
"type": "object", | |
"properties": { | |
"captionAssetId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"captionAssetId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionasset/action/serveAsJson": { | |
"post": { | |
"tags": [ | |
"captionAsset" | |
], | |
"description": "Serves caption file as Json by its ID", | |
"operationId": "captionAsset.serveAsJson", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"captionAssetId" | |
], | |
"type": "object", | |
"properties": { | |
"captionAssetId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"captionAssetId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionasset/action/serveByEntryId": { | |
"post": { | |
"tags": [ | |
"captionAsset" | |
], | |
"description": "Serves caption by entry id and thumnail params id", | |
"operationId": "captionAsset.serveByEntryId", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"captionParamId": { | |
"type": "integer" | |
}, | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"captionParamId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionasset/action/serveWebVTT": { | |
"post": { | |
"tags": [ | |
"captionAsset" | |
], | |
"description": "Serves caption by its id converting it to segmented WebVTT", | |
"operationId": "captionAsset.serveWebVTT", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"captionAssetId" | |
], | |
"type": "object", | |
"properties": { | |
"captionAssetId": { | |
"type": "string" | |
}, | |
"localTimestamp": { | |
"type": "integer" | |
}, | |
"segmentDuration": { | |
"type": "integer" | |
}, | |
"segmentIndex": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"captionAssetId", | |
"segmentDuration", | |
"segmentIndex", | |
"localTimestamp" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionasset/action/setAsDefault": { | |
"post": { | |
"tags": [ | |
"captionAsset" | |
], | |
"description": "Markss the caption as default and removes that mark from all other caption assets of the entry.", | |
"operationId": "captionAsset.setAsDefault", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"captionAssetId" | |
], | |
"type": "object", | |
"properties": { | |
"captionAssetId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"captionAssetId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionasset/action/setContent": { | |
"post": { | |
"tags": [ | |
"captionAsset" | |
], | |
"description": "Update content of caption asset", | |
"operationId": "captionAsset.setContent", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"contentResource", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"contentResource": { | |
"$ref": "#/components/schemas/KalturaContentResource" | |
}, | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCaptionAsset" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"contentResource" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionasset/action/update": { | |
"post": { | |
"tags": [ | |
"captionAsset" | |
], | |
"description": "Update caption asset", | |
"operationId": "captionAsset.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"captionAsset", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"captionAsset": { | |
"$ref": "#/components/schemas/KalturaCaptionAsset" | |
}, | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCaptionAsset" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"captionAsset" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionparams/action/add": { | |
"post": { | |
"tags": [ | |
"captionParams" | |
], | |
"description": "Add new Caption Params", | |
"operationId": "captionParams.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"captionParams" | |
], | |
"type": "object", | |
"properties": { | |
"captionParams": { | |
"$ref": "#/components/schemas/KalturaCaptionParams" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCaptionParams" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"captionParams" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionparams/action/delete": { | |
"post": { | |
"tags": [ | |
"captionParams" | |
], | |
"description": "Delete Caption Params by ID", | |
"operationId": "captionParams.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionparams/action/get": { | |
"post": { | |
"tags": [ | |
"captionParams" | |
], | |
"description": "Get Caption Params by ID", | |
"operationId": "captionParams.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCaptionParams" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionparams/action/list": { | |
"post": { | |
"tags": [ | |
"captionParams" | |
], | |
"description": "List Caption Params by filter with paging support (By default - all system default params will be listed too)", | |
"operationId": "captionParams.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaCaptionParamsFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCaptionParamsListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/caption_captionparams/action/update": { | |
"post": { | |
"tags": [ | |
"captionParams" | |
], | |
"description": "Update Caption Params by ID", | |
"operationId": "captionParams.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"captionParams", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"captionParams": { | |
"$ref": "#/components/schemas/KalturaCaptionParams" | |
}, | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCaptionParams" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"captionParams" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/captionsearch_captionassetitem/action/list": { | |
"post": { | |
"tags": [ | |
"captionAssetItem" | |
], | |
"description": "List caption asset items by filter and pager", | |
"operationId": "captionAssetItem.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"captionAssetId" | |
], | |
"type": "object", | |
"properties": { | |
"captionAssetId": { | |
"type": "string" | |
}, | |
"captionAssetItemFilter": { | |
"$ref": "#/components/schemas/KalturaCaptionAssetItemFilter" | |
}, | |
"captionAssetItemPager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCaptionAssetItemListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"captionAssetId", | |
"captionAssetItemFilter", | |
"captionAssetItemPager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/captionsearch_captionassetitem/action/parse": { | |
"post": { | |
"tags": [ | |
"captionAssetItem" | |
], | |
"description": "Parse content of caption asset and index it", | |
"operationId": "captionAssetItem.parse", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"captionAssetId" | |
], | |
"type": "object", | |
"properties": { | |
"captionAssetId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"captionAssetId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/captionsearch_captionassetitem/action/search": { | |
"post": { | |
"tags": [ | |
"captionAssetItem" | |
], | |
"description": "Search caption asset items by filter, pager and free text", | |
"operationId": "captionAssetItem.search", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"captionAssetItemFilter": { | |
"$ref": "#/components/schemas/KalturaCaptionAssetItemFilter" | |
}, | |
"captionAssetItemPager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
}, | |
"entryFilter": { | |
"$ref": "#/components/schemas/KalturaBaseEntryFilter" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCaptionAssetItemListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryFilter", | |
"captionAssetItemFilter", | |
"captionAssetItemPager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/captionsearch_captionassetitem/action/searchEntries": { | |
"post": { | |
"tags": [ | |
"captionAssetItem" | |
], | |
"description": "Search caption asset items by filter, pager and free text", | |
"operationId": "captionAssetItem.searchEntries", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"captionAssetItemFilter": { | |
"$ref": "#/components/schemas/KalturaCaptionAssetItemFilter" | |
}, | |
"captionAssetItemPager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
}, | |
"entryFilter": { | |
"$ref": "#/components/schemas/KalturaBaseEntryFilter" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBaseEntryListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryFilter", | |
"captionAssetItemFilter", | |
"captionAssetItemPager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/capturespace_capturespace/action/clientUpdates": { | |
"post": { | |
"tags": [ | |
"captureSpace" | |
], | |
"description": "Returns latest version and URL", | |
"operationId": "captureSpace.clientUpdates", | |
"parameters": [ | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"os", | |
"version" | |
], | |
"type": "object", | |
"properties": { | |
"hashAlgorithm": { | |
"type": "string", | |
"enum": [ | |
"md5", | |
"sha1", | |
"sha256", | |
"sha512" | |
], | |
"x-enumLabels": [ | |
"MD5", | |
"SHA1", | |
"SHA256", | |
"SHA512" | |
], | |
"x-enumType": "KalturaCaptureSpaceHashAlgorithm" | |
}, | |
"os": { | |
"type": "string" | |
}, | |
"version": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCaptureSpaceUpdateResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"os", | |
"version", | |
"hashAlgorithm" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/capturespace_capturespace/action/serveInstall": { | |
"post": { | |
"tags": [ | |
"captureSpace" | |
], | |
"description": "Serve installation file", | |
"operationId": "captureSpace.serveInstall", | |
"parameters": [ | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"os" | |
], | |
"type": "object", | |
"properties": { | |
"os": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"os" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/capturespace_capturespace/action/serveUpdate": { | |
"post": { | |
"tags": [ | |
"captureSpace" | |
], | |
"description": "Serve update file", | |
"operationId": "captureSpace.serveUpdate", | |
"parameters": [ | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"os", | |
"version" | |
], | |
"type": "object", | |
"properties": { | |
"os": { | |
"type": "string" | |
}, | |
"version": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"os", | |
"version" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/category/action/add": { | |
"post": { | |
"tags": [ | |
"category" | |
], | |
"description": "Add new Category", | |
"operationId": "category.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"category" | |
], | |
"type": "object", | |
"properties": { | |
"category": { | |
"$ref": "#/components/schemas/KalturaCategory" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCategory" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"category" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/category/action/addFromBulkUpload": { | |
"post": { | |
"tags": [ | |
"category" | |
], | |
"operationId": "category.addFromBulkUpload", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "bulkUploadData[objectType]", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"KalturaJobData", | |
"KalturaBulkDownloadJobData", | |
"KalturaBulkUploadJobData", | |
"KalturaCaptureThumbJobData", | |
"KalturaClipConcatJobData", | |
"KalturaConcatJobData", | |
"KalturaConvartableJobData", | |
"KalturaConvertCaptionAssetJobData", | |
"KalturaConvertLiveSegmentJobData", | |
"KalturaConvertProfileJobData", | |
"KalturaCopyCaptionsJobData", | |
"KalturaCopyJobData", | |
"KalturaCopyPartnerJobData", | |
"KalturaDeleteFileJobData", | |
"KalturaDeleteJobData", | |
"KalturaDistributionJobData", | |
"KalturaDropFolderContentProcessorJobData", | |
"KalturaEventNotificationDispatchJobData", | |
"KalturaExportCsvJobData", | |
"KalturaFlattenJobData", | |
"KalturaImportJobData", | |
"KalturaImportMetadataJobData", | |
"KalturaIndexJobData", | |
"KalturaIndexTagsByPrivacyContextJobData", | |
"KalturaIntegrationJobData", | |
"KalturaLiveEntryArchiveJobData", | |
"KalturaLiveReportExportJobData", | |
"KalturaLiveToVodJobData", | |
"KalturaMailJobData", | |
"KalturaMoveCategoryEntriesJobData", | |
"KalturaNotificationJobData", | |
"KalturaParseCaptionAssetJobData", | |
"KalturaParseMultiLanguageCaptionAssetJobData", | |
"KalturaProvisionJobData", | |
"KalturaReportExportJobData", | |
"KalturaScheduledTaskJobData", | |
"KalturaStorageJobData", | |
"KalturaSyncCategoryPrivacyContextJobData", | |
"KalturaTransformMetadataJobData", | |
"KalturaVirusScanJobData", | |
"KalturaWidevineRepositorySyncJobData", | |
"KalturaBulkUploadCsvJobData", | |
"KalturaBulkUploadFilterJobData", | |
"KalturaBulkUploadXmlJobData", | |
"KalturaBulkUploadICalJobData", | |
"KalturaBulkUploadScheduleEventCsvJobData", | |
"KalturaDropFolderXmlBulkUploadJobData", | |
"KalturaConvertCollectionJobData", | |
"KalturaConvertJobData", | |
"KalturaExtractMediaJobData", | |
"KalturaPostConvertJobData", | |
"KalturaDistributionDeleteJobData", | |
"KalturaDistributionFetchReportJobData", | |
"KalturaDistributionSubmitJobData", | |
"KalturaDistributionUpdateJobData", | |
"KalturaDistributionDisableJobData", | |
"KalturaDistributionEnableJobData", | |
"KalturaWebexDropFolderContentProcessorJobData", | |
"KalturaBusinessProcessNotificationDispatchJobData", | |
"KalturaEmailNotificationDispatchJobData", | |
"KalturaHttpNotificationDispatchJobData", | |
"KalturaEntryVendorTaskCsvJobData", | |
"KalturaMediaEsearchExportToCsvJobData", | |
"KalturaCategoriesCsvJobData", | |
"KalturaEntriesCsvJobData", | |
"KalturaUsersCsvJobData", | |
"KalturaSshImportJobData", | |
"KalturaDropFolderImportJobData", | |
"KalturaAkamaiProvisionJobData", | |
"KalturaAkamaiUniversalProvisionJobData", | |
"KalturaVelocixProvisionJobData", | |
"KalturaRecalculateResponseProfileCacheJobData", | |
"KalturaStorageDeleteJobData", | |
"KalturaStorageExportJobData", | |
"KalturaKontikiStorageDeleteJobData", | |
"KalturaAmazonS3StorageExportJobData", | |
"KalturaKontikiStorageExportJobData", | |
"KalturaBulkUploadScheduleEventJobData" | |
], | |
"x-group": "bulkUploadData" | |
}, | |
"x-group": "bulkUploadData" | |
}, | |
{ | |
"name": "bulkUploadData[fileName]", | |
"in": "query", | |
"description": "Friendly name of the file, used to be recognized later in the logs.", | |
"schema": { | |
"type": "string", | |
"x-group": "bulkUploadData" | |
}, | |
"x-group": "bulkUploadData" | |
}, | |
{ | |
"name": "bulkUploadData[objectData][objectType]", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"KalturaBulkUploadCategoryData", | |
"KalturaBulkUploadCategoryEntryData", | |
"KalturaBulkUploadCategoryUserData", | |
"KalturaBulkUploadEntryData", | |
"KalturaBulkUploadUserData", | |
"KalturaBulkUploadVendorCatalogItemData" | |
], | |
"x-group": "bulkUploadData[objectData]" | |
}, | |
"x-group": "bulkUploadData[objectData]" | |
}, | |
{ | |
"name": "bulkUploadData[emailRecipients]", | |
"in": "query", | |
"description": "Recipients of the email for bulk upload success/failure", | |
"schema": { | |
"type": "string", | |
"x-group": "bulkUploadData" | |
}, | |
"x-group": "bulkUploadData" | |
}, | |
{ | |
"name": "bulkUploadData[numOfErrorObjects]", | |
"in": "query", | |
"description": "Number of objects that finished on error status", | |
"schema": { | |
"type": "integer", | |
"x-group": "bulkUploadData" | |
}, | |
"x-group": "bulkUploadData" | |
}, | |
{ | |
"name": "bulkUploadData[privileges]", | |
"in": "query", | |
"description": "privileges for the job", | |
"schema": { | |
"type": "string", | |
"x-group": "bulkUploadData" | |
}, | |
"x-group": "bulkUploadData" | |
}, | |
{ | |
"name": "bulkUploadCategoryData[objectType]", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"KalturaBulkUploadCategoryData", | |
"KalturaBulkUploadCategoryEntryData", | |
"KalturaBulkUploadCategoryUserData", | |
"KalturaBulkUploadEntryData", | |
"KalturaBulkUploadUserData", | |
"KalturaBulkUploadVendorCatalogItemData" | |
], | |
"x-group": "bulkUploadCategoryData" | |
}, | |
"x-group": "bulkUploadCategoryData" | |
} | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"required": [ | |
"fileData" | |
], | |
"properties": { | |
"fileData": { | |
"type": "string", | |
"format": "binary" | |
} | |
} | |
} | |
} | |
}, | |
"required": true | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBulkUpload" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "file", | |
"x-kaltura-parameters": [ | |
"fileData", | |
"bulkUploadData", | |
"bulkUploadCategoryData" | |
], | |
"x-parameterGroups": [ | |
{ | |
"description": "Object Type: `KalturaBulkUploadJobData`", | |
"name": "bulkUploadData", | |
"schema": { | |
"$ref": "#/definitions/KalturaBulkUploadJobData" | |
}, | |
"subGroups": [ | |
{ | |
"name": "bulkUploadData[objectData]" | |
} | |
] | |
}, | |
{ | |
"description": "Object Type: `KalturaBulkUploadCategoryData`", | |
"name": "bulkUploadCategoryData", | |
"schema": { | |
"$ref": "#/definitions/KalturaBulkUploadCategoryData" | |
}, | |
"subGroups": [] | |
} | |
] | |
} | |
}, | |
"/service/category/action/clone": { | |
"post": { | |
"tags": [ | |
"category" | |
], | |
"description": "Clone Category", | |
"operationId": "category.clone", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"categoryId", | |
"fromPartnerId" | |
], | |
"type": "object", | |
"properties": { | |
"categoryId": { | |
"type": "integer" | |
}, | |
"fromPartnerId": { | |
"type": "integer" | |
}, | |
"parentCategoryId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCategory" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"categoryId", | |
"fromPartnerId", | |
"parentCategoryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/category/action/delete": { | |
"post": { | |
"tags": [ | |
"category" | |
], | |
"description": "Delete a Category", | |
"operationId": "category.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
}, | |
"moveEntriesToParentCategory": { | |
"type": "integer", | |
"x-enumLabels": [ | |
"NULL_VALUE", | |
"FALSE_VALUE", | |
"TRUE_VALUE" | |
], | |
"x-enumType": "KalturaNullableBoolean" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"moveEntriesToParentCategory" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/category/action/exportToCsv": { | |
"post": { | |
"tags": [ | |
"category" | |
], | |
"description": "Creates a batch job that sends an email with a link to download a CSV containing a list of categories", | |
"operationId": "category.exportToCsv", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"additionalFields": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/KalturaCsvAdditionalFieldInfo" | |
} | |
}, | |
"filter": { | |
"$ref": "#/components/schemas/KalturaCategoryFilter" | |
}, | |
"mappedFields": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/KalturaKeyValue" | |
} | |
}, | |
"metadataProfileId": { | |
"type": "integer" | |
}, | |
"options": { | |
"$ref": "#/components/schemas/KalturaExportToCsvOptions" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"metadataProfileId", | |
"additionalFields", | |
"mappedFields", | |
"options" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/category/action/get": { | |
"post": { | |
"tags": [ | |
"category" | |
], | |
"description": "Get Category by id", | |
"operationId": "category.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCategory" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/category/action/index": { | |
"post": { | |
"tags": [ | |
"category" | |
], | |
"description": "Index Category by id", | |
"operationId": "category.index", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
}, | |
"shouldUpdate": { | |
"type": "boolean", | |
"default": true | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"shouldUpdate" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/category/action/list": { | |
"post": { | |
"tags": [ | |
"category" | |
], | |
"description": "List all categories", | |
"operationId": "category.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaCategoryFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCategoryListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/category/action/move": { | |
"post": { | |
"tags": [ | |
"category" | |
], | |
"description": "Move categories that belong to the same parent category to a target category - enabled only for ks with disable entitlement", | |
"operationId": "category.move", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"categoryIds", | |
"targetCategoryParentId" | |
], | |
"type": "object", | |
"properties": { | |
"categoryIds": { | |
"type": "string" | |
}, | |
"targetCategoryParentId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "boolean" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"categoryIds", | |
"targetCategoryParentId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/category/action/unlockCategories": { | |
"post": { | |
"tags": [ | |
"category" | |
], | |
"description": "Unlock categories", | |
"operationId": "category.unlockCategories", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"responseProfile": { | |
"$ref": "#/components/schemas/KalturaBaseResponseProfile" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [], | |
"x-codegen-request-body-name": "responseProfile" | |
} | |
}, | |
"/service/category/action/update": { | |
"post": { | |
"tags": [ | |
"category" | |
], | |
"description": "Update Category", | |
"operationId": "category.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"category", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"category": { | |
"$ref": "#/components/schemas/KalturaCategory" | |
}, | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCategory" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"category" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/categoryentry/action/activate": { | |
"post": { | |
"tags": [ | |
"categoryEntry" | |
], | |
"description": "activate CategoryEntry when it is pending moderation", | |
"operationId": "categoryEntry.activate", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"categoryId", | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"categoryId": { | |
"type": "integer" | |
}, | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"categoryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/categoryentry/action/add": { | |
"post": { | |
"tags": [ | |
"categoryEntry" | |
], | |
"description": "Add new CategoryEntry", | |
"operationId": "categoryEntry.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"categoryEntry" | |
], | |
"type": "object", | |
"properties": { | |
"categoryEntry": { | |
"$ref": "#/components/schemas/KalturaCategoryEntry" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCategoryEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"categoryEntry" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/categoryentry/action/addFromBulkUpload": { | |
"post": { | |
"tags": [ | |
"categoryEntry" | |
], | |
"operationId": "categoryEntry.addFromBulkUpload", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"bulkUploadData" | |
], | |
"type": "object", | |
"properties": { | |
"bulkUploadCategoryEntryData": { | |
"$ref": "#/components/schemas/KalturaBulkUploadCategoryEntryData" | |
}, | |
"bulkUploadData": { | |
"$ref": "#/components/schemas/KalturaBulkServiceData" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBulkUpload" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"bulkUploadData", | |
"bulkUploadCategoryEntryData" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/categoryentry/action/delete": { | |
"post": { | |
"tags": [ | |
"categoryEntry" | |
], | |
"description": "Delete CategoryEntry", | |
"operationId": "categoryEntry.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"categoryId", | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"categoryId": { | |
"type": "integer" | |
}, | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"categoryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/categoryentry/action/index": { | |
"post": { | |
"tags": [ | |
"categoryEntry" | |
], | |
"description": "Index CategoryEntry by Id", | |
"operationId": "categoryEntry.index", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"categoryId", | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"categoryId": { | |
"type": "integer" | |
}, | |
"entryId": { | |
"type": "string" | |
}, | |
"shouldUpdate": { | |
"type": "boolean", | |
"default": true | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"categoryId", | |
"shouldUpdate" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/categoryentry/action/list": { | |
"post": { | |
"tags": [ | |
"categoryEntry" | |
], | |
"description": "List all categoryEntry", | |
"operationId": "categoryEntry.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaCategoryEntryFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCategoryEntryListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/categoryentry/action/reject": { | |
"post": { | |
"tags": [ | |
"categoryEntry" | |
], | |
"description": "activate CategoryEntry when it is pending moderation", | |
"operationId": "categoryEntry.reject", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"categoryId", | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"categoryId": { | |
"type": "integer" | |
}, | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"categoryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/categoryentry/action/syncPrivacyContext": { | |
"post": { | |
"tags": [ | |
"categoryEntry" | |
], | |
"description": "update privacy context from the category", | |
"operationId": "categoryEntry.syncPrivacyContext", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"categoryId", | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"categoryId": { | |
"type": "integer" | |
}, | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"categoryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/categoryentry/action/updateStatusFromBulk": { | |
"post": { | |
"tags": [ | |
"categoryEntry" | |
], | |
"operationId": "categoryEntry.updateStatusFromBulk", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "bulkUploadData[objectType]", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"KalturaJobData", | |
"KalturaBulkDownloadJobData", | |
"KalturaBulkUploadJobData", | |
"KalturaCaptureThumbJobData", | |
"KalturaClipConcatJobData", | |
"KalturaConcatJobData", | |
"KalturaConvartableJobData", | |
"KalturaConvertCaptionAssetJobData", | |
"KalturaConvertLiveSegmentJobData", | |
"KalturaConvertProfileJobData", | |
"KalturaCopyCaptionsJobData", | |
"KalturaCopyJobData", | |
"KalturaCopyPartnerJobData", | |
"KalturaDeleteFileJobData", | |
"KalturaDeleteJobData", | |
"KalturaDistributionJobData", | |
"KalturaDropFolderContentProcessorJobData", | |
"KalturaEventNotificationDispatchJobData", | |
"KalturaExportCsvJobData", | |
"KalturaFlattenJobData", | |
"KalturaImportJobData", | |
"KalturaImportMetadataJobData", | |
"KalturaIndexJobData", | |
"KalturaIndexTagsByPrivacyContextJobData", | |
"KalturaIntegrationJobData", | |
"KalturaLiveEntryArchiveJobData", | |
"KalturaLiveReportExportJobData", | |
"KalturaLiveToVodJobData", | |
"KalturaMailJobData", | |
"KalturaMoveCategoryEntriesJobData", | |
"KalturaNotificationJobData", | |
"KalturaParseCaptionAssetJobData", | |
"KalturaParseMultiLanguageCaptionAssetJobData", | |
"KalturaProvisionJobData", | |
"KalturaReportExportJobData", | |
"KalturaScheduledTaskJobData", | |
"KalturaStorageJobData", | |
"KalturaSyncCategoryPrivacyContextJobData", | |
"KalturaTransformMetadataJobData", | |
"KalturaVirusScanJobData", | |
"KalturaWidevineRepositorySyncJobData", | |
"KalturaBulkUploadCsvJobData", | |
"KalturaBulkUploadFilterJobData", | |
"KalturaBulkUploadXmlJobData", | |
"KalturaBulkUploadICalJobData", | |
"KalturaBulkUploadScheduleEventCsvJobData", | |
"KalturaDropFolderXmlBulkUploadJobData", | |
"KalturaConvertCollectionJobData", | |
"KalturaConvertJobData", | |
"KalturaExtractMediaJobData", | |
"KalturaPostConvertJobData", | |
"KalturaDistributionDeleteJobData", | |
"KalturaDistributionFetchReportJobData", | |
"KalturaDistributionSubmitJobData", | |
"KalturaDistributionUpdateJobData", | |
"KalturaDistributionDisableJobData", | |
"KalturaDistributionEnableJobData", | |
"KalturaWebexDropFolderContentProcessorJobData", | |
"KalturaBusinessProcessNotificationDispatchJobData", | |
"KalturaEmailNotificationDispatchJobData", | |
"KalturaHttpNotificationDispatchJobData", | |
"KalturaEntryVendorTaskCsvJobData", | |
"KalturaMediaEsearchExportToCsvJobData", | |
"KalturaCategoriesCsvJobData", | |
"KalturaEntriesCsvJobData", | |
"KalturaUsersCsvJobData", | |
"KalturaSshImportJobData", | |
"KalturaDropFolderImportJobData", | |
"KalturaAkamaiProvisionJobData", | |
"KalturaAkamaiUniversalProvisionJobData", | |
"KalturaVelocixProvisionJobData", | |
"KalturaRecalculateResponseProfileCacheJobData", | |
"KalturaStorageDeleteJobData", | |
"KalturaStorageExportJobData", | |
"KalturaKontikiStorageDeleteJobData", | |
"KalturaAmazonS3StorageExportJobData", | |
"KalturaKontikiStorageExportJobData", | |
"KalturaBulkUploadScheduleEventJobData" | |
], | |
"x-group": "bulkUploadData" | |
}, | |
"x-group": "bulkUploadData" | |
}, | |
{ | |
"name": "bulkUploadData[fileName]", | |
"in": "query", | |
"description": "Friendly name of the file, used to be recognized later in the logs.", | |
"schema": { | |
"type": "string", | |
"x-group": "bulkUploadData" | |
}, | |
"x-group": "bulkUploadData" | |
}, | |
{ | |
"name": "bulkUploadData[objectData][objectType]", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"KalturaBulkUploadCategoryData", | |
"KalturaBulkUploadCategoryEntryData", | |
"KalturaBulkUploadCategoryUserData", | |
"KalturaBulkUploadEntryData", | |
"KalturaBulkUploadUserData", | |
"KalturaBulkUploadVendorCatalogItemData" | |
], | |
"x-group": "bulkUploadData[objectData]" | |
}, | |
"x-group": "bulkUploadData[objectData]" | |
}, | |
{ | |
"name": "bulkUploadData[emailRecipients]", | |
"in": "query", | |
"description": "Recipients of the email for bulk upload success/failure", | |
"schema": { | |
"type": "string", | |
"x-group": "bulkUploadData" | |
}, | |
"x-group": "bulkUploadData" | |
}, | |
{ | |
"name": "bulkUploadData[numOfErrorObjects]", | |
"in": "query", | |
"description": "Number of objects that finished on error status", | |
"schema": { | |
"type": "integer", | |
"x-group": "bulkUploadData" | |
}, | |
"x-group": "bulkUploadData" | |
}, | |
{ | |
"name": "bulkUploadData[privileges]", | |
"in": "query", | |
"description": "privileges for the job", | |
"schema": { | |
"type": "string", | |
"x-group": "bulkUploadData" | |
}, | |
"x-group": "bulkUploadData" | |
}, | |
{ | |
"name": "bulkUploadCategoryEntryData[objectType]", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"KalturaBulkUploadCategoryData", | |
"KalturaBulkUploadCategoryEntryData", | |
"KalturaBulkUploadCategoryUserData", | |
"KalturaBulkUploadEntryData", | |
"KalturaBulkUploadUserData", | |
"KalturaBulkUploadVendorCatalogItemData" | |
], | |
"x-group": "bulkUploadCategoryEntryData" | |
}, | |
"x-group": "bulkUploadCategoryEntryData" | |
} | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"required": [ | |
"fileData" | |
], | |
"properties": { | |
"fileData": { | |
"type": "string", | |
"format": "binary" | |
} | |
} | |
} | |
} | |
}, | |
"required": true | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBulkUpload" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "file", | |
"x-kaltura-parameters": [ | |
"fileData", | |
"bulkUploadData", | |
"bulkUploadCategoryEntryData" | |
], | |
"x-parameterGroups": [ | |
{ | |
"description": "Object Type: `KalturaBulkUploadJobData`", | |
"name": "bulkUploadData", | |
"schema": { | |
"$ref": "#/definitions/KalturaBulkUploadJobData" | |
}, | |
"subGroups": [ | |
{ | |
"name": "bulkUploadData[objectData]" | |
} | |
] | |
}, | |
{ | |
"description": "Object Type: `KalturaBulkUploadCategoryEntryData`", | |
"name": "bulkUploadCategoryEntryData", | |
"schema": { | |
"$ref": "#/definitions/KalturaBulkUploadCategoryEntryData" | |
}, | |
"subGroups": [] | |
} | |
] | |
} | |
}, | |
"/service/categoryuser/action/activate": { | |
"post": { | |
"tags": [ | |
"categoryUser" | |
], | |
"description": "activate CategoryUser", | |
"operationId": "categoryUser.activate", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"categoryId", | |
"userId" | |
], | |
"type": "object", | |
"properties": { | |
"categoryId": { | |
"type": "integer" | |
}, | |
"userId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCategoryUser" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"categoryId", | |
"userId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/categoryuser/action/add": { | |
"post": { | |
"tags": [ | |
"categoryUser" | |
], | |
"description": "Add new CategoryUser", | |
"operationId": "categoryUser.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"categoryUser" | |
], | |
"type": "object", | |
"properties": { | |
"categoryUser": { | |
"$ref": "#/components/schemas/KalturaCategoryUser" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCategoryUser" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"categoryUser" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/categoryuser/action/addFromBulkUpload": { | |
"post": { | |
"tags": [ | |
"categoryUser" | |
], | |
"operationId": "categoryUser.addFromBulkUpload", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "bulkUploadData[objectType]", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"KalturaJobData", | |
"KalturaBulkDownloadJobData", | |
"KalturaBulkUploadJobData", | |
"KalturaCaptureThumbJobData", | |
"KalturaClipConcatJobData", | |
"KalturaConcatJobData", | |
"KalturaConvartableJobData", | |
"KalturaConvertCaptionAssetJobData", | |
"KalturaConvertLiveSegmentJobData", | |
"KalturaConvertProfileJobData", | |
"KalturaCopyCaptionsJobData", | |
"KalturaCopyJobData", | |
"KalturaCopyPartnerJobData", | |
"KalturaDeleteFileJobData", | |
"KalturaDeleteJobData", | |
"KalturaDistributionJobData", | |
"KalturaDropFolderContentProcessorJobData", | |
"KalturaEventNotificationDispatchJobData", | |
"KalturaExportCsvJobData", | |
"KalturaFlattenJobData", | |
"KalturaImportJobData", | |
"KalturaImportMetadataJobData", | |
"KalturaIndexJobData", | |
"KalturaIndexTagsByPrivacyContextJobData", | |
"KalturaIntegrationJobData", | |
"KalturaLiveEntryArchiveJobData", | |
"KalturaLiveReportExportJobData", | |
"KalturaLiveToVodJobData", | |
"KalturaMailJobData", | |
"KalturaMoveCategoryEntriesJobData", | |
"KalturaNotificationJobData", | |
"KalturaParseCaptionAssetJobData", | |
"KalturaParseMultiLanguageCaptionAssetJobData", | |
"KalturaProvisionJobData", | |
"KalturaReportExportJobData", | |
"KalturaScheduledTaskJobData", | |
"KalturaStorageJobData", | |
"KalturaSyncCategoryPrivacyContextJobData", | |
"KalturaTransformMetadataJobData", | |
"KalturaVirusScanJobData", | |
"KalturaWidevineRepositorySyncJobData", | |
"KalturaBulkUploadCsvJobData", | |
"KalturaBulkUploadFilterJobData", | |
"KalturaBulkUploadXmlJobData", | |
"KalturaBulkUploadICalJobData", | |
"KalturaBulkUploadScheduleEventCsvJobData", | |
"KalturaDropFolderXmlBulkUploadJobData", | |
"KalturaConvertCollectionJobData", | |
"KalturaConvertJobData", | |
"KalturaExtractMediaJobData", | |
"KalturaPostConvertJobData", | |
"KalturaDistributionDeleteJobData", | |
"KalturaDistributionFetchReportJobData", | |
"KalturaDistributionSubmitJobData", | |
"KalturaDistributionUpdateJobData", | |
"KalturaDistributionDisableJobData", | |
"KalturaDistributionEnableJobData", | |
"KalturaWebexDropFolderContentProcessorJobData", | |
"KalturaBusinessProcessNotificationDispatchJobData", | |
"KalturaEmailNotificationDispatchJobData", | |
"KalturaHttpNotificationDispatchJobData", | |
"KalturaEntryVendorTaskCsvJobData", | |
"KalturaMediaEsearchExportToCsvJobData", | |
"KalturaCategoriesCsvJobData", | |
"KalturaEntriesCsvJobData", | |
"KalturaUsersCsvJobData", | |
"KalturaSshImportJobData", | |
"KalturaDropFolderImportJobData", | |
"KalturaAkamaiProvisionJobData", | |
"KalturaAkamaiUniversalProvisionJobData", | |
"KalturaVelocixProvisionJobData", | |
"KalturaRecalculateResponseProfileCacheJobData", | |
"KalturaStorageDeleteJobData", | |
"KalturaStorageExportJobData", | |
"KalturaKontikiStorageDeleteJobData", | |
"KalturaAmazonS3StorageExportJobData", | |
"KalturaKontikiStorageExportJobData", | |
"KalturaBulkUploadScheduleEventJobData" | |
], | |
"x-group": "bulkUploadData" | |
}, | |
"x-group": "bulkUploadData" | |
}, | |
{ | |
"name": "bulkUploadData[fileName]", | |
"in": "query", | |
"description": "Friendly name of the file, used to be recognized later in the logs.", | |
"schema": { | |
"type": "string", | |
"x-group": "bulkUploadData" | |
}, | |
"x-group": "bulkUploadData" | |
}, | |
{ | |
"name": "bulkUploadData[objectData][objectType]", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"KalturaBulkUploadCategoryData", | |
"KalturaBulkUploadCategoryEntryData", | |
"KalturaBulkUploadCategoryUserData", | |
"KalturaBulkUploadEntryData", | |
"KalturaBulkUploadUserData", | |
"KalturaBulkUploadVendorCatalogItemData" | |
], | |
"x-group": "bulkUploadData[objectData]" | |
}, | |
"x-group": "bulkUploadData[objectData]" | |
}, | |
{ | |
"name": "bulkUploadData[emailRecipients]", | |
"in": "query", | |
"description": "Recipients of the email for bulk upload success/failure", | |
"schema": { | |
"type": "string", | |
"x-group": "bulkUploadData" | |
}, | |
"x-group": "bulkUploadData" | |
}, | |
{ | |
"name": "bulkUploadData[numOfErrorObjects]", | |
"in": "query", | |
"description": "Number of objects that finished on error status", | |
"schema": { | |
"type": "integer", | |
"x-group": "bulkUploadData" | |
}, | |
"x-group": "bulkUploadData" | |
}, | |
{ | |
"name": "bulkUploadData[privileges]", | |
"in": "query", | |
"description": "privileges for the job", | |
"schema": { | |
"type": "string", | |
"x-group": "bulkUploadData" | |
}, | |
"x-group": "bulkUploadData" | |
}, | |
{ | |
"name": "bulkUploadCategoryUserData[objectType]", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"KalturaBulkUploadCategoryData", | |
"KalturaBulkUploadCategoryEntryData", | |
"KalturaBulkUploadCategoryUserData", | |
"KalturaBulkUploadEntryData", | |
"KalturaBulkUploadUserData", | |
"KalturaBulkUploadVendorCatalogItemData" | |
], | |
"x-group": "bulkUploadCategoryUserData" | |
}, | |
"x-group": "bulkUploadCategoryUserData" | |
} | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"required": [ | |
"fileData" | |
], | |
"properties": { | |
"fileData": { | |
"type": "string", | |
"format": "binary" | |
} | |
} | |
} | |
} | |
}, | |
"required": true | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaBulkUpload" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "file", | |
"x-kaltura-parameters": [ | |
"fileData", | |
"bulkUploadData", | |
"bulkUploadCategoryUserData" | |
], | |
"x-parameterGroups": [ | |
{ | |
"description": "Object Type: `KalturaBulkUploadJobData`", | |
"name": "bulkUploadData", | |
"schema": { | |
"$ref": "#/definitions/KalturaBulkUploadJobData" | |
}, | |
"subGroups": [ | |
{ | |
"name": "bulkUploadData[objectData]" | |
} | |
] | |
}, | |
{ | |
"description": "Object Type: `KalturaBulkUploadCategoryUserData`", | |
"name": "bulkUploadCategoryUserData", | |
"schema": { | |
"$ref": "#/definitions/KalturaBulkUploadCategoryUserData" | |
}, | |
"subGroups": [] | |
} | |
] | |
} | |
}, | |
"/service/categoryuser/action/copyFromCategory": { | |
"post": { | |
"tags": [ | |
"categoryUser" | |
], | |
"description": "Copy all member from parent category", | |
"operationId": "categoryUser.copyFromCategory", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"categoryId" | |
], | |
"type": "object", | |
"properties": { | |
"categoryId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"categoryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/categoryuser/action/deactivate": { | |
"post": { | |
"tags": [ | |
"categoryUser" | |
], | |
"description": "reject CategoryUser", | |
"operationId": "categoryUser.deactivate", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"categoryId", | |
"userId" | |
], | |
"type": "object", | |
"properties": { | |
"categoryId": { | |
"type": "integer" | |
}, | |
"userId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCategoryUser" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"categoryId", | |
"userId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/categoryuser/action/delete": { | |
"post": { | |
"tags": [ | |
"categoryUser" | |
], | |
"description": "Delete a CategoryUser", | |
"operationId": "categoryUser.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"categoryId", | |
"userId" | |
], | |
"type": "object", | |
"properties": { | |
"categoryId": { | |
"type": "integer" | |
}, | |
"userId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"categoryId", | |
"userId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/categoryuser/action/get": { | |
"post": { | |
"tags": [ | |
"categoryUser" | |
], | |
"description": "Get CategoryUser by id", | |
"operationId": "categoryUser.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"categoryId", | |
"userId" | |
], | |
"type": "object", | |
"properties": { | |
"categoryId": { | |
"type": "integer" | |
}, | |
"userId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCategoryUser" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"categoryId", | |
"userId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/categoryuser/action/index": { | |
"post": { | |
"tags": [ | |
"categoryUser" | |
], | |
"description": "Index CategoryUser by userid and category id", | |
"operationId": "categoryUser.index", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"categoryId", | |
"userId" | |
], | |
"type": "object", | |
"properties": { | |
"categoryId": { | |
"type": "integer" | |
}, | |
"shouldUpdate": { | |
"type": "boolean", | |
"default": true | |
}, | |
"userId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"userId", | |
"categoryId", | |
"shouldUpdate" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/categoryuser/action/list": { | |
"post": { | |
"tags": [ | |
"categoryUser" | |
], | |
"description": "List all categories", | |
"operationId": "categoryUser.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaCategoryUserFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCategoryUserListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/categoryuser/action/update": { | |
"post": { | |
"tags": [ | |
"categoryUser" | |
], | |
"description": "Update CategoryUser by id", | |
"operationId": "categoryUser.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"categoryId", | |
"categoryUser", | |
"userId" | |
], | |
"type": "object", | |
"properties": { | |
"categoryId": { | |
"type": "integer" | |
}, | |
"categoryUser": { | |
"$ref": "#/components/schemas/KalturaCategoryUser" | |
}, | |
"override": { | |
"type": "boolean", | |
"default": false | |
}, | |
"userId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCategoryUser" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"categoryId", | |
"userId", | |
"categoryUser", | |
"override" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/comcastmrssdistribution_comcastmrss/action/getFeed": { | |
"post": { | |
"tags": [ | |
"comcastMrss" | |
], | |
"operationId": "comcastMrss.getFeed", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"distributionProfileId", | |
"hash" | |
], | |
"type": "object", | |
"properties": { | |
"distributionProfileId": { | |
"type": "integer" | |
}, | |
"hash": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"distributionProfileId", | |
"hash" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/confmaps_confmaps/action/add": { | |
"post": { | |
"tags": [ | |
"confMaps" | |
], | |
"description": "Add configuration map", | |
"operationId": "confMaps.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"map" | |
], | |
"type": "object", | |
"properties": { | |
"map": { | |
"$ref": "#/components/schemas/KalturaConfMaps" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaConfMaps" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"map" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/confmaps_confmaps/action/get": { | |
"post": { | |
"tags": [ | |
"confMaps" | |
], | |
"description": "Get configuration map", | |
"operationId": "confMaps.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"filter" | |
], | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaConfMapsFilter" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaConfMaps" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/confmaps_confmaps/action/getBatchMap": { | |
"post": { | |
"tags": [ | |
"confMaps" | |
], | |
"description": "Get batch configuration map", | |
"operationId": "confMaps.getBatchMap", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"hostName" | |
], | |
"type": "object", | |
"properties": { | |
"hostName": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"hostName" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/confmaps_confmaps/action/getCacheVersionId": { | |
"post": { | |
"tags": [ | |
"confMaps" | |
], | |
"description": "Get configuration map cache key", | |
"operationId": "confMaps.getCacheVersionId", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"responseProfile": { | |
"$ref": "#/components/schemas/KalturaBaseResponseProfile" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [], | |
"x-codegen-request-body-name": "responseProfile" | |
} | |
}, | |
"/service/confmaps_confmaps/action/getMapNames": { | |
"post": { | |
"tags": [ | |
"confMaps" | |
], | |
"description": "List configuration maps names", | |
"operationId": "confMaps.getMapNames", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"responseProfile": { | |
"$ref": "#/components/schemas/KalturaBaseResponseProfile" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/KalturaString" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [], | |
"x-codegen-request-body-name": "responseProfile" | |
} | |
}, | |
"/service/confmaps_confmaps/action/list": { | |
"post": { | |
"tags": [ | |
"confMaps" | |
], | |
"description": "List configuration maps", | |
"operationId": "confMaps.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"filter" | |
], | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaConfMapsFilter" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaConfMapsListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/confmaps_confmaps/action/update": { | |
"post": { | |
"tags": [ | |
"confMaps" | |
], | |
"description": "Update configuration map", | |
"operationId": "confMaps.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"map" | |
], | |
"type": "object", | |
"properties": { | |
"map": { | |
"$ref": "#/components/schemas/KalturaConfMaps" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaConfMaps" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"map" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_contentdistributionbatch/action/createRequiredJobs": { | |
"post": { | |
"tags": [ | |
"contentDistributionBatch" | |
], | |
"description": "creates all required jobs according to entry distribution dirty flags", | |
"operationId": "contentDistributionBatch.createRequiredJobs", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"responseProfile": { | |
"$ref": "#/components/schemas/KalturaBaseResponseProfile" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [], | |
"x-codegen-request-body-name": "responseProfile" | |
} | |
}, | |
"/service/contentdistribution_contentdistributionbatch/action/getAssetUrl": { | |
"post": { | |
"tags": [ | |
"contentDistributionBatch" | |
], | |
"description": "returns absolute valid url for asset file", | |
"operationId": "contentDistributionBatch.getAssetUrl", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"assetId" | |
], | |
"type": "object", | |
"properties": { | |
"assetId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"assetId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_contentdistributionbatch/action/updateSunStatus": { | |
"post": { | |
"tags": [ | |
"contentDistributionBatch" | |
], | |
"description": "updates entry distribution sun status in the search engine", | |
"operationId": "contentDistributionBatch.updateSunStatus", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"responseProfile": { | |
"$ref": "#/components/schemas/KalturaBaseResponseProfile" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [], | |
"x-codegen-request-body-name": "responseProfile" | |
} | |
}, | |
"/service/contentdistribution_distributionprofile/action/add": { | |
"post": { | |
"tags": [ | |
"distributionProfile" | |
], | |
"description": "Add new Distribution Profile", | |
"operationId": "distributionProfile.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"distributionProfile" | |
], | |
"type": "object", | |
"properties": { | |
"distributionProfile": { | |
"$ref": "#/components/schemas/KalturaDistributionProfile" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDistributionProfile" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"distributionProfile" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_distributionprofile/action/delete": { | |
"post": { | |
"tags": [ | |
"distributionProfile" | |
], | |
"description": "Delete Distribution Profile by id", | |
"operationId": "distributionProfile.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_distributionprofile/action/get": { | |
"post": { | |
"tags": [ | |
"distributionProfile" | |
], | |
"description": "Get Distribution Profile by id", | |
"operationId": "distributionProfile.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDistributionProfile" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_distributionprofile/action/list": { | |
"post": { | |
"tags": [ | |
"distributionProfile" | |
], | |
"description": "List all distribution providers", | |
"operationId": "distributionProfile.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaDistributionProfileFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDistributionProfileListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_distributionprofile/action/listByPartner": { | |
"post": { | |
"tags": [ | |
"distributionProfile" | |
], | |
"operationId": "distributionProfile.listByPartner", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaPartnerFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDistributionProfileListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_distributionprofile/action/update": { | |
"post": { | |
"tags": [ | |
"distributionProfile" | |
], | |
"description": "Update Distribution Profile by id", | |
"operationId": "distributionProfile.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"distributionProfile", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"distributionProfile": { | |
"$ref": "#/components/schemas/KalturaDistributionProfile" | |
}, | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDistributionProfile" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"distributionProfile" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_distributionprofile/action/updateStatus": { | |
"post": { | |
"tags": [ | |
"distributionProfile" | |
], | |
"description": "Update Distribution Profile status by id", | |
"operationId": "distributionProfile.updateStatus", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id", | |
"status" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
}, | |
"status": { | |
"type": "integer", | |
"x-enumLabels": [ | |
"DISABLED", | |
"ENABLED", | |
"DELETED" | |
], | |
"x-enumType": "KalturaDistributionProfileStatus" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDistributionProfile" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"status" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_distributionprovider/action/list": { | |
"post": { | |
"tags": [ | |
"distributionProvider" | |
], | |
"description": "List all distribution providers", | |
"operationId": "distributionProvider.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaDistributionProviderFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDistributionProviderListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_entrydistribution/action/add": { | |
"post": { | |
"tags": [ | |
"entryDistribution" | |
], | |
"description": "Add new Entry Distribution", | |
"operationId": "entryDistribution.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryDistribution" | |
], | |
"type": "object", | |
"properties": { | |
"entryDistribution": { | |
"$ref": "#/components/schemas/KalturaEntryDistribution" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaEntryDistribution" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryDistribution" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_entrydistribution/action/delete": { | |
"post": { | |
"tags": [ | |
"entryDistribution" | |
], | |
"description": "Delete Entry Distribution by id", | |
"operationId": "entryDistribution.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_entrydistribution/action/get": { | |
"post": { | |
"tags": [ | |
"entryDistribution" | |
], | |
"description": "Get Entry Distribution by id", | |
"operationId": "entryDistribution.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaEntryDistribution" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_entrydistribution/action/list": { | |
"post": { | |
"tags": [ | |
"entryDistribution" | |
], | |
"description": "List all distribution providers", | |
"operationId": "entryDistribution.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaEntryDistributionFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaEntryDistributionListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_entrydistribution/action/retrySubmit": { | |
"post": { | |
"tags": [ | |
"entryDistribution" | |
], | |
"description": "Retries last submit action", | |
"operationId": "entryDistribution.retrySubmit", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaEntryDistribution" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_entrydistribution/action/serveReturnedData": { | |
"post": { | |
"tags": [ | |
"entryDistribution" | |
], | |
"description": "Serves entry distribution returned data", | |
"operationId": "entryDistribution.serveReturnedData", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"actionType", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"actionType": { | |
"type": "integer", | |
"x-enumLabels": [ | |
"SUBMIT", | |
"UPDATE", | |
"DELETE", | |
"FETCH_REPORT" | |
], | |
"x-enumType": "KalturaDistributionAction" | |
}, | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"actionType" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_entrydistribution/action/serveSentData": { | |
"post": { | |
"tags": [ | |
"entryDistribution" | |
], | |
"description": "Serves entry distribution sent data", | |
"operationId": "entryDistribution.serveSentData", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"actionType", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"actionType": { | |
"type": "integer", | |
"x-enumLabels": [ | |
"SUBMIT", | |
"UPDATE", | |
"DELETE", | |
"FETCH_REPORT" | |
], | |
"x-enumType": "KalturaDistributionAction" | |
}, | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"actionType" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_entrydistribution/action/submitAdd": { | |
"post": { | |
"tags": [ | |
"entryDistribution" | |
], | |
"description": "Submits Entry Distribution to the remote destination", | |
"operationId": "entryDistribution.submitAdd", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
}, | |
"submitWhenReady": { | |
"type": "boolean", | |
"default": false | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaEntryDistribution" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"submitWhenReady" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_entrydistribution/action/submitDelete": { | |
"post": { | |
"tags": [ | |
"entryDistribution" | |
], | |
"description": "Deletes Entry Distribution from the remote destination", | |
"operationId": "entryDistribution.submitDelete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaEntryDistribution" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_entrydistribution/action/submitFetchReport": { | |
"post": { | |
"tags": [ | |
"entryDistribution" | |
], | |
"description": "Submits Entry Distribution report request", | |
"operationId": "entryDistribution.submitFetchReport", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaEntryDistribution" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_entrydistribution/action/submitUpdate": { | |
"post": { | |
"tags": [ | |
"entryDistribution" | |
], | |
"description": "Submits Entry Distribution changes to the remote destination", | |
"operationId": "entryDistribution.submitUpdate", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaEntryDistribution" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_entrydistribution/action/update": { | |
"post": { | |
"tags": [ | |
"entryDistribution" | |
], | |
"description": "Update Entry Distribution by id", | |
"operationId": "entryDistribution.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryDistribution", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"entryDistribution": { | |
"$ref": "#/components/schemas/KalturaEntryDistribution" | |
}, | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaEntryDistribution" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"entryDistribution" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_entrydistribution/action/validate": { | |
"post": { | |
"tags": [ | |
"entryDistribution" | |
], | |
"description": "Validates Entry Distribution by id for submission", | |
"operationId": "entryDistribution.validate", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaEntryDistribution" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovider/action/add": { | |
"post": { | |
"tags": [ | |
"genericDistributionProvider" | |
], | |
"description": "Add new Generic Distribution Provider", | |
"operationId": "genericDistributionProvider.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"genericDistributionProvider" | |
], | |
"type": "object", | |
"properties": { | |
"genericDistributionProvider": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProvider" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProvider" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"genericDistributionProvider" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovider/action/delete": { | |
"post": { | |
"tags": [ | |
"genericDistributionProvider" | |
], | |
"description": "Delete Generic Distribution Provider by id", | |
"operationId": "genericDistributionProvider.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovider/action/get": { | |
"post": { | |
"tags": [ | |
"genericDistributionProvider" | |
], | |
"description": "Get Generic Distribution Provider by id", | |
"operationId": "genericDistributionProvider.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProvider" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovider/action/list": { | |
"post": { | |
"tags": [ | |
"genericDistributionProvider" | |
], | |
"description": "List all distribution providers", | |
"operationId": "genericDistributionProvider.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovider/action/update": { | |
"post": { | |
"tags": [ | |
"genericDistributionProvider" | |
], | |
"description": "Update Generic Distribution Provider by id", | |
"operationId": "genericDistributionProvider.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"genericDistributionProvider", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"genericDistributionProvider": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProvider" | |
}, | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProvider" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"genericDistributionProvider" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovideraction/action/add": { | |
"post": { | |
"tags": [ | |
"genericDistributionProviderAction" | |
], | |
"description": "Add new Generic Distribution Provider Action", | |
"operationId": "genericDistributionProviderAction.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"genericDistributionProviderAction" | |
], | |
"type": "object", | |
"properties": { | |
"genericDistributionProviderAction": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderAction" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderAction" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"genericDistributionProviderAction" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovideraction/action/addMrssTransform": { | |
"post": { | |
"tags": [ | |
"genericDistributionProviderAction" | |
], | |
"description": "Add MRSS transform file to generic distribution provider action", | |
"operationId": "genericDistributionProviderAction.addMrssTransform", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id", | |
"xslData" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
}, | |
"xslData": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderAction" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"xslData" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovideraction/action/addMrssTransformFromFile": { | |
"post": { | |
"tags": [ | |
"genericDistributionProviderAction" | |
], | |
"description": "Add MRSS transform file to generic distribution provider action", | |
"operationId": "genericDistributionProviderAction.addMrssTransformFromFile", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "id", | |
"in": "query", | |
"description": "the id of the generic distribution provider action", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"required": [ | |
"xslFile" | |
], | |
"properties": { | |
"xslFile": { | |
"type": "string", | |
"description": "XSL MRSS transformation file", | |
"format": "binary" | |
} | |
} | |
} | |
} | |
}, | |
"required": true | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderAction" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "file", | |
"x-kaltura-parameters": [ | |
"id", | |
"xslFile" | |
] | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovideraction/action/addMrssValidate": { | |
"post": { | |
"tags": [ | |
"genericDistributionProviderAction" | |
], | |
"description": "Add MRSS validate file to generic distribution provider action", | |
"operationId": "genericDistributionProviderAction.addMrssValidate", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id", | |
"xsdData" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
}, | |
"xsdData": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderAction" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"xsdData" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovideraction/action/addMrssValidateFromFile": { | |
"post": { | |
"tags": [ | |
"genericDistributionProviderAction" | |
], | |
"description": "Add MRSS validate file to generic distribution provider action", | |
"operationId": "genericDistributionProviderAction.addMrssValidateFromFile", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "id", | |
"in": "query", | |
"description": "the id of the generic distribution provider action", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"required": [ | |
"xsdFile" | |
], | |
"properties": { | |
"xsdFile": { | |
"type": "string", | |
"description": "XSD MRSS validatation file", | |
"format": "binary" | |
} | |
} | |
} | |
} | |
}, | |
"required": true | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderAction" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "file", | |
"x-kaltura-parameters": [ | |
"id", | |
"xsdFile" | |
] | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovideraction/action/addResultsTransform": { | |
"post": { | |
"tags": [ | |
"genericDistributionProviderAction" | |
], | |
"description": "Add results transform file to generic distribution provider action", | |
"operationId": "genericDistributionProviderAction.addResultsTransform", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id", | |
"transformData" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
}, | |
"transformData": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderAction" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"transformData" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovideraction/action/addResultsTransformFromFile": { | |
"post": { | |
"tags": [ | |
"genericDistributionProviderAction" | |
], | |
"description": "Add MRSS transform file to generic distribution provider action", | |
"operationId": "genericDistributionProviderAction.addResultsTransformFromFile", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "id", | |
"in": "query", | |
"description": "the id of the generic distribution provider action", | |
"required": true, | |
"schema": { | |
"type": "integer" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"required": [ | |
"transformFile" | |
], | |
"properties": { | |
"transformFile": { | |
"type": "string", | |
"description": "transformation file xsl, xPath or regex", | |
"format": "binary" | |
} | |
} | |
} | |
} | |
}, | |
"required": true | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderAction" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "file", | |
"x-kaltura-parameters": [ | |
"id", | |
"transformFile" | |
] | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovideraction/action/delete": { | |
"post": { | |
"tags": [ | |
"genericDistributionProviderAction" | |
], | |
"description": "Delete Generic Distribution Provider Action by id", | |
"operationId": "genericDistributionProviderAction.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovideraction/action/deleteByProviderId": { | |
"post": { | |
"tags": [ | |
"genericDistributionProviderAction" | |
], | |
"description": "Delete Generic Distribution Provider Action by provider id", | |
"operationId": "genericDistributionProviderAction.deleteByProviderId", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"actionType", | |
"genericDistributionProviderId" | |
], | |
"type": "object", | |
"properties": { | |
"actionType": { | |
"type": "integer", | |
"x-enumLabels": [ | |
"SUBMIT", | |
"UPDATE", | |
"DELETE", | |
"FETCH_REPORT" | |
], | |
"x-enumType": "KalturaDistributionAction" | |
}, | |
"genericDistributionProviderId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"genericDistributionProviderId", | |
"actionType" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovideraction/action/get": { | |
"post": { | |
"tags": [ | |
"genericDistributionProviderAction" | |
], | |
"description": "Get Generic Distribution Provider Action by id", | |
"operationId": "genericDistributionProviderAction.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderAction" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovideraction/action/getByProviderId": { | |
"post": { | |
"tags": [ | |
"genericDistributionProviderAction" | |
], | |
"description": "Get Generic Distribution Provider Action by provider id", | |
"operationId": "genericDistributionProviderAction.getByProviderId", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"actionType", | |
"genericDistributionProviderId" | |
], | |
"type": "object", | |
"properties": { | |
"actionType": { | |
"type": "integer", | |
"x-enumLabels": [ | |
"SUBMIT", | |
"UPDATE", | |
"DELETE", | |
"FETCH_REPORT" | |
], | |
"x-enumType": "KalturaDistributionAction" | |
}, | |
"genericDistributionProviderId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderAction" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"genericDistributionProviderId", | |
"actionType" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovideraction/action/list": { | |
"post": { | |
"tags": [ | |
"genericDistributionProviderAction" | |
], | |
"description": "List all distribution providers", | |
"operationId": "genericDistributionProviderAction.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderActionFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderActionListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovideraction/action/update": { | |
"post": { | |
"tags": [ | |
"genericDistributionProviderAction" | |
], | |
"description": "Update Generic Distribution Provider Action by id", | |
"operationId": "genericDistributionProviderAction.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"genericDistributionProviderAction", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"genericDistributionProviderAction": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderAction" | |
}, | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderAction" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"genericDistributionProviderAction" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/contentdistribution_genericdistributionprovideraction/action/updateByProviderId": { | |
"post": { | |
"tags": [ | |
"genericDistributionProviderAction" | |
], | |
"description": "Update Generic Distribution Provider Action by provider id", | |
"operationId": "genericDistributionProviderAction.updateByProviderId", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"actionType", | |
"genericDistributionProviderAction", | |
"genericDistributionProviderId" | |
], | |
"type": "object", | |
"properties": { | |
"actionType": { | |
"type": "integer", | |
"x-enumLabels": [ | |
"SUBMIT", | |
"UPDATE", | |
"DELETE", | |
"FETCH_REPORT" | |
], | |
"x-enumType": "KalturaDistributionAction" | |
}, | |
"genericDistributionProviderAction": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderAction" | |
}, | |
"genericDistributionProviderId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaGenericDistributionProviderAction" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"genericDistributionProviderId", | |
"actionType", | |
"genericDistributionProviderAction" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/conversionprofile/action/add": { | |
"post": { | |
"tags": [ | |
"conversionProfile" | |
], | |
"description": "Add new Conversion Profile", | |
"operationId": "conversionProfile.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"conversionProfile" | |
], | |
"type": "object", | |
"properties": { | |
"conversionProfile": { | |
"$ref": "#/components/schemas/KalturaConversionProfile" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaConversionProfile" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"conversionProfile" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/conversionprofile/action/delete": { | |
"post": { | |
"tags": [ | |
"conversionProfile" | |
], | |
"description": "Delete Conversion Profile by ID", | |
"operationId": "conversionProfile.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/conversionprofile/action/get": { | |
"post": { | |
"tags": [ | |
"conversionProfile" | |
], | |
"description": "Get Conversion Profile by ID", | |
"operationId": "conversionProfile.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaConversionProfile" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/conversionprofile/action/getDefault": { | |
"post": { | |
"tags": [ | |
"conversionProfile" | |
], | |
"description": "Get the partner's default conversion profile", | |
"operationId": "conversionProfile.getDefault", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"1", | |
"2" | |
], | |
"x-enumLabels": [ | |
"MEDIA", | |
"LIVE_STREAM" | |
], | |
"x-enumType": "KalturaConversionProfileType" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaConversionProfile" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"type" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/conversionprofile/action/list": { | |
"post": { | |
"tags": [ | |
"conversionProfile" | |
], | |
"description": "List Conversion Profiles by filter with paging support", | |
"operationId": "conversionProfile.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaConversionProfileFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaConversionProfileListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/conversionprofile/action/setAsDefault": { | |
"post": { | |
"tags": [ | |
"conversionProfile" | |
], | |
"description": "Set Conversion Profile to be the partner default", | |
"operationId": "conversionProfile.setAsDefault", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaConversionProfile" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/conversionprofile/action/update": { | |
"post": { | |
"tags": [ | |
"conversionProfile" | |
], | |
"description": "Update Conversion Profile by ID", | |
"operationId": "conversionProfile.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"conversionProfile", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"conversionProfile": { | |
"$ref": "#/components/schemas/KalturaConversionProfile" | |
}, | |
"id": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaConversionProfile" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"conversionProfile" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/conversionprofileassetparams/action/list": { | |
"post": { | |
"tags": [ | |
"conversionProfileAssetParams" | |
], | |
"description": "Lists asset parmas of conversion profile by ID", | |
"operationId": "conversionProfileAssetParams.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaConversionProfileAssetParamsFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaConversionProfileAssetParamsListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/conversionprofileassetparams/action/update": { | |
"post": { | |
"tags": [ | |
"conversionProfileAssetParams" | |
], | |
"description": "Update asset parmas of conversion profile by ID", | |
"operationId": "conversionProfileAssetParams.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"assetParamsId", | |
"conversionProfileAssetParams", | |
"conversionProfileId" | |
], | |
"type": "object", | |
"properties": { | |
"assetParamsId": { | |
"type": "integer" | |
}, | |
"conversionProfileAssetParams": { | |
"$ref": "#/components/schemas/KalturaConversionProfileAssetParams" | |
}, | |
"conversionProfileId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaConversionProfileAssetParams" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"conversionProfileId", | |
"assetParamsId", | |
"conversionProfileAssetParams" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/cuepoint_cuepoint/action/add": { | |
"post": { | |
"tags": [ | |
"cuePoint" | |
], | |
"description": "Allows you to add an cue point object associated with an entry", | |
"operationId": "cuePoint.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"cuePoint" | |
], | |
"type": "object", | |
"properties": { | |
"cuePoint": { | |
"$ref": "#/components/schemas/KalturaCuePoint" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCuePoint" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"cuePoint" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/cuepoint_cuepoint/action/addFromBulk": { | |
"post": { | |
"tags": [ | |
"cuePoint" | |
], | |
"description": "Allows you to add multiple cue points objects by uploading XML that contains multiple cue point definitions", | |
"operationId": "cuePoint.addFromBulk", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
} | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"required": [ | |
"fileData" | |
], | |
"properties": { | |
"fileData": { | |
"type": "string", | |
"format": "binary" | |
} | |
} | |
} | |
} | |
}, | |
"required": true | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCuePointListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "file", | |
"x-kaltura-parameters": [ | |
"fileData" | |
] | |
} | |
}, | |
"/service/cuepoint_cuepoint/action/clone": { | |
"post": { | |
"tags": [ | |
"cuePoint" | |
], | |
"description": "Clone cuePoint with id to given entry", | |
"operationId": "cuePoint.clone", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
}, | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCuePoint" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"entryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/cuepoint_cuepoint/action/count": { | |
"post": { | |
"tags": [ | |
"cuePoint" | |
], | |
"description": "count cue point objects by filter", | |
"operationId": "cuePoint.count", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaCuePointFilter" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/cuepoint_cuepoint/action/delete": { | |
"post": { | |
"tags": [ | |
"cuePoint" | |
], | |
"description": "delete cue point by id, and delete all children cue points", | |
"operationId": "cuePoint.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/cuepoint_cuepoint/action/get": { | |
"post": { | |
"tags": [ | |
"cuePoint" | |
], | |
"description": "Retrieve an CuePoint object by id", | |
"operationId": "cuePoint.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCuePoint" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/cuepoint_cuepoint/action/list": { | |
"post": { | |
"tags": [ | |
"cuePoint" | |
], | |
"description": "List cue point objects by filter and pager", | |
"operationId": "cuePoint.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaCuePointFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCuePointListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/cuepoint_cuepoint/action/serveBulk": { | |
"post": { | |
"tags": [ | |
"cuePoint" | |
], | |
"description": "Download multiple cue points objects as XML definitions", | |
"operationId": "cuePoint.serveBulk", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaCuePointFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/cuepoint_cuepoint/action/update": { | |
"post": { | |
"tags": [ | |
"cuePoint" | |
], | |
"description": "Update cue point by id", | |
"operationId": "cuePoint.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"cuePoint", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"cuePoint": { | |
"$ref": "#/components/schemas/KalturaCuePoint" | |
}, | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCuePoint" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"cuePoint" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/cuepoint_cuepoint/action/updateCuePointsTimes": { | |
"post": { | |
"tags": [ | |
"cuePoint" | |
], | |
"operationId": "cuePoint.updateCuePointsTimes", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id", | |
"startTime" | |
], | |
"type": "object", | |
"properties": { | |
"endTime": { | |
"type": "integer" | |
}, | |
"id": { | |
"type": "string" | |
}, | |
"startTime": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaCuePoint" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"startTime", | |
"endTime" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/cuepoint_cuepoint/action/updateStatus": { | |
"post": { | |
"tags": [ | |
"cuePoint" | |
], | |
"description": "Update cuePoint status by id", | |
"operationId": "cuePoint.updateStatus", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id", | |
"status" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string" | |
}, | |
"status": { | |
"type": "integer", | |
"x-enumLabels": [ | |
"READY", | |
"DELETED", | |
"HANDLED", | |
"PENDING" | |
], | |
"x-enumType": "KalturaCuePointStatus" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"status" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/data/action/add": { | |
"post": { | |
"tags": [ | |
"data" | |
], | |
"description": "Adds a new data entry", | |
"operationId": "data.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"dataEntry" | |
], | |
"type": "object", | |
"properties": { | |
"dataEntry": { | |
"$ref": "#/components/schemas/KalturaDataEntry" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDataEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"dataEntry" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/data/action/addContent": { | |
"post": { | |
"tags": [ | |
"data" | |
], | |
"description": "Update the dataContent of data entry using a resource", | |
"operationId": "data.addContent", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId", | |
"resource" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
}, | |
"resource": { | |
"$ref": "#/components/schemas/KalturaGenericDataCenterContentResource" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"resource" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/data/action/delete": { | |
"post": { | |
"tags": [ | |
"data" | |
], | |
"description": "Delete a data entry.", | |
"operationId": "data.delete", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": {} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/data/action/get": { | |
"post": { | |
"tags": [ | |
"data" | |
], | |
"description": "Get data entry by ID.", | |
"operationId": "data.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
}, | |
"version": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDataEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"version" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/data/action/list": { | |
"post": { | |
"tags": [ | |
"data" | |
], | |
"description": "List data entries by filter with paging support.", | |
"operationId": "data.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaDataEntryFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDataListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/data/action/serve": { | |
"post": { | |
"tags": [ | |
"data" | |
], | |
"description": "return the file from dataContent field.", | |
"operationId": "data.serve", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
}, | |
"forceProxy": { | |
"type": "boolean", | |
"default": false | |
}, | |
"version": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"version", | |
"forceProxy" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/data/action/update": { | |
"post": { | |
"tags": [ | |
"data" | |
], | |
"description": "Update data entry. Only the properties that were set will be updated.", | |
"operationId": "data.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"documentEntry", | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"documentEntry": { | |
"$ref": "#/components/schemas/KalturaDataEntry" | |
}, | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDataEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId", | |
"documentEntry" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/deliveryprofile/action/add": { | |
"post": { | |
"tags": [ | |
"deliveryProfile" | |
], | |
"description": "Add new delivery.", | |
"operationId": "deliveryProfile.add", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"delivery" | |
], | |
"type": "object", | |
"properties": { | |
"delivery": { | |
"$ref": "#/components/schemas/KalturaDeliveryProfile" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDeliveryProfile" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"delivery" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/deliveryprofile/action/clone": { | |
"post": { | |
"tags": [ | |
"deliveryProfile" | |
], | |
"description": "Add delivery based on existing delivery.\n\nMust provide valid sourceDeliveryId", | |
"operationId": "deliveryProfile.clone", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"deliveryId" | |
], | |
"type": "object", | |
"properties": { | |
"deliveryId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDeliveryProfile" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"deliveryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/deliveryprofile/action/get": { | |
"post": { | |
"tags": [ | |
"deliveryProfile" | |
], | |
"description": "Get delivery by id", | |
"operationId": "deliveryProfile.get", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDeliveryProfile" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/deliveryprofile/action/list": { | |
"post": { | |
"tags": [ | |
"deliveryProfile" | |
], | |
"description": "Retrieve a list of available delivery depends on the filter given", | |
"operationId": "deliveryProfile.list", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"filter": { | |
"$ref": "#/components/schemas/KalturaDeliveryProfileFilter" | |
}, | |
"pager": { | |
"$ref": "#/components/schemas/KalturaFilterPager" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDeliveryProfileListResponse" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"filter", | |
"pager" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/deliveryprofile/action/update": { | |
"post": { | |
"tags": [ | |
"deliveryProfile" | |
], | |
"description": "Update existing delivery profile", | |
"operationId": "deliveryProfile.update", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"delivery", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"delivery": { | |
"$ref": "#/components/schemas/KalturaDeliveryProfile" | |
}, | |
"id": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDeliveryProfile" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"id", | |
"delivery" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/document_documents/action/addFromEntry": { | |
"post": { | |
"tags": [ | |
"documents" | |
], | |
"description": "Copy entry into new entry", | |
"operationId": "documents.addFromEntry", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"sourceEntryId" | |
], | |
"type": "object", | |
"properties": { | |
"documentEntry": { | |
"$ref": "#/components/schemas/KalturaDocumentEntry" | |
}, | |
"sourceEntryId": { | |
"type": "string" | |
}, | |
"sourceFlavorParamsId": { | |
"type": "integer" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDocumentEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"sourceEntryId", | |
"documentEntry", | |
"sourceFlavorParamsId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/document_documents/action/addFromFlavorAsset": { | |
"post": { | |
"tags": [ | |
"documents" | |
], | |
"description": "Copy flavor asset into new entry", | |
"operationId": "documents.addFromFlavorAsset", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"sourceFlavorAssetId" | |
], | |
"type": "object", | |
"properties": { | |
"documentEntry": { | |
"$ref": "#/components/schemas/KalturaDocumentEntry" | |
}, | |
"sourceFlavorAssetId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDocumentEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"sourceFlavorAssetId", | |
"documentEntry" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/document_documents/action/addFromUploadedFile": { | |
"post": { | |
"tags": [ | |
"documents" | |
], | |
"description": "Add new document entry after the specific document file was uploaded and the upload token id exists", | |
"operationId": "documents.addFromUploadedFile", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"documentEntry", | |
"uploadTokenId" | |
], | |
"type": "object", | |
"properties": { | |
"documentEntry": { | |
"$ref": "#/components/schemas/KalturaDocumentEntry" | |
}, | |
"uploadTokenId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDocumentEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"documentEntry", | |
"uploadTokenId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/document_documents/action/approveReplace": { | |
"post": { | |
"tags": [ | |
"documents" | |
], | |
"description": "Approves document replacement", | |
"operationId": "documents.approveReplace", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDocumentEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/document_documents/action/cancelReplace": { | |
"post": { | |
"tags": [ | |
"documents" | |
], | |
"description": "Cancels document replacement", | |
"operationId": "documents.cancelReplace", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": "language", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
} | |
], | |
"requestBody": { | |
"content": { | |
"*/*": { | |
"schema": { | |
"required": [ | |
"entryId" | |
], | |
"type": "object", | |
"properties": { | |
"entryId": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
}, | |
"required": false | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"*/*": { | |
"schema": { | |
"$ref": "#/components/schemas/KalturaDocumentEntry" | |
} | |
} | |
} | |
} | |
}, | |
"x-kaltura-format": "post", | |
"x-kaltura-parameters": [ | |
"entryId" | |
], | |
"x-codegen-request-body-name": "body" | |
} | |
}, | |
"/service/document_documents/action/convert": { | |
"post": { | |
"tags": [ | |
"documents" | |
], | |
"description": "Convert entry", | |
"operationId": "documents.convert", | |
"parameters": [ | |
{ | |
"name": "ks", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"x-global": true | |
}, | |
"x-global": true | |
}, | |
{ | |
"name": "format", | |
"in": "query", | |
"description": "The format of the response", | |
"schema": { | |
"type": "integer", | |
"enum": [ | |
1, | |
2, | |
3 | |
], | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
"x-consoleDefault": 1, | |
"x-enumLabels": [ | |
"JSON", | |
"XML", | |
"PHP" | |
], | |
"x-global": true | |
}, | |
{ | |
"name": "clientTag", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"default": "devkcom", | |
"x-hidden": true | |
}, | |
"x-hidden": true | |
}, | |
{ | |
"name": "partnerId", | |
"in": "query", | |
"schema": { | |
"type": "integer", | |
"x-global": true, | |
"x-volatile": false | |
}, | |
"x-global": true, | |
"x-volatile": false | |
}, | |
{ | |
"name": |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment