Listas de reproducción/Endpoints dinámicos (2022/06)
Use estos endpoints para administrar Dynamic Playlists en la red.
URL base para estos endpoints: https://api.bsn.cloud/2022/06/REST/Playlists/Dynamic
_________________________________________________________________________
GET /
Recupera una lista de Dynamic Playlists en la red.
Token de alcance requerido
bsn.api.main.playlists.dynamic.retrieve
______________________________________________________________
Parámetros de Query String
- filtro string opcional: Una expresiónexpresión para filtrar resultados de búsqueda. El valor predeterminado es null.
- ordenar string opcional: Una expresión para ordenar los resultados de búsqueda. La expresión de ordenación especifica la entrada utilizada para ordenar y el orden de clasificación ascendente/descendente (ASC/DESC) (por ejemplo "[Dispositivo].[Serie] ASC"). El valor predeterminado es null.
- marcador string opcional: Un valor que especifica qué página recuperar. Este valor es útil si la entrada isTruncated en el cuerpo de la respuesta de la llamada GET anterior indica que el número de Dynamic Playlists excede el pageSize. Este parámetro solo es necesario si usted necesita más elementos en la lista paginada que el pageSize (100).
- pageSize int opcional: La cantidad máxima de Dynamic Playlists que puede contenerse en el cuerpo de la respuesta. Esto usa de forma predeterminada el tamaño máximo de página permitido (100).
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- marcador value se establece en el valor de la propiedad [PagedList].[NextMarker] de la respuesta anterior de la API de BSN.cloud.
- pageSize se establece en 1
- filtro se establece en [Name] CONTIENE 'Building'
- ordenar se establece en [LastModifiedDate] DESC
GET /2022/06/REST/Playlists/Dynamic/?marker=MjAyMy0xMS0wMVQyMjozNzoyNC40MDNaLDExNjQwNDE3&pageSize=1&filter=%5BName%5D%20CONTAINS%20%27Building%27&sort=%5BLastModifiedDate%5D%20DESC HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Cuerpo de la respuesta exitosa
200: Devuelve una lista paginadalista paginada de Entidades de Dynamic PlaylistsEntidad de Dynamic Playlists en una red. Esto devolverá no más de 100 entidades junto con la información necesaria para devolver cualquier otra página restante.
Ejemplo
{
"items": [ {
"id": 12345678,
"name": "WestBuilding",
"physicalPath": "https://bsncloud.s3.amazonaws.com/JaneDoe/87a992afd6071576647ecd1fd65776ba",
"fileSize": 1060,
"fileHash": "SHA1:B995E0604EDD01F5E143B0329AABE9A14D06B821",
"creationDate": "2023-11-01T22:36:42.153Z",
"lastModifiedDate": "2023-11-01T22:36:42.253Z",
"supportsAudio": true,
"supportsVideo": true,
"supportsImages": true,
"content": null,
"presentations": [ {
"id": 3210,
"name": "Test4Buildings",
"type": "Presentation",
"link": null
}],
"permissions": []
}],
"totalItemCount": 3,
"matchingItemCount": 2,
"pageSize": 1,
"nextMarker": "MjAyMy0xMS0wMVQyMjozNjo0Mi4yNTNaLDExNjQwNDE1",
"prevMarker": "MjAyMy0xMS0wMVQyMjozNjo0Mi4yNTNaLDExNjQwafg9",
"isTruncated": false,
"sortExpression": "[LastModifiedDate] DESC",
"filterExpression": "[Name] CONTAINS 'Building'"
}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no brinda acceso a este método
406: El servidor no puede devolver la representación de datos que usted solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
POST /
Cree una nueva Dynamic Playlist en la red.
Token de alcance requerido
bsn.api.main.playlists.dynamic.create
______________________________________________________________
Cuerpo de la solicitud
- La Entidad de Dynamic PlaylistsDynamic Playlists Entity
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
POST /2022/06/REST/Playlists/Dynamic/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 328Este es el cuerpo de la solicitud de ejemplo:
{
"id": 0,
"name": "NorthwestBuilding",
"physicalPath": null,
"fileSize": 0,
"fileHash": null,
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"supportsAudio": true,
"supportsVideo": true,
"supportsImages": true,
"content": [
{
"contentId": 12345,
"fileName": "Saturday Breakfast Menu.jpg",
"displayDuration": "00:00:15",
"validityStartDate": "2023-11-11T08:00:00",
"validityEndDate": "2023-11-11T12:00:00"
}
],
"presentations": null,
"permissions": []
}______________________________________________________________
Cuerpo de la respuesta correcta
201: Devuelve la Entidad de Dynamic PlaylistsDynamic Playlists Entity creada y referenciada por el Uri (proporcionado por el campo del encabezado Location) en la respuesta
Ejemplo
{
"id": 23456789,
"name": "NorthwestBuilding",
"physicalPath": "https://bsncloud.s3.amazonaws.com/JaneDoe/3004b40831e00749a44e646fbe1ad068",
"fileSize": 334,
"fileHash": "SHA1:4ADEBD82AB32F6E9FD4733F552D56C0282736BBD",
"creationDate": "2023-11-03T16:44:44.9301064Z",
"lastModifiedDate": "2023-11-03T16:44:44.9301064Z",
"supportsAudio": true,
"supportsVideo": true,
"supportsImages": true,
"content": [
{
"contentId": 12345,
"fileName": "Saturday Breakfast Menu.jpg",
"displayDuration": "00:00:15",
"validityStartDate": "2023-11-11T08:00:00",
"validityEndDate": "2023-11-11T12:00:00"
}
],
"presentations": [],
"permissions": []
}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, son inválidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso es inválido o no se especificó
403: El token de acceso proporcionado, aunque es válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
415: El servidor no puede aceptar la representación de datos que envió (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /
Elimina Dynamic Playlists, especificadas por un filtro, de una red. Esto permite eliminar varias Dynamic Playlists a la vez.
Token de alcance requerido
bsn.api.main.playlists.dynamic.delete
______________________________________________________________
Parámetro de cadena de consulta
- filtro string required: Una expresiónexpression para filtrar los resultados de búsqueda
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados del ejemplo de solicitud se establecen de la siguiente manera:
- filtro se establece en [Name] CONTIENE 'Southeast'
DELETE /2022/06/REST/Playlists/Dynamic/?filter=%5BName%5D%20CONTAINS%20%27Southeast%27 HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Cuerpo de respuesta exitoso
200: Devuelve el número de Dynamic Playlists afectadas como un valor entero
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay varias representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, son inválidos, o se rechazan de acuerdo con las reglas de negocio (por ejemplo, la Dynamic Playlist especificada se está utilizando en una presentación y no puede eliminarse)
401: El token de acceso es inválido o no se especificó
403: El token de acceso proporcionado, aunque es válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /Count/
Devuelve la cantidad de Dynamic Playlists en la red que coinciden con los criterios de filtro especificados. Si no se incluye ningún filtro, esta llamada devuelve la cantidad total de Dynamic Playlists en la red.
Token de alcance requerido
bsn.api.main.playlists.dynamic.retrieve
______________________________________________________________
Parámetro de cadena de consulta
- filtro string opcional: Una expresiónexpression para filtrar resultados de búsqueda. El valor predeterminado es null.
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- filtro se establece en [SupportsVideo] ES VERDADERO
GET /2022/06/REST/Playlists/Dynamic/Count/?filter=%5BSupportsVideo%5D%20IS%20TRUE HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Cuerpo de la respuesta exitosa
200: El número de Dynamic Playlists se devuelve como un valor entero.
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está malformada y por lo tanto no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que usted solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{id}/
Devuelve la Dynamic Playlist especificada
Token de alcance requerido
bsn.api.main.playlists.dynamic.retrieve
______________________________________________________________
Segmento
- id int: Un identificador único para la Dynamic Playlist
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 12345678
- El valor opcional del encabezado If-Modified-Since es igual al valor del encabezado Última modificación recuperado de la respuesta anterior de GET /id o GET /name
GET /2022/06/REST/Playlists/Dynamic/12345678/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 13 Mar 2024 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta exitosa con cuerpo
200: Devuelve la Entidad de Dynamic PlaylistsDynamic Playlists Entity
Ejemplo
Este es un ejemplo de una respuesta de nivel 200:
{
"id": 12345678,
"name": "WestBuilding",
"physicalPath": "https://bsncloud.s3.amazonaws.com/JaneDoe/87a992afd6071576647ecd1fd65776ba",
"fileSize": 1060,
"fileHash": "SHA1:B895E0604EDD11F5E143B1329AABE9L13D06B821",
"creationDate": "2023-11-01T22:36:42.153Z",
"lastModifiedDate": "2024-03-13T21:32:35.093Z",
"supportsAudio": true,
"supportsVideo": true,
"supportsImages": true,
"content": [
{
"contentId": 123456,
"fileName": "Steampunk Resin Clock With Metallic Cogs And Gears.mp4",
"displayDuration": "00:00:00",
"validityStartDate": null,
"validityEndDate": null
}
],
"presentations": [
{
"id": 987654,
"name": "Test4Buildings",
"type": "Presentation",
"link": null
}
],
"permissions": []
}Respuesta correcta
304: El recurso no se modificó desde la hora especificada en el encabezado “If-Modified-Since”
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
PUT /{id}/
Modifica la Dynamic Playlist especificada
Token de Scope requerido
bsn.api.main.playlists.dynamic.update
______________________________________________________________
Segmento
- id int: Un identificador único para la Dynamic Playlist
______________________________________________________________
Cuerpo de la solicitud
- La Entidad de Dynamic PlaylistsDynamic Playlists Entity
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 1234567
- El valor opcional del encabezado If-Unmodified-Since es igual al valor del encabezado Última modificación recuperado de la respuesta de GET /id o GET /name .
PUT /2022/06/REST/Playlists/Dynamic/1234567/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
If-Unmodified-Since: Wed, 13 Mar 2024 21:32:34 GMT
Content-Type: application/json
Content-Length: 320Este es el cuerpo de la solicitud de ejemplo:
{
"id": 0,
"name": "Southwest",
"physicalPath": null,
"fileSize": 0,
"fileHash": null,
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"supportsAudio": true,
"supportsVideo": true,
"supportsImages": true,
"content": [
{
"contentId": 123456,
"fileName": "Steampunk Resin Clock With Metallic Cogs And Gears.mp4",
"displayDuration": "00:00:00",
"validityStartDate": null,
"validityEndDate": null
}
],
"presentations": null,
"permissions": []
}______________________________________________________________
Respuesta correcta
204: La Dynamic Playlist especificada ha sido modificada
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
412: Falló la condición previa (el recurso cambió desde el momento especificado en el valor del encabezado “If-Unmodified-Since”)
415: El servidor no puede aceptar la representación de datos que usted envió (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{id}/
Elimina la Dynamic Playlist especificada
Token de alcance requerido
bsn.api.main.playlists.dynamic.delete
______________________________________________________________
Segmento
- id int: Un identificador único para la Dynamic Playlist
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 1234567
- El valor opcional del encabezado If-Unmodified-Since es igual al valor del encabezado Última modificación recuperado de la respuesta de GET /id o GET /name .
DELETE /2022/06/REST/Playlists/Dynamic/1234567/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Unmodified-Since: Wed, 13 Mar 2024 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta exitosa
204: El archivo Dynamic Playlist especificado se ha eliminado de la red
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
412: Falló la condición previa (el recurso cambió desde el momento especificado en el valor del encabezado “If-Unmodified-Since”)
5XX: Cualquier código 500 es un error interno del servidor
GET /{name}/
Devuelve la Dynamic Playlist especificada
Token de Scope requerido
bsn.api.main.playlists.dynamic.retrieve
______________________________________________________________
Segmento
- nombre string: El nombre de la Dynamic Playlist
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- nombre se establece en WestBuilding
- El valor opcional del encabezado If-Modified-Since es igual al valor del encabezado Última modificación recuperado de la respuesta anterior de GET /id o GET /name
GET /2022/06/REST/Playlists/Dynamic/WestBuilding/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 13 Mar 2024 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta correcta con cuerpo
200: Devuelve la Entidad de Dynamic PlaylistsDynamic Playlists Entity
Ejemplo
Este es un ejemplo de una respuesta de nivel 200:
{
"id": 12345678,
"name": "WestBuilding",
"physicalPath": "https://bsncloud.s3.amazonaws.com/JaneDoe/87a992afd6071576647ecd1fd65776ba",
"fileSize": 1060,
"fileHash": "SHA1:B895E0604EDD11F5E143B0329AABE9A13D06B821",
"creationDate": "2023-11-01T22:36:42.153Z",
"lastModifiedDate": "2024-03-13T21:32:35.093Z",
"supportsAudio": true,
"supportsVideo": true,
"supportsImages": true,
"content": [
{
"contentId": 123456,
"fileName": "Steampunk Resin Clock With Metallic Cogs And Gears.mp4",
"displayDuration": "00:00:00",
"validityStartDate": null,
"validityEndDate": null
}
],
"presentations": [
{
"id": 987654,
"name": "Test4Buildings",
"type": "Presentation",
"link": null
}
],
"permissions": []
}Respuesta correcta
304: El recurso no se modificó desde la hora especificada en el encabezado “If-Modified-Since”
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está malformada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
PUT /{name}/
Modifica la Dynamic Playlist especificada
Token de Scope requerido
bsn.api.main.playlists.dynamic.update
______________________________________________________________
Segmento
- nombre string: El nombre de la Dynamic Playlist
______________________________________________________________
Cuerpo de la solicitud
- La Entidad de Dynamic PlaylistsDynamic Playlists Entity
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- nombre se establece en Suroeste
- El valor del encabezado opcional If-Unmodified-Since es igual al valor del encabezado Última modificación recuperado de la respuesta de GET /id o GET /name.
PUT /2022/06/REST/Playlists/Dynamic/Southwest/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
If-Unmodified-Since: Wed, 13 Mar 2024 21:32:34 GMT
Content-Type: application/json
Content-Length: 320Este es el cuerpo de la solicitud de ejemplo:
{
"id": 0,
"name": "Southwest",
"physicalPath": null,
"fileSize": 0,
"fileHash": null,
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"supportsAudio": true,
"supportsVideo": true,
"supportsImages": true,
"content": [
{
"contentId": 123456,
"fileName": "Steampunk Resin Clock With Metallic Cogs And Gears.mp4",
"displayDuration": "00:00:00",
"validityStartDate": null,
"validityEndDate": null
}
],
"presentations": null,
"permissions": []
}______________________________________________________________
Respuesta correcta
204: La Dynamic Playlist especificada ha sido modificada
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
412: La condición previa falló (el recurso cambió desde el momento especificado en el valor del encabezado “If-Unmodified-Since”)
415: El servidor no puede aceptar la representación de datos que usted envió (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{name}/
Elimina la Dynamic Playlist especificada
Token de alcance requerido
bsn.api.main.playlists.dynamic.delete
______________________________________________________________
Segmento
- nombre string: El nombre de la Dynamic Playlist
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- nombre se establece en Noreste
- El valor opcional del encabezado If-Unmodified-Since es igual al valor del encabezado Última modificación recuperado de la respuesta de GET /id o GET /name.
DELETE /2022/06/REST/Playlists/Dynamic/Northeast/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Unmodified-Since: Wed, 13 Mar 2024 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta correcta
204: El archivo Dynamic Playlist especificado se ha eliminado de la red
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud están malformados y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas empresariales
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (según se especifica en el encabezado "Accept")
412: La condición previa falló (el recurso cambió desde la hora especificada en el valor del encabezado “If-Unmodified-Since”)
5XX: Cualquier código 500 es un error interno del servidor
GET /Operations/
Devuelve los permisos operativos otorgados a los roles para operaciones empresariales específicas
Token de alcance requerido
bsn.api.main.operations.retrieve
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
GET /2022/06/REST/Playlists/Dynamic/Operations/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Cuerpo de la respuesta correcta
200: Devuelve la Entidad de operaciones empresarialesBusiness Operations Entity
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{id}/Permissions/
Incluye permisos de objeto para una Dynamic Playlist determinada
Token de alcance requerido
bsn.api.main.playlists.dynamic.retrieve
______________________________________________________________
Segmento
- id int: Un identificador único para la Dynamic Playlist
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id es 12345678
GET /2022/06/REST/Playlists/Dynamic/12345678/Permissions/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Cuerpo de la respuesta exitosa
200: Devuelve una matriz de entidades de PermisoPermission
Ejemplo
[
{
"entityId": 12345678,
"operationUID": "60252669-c9ea-c784-7de0-1d685b99c255",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-25T22:17:24.28Z"
},
{
"entityId": 12345678,
"operationUID": "cc86a53e-e63d-4268-b2bf-fe4579d461f4",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-27T18:48:11.053Z"
}
]Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
POST /{id}/Permissions/
Agrega permisos a la Dynamic Playlist especificada
Token de alcance requerido
bsn.api.main.playlists.dynamic.update
______________________________________________________________
Segmento
- id int: Un identificador único para la Dynamic Playlist
______________________________________________________________
Cuerpo de la solicitud
- Una matriz de entidades PermisoPermission
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 987654321
POST /2022/06/REST/Playlists/Dynamic/987654321/Permissions/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 318Este es el cuerpo de la solicitud de ejemplo:
[
{
"entityId": 987654321,
"operationUID": "cc86a53e-e63d-4268-b2bf-fe4579d461f4",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10701
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "0001-01-01T00:00:00"
}
]______________________________________________________________
Respuesta correcta
204: Los permisos se agregaron correctamente a la lista de reproducción dinámica especificada
Respuesta de error
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
415: El servidor no puede aceptar la representación de datos que envió (según lo especificado en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{id}/Permissions/
Elimina permisos para la Dynamic Playlist especificada
Token de alcance requerido
bsn.api.main.playlists.dynamic.update
______________________________________________________________
Segmento
- id int: Un identificador único para la Dynamic Playlist
______________________________________________________________
Cuerpo de la solicitud
- Una matriz de entidades PermisoPermission entidades
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id es 12345678
DELETE /2022/06/REST/Playlists/Dynamic/12345678/Permissions/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 318Este es el cuerpo de solicitud de ejemplo:
[
{
"entityId": 12345678,
"operationUID": "cc86a53e-e63d-4268-b2bf-fe4579d461f4",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10701
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "0001-01-01T00:00:00"
}
]______________________________________________________________
Respuesta correcta
204: Los permisos especificados se eliminaron correctamente
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{name}/Permissions/
Incluye permisos de objetos para una Dynamic Playlist determinada
Token de Scope requerido
bsn.api.main.playlists.dynamic.retrieve
______________________________________________________________
Segmento
- nombre string: El nombre de la Dynamic Playlist
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- nombre es NorthBuilding
GET /2022/06/REST/Playlists/Dynamic/NorthBuilding/Permissions/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Cuerpo de la respuesta correcta
200: Devuelve una matriz de entidades PermisoPermission
Ejemplo
[
{
"entityId": 12345678,
"operationUID": "60252669-c9ea-c784-7de0-1d685b99c255",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-25T22:17:24.28Z"
},
{
"entityId": 4567890,
"operationUID": "cc86a53e-e63d-4268-b2bf-fe4579d461f4",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-27T18:48:11.053Z"
}
]Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque es válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
POST /{name}/Permissions/
Agrega permisos a la Dynamic Playlist especificada
Token de alcance requerido
bsn.api.main.playlists.dynamic.update
______________________________________________________________
Segmento
- nombre string: El nombre de la Dynamic Playlist
______________________________________________________________
Cuerpo de la solicitud
- Una matriz de entidades PermisoPermission
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en NorthBuilding
POST /2022/06/REST/Playlists/Dynamic/NorthBuilding/Permissions/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 318Este es el cuerpo de la solicitud de ejemplo:
[
{
"entityId": 12345678,
"operationUID": "cc86a53e-e63d-4268-b2bf-fe4579d461f4",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10701
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "0001-01-01T00:00:00"
}
]______________________________________________________________
Respuesta correcta
204: Los permisos se agregaron correctamente a la Dynamic Playlist especificada
Respuesta de error
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas comerciales
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque es válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
415: El servidor no puede aceptar la representación de datos que envió (según se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{name}/Permissions/
Elimina permisos de la Dynamic Playlist especificada
Token de alcance requerido
bsn.api.main.playlists.dynamic.update
______________________________________________________________
Segmento
- nombre string: El nombre de la Dynamic Playlist
______________________________________________________________
Cuerpo de la solicitud
- Una matriz de PermisoPermission entidades
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id es NorthBuilding
DELETE /2022/06/REST/Playlists/Dynamic/NorthBuilding/Permissions/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 318Este es el cuerpo de solicitud de ejemplo:
[
{
"entityId": 12345678,
"operationUID": "cc86a53e-e63d-4268-b2bf-fe4579d461f4",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10701
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "0001-01-01T00:00:00"
}
]______________________________________________________________
Respuesta exitosa
204: Los permisos especificados se eliminaron correctamente
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tiene un formato incorrecto y, por lo tanto, no es válido, o se rechaza de acuerdo con las reglas empresariales
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor