Introduction
UNE GET demande au https://api.bcovlive.io/v1/jobs Le point de terminaison de l'API Live vous permet d'obtenir une liste des tâches en direct que vous avez créées. De même, un GET demande à https://api.bcovlive.io/v1/jobs/{job_id}/vods obtient une liste de travaux VOD pour un travail en direct. Vous trouverez tous les détails de ces demandes dans le Référence API. Cette rubrique fournit une vue d'ensemble et quelques détails supplémentaires. Sauf indication contraire, les paramètres décrits ci-dessous s'appliquent à ces deux demandes.
Pagination
La pagination des résultats est gérée par le start_token et page_size paramètres de requête. La taille de la page indique le nombre de résultats à renvoyer pour chaque requête et peut être définie sur n'importe quel nombre compris entre 1 et 1 000.
Chaque réponse comprendra un next_token champ s'il y a des résultats supplémentaires. Réglage de la start_token à la next_token value renverra la page de résultats suivante.
Tri
Les résultats peuvent être triés à l'aide du sort paramètre, qui peut être réglé sur created_at (par défaut) ou modified_at. Vous pouvez également définir le sens du tri en définissant le sort_dir paramètre à asc (par défaut) ou desc.
Filtres de recherche
Vous pouvez limiter les résultats en ajoutant des paramètres de filtre de recherche. Tous les filtres de recherche sont facultatifs. Les filtres multiples sont considérés comme AND des conditions, c'est-à-dire que toutes les conditions doivent être remplies pour qu'une tâche de vidéo à la demande soit incluse dans les résultats.
Plusieurs valeurs peuvent être spécifiées pour un seul filtre en utilisant le format suivant :
{filter}=[value1,value2]
Les valeurs de filtre spécifiées de cette manière sont traitées comme OR des conditions : une tâche est renvoyée si elle correspond à l'une des valeurs.
Un opérateur de comparaison peut être inclus avant une valeur de filtre, séparé par deux points :
{filter}={op}:{value}
Les opérateurs sont les suivants : gt ge(supérieur à), (supérieur ou égal), lt(inférieur à), le(inférieur ou égal). Par exemple, pour rechercher des jobs vod créés après le 1er janvier 2018 :
created_at=gt:1514764800000
Le type de filtre est déduit de la valeur. Si un nombre ou un booléen doit être traité comme une chaîne, il peut être entouré de guillemets simples :
{filter}=’1234’
| Nom du filtre | Type | Description / Valeurs |
|---|---|---|
user_id |
chaîne, tableau de chaînes | Identifiant d'utilisateur |
created_at |
entier | Temps Unix de création de tâche (en millisecondes) |
modified_at |
entier | Heure Unix du dernier changement d'état de la tâche (en millisecondes) |
static |
booléen | A un point de terminaison statique (pour les demandes de tâches de liste uniquement) |
state |
chaîne, tableau de chaînes | Un ou plusieurs états de tâche (pour les demandes de tâche de liste uniquement) |
jvod_state |
chaîne, tableau de chaînes | Un ou plusieurs états de tâche VOD (pour les demandes de tâche liste vod uniquement) |
jvod_type |
chaîne, tableau de chaînes | Un ou plusieurs types de tâches VOD (pour les demandes de tâches liste vod uniquement) |
label |
chaîne, tableau de chaînes | Une ou plusieurs étiquettes de tâche VOD (pour les demandes de tâche liste vod uniquement) |
sep_state |
chaîne, tableau de chaînes | Un ou plusieurs états de point de terminaison statiques (pour les demandes de tâches de liste uniquement) |
ssai_state |
chaîne, tableau de chaînes | Un ou plusieurs états SSAI (pour les demandes de tâches de liste uniquement) |
region |
chaîne, tableau de chaînes | Une ou plusieurs régions (pour les demandes d'emploi de liste uniquement) |
account_id |
chaîne | Recherchez un compte particulier ou spécifiez « * » pour rechercher tous les comptes. La valeur par défaut est le compte auquel appartient la clé API |
{other_job_fields} |
déduit du type de champ | D'autres champs d'emploi peuvent être filtrés en spécifiant leur nom interne et une valeur |
Exemples
Vous trouverez ci-dessous quelques exemples de demandes pour obtenir des emplois en direct.
- Obtenez les tâches en direct dans un état terminé, en affichant en premier les plus récemment créées :
https://api.bcovlive.io/v1/jobs?state=finished&sort=created_at&sort_dir=desc- Obtenez des emplois en direct SEP qui sont actuellement actifs
https://api.bcovlive.io/v1/jobs?static=true&sep_state=ready- Obtenez des emplois en direct créés à partir du 01/10/2018
https://api.bcovlive.io/v1/jobs?created_at=gt:1538428165517