> This page is for mk.io. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://mediakind.ferndocs.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server. # List Scheduled Operations GET https://app.mk.io/api/v1/projects/{project_name}/live/staticMultiviewEvents/{name}/scheduledOperations ## Listing, Sorting and Filtering Scheduled Operations This endpoint returns the list of scheduled operations in the specified project. ### Sorting The results from this endpoint can be ordered using the `$orderby` query parameter. Specify a list of field names, separated by commas where each one can optionally specify `asc` or `desc`. Sorting is valid on the following fields: `created`, `createdBy`, `endTime`, `id`, `name`, `resourcePath`, `startTime`, `type`, `updated`, `updatedBy` ### Filtering The `$filter` query parameter allows for scheduled operations to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `created`, `createdBy`, `createdByEmail`, `createdByName`, `endTime`, `id`, `name`, `resourcePath`, `startTime`, `type`, `updated`, `updatedBy`, `updatedByEmail`, `updatedByName` ### Examples: `?$top=10` - Returns only the first 10 scheduled operations from the list. `?$orderby=name desc` - Sorts scheduled operations by name in descending order. `?$filter=name eq 'descriptive name'` - Returns scheduled operations that match the provided name. `?$orderby=created desc` - Sorts scheduled operations by creation date in descending order. `?$filter=created ge 2021-01-01T00:00:00Z` - Returns scheduled operations created after January 1, 2021. RBAC Capability Required: `scheduling.event.get` Reference: https://mediakind.ferndocs.com/mkio/api/live/static-multiview-event/list-scheduled-operations ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `project_name` (string, required) - `name` (string, required) ### Query parameters - `$orderby` (string, optional) — Specifies the key by which the result collection should be ordered. - `$filter` (string, optional) — Restricts the set of items returned. - `$top` (string, optional) — Specifies a non-negative integer `n` that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value `n`. - `$skiptoken` (string, optional) — Specifies a start offset to support paginated results. Use `@odata.nextLink` in the result object to enumerate the collection - it will be present only if there's more than one page of entities. ## Response ### 200 A list of scheduled operations - `supplemental` (ListResponseSupplementalSchema, required) — Supplemental info - `value` (list of ScheduledOperationSchema, required) — A list of scheduled operations - `@odata.nextLink` (string, optional) — @odata.nextLink URL if the page length and number of items match. ## Errors ### 400 Bad Request Error Bad Request - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 401 Unauthorized Error Unauthorized - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 403 Forbidden Error Forbidden - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 404 Not Found Error Not Found - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 429 Too Many Requests Error Too Many Requests - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 500 Internal Server Error Internal Server Error - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ## Types ### ListResponseSupplementalSchema - `count` (integer, required) — Number of items returned - `kind` (string, required) — Type of items in the list - `operation` (string, required) — Operation type. Should always say 'list' - `pagination` (PaginationInfoSchema, required) — Pagination info - `subscription` (ProjectInfoSchema, optional) — Project info ### ScheduledOperationSchema - `spec` (ScheduledOperationSchemaSpec, required) - `metadata` (ScheduledOperationMetadataSchema, optional) - `status` (ScheduledOperationStatusSchema, optional) ### ErrorDetail - `code` (string, required) — The error code. - `detail` (string, required) — The error message. - `extraDetail` (map from string to any, optional) — Extra information regarding this error. ### PaginationInfoSchema - `end` (integer, required) — Position of the last item in the list - `records` (integer, required) — Total number of items returned in the list - `start` (integer, required) — Position of the first item in the list - `total` (integer, required) — Total number of items in the project ### ProjectInfoSchema - `id` (string, required) — Project ID - `name` (string, required) — Project name ### ScheduledOperationSchemaSpec - `type`: `MediaKind.ScheduledOperation.StartStop` (ScheduledOperationStartStopSpecSchema) - `correlationData` (map from string to any, required) — User data - `endTime` (datetime, required) — End of the event - `startTime` (datetime, required) — Start of the event ### ScheduledOperationMetadataSchema - `id` (string, optional) — The ID of the resource - `name` (string, optional) — The name of the resource ### ScheduledOperationStatusSchema - `state` (enum, required) — State of the scheduled operation - Allowed values: `Pending`, `Accepted`, `Errored`, `Ongoing`, `Completed` - `errors` (list of string, optional) — description of the errors found ## Examples **Response** ```json { "supplemental": { "count": 1, "kind": "string", "operation": "string", "pagination": { "end": 1, "records": 1, "start": 1, "total": 1 }, "subscription": { "id": "string", "name": "string" } }, "value": [ { "spec": { "type": "MediaKind.ScheduledOperation.StartStop", "correlationData": {}, "endTime": "2024-01-15T09:30:00Z", "startTime": "2024-01-15T09:30:00Z" }, "metadata": { "id": "string", "name": "name" }, "status": { "state": "Pending", "errors": [ "string" ] } } ], "@odata.nextLink": "string" } ``` **SDK Code** ```python import requests url = "https://app.mk.io/api/v1/projects/project_name/live/staticMultiviewEvents/name/scheduledOperations" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://app.mk.io/api/v1/projects/project_name/live/staticMultiviewEvents/name/scheduledOperations'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://app.mk.io/api/v1/projects/project_name/live/staticMultiviewEvents/name/scheduledOperations" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://app.mk.io/api/v1/projects/project_name/live/staticMultiviewEvents/name/scheduledOperations") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://app.mk.io/api/v1/projects/project_name/live/staticMultiviewEvents/name/scheduledOperations") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://app.mk.io/api/v1/projects/project_name/live/staticMultiviewEvents/name/scheduledOperations', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://app.mk.io/api/v1/projects/project_name/live/staticMultiviewEvents/name/scheduledOperations"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://app.mk.io/api/v1/projects/project_name/live/staticMultiviewEvents/name/scheduledOperations")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```