openapi: 3.2.0 info: description: 'Media Services (includes Media Flow and Media Streams) is a fully managed service for processing media (video) source content. Use Media Flow and Media Streams to transcode and package digital video using configurable workflows and stream video outputs. Use the Media Services API to configure media workflows and run Media Flow jobs, create distribution channels, ingest assets, create Preview URLs and play assets. For more information, see [Media Flow](/iaas/Content/media-services/mediaflow/mediaflow.htm) and [Media Streams](/iaas/Content/media-services/mediastreams/mediastreams.htm). ' title: Media Services API version: '20211101' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/fb3f87892acfebb2d30cddd4ec628119125fc820d1c3fad363bf9d5ed5497dc9.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Media Services API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/fb3f87892acfebb2d30cddd4ec628119125fc820d1c3fad363bf9d5ed5497dc9.yaml what: the harvested document for Media Services API servers: - url: http://127.0.0.1/20211101 - url: https://127.0.0.1/20211101 tags: - name: mediaServices paths: /mediaAssets: get: description: 'Returns a list of MediaAssetSummary. ' operationId: ListMediaAssets parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/MediaAssetsLifecycleStateQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/MediaAssetsSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/DistributionChannelIdentifierQueryParam' - $ref: '#/components/parameters/ParentMediaAssetIdQueryParam' - $ref: '#/components/parameters/MasterMediaAssetIdQueryParam' - $ref: '#/components/parameters/MediaAssetTypeQueryParam' - $ref: '#/components/parameters/BucketNameQueryParam' - $ref: '#/components/parameters/ObjectNameQueryParam' - $ref: '#/components/parameters/MediaWorkflowJobIdQueryParam' - $ref: '#/components/parameters/SourceMediaWorkflowIdQueryParam' - $ref: '#/components/parameters/SourceMediaWorkflowVersionQueryParam' responses: 200: description: A page of MediaAssetSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaAssetCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all MediaAssetSummary in a compartment. tags: - mediaServices x-related-resource: '#/definitions/MediaAsset' post: description: 'Creates a new MediaAsset. ' operationId: CreateMediaAsset parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The MediaAsset was successfully created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaAsset' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new MediaAsset tags: - mediaServices x-related-resource: '#/definitions/MediaAsset' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMediaAssetDetails' description: Details for the new MediaAsset. required: true /mediaAssets/{mediaAssetId}: delete: description: Deletes a MediaAsset resource by identifier. If DeleteChildren is passed in as the mode, all the assets with the parentMediaAssetId matching the ID will be deleted. If DeleteDerivatives is set as the mode, all the assets with the masterMediaAssetId matching the ID will be deleted. operationId: DeleteMediaAsset parameters: - $ref: '#/components/parameters/MediaAssetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/DeleteModeQueryParam' responses: 204: description: The MediaAsset was successfully deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned MediaAsset tags: - mediaServices x-related-resource: '#/definitions/MediaAsset' get: description: Gets a MediaAsset by identifier. operationId: GetMediaAsset parameters: - $ref: '#/components/parameters/MediaAssetIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the MediaAsset with the given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaAsset' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get MediaAsset tags: - mediaServices put: description: Updates the MediaAsset. operationId: UpdateMediaAsset parameters: - $ref: '#/components/parameters/MediaAssetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The MediaAsset was successfully updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaAsset' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the MediaAsset identified by the ID. tags: - mediaServices x-related-resource: '#/definitions/MediaAsset' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMediaAssetDetails' description: The information to be updated. required: true /mediaAssets/{mediaAssetId}/actions/addLock: post: description: 'Add a lock to an MediaAsset. ' operationId: AddMediaAssetLock parameters: - $ref: '#/components/parameters/MediaAssetIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Lock is added. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaAsset' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Add a lock to an MediaAsset. tags: - mediaServices x-related-resource: '#/definitions/MediaAsset' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddLockDetails' description: The details to be updated for the AddLock. required: true /mediaAssets/{mediaAssetId}/actions/changeCompartment: post: description: Moves a MediaAsset resource from one compartment identifier to another. operationId: ChangeMediaAssetCompartment parameters: - $ref: '#/components/parameters/MediaAssetIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The MediaAsset resource has been moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves an asset into a different compartment. tags: - mediaServices x-related-resource: '#/definitions/MediaAsset' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeMediaAssetCompartmentDetails' description: The information to be updated. required: true /mediaAssets/{mediaAssetId}/actions/removeLock: post: description: 'Remove a lock to an MediaAsset. ' operationId: RemoveMediaAssetLock parameters: - $ref: '#/components/parameters/MediaAssetIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Lock is removed. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaAsset' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Remove a lock from an MediaAsset. tags: - mediaServices x-related-resource: '#/definitions/MediaAsset' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveLockDetails' description: The details to be updated for the RemoveLock. required: true /mediaAssets/{mediaAssetId}/distributionChannelAttachments: get: description: Lists the MediaAssetDistributionChannelAttachments for a MediaAsset by identifier. operationId: ListMediaAssetDistributionChannelAttachments parameters: - $ref: '#/components/parameters/MediaAssetIdentifierPathParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DistributionChannelSortByQueryParam' - $ref: '#/components/parameters/DistributionChannelIdentifierQueryParam' responses: 200: description: A page of MediaAssetDistributionChannelAttachmentSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaAssetDistributionChannelAttachmentCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List MediaAssetDistributionChannelAttachments for MediaAsset. tags: - mediaServices x-related-resource: '#/definitions/MediaAssetDistributionChannelAttachmentCollection' /mediaAssets/{mediaAssetId}/distributionChannelAttachments/{distributionChannelId}: delete: description: Deletes a MediaAsset from the DistributionChannel by identifiers. operationId: DeleteMediaAssetDistributionChannelAttachment parameters: - $ref: '#/components/parameters/MediaAssetIdentifierPathParam' - $ref: '#/components/parameters/DistributionChannelIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/MediaAssetDistributionChannelAttachmentVersionQueryParam' responses: 204: description: The MediaAssetDistributionChannelAttachment was successfully deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a MediaAsset from DistributionChannel. tags: - mediaServices x-related-resource: '#/definitions/MediaAssetDistributionChannelAttachment' get: description: Gets a MediaAssetDistributionChannelAttachment for a MediaAsset by identifiers. operationId: GetMediaAssetDistributionChannelAttachment parameters: - $ref: '#/components/parameters/MediaAssetIdentifierPathParam' - $ref: '#/components/parameters/DistributionChannelIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/MediaAssetDistributionChannelAttachmentVersionQueryParam' responses: 200: description: Retrieves the MediaAssetDistributionChannelAttachment for a MediaAsset with the given IDs. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaAssetDistributionChannelAttachment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a MediaAssetDistributionChannelAttachment for a MediaAsset. tags: - mediaServices /mediaWorkflowConfigurations: get: description: 'Returns a list of MediaWorkflowConfigurations. ' operationId: ListMediaWorkflowConfigurations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/MediaWorkflowConfigurationIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of MediaWorkflowConfigurationSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflowConfigurationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all MediaWorkflowConfigurations in a compartment. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflowConfigurationCollection' post: description: 'Creates a new MediaWorkflowConfiguration. ' operationId: CreateMediaWorkflowConfiguration parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The MediaWorkflowConfiguration was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflowConfiguration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new MediaWorkflowConfiguration. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflowConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMediaWorkflowConfigurationDetails' description: Details for the new MediaWorkflowConfiguration. required: true /mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}: delete: description: Deletes a MediaWorkflowConfiguration resource by identifier. operationId: DeleteMediaWorkflowConfiguration parameters: - $ref: '#/components/parameters/MediaWorkflowConfigurationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The MediaWorkflowConfiguration will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a provisioned MediaWorkflowConfiguration. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflowConfiguration' get: description: Gets a MediaWorkflowConfiguration by identifier operationId: GetMediaWorkflowConfiguration parameters: - $ref: '#/components/parameters/MediaWorkflowConfigurationIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the MediaWorkflowConfiguration with the given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflowConfiguration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get MediaWorkflowConfiguration tags: - mediaServices put: description: Updates the MediaWorkflowConfiguration. operationId: UpdateMediaWorkflowConfiguration parameters: - $ref: '#/components/parameters/MediaWorkflowConfigurationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The MediaWorkflowConfiguration is updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflowConfiguration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the MediaWorkflowConfiguration identified by the ID. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflowConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMediaWorkflowConfigurationDetails' description: The information to be updated. required: true /mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}/actions/addLock: post: description: 'Add a lock to a MediaWorkflowConfiguration. ' operationId: AddMediaWorkflowConfigurationLock parameters: - $ref: '#/components/parameters/AddResourceLockDetailsBodyParam' - $ref: '#/components/parameters/MediaWorkflowConfigurationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Lock is added. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflowConfiguration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Add a lock to a MediaWorkflowConfiguration. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflowConfiguration' /mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}/actions/changeCompartment: post: description: Moves a MediaWorkflowConfiguration resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeMediaWorkflowConfigurationCompartment parameters: - $ref: '#/components/parameters/MediaWorkflowConfigurationIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The MediaWorkflowConfiguration resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflowConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeMediaWorkflowConfigurationCompartmentDetails' description: The information to be updated. required: true /mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}/actions/removeLock: post: description: 'Remove a lock from a MediaWorkflowConfiguration. ' operationId: RemoveMediaWorkflowConfigurationLock parameters: - $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam' - $ref: '#/components/parameters/MediaWorkflowConfigurationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Lock is removed. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflowConfiguration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Remove a lock from a MediaWorkflowConfiguration. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflowConfiguration' /mediaWorkflowJobs: get: description: Lists the MediaWorkflowJobs. operationId: ListMediaWorkflowJobs parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/MediaWorkflowJobIdentifierQueryParam' - $ref: '#/components/parameters/MediaWorkflowIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/MediaWorkflowJobLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/MediaWorkflowJobSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Lists all the MediaWorkflowJobs in a compartment. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflowJobCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List MediaWorkflowJobs in a compartment tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflowJob' post: description: Run the MediaWorkflow according to the given mediaWorkflow definition and configuration. operationId: CreateMediaWorkflowJob parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Creates and starts running a new job for the MediaWorkflow with the given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflowJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates and runs a MediaWorkflowJob for the the MediaWorkflow identified by mediaWorkflowId tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflowJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMediaWorkflowJobDetails' description: The information to run the mediaWorkflow. required: true /mediaWorkflowJobs/{mediaWorkflowJobId}: delete: description: This is an asynchronous operation. The MediaWorkflowJob lifecycleState will change to CANCELING temporarily until the job is completely CANCELED. operationId: DeleteMediaWorkflowJob parameters: - $ref: '#/components/parameters/MediaWorkflowJobIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The MediaWorkflowJob will be canceled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel a MediaWorkflowJob identified by the mediaWorkflowJobId tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflowJob' get: description: Gets the MediaWorkflowJob. operationId: GetMediaWorkflowJob parameters: - $ref: '#/components/parameters/MediaWorkflowJobIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the MediaWorkflowJob with the given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflowJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get MediaWorkflowJob identified by the mediaWorkflowId and jobId tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflowJob' put: description: Updates the MediaWorkflowJob. operationId: UpdateMediaWorkflowJob parameters: - $ref: '#/components/parameters/MediaWorkflowJobIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The MediaWorkflowJob was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflowJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the MediaWorkflowJob identified by the id tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflowJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMediaWorkflowJobDetails' description: The information to be updated. required: true /mediaWorkflowJobs/{mediaWorkflowJobId}/actions/addLock: post: description: 'Add a lock to a MediaWorkflowJob. ' operationId: AddMediaWorkflowJobLock parameters: - $ref: '#/components/parameters/MediaWorkflowJobIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Lock is added. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflowJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Add a lock to a MediaWorkflowJob. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflowJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddLockDetails' description: The details to be updated for the AddLock. required: true /mediaWorkflowJobs/{mediaWorkflowJobId}/actions/changeCompartment: post: description: Moves a MediaWorkflowJob resource from one compartment identifier to another. operationId: ChangeMediaWorkflowJobCompartment parameters: - $ref: '#/components/parameters/MediaWorkflowJobIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The MediaWorkflowJob resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves a resource into a different compartment. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflowJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeMediaWorkflowJobCompartmentDetails' description: The change compartment payload. required: true /mediaWorkflowJobs/{mediaWorkflowJobId}/actions/removeLock: post: description: 'Remove a lock from a MediaWorkflowJob. ' operationId: RemoveMediaWorkflowJobLock parameters: - $ref: '#/components/parameters/MediaWorkflowJobIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Lock is removed. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflowJob' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Remove a lock from a MediaWorkflowJob. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflowJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveLockDetails' description: The details to be updated for the RemoveLock. required: true /mediaWorkflowTaskDeclarations: get: description: 'Returns a list of MediaWorkflowTaskDeclarations. ' operationId: ListMediaWorkflowTaskDeclarations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/MediaWorkflowTaskDeclarationVerionQueryParam' - $ref: '#/components/parameters/MediaWorkflowTaskDeclarationCurrentQueryParam' - $ref: '#/components/parameters/MediaWorkflowTaskDeclarationSortByQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of MediaWorkflowTaskDeclaration items. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflowTaskDeclarationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all MediaWorkflowTaskDeclarations. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflowTaskDeclarationCollection' /mediaWorkflows: get: description: Lists the MediaWorkflows. operationId: ListMediaWorkflows parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/MediaWorkflowIdentifierQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of all the MediaWorkflows. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflowCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists the MediaWorkflows. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflow' post: description: 'Creates a new MediaWorkflow. ' operationId: CreateMediaWorkflow parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The MediaWorkflow was successfully created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflow' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new MediaWorkflow. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflow' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMediaWorkflowDetails' description: Details for the new MediaWorkflow. required: true /mediaWorkflows/{mediaWorkflowId}: delete: description: The MediaWorkflow lifecycleState will change to DELETED. operationId: DeleteMediaWorkflow parameters: - $ref: '#/components/parameters/MediaWorkflowIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The MediaWorkflow is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a MediaWorkflow identified by the mediaWorkflowId. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflow' get: description: Gets a MediaWorkflow by identifier. operationId: GetMediaWorkflow parameters: - $ref: '#/components/parameters/MediaWorkflowIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the MediaWorkflow with the given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflow' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets MediaWorkflow. tags: - mediaServices put: description: Updates the MediaWorkflow. operationId: UpdateMediaWorkflow parameters: - $ref: '#/components/parameters/MediaWorkflowIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The MediaWorkflow was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflow' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the MediaWorkflow identified by the ID. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflow' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMediaWorkflowDetails' description: The information to be updated. required: true /mediaWorkflows/{mediaWorkflowId}/actions/addLock: post: description: 'Add a lock to a MediaWorkflow. ' operationId: AddMediaWorkflowLock parameters: - $ref: '#/components/parameters/AddResourceLockDetailsBodyParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/MediaWorkflowIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Lock is added. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflow' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Add a lock to a MediaWorkflow. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflow' /mediaWorkflows/{mediaWorkflowId}/actions/changeCompartment: post: description: Moves a MediaWorkflow resource from one compartment identifier to another. operationId: ChangeMediaWorkflowCompartment parameters: - $ref: '#/components/parameters/MediaWorkflowIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The MediaWorkflow resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves a resource into a different compartment. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflow' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeMediaWorkflowCompartmentDetails' description: The change compartment payload. required: true /mediaWorkflows/{mediaWorkflowId}/actions/removeLock: post: description: 'Remove a lock from a MediaWorkflow. ' operationId: RemoveMediaWorkflowLock parameters: - $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/MediaWorkflowIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Lock is removed. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MediaWorkflow' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Remove a lock from a MediaWorkflow. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflow' /streamCdnConfigs: get: description: Lists the StreamCdnConfig. operationId: ListStreamCdnConfigs parameters: - $ref: '#/components/parameters/RequiredStreamCdnConfigDistributionChannelIdentifierQueryParam' - $ref: '#/components/parameters/StreamCdnConfigIdentifierQueryParam' - $ref: '#/components/parameters/StreamCdnConfigLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List all the CDN Configurations. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamCdnConfigCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists the StreamCdnConfig. tags: - mediaServices x-related-resource: '#/definitions/StreamCdnConfig' post: description: 'Creates a new CDN Configuration. ' operationId: CreateStreamCdnConfig parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The StreamCdnConfig was successfully created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamCdnConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new CDN Configuration. tags: - mediaServices x-related-resource: '#/definitions/StreamCdnConfig' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateStreamCdnConfigDetails' description: Details for the new StreamCdnConfig. required: true /streamCdnConfigs/{streamCdnConfigId}: delete: description: The StreamCdnConfig lifecycleState will change to DELETED. operationId: DeleteStreamCdnConfig parameters: - $ref: '#/components/parameters/StreamCdnConfigIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The StreamCdnConfig is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a StreamCdnConfig identified by the streamCdnConfigId. tags: - mediaServices x-related-resource: '#/definitions/StreamCdnConfig' get: description: Gets a StreamCdnConfig by identifier. operationId: GetStreamCdnConfig parameters: - $ref: '#/components/parameters/StreamCdnConfigIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the StreamCdnConfig with the given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamCdnConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets StreamCdnConfig. tags: - mediaServices put: description: Updates the StreamCdnConfig. operationId: UpdateStreamCdnConfig parameters: - $ref: '#/components/parameters/StreamCdnConfigIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The StreamCdnConfig is updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamCdnConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the StreamCdnConfig identified by the ID. tags: - mediaServices x-related-resource: '#/definitions/StreamCdnConfig' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateStreamCdnConfigDetails' description: The information to be updated. required: true /streamCdnConfigs/{streamCdnConfigId}/actions/addLock: post: description: 'Add a lock to a StreamCdnConfig. ' operationId: AddStreamCdnConfigLock parameters: - $ref: '#/components/parameters/AddResourceLockDetailsBodyParam' - $ref: '#/components/parameters/StreamCdnConfigIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Lock is added. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamCdnConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Add a lock to a StreamCdnConfig. tags: - mediaServices x-related-resource: '#/definitions/StreamCdnConfig' /streamCdnConfigs/{streamCdnConfigId}/actions/removeLock: post: description: 'Remove a lock from a StreamCdnConfig. ' operationId: RemoveStreamCdnConfigLock parameters: - $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam' - $ref: '#/components/parameters/StreamCdnConfigIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Lock is removed. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamCdnConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Remove a lock from a StreamCdnConfig. tags: - mediaServices x-related-resource: '#/definitions/StreamCdnConfig' /streamDistributionChannels: get: description: Lists the Stream Distribution Channels. operationId: ListStreamDistributionChannels parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/StreamDistributionChannelIdentifierQueryParam' - $ref: '#/components/parameters/StreamDistributionChannelLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Lists all the Stream Distribution Channels. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamDistributionChannelCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists Stream Distribution Channels. tags: - mediaServices x-related-resource: '#/definitions/StreamDistributionChannel' post: description: 'Creates a new Stream Distribution Channel. ' operationId: CreateStreamDistributionChannel parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Stream Distribution Channel was successfully created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamDistributionChannel' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Stream Distribution Channel tags: - mediaServices x-related-resource: '#/definitions/StreamDistributionChannel' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateStreamDistributionChannelDetails' description: Details for the new Stream Distribution Channel. required: true /streamDistributionChannels/{streamDistributionChannelId}: delete: description: The Stream Distribution Channel lifecycleState will change to DELETED. operationId: DeleteStreamDistributionChannel parameters: - $ref: '#/components/parameters/StreamDistributionChannelIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The Stream Distribution Channel is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a Stream Distribution Channel identified by the streamDistributionChannelId. tags: - mediaServices x-related-resource: '#/definitions/StreamDistributionChannel' get: description: Gets a Stream Distribution Channel by identifier. operationId: GetStreamDistributionChannel parameters: - $ref: '#/components/parameters/StreamDistributionChannelIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Stream Distribution Channel with the given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamDistributionChannel' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a Stream Distribution Channel. tags: - mediaServices put: description: Updates the Stream Distribution Channel. operationId: UpdateStreamDistributionChannel parameters: - $ref: '#/components/parameters/StreamDistributionChannelIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Stream Distribution Channel has been updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamDistributionChannel' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Stream Distribution Channel identified by the id tags: - mediaServices x-related-resource: '#/definitions/StreamDistributionChannel' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateStreamDistributionChannelDetails' description: The information to be updated. required: true /streamDistributionChannels/{streamDistributionChannelId}/actions/addLock: post: description: 'Add a lock to a StreamDistributionChannel. ' operationId: AddStreamDistributionChannelLock parameters: - $ref: '#/components/parameters/AddResourceLockDetailsBodyParam' - $ref: '#/components/parameters/StreamDistributionChannelIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Lock is added. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamDistributionChannel' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Add a lock to a StreamDistributionChannel. tags: - mediaServices x-related-resource: '#/definitions/StreamDistributionChannel' /streamDistributionChannels/{streamDistributionChannelId}/actions/changeCompartment: post: description: Moves a Stream Distribution Channel resource from one compartment identifier to another. operationId: ChangeStreamDistributionChannelCompartment parameters: - $ref: '#/components/parameters/StreamDistributionChannelIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The Stream Distribution Channel resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves a resource into a different compartment. tags: - mediaServices x-related-resource: '#/definitions/StreamDistributionChannel' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeStreamDistributionChannelCompartmentDetails' description: The change compartment payload. required: true /streamDistributionChannels/{streamDistributionChannelId}/actions/ingest: post: description: Ingests an Asset into a Distribution Channel. operationId: IngestStreamDistributionChannel parameters: - $ref: '#/components/parameters/StreamDistributionChannelIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The workflow job is successfully created to ingest the asset into the distribution channel. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IngestStreamDistributionChannelResult' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Ingests an Asset into a Distribution Channel. tags: - mediaServices x-related-resource: '#/definitions/StreamDistributionChannel' requestBody: content: application/json: schema: $ref: '#/components/schemas/IngestStreamDistributionChannelDetails' description: Playlist entry information. required: true /streamDistributionChannels/{streamDistributionChannelId}/actions/removeLock: post: description: 'Remove a lock to a StreamDistributionChannel. ' operationId: RemoveStreamDistributionChannelLock parameters: - $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam' - $ref: '#/components/parameters/StreamDistributionChannelIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Lock is removed. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamDistributionChannel' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Remove a lock to a StreamDistributionChannel. tags: - mediaServices x-related-resource: '#/definitions/StreamDistributionChannel' /streamPackagingConfigs: get: description: Lists the Stream Packaging Configurations. operationId: ListStreamPackagingConfigs parameters: - $ref: '#/components/parameters/StreamPackagingConfigDistributionChannelIdQueryParam' - $ref: '#/components/parameters/StreamPackagingConfigIdentifierQueryParam' - $ref: '#/components/parameters/StreamPackagingConfigLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Lists all the Stream Packaging Configurations. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamPackagingConfigCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List Stream Packaging Configurations tags: - mediaServices x-related-resource: '#/definitions/StreamPackagingConfig' post: description: 'Creates a new Packaging Configuration. ' operationId: CreateStreamPackagingConfig parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Stream Packaging Configuration was successfully created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamPackagingConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Stream Packaging Configuration. tags: - mediaServices x-related-resource: '#/definitions/StreamPackagingConfig' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateStreamPackagingConfigDetails' description: Details for the new Stream Packaging Configuration. required: true /streamPackagingConfigs/{streamPackagingConfigId}: delete: description: The Stream Packaging Configuration lifecycleState will change to DELETED. operationId: DeleteStreamPackagingConfig parameters: - $ref: '#/components/parameters/StreamPackagingConfigIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The Stream Packaging Configuration is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a Stream Packaging Configuration identified by the streamPackagingConfigId. tags: - mediaServices x-related-resource: '#/definitions/StreamPackagingConfig' get: description: Gets a Stream Packaging Configuration by identifier. operationId: GetStreamPackagingConfig parameters: - $ref: '#/components/parameters/StreamPackagingConfigIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Stream Packaging Configuration with the given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamPackagingConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a Stream Packaging Configuration. tags: - mediaServices put: description: Updates the Stream Packaging Configuration. operationId: UpdateStreamPackagingConfig parameters: - $ref: '#/components/parameters/StreamPackagingConfigIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Stream Packaging Configuration will be updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamPackagingConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the Stream Packaging Configuration identified by the ID. tags: - mediaServices x-related-resource: '#/definitions/StreamPackagingConfig' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateStreamPackagingConfigDetails' description: The information to be updated. required: true /streamPackagingConfigs/{streamPackagingConfigId}/actions/addLock: post: description: 'Add a lock to a StreamPackagingConfig. ' operationId: AddStreamPackagingConfigLock parameters: - $ref: '#/components/parameters/AddResourceLockDetailsBodyParam' - $ref: '#/components/parameters/StreamPackagingConfigIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Lock is added. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamPackagingConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Add a lock to a StreamPackagingConfig. tags: - mediaServices x-related-resource: '#/definitions/StreamPackagingConfig' /streamPackagingConfigs/{streamPackagingConfigId}/actions/removeLock: post: description: 'Remove a lock from a StreamPackagingConfig. ' operationId: RemoveStreamPackagingConfigLock parameters: - $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam' - $ref: '#/components/parameters/StreamPackagingConfigIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Lock is removed. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StreamPackagingConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Remove a lock from a StreamPackagingConfig. tags: - mediaServices x-related-resource: '#/definitions/StreamPackagingConfig' /systemMediaWorkflows: get: description: 'Lists the SystemMediaWorkflows that can be used to run a job by name or as a template to create a MediaWorkflow. ' operationId: ListSystemMediaWorkflows parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The SystemMediaWorkflow templates. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SystemMediaWorkflowCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists SystemMediaWorkflows. tags: - mediaServices x-related-resource: '#/definitions/MediaWorkflow' components: parameters: NameQueryParam: description: A filter to return only the resources with their system defined, unique name matching the given name. in: query name: name x-default-description: 'null' schema: type: string MediaWorkflowJobSortByQueryParam: description: The parameter sort by. in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/MediaWorkflowJobSortBy' schema: type: string enum: - timeCreated - workflowId - lifecycleState default: timeCreated MediaWorkflowTaskDeclarationVerionQueryParam: description: A filter to select MediaWorkflowTaskDeclaration by version. in: query name: version x-default-description: 'null' schema: type: integer minimum: 0 SourceMediaWorkflowIdQueryParam: description: The ID of the MediaWorkflow used to produce this asset. in: query name: sourceMediaWorkflowId required: false x-default-description: 'null' schema: type: string StreamCdnConfigIdentifierQueryParam: description: Unique StreamCdnConfig identifier. in: query name: id x-default-description: 'null' schema: type: string DistributionChannelIdentifierQueryParam: description: Unique DistributionChannel identifier. in: query name: distributionChannelId x-default-description: 'null' schema: type: string StreamPackagingConfigLifecycleStateQueryParam: description: A filter to return only the resources with lifecycleState matching the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/StreamPackagingConfig/lifecycleState' schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string MediaWorkflowIdentifierPathParam: description: Unique MediaWorkflow identifier. in: path name: mediaWorkflowId required: true schema: type: string MediaWorkflowJobIdentifierQueryParam: description: unique MediaWorkflowJob identifier in: query name: id x-default-description: 'null' schema: type: string SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC MediaWorkflowJobLifecycleStateQueryParam: description: A filter to return only the resources with lifecycleState matching the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/MediaWorkflowJob/lifecycleState' schema: type: string ParentMediaAssetIdQueryParam: description: Unique MediaAsset identifier of the asset from which this asset is derived. in: query name: parentMediaAssetId x-default-description: 'null' schema: type: string StreamPackagingConfigDistributionChannelIdQueryParam: description: Unique Stream Distribution Channel identifier. in: query name: distributionChannelId required: true x-default-description: 'null' schema: type: string RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string MediaAssetsSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy x-default-description: The default value is timeCreated. x-obmcs-top-level-enum: '#/definitions/MediaAssetSortBy' schema: type: string enum: - compartmentId - type - lifecycleState - parentMediaAssetId - masterMediaAssetId - displayName - timeCreated - timeUpdated LifecycleStateQueryParam: description: A filter to return only the resources with lifecycleState matching the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/MediaWorkflow/lifecycleState' schema: type: string MediaWorkflowIdQueryParam: description: Unique MediaWorkflow identifier. in: query name: mediaWorkflowId x-default-description: 'null' schema: type: string DistributionChannelSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy x-default-description: The default value is the media asset ID. x-obmcs-top-level-enum: '#/definitions/MediaAssetDistributionChannelAttachmentSortBy' schema: type: string enum: - mediaAssetId - distributionChannelId - displayName - version AddResourceLockDetailsBodyParam: description: AddResourceLockDetails body parameter in: body name: AddResourceLockDetails required: true schema: $ref: '#/components/schemas/AddLockDetails' SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/SortBy' schema: type: string enum: - timeCreated - displayName default: timeCreated SourceMediaWorkflowVersionQueryParam: description: The version of the MediaWorkflow used to produce this asset. in: query name: sourceMediaWorkflowVersion required: false x-default-description: 'null' schema: type: integer format: int64 MasterMediaAssetIdQueryParam: description: Unique MediaAsset identifier of the first asset upload. in: query name: masterMediaAssetId x-default-description: 'null' schema: type: string StreamPackagingConfigIdentifierPathParam: description: Unique Stream Packaging Configuration path identifier. in: path name: streamPackagingConfigId required: true schema: type: string MediaWorkflowIdentifierQueryParam: description: Unique MediaWorkflow identifier. in: query name: id x-default-description: 'null' schema: type: string MediaWorkflowConfigurationIdentifierPathParam: description: Unique MediaWorkflowConfiguration identifier. in: path name: mediaWorkflowConfigurationId required: true schema: type: string DeleteModeQueryParam: description: DeleteMode decides whether to delete all the immediate children or all assets with the asset's ID as their masterMediaAssetId. in: query name: deleteMode x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/DeleteMode' schema: type: string enum: - DELETE_CHILDREN - DELETE_DERIVATIONS MediaAssetsLifecycleStateQueryParam: description: A filter to return only the resources with lifecycleState matching the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/LifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED DisplayNameQueryParam: description: A filter to return only the resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 MediaAssetDistributionChannelAttachmentVersionQueryParam: description: Version of the attachment. in: query name: version x-default-description: 'null' schema: type: integer format: int64 PaginationTokenQueryParam: description: 'A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. ' in: query name: page x-default-description: 'null' schema: type: string default: '' minLength: 1 BucketNameQueryParam: description: Filter MediaAsset by the bucket where the object is stored. in: query name: bucketName x-default-description: 'null' schema: type: string MediaAssetTypeQueryParam: description: Filter MediaAsset by the asset type. in: query name: type x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/AssetType' schema: type: string enum: - AUDIO - VIDEO - PLAYLIST - IMAGE - CAPTION_FILE - UNKNOWN StreamDistributionChannelIdentifierPathParam: description: Unique Stream Distribution Channel path identifier. in: path name: streamDistributionChannelId required: true schema: type: string StreamDistributionChannelIdentifierQueryParam: description: Unique Stream Distribution Channel identifier. in: query name: id x-default-description: 'null' schema: type: string DistributionChannelIdentifierPathParam: description: Unique DistributionChannel identifier. in: path name: distributionChannelId required: true schema: type: string RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 StreamCdnConfigLifecycleStateQueryParam: description: A filter to return only the resources with lifecycleState matching the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/StreamCdnConfig/lifecycleState' schema: type: string MediaWorkflowJobIdQueryParam: description: The ID of the MediaWorkflowJob used to produce this asset, if this parameter is supplied then the workflow ID must also be supplied. in: query name: mediaWorkflowJobId required: false x-default-description: 'null' schema: type: string MediaWorkflowTaskDeclarationSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/MediaWorkflowTaskDeclarationSortBy' schema: type: string enum: - name - version default: name MediaWorkflowJobIdPathParam: description: Unique MediaWorkflowJob identifier. in: path name: mediaWorkflowJobId required: true schema: type: string StreamDistributionChannelLifecycleStateQueryParam: description: A filter to return only the resources with lifecycleState matching the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/StreamDistributionChannel/lifecycleState' schema: type: string RequiredStreamCdnConfigDistributionChannelIdentifierQueryParam: description: 'The Stream Distribution Channel identifier this CdnConfig belongs to. ' in: query name: distributionChannelId required: true x-default-description: 'null' schema: type: string CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId x-default-description: The OCID of the compartment in which to list resources. Required - unless resource id is specified in the query parameter. schema: type: string RemoveResourceLockDetailsBodyParam: description: RemoveResourceLockDetails body parameter in: body name: RemoveResourceLockDetails required: true schema: $ref: '#/components/schemas/RemoveLockDetails' PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 50 minimum: 1 MediaAssetIdentifierPathParam: description: Unique MediaAsset identifier in: path name: mediaAssetId required: true schema: type: string StreamCdnConfigIdentifierPathParam: description: Unique StreamCdnConfig identifier. in: path name: streamCdnConfigId required: true schema: type: string StreamPackagingConfigIdentifierQueryParam: description: Unique Stream Packaging Configuration identifier. in: query name: streamPackagingConfigId x-default-description: 'null' schema: type: string MediaWorkflowTaskDeclarationCurrentQueryParam: description: A filter to only select the newest version for each MediaWorkflowTaskDeclaration name. in: query name: isCurrent schema: type: boolean default: false MediaWorkflowConfigurationIdentifierQueryParam: description: Unique MediaWorkflowConfiguration identifier. in: query name: id x-default-description: 'null' schema: type: string ObjectNameQueryParam: description: Filter MediaAsset by the name of the object in object storage. in: query name: objectName x-default-description: 'null' schema: type: string schemas: Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message UpdateStreamDistributionChannelDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Stream Distribution channel display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object type: object ChangeMediaWorkflowCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object MediaWorkflowConfiguration: description: Resusable set of values that can be referenced either in a MediaWorkflow or when running a MediaWorkflowJob. properties: compartmentId: description: Compartment Identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Display name for the MediaWorkflowConfiguration. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleState: description: The current state of the MediaWorkflowConfiguration. enum: - ACTIVE - DELETED type: string lifecyleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array parameters: additionalProperties: type: object description: 'Reuseable parameter values encoded as a JSON; the top and second level JSON elements are objects. Each key of the top level object refer to a task key that is unqiue to the workflow, each of the second level objects'' keys refer to the name of a parameter that is unique to the task. taskKey -> parameterName -> parameterValue ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time when the the MediaWorkflowConfiguration was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the MediaWorkflowConfiguration was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - displayName - parameters type: object IngestStreamDistributionChannelDetails: description: Ingest Payload Information. discriminator: propertyName: ingestPayloadType properties: ingestPayloadType: description: Ingest Payload Type enum: - ASSET_METADATA_MEDIA_ASSET type: string required: - ingestPayloadType type: object SystemMediaWorkflowCollection: description: 'Result for the ListSystemMediaWorkflows operation. ' properties: items: description: List of SytemMediaWorkflow items. items: $ref: '#/components/schemas/SystemMediaWorkflow' type: array required: - items type: object MediaWorkflowConfigurationSummary: description: Summary of the MediaWorkflowConfiguration. properties: compartmentId: description: Compartment identifier type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Name of the MediaWorkflowConfiguration. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Immutable unique identifier for the MediaWorkflowConfiguration. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the MediaWorkflowConfiguration. type: string x-obmcs-enumref: '#/definitions/MediaWorkflowConfiguration/lifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time when the MediaWorkflowConfiguration was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the MediaWorkflowConfiguration was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - displayName type: object UpdateMediaWorkflowDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Name for the MediaWorkflow. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object mediaWorkflowConfigurationIds: description: 'Configurations to be applied to all jobs for this workflow. Parameters in these configurations are overridden by parameters in the MediaWorkflowConfigurations of the MediaWorkflogJob and the parameters of the MediaWorkflowJob. ' items: type: string type: array parameters: additionalProperties: type: object description: 'JSON object representing named parameters and their default values that can be referenced throughout this workflow. The values declared here can be overridden by the MediaWorkflowConfigurations or parameters supplied when creating MediaWorkflowJobs from this MediaWorkflow. ' type: object tasks: description: 'The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array must be unique within the array. ' items: $ref: '#/components/schemas/MediaWorkflowTask' type: array type: object ChangeMediaWorkflowConfigurationCompartmentDetails: description: The details of the compartment to which the MediaWorkflowConfiguration will be moved. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object MediaWorkflowJobCollection: description: 'Results of a mediaWorkflowJob search, a list of MediaWorkflowJobSummary items and metadata of the search. ' properties: items: description: List of mediaWorkflowJob items. items: $ref: '#/components/schemas/MediaWorkflowJobSummary' type: array required: - items type: object CreateMediaWorkflowDetails: description: The information about new MediaWorkflow. properties: compartmentId: description: Compartment Identifier. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Name for the MediaWorkflow. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array mediaWorkflowConfigurationIds: description: 'Configurations to be applied to all the jobs for this workflow. Parameters in these configurations are overridden by parameters in the MediaWorkflowConfigurations of the MediaWorkflowJob and the parameters of the MediaWorkflowJob. ' items: type: string type: array parameters: additionalProperties: type: object description: 'JSON object representing named parameters and their default values that can be referenced throughout this workflow. The values declared here can be overridden by the MediaWorkflowConfigurations or parameters supplied when creating MediaWorkflowJobs from this MediaWorkflow. ' type: object tasks: description: 'The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array must be unique within the array. The order of tasks given here will be preserved. ' items: $ref: '#/components/schemas/MediaWorkflowTask' maxItems: 20 minItems: 1 type: array required: - displayName - compartmentId type: object UpdateStreamPackagingConfigDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The name of the stream Packaging Configuration. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object type: object SystemMediaWorkflow: description: A named list of tasks to be used to run a job or as a template to create a MediaWorkflow. properties: description: description: 'Description of this workflow''s processing and how that processing can be customized by specifying parameter values. ' type: string locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array name: description: System provided unique identifier for this static media workflow. type: string parameters: additionalProperties: type: object description: 'JSON object representing named parameters and their default values that can be referenced throughout this workflow. The values declared here can be overridden by the MediaWorkflowConfigurations or parameters supplied when creating MediaWorkflowJobs from this MediaWorkflow. ' type: object tasks: description: 'The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array is unique within the array. The order of the items is preserved from the order of the tasks array in CreateMediaWorkflowDetails or UpdateMediaWorkflowDetails. ' items: $ref: '#/components/schemas/MediaWorkflowTask' type: array required: - name - tasks type: object CreateMediaAssetDetails: description: The information about new MediaAsset. properties: bucketName: description: The name of the object storage bucket where this asset is located. maxLength: 256 minLength: 1 type: string compartmentId: description: Compartment Identifier. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Display name for the Media Asset. Does not have to be unique. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array masterMediaAssetId: description: The ID of the senior most asset from which this asset is derived. maxLength: 255 minLength: 1 type: string mediaAssetTags: description: list of tags for the MediaAsset. items: $ref: '#/components/schemas/MediaAssetTag' type: array mediaWorkflowJobId: description: The ID of the MediaWorkflowJob used to produce this asset. maxLength: 255 minLength: 1 type: string metadata: description: List of Metadata. items: $ref: '#/components/schemas/Metadata' type: array namespaceName: description: The object storage namespace where this asset is located. maxLength: 255 minLength: 1 type: string objectEtag: description: eTag of the underlying object storage object. maxLength: 128 minLength: 1 type: string objectName: description: The object storage object name that identifies this asset. maxLength: 1024 minLength: 1 type: string parentMediaAssetId: description: The ID of the parent asset from which this asset is derived. maxLength: 255 minLength: 1 type: string segmentRangeEndIndex: description: The end index for video segment files. format: int64 minimum: 0 type: integer segmentRangeStartIndex: description: The start index for video segment files. format: int64 minimum: 0 type: integer sourceMediaWorkflowId: description: The ID of the MediaWorkflow used to produce this asset. maxLength: 255 minLength: 1 type: string sourceMediaWorkflowVersion: description: The version of the MediaWorkflow used to produce this asset. format: int64 minimum: 1 type: integer type: description: The type of the media asset. enum: - AUDIO - VIDEO - PLAYLIST - IMAGE - CAPTION_FILE - UNKNOWN type: string x-obmcs-top-level-enum: '#/definitions/AssetType' required: - type - compartmentId type: object UpdateStreamCdnConfigDetails: description: The information to be updated. properties: config: $ref: '#/components/schemas/StreamCdnConfigSection' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: CDN Config display name. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isEnabled: description: Whether CDN is enabled for publishing. type: boolean type: object UpdateMediaWorkflowConfigurationDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Name for the MediaWorkflowConfiguration. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object parameters: additionalProperties: type: object description: 'Reuseable parameter values encoded as a JSON; the top and second level JSON elements are objects. Each key of the top level object refer to a task key that is unqiue to the workflow, each of the second level objects'' keys refer to the name of a parameter that is unique to the task. taskKey -> parameterName -> parameterValue ' type: object type: object StreamDistributionChannel: description: Channel used for delivering video streams to the end-users. properties: compartmentId: description: Compartment Identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Stream Distribution Channel display name. Avoid entering confidential information. type: string domainName: description: Unique domain name of the Distribution Channel. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleState: description: The current state of the Stream Distribution Channel. enum: - ACTIVE - NEEDS_ATTENTION - DELETED type: string locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time when the Stream Distribution Channel was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the Stream Distribution Channel was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - displayName - compartmentId type: object MediaAssetDistributionChannelAttachmentCollection: description: Results of a MediaAssetDistributionChannelAttachment search. Contains the MediaAssetDistributionChannelAttachmentSummary items. properties: items: description: List of Distribution Channel attachments. items: $ref: '#/components/schemas/MediaAssetDistributionChannelAttachmentSummary' type: array required: - items type: object CreateStreamCdnConfigDetails: description: The information about the new CDN Configuration. properties: config: $ref: '#/components/schemas/StreamCdnConfigSection' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: CDN Config display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string distributionChannelId: description: Distribution Channel Identifier. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isEnabled: default: true description: Whether publishing to CDN is enabled. type: boolean locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - displayName - distributionChannelId - config type: object JobOutput: description: The output result of an executed MediaWorkflowJob. properties: assetType: description: Type of job output. enum: - AUDIO - VIDEO - PLAYLIST - IMAGE - CAPTION_FILE - TRANSCRIPTION_JOB - VISION_JOB - TEXT_ANALYSIS - INPUT_FILE - OTHER type: string bucketName: description: The bucket name of the job output. type: string id: description: The ID associated with the job output. type: string namespaceName: description: The namespace name of the job output. type: string objectName: description: The object name of the job output. type: string type: object StreamPackagingConfigSummary: description: Summary of the Packaging Configuration. properties: compartmentId: description: Compartment Identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Stream Packaging Configuration display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string distributionChannelId: description: Unique identifier of the distribution channel that this stream packaging configuration belongs to. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleState: description: The current state of the Distribution Channel. type: string x-obmcs-enumref: '#/definitions/StreamPackagingConfig/lifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time when the Distribution Channel was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the Distribution Channel was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - distributionChannelId - displayName type: object StreamCdnConfigSummary: description: Summary of the StreamCdnConfig. properties: compartmentId: description: Compartment Identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The CDN Configuration identifier or display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string distributionChannelId: description: Distribution Channel Identifier. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string isEnabled: description: Whether publishing to CDN is enabled. type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the CDN Configuration. type: string x-obmcs-enumref: '#/definitions/StreamCdnConfig/lifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time when the the CDN Configuration was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the CDN Configuration was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - displayName - compartmentId - distributionChannelId - isEnabled type: object StreamPackagingConfig: description: A stream packaging configuration for a Distribution Channel. discriminator: propertyName: streamPackagingFormat properties: compartmentId: description: Compartment Identifier type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The name of the stream packaging configuration. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string distributionChannelId: description: Unique identifier of the Distribution Channel that this stream packaging configuration belongs to. type: string encryption: $ref: '#/components/schemas/StreamPackagingConfigEncryption' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleState: description: The current state of the Packaging Configuration. enum: - ACTIVE - NEEDS_ATTENTION - DELETED type: string locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array segmentTimeInSeconds: default: 6 description: The duration in seconds for each fragment. maximum: 30 minimum: 1 type: integer streamPackagingFormat: description: The output format for the package. enum: - HLS - DASH type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time when the Packaging Configuration was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the Packaging Configuration was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - distributionChannelId - displayName - streamPackagingFormat - segmentTimeInSeconds type: object RemoveLockDetails: description: 'Request payload to remove lock to the resource. ' properties: compartmentId: description: The compartment ID of the lock. type: string message: description: 'A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. ' type: string relatedResourceId: description: 'The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. ' type: string timeCreated: description: When the lock was created. format: date-time type: string type: description: Type of the lock. enum: - FULL - DELETE type: string required: - type - compartmentId type: object MediaAssetDistributionChannelAttachmentSummary: description: Summary of the MediaAssetDistributionChannelAttachment. properties: displayName: description: Display name for the MediaAssetDistributionChannelAttachment. Does not have to be unique, and it's changeable. Avoid entering confidential information. type: string distributionChannelId: description: OCID of associated Distribution Channel. type: string lifecycleState: description: Lifecycle state of the attachment. enum: - CREATING - ACTIVE - NEEDS_ATTENTION - UPDATING type: string x-obmcs-enumref: '#/definitions/MediaAssetDistributionChannelAttachment/lifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array mediaAssetId: description: OCID of associated media asset. type: string mediaWorkflowJobId: description: The ingest MediaWorkflowJob ID that created this attachment. type: string metadataRef: description: The identifier for the metadata. type: string version: description: Version number of the attachment. format: int64 type: integer required: - mediaAssetId - distributionChannelId - version - lifecycleState - metadataRef type: object ChangeStreamDistributionChannelCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object MediaAsset: description: Represents the metadata associated with an asset that has been either produced by or registered with Media Services. properties: bucketName: description: The name of the object storage bucket where this represented asset is located. type: string compartmentId: description: The ID of the compartment containing the MediaAsset. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleState: description: The current state of the MediaAsset. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array masterMediaAssetId: description: The ID of the senior most asset from which this asset is derived. type: string mediaAssetTags: description: List of tags for the MediaAsset. items: $ref: '#/components/schemas/MediaAssetTag' type: array mediaWorkflowJobId: description: The ID of the MediaWorkflowJob used to produce this asset. type: string metadata: description: List of Metadata. items: $ref: '#/components/schemas/Metadata' type: array namespaceName: description: The object storage namespace where this asset is located. type: string objectEtag: description: eTag of the underlying object storage object. type: string objectName: description: The object storage object name that identifies this asset. type: string parentMediaAssetId: description: The ID of the parent asset from which this asset is derived. type: string segmentRangeEndIndex: description: The end index of video segment files. format: int64 type: integer segmentRangeStartIndex: description: The start index for video segment files. format: int64 type: integer sourceMediaWorkflowId: description: The ID of the MediaWorkflow used to produce this asset. type: string sourceMediaWorkflowVersion: description: The version of the MediaWorkflow used to produce this asset. format: int64 type: integer systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time when the MediaAsset was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the MediaAsset was updated. An RFC3339 formatted datetime string. format: date-time type: string type: description: The type of the media asset. enum: - AUDIO - VIDEO - PLAYLIST - IMAGE - CAPTION_FILE - UNKNOWN type: string x-obmcs-top-level-enum: '#/definitions/AssetType' required: - id - compartmentId - lifecycleState - type type: object CreateMediaWorkflowConfigurationDetails: description: The information needed to create a new MediaWorkflowConfiguration. properties: compartmentId: description: Compartment Identifier. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: MediaWorkflowConfiguration identifier. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array parameters: additionalProperties: type: object description: 'Reuseable parameter values encoded as a JSON; the top and second level JSON elements are objects. Each key of the top level object refers to a task key that is unqiue to the workflow, each of the second level objects'' keys refer to the name of a parameter that is unique to the task. taskKey -> parameterName -> parameterValue ' type: object required: - displayName - parameters - compartmentId type: object MediaWorkflow: description: Configurable workflows that define the series of tasks that will be used to process video files. properties: compartmentId: description: Compartment Identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Name of the Media Workflow. Does not have to be unique, and it's changeable. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleState: description: The current state of the MediaWorkflow. enum: - ACTIVE - NEEDS_ATTENTION - DELETED type: string lifecyleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array mediaWorkflowConfigurationIds: description: 'Configurations to be applied to all the runs of this workflow. Parameters in these configurations are overridden by parameters in the MediaWorkflowConfigurations of the MediaWorkflowJob and the parameters of the MediaWorkflowJob. If the same parameter appears in multiple configurations, the values that appear in the configuration at the highest index will be used. ' items: type: string type: array parameters: additionalProperties: type: object description: 'JSON object representing named parameters and their default values that can be referenced throughout this workflow. The values declared here can be overridden by the MediaWorkflowConfigurations or parameters supplied when creating MediaWorkflowJobs from this MediaWorkflow. ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object tasks: description: 'The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array is unique within the array. The order of the items is preserved from the order of the tasks array in CreateMediaWorkflowDetails or UpdateMediaWorkflowDetails. ' items: $ref: '#/components/schemas/MediaWorkflowTask' type: array timeCreated: description: The time when the MediaWorkflow was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the MediaWorkflow was updated. An RFC3339 formatted datetime string. format: date-time type: string version: description: The version of the MediaWorkflow. format: int64 type: integer required: - id - compartmentId - displayName - tasks type: object UpdateMediaWorkflowJobDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Name for the MediaWorkflowJob. Does not have to be unique. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object type: object AddLockDetails: description: "Request payload to add lock to the resource. The FULL lock type allows no modifications (delete, create, update). \nThe DELETE lock type allows all modifications, but delete is not allowed.\ntype: object\n" properties: compartmentId: description: The compartment ID of the lock. type: string message: description: 'A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. ' type: string relatedResourceId: description: 'The ID of the Target that is locking this Target. Indicates that deleting this Target will remove the lock. ' type: string timeCreated: description: When the lock was created. format: date-time type: string type: description: Type of the lock. enum: - FULL - DELETE type: string required: - type - compartmentId UpdateMediaAssetDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Display name for the Media Asset. Does not have to be unique. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object masterMediaAssetId: description: The ID of the senior most asset from which this asset is derived. maxLength: 255 minLength: 1 type: string mediaAssetTags: description: List of tags for the MediaAsset. items: $ref: '#/components/schemas/MediaAssetTag' type: array metadata: description: List of Metadata. items: $ref: '#/components/schemas/Metadata' type: array parentMediaAssetId: description: The ID of the parent asset from which this asset is derived. maxLength: 255 minLength: 1 type: string type: description: The type of the media asset. enum: - AUDIO - VIDEO - PLAYLIST - IMAGE - CAPTION_FILE - UNKNOWN type: string x-obmcs-top-level-enum: '#/definitions/AssetType' type: object MediaWorkflowTaskDeclaration: description: The declaration of a type of task that can be used in a MediaWorkflow. properties: locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array name: description: 'MediaWorkflowTaskDeclaration identifier. The name and version should be unique among MediaWorkflowTaskDeclarations. ' type: string parametersSchema: additionalProperties: type: object description: 'JSON schema specifying the parameters supported by this type of task. This is used to validate tasks'' parameters when jobs are created. ' type: object parametersSchemaAllowingReferences: additionalProperties: type: object description: 'JSON schema similar to the parameterSchema, but permits parameter values to refer to other parameters using the ${/path/to/another/parmeter} syntax. This is used to validate task parameters when workflows are created. ' type: object version: description: 'The version of MediaWorkflowTaskDeclaration, incremented whenever the team implementing the task processor modifies the JSON schema of this declaration''s definitions, parameters or list of required parameters. ' type: integer required: - name - version - parametersSchema - parametersSchemaAllowingReferences type: object StreamDistributionChannelSummary: description: Summary of the Stream Distribution Channel. properties: compartmentId: description: Compartment Identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Stream Distribution Channel display name. Avoid entering confidential information. type: string domainName: description: The unique domain name of the Distribution Channel. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleState: description: The current state of the Stream Distribution Channel. type: string x-obmcs-enumref: '#/definitions/StreamDistributionChannel/lifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time when the Stream Distribution Channel was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the Stream Distribution Channel was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - displayName - compartmentId type: object ChangeMediaAssetCompartmentDetails: description: The information to be updated. properties: compartmentId: description: Compartment Identifier. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object CreateStreamPackagingConfigDetails: description: The information about the new Packaging Configuration. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The name of the stream Packaging Configuration. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string distributionChannelId: description: Unique identifier of the Distribution Channel that this stream packaging configuration belongs to. type: string encryption: $ref: '#/components/schemas/StreamPackagingConfigEncryption' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array segmentTimeInSeconds: default: 6 description: The duration in seconds for each fragment. maximum: 30 minimum: 1 type: integer streamPackagingFormat: description: The output format for the package. enum: - HLS - DASH type: string required: - distributionChannelId - displayName - streamPackagingFormat - segmentTimeInSeconds type: object MediaWorkflowCollection: description: 'Results of a MediaWorkflow search. Contains both MediaWorkflowSummary items and other information, such as metadata. ' properties: items: description: List of all MediaWorkflows. items: $ref: '#/components/schemas/MediaWorkflowSummary' type: array required: - items type: object StreamCdnConfigSection: description: Base fields of the StreamCdnConfig configuration object. discriminator: propertyName: type properties: type: description: The name of the CDN configuration type. enum: - EDGE - AKAMAI_MANUAL type: string required: - type type: object MediaWorkflowSummary: description: Summary of the MediaWorkflow. properties: compartmentId: description: Compartment Identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Name for the MediaWorkflow. Does not have to be unique, and it's changeable. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the MediaWorkflow. type: string x-obmcs-enumref: '#/definitions/MediaWorkflow/lifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time when the MediaWorkflow was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the MediaWorkflow was updated. An RFC3339 formatted datetime string. format: date-time type: string version: description: The version of MediaWorkflow. format: int64 type: integer required: - id - compartmentId type: object Metadata: description: Technical metadata for this asset. properties: metadata: description: JSON string containing the technial metadata for the media asset. type: string required: - metadata type: object MediaWorkflowTask: description: 'Defines the type of processing to be run at a given point in the workflow, parameters to configure the processing, and any processing that must be completed before this processing begins. ' properties: enableParameterReference: description: 'Allows this task to be conditionally enabled. If no value or a blank value is given, the task is unconditionally enbled. Otherwise the given string specifies a parameter of the job created for this task''s workflow using the JSON pointer syntax. The JSON pointer is validated when a job is created from the workflow of this task. ' type: string enableWhenReferencedParameterEquals: additionalProperties: type: object description: 'Used in conjunction with enableParameterReference to conditionally enable a task. When a job is created from the workflow of this task, the task will only be enabled if the value of the parameter specified by enableParameterReference is equal to the value of this property. This property must be prenset if and only if a enableParameterReference is given. The value is a JSON node. ' type: object key: description: 'A unique identifier for this task within its workflow. Keys are used to reference a task within workflows and MediaWorkflowJobs. Tasks are referenced as prerequisites and to track output and state. ' type: string parameters: additionalProperties: type: object description: 'Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters. ' type: object prerequisites: description: 'Keys to the other tasks in this workflow that must be completed before execution of this task can begin. ' items: type: string type: array uniqueItems: true type: description: 'The type of process to run at this task. Refers to the name of a MediaWorkflowTaskDeclaration. ' type: string version: description: The version of the MediaWorkflowTaskDeclaration. format: int64 type: integer required: - key - version - type - parameters type: object StreamPackagingConfigCollection: description: 'Results of a Packaging Configuration search. Contains both StreamPackagingConfigSummary items and other information, such as metadata. ' properties: items: description: List of Packaging Configurations. items: $ref: '#/components/schemas/StreamPackagingConfigSummary' type: array required: - items type: object MediaWorkflowConfigurationCollection: description: Results of a mediaWorkflowConfiguration search. Contains boh MediaWorkflowConfigurationSummary items and other information, such as metadata. properties: items: description: List of the mediaWorkflowConfigurationSummary objects. items: $ref: '#/components/schemas/MediaWorkflowConfigurationSummary' type: array required: - items type: object StreamPackagingConfigEncryption: description: The encryption used by the stream packaging configuration. discriminator: propertyName: algorithm properties: algorithm: description: The encryption algorithm for the stream packaging configuration. enum: - NONE - AES128 type: string required: - algorithm type: object MediaWorkflowJobSummary: description: Summary of a MediaWorkflowJob. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Name of the Media Workflow Job. Does not have to be unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier for this job. type: string lifecycleDetails: description: The lifecyle details. type: string lifecycleState: description: The current state of the MediaWorkflowJob. type: string x-obmcs-enumref: '#/definitions/MediaWorkflowJob/lifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array mediaWorkflowId: description: The workflow to execute. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: Creation time of the job. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: Updated time of the job. An RFC3339 formatted datetime string. format: date-time type: string type: object IngestStreamDistributionChannelResult: description: The Ingest Workflow Job information. properties: mediaWorkflowJobId: description: Identifier of the Ingest Workflow Job created. maxLength: 255 minLength: 1 type: string required: - mediaWorkflowJobId type: object MediaAssetSummary: description: Summary of the MediaAsset. properties: compartmentId: description: The ID of the compartment containing the MediaAsset. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: MediaAsset name. Does not have to be unique, and it's changeable. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleState: description: The current state of the MediaAsset. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array masterMediaAssetId: description: The ID of the senior most asset from which this asset is derived. type: string parentMediaAssetId: description: The ID of the parent asset from which this asset is derived. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the MediaAsset was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the MediaAsset was updated. An RFC3339 formatted datetime string. format: date-time type: string type: description: The type of the media asset. enum: - AUDIO - VIDEO - PLAYLIST - IMAGE - CAPTION_FILE - UNKNOWN type: string x-obmcs-top-level-enum: '#/definitions/AssetType' required: - id - compartmentId - type - lifecycleState type: object StreamDistributionChannelCollection: description: 'Results of a Stream Distribution Channel search. Contains both StreamDistributionChannelSummary items and other information, such as metadata. ' properties: items: description: List of Stream Distribution Channels. items: $ref: '#/components/schemas/StreamDistributionChannelSummary' type: array required: - items type: object StreamCdnConfig: description: Configuration used for integrating with a CDN. properties: compartmentId: description: Compartment Identifier. type: string config: $ref: '#/components/schemas/StreamCdnConfigSection' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The CDN Configuration identifier or display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string distributionChannelId: description: Distribution Channel Identifier. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string isEnabled: description: Whether publishing to CDN is enabled. type: boolean lifecycleState: description: The current state of the CDN Configuration. enum: - ACTIVE - NEEDS_ATTENTION - DELETED type: string lifecyleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time when the CDN Config was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the CDN Config was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - displayName - compartmentId - distributionChannelId - isEnabled - config type: object ResourceLock: description: 'Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource. ' properties: compartmentId: description: The compartment ID of the lock. type: string message: description: 'A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. ' type: string relatedResourceId: description: 'The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. ' type: string timeCreated: description: When the lock was created. format: date-time type: string type: description: Type of the lock. enum: - FULL - DELETE type: string required: - type - compartmentId type: object MediaAssetCollection: description: Results of a mediaAsset search. Contains both MediaAssetSummary items and other data. properties: items: description: List of mediaAssets. items: $ref: '#/components/schemas/MediaAssetSummary' type: array required: - items type: object MediaWorkflowJob: description: 'A MediaWorkflowJob represents a run of a MediaWorkflow for a specific set of parameters and configurations. ' properties: compartmentId: description: Compartment Identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Name of the Media Workflow Job. Does not have to be unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier for this run of the workflow. type: string lifecycleDetails: description: The lifecyle details. type: string lifecycleState: description: The current state of the MediaWorkflowJob. enum: - ACCEPTED - IN_PROGRESS - WAITING - REJECTED - FAILED - SUCCEEDED - CANCELING - CANCELED type: string locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array mediaWorkflowConfigurationIds: description: Configurations to be applied to this run of the workflow. items: type: string type: array mediaWorkflowId: description: The workflow to execute. type: string outputs: description: A list of JobOutput for the workflowJob. items: $ref: '#/components/schemas/JobOutput' type: array parameters: additionalProperties: type: object description: 'Parameters that override parameters specified in MediaWorkflowTaskDeclarations, the MediaWorkflow, the MediaWorkflow''s MediaWorkflowConfigurations and the MediaWorkflowConfigurations of this MediaWorkflowJob. The parameters are given as JSON. The top level and 2nd level elements must be JSON objects (vs arrays, scalars, etc). The top level keys refer to a task''s key and the 2nd level keys refer to a parameter''s name. ' type: object runnable: additionalProperties: type: object description: 'A JSON representation of the job as it will be run by the system. All the task declarations, configurations and parameters are merged. Parameter values are all fully resolved. ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object taskLifecycleState: description: Status of each task. items: $ref: '#/components/schemas/MediaWorkflowTaskState' type: array timeCreated: description: Creation time of the job. An RFC3339 formatted datetime string. format: date-time type: string timeEnded: description: Time when the job finished. An RFC3339 formatted datetime string. format: date-time type: string timeStarted: description: Time when the job started to execute. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: Updated time of the job. An RFC3339 formatted datetime string. format: date-time type: string required: - id - mediaWorkflowId - compartmentId type: object StreamCdnConfigCollection: description: 'Results of a streamCdnConfig search. Contains both StreamCdnConfigSummary items and other information, such as metadata. ' properties: items: description: List of streamCdnConfigs. items: $ref: '#/components/schemas/StreamCdnConfigSummary' type: array required: - items type: object CreateMediaWorkflowJobDetails: description: Information to run the MediaWorkflow. discriminator: propertyName: workflowIdentifierType properties: compartmentId: description: ID of the compartment in which the job should be created. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Name of the Media Workflow Job. Does not have to be unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array mediaWorkflowConfigurationIds: description: Configurations to be applied to this run of the workflow. items: type: string type: array parameters: additionalProperties: type: object description: 'Parameters that override parameters specified in MediaWorkflowTaskDeclarations, the MediaWorkflow, the MediaWorkflow''s MediaWorkflowConfigurations and the MediaWorkflowConfigurations of this MediaWorkflowJob. The parameters are given as JSON. The top level and 2nd level elements must be JSON objects (vs arrays, scalars, etc). The top level keys refer to a task''s key and the 2nd level keys refer to a parameter''s name. ' type: object workflowIdentifierType: description: Discriminate identification of a workflow by name versus a workflow by ID. enum: - ID - NAME type: string required: - workflowIdentifierType - compartmentId type: object MediaWorkflowTaskDeclarationCollection: description: 'Results of the ListMediaWorkflowTaskDeclaration operation, a list of MediaWorkflowTaskDeclarations. ' properties: items: description: List of MediaWorkflowTaskDeclaration objects. items: $ref: '#/components/schemas/MediaWorkflowTaskDeclaration' type: array required: - items type: object MediaAssetTag: description: Tags of the MediaAsset. properties: type: description: Type of the tag. enum: - USER - SYSTEM type: string value: description: Tag of the MediaAsset. type: string required: - value type: object ChangeMediaWorkflowJobCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object CreateStreamDistributionChannelDetails: description: The information about the new Stream Distribution Channel. properties: compartmentId: description: Compartment Identifier. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Stream Distribution Channel display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array required: - displayName - compartmentId type: object MediaWorkflowTaskState: description: Status of a task in a workflow job being run. properties: key: description: Unique key within a MediaWorkflowJob for the task. type: string lifecycleDetails: description: The lifecycle details of MediaWorkflowJob task. type: string lifecycleState: description: The current state of the MediaWorkflowJob task. type: string x-obmcs-enumref: '#/definitions/MediaWorkflowJob/lifecycleState' type: object MediaAssetDistributionChannelAttachment: description: Attachment between MediaAsset and streaming DistributionChannel. properties: displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. type: string distributionChannelId: description: OCID of associated Distribution Channel. type: string lifecycleState: description: Lifecycle state of the attachment. enum: - CREATING - ACTIVE - NEEDS_ATTENTION - UPDATING type: string locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 1 type: array mediaWorkflowJobId: description: The ingest MediaWorkflowJob ID that created this attachment. type: string metadataRef: description: The identifier for the metadata. type: string version: description: Version of the attachment. format: int64 type: integer required: - distributionChannelId - version - lifecycleState - metadataRef type: object responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-tag-groups: flowCellDeployment: - mediaServices logging: - mediaServices mediaAsset: - mediaServices mediaAssetDistributionChannelAttachment: - mediaServices mediaWorkflow: - mediaServices mediaWorkflowConfiguration: - mediaServices mediaWorkflowJob: - mediaServices mediaWorkflowTaskDeclaration: - mediaServices streamCdnConfig: - mediaServices streamCellAssignmentGroup: - mediaServices streamCellDeployment: - mediaServices streamDistributionChannel: - mediaServices streamPackagingConfig: - mediaServices streamPlaylist: - mediaStream streamSessionToken: - mediaStream x-tenancy-groups: streamAdminListTenancies: - boat - ocid1.tenancy.oc1..aaaaaaaaqbwgdkzsx5cd2kiu3p32nnz3kkra5dchg5d3olbnxcbi3y5mkgoq - ocid1.tenancy.oc1..aaaaaaaahyw7vxxqtskl2qhhj5be3yvnollsfowsxoekcdbfhcfmhof62jga - ocid1.tenancy.oc1..aaaaaaaakprqz2dsqoloq2norxisvjaumwep5sl6cx2ktwioyxzjebmmekca - ocid1.tenancy.oc1..aaaaaaaagmko4nzct4hpfhqviwxo4cim4zsezpjrxembuapkhchg2rvwhqha - ocid1.tenancy.oc1..aaaaaaaatf4g2zretdqp4n3vfmrp7lwa5j7kx2s3xexequp5q3zpa5tmhpra - ocid1.tenancy.oc5..aaaaaaaarik3gd4tvsvx2tn3izg5l5gggcnglhrt7o3kijq5tnvpgcad3zra - ocid1.tenancy.region1..aaaaaaaa72w5f5zeb5yx745amjc2rv4tvbabywnklsahd4oh4bcee34kvu2a - ocid1.tenancy.oc1..aaaaaaaav4xzhmyw4ewi7mciau2y47eqzxv32wayrl5kmrfjvc2vommkcsfq - ocid1.tenancy.oc1..aaaaaaaafkxx2wtortpikuo63ywglstgfhdrn62s5shcicvuccfqzhqnqr6q - ocid1.tenancy.oc1..aaaaaaaabss5hrvab4ophshqmw7tyxipbhyirsxeijmitfmzlnayxjuaqy6a streamAdminTenancies: - boat - ocid1.tenancy.oc1..aaaaaaaaqbwgdkzsx5cd2kiu3p32nnz3kkra5dchg5d3olbnxcbi3y5mkgoq - ocid1.tenancy.oc1..aaaaaaaahyw7vxxqtskl2qhhj5be3yvnollsfowsxoekcdbfhcfmhof62jga - ocid1.tenancy.oc1..aaaaaaaakprqz2dsqoloq2norxisvjaumwep5sl6cx2ktwioyxzjebmmekca - ocid1.tenancy.oc1..aaaaaaaagmko4nzct4hpfhqviwxo4cim4zsezpjrxembuapkhchg2rvwhqha - ocid1.tenancy.oc1..aaaaaaaatf4g2zretdqp4n3vfmrp7lwa5j7kx2s3xexequp5q3zpa5tmhpra - ocid1.tenancy.oc5..aaaaaaaarik3gd4tvsvx2tn3izg5l5gggcnglhrt7o3kijq5tnvpgcad3zra x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.oci.dmp