Listas de reproducción/puntos de conexión etiquetados (2022/06)
Use estos endpoints para administrar Tagged Playlists en la red.
URL base para estos endpoints: https://api.bsn.cloud/2022/06/REST/Playlists/Tagged
_________________________________________________________________________
GET /
Devuelve una lista de Tagged Playlists en la red.
Token de alcance requerido
bsn.api.main.playlists.tagged.retrieve
______________________________________________________________
Parámetros de Query String
- filtro string opcional: Una expresiónexpression para filtrar los 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 orden especifica la entrada utilizada para el ordenamiento y el orden ascendente/descendente (ASC/DESC) (p. ej., "[Device].[Serial] 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 respuesta de la llamada GET anterior indica que el número de Tagged Playlists supera el pageSize. Este parámetro solo es necesario si necesita más elementos en la lista paginada que el pageSize (100).
- pageSize int opcional: La cantidad máxima de Tagged Playlists que puede contenerse en el cuerpo de 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 is set to the [PagedList].[NextMarker] property value from the previous BSN.cloud API response.
- pageSize se establece en 1
- filtro se establece en [WaitingForApprove] ES FALSO
- ordenar se establece en [Nombre] DESC
GET /2022/06/REST/Playlists/Tagged/?marker=Qm9zZSw2OTk2MTMz&pageSize=1&filter=%5BWaitingForApprove%5D%20IS%20FALSE&sort=%5BName%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 respuesta exitoso
200: Devuelve una lista paginadapaged list de Entidades de Tagged 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": 4629237,
"name": "Animals",
"physicalPath": "https://handlers.bsn.cloud/bs/GetFile.ashx?type=TaggedPlaylist&token=492A1CD3D8588F3DC1C61E082B77B901",
"contentsVirtualPath": "\\Shared\\",
"rule": "<Cats> IS 'Maine Coon' AND <Dogs> IS 'Beagle'",
"orderTag": "<FileName> ASC",
"ttl": "00:05:00",
"waitingForApprove": false,
"creationDate": "2022-08-22T19:01:19.457Z",
"lastModifiedDate": "2022-08-22T19:01:19.457Z",
"content": null,
"presentations": [],
"permissions": []
}],
"totalItemCount": 2,
"matchingItemCount": 2,
"pageSize": 1,
"nextMarker": "QW5pbWFscyw0NjI5MjM2",
"prevMarker": "QW5pbWFscyw0NjI55h67",
"isTruncated": false,
"sortExpression": "[Name] DESC",
"filterExpression": "[WaitingForApprove] IS FALSE"
}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
POST /
Crea una Tagged Playlist en la red.
Token de alcance requerido
bsn.api.main.playlists.tagged.create
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
POST /2022/06/REST/Playlists/Tagged/ 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: 535Este es el cuerpo de la solicitud de ejemplo:
{
"id": 0,
"name": "Entryway",
"physicalPath": null,
"contentsVirtualPath": "\\Shared\\Playlists\\",
"rule": "<audio> IS 'song' AND <video> IS 'demo'",
"orderTag": "<FileName> ASC",
"ttl": "00:05:00",
"waitingForApprove": false,
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"content": null,
"presentations": null,
"permissions": []
}______________________________________________________________
Cuerpo de la respuesta exitosa
201: Devuelve la Entidad de Tagged Playlists creada y referenciada por el Uri (proporcionado por el campo de encabezado Location) en la respuesta.
Ejemplo
{
"id": 12345678,
"name": "Entryway",
"physicalPath": "https://handlers.bsn.cloud/bs/GetFile.ashx?type=TaggedPlaylist&token=3C149FB6DA45DA4EBB81AB9090CA0154",
"contentsVirtualPath": "\\Shared\\Playlists\\",
"rule": "<audio> IS 'song' AND <video> IS 'demo' AND <Speaker> IS 'revolve'",
"orderTag": "<FileName> ASC",
"ttl": "00:05:00",
"waitingForApprove": false,
"creationDate": "2023-11-17T23:58:59.5921725Z",
"lastModifiedDate": "2023-11-17T23:58:59.5921725Z",
"content": [
{
"contentId": 12345,
"fileName": "audio1429519115.m4a",
"displayDuration": null,
"validityStartDate": null,
"validityEndDate": null,
"state": "Approved"
}
],
"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 está mal formado y, por lo tanto, no es válido, o se rechaza 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 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 Tagged Playlists, especificadas mediante un filtro, de la red. Esto le permite eliminar múltiples Tagged Playlists a la vez.
Token de Scope requerido
bsn.api.main.playlists.tagged.delete
______________________________________________________________
Parámetro de cadena de consulta
- filtro string required: Una expresiónexpresión para filtrar resultados de búsqueda
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- filtro se establece en [ContentsVirtualPath] IS '\\Shared\\Playlists\\'
DELETE /2022/06/REST/Playlists/Tagged/?filter=%5BContentsVirtualPath%5D%20IS%20%27%5C%5CShared%5C%5CPlaylists%5C%5C%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 la respuesta exitosa
200: Devuelve el número de Tagged Playlist afectados como un valor entero
Respuesta de error
300: La representación solicitada no pudo ser devuelta 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 de negocio
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
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 el número de Tagged Playlists en la red que coinciden con los criterios de filtro especificados. Si no se incluye ningún filtro, esta llamada devuelve el número total de Tagged Playlists en la red.
Token de Scope requerido
bsn.api.main.playlists.tagged.retrieve
______________________________________________________________
Parámetro de cadena de consulta
- filtro string opcional: Una expresiónexpresión 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 configuran de la siguiente manera:
- filtro se establece en [WaitingForApprove] ES FALSO
GET /2022/06/REST/Playlists/Tagged/Count/?filter=%5BWaitingForApprove%5D%20IS%20FALSE 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: El número de Tagged 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 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
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}/
Devuelve la Tagged Playlist especificada
Token de alcance requerido
bsn.api.main.playlists.tagged.retrieve
______________________________________________________________
Segmento
- id int: Un identificador único para la Tagged Playlist
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se configuran 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/Tagged/12345678/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta correcta con cuerpo
200: Devuelve la Entidad Tagged Playlists
Ejemplo
Este es un ejemplo de una respuesta de nivel 200:
{
"id": 12345678,
"name": "DecemberSaleEvent",
"physicalPath": "https://handlers.bsn.cloud/bs/GetFile.ashx?type=TaggedPlaylist&token=03BAD9A1CD834901HT5E574983F8215D",
"contentsVirtualPath": "\\Shared\\Playlists\\",
"rule": "<audio> IS 'song' AND <video> IS 'demo' AND <Speaker> IS 'revolve'",
"orderTag": "<FileName> ASC",
"ttl": "00:05:00",
"waitingForApprove": false,
"creationDate": "2023-11-07T18:35:49.003Z",
"lastModifiedDate": "2023-12-20T21:32:35.093Z",
"content": [
{
"contentId": 12345,
"fileName": "audio1429519115.m4a",
"displayDuration": null,
"validityStartDate": null,
"validityEndDate": null,
"state": "Approved"
}
],
"presentations": [
{
"id": 54321,
"name": "HTML_RedandGreen",
"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á 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
PUT /{id}/
Modifica la Tagged Playlist especificada
Token de Scope requerido
bsn.api.main.playlists.tagged.update
______________________________________________________________
Segmento
- id int: Un identificador único para la Tagged Playlist
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
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-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/Tagged/12345678/ 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, 20 Dec 2023 21:32:34 GMT
Content-Type: application/json
Content-Length: 705Este es el cuerpo de la solicitud de ejemplo:
{
"id": 12345678,
"name": "DecemberSaleEvent",
"physicalPath": null,
"contentsVirtualPath": "\\Shared\\Playlists\\",
"rule": "<audio> IS 'song' AND <video> IS 'demo' AND <Speaker> IS 'revolve'",
"orderTag": "<FileName> ASC",
"ttl": "00:05:00",
"waitingForApprove": false,
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"content": [
{
"contentId": 12345,
"fileName": "audio1429519115.m4a",
"displayDuration": "00:01:00",
"validityStartDate": "2023-12-01T00:00:00",
"validityEndDate": "2024-01-01T00:00:00",
"state": "Approved"
}
],
"presentations": null,
"permissions": []
}______________________________________________________________
Respuesta correcta
204: La Tagged Playlist especificada se ha actualizado en 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 mal formados 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 ha especificado
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")
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 envió (según se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{id}/
Elimina la Tagged Playlist especificada
Token de Scope requerido
bsn.api.main.playlists.tagged.delete
______________________________________________________________
Segmento
- id int: Un identificador único para la Tagged 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-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/Tagged/12345678/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Unmodified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta correcta
204: El archivo Tagged Playlist especificado se ha eliminado
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 mal formados 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 ha especificado
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")
412: Condición previa fallida (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 Tagged Playlist especificada
Token de Scope requerido
bsn.api.main.playlists.tagged.retrieve
______________________________________________________________
Segmento
- nombre string: El nombre de la Tagged Playlist
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- nombre se configura en EventoDeVentasDeDiciembre
- 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/Tagged/DecemberSaleEvent/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 20 Dec 2023 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 Tagged Playlists
Ejemplo
Este es un ejemplo de una respuesta de nivel 200:
{
"id": 12345678,
"name": "DecemberSaleEvent",
"physicalPath": "https://handlers.bsn.cloud/bs/GetFile.ashx?type=TaggedPlaylist&token=03BAD9A1CD834901HT5E574983F8215D",
"contentsVirtualPath": "\\Shared\\Playlists\\",
"rule": "<audio> IS 'song' AND <video> IS 'demo' AND <Speaker> IS 'revolve'",
"orderTag": "<FileName> ASC",
"ttl": "00:05:00",
"waitingForApprove": false,
"creationDate": "2023-11-07T18:35:49.003Z",
"lastModifiedDate": "2023-12-20T21:32:35.093Z",
"content": [
{
"contentId": 12345,
"fileName": "audio1429519115.m4a",
"displayDuration": null,
"validityStartDate": null,
"validityEndDate": null,
"state": "Approved"
}
],
"presentations": [
{
"id": 242158,
"name": "HTML_RedandGreen",
"type": "Presentation",
"link": null
}
],
"permissions": []
}Respuesta exitosa
304: El recurso no fue modificado desde el momento especificado 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á mal formada y, por lo tanto, es inválida
401: El token de acceso es invá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 Tagged Playlist especificada
Token de Scope requerido
bsn.api.main.playlists.tagged.create
______________________________________________________________
Segmento
- nombre string: El nombre de la Tagged Playlist
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- nombre se establece en EventoDeVentasDeDiciembre
- 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/Tagged/DecemberSaleEvent/ 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, 20 Dec 2023 21:32:34 GMT
Content-Type: application/json
Content-Length: 705Este es el cuerpo de la solicitud de ejemplo:
{
"id": 12345678,
"name": "DecemberSaleEvent",
"physicalPath": null,
"contentsVirtualPath": "\\Shared\\Playlists\\",
"rule": "<audio> IS 'song' AND <video> IS 'demo' AND <Speaker> IS 'revolve'",
"orderTag": "<FileName> ASC",
"ttl": "00:05:00",
"waitingForApprove": false,
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"content": [
{
"contentId": 12345,
"fileName": "audio1429519115.m4a",
"displayDuration": "00:01:00",
"validityStartDate": "2023-12-01T00:00:00",
"validityEndDate": "2024-01-01T00:00:00",
"state": "Approved"
}
],
"presentations": null,
"permissions": []
}______________________________________________________________
Respuesta exitosa
204: La Tagged Playlist especificada se ha actualizado en 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á mal formado y, por lo tanto, no es válido, o se rechaza 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 la hora especificada 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 Tagged Playlist especificada
Token de Scope requerido
bsn.api.main.playlists.tagged.delete
______________________________________________________________
Segmento
- nombre string: El nombre de la Tagged Playlist
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- nombre se establece en EventoDeVentasDeDiciembre
- 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/Tagged/DecemberSaleEvent/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Unmodified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta exitosa
204: El archivo Tagged Playlist especificado ha sido eliminado
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 comerciales
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 lo especificado en el encabezado "Accept")
412: Precondición fallida (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 /Operations/
Devuelve los permisos operativos otorgados a los roles para operaciones comerciales específicas
Token de ámbito requerido
bsn.api.main.playlists.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/Tagged/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 exitosa
200: Devuelve la Entidad de operaciones comercialesBusiness Operations Entity
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
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}/Permissions/
Incluye permisos de objeto para una Tagged Playlist determinada
Token de Scope requerido
bsn.api.main.playlists.tagged.retrieve
______________________________________________________________
Segmento
- id int: Un identificador único para la Tagged 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
GET /2022/06/REST/Playlists/Tagged/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 correcta
200: Devuelve una matriz de entidades de PermisoPermission
Ejemplo
[
{
"entityId": 12345678,
"operationUID": "3cd50d9a-a3be-4d6f-84a9-323ab72cc39e",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-11-07T22:10:20.99Z"
}
]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 usted solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
POST /{id}/Permissions/
Recupera los permisos para la Tagged Playlist especificada en la red.
Token de Scope requerido
bsn.api.main.playlists.tagged.update
______________________________________________________________
Segmento
- id int: Un identificador único para la Tagged Playlist
______________________________________________________________
Cuerpo de la solicitud
- Un array 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 12345678
POST /2022/06/REST/Playlists/Tagged/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: 484Este es el cuerpo de la solicitud de ejemplo:
{
"entityId": 12345678,
"operationUID": "3cd50d9a-a3be-4d6f-84a9-323ab72cc39e",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-11-09T18:03:06.673Z"
}______________________________________________________________
Respuesta exitosa
204: Los permisos se agregaron correctamente a la Tagged 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 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)
415: El servidor no puede aceptar la representación de datos que usted envió (según se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{id}/Permissions/
Elimina permisos para la Tagged Playlist especificada
Token de Scope requerido
bsn.api.main.playlists.tagged.delete
______________________________________________________________
Segmento
- id int: Un identificador único para la Tagged Playlist
______________________________________________________________
Cuerpo de la solicitud
- Un array 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 12345678
DELETE /2022/06/REST/Playlists/Tagged/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: 321Este es el cuerpo de la solicitud de ejemplo:
[
{
"entityId": 12345678,
"operationUID": "5c6ef943-d660-4907-aa56-e91903ff1772",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 0
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-11T18:46:30.1Z"
}
]______________________________________________________________
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 objeto para una Tagged Playlist determinada
Token de Scope requerido
bsn.api.main.playlists.tagged.retrieve
______________________________________________________________
Segmento
- nombre string: El nombre de la Tagged Playlist
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- nombre se establece en Tarde
GET /2022/06/REST/Playlists/Tagged/Afternoon/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": "3cd50d9a-a3be-4d6f-84a9-323ab72cc39e",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-11-07T22:10:20.99Z"
}
]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ó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
POST /{name}/Permissions/
Recupera los permisos para la Tagged Playlist especificada en la red.
Token de Scope requerido
bsn.api.main.playlists.tagged.update
______________________________________________________________
Segmento
- nombre string: El nombre de la Tagged 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 Mañana
POST /2022/06/REST/Playlists/Tagged/Morning/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: 484Este es el cuerpo de solicitud de ejemplo:
{
"entityId": 23456789,
"operationUID": "3cd50d9a-a3be-4d6f-84a9-323ab72cc39e",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-11-09T18:03:06.673Z"
}______________________________________________________________
Respuesta correcta
204: Los permisos se agregaron correctamente a la Tagged 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 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 para la Tagged Playlist especificada
Token de Scope requerido
bsn.api.main.playlists.tagged.update
______________________________________________________________
Segmento
- nombre string: El nombre de la Tagged 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:
- nombre se establece en Tarde
DELETE /2022/06/REST/Playlists/Tagged/Afternoon/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: 321Este es el cuerpo de la solicitud de ejemplo:
[
{
"entityId": 12345678,
"operationUID": "5c6ef943-d660-4907-aa56-e91903ff1772",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 0
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-11T18:46:30.1Z"
}
]______________________________________________________________
Respuesta correcta
204: Los permisos especificados se eliminaron correctamente
Respuesta de error
300: No se pudo devolver la representación solicitada 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ó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor