Eine Liste von Live- oder VOD-Jobs abrufen
Einleitung
EIN GET Anfrage an die https://api.bcovlive.io/v1/jobs Endpunkt der Live-API können Sie eine Liste der von Ihnen erstellten Live-Jobs abrufen. In ähnlicher Weise a GET Anfrage zu https://api.bcovlive.io/v1/jobs/{job_id}/vods Ruft eine Liste von VOD-Jobs für einen Live-Job ab. Alle Einzelheiten zu diesen Anträgen finden Sie in der API-Referenz. Dieses Thema bietet einen Überblick und einige zusätzliche Details. Sofern nicht anders angegeben, gelten die unten beschriebenen Parameter für beide Anforderungen.
Seitennummerierung
Die Paginierung der Ergebnisse erfolgt über die start_token und page_size Abfrageparameter. Die Seitengröße gibt die Anzahl der Ergebnisse an, die bei jeder Anforderung zurückgegeben werden sollen, und kann auf eine beliebige Zahl zwischen 1 und 1000 festgelegt werden.
Jede Antwort enthält a next_token Feld, wenn zusätzliche Ergebnisse vorhanden sind. Einstellen der start_token zum next_token value gibt die nächste Ergebnisseite zurück.
Sortierung
Die Ergebnisse können mit dem sortiert werden sort Parameter, der auf eingestellt werden kann created_at (Standard) oder modified_at. Sie können die Sortierrichtung auch festlegen, indem Sie die sort_dir Parameter zu asc (Standard) oder desc.
Suchfilter
Sie können die Ergebnisse einschränken, indem Sie Suchfilterparameter hinzufügen. Alle Suchfilter sind optional. Mehrere Filter werden behandelt als AND Bedingungen - das heißt, alle Bedingungen müssen erfüllt sein, damit ein Vod-Job in die Ergebnisse aufgenommen wird.
Für einen einzelnen Filter können mehrere Werte im folgenden Format angegeben werden:
{filter}=[value1,value2]
Auf diese Weise angegebene Filterwerte werden behandelt als OR Bedingungen -- ein Job wird zurückgegeben, wenn er mit einem der Werte übereinstimmt.
Ein Vergleichsoperator kann vor einem Filterwert eingefügt werden, getrennt durch einen Doppelpunkt:
{filter}={op}:{value}
Betreiber sind: gt (größer als), ge (größer als oder gleich), lt (weniger als), le (weniger als oder gleich). So suchen Sie beispielsweise nach Vod-Jobs, die nach dem 1. Januar 2018 erstellt wurden:
created_at=gt:1514764800000
Der Filtertyp wird aus dem Wert abgeleitet. Wenn eine Zahl oder ein boolescher Wert als String behandelt werden muss, kann er in einfache Anführungszeichen eingeschlossen werden:
{filter}=’1234’
| Filtername | Typ | Beschreibung / Werte |
|---|---|---|
user_id |
string, Array von Strings | Benutzeridentifikation |
created_at |
ganze Zahl | Unix-Zeit der Joberstellung (in Millisekunden) |
modified_at |
ganze Zahl | Unix-Zeit der letzten Zustandsänderung des Jobs (in Millisekunden) |
static |
boolesch | Hat statischen Endpunkt (nur für Listenjobanfragen) |
state |
string, Array von Strings | Ein oder mehrere Jobstatus (nur für Listenjobanfragen) |
jvod_state |
string, Array von Strings | Ein oder mehrere VOD-Jobstatus (nur für Listen-VOD-Jobanfragen) |
jvod_type |
string, Array von Strings | Ein oder mehrere VOD-Jobtypen (nur für Listen-VOD-Jobanfragen) |
label |
string, Array von Strings | Ein oder mehrere VOD-Joblabels (nur für Listen-VOD-Jobanfragen) |
sep_state |
string, Array von Strings | Mindestens ein statischer Endpunktstatus (nur für Listenjobanfragen) |
ssai_state |
string, Array von Strings | Ein oder mehrere SSAI-Staaten (nur für Listenjobanfragen) |
region |
string, Array von Strings | Eine oder mehrere Regionen (nur für Listenjobanfragen) |
account_id |
Schnur | Durchsuchen Sie ein bestimmtes Konto oder geben Sie '*' ein, um alle Konten zu durchsuchen. Der Standardwert ist der Konto-API-Schlüssel, zu dem gehört |
{other_job_fields} |
aus dem Feldtyp abgeleitet | Andere Jobfelder können durch Angabe ihres internen Namens und eines Wertes gefiltert werden |
Beispiele
Nachfolgend finden Sie einige Beispielanfragen für Live-Jobs.
- Erhalten Sie Live-Jobs in einem abgeschlossenen Zustand, wobei die zuletzt erstellten zuerst angezeigt werden:
https://api.bcovlive.io/v1/jobs?state=finished&sort=created_at&sort_dir=desc- Erhalten Sie SEP Live-Jobs, die derzeit aktiv sind
https://api.bcovlive.io/v1/jobs?static=true&sep_state=ready- Erhalten Sie Live-Jobs, die am oder nach dem 01.10.2018 erstellt wurden
https://api.bcovlive.io/v1/jobs?created_at=gt:1538428165517