Referencia API

API de Listas de reproducción

Listas de reproducción

Referencia HTTP. Generada a partir del contrato backend. Explore los endpoints abajo o descargue OpenAPI.

Este grupo tiene 16 operaciones, generadas a partir de api/openapi.yaml. Filtre por ruta, acción o autenticación. Cada endpoint indica sus entradas; despliéguelo para ver una plantilla de solicitud y los códigos de respuesta. Las plantillas necesitan sus propios valores y un cuerpo válido según el esquema.

Reemplace los marcadores en mayúsculas con sus valores. Para una solicitud JSON, guarde un cuerpo que coincida con el esquema en request.json. Los ejemplos de cookies usan un frasco de cookies local de una sesión autenticada.

Listas de reproducción

GET/api/playlists

Listar playlists V2

Lista de listas de reproducción versionadas que puede exponer páginas de espacios publicitarios. La lista v1 rechaza una página que contiene un documento con anuncios con version_required en lugar de filtrarla.

Páginas como listPlaylists, las más nuevas primero, máximo 200 por página y menos una vez que una página contiene 8 MiB de listas de reproducción almacenadas. next_cursor es la posición de la última fila devuelta mientras quedan más filas; páselo como after, con los mismos filtros, para la siguiente página. next_cursor es null en la última página. library=true enumera en su lugar las listas de reproducción de la Biblioteca de la organización (solo lectura; prográmelas o cree otras a partir de sus plantillas).

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
listPlaylistsV2

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
libraryconsultaopcional

true enumera el proyecto Biblioteca de la organización en lugar de este proyecto: sus elementos son de solo lectura aquí y llevan library true. Una organización sin Biblioteca, o el propio proyecto Biblioteca, no enumera nada con true.

despuésconsultaopcionalnext_cursor de la página anterior de la misma lista, con los mismos filtros. Omitido comienza en la fila más reciente. Un valor que no sea tal cursor es invalid_request.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playlists'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Listas de reproducción con la unión de la página de espacio publicitario.PlaylistV2List (application/json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
POST/api/playlists

Crear lista de reproducción V2

Entrada de creación para la unión de páginas de espacio publicitario. Como máximo 16 páginas de espacio publicitario, al menos una página ordinaria sin visibilidad, y la reutilización de una definición de espacio en diferentes páginas siguen siendo verificaciones del servidor. La resolución de referencias y DNS siguen siendo verificaciones del servidor.

Una sesión del panel (el editor de páginas) crea la lista de reproducción en vivo, nunca como propuesta, atribuida a la persona, y requiere al propietario del proyecto o a un miembro que pueda aprobar (de lo contrario, approver_required); el contenido multimedia que nombra y que espera su revisión es media_pending_review (409), donde la escritura en vivo de un agente lo aprueba.

Una escritura que contiene una página iframe que el Player web no puede encuadrar se guarda de todos modos; la respuesta incluye advertencias (PlaylistWarning) y el registro del proyecto recibe un evento playlist.iframe_framing_refused por cada página.

Una escritura cuyo src de iframe, fallback_src o params de aplicación leen un token de pantalla ({screen.field.NAME} y los demás de los esquemas de primitivas) que le falta a una pantalla que muestra la lista de reproducción también responde con una advertencia screen_fact_missing que nombra las primeras 20 pantallas de ese tipo; los manifiestos de esas pantallas omiten esa primitiva.

Un src o fallback_src de iframe que sea un enlace de Google Slides, Docs o Sheets (compartir, Publicar en la web o insertar) o un enlace Embed de Microsoft 365 OneDrive o SharePoint se almacena reconstruido para la pantalla: Slides se repite y avanza según el delayms del enlace, limitado a la duración de la página, y Docs, Sheets, Word y Excel se recargan cada 5 minutos.

Un código de inserción <iframe> pegado en src o fallback_src se lee por su src. Un archivo que pide a los espectadores que inicien sesión se rechaza con document_not_shared (400), cuyo errors[0].field es ese src o fallback_src y cuyo detalle nombra el ajuste de uso compartido que hay que cambiar.

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
PlaylistCreateRequest
ID de operación
createPlaylistV2

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
Screenrig-Review-Noteencabezadoopcional

Nota opcional del proponente en una escritura de clase revisión, enviada como UTF-8 codificado en porcentaje (lo que escribe encodeURIComponent de JavaScript). El servidor la decodifica en porcentaje (una escape inválido es 400 invalid_request); la nota decodificada es texto plano, máximo 280 caracteres tras recortar, sin caracteres de control (de lo contrario 400 invalid_request).

Almacenado en la revisión cuando la escritura se convierte en una; ignorado cuando se aplica en vivo.

Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/playlists'

Respuestas

EstadoSignificadoCuerpo y encabezados
202

La escritura se convirtió en una revisión y espera la aprobación de una persona (docs/reviews.md), con acceso Proponer, o con cualquier nivel de acceso cuando alcanza una pantalla de una carpeta de pantallas protegida, donde la decide un segundo aprobador (docs/screen-scope.md). Una persona aprueba, rechaza o solicita cambios en el panel, en review.url.

Una repetición de Idempotency-Key responde con el mismo cuerpo.

ReviewPending (application/json)
201Lista de reproducción con sus páginas de espacios publicitarios.PlaylistV2 (application/json)
402

feature_not_in_plan — Declarar campos, bloquear una primitiva o cambiar una lista de reproducción que declara campos corresponde a las plantillas de listas de reproducción, y el plan del proyecto no las incluye; required_plan nombra el plan que sí las incluye. Crear una lista de reproducción a partir de una plantilla siempre está permitido.

Un formato de 2 o más monitores (un muro de video) forma parte de Plus; un formato de región y una lista de reproducción sin formato están en todos los planes. El problema nombra la función, el plan del proyecto y required_plan.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
GET/api/playlists/{id}

Obtener lista de reproducción V2

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
getPlaylistV2

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
idrutarequerido
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playlists/RESOURCE_ID'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Lista de reproducción con sus páginas de espacios publicitarios.PlaylistV2 (application/json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
PUT/api/playlists/{id}

Actualizar lista de reproducción V2

Actualización versionada que acepta la unión de páginas de espacios publicitarios. If-Match lleva la revisión de la lista de reproducción.

Una sesión del panel (el editor de páginas) reemplaza la lista de reproducción en vivo, nunca como propuesta, atribuida a la persona; requiere al propietario del proyecto o a un miembro que pueda aprobar (de lo contrario, approver_required) e If-Match (invalid_request si falta); una lista de reproducción que ninguna persona ha aprobado aún es playlist_not_approved (409), como en patchPlaylistStructure, y el contenido multimedia que una página nombra y que espera su revisión es media_pending_review (409).

Una escritura que contiene una página iframe que el Player web no puede encuadrar se guarda de todos modos; la respuesta incluye advertencias (PlaylistWarning) y el registro del proyecto recibe un evento playlist.iframe_framing_refused por cada página.

Una escritura cuyo src de iframe, fallback_src o params de aplicación leen un token de pantalla ({screen.field.NAME} y los demás de los esquemas de primitivas) que le falta a una pantalla que muestra la lista de reproducción también responde con una advertencia screen_fact_missing que nombra las primeras 20 pantallas de ese tipo; los manifiestos de esas pantallas omiten esa primitiva.

Un src o fallback_src de iframe que sea un enlace de Google Slides, Docs o Sheets (compartir, Publicar en la web o insertar) o un enlace Embed de Microsoft 365 OneDrive o SharePoint se almacena reconstruido para la pantalla: Slides se repite y avanza según el delayms del enlace, limitado a la duración de la página, y Docs, Sheets, Word y Excel se recargan cada 5 minutos.

Un código de inserción <iframe> pegado en src o fallback_src se lee por su src. Un archivo que pide a los espectadores que inicien sesión se rechaza con document_not_shared (400), cuyo errors[0].field es ese src o fallback_src y cuyo detalle nombra el ajuste de uso compartido que hay que cambiar.

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
PlaylistWriteV2
ID de operación
updatePlaylistV2

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
Screenrig-Review-Noteencabezadoopcional

Nota opcional del proponente en una escritura de clase revisión, enviada como UTF-8 codificado en porcentaje (lo que escribe encodeURIComponent de JavaScript). El servidor la decodifica en porcentaje (una escape inválido es 400 invalid_request); la nota decodificada es texto plano, máximo 280 caracteres tras recortar, sin caracteres de control (de lo contrario 400 invalid_request).

Almacenado en la revisión cuando la escritura se convierte en una; ignorado cuando se aplica en vivo.

idrutarequerido
If-MatchencabezadoopcionalRevisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.
Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Campos del cuerpo de la solicitud

CampoDescripción
nombre (requerido, cadena)minLength: 1 maxLength: 120
campos (opcional, PlaylistTemplateFields)

Declarar campos convierte la lista de reproducción en una plantilla. Cada marcador que lee una página debe nombrar un campo declarado del tipo correcto y cada campo debe leerse; una lista sin campos no lee marcadores. Una plantilla nunca se muestra en una pantalla (playlist_is_template). PUT sin fields los conserva; null o una matriz vacía los quita.

pages (requerido, arreglo)

Las páginas de una lista de reproducción pueden resolver a un máximo de 1024 referencias multimedia en total. Un selector by:ids cuenta su longitud; una definición by:all, by:tag o by:folder reserva 32 referencias independientemente del tamaño del catálogo. La instantánea real del bucle está limitada a 1024 referencias multimedia en total. Por encima de cualquiera de los presupuestos es 422 invalid en la ruta pages.

audio (opcional, PlaylistAudioWrite)

Banda sonora opcional de lista de reproducción: multimedia de audio ordenado listo (MP3) que se reproduce continuamente mientras cambian las páginas (docs/playlist-audio.md). Los cambios de página nunca la detienen ni reinician. PUT reemplaza toda la lista de reproducción, por lo que omitir audio elimina la banda sonora.

formato (opcional, PlaylistFormat)

Para qué se crea una lista de reproducción: un muro de video (PlaylistWallFormat) o una región (PlaylistRegionFormat), nunca ambos. Una lista de reproducción sin formato es una lista ordinaria que se asigna a cualquier pantalla como la página.

Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/playlists/RESOURCE_ID'

Respuestas

EstadoSignificadoCuerpo y encabezados
202

La escritura se convirtió en una revisión y espera la aprobación de una persona (docs/reviews.md), con acceso Proponer, o con cualquier nivel de acceso cuando alcanza una pantalla de una carpeta de pantallas protegida, donde la decide un segundo aprobador (docs/screen-scope.md). Una persona aprueba, rechaza o solicita cambios en el panel, en review.url.

Una repetición de Idempotency-Key responde con el mismo cuerpo.

ReviewPending (application/json)
200Lista de reproducción actualizada.PlaylistV2 (application/json)
402

feature_not_in_plan — Declarar campos, bloquear una primitiva o cambiar una lista de reproducción que declara campos corresponde a las plantillas de listas de reproducción, y el plan del proyecto no las incluye; required_plan nombra el plan que sí las incluye. Crear una lista de reproducción a partir de una plantilla siempre está permitido.

Establecer un formato de muro de video (2 o más monitores) distinto del propio de la lista de reproducción forma parte de Plus. El problema nombra la función, el plan del proyecto y required_plan.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
PATCH/api/playlists/{id}

Parche de lista de reproducción

Cambia solo los campos de primer nivel enviados: name, pages, audio, format o fields. Los campos omitidos se conservan de la misma instantánea de la transacción. Las pages, audio y format enviados reemplazan el valor completo; audio null quita la banda sonora y format null quita el formato. Los elementos de matrices anidadas no se combinan.

Una edición solo de nombre de una lista de reproducción aprobada no revalida ni vuelve a resolver su contenido sin cambios, incluyendo formatos de página almacenados antiguos. Se validan el contenido suministrado y las relaciones audio/indicio de página. If-Match protege opcionalmente la revisión; parches idénticos no hacen nada y reintentos idempotentes reproducen la respuesta original.

El acceso Propose y la política de revisión funcionan como en PUT, incluidas las advertencias que recibe un valor pages proporcionado para una página iframe que el Player web no puede encuadrar. PUT sigue reemplazando el documento completo.

Autenticación
projectBearer
Cuerpo de la solicitud
PlaylistPatch
ID de operación
patchPlaylist

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
Screenrig-Review-Noteencabezadoopcional

Nota opcional del proponente en una escritura de clase revisión, enviada como UTF-8 codificado en porcentaje (lo que escribe encodeURIComponent de JavaScript). El servidor la decodifica en porcentaje (una escape inválido es 400 invalid_request); la nota decodificada es texto plano, máximo 280 caracteres tras recortar, sin caracteres de control (de lo contrario 400 invalid_request).

Almacenado en la revisión cuando la escritura se convierte en una; ignorado cuando se aplica en vivo.

idrutarequerido
If-MatchencabezadoopcionalRevisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.
Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Campos del cuerpo de la solicitud

CampoDescripción
nombre (opcional, cadena)minLength: 1 maxLength: 120
pages (opcional, arreglo)
fields (opcional, inline)
audio (opcional, en línea)
formato (opcional, en línea)
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request PATCH --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/playlists/RESOURCE_ID'

Respuestas

EstadoSignificadoCuerpo y encabezados
202

La escritura se convirtió en una revisión y espera la aprobación de una persona (docs/reviews.md), con acceso Proponer, o con cualquier nivel de acceso cuando alcanza una pantalla de una carpeta de pantallas protegida, donde la decide un segundo aprobador (docs/screen-scope.md). Una persona aprueba, rechaza o solicita cambios en el panel, en review.url.

Una repetición de Idempotency-Key responde con el mismo cuerpo.

ReviewPending (application/json)
200Lista de reproducción actualizada; ETag lleva su revisión.PlaylistV2 (application/json)
402

feature_not_in_plan — Declarar campos, bloquear una primitiva o cambiar una lista de reproducción que declara campos corresponde a las plantillas de listas de reproducción, y el plan del proyecto no las incluye; required_plan nombra el plan que sí las incluye. Crear una lista de reproducción a partir de una plantilla siempre está permitido.

Establecer un formato de muro de video (2 o más monitores) distinto del propio de la lista de reproducción forma parte de Plus. El problema nombra la función, el plan del proyecto y required_plan.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
ELIMINAR/api/playlists/{id}

Eliminar lista de reproducción V2

Marca como eliminada una lista de reproducción del proyecto autenticado. Se rechaza con resource_conflict (409) mientras alguna pantalla, incluidas las archivadas o pendientes, la tenga como predeterminada, en su programación o como toma de control, mientras una carpeta de pantallas la tenga como predeterminada o mientras una campaña la reproduzca.

La sesión del panel también puede eliminar; crea y reemplaza listas de reproducción con createPlaylistV2 y updatePlaylistV2 y cambia su estructura mediante patchPlaylistStructure.

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
deletePlaylistV2

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
idrutarequerido
If-MatchencabezadoopcionalRevisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.
Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playlists/RESOURCE_ID'

Respuestas

EstadoSignificadoCuerpo y encabezados
204Lista de reproducción eliminada.sin cuerpo
409

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
PATCH/api/playlists/{id}/structure

Parche de estructura de lista de reproducción

Una persona conectada cambia la estructura de una lista de reproducción y nunca lo que muestran sus páginas: su nombre, el orden de sus páginas, qué páginas permanecen y el avance y visibilidad de cada página mantenida. pages es el nuevo orden completo; una página almacenada que omite se elimina, y un id que la lista de reproducción no tiene, o uno repetido, es invalid_request en pages[i].id.

El lienzo, transición, audio_cue, primitivas y comentarios de una página guardada son siempre los almacenados: el cuerpo no tiene miembro para ellos, y cualquier otro miembro es rechazado.

Las páginas guardadas pasan por la misma resolución y validación que cualquier lista de reproducción almacenada, por lo que un elemento multimedia eliminado desde entonces es rechazado (resource_conflict) y la lista de reproducción aún conserva una página ordinaria sin visibilidad, como máximo 16 páginas de espacios publicitarios y sus señales audio_end. advance reemplaza el avance de la página (una página de espacio publicitario no tiene); visibility reemplaza la visibilidad de la página cuando es un objeto, la elimina cuando es nulo y la mantiene cuando se omite.

Un cambio que deja la lista de reproducción tal como está almacenada no realiza ninguna acción. If-Match lleva la revisión de la lista de reproducción y es obligatorio (invalid_request si falta, revision_conflict si está desactualizado). La escritura se aplica inmediatamente en todas las pantallas que muestran la lista de reproducción y se atribuye a la persona en playlist.updated; nunca es una propuesta, por lo que la respuesta nunca es 202.

Una lista de reproducción que ninguna persona ha aprobado aún (approved_revision 0) se rechaza con playlist_not_approved (409): decida primero su revisión. Un nombre que otra lista de reproducción del proyecto ya usa es resource_conflict. Solo la sesión del panel; los agentes cambian listas de reproducción con patchPlaylist, y una persona cambia lo que muestran las páginas con updatePlaylistV2.

La respuesta incluye warnings (PlaylistWarning) como en cualquier escritura, entre ellas screen_fact_missing cuando a una pantalla que muestra la lista de reproducción le falta un valor que leen el src de un iframe o los params de aplicación de sus páginas. El cuerpo es de 64 KiB como máximo.

Autenticación
dashboardSession
Cuerpo de la solicitud
PlaylistStructurePatch
ID de operación
patchPlaylistStructure

Parámetros

NombreEnviar¿Requerido?Descripción
idrutarequerido
If-MatchencabezadorequeridoLa revisión actual de la lista de reproducción, citada o simple (la ETag de la última lectura). Una revisión obsoleta es revision_conflict con current_revision.
Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Campos del cuerpo de la solicitud

CampoDescripción
nombre (opcional, cadena)minLength: 1 maxLength: 120
pages (opcional, arreglo)

Cada página que permanece, en orden de reproducción. Un id que la lista de reproducción no contiene, o uno listado dos veces, es invalid_request en pages[i].id. El resultado debe cumplir las reglas de la lista de reproducción: al menos una página ordinaria sin visibilidad, máximo 16 páginas de espacios publicitarios, una página audio_end mantiene su audio_cue.

Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request PATCH --cookie cookies.txt --cookie-jar cookies.txt --header 'If-Match: "REVISION"' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/playlists/RESOURCE_ID/structure'

Respuestas

EstadoSignificadoCuerpo y encabezados
200La lista de reproducción tal como está almacenada ahora; ETag lleva su revisión.PlaylistV2 (application/json); encabezados: ETag
402

feature_not_in_plan — declarar campos, bloquear una primitiva o cambiar una lista de reproducción que declara campos corresponde a las plantillas de listas de reproducción, y el plan del proyecto no las incluye; required_plan nombra el plan que sí las incluye. Crear una lista de reproducción a partir de una plantilla siempre está permitido.

Problema (application/problem+json)
409playlist_not_approved — la lista de reproducción no tiene una versión aprobada; resource_conflict — el nombre está en uso, o un elemento multimedia o un nombre de página guardado ya no está listo.Problema (application/problem+json)
412revision_conflict: If-Match está obsoleto; current_revision del error contiene la revisión actual.Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
GET/api/playlists/{id}/revisions

Listar revisiones de la lista de reproducción

The playlist's revisions, newest first: each revision a write stored (a create, a replace, a patch, a structure change, an applied review, a promote) with its name, its page count, the kind of change and who made it.

History begins with the revision a playlist held when revision history was first recorded: until its next write the list holds that revision alone, with change baseline. Revisions are kept for as long as the playlist is. At most 50 per page; next_cursor while more remain, null on the last page.

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
listPlaylistRevisions

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
idrutarequerido
despuésconsultaopcionalnext_cursor de la página anterior de la misma lista, con los mismos filtros. Omitido comienza en la fila más reciente. Un valor que no sea tal cursor es invalid_request.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playlists/RESOURCE_ID/revisions'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Las revisiones de la lista de reproducción, de la más reciente a la más antigua.PlaylistRevisionList (application/json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
GET/api/playlists/{id}/revisions/{revision}

Obtener una revisión de la lista de reproducción

One revision of the playlist and the playlist as it stood at that revision: its name, pages, soundtrack and format, with revision set to this one. A revision the playlist never had, or one from before its history began, is not_found.

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
getPlaylistRevision

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
idrutarequerido
revisiónrutarequeridoUna revisión de la lista de reproducción, tal como la numera listPlaylistRevisions.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playlists/RESOURCE_ID/revisions/REVISION'

Respuestas

EstadoSignificadoCuerpo y encabezados
200La revisión y la lista de reproducción en esa revisión.PlaylistRevisionDetail (application/json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
POST/api/playlists/{id}/revisions/{revision}/promote

Promover una revisión de la lista de reproducción

Makes an earlier revision current again by copying it forward: its pages, soundtrack and format become a new revision, the current one plus one, whose change is promoted and restored_from names the revision copied. The playlist keeps its current name, earlier revisions stay as they were, and every screen that shows the playlist updates as for any other write.

If-Match is required and names the current revision (invalid_request when absent, revision_conflict when stale). The pages are resolved again as a structure change resolves them: a selector matches today's media, and media or a web app the revision named that is gone or not ready refuses the promote with the problem a write would get.

Una revisión cuyo contenido es el contenido actual no cambia nada y responde con la lista de reproducción actual. Requiere una credencial que publique en vivo (prohibido para una cuyas escrituras se proponen para revisión) o una sesión de panel del propietario del proyecto o de un miembro que pueda aprobar (approver_required); una lista de reproducción que ninguna persona ha aprobado aún da playlist_not_approved (409).

Como en cualquier escritura, la respuesta incluye warnings (PlaylistWarning), entre ellas screen_fact_missing cuando a una pantalla que muestra la lista de reproducción le falta un valor que leen el src de un iframe o los params de aplicación de las páginas promovidas.

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
promotePlaylistRevision

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
idrutarequerido
revisiónrutarequeridoUna revisión de la lista de reproducción, tal como la numera listPlaylistRevisions.
If-MatchencabezadoopcionalRevisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.
Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playlists/RESOURCE_ID/revisions/REVISION/promote'

Respuestas

EstadoSignificadoCuerpo y encabezados
200La lista de reproducción con la revisión copiada como actual; ETag lleva su revisión.PlaylistV2 (application/json)
402

feature_not_in_plan — declarar campos, bloquear una primitiva o cambiar una lista de reproducción que declara campos corresponde a las plantillas de listas de reproducción, y el plan del proyecto no las incluye; required_plan nombra el plan que sí las incluye. Crear una lista de reproducción a partir de una plantilla siempre está permitido.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
PATCH/api/playlists/{id}/values

Actualizar valores de lista de reproducción

Establece, o con null borra, los valores de campo de una lista de reproducción creada a partir de una plantilla y vuelve a crear sus páginas con la revisión actual de la plantilla: los valores se comprueban como al crear y los cambios de marca hechos en la plantilla desde entonces llegan a esta copia. No envíe valores para solo poner la copia al día.

Clase de revisión como cualquier escritura de lista de reproducción: el propietario o un miembro que pueda aprobar (sesión del panel) y una credencial Manage escriben en directo, un cargador solo para sus listas y carpetas, y Propose convierte el cambio en una revisión (202). Una lista que no se creó a partir de una plantilla es invalid_request. If-Match es opcional.

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
PlaylistValuesChange
ID de operación
updatePlaylistValues

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
Screenrig-Review-Noteencabezadoopcional

Nota opcional del proponente en una escritura de clase revisión, enviada como UTF-8 codificado en porcentaje (lo que escribe encodeURIComponent de JavaScript). El servidor la decodifica en porcentaje (una escape inválido es 400 invalid_request); la nota decodificada es texto plano, máximo 280 caracteres tras recortar, sin caracteres de control (de lo contrario 400 invalid_request).

Almacenado en la revisión cuando la escritura se convierte en una; ignorado cuando se aplica en vivo.

idrutarequerido
If-MatchencabezadoopcionalRevisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.
Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Campos del cuerpo de la solicitud

CampoDescripción
valores (requerido, objeto)Nombre de campo a valor; null borra un campo opcional. Los campos no nombrados conservan su valor.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request PATCH --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/playlists/RESOURCE_ID/values'

Respuestas

EstadoSignificadoCuerpo y encabezados
202

La escritura se convirtió en una revisión y espera la aprobación de una persona (docs/reviews.md), con acceso Proponer, o con cualquier nivel de acceso cuando alcanza una pantalla de una carpeta de pantallas protegida, donde la decide un segundo aprobador (docs/screen-scope.md). Una persona aprueba, rechaza o solicita cambios en el panel, en review.url.

Una repetición de Idempotency-Key responde con el mismo cuerpo.

ReviewPending (application/json)
200La lista de reproducción actualizada; ETag lleva su revisión.PlaylistV2 (application/json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
GET/api/playlists/{id}/instances

Listar instancias de lista de reproducción

Las listas de reproducción creadas a partir de una plantilla (como máximo 1000, por nombre), cada una con la revisión de la plantilla con la que se crearon sus páginas y si la plantilla tiene una más reciente.

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
listPlaylistInstances

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
idrutarequerido
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playlists/RESOURCE_ID/instances'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Las instancias.PlaylistInstanceList (application/json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
POST/api/playlists/{id}/expand

Expandir plantilla de lista de reproducción

Las páginas que tendría una lista de reproducción creada con la plantilla y estos valores, comprobadas por todas las reglas. Solo calcula; no se guarda nada.

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
PlaylistExpandRequest
ID de operación
expandPlaylistTemplate

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
idrutarequerido

Campos del cuerpo de la solicitud

CampoDescripción
valores (opcional, objeto)
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/playlists/RESOURCE_ID/expand'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Las páginas.PlaylistExpanded (application/json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
POST/api/playlists/{id}/pages

Añadir página de lista de reproducción

Añade una página a una lista de reproducción aprobada sin enviar las demás: al final, o delante de la página indicada por before.

Las páginas que la lista de reproducción ya contiene se conservan tal como están almacenadas y se comprueban de nuevo con la nueva en una sola pasada, de modo que las reglas entre páginas (de 1 a 100 páginas, una página ordinaria sin visibilidad, 16 páginas de espacio publicitario, 1024 referencias de medios) ven el resultado: una regla incumplida da invalid_request con field (page.id cuando el id ya está en uso, before cuando no nombra ninguna página).

La validez de página de la lista de reproducción es la visibilidad propia de la página (from, until, windows, data), en la zona horaria de cada pantalla, con until exclusivo.

Clase de revisión: en Proponer, el cambio se convierte en una revisión (202); un cambio de página posterior de la misma lista de reproducción por el mismo proponente amplía esa revisión pendiente mientras se base en la revisión en vivo, de modo que los cambios sucesivos no se sustituyen entre sí, y la aprobación los aplica todos o ninguno (review_stale cuando la lista de reproducción ha avanzado); la revisión pendiente de un cambio de página de otro proponente no se amplía ni se sustituye, y el cambio espera con resource_conflict (409).

Con Administrar, o desde una sesión del panel del propietario o de un miembro que pueda aprobar (de lo contrario, approver_required), queda en vivo. If-Match es opcional: si está presente, debe ser la revisión en vivo. Una lista de reproducción que ninguna persona ha aprobado aún es playlist_not_approved (409).

Un usuario de carga (docs/uploaders.md) solo añade una página de medios de sus carpetas a una de sus listas de reproducción (de lo contrario, outside_upload_scope); un miembro usuario de carga en Proponer es el proponente de la revisión (kind person).

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
PlaylistPageAdd
ID de operación
addPlaylistPage

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
Screenrig-Review-Noteencabezadoopcional

Nota opcional del proponente en una escritura de clase revisión, enviada como UTF-8 codificado en porcentaje (lo que escribe encodeURIComponent de JavaScript). El servidor la decodifica en porcentaje (una escape inválido es 400 invalid_request); la nota decodificada es texto plano, máximo 280 caracteres tras recortar, sin caracteres de control (de lo contrario 400 invalid_request).

Almacenado en la revisión cuando la escritura se convierte en una; ignorado cuando se aplica en vivo.

idrutarequerido
If-MatchencabezadoopcionalRevisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.
Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.

Campos del cuerpo de la solicitud

CampoDescripción
page (requerido, PlaylistPageWriteV2)
before (opcional, cadena)La página delante de la que se coloca; si se omite, se añade al final. pattern: "^[A-Za-z][A-Za-z0-9_-]{0,63}$"
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/playlists/RESOURCE_ID/pages'

Respuestas

EstadoSignificadoCuerpo y encabezados
202

La escritura se convirtió en una revisión y espera la aprobación de una persona (docs/reviews.md), con acceso Proponer, o con cualquier nivel de acceso cuando alcanza una pantalla de una carpeta de pantallas protegida, donde la decide un segundo aprobador (docs/screen-scope.md). Una persona aprueba, rechaza o solicita cambios en el panel, en review.url.

Una repetición de Idempotency-Key responde con el mismo cuerpo.

ReviewPending (application/json)
200La lista de reproducción actualizada; ETag lleva su revisión.PlaylistV2 (application/json)
402

feature_not_in_plan — declarar campos, bloquear una primitiva o cambiar una lista de reproducción que declara campos corresponde a las plantillas de listas de reproducción, y el plan del proyecto no las incluye; required_plan nombra el plan que sí las incluye. Crear una lista de reproducción a partir de una plantilla siempre está permitido.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
PUT/api/playlists/{id}/pages/{page_id}

Reemplazar página de lista de reproducción

Reemplaza una página de una lista de reproducción aprobada, en su sitio, sin enviar las demás. El cuerpo es la página y su id es page_id. Una página desconocida es not_found.

Todo lo demás es como en addPlaylistPage: se valida con las páginas conservadas en una sola pasada, clase de revisión (202 en Proponer, encadenada a una revisión pendiente de cambio de página), en vivo con Administrar o por una persona que aprueba, If-Match opcional, playlist_not_approved para una lista de reproducción que ninguna persona aprobó.

Un usuario de carga solo reemplaza una página de medios de sus carpetas por otra página de medios de sus carpetas; en Proponer, también puede reemplazar las páginas que esperan en su propia revisión.

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
PlaylistPageWriteV2
ID de operación
replacePlaylistPage

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
idrutarequerido
page_idrutarequeridoCadena de id de página de lista de reproducción.
Screenrig-Review-Noteencabezadoopcional

Nota opcional del proponente en una escritura de clase revisión, enviada como UTF-8 codificado en porcentaje (lo que escribe encodeURIComponent de JavaScript). El servidor la decodifica en porcentaje (una escape inválido es 400 invalid_request); la nota decodificada es texto plano, máximo 280 caracteres tras recortar, sin caracteres de control (de lo contrario 400 invalid_request).

Almacenado en la revisión cuando la escritura se convierte en una; ignorado cuando se aplica en vivo.

If-MatchencabezadoopcionalRevisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.
Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/playlists/RESOURCE_ID/pages/PAGE_ID'

Respuestas

EstadoSignificadoCuerpo y encabezados
202

La escritura se convirtió en una revisión y espera la aprobación de una persona (docs/reviews.md), con acceso Proponer, o con cualquier nivel de acceso cuando alcanza una pantalla de una carpeta de pantallas protegida, donde la decide un segundo aprobador (docs/screen-scope.md). Una persona aprueba, rechaza o solicita cambios en el panel, en review.url.

Una repetición de Idempotency-Key responde con el mismo cuerpo.

ReviewPending (application/json)
200La lista de reproducción actualizada; ETag lleva su revisión.PlaylistV2 (application/json)
402

feature_not_in_plan — declarar campos, bloquear una primitiva o cambiar una lista de reproducción que declara campos corresponde a las plantillas de listas de reproducción, y el plan del proyecto no las incluye; required_plan nombra el plan que sí las incluye. Crear una lista de reproducción a partir de una plantilla siempre está permitido.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
ELIMINAR/api/playlists/{id}/pages/{page_id}

Eliminar página de lista de reproducción

Elimina una página de una lista de reproducción aprobada. La lista de reproducción conserva de 1 a 100 páginas y una página ordinaria sin visibilidad (de lo contrario, invalid_request). Una página desconocida es not_found. Todo lo demás es como en replacePlaylistPage. Un usuario de carga solo elimina una página de medios de sus carpetas.

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
removePlaylistPage

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
idrutarequerido
page_idrutarequeridoCadena de id de página de lista de reproducción.
Screenrig-Review-Noteencabezadoopcional

Nota opcional del proponente en una escritura de clase revisión, enviada como UTF-8 codificado en porcentaje (lo que escribe encodeURIComponent de JavaScript). El servidor la decodifica en porcentaje (una escape inválido es 400 invalid_request); la nota decodificada es texto plano, máximo 280 caracteres tras recortar, sin caracteres de control (de lo contrario 400 invalid_request).

Almacenado en la revisión cuando la escritura se convierte en una; ignorado cuando se aplica en vivo.

If-MatchencabezadoopcionalRevisión positiva opcional de recurso. Omitir para escribir el recurso actual; una revisión obsoleta suministrada es revision_conflict.
Idempotency-KeyencabezadoopcionalOmitir para una operación nueva. Proporcione y reutilice una clave para deduplicar reintentos; el CLI gestiona las claves automáticamente.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playlists/RESOURCE_ID/pages/PAGE_ID'

Respuestas

EstadoSignificadoCuerpo y encabezados
202

La escritura se convirtió en una revisión y espera la aprobación de una persona (docs/reviews.md), con acceso Proponer, o con cualquier nivel de acceso cuando alcanza una pantalla de una carpeta de pantallas protegida, donde la decide un segundo aprobador (docs/screen-scope.md). Una persona aprueba, rechaza o solicita cambios en el panel, en review.url.

Una repetición de Idempotency-Key responde con el mismo cuerpo.

ReviewPending (application/json)
200La lista de reproducción actualizada; ETag lleva su revisión.PlaylistV2 (application/json)
402

feature_not_in_plan — declarar campos, bloquear una primitiva o cambiar una lista de reproducción que declara campos corresponde a las plantillas de listas de reproducción, y el plan del proyecto no las incluye; required_plan nombra el plan que sí las incluye. Crear una lista de reproducción a partir de una plantilla siempre está permitido.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)