Get Transcoder Schedule
GEThttps://api.millicast.com/api/transcoders/schedule/:scheduleId
Gets schedule summary by Schedule ID.
Request
Path Parameters
scheduleId stringrequired
Responses
- 200
- 400
- default
Success
- application/json
- Schema
- Example (auto)
- simple
Schema
statusstringrequired
Possible values: non-empty
Default value:
success
data objectrequired
{
"status": "success",
"data": {
"metadata": {
"createdOn": "2024-07-29T15:51:28.071Z",
"lastModifiedOn": "2024-07-29T15:51:28.071Z"
},
"status": "Active",
"scheduleId": "string",
"start": "2024-07-29T15:51:28.071Z",
"stop": "2024-07-29T15:51:28.071Z",
"clientId": "string",
"name": "string",
"description": "string",
"recurring": {
"frequency": {
"interval": "Daily",
"daysOfWeek": [
"Sunday"
]
},
"endDate": "2024-07-29T15:51:28.071Z"
},
"transcoderIds": [
"string"
],
"executions": [
{
"executionTime": "2024-07-29T15:51:28.071Z",
"scheduleType": "Start",
"executionStatus": "Pending",
"transcoderId": "string"
}
]
}
}
simple
{
"status": "success",
"data": {
"start": "2024-08-15T09:00:00Z",
"stop": "2024-08-17T09:00:00Z",
"clientId": "random_string",
"scheduleId": "b4d1f1ea-c8ae-49ca-815e-8460587207cb",
"status": "active",
"transcoderIds": [
"9dc8129e-499d-4989-bb32-a5ae459277c5"
],
"name": "start-transcoder-once",
"description": "first schedular ive created",
"recurring": {
"enabled": true,
"frequency": {
"interval": "weekly"
}
},
"metadata": {
"createdOn": "2024-08-14T09:23:12Z"
},
"executions": [
{
"executionTime": "2024-08-15T09:00:00Z",
"scheduleType": "Start",
"executionStatus": "Pending",
"transcoderId": "9dc8129e-499d-4989-bb32-a5ae459277c5"
},
{
"executionTime": "2024-08-17T09:00:00Z",
"scheduleType": "Stop",
"executionStatus": "Pending",
"transcoderId": "9dc8129e-499d-4989-bb32-a5ae459277c5"
}
]
}
}
Bad Request
- application/json
- Schema
- Example (auto)
Schema
statusstringrequired
Possible values: non-empty
Default value:
fail
datarequired
{
"status": "fail",
"data": {}
}
Server Error
- application/json
- Schema
- Example (auto)
- general
Schema
statusstringrequired
Possible values: non-empty
Default value:
error
messagestringrequired
Possible values: non-empty
codeint32nullable
datanullable
{
"status": "error",
"message": "string",
"code": 0
}
general
{
"status": "error",
"message": "simple error reason",
"code": 500,
"data": {
"additional": "other data here (not actual key)"
}
}
Authorization: http
name: API_Secrettype: httpdescription: ### Usage #### Acquire secret from dashboard. * Login to the streaming dashboard * On the left menu, click on Settings * Navigate to the Security tab's sub section API Secrets 1. "+ Create" to generate a new named API Secret if needed 2. Click on the copy button or the reveal button to access a previously created API Secret scheme: bearer
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.millicast.com/api/transcoders/schedule/:scheduleId");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());