{ "components": { "schemas": { "AnyValue": {}, "ConfigRefSchema": { "properties": { "name": { "description": "Name of the configuration template to use, must match the configType.", "type": "string" }, "version": { "description": "Which revision of the configuration to use, either a tag or a hash must be provided", "example": "latest", "type": "string" } }, "required": [ "name", "version" ], "title": "ConfigRefSchema", "type": "object" }, "ConfigSchema": { "properties": { "advancedSettingsName": { "description": "Name of the advanced settings configuration to apply to this component.\nThese configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.", "maxLength": 64, "nullable": true, "type": "string" }, "configOverrides": { "description": "Optional control over template contents. These are applied after any configValues.", "discriminator": { "mapping": { "application/json-patch+json": "#/components/schemas/FlowJsonPatchOverrides" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/FlowJsonPatchOverrides" } ] }, "configRef": { "$ref": "#/components/schemas/ConfigRefSchema", "description": "Reference to configuration template" }, "configValues": { "additionalProperties": { "$ref": "#/components/schemas/AnyValue" }, "description": "Optional control over template contents, replacing parameters exposed by the configuration.\nThese are applied before any configOverrides.", "example": { "audio1label": "Spanish", "audio1lang": "spa", "audio1pid": 257, "epochts": false }, "nullable": true, "type": "object" } }, "required": [ "configRef" ], "title": "ConfigSchema", "type": "object" }, "DefaultMetadata": { "properties": { "displayName": { "description": "A human-readable name for the resource.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "A dictionary of labels associated with the resource.\n Maximum number of labels: 32.\n Maximum length of a label or value: 256 characters.\n Label: alphanumeric, hyphens and underscores.\n Value: alphanumeric, hyphens, underscores and spaces.", "maxProperties": 32, "type": "object" } }, "required": [ "displayName" ], "title": "DefaultMetadata", "type": "object" }, "DefaultPatchMetadata": { "properties": { "displayName": { "description": "A human-readable name for the resource.", "maxLength": 255, "minLength": 1, "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "A dictionary of labels associated with the resource.\n Maximum number of labels: 32.\n Maximum length of a label or value: 256 characters.\n Label: alphanumeric, hyphens and underscores.\n Value: alphanumeric, hyphens, underscores and spaces.", "maxProperties": 32, "type": "object" } }, "title": "DefaultPatchMetadata", "type": "object" }, "Error": { "properties": { "error": { "$ref": "#/components/schemas/ErrorDetail", "description": "Pertinent information about the error" }, "ref": { "description": "A reference to the request that caused the error.", "type": "string" }, "status": { "description": "The HTTP status code", "type": "integer" } }, "required": [ "error", "status", "ref" ], "title": "Error", "type": "object" }, "ErrorDetail": { "properties": { "code": { "description": "The error code.", "type": "string" }, "detail": { "description": "The error message.", "type": "string" }, "extraDetail": { "additionalProperties": {}, "description": "Extra information regarding this error.", "type": "object" } }, "required": [ "code", "detail" ], "title": "ErrorDetail", "type": "object" }, "FlowBody": { "properties": { "metadata": { "$ref": "#/components/schemas/DefaultMetadata", "description": "Resource metadata." }, "spec": { "$ref": "#/components/schemas/FlowBodySpec", "description": "Flow specification." } }, "required": [ "metadata", "spec" ], "title": "FlowBody", "type": "object" }, "FlowBodySpec": { "properties": { "inputs": { "description": "List of flow inputs.\n\nRead [Flow inputs and outputs](doc:flows#flow-inputs-and-outputs) to learn more about how to connect flow inputs between content and flow transform inputs.", "items": { "$ref": "#/components/schemas/FlowInputFragment" }, "type": "array" }, "outputs": { "description": "List of flow outputs.\n\nRead [Flow inputs and outputs](doc:flows#flow-inputs-and-outputs) to learn more about how to connect flow outputs between flow transform outputs and destinations or to make them available to other flows.", "items": { "$ref": "#/components/schemas/FlowOutputFragment" }, "type": "array" }, "refiner": { "$ref": "#/components/schemas/FlowRefinerFragment", "description": "The <> that influence how this flow will be assigned. This is a placeholder for future functionality." }, "siteName": { "description": "The name of the <> where the flow will run. If omitted, the site is inferred from the flow type: cloud flows default to the project's cloud site; device flows default to the 'world' site.", "example": "world", "pattern": "^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "type": "string" }, "state": { "description": "The desired state of the flow.", "enum": [ "Stopped", "Running" ], "example": "Running", "type": "string" }, "transform": { "description": "Configuration for the transformation that this flow performs", "discriminator": { "mapping": { "LiveChannel": "#/components/schemas/LiveChannelFlow", "LiveEvent": "#/components/schemas/LiveEventFlow", "StaticMultiviewChannel": "#/components/schemas/StaticMultiviewChannelFlow", "StaticMultiviewEvent": "#/components/schemas/StaticMultiviewEventFlow" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/LiveChannelFlow" }, { "$ref": "#/components/schemas/LiveEventFlow" }, { "$ref": "#/components/schemas/StaticMultiviewChannelFlow" }, { "$ref": "#/components/schemas/StaticMultiviewEventFlow" } ] } }, "required": [ "transform", "inputs", "outputs", "state" ], "title": "FlowBodySpec", "type": "object" }, "FlowGetSchema": { "properties": { "kind": { "description": "The kind of record.", "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataSchema", "description": "Flow metadata." }, "spec": { "$ref": "#/components/schemas/FlowBodySpec", "description": "Flow specification." }, "status": { "$ref": "#/components/schemas/FlowStatusGetSchema", "description": "Flow status." } }, "required": [ "kind", "spec", "metadata", "status" ], "title": "FlowGetSchema", "type": "object" }, "FlowInputFragment": { "description": "Describes an input to a flow.\n\nA flow input can be specified as either a connection to <>, a connection to a specific\n<>, or a connection to a specific <>. Exactly one of either contentName,\nsourceName or flowName must be specified.", "properties": { "contentName": { "description": "The <> that the flow input is connected to. This also influences the content that will be available on the flow outputs.\n\nRead [Resolving content](doc:content-and-sources#resolving-content) to learn more about how content is resolved to the <>s and <>s that can supply it.", "example": "channel-1", "pattern": "^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "type": "string" }, "flowName": { "description": "The upstream <> that the flow input is connected to. This also influences the content that will be available on the flow outputs.", "example": "flow-1", "pattern": "^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "type": "string" }, "refiner": { "$ref": "#/components/schemas/FlowInputRefinerFragment", "description": "The <> that influence how this flow input will be assigned and how [content will be resolved](/api-guides/how-to/media/content-and-sources#resolving-content) for it. For example, flow inputs can be constrained to specific upstream <>s and <>s. To learn more, read [Flow input refiners](doc:flows#flow-input-refiners)." }, "sourceName": { "description": "The <> that the flow input is connected to. This also influences the content that will be available on the flow outputs.", "example": "source-1", "pattern": "^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "type": "string" }, "transformInput": { "description": "The name of the input pin to connect in the associated processing config. Retrieve the config through the Templates API and use a name from `status.inputPins[].name`.", "example": "encoding/input_1", "maxLength": 128, "minLength": 1, "type": "string" } }, "title": "FlowInputFragment", "type": "object" }, "FlowInputRefinerFragment": { "properties": { "flow": { "$ref": "#/components/schemas/NameRefinerFragment", "description": "Refiner to restrict a flow's input to originate from a specific flow." }, "labelMatch": { "$ref": "#/components/schemas/LabelMatchRefinerFragment", "description": "Refiner to restrict a flow's input to originate from one of a set of both flows and content sources." } }, "title": "FlowInputRefinerFragment", "type": "object" }, "FlowInputStatusFragment": { "properties": { "contentDisplayName": { "description": "If the flow input references content, this field contains the display name of that <>.\nIf the flow input references a source, this field contains the display name of the <> referenced by that source.\nIf the flow input references a flow, this field contains the display name of the <> assigned to the resolved upstream flow output, or empty if resolution failed.", "example": "Channel 1", "maxLength": 255, "type": "string" }, "contentName": { "description": "If the flow input references content, this field contains the name of that <>.\nIf the flow input references a source, this field contains the name of the <> referenced by that source.\nIf the flow input references a flow, this field contains the name of the <> assigned to the resolved upstream flow output, or empty if resolution failed.", "example": "channel-1", "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$", "type": "string" }, "deviceInterfaceName": { "description": "The name of the <> assigned to the flow input. Empty if a device interface is not assigned.", "example": "eth0", "pattern": "^([^\\s\\/]{1,16}|[a-zA-Z][a-zA-Z0-9_]{1,255})?$", "type": "string" }, "networkDisplayName": { "description": "The display name of the <> assigned to the flow input. Empty if the content was resolved from a directly-connected <> (e.g. SDI) or a network is not assigned.", "example": "Internet", "maxLength": 255, "type": "string" }, "networkName": { "description": "The name of the <> assigned to the flow input. Empty if the content was resolved from a directly-connected <> (e.g. SDI) or a network is not assigned.", "example": "internet", "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$", "type": "string" }, "sourceDisplayName": { "description": "The display name of the <> assigned to the flow input. Empty if the content was resolved to an upstream <> or a source is not assigned.", "example": "Channel 1 SRT", "maxLength": 255, "type": "string" }, "sourceName": { "description": "The name of the <> assigned to the flow input. Empty if the content was resolved to an upstream <> or a source is not assigned.", "example": "channel-1-srt", "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$", "type": "string" }, "sourceShortId": { "description": "An alternative short identifier for the source. This is used only for visual inspection and should not be used for any programmatic purposes.", "example": "a1b2c3d4e5f6", "pattern": "^([a-z0-9]{12})?$", "type": "string" }, "sourceUrl": { "description": "The ingress URL for the <> assigned to the flow input. Empty if the source does not have a URL.", "example": "srt://10.10.10.1:6000", "maxLength": 2048, "nullable": true, "type": "string" }, "upstreamFlowName": { "description": "The name of an upstream <> providing the input. Empty if the content was resolved to a <> or if an upstream flow is not assigned.", "example": "channel-1-encode", "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$", "type": "string" } }, "title": "FlowInputStatusFragment", "type": "object" }, "FlowJsonPatchOverrides": { "properties": { "operations": { "description": "List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.", "items": { "$ref": "#/components/schemas/JsonPatchEntry" }, "type": "array" }, "type": { "description": "Type of override.", "example": "application/json-patch+json", "type": "string" } }, "required": [ "type", "operations" ], "title": "FlowJsonPatchOverrides", "type": "object" }, "FlowListResponseSchema": { "properties": { "@odata.nextLink": { "description": "@odata.nextLink URL if the page length and number of items match.", "readOnly": true, "type": "string" }, "supplemental": { "$ref": "#/components/schemas/ListResponseSupplementalSchema", "description": "Supplemental info", "readOnly": true }, "value": { "description": "A list of flows.", "items": { "$ref": "#/components/schemas/FlowGetSchema" }, "type": "array" } }, "required": [ "supplemental", "value" ], "title": "FlowListResponseSchema", "type": "object" }, "FlowOutputFragment": { "properties": { "contentName": { "description": "Optional, sets the <> that is provided by this flow output.", "type": "string" }, "destinationName": { "description": "The destination to connect the flow output to. Omit this field to create an <>.\n\nRead [Flows](doc:flows) to learn more about how to connect flows to other flows.", "example": "production-1", "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$", "type": "string" }, "refiner": { "$ref": "#/components/schemas/FlowOutputRefinerFragment", "description": "The <> that influence how this flow output will be assigned. This is a placeholder for future functionality." }, "transformOutput": { "description": "The name of the output pin to connect in the associated processing config. Retrieve the config through the Templates API and use a name from `status.outputPins[].name`.", "example": "encoding/output_1", "maxLength": 128, "minLength": 1, "type": "string" }, "transport": { "$ref": "#/components/schemas/FlowOutputTransportFragment", "description": "Transport setting overrides for this specific flow output. If not specified, the transport will use the default settings." } }, "title": "FlowOutputFragment", "type": "object" }, "FlowOutputRefinerFragment": { "properties": {}, "title": "FlowOutputRefinerFragment", "type": "object" }, "FlowOutputStatusFragment": { "properties": { "contentDisplayName": { "description": "The display name of the <> that is provided by this flow output.", "maxLength": 255, "type": "string" }, "contentName": { "description": "The <> that is provided by this flow output.", "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$", "type": "string" }, "destinationDisplayName": { "description": "The display name of the <> reference from the flow output. Empty if this is a <> with no destination.", "example": "production-1", "maxLength": 255, "type": "string" }, "destinationUrl": { "description": "The egress URL for the <> assigned to the flow output. Empty if the destination does not have a URL.", "example": "srt://10.10.10.2:6000", "maxLength": 2048, "nullable": true, "type": "string" }, "deviceInterfaceName": { "description": "The name of the <> assigned to the flow output. Empty if a device interface is not assigned.", "example": "eth0", "pattern": "^([^\\s\\/]{1,16}|[a-zA-Z][a-zA-Z0-9_]{1,255})?$", "type": "string" }, "downstreamFlowNames": { "description": "List of names of <>s that are connected to this flow output. Empty if the flow output is not connected to any downstream flows.", "items": { "type": "string" }, "type": "array" }, "networkDisplayName": { "description": "The display name of the <> assigned to the flow outputEmpty if the output references a directly-connected <> (e.g. SDI) or a network is not assigned.", "example": "Internet", "maxLength": 255, "type": "string" }, "networkName": { "description": "The name of the <> assigned to the flow output. Empty if the output references a directly-connected <> (e.g. SDI) or a network is not assigned.", "example": "internet", "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$", "type": "string" }, "transport": { "$ref": "#/components/schemas/FlowOutputStatusTransportFragment", "description": "Transport settings specific to this flow output." } }, "required": [ "contentName", "contentDisplayName" ], "title": "FlowOutputStatusFragment", "type": "object" }, "FlowOutputStatusTransportFragment": { "properties": { "latency": { "description": "The minimum SRT Latency, in seconds for this output's connections, if known.", "example": 10, "type": "number" }, "maxBitrate": { "description": "The calculated maximum bitrate for the flow output's transport.", "type": "integer" }, "maxConnections": { "description": "The maximum number of connections allowed for this output where a restriction applies.", "example": 10, "minimum": 1, "type": "integer" } }, "required": [ "maxBitrate" ], "title": "FlowOutputStatusTransportFragment", "type": "object" }, "FlowOutputTransportFragment": { "properties": { "maxConnections": { "description": "Optional, specifies the maximum number of connections for this output if no destination is specified.", "example": 10, "minimum": 1, "type": "integer" } }, "title": "FlowOutputTransportFragment", "type": "object" }, "FlowPatchBody": { "properties": { "metadata": { "$ref": "#/components/schemas/DefaultPatchMetadata", "description": "Resource metadata." }, "spec": { "$ref": "#/components/schemas/FlowPatchBodySpec", "description": "Flow specification." } }, "title": "FlowPatchBody", "type": "object" }, "FlowPatchBodySpec": { "properties": { "state": { "description": "The desired state of the flow.", "enum": [ "Stopped", "Running" ], "example": "Running", "type": "string" }, "transform": { "description": "Configuration for the transformation that this flow performs", "discriminator": { "mapping": { "LiveChannel": "#/components/schemas/LiveChannelPatchFlow", "LiveEvent": "#/components/schemas/LiveEventPatchFlow", "StaticMultiviewChannel": "#/components/schemas/StaticMultiviewChannelPatchFlow", "StaticMultiviewEvent": "#/components/schemas/StaticMultiviewEventPatchFlow" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/LiveChannelPatchFlow" }, { "$ref": "#/components/schemas/LiveEventPatchFlow" }, { "$ref": "#/components/schemas/StaticMultiviewChannelPatchFlow" }, { "$ref": "#/components/schemas/StaticMultiviewEventPatchFlow" } ] } }, "title": "FlowPatchBodySpec", "type": "object" }, "FlowRefinerFragment": { "properties": {}, "title": "FlowRefinerFragment", "type": "object" }, "FlowStatusGetSchema": { "properties": { "deviceDisplayName": { "description": "The display name of the <> the flow is assigned to. Empty if not assigned or if the flow is on a <>.", "example": "Device 1", "maxLength": 255, "type": "string" }, "deviceName": { "default": "", "description": "The name of the <> the flow is assigned to. Empty if not assigned or if the flow is on a <>.", "example": "device-1", "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$", "type": "string" }, "info": { "description": "An optional informational message. Only present if not empty.", "example": "There was an issue with start due to a mismatch of Template inputs and configured inputs.", "type": "string" }, "inputs": { "description": "The status of flow inputs.", "items": { "$ref": "#/components/schemas/FlowInputStatusFragment" }, "type": "array" }, "metrics": { "additionalProperties": { "$ref": "#/components/schemas/FlowStatusMetricSchema" }, "description": "A dictionary of metrics reported by the flow.The keys are metrics names and the values contains an array of samples for that metric.The Sample contains a 'value' field and a 'labels' field which is a dictionary of label keys and values.", "example": { "mk_resource_status": [ { "labels": { "mkio_stage": "encode" }, "value": 0 }, { "labels": { "mkio_stage": "output" }, "value": 0 }, { "labels": { "mkio_stage": "resource" }, "value": 0 } ] }, "type": "object" }, "monitoring": { "additionalProperties": { "$ref": "#/components/schemas/MonitoringDetailsSchema" }, "description": "Details for how to access monitoring feedback. Each key is a monitoring context that is influenced by the <> selected in the flow and the configuration of the flow transform. Read [flow monitoring](doc:flows#monitoring) to learn more.", "type": "object" }, "outputs": { "description": "The status of flow outputs.", "items": { "$ref": "#/components/schemas/FlowOutputStatusFragment" }, "type": "array" }, "shortId": { "description": "An alternative short identifier for the flow. This is used only for visual inspection and should not be used for any programmatic purposes.", "example": "a1b2c3d4e5f6", "pattern": "^([a-z0-9]{12})?$", "type": "string" }, "siteDisplayName": { "description": "The display name of <> associated with the flow.", "example": "World", "maxLength": 255, "type": "string" }, "state": { "description": "The last reported state of the flow.", "enum": [ "", "Stopping", "Stopped", "Starting", "Running", "Pending", "Deleting", "Deleted", "Updating", "Started", "Allocating", "Allocated", "UnableToStart" ], "example": "Started", "type": "string" }, "transform": { "$ref": "#/components/schemas/FlowTransformStatus", "description": "" } }, "title": "FlowStatusGetSchema", "type": "object" }, "FlowStatusMetricSchema": { "properties": { "labels": { "additionalProperties": { "type": "string" }, "description": "A dictionary of label keys and values for this metric sample.", "type": "object" }, "value": { "description": "The value of the metric sample.", "type": "number" } }, "required": [ "value" ], "title": "FlowStatusMetricSchema", "type": "object" }, "FlowTransformStatus": { "properties": { "streamPersonalization": { "$ref": "#/components/schemas/FlowTransformStatusStreamPersonalization", "description": "" } }, "title": "FlowTransformStatus", "type": "object" }, "FlowTransformStatusStreamPersonalization": { "properties": { "hostName": { "description": "", "type": "string" } }, "title": "FlowTransformStatusStreamPersonalization", "type": "object" }, "JsonPatchEntry": { "properties": { "op": { "description": "Operation", "enum": [ "add", "remove", "replace", "stringReplace", "numberReplace" ], "type": "string" }, "path": { "description": "Path", "type": "string" }, "search": { "description": "Search string for 'stringReplace' and 'numberReplace' operations. \n'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e \"audio_pid\" would be replaced with 50, not \"50\".", "type": "string" }, "value": { "$ref": "#/components/schemas/AnyValue", "description": "Value" } }, "required": [ "op", "path" ], "title": "JsonPatchEntry", "type": "object" }, "LabelMatchRefinerFragment": { "properties": { "key": { "description": "Name of the label to match against. Case sensitive.", "type": "string" }, "value": { "description": "The desired value of the label. Case sensitive.", "type": "string" } }, "required": [ "key", "value" ], "title": "LabelMatchRefinerFragment", "type": "object" }, "ListResponseSupplementalSchema": { "properties": { "count": { "description": "Number of items returned", "readOnly": true, "type": "integer" }, "kind": { "description": "Type of items in the list", "readOnly": true, "type": "string" }, "operation": { "description": "Operation type. Should always say 'list'", "readOnly": true, "type": "string" }, "pagination": { "$ref": "#/components/schemas/PaginationInfoSchema", "description": "Pagination info", "readOnly": true }, "subscription": { "$ref": "#/components/schemas/ProjectInfoSchema", "description": "Project info", "readOnly": true } }, "required": [ "kind", "count", "operation", "pagination" ], "title": "ListResponseSupplementalSchema", "type": "object" }, "LiveChannelFlow": { "description": "A 24x7 flow that takes live input and encodes it, storing the material in the asset named by the required assetName field.\n\nStarting a LiveChannel flow will immediately charge the full monthly fee to your payment method,\nno matter how much of the month remains.\n\nPlease see LiveEvent for encoding billed by the minute.", "properties": { "archiveWindowLength": { "description": "The maximum content length that can be archived in the asset for the live output. This also limits the maximum content length for the timeshift window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. Max value = 30 days.", "pattern": "^P(?:(?P\\d+)Y)?(?:(?P\\d+)M)?(?:(?P\\d+)W)?(?:(?P\\d+)D)?T(?:(?P\\d+)H)?(?:(?P\\d+)M)?(?:(?P(?:\\d*.)?\\d+)S)?$", "type": "string" }, "assetName": { "description": "The name of asset that you want this flow to store material in.", "type": "string" }, "assetPath": { "description": "If an asset name is given, then you may also specify a subpath within the asset for the material.", "type": "string" }, "encodingLive": { "$ref": "#/components/schemas/ConfigSchema", "description": "Reference to template of type 'encodingLive'" }, "streamConditioning": { "$ref": "#/components/schemas/ConfigSchema", "description": "Optional reference to template of type 'streamConditioning'" }, "type": { "description": "Processing type.", "type": "string" } }, "required": [ "type", "assetName", "encodingLive" ], "title": "LiveChannelFlow", "type": "object" }, "LiveChannelPatchFlow": { "properties": { "type": { "description": "Processing type.", "type": "string" } }, "required": [ "type" ], "title": "LiveChannelPatchFlow", "type": "object" }, "LiveEventFlow": { "description": "A flow that takes live input and encodes it, storing the material in the asset named by the required assetName field.\n\nA LiveEvent flow is billed by the minute, please see LiveChannel for encoding billed by the\nmonth.", "properties": { "archiveWindowLength": { "description": "The maximum content length that can be archived in the asset for the live output. This also limits the maximum content length for the timeshift window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. Max value = 30 days.", "pattern": "^P(?:(?P\\d+)Y)?(?:(?P\\d+)M)?(?:(?P\\d+)W)?(?:(?P\\d+)D)?T(?:(?P\\d+)H)?(?:(?P\\d+)M)?(?:(?P(?:\\d*.)?\\d+)S)?$", "type": "string" }, "assetName": { "description": "The name of asset that you want this flow to store material in.", "type": "string" }, "assetPath": { "description": "If an asset name is given, then you may also specify a subpath within the asset for the material.", "type": "string" }, "encodingLive": { "$ref": "#/components/schemas/ConfigSchema", "description": "Reference to template of type 'encodingLive'" }, "streamConditioning": { "$ref": "#/components/schemas/ConfigSchema", "description": "Optional reference to template of type 'streamConditioning'" }, "type": { "description": "Processing type.", "type": "string" } }, "required": [ "type", "assetName", "encodingLive" ], "title": "LiveEventFlow", "type": "object" }, "LiveEventPatchFlow": { "properties": { "type": { "description": "Processing type.", "type": "string" } }, "required": [ "type" ], "title": "LiveEventPatchFlow", "type": "object" }, "MetadataSchema": { "properties": { "created": { "description": "The time when the resource was created", "format": "date-time", "type": "string" }, "createdBy": { "description": "ID of the user who created the resource", "format": "uuid", "type": "string" }, "createdByEmail": { "description": "Email of the user who created the resource", "type": "string" }, "displayName": { "description": "The display name of the resource", "type": "string" }, "id": { "description": "The ID of the resource", "format": "uuid", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "A dictionary of labels associated with the resource", "example": { "label1": "value1", "label2": "value2" }, "type": "object" }, "name": { "description": "The name of the resource", "type": "string" }, "updated": { "description": "The time when the resource was last updated", "format": "date-time", "type": "string" }, "updatedBy": { "description": "ID of the user who last updated the resource", "format": "uuid", "type": "string" }, "updatedByEmail": { "description": "Email of the user who last updated the resource", "type": "string" } }, "required": [ "id" ], "title": "MetadataSchema", "type": "object" }, "MonitoringDetailsSchema": { "properties": { "metadataUrl": { "description": "URL of the metadata.", "maxLength": 2048, "type": "string" }, "thumbnailUrl": { "description": "URL of the thumbnail image.", "maxLength": 2048, "type": "string" } }, "required": [ "thumbnailUrl", "metadataUrl" ], "title": "MonitoringDetailsSchema", "type": "object" }, "NameRefinerFragment": { "properties": { "name": { "description": "Name of the resource to match.", "type": "string" } }, "required": [ "name" ], "title": "NameRefinerFragment", "type": "object" }, "PaginationInfoSchema": { "properties": { "end": { "description": "Position of the last item in the list", "readOnly": true, "type": "integer" }, "records": { "description": "Total number of items returned in the list", "readOnly": true, "type": "integer" }, "start": { "description": "Position of the first item in the list", "readOnly": true, "type": "integer" }, "total": { "description": "Total number of items in the project", "readOnly": true, "type": "integer" } }, "required": [ "start", "end", "records", "total" ], "title": "PaginationInfoSchema", "type": "object" }, "ProjectInfoSchema": { "properties": { "id": { "description": "Project ID", "readOnly": true, "type": "string" }, "name": { "description": "Project name", "readOnly": true, "type": "string" } }, "required": [ "id", "name" ], "title": "ProjectInfoSchema", "type": "object" }, "ResourceStateSchema": { "properties": { "status": { "$ref": "#/components/schemas/ResourceStateStatus", "description": "The status of the resource." } }, "required": [ "status" ], "title": "ResourceStateSchema", "type": "object" }, "ResourceStateStatus": { "properties": { "state": { "description": "The state of the resource. The value depends on the resource type.", "type": "string" } }, "required": [ "state" ], "title": "ResourceStateStatus", "type": "object" }, "ScheduledOperationListSchema": { "properties": { "@odata.nextLink": { "description": "@odata.nextLink URL if the page length and number of items match.", "readOnly": true, "type": "string" }, "supplemental": { "$ref": "#/components/schemas/ListResponseSupplementalSchema", "description": "Supplemental info", "readOnly": true }, "value": { "description": "A list of scheduled operations", "items": { "$ref": "#/components/schemas/ScheduledOperationSchema" }, "type": "array" } }, "required": [ "supplemental", "value" ], "title": "ScheduledOperationListSchema", "type": "object" }, "ScheduledOperationMetadataSchema": { "properties": { "id": { "description": "The ID of the resource", "format": "uuid", "readOnly": true, "type": "string" }, "name": { "description": "The name of the resource", "example": "name", "maxLength": 260, "minLength": 1, "pattern": "^[^\\^\\'<>%&:\\\\?/*+]+$", "readOnly": true, "type": "string" } }, "title": "ScheduledOperationMetadataSchema", "type": "object" }, "ScheduledOperationPutSchema": { "properties": { "spec": { "description": "", "discriminator": { "mapping": { "MediaKind.ScheduledOperation.StartStop": "#/components/schemas/ScheduledOperationStartStopSpecSchema" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ScheduledOperationStartStopSpecSchema" } ] } }, "required": [ "spec" ], "title": "ScheduledOperationPutSchema", "type": "object" }, "ScheduledOperationSchema": { "properties": { "metadata": { "$ref": "#/components/schemas/ScheduledOperationMetadataSchema", "description": "", "readOnly": true }, "spec": { "description": "", "discriminator": { "mapping": { "MediaKind.ScheduledOperation.StartStop": "#/components/schemas/ScheduledOperationStartStopSpecSchema" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ScheduledOperationStartStopSpecSchema" } ] }, "status": { "$ref": "#/components/schemas/ScheduledOperationStatusSchema", "description": "", "readOnly": true } }, "required": [ "spec" ], "title": "ScheduledOperationSchema", "type": "object" }, "ScheduledOperationStartStopSpecSchema": { "properties": { "correlationData": { "additionalProperties": { "$ref": "#/components/schemas/AnyValue" }, "description": "User data", "type": "object" }, "endTime": { "description": "End of the event", "format": "date-time", "type": "string" }, "startTime": { "description": "Start of the event", "format": "date-time", "type": "string" }, "type": { "description": "Event Type", "enum": [ "MediaKind.ScheduledOperation.StartStop" ], "type": "string" } }, "required": [ "type", "correlationData", "startTime", "endTime" ], "title": "ScheduledOperationStartStopSpecSchema", "type": "object" }, "ScheduledOperationStatusSchema": { "properties": { "errors": { "description": "description of the errors found", "items": { "type": "string" }, "type": "array" }, "state": { "description": "State of the scheduled operation", "enum": [ "Pending", "Accepted", "Errored", "Ongoing", "Completed" ], "type": "string" } }, "required": [ "state" ], "title": "ScheduledOperationStatusSchema", "type": "object" }, "StaticMultiviewChannelFlow": { "description": "A 24x7 flow that takes multiple live inputs, composes and encodes them, storing the material in the asset named by the required assetName field.\n\nSupports two modes:\n- With multiviewComposing: Inputs defined in multiviewComposing config.\n- Without multiviewComposing: Inputs defined in encodingLive config using multiInputComposer input type.\n\nStarting a StaticMultiviewChannel flow will immediately charge the full monthly fee to your payment method,\nno matter how much of the month remains.\n\nPlease see StaticMultiviewEvent for encoding billed by the minute.", "properties": { "archiveWindowLength": { "description": "The maximum content length that can be archived in the asset for the live output. This also limits the maximum content length for the timeshift window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. Max value = 30 days.", "pattern": "^P(?:(?P\\d+)Y)?(?:(?P\\d+)M)?(?:(?P\\d+)W)?(?:(?P\\d+)D)?T(?:(?P\\d+)H)?(?:(?P\\d+)M)?(?:(?P(?:\\d*.)?\\d+)S)?$", "type": "string" }, "assetName": { "description": "The name of asset that you want this flow to store material in.", "type": "string" }, "assetPath": { "description": "If an asset name is given, then you may also specify a subpath within the asset for the material.", "type": "string" }, "encodingLive": { "$ref": "#/components/schemas/ConfigSchema", "description": "Reference to template of type 'encodingLive'" }, "multiviewComposing": { "$ref": "#/components/schemas/ConfigSchema", "description": "Optional reference to template of type 'multiviewComposing'. If omitted, inputs are taken from encodingLive." }, "streamConditioning": { "$ref": "#/components/schemas/ConfigSchema", "description": "Optional reference to template of type 'streamConditioning'" }, "type": { "description": "Processing type.", "type": "string" } }, "required": [ "type", "assetName", "encodingLive" ], "title": "StaticMultiviewChannelFlow", "type": "object" }, "StaticMultiviewChannelPatchFlow": { "properties": { "type": { "description": "Processing type.", "type": "string" } }, "required": [ "type" ], "title": "StaticMultiviewChannelPatchFlow", "type": "object" }, "StaticMultiviewEventFlow": { "description": "A flow that takes multiple live inputs, composes and encodes them, storing the material in the asset named by the required assetName field.\n\nSupports two modes:\n- With multiviewComposing: Inputs defined in multiviewComposing config.\n- Without multiviewComposing: Inputs defined in encodingLive config using multiInputComposer input type.\n\nA StaticMultiviewEvent flow is billed by the minute, please see StaticMultiviewChannel for encoding billed by the\nmonth.", "properties": { "archiveWindowLength": { "description": "The maximum content length that can be archived in the asset for the live output. This also limits the maximum content length for the timeshift window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. Max value = 30 days.", "pattern": "^P(?:(?P\\d+)Y)?(?:(?P\\d+)M)?(?:(?P\\d+)W)?(?:(?P\\d+)D)?T(?:(?P\\d+)H)?(?:(?P\\d+)M)?(?:(?P(?:\\d*.)?\\d+)S)?$", "type": "string" }, "assetName": { "description": "The name of asset that you want this flow to store material in.", "type": "string" }, "assetPath": { "description": "If an asset name is given, then you may also specify a subpath within the asset for the material.", "type": "string" }, "encodingLive": { "$ref": "#/components/schemas/ConfigSchema", "description": "Reference to template of type 'encodingLive'" }, "multiviewComposing": { "$ref": "#/components/schemas/ConfigSchema", "description": "Optional reference to template of type 'multiviewComposing'. If omitted, inputs are taken from encodingLive." }, "streamConditioning": { "$ref": "#/components/schemas/ConfigSchema", "description": "Optional reference to template of type 'streamConditioning'" }, "type": { "description": "Processing type.", "type": "string" } }, "required": [ "type", "assetName", "encodingLive" ], "title": "StaticMultiviewEventFlow", "type": "object" }, "StaticMultiviewEventPatchFlow": { "properties": { "type": { "description": "Processing type.", "type": "string" } }, "required": [ "type" ], "title": "StaticMultiviewEventPatchFlow", "type": "object" } }, "securitySchemes": { "BearerAuth": { "scheme": "bearer", "type": "http" } } }, "info": { "description": "## Overview\nThe MKIO Live API provides live encoding and multiview capabilities. Consult the related Media and Templates APIs for information about Templating, Sources, Destinations, Assets, and StreamingLocators.\n\nMK.IO LiveEvents support multiple input sources, multiple audio profiles, source switching, 1+1 redundancy, and a multitude of codecs and coding parameters that are described in our docs.\n\nMK.IO LiveChannels are exactly the same as Live Events, only with monthly billing for long-running workloads. Live Events can output to Assets for instant Live2VOD and streaming, or Destinations can be optionally configured to contribute your live stream over RTMP/SRT to a remote address.\n\nMK.IO StaticMultiviewEvents create a server-side tiled streaming Multiview experience for clients. Use StaticMultiview to reach the biggest possible audience, with support for h.264 and HEVC, and whatever other core video capabilities (SCTE-35 and SGAI, DRM) you may require. Streaming Multiview takes multiple sources and integrates them into a tiled interface, preserving audio and captions for a seamless user experience. Supported layouts include 2up, 3up, 3us, 4up, 4us. The number indicates the number of connected sources, while the 'us/up' indicates whether the layout contains a 'spotlight', or whether the layout gives all sources equal placement.\n\nMK.IO StaticMultiviewChannels are exactly the same as StaticMultiview Events, only with monthly billing for long-running workloads.\n\nAll resources in the MK.IO Live API support Scheduled Operations. Scheduled Operations allow you to start and stop Events and Channels at specific times. Additional operations, such as slate insertion/removal, and ad operations, may be supported in the future.\n\n## Template management\n\n[Template management](/api-reference/templates-api)\n\n[Content/ContentSource/Destination management](/api-reference/media-api)\n\n## Authentication\nAll endpoints require a bearer token in the `Authorization` header:\n`Authorization: Bearer `\n\nYou can create and manage your tokens in your [profile settings](https://app.mk.io/user/profile) under **Your personal API tokens**. Follow the [API tokens guide](https://docs.mediakind.com/mkio/how-to/managing-your-organization/api-tokens) for more information.\n\n## Usage\nBase URL: `https://app.mk.io`\n", "title": "MK.IO Live API", "version": "0.0.23" }, "openapi": "3.0.2", "paths": { "/api/v1/projects/{project_name}/live/liveChannels": { "get": { "description": "List Live Channels on the specified project. \n\n## Listing, Sorting and Filtering Live Channels\n\nThis endpoint returns the list of Live Channels in the specified project.\n\n### Sorting\n\nThe results from this endpoint can be ordered using the `$orderby` query parameter. Specify a list of field names, separated by commas\nwhere each one can optionally specify `asc` or `desc`.\n\nSorting is valid on the following fields: `created`, `createdBy`, `displayName`, `id`, `labels`, `name`, `spec/state`, `spec/transform/type`, `status/state`, `status/transformType`, `updated`, `updatedBy`\n\n### Filtering\n\n\nThere are two ways to filter the set of returned Live Channels from this endpoint - the first is to use the `$filter` query parameter, the second is to use the\n`$label_key` and `$label` query parameters.\n\n\nThe `$filter` query parameter allows for Live Channels to be filtered on the basis of fields in the schema using OData query syntax.\nSee [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used.\n\nFilters are valid on the following fields: `created`, `createdBy`, `createdByEmail`, `createdByName`, `displayName`, `id`, `labels`, `name`, `spec/inputs/content`, `spec/outputs/destination`, `spec/siteName`, `spec/state`, `spec/transform/type`, `status/deviceName`, `status/state`, `status/transformType`, `updated`, `updatedBy`, `updatedByEmail`, `updatedByName`\n\n`$label_key` and `$label` are specific to querying Live Channels based on their labels. Labels are a set of key-value pairs that can be used to identify Live Channels with\nany arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of Live Channels.\n\n### Examples:\n\n`?$top=10` - Returns only the first 10 Live Channels from the list.\n\n`?$orderby=name desc` - Sorts Live Channels by name in descending order.\n\n`?$filter=name eq 'descriptive name'` - Returns Live Channels that match the provided name.\n\n\n`?$orderby=created desc` - Sorts Live Channels by creation date in descending order.\n\n`?$filter=created ge 2021-01-01T00:00:00Z` - Returns Live Channels created after January 1, 2021.\n\n\n`?$label=studio=paravalley` - Returns Live Channels with the label `studio` set to `paravalley`.\n\n`?$label=release-date~2023` - Returns Live Channels with the label `release-date` set to a value that contains `2023`.\n\n`?$label_key=studio&label_key=release-date` - Returns Live Channels with any value set for the `studio` label and the `release-date` label.\n\nRBAC Capability Required: `transform.livechannel.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/liveChannels", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "Specifies the key by which the result collection should be ordered.", "in": "query", "name": "$orderby", "required": false, "schema": { "title": "$Orderby", "type": "string" } }, { "description": "Restricts the set of items returned.", "in": "query", "name": "$filter", "required": false, "schema": { "title": "$Filter", "type": "string" } }, { "description": "Specifies a non-negative integer `n` that limits the number of items returned from a collection.\nThe service returns the number of available items up to but not greater than the specified value `n`.", "in": "query", "name": "$top", "required": false, "schema": { "title": "$Top", "type": "string" } }, { "description": "Specifies a start offset to support paginated results.\nUse `@odata.nextLink` in the result object to enumerate the collection -\nit will be present only if there's more than one page of entities.", "in": "query", "name": "$skiptoken", "required": false, "schema": { "title": "$Skiptoken", "type": "string" } }, { "description": "Filters the set to the specified label key.\nIf multiple $label_keys are specified, matching items must have all labels.", "in": "query", "name": "$label_key", "required": false, "schema": { "title": "$Label_Key", "type": "string" } }, { "description": "Filters the set to the specified label key/value pair.\nSupports equality, inequality, and inexact matching. If multiple values are provided for the same key, items matching either value will be returned.", "in": "query", "name": "$label", "required": false, "schema": { "title": "$Label", "type": "string" } }, { "description": "Include extra status information in the response.", "in": "query", "name": "$detailedStatus", "required": false, "schema": { "title": "$Detailedstatus", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowListResponseSchema" } } }, "description": "List of Live Channels" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "List Live Channels", "tags": [ "Live Channel" ] } }, "/api/v1/projects/{project_name}/live/liveChannels/{name}": { "delete": { "description": "Delete a Live Channel. If the Live Channel does not exist, this API will return a 204.\n\nRBAC Capability Required: `transform.livechannel.delete`", "operationId": "[delete]_/api/v1/projects/{project_name}/live/liveChannels/{name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "When true, delete any scheduled operations attached to this resource before deleting it.", "in": "query", "name": "$force", "required": false, "schema": { "title": "$Force", "type": "boolean" } } ], "responses": { "200": { "description": "Live Channel deleted." }, "204": { "description": "Nothing to delete." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Live Channel is referenced by existing Live Channel inputs." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Delete Live Channel", "tags": [ "Live Channel" ] }, "get": { "description": "Get a Live Channel by name.\n\nRBAC Capability Required: `transform.livechannel.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/liveChannels/{name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "Include extra status information in the response.", "in": "query", "name": "$detailedStatus", "required": false, "schema": { "title": "$Detailedstatus", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowGetSchema" } } }, "description": "A single Live Channel." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Get Live Channel", "tags": [ "Live Channel" ] }, "patch": { "description": "Update a Live Channel.\n\nRBAC Capability Required: `transform.livechannel.update`", "operationId": "[patch]_/api/v1/projects/{project_name}/live/liveChannels/{name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowPatchBody" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowGetSchema" } } }, "description": "The updated Live Channel." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Update Live Channel", "tags": [ "Live Channel" ] }, "put": { "description": "Create or replace a Live Channel.\n\nRBAC Capability Required: `transform.livechannel.create`", "operationId": "[put]_/api/v1/projects/{project_name}/live/liveChannels/{name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowBody" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowGetSchema" } } }, "description": "The replaced Live Channel." }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowGetSchema" } } }, "description": "The created Live Channel." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Create or replace Live Channel", "tags": [ "Live Channel" ] } }, "/api/v1/projects/{project_name}/live/liveChannels/{name}/scheduledOperations": { "get": { "description": "## Listing, Sorting and Filtering Scheduled Operations\n\nThis endpoint returns the list of scheduled operations in the specified project.\n\n### Sorting\n\nThe results from this endpoint can be ordered using the `$orderby` query parameter. Specify a list of field names, separated by commas\nwhere each one can optionally specify `asc` or `desc`.\n\nSorting is valid on the following fields: `created`, `createdBy`, `endTime`, `id`, `name`, `resourcePath`, `startTime`, `type`, `updated`, `updatedBy`\n\n### Filtering\n\n\n\nThe `$filter` query parameter allows for scheduled operations to be filtered on the basis of fields in the schema using OData query syntax.\nSee [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used.\n\nFilters are valid on the following fields: `created`, `createdBy`, `createdByEmail`, `createdByName`, `endTime`, `id`, `name`, `resourcePath`, `startTime`, `type`, `updated`, `updatedBy`, `updatedByEmail`, `updatedByName`\n\n### Examples:\n\n`?$top=10` - Returns only the first 10 scheduled operations from the list.\n\n`?$orderby=name desc` - Sorts scheduled operations by name in descending order.\n\n`?$filter=name eq 'descriptive name'` - Returns scheduled operations that match the provided name.\n\n\n`?$orderby=created desc` - Sorts scheduled operations by creation date in descending order.\n\n`?$filter=created ge 2021-01-01T00:00:00Z` - Returns scheduled operations created after January 1, 2021.\n\nRBAC Capability Required: `scheduling.event.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/liveChannels/{name}/scheduledOperations", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "Specifies the key by which the result collection should be ordered.", "in": "query", "name": "$orderby", "required": false, "schema": { "title": "$Orderby", "type": "string" } }, { "description": "Restricts the set of items returned.", "in": "query", "name": "$filter", "required": false, "schema": { "title": "$Filter", "type": "string" } }, { "description": "Specifies a non-negative integer `n` that limits the number of items returned from a collection.\nThe service returns the number of available items up to but not greater than the specified value `n`.", "in": "query", "name": "$top", "required": false, "schema": { "title": "$Top", "type": "string" } }, { "description": "Specifies a start offset to support paginated results.\nUse `@odata.nextLink` in the result object to enumerate the collection -\nit will be present only if there's more than one page of entities.", "in": "query", "name": "$skiptoken", "required": false, "schema": { "title": "$Skiptoken", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationListSchema" } } }, "description": "A list of scheduled operations" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "List Scheduled Operations", "tags": [ "Live Channel" ] } }, "/api/v1/projects/{project_name}/live/liveChannels/{name}/scheduledOperations/{operation_name}": { "delete": { "description": "Delete a scheduled operation by name.\n\nRBAC Capability Required: `scheduling.event.delete`", "operationId": "[delete]_/api/v1/projects/{project_name}/live/liveChannels/{name}/scheduledOperations/{operation_name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "", "in": "path", "name": "operation_name", "required": true, "schema": { "title": "Operation_Name", "type": "string" } } ], "responses": { "200": { "description": "Deleted." }, "204": { "description": "Nothing to delete." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Delete Scheduled Operation", "tags": [ "Live Channel" ] }, "get": { "description": "Returns the details of a scheduled operation.\n\nRBAC Capability Required: `scheduling.event.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/liveChannels/{name}/scheduledOperations/{operation_name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "", "in": "path", "name": "operation_name", "required": true, "schema": { "title": "Operation_Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationSchema" } } }, "description": "scheduling settings" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Get Scheduled Operation", "tags": [ "Live Channel" ] }, "put": { "description": "Create or update a scheduled operation.\n\nRBAC Capability Required: `scheduling.event.create` or `scheduling.event.update`", "operationId": "[put]_/api/v1/projects/{project_name}/live/liveChannels/{name}/scheduledOperations/{operation_name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "", "in": "path", "name": "operation_name", "required": true, "schema": { "title": "Operation_Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationPutSchema" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationSchema" } } }, "description": "Updated" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationSchema" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Create or update Scheduled Operation", "tags": [ "Live Channel" ] } }, "/api/v1/projects/{project_name}/live/liveChannels/{name}/state": { "get": { "description": "Get the internal state of the resource. The state value depends on the resource type. For details about the potential states for each resource type, see [our resource state docs](https://docs.mediakind.com/mkio/reference/resource-states).\n\nRBAC Capability Required: `transform.livechannel.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/liveChannels/{name}/state", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceStateSchema" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Get resource state", "tags": [ "Live Channel" ] } }, "/api/v1/projects/{project_name}/live/liveEvents": { "get": { "description": "List Live Events on the specified project. \n\n## Listing, Sorting and Filtering Live Events\n\nThis endpoint returns the list of Live Events in the specified project.\n\n### Sorting\n\nThe results from this endpoint can be ordered using the `$orderby` query parameter. Specify a list of field names, separated by commas\nwhere each one can optionally specify `asc` or `desc`.\n\nSorting is valid on the following fields: `created`, `createdBy`, `displayName`, `id`, `labels`, `name`, `spec/state`, `spec/transform/type`, `status/state`, `status/transformType`, `updated`, `updatedBy`\n\n### Filtering\n\n\nThere are two ways to filter the set of returned Live Events from this endpoint - the first is to use the `$filter` query parameter, the second is to use the\n`$label_key` and `$label` query parameters.\n\n\nThe `$filter` query parameter allows for Live Events to be filtered on the basis of fields in the schema using OData query syntax.\nSee [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used.\n\nFilters are valid on the following fields: `created`, `createdBy`, `createdByEmail`, `createdByName`, `displayName`, `id`, `labels`, `name`, `spec/inputs/content`, `spec/outputs/destination`, `spec/siteName`, `spec/state`, `spec/transform/type`, `status/deviceName`, `status/state`, `status/transformType`, `updated`, `updatedBy`, `updatedByEmail`, `updatedByName`\n\n`$label_key` and `$label` are specific to querying Live Events based on their labels. Labels are a set of key-value pairs that can be used to identify Live Events with\nany arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of Live Events.\n\n### Examples:\n\n`?$top=10` - Returns only the first 10 Live Events from the list.\n\n`?$orderby=name desc` - Sorts Live Events by name in descending order.\n\n`?$filter=name eq 'descriptive name'` - Returns Live Events that match the provided name.\n\n\n`?$orderby=created desc` - Sorts Live Events by creation date in descending order.\n\n`?$filter=created ge 2021-01-01T00:00:00Z` - Returns Live Events created after January 1, 2021.\n\n\n`?$label=studio=paravalley` - Returns Live Events with the label `studio` set to `paravalley`.\n\n`?$label=release-date~2023` - Returns Live Events with the label `release-date` set to a value that contains `2023`.\n\n`?$label_key=studio&label_key=release-date` - Returns Live Events with any value set for the `studio` label and the `release-date` label.\n\nRBAC Capability Required: `transform.liveevent.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/liveEvents", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "Specifies the key by which the result collection should be ordered.", "in": "query", "name": "$orderby", "required": false, "schema": { "title": "$Orderby", "type": "string" } }, { "description": "Restricts the set of items returned.", "in": "query", "name": "$filter", "required": false, "schema": { "title": "$Filter", "type": "string" } }, { "description": "Specifies a non-negative integer `n` that limits the number of items returned from a collection.\nThe service returns the number of available items up to but not greater than the specified value `n`.", "in": "query", "name": "$top", "required": false, "schema": { "title": "$Top", "type": "string" } }, { "description": "Specifies a start offset to support paginated results.\nUse `@odata.nextLink` in the result object to enumerate the collection -\nit will be present only if there's more than one page of entities.", "in": "query", "name": "$skiptoken", "required": false, "schema": { "title": "$Skiptoken", "type": "string" } }, { "description": "Filters the set to the specified label key.\nIf multiple $label_keys are specified, matching items must have all labels.", "in": "query", "name": "$label_key", "required": false, "schema": { "title": "$Label_Key", "type": "string" } }, { "description": "Filters the set to the specified label key/value pair.\nSupports equality, inequality, and inexact matching. If multiple values are provided for the same key, items matching either value will be returned.", "in": "query", "name": "$label", "required": false, "schema": { "title": "$Label", "type": "string" } }, { "description": "Include extra status information in the response.", "in": "query", "name": "$detailedStatus", "required": false, "schema": { "title": "$Detailedstatus", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowListResponseSchema" } } }, "description": "List of Live Events" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "List Live Events", "tags": [ "Live Event" ] } }, "/api/v1/projects/{project_name}/live/liveEvents/{name}": { "delete": { "description": "Delete a Live Event. If the Live Event does not exist, this API will return a 204.\n\nRBAC Capability Required: `transform.liveevent.delete`", "operationId": "[delete]_/api/v1/projects/{project_name}/live/liveEvents/{name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "When true, delete any scheduled operations attached to this resource before deleting it.", "in": "query", "name": "$force", "required": false, "schema": { "title": "$Force", "type": "boolean" } } ], "responses": { "200": { "description": "Live Event deleted." }, "204": { "description": "Nothing to delete." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Live Event is referenced by existing Live Event inputs." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Delete Live Event", "tags": [ "Live Event" ] }, "get": { "description": "Get a Live Event by name.\n\nRBAC Capability Required: `transform.liveevent.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/liveEvents/{name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "Include extra status information in the response.", "in": "query", "name": "$detailedStatus", "required": false, "schema": { "title": "$Detailedstatus", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowGetSchema" } } }, "description": "A single Live Event." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Get Live Event", "tags": [ "Live Event" ] }, "patch": { "description": "Update a Live Event.\n\nRBAC Capability Required: `transform.liveevent.update`", "operationId": "[patch]_/api/v1/projects/{project_name}/live/liveEvents/{name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowPatchBody" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowGetSchema" } } }, "description": "The updated Live Event." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Update Live Event", "tags": [ "Live Event" ] }, "put": { "description": "Create or replace a Live Event.\n\nRBAC Capability Required: `transform.liveevent.create`", "operationId": "[put]_/api/v1/projects/{project_name}/live/liveEvents/{name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowBody" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowGetSchema" } } }, "description": "The replaced Live Event." }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowGetSchema" } } }, "description": "The created Live Event." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Create or replace Live Event", "tags": [ "Live Event" ] } }, "/api/v1/projects/{project_name}/live/liveEvents/{name}/scheduledOperations": { "get": { "description": "## Listing, Sorting and Filtering Scheduled Operations\n\nThis endpoint returns the list of scheduled operations in the specified project.\n\n### Sorting\n\nThe results from this endpoint can be ordered using the `$orderby` query parameter. Specify a list of field names, separated by commas\nwhere each one can optionally specify `asc` or `desc`.\n\nSorting is valid on the following fields: `created`, `createdBy`, `endTime`, `id`, `name`, `resourcePath`, `startTime`, `type`, `updated`, `updatedBy`\n\n### Filtering\n\n\n\nThe `$filter` query parameter allows for scheduled operations to be filtered on the basis of fields in the schema using OData query syntax.\nSee [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used.\n\nFilters are valid on the following fields: `created`, `createdBy`, `createdByEmail`, `createdByName`, `endTime`, `id`, `name`, `resourcePath`, `startTime`, `type`, `updated`, `updatedBy`, `updatedByEmail`, `updatedByName`\n\n### Examples:\n\n`?$top=10` - Returns only the first 10 scheduled operations from the list.\n\n`?$orderby=name desc` - Sorts scheduled operations by name in descending order.\n\n`?$filter=name eq 'descriptive name'` - Returns scheduled operations that match the provided name.\n\n\n`?$orderby=created desc` - Sorts scheduled operations by creation date in descending order.\n\n`?$filter=created ge 2021-01-01T00:00:00Z` - Returns scheduled operations created after January 1, 2021.\n\nRBAC Capability Required: `scheduling.event.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/liveEvents/{name}/scheduledOperations", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "Specifies the key by which the result collection should be ordered.", "in": "query", "name": "$orderby", "required": false, "schema": { "title": "$Orderby", "type": "string" } }, { "description": "Restricts the set of items returned.", "in": "query", "name": "$filter", "required": false, "schema": { "title": "$Filter", "type": "string" } }, { "description": "Specifies a non-negative integer `n` that limits the number of items returned from a collection.\nThe service returns the number of available items up to but not greater than the specified value `n`.", "in": "query", "name": "$top", "required": false, "schema": { "title": "$Top", "type": "string" } }, { "description": "Specifies a start offset to support paginated results.\nUse `@odata.nextLink` in the result object to enumerate the collection -\nit will be present only if there's more than one page of entities.", "in": "query", "name": "$skiptoken", "required": false, "schema": { "title": "$Skiptoken", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationListSchema" } } }, "description": "A list of scheduled operations" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "List Scheduled Operations", "tags": [ "Live Event" ] } }, "/api/v1/projects/{project_name}/live/liveEvents/{name}/scheduledOperations/{operation_name}": { "delete": { "description": "Delete a scheduled operation by name.\n\nRBAC Capability Required: `scheduling.event.delete`", "operationId": "[delete]_/api/v1/projects/{project_name}/live/liveEvents/{name}/scheduledOperations/{operation_name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "", "in": "path", "name": "operation_name", "required": true, "schema": { "title": "Operation_Name", "type": "string" } } ], "responses": { "200": { "description": "Deleted." }, "204": { "description": "Nothing to delete." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Delete Scheduled Operation", "tags": [ "Live Event" ] }, "get": { "description": "Returns the details of a scheduled operation.\n\nRBAC Capability Required: `scheduling.event.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/liveEvents/{name}/scheduledOperations/{operation_name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "", "in": "path", "name": "operation_name", "required": true, "schema": { "title": "Operation_Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationSchema" } } }, "description": "scheduling settings" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Get Scheduled Operation", "tags": [ "Live Event" ] }, "put": { "description": "Create or update a scheduled operation.\n\nRBAC Capability Required: `scheduling.event.create` or `scheduling.event.update`", "operationId": "[put]_/api/v1/projects/{project_name}/live/liveEvents/{name}/scheduledOperations/{operation_name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "", "in": "path", "name": "operation_name", "required": true, "schema": { "title": "Operation_Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationPutSchema" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationSchema" } } }, "description": "Updated" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationSchema" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Create or update Scheduled Operation", "tags": [ "Live Event" ] } }, "/api/v1/projects/{project_name}/live/liveEvents/{name}/state": { "get": { "description": "Get the internal state of the resource. The state value depends on the resource type. For details about the potential states for each resource type, see [our resource state docs](https://docs.mediakind.com/mkio/reference/resource-states).\n\nRBAC Capability Required: `transform.liveevent.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/liveEvents/{name}/state", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceStateSchema" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Get resource state", "tags": [ "Live Event" ] } }, "/api/v1/projects/{project_name}/live/search": { "get": { "description": "List Live Resources on the specified project. \n\n## Listing, Sorting and Filtering Resource\n\nThis endpoint returns the list of Resource in the specified project.\n\n### Sorting\n\nThe results from this endpoint can be ordered using the `$orderby` query parameter. Specify a list of field names, separated by commas\nwhere each one can optionally specify `asc` or `desc`.\n\nSorting is valid on the following fields: `created`, `createdBy`, `displayName`, `id`, `labels`, `name`, `spec/state`, `spec/transform/type`, `status/state`, `status/transformType`, `updated`, `updatedBy`\n\n### Filtering\n\n\nThere are two ways to filter the set of returned Resource from this endpoint - the first is to use the `$filter` query parameter, the second is to use the\n`$label_key` and `$label` query parameters.\n\n\nThe `$filter` query parameter allows for Resource to be filtered on the basis of fields in the schema using OData query syntax.\nSee [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used.\n\nFilters are valid on the following fields: `created`, `createdBy`, `createdByEmail`, `createdByName`, `displayName`, `id`, `labels`, `name`, `spec/inputs/content`, `spec/outputs/destination`, `spec/siteName`, `spec/state`, `spec/transform/type`, `status/deviceName`, `status/state`, `status/transformType`, `updated`, `updatedBy`, `updatedByEmail`, `updatedByName`\n\n`$label_key` and `$label` are specific to querying Resource based on their labels. Labels are a set of key-value pairs that can be used to identify Resource with\nany arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of Resource.\n\n### Examples:\n\n`?$top=10` - Returns only the first 10 Resource from the list.\n\n`?$orderby=name desc` - Sorts Resource by name in descending order.\n\n`?$filter=name eq 'descriptive name'` - Returns Resource that match the provided name.\n\n\n`?$orderby=created desc` - Sorts Resource by creation date in descending order.\n\n`?$filter=created ge 2021-01-01T00:00:00Z` - Returns Resource created after January 1, 2021.\n\n\n`?$label=studio=paravalley` - Returns Resource with the label `studio` set to `paravalley`.\n\n`?$label=release-date~2023` - Returns Resource with the label `release-date` set to a value that contains `2023`.\n\n`?$label_key=studio&label_key=release-date` - Returns Resource with any value set for the `studio` label and the `release-date` label.\n\nRBAC Capability Required: `transform.livechannel.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/search", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "Specifies the key by which the result collection should be ordered.", "in": "query", "name": "$orderby", "required": false, "schema": { "title": "$Orderby", "type": "string" } }, { "description": "Restricts the set of items returned.", "in": "query", "name": "$filter", "required": false, "schema": { "title": "$Filter", "type": "string" } }, { "description": "Specifies a non-negative integer `n` that limits the number of items returned from a collection.\nThe service returns the number of available items up to but not greater than the specified value `n`.", "in": "query", "name": "$top", "required": false, "schema": { "title": "$Top", "type": "string" } }, { "description": "Specifies a start offset to support paginated results.\nUse `@odata.nextLink` in the result object to enumerate the collection -\nit will be present only if there's more than one page of entities.", "in": "query", "name": "$skiptoken", "required": false, "schema": { "title": "$Skiptoken", "type": "string" } }, { "description": "Filters the set to the specified label key.\nIf multiple $label_keys are specified, matching items must have all labels.", "in": "query", "name": "$label_key", "required": false, "schema": { "title": "$Label_Key", "type": "string" } }, { "description": "Filters the set to the specified label key/value pair.\nSupports equality, inequality, and inexact matching. If multiple values are provided for the same key, items matching either value will be returned.", "in": "query", "name": "$label", "required": false, "schema": { "title": "$Label", "type": "string" } }, { "description": "Include extra status information in the response.", "in": "query", "name": "$detailedStatus", "required": false, "schema": { "title": "$Detailedstatus", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowListResponseSchema" } } }, "description": "List of Live Resources" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "List Live resources", "tags": [ "Live Search" ] } }, "/api/v1/projects/{project_name}/live/staticMultiviewChannels": { "get": { "description": "List Static Multiview Channels on the specified project. \n\n## Listing, Sorting and Filtering Static Multiview Channels\n\nThis endpoint returns the list of Static Multiview Channels in the specified project.\n\n### Sorting\n\nThe results from this endpoint can be ordered using the `$orderby` query parameter. Specify a list of field names, separated by commas\nwhere each one can optionally specify `asc` or `desc`.\n\nSorting is valid on the following fields: `created`, `createdBy`, `displayName`, `id`, `labels`, `name`, `spec/state`, `spec/transform/type`, `status/state`, `status/transformType`, `updated`, `updatedBy`\n\n### Filtering\n\n\nThere are two ways to filter the set of returned Static Multiview Channels from this endpoint - the first is to use the `$filter` query parameter, the second is to use the\n`$label_key` and `$label` query parameters.\n\n\nThe `$filter` query parameter allows for Static Multiview Channels to be filtered on the basis of fields in the schema using OData query syntax.\nSee [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used.\n\nFilters are valid on the following fields: `created`, `createdBy`, `createdByEmail`, `createdByName`, `displayName`, `id`, `labels`, `name`, `spec/inputs/content`, `spec/outputs/destination`, `spec/siteName`, `spec/state`, `spec/transform/type`, `status/deviceName`, `status/state`, `status/transformType`, `updated`, `updatedBy`, `updatedByEmail`, `updatedByName`\n\n`$label_key` and `$label` are specific to querying Static Multiview Channels based on their labels. Labels are a set of key-value pairs that can be used to identify Static Multiview Channels with\nany arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of Static Multiview Channels.\n\n### Examples:\n\n`?$top=10` - Returns only the first 10 Static Multiview Channels from the list.\n\n`?$orderby=name desc` - Sorts Static Multiview Channels by name in descending order.\n\n`?$filter=name eq 'descriptive name'` - Returns Static Multiview Channels that match the provided name.\n\n\n`?$orderby=created desc` - Sorts Static Multiview Channels by creation date in descending order.\n\n`?$filter=created ge 2021-01-01T00:00:00Z` - Returns Static Multiview Channels created after January 1, 2021.\n\n\n`?$label=studio=paravalley` - Returns Static Multiview Channels with the label `studio` set to `paravalley`.\n\n`?$label=release-date~2023` - Returns Static Multiview Channels with the label `release-date` set to a value that contains `2023`.\n\n`?$label_key=studio&label_key=release-date` - Returns Static Multiview Channels with any value set for the `studio` label and the `release-date` label.\n\nRBAC Capability Required: `transform.staticmultiviewchannel.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/staticMultiviewChannels", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "Specifies the key by which the result collection should be ordered.", "in": "query", "name": "$orderby", "required": false, "schema": { "title": "$Orderby", "type": "string" } }, { "description": "Restricts the set of items returned.", "in": "query", "name": "$filter", "required": false, "schema": { "title": "$Filter", "type": "string" } }, { "description": "Specifies a non-negative integer `n` that limits the number of items returned from a collection.\nThe service returns the number of available items up to but not greater than the specified value `n`.", "in": "query", "name": "$top", "required": false, "schema": { "title": "$Top", "type": "string" } }, { "description": "Specifies a start offset to support paginated results.\nUse `@odata.nextLink` in the result object to enumerate the collection -\nit will be present only if there's more than one page of entities.", "in": "query", "name": "$skiptoken", "required": false, "schema": { "title": "$Skiptoken", "type": "string" } }, { "description": "Filters the set to the specified label key.\nIf multiple $label_keys are specified, matching items must have all labels.", "in": "query", "name": "$label_key", "required": false, "schema": { "title": "$Label_Key", "type": "string" } }, { "description": "Filters the set to the specified label key/value pair.\nSupports equality, inequality, and inexact matching. If multiple values are provided for the same key, items matching either value will be returned.", "in": "query", "name": "$label", "required": false, "schema": { "title": "$Label", "type": "string" } }, { "description": "Include extra status information in the response.", "in": "query", "name": "$detailedStatus", "required": false, "schema": { "title": "$Detailedstatus", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowListResponseSchema" } } }, "description": "List of Static Multiview Channels" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "List Static Multiview Channels", "tags": [ "Static Multiview Channel" ] } }, "/api/v1/projects/{project_name}/live/staticMultiviewChannels/{name}": { "delete": { "description": "Delete a Static Multiview Channel. If the Static Multiview Channel does not exist, this API will return a 204.\n\nRBAC Capability Required: `transform.staticmultiviewchannel.delete`", "operationId": "[delete]_/api/v1/projects/{project_name}/live/staticMultiviewChannels/{name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "When true, delete any scheduled operations attached to this resource before deleting it.", "in": "query", "name": "$force", "required": false, "schema": { "title": "$Force", "type": "boolean" } } ], "responses": { "200": { "description": "Static Multiview Channel deleted." }, "204": { "description": "Nothing to delete." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Static Multiview Channel is referenced by existing Static Multiview Channel inputs." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Delete Static Multiview Channel", "tags": [ "Static Multiview Channel" ] }, "get": { "description": "Get a Static Multiview Channel by name.\n\nRBAC Capability Required: `transform.staticmultiviewchannel.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/staticMultiviewChannels/{name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "Include extra status information in the response.", "in": "query", "name": "$detailedStatus", "required": false, "schema": { "title": "$Detailedstatus", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowGetSchema" } } }, "description": "A single Static Multiview Channel." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Get Static Multiview Channel", "tags": [ "Static Multiview Channel" ] }, "patch": { "description": "Update a Static Multiview Channel.\n\nRBAC Capability Required: `transform.staticmultiviewchannel.update`", "operationId": "[patch]_/api/v1/projects/{project_name}/live/staticMultiviewChannels/{name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowPatchBody" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowGetSchema" } } }, "description": "The updated Static Multiview Channel." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Update Static Multiview Channel", "tags": [ "Static Multiview Channel" ] }, "put": { "description": "Create or replace a Static Multiview Channel.\n\nRBAC Capability Required: `transform.staticmultiviewchannel.create`", "operationId": "[put]_/api/v1/projects/{project_name}/live/staticMultiviewChannels/{name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowBody" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowGetSchema" } } }, "description": "The replaced Static Multiview Channel." }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowGetSchema" } } }, "description": "The created Static Multiview Channel." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Create or replace Static Multiview Channel", "tags": [ "Static Multiview Channel" ] } }, "/api/v1/projects/{project_name}/live/staticMultiviewChannels/{name}/scheduledOperations": { "get": { "description": "## Listing, Sorting and Filtering Scheduled Operations\n\nThis endpoint returns the list of scheduled operations in the specified project.\n\n### Sorting\n\nThe results from this endpoint can be ordered using the `$orderby` query parameter. Specify a list of field names, separated by commas\nwhere each one can optionally specify `asc` or `desc`.\n\nSorting is valid on the following fields: `created`, `createdBy`, `endTime`, `id`, `name`, `resourcePath`, `startTime`, `type`, `updated`, `updatedBy`\n\n### Filtering\n\n\n\nThe `$filter` query parameter allows for scheduled operations to be filtered on the basis of fields in the schema using OData query syntax.\nSee [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used.\n\nFilters are valid on the following fields: `created`, `createdBy`, `createdByEmail`, `createdByName`, `endTime`, `id`, `name`, `resourcePath`, `startTime`, `type`, `updated`, `updatedBy`, `updatedByEmail`, `updatedByName`\n\n### Examples:\n\n`?$top=10` - Returns only the first 10 scheduled operations from the list.\n\n`?$orderby=name desc` - Sorts scheduled operations by name in descending order.\n\n`?$filter=name eq 'descriptive name'` - Returns scheduled operations that match the provided name.\n\n\n`?$orderby=created desc` - Sorts scheduled operations by creation date in descending order.\n\n`?$filter=created ge 2021-01-01T00:00:00Z` - Returns scheduled operations created after January 1, 2021.\n\nRBAC Capability Required: `scheduling.event.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/staticMultiviewChannels/{name}/scheduledOperations", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "Specifies the key by which the result collection should be ordered.", "in": "query", "name": "$orderby", "required": false, "schema": { "title": "$Orderby", "type": "string" } }, { "description": "Restricts the set of items returned.", "in": "query", "name": "$filter", "required": false, "schema": { "title": "$Filter", "type": "string" } }, { "description": "Specifies a non-negative integer `n` that limits the number of items returned from a collection.\nThe service returns the number of available items up to but not greater than the specified value `n`.", "in": "query", "name": "$top", "required": false, "schema": { "title": "$Top", "type": "string" } }, { "description": "Specifies a start offset to support paginated results.\nUse `@odata.nextLink` in the result object to enumerate the collection -\nit will be present only if there's more than one page of entities.", "in": "query", "name": "$skiptoken", "required": false, "schema": { "title": "$Skiptoken", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationListSchema" } } }, "description": "A list of scheduled operations" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "List Scheduled Operations", "tags": [ "Static Multiview Channel" ] } }, "/api/v1/projects/{project_name}/live/staticMultiviewChannels/{name}/scheduledOperations/{operation_name}": { "delete": { "description": "Delete a scheduled operation by name.\n\nRBAC Capability Required: `scheduling.event.delete`", "operationId": "[delete]_/api/v1/projects/{project_name}/live/staticMultiviewChannels/{name}/scheduledOperations/{operation_name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "", "in": "path", "name": "operation_name", "required": true, "schema": { "title": "Operation_Name", "type": "string" } } ], "responses": { "200": { "description": "Deleted." }, "204": { "description": "Nothing to delete." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Delete Scheduled Operation", "tags": [ "Static Multiview Channel" ] }, "get": { "description": "Returns the details of a scheduled operation.\n\nRBAC Capability Required: `scheduling.event.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/staticMultiviewChannels/{name}/scheduledOperations/{operation_name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "", "in": "path", "name": "operation_name", "required": true, "schema": { "title": "Operation_Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationSchema" } } }, "description": "scheduling settings" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Get Scheduled Operation", "tags": [ "Static Multiview Channel" ] }, "put": { "description": "Create or update a scheduled operation.\n\nRBAC Capability Required: `scheduling.event.create` or `scheduling.event.update`", "operationId": "[put]_/api/v1/projects/{project_name}/live/staticMultiviewChannels/{name}/scheduledOperations/{operation_name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "", "in": "path", "name": "operation_name", "required": true, "schema": { "title": "Operation_Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationPutSchema" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationSchema" } } }, "description": "Updated" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationSchema" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Create or update Scheduled Operation", "tags": [ "Static Multiview Channel" ] } }, "/api/v1/projects/{project_name}/live/staticMultiviewChannels/{name}/state": { "get": { "description": "Get the internal state of the resource. The state value depends on the resource type. For details about the potential states for each resource type, see [our resource state docs](https://docs.mediakind.com/mkio/reference/resource-states).\n\nRBAC Capability Required: `transform.staticmultiviewchannel.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/staticMultiviewChannels/{name}/state", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceStateSchema" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Get resource state", "tags": [ "Static Multiview Channel" ] } }, "/api/v1/projects/{project_name}/live/staticMultiviewEvents": { "get": { "description": "List Static Multiview Events on the specified project. \n\n## Listing, Sorting and Filtering Static Multiview Events\n\nThis endpoint returns the list of Static Multiview Events in the specified project.\n\n### Sorting\n\nThe results from this endpoint can be ordered using the `$orderby` query parameter. Specify a list of field names, separated by commas\nwhere each one can optionally specify `asc` or `desc`.\n\nSorting is valid on the following fields: `created`, `createdBy`, `displayName`, `id`, `labels`, `name`, `spec/state`, `spec/transform/type`, `status/state`, `status/transformType`, `updated`, `updatedBy`\n\n### Filtering\n\n\nThere are two ways to filter the set of returned Static Multiview Events from this endpoint - the first is to use the `$filter` query parameter, the second is to use the\n`$label_key` and `$label` query parameters.\n\n\nThe `$filter` query parameter allows for Static Multiview Events to be filtered on the basis of fields in the schema using OData query syntax.\nSee [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used.\n\nFilters are valid on the following fields: `created`, `createdBy`, `createdByEmail`, `createdByName`, `displayName`, `id`, `labels`, `name`, `spec/inputs/content`, `spec/outputs/destination`, `spec/siteName`, `spec/state`, `spec/transform/type`, `status/deviceName`, `status/state`, `status/transformType`, `updated`, `updatedBy`, `updatedByEmail`, `updatedByName`\n\n`$label_key` and `$label` are specific to querying Static Multiview Events based on their labels. Labels are a set of key-value pairs that can be used to identify Static Multiview Events with\nany arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of Static Multiview Events.\n\n### Examples:\n\n`?$top=10` - Returns only the first 10 Static Multiview Events from the list.\n\n`?$orderby=name desc` - Sorts Static Multiview Events by name in descending order.\n\n`?$filter=name eq 'descriptive name'` - Returns Static Multiview Events that match the provided name.\n\n\n`?$orderby=created desc` - Sorts Static Multiview Events by creation date in descending order.\n\n`?$filter=created ge 2021-01-01T00:00:00Z` - Returns Static Multiview Events created after January 1, 2021.\n\n\n`?$label=studio=paravalley` - Returns Static Multiview Events with the label `studio` set to `paravalley`.\n\n`?$label=release-date~2023` - Returns Static Multiview Events with the label `release-date` set to a value that contains `2023`.\n\n`?$label_key=studio&label_key=release-date` - Returns Static Multiview Events with any value set for the `studio` label and the `release-date` label.\n\nRBAC Capability Required: `transform.staticmultiviewevent.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/staticMultiviewEvents", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "Specifies the key by which the result collection should be ordered.", "in": "query", "name": "$orderby", "required": false, "schema": { "title": "$Orderby", "type": "string" } }, { "description": "Restricts the set of items returned.", "in": "query", "name": "$filter", "required": false, "schema": { "title": "$Filter", "type": "string" } }, { "description": "Specifies a non-negative integer `n` that limits the number of items returned from a collection.\nThe service returns the number of available items up to but not greater than the specified value `n`.", "in": "query", "name": "$top", "required": false, "schema": { "title": "$Top", "type": "string" } }, { "description": "Specifies a start offset to support paginated results.\nUse `@odata.nextLink` in the result object to enumerate the collection -\nit will be present only if there's more than one page of entities.", "in": "query", "name": "$skiptoken", "required": false, "schema": { "title": "$Skiptoken", "type": "string" } }, { "description": "Filters the set to the specified label key.\nIf multiple $label_keys are specified, matching items must have all labels.", "in": "query", "name": "$label_key", "required": false, "schema": { "title": "$Label_Key", "type": "string" } }, { "description": "Filters the set to the specified label key/value pair.\nSupports equality, inequality, and inexact matching. If multiple values are provided for the same key, items matching either value will be returned.", "in": "query", "name": "$label", "required": false, "schema": { "title": "$Label", "type": "string" } }, { "description": "Include extra status information in the response.", "in": "query", "name": "$detailedStatus", "required": false, "schema": { "title": "$Detailedstatus", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowListResponseSchema" } } }, "description": "List of Static Multiview Events" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "List Static Multiview Events", "tags": [ "Static Multiview Event" ] } }, "/api/v1/projects/{project_name}/live/staticMultiviewEvents/{name}": { "delete": { "description": "Delete a Static Multiview Event. If the Static Multiview Event does not exist, this API will return a 204.\n\nRBAC Capability Required: `transform.staticmultiviewevent.delete`", "operationId": "[delete]_/api/v1/projects/{project_name}/live/staticMultiviewEvents/{name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "When true, delete any scheduled operations attached to this resource before deleting it.", "in": "query", "name": "$force", "required": false, "schema": { "title": "$Force", "type": "boolean" } } ], "responses": { "200": { "description": "Static Multiview Event deleted." }, "204": { "description": "Nothing to delete." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Static Multiview Event is referenced by existing Static Multiview Event inputs." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Delete Static Multiview Event", "tags": [ "Static Multiview Event" ] }, "get": { "description": "Get a Static Multiview Event by name.\n\nRBAC Capability Required: `transform.staticmultiviewevent.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/staticMultiviewEvents/{name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "Include extra status information in the response.", "in": "query", "name": "$detailedStatus", "required": false, "schema": { "title": "$Detailedstatus", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowGetSchema" } } }, "description": "A single Static Multiview Event." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Get Static Multiview Event", "tags": [ "Static Multiview Event" ] }, "patch": { "description": "Update a Static Multiview Event.\n\nRBAC Capability Required: `transform.staticmultiviewevent.update`", "operationId": "[patch]_/api/v1/projects/{project_name}/live/staticMultiviewEvents/{name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowPatchBody" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowGetSchema" } } }, "description": "The updated Static Multiview Event." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Update Static Multiview Event", "tags": [ "Static Multiview Event" ] }, "put": { "description": "Create or replace a Static Multiview Event.\n\nRBAC Capability Required: `transform.staticmultiviewevent.create`", "operationId": "[put]_/api/v1/projects/{project_name}/live/staticMultiviewEvents/{name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowBody" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowGetSchema" } } }, "description": "The replaced Static Multiview Event." }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowGetSchema" } } }, "description": "The created Static Multiview Event." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Create or replace Static Multiview Event", "tags": [ "Static Multiview Event" ] } }, "/api/v1/projects/{project_name}/live/staticMultiviewEvents/{name}/scheduledOperations": { "get": { "description": "## Listing, Sorting and Filtering Scheduled Operations\n\nThis endpoint returns the list of scheduled operations in the specified project.\n\n### Sorting\n\nThe results from this endpoint can be ordered using the `$orderby` query parameter. Specify a list of field names, separated by commas\nwhere each one can optionally specify `asc` or `desc`.\n\nSorting is valid on the following fields: `created`, `createdBy`, `endTime`, `id`, `name`, `resourcePath`, `startTime`, `type`, `updated`, `updatedBy`\n\n### Filtering\n\n\n\nThe `$filter` query parameter allows for scheduled operations to be filtered on the basis of fields in the schema using OData query syntax.\nSee [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used.\n\nFilters are valid on the following fields: `created`, `createdBy`, `createdByEmail`, `createdByName`, `endTime`, `id`, `name`, `resourcePath`, `startTime`, `type`, `updated`, `updatedBy`, `updatedByEmail`, `updatedByName`\n\n### Examples:\n\n`?$top=10` - Returns only the first 10 scheduled operations from the list.\n\n`?$orderby=name desc` - Sorts scheduled operations by name in descending order.\n\n`?$filter=name eq 'descriptive name'` - Returns scheduled operations that match the provided name.\n\n\n`?$orderby=created desc` - Sorts scheduled operations by creation date in descending order.\n\n`?$filter=created ge 2021-01-01T00:00:00Z` - Returns scheduled operations created after January 1, 2021.\n\nRBAC Capability Required: `scheduling.event.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/staticMultiviewEvents/{name}/scheduledOperations", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "Specifies the key by which the result collection should be ordered.", "in": "query", "name": "$orderby", "required": false, "schema": { "title": "$Orderby", "type": "string" } }, { "description": "Restricts the set of items returned.", "in": "query", "name": "$filter", "required": false, "schema": { "title": "$Filter", "type": "string" } }, { "description": "Specifies a non-negative integer `n` that limits the number of items returned from a collection.\nThe service returns the number of available items up to but not greater than the specified value `n`.", "in": "query", "name": "$top", "required": false, "schema": { "title": "$Top", "type": "string" } }, { "description": "Specifies a start offset to support paginated results.\nUse `@odata.nextLink` in the result object to enumerate the collection -\nit will be present only if there's more than one page of entities.", "in": "query", "name": "$skiptoken", "required": false, "schema": { "title": "$Skiptoken", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationListSchema" } } }, "description": "A list of scheduled operations" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "List Scheduled Operations", "tags": [ "Static Multiview Event" ] } }, "/api/v1/projects/{project_name}/live/staticMultiviewEvents/{name}/scheduledOperations/{operation_name}": { "delete": { "description": "Delete a scheduled operation by name.\n\nRBAC Capability Required: `scheduling.event.delete`", "operationId": "[delete]_/api/v1/projects/{project_name}/live/staticMultiviewEvents/{name}/scheduledOperations/{operation_name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "", "in": "path", "name": "operation_name", "required": true, "schema": { "title": "Operation_Name", "type": "string" } } ], "responses": { "200": { "description": "Deleted." }, "204": { "description": "Nothing to delete." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Delete Scheduled Operation", "tags": [ "Static Multiview Event" ] }, "get": { "description": "Returns the details of a scheduled operation.\n\nRBAC Capability Required: `scheduling.event.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/staticMultiviewEvents/{name}/scheduledOperations/{operation_name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "", "in": "path", "name": "operation_name", "required": true, "schema": { "title": "Operation_Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationSchema" } } }, "description": "scheduling settings" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Get Scheduled Operation", "tags": [ "Static Multiview Event" ] }, "put": { "description": "Create or update a scheduled operation.\n\nRBAC Capability Required: `scheduling.event.create` or `scheduling.event.update`", "operationId": "[put]_/api/v1/projects/{project_name}/live/staticMultiviewEvents/{name}/scheduledOperations/{operation_name}", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } }, { "description": "", "in": "path", "name": "operation_name", "required": true, "schema": { "title": "Operation_Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationPutSchema" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationSchema" } } }, "description": "Updated" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledOperationSchema" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Create or update Scheduled Operation", "tags": [ "Static Multiview Event" ] } }, "/api/v1/projects/{project_name}/live/staticMultiviewEvents/{name}/state": { "get": { "description": "Get the internal state of the resource. The state value depends on the resource type. For details about the potential states for each resource type, see [our resource state docs](https://docs.mediakind.com/mkio/reference/resource-states).\n\nRBAC Capability Required: `transform.staticmultiviewevent.get`", "operationId": "[get]_/api/v1/projects/{project_name}/live/staticMultiviewEvents/{name}/state", "parameters": [ { "description": "", "in": "path", "name": "project_name", "required": true, "schema": { "title": "Project_Name", "type": "string" } }, { "description": "", "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceStateSchema" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "summary": "Get resource state", "tags": [ "Static Multiview Event" ] } } }, "security": [ { "BearerAuth": [] } ], "servers": [ { "description": "MK.IO API Server", "url": "https://app.mk.io/" } ], "tags": [ { "description": "", "name": "Live Channel" }, { "description": "", "name": "Live Event" }, { "description": "", "name": "Live Search" }, { "description": "", "name": "Static Multiview Channel" }, { "description": "", "name": "Static Multiview Event" } ] }