Introducción
A GET solicitud a la https://api.bcovlive.io/v1/jobs El punto final de la API en vivo le permite obtener una lista de los trabajos en vivo que ha creado. Del mismo modo, un GET solicitud de https://api.bcovlive.io/v1/jobs/{job_id}/vods obtiene una lista de trabajos de VOD para un trabajo en vivo. Los detalles completos de estas solicitudes se pueden encontrar en el Referencia de API. Este tema proporciona una descripción general y algunos detalles adicionales. A menos que se indique lo contrario, los parámetros que se describen a continuación se aplican a ambas solicitudes.
Paginación
La paginación de resultados se maneja a través del start_token y page_size parámetros de consulta. El tamaño de la página indica el número de resultados que se devolverán en cada solicitud y se puede establecer en cualquier número del 1 al 1000.
Cada respuesta incluirá un next_token campo si hay resultados adicionales. Establecer el start_token hacia next_token value devolverá la siguiente página de resultados.
Clasificación
Los resultados se pueden ordenar utilizando el sort parámetro, que se puede establecer en created_at (predeterminado) o modified_at. También puede establecer la dirección de clasificación configurando el sort_dir parámetro a asc (predeterminado) o desc.
Filtros de búsqueda
Puede limitar los resultados agregando parámetros de filtro de búsqueda. Todos los filtros de búsqueda son opcionales. Los filtros múltiples se tratan como AND condiciones, es decir, se deben cumplir todas las condiciones para que un trabajo de vod se incluya en los resultados.
Se pueden especificar varios valores para un solo filtro utilizando el siguiente formato:
{filter}=[value1,value2]
Los valores de filtro especificados de esta manera se tratan como OR condiciones: se devuelve un trabajo si coincide con alguno de los valores.
Se puede incluir un operador de comparación antes de un valor de filtro, separado por dos puntos:
{filter}={op}:{value}
Los operadores son: gt (mas grande que), ge (mayor que o igual), lt (menos que), le (menor o igual). Por ejemplo, para buscar trabajos de vod creados después del 1 de enero de 2018:
created_at=gt:1514764800000
El tipo de filtro se infiere del valor. Si un número o un valor booleano debe tratarse como una cadena, puede encerrarse entre comillas simples:
{filter}=’1234’
| Nombre del filtro | Tipo | Descripción / Valores |
|---|---|---|
user_id |
cadena, matriz de cadenas | ID de usuario |
created_at |
entero | Tiempo Unix de creación de empleo (en milisegundos) |
modified_at |
entero | Tiempo Unix del último cambio de estado del trabajo (en milisegundos) |
static |
booleano | Tiene un punto final estático (solo para solicitudes de trabajo de lista) |
state |
cadena, matriz de cadenas | Uno o más estados de trabajo (solo para solicitudes de trabajo de lista) |
jvod_state |
cadena, matriz de cadenas | Uno o más estados de trabajos de VOD (solo para solicitudes de trabajos de VOD de lista) |
jvod_type |
cadena, matriz de cadenas | Uno o más tipos de trabajos de VOD (solo para solicitudes de trabajos de VOD de lista) |
label |
cadena, matriz de cadenas | Una o más etiquetas de trabajo de VOD (solo para solicitudes de trabajo de lista de VOD) |
sep_state |
cadena, matriz de cadenas | Uno o más estados de extremos estáticos (solo para solicitudes de trabajos de lista) |
ssai_state |
cadena, matriz de cadenas | Uno o más estados SSAI (solo para solicitudes de lista de trabajos) |
region |
cadena, matriz de cadenas | Una o más regiones (solo para solicitudes de lista de trabajos) |
account_id |
cuerda | Busque una cuenta en particular o especifique '*' para buscar todas las cuentas. El valor predeterminado es la clave API de la cuenta a la que pertenece |
{other_job_fields} |
inferido del tipo de campo | Se pueden filtrar otros campos de trabajo especificando su nombre interno y un valor |
Ejemplos
A continuación se muestran algunos ejemplos de solicitudes para obtener trabajos en vivo.
- Obtenga trabajos en vivo en un estado terminado, mostrando primero los creados más recientemente:
https://api.bcovlive.io/v1/jobs?state=finished&sort=created_at&sort_dir=desc- Obtenga trabajos en vivo de SEP que estén actualmente activos
https://api.bcovlive.io/v1/jobs?static=true&sep_state=ready- Obtenga trabajos en vivo creados a partir del 2018-10-01
https://api.bcovlive.io/v1/jobs?created_at=gt:1538428165517