Feeds/Media Endpoints (2022/06)
Use estos endpoints para administrar Live Media Feeds en la red.
URL base para estos endpoints: https://api.bsn.cloud/2022/06/REST/Feeds/Media
_________________________________________________________________________
GET /
Devuelve una lista de Live Media Feeds en una red
Token de Scope requerido
bsn.api.main.feeds.media.retrieve
______________________________________________________________
Parámetros de la cadena de consulta
- 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) (consulte esta páginaesta página para obtener más información). 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 Live Media Feeds supera el pageSize. Este parámetro solo es requerido si usted necesita más elementos en la lista paginada que el pageSize (100).
- pageSize int opcional: La cantidad máxima de Live Media Feeds que puede incluirse en el cuerpo de respuesta. De forma predeterminada, este valor es 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 el valor se establece en el valor de propiedad [PagedList].[NextMarker] de la respuesta anterior de la API de BSN.cloud.
- pageSize se establece en 1
- filtro se establece en [Name] COMIENZA CON 'Oct'
- ordenar se establece en [LastModifiedDate] DESC
GET /2022/06/REST/Feeds/Media/?marker=OAb21dyge433&pageSize=1&filter=%5BName%5D%20BEGINS%20WITH%20%27Oct%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 respuesta exitosa
200: Devuelve una lista paginadalista paginada de Entidades de Live Media FeedEntidad de Live Media Feed 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": "Oct2023_LMF_2",
"ttl": "00:01:00",
"physicalPath": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/1903005a2e7c4255f162ca068eb925b6",
"fileSize": 842,
"fileHash": "SHA1:7DED344401FA3D60E33987B0B792EDE2A4583180",
"creationDate": "2023-10-25T18:31:55.037Z",
"lastModifiedDate": "2023-10-25T18:31:55.153Z",
"content": null,
"permissions": [],
"presentations": [
{
"id": 12345,
"name": "All Set Presentation",
"type": "Presentation",
"link": null
}
]
}
],
"totalItemCount": 3,
"matchingItemCount": 3,
"pageSize": 1,
"nextMarker": "MjAyMy0xMC0yNVQxODozMTo1NS4xNTNaLDExNTAzNjQ1",
"prevMarker": "MjAyMy0xMC0yNVQxODozMTo1NS4xNTNaLDExNTAzSm01",
"isTruncated": true,
"sortExpression": "[LastModifiedDate] DESC",
"filterExpression": "[Name] BEGINS WITH 'Oct'"
}Error
300: El servidor no pudo devolver la representación solicitada porque es ambigua (hay varias 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 un Live Media Feed en una red
Token de alcance requerido
bsn.api.main.feeds.media.create
______________________________________________________________
Cuerpo de la solicitud
- La Entidad de Live Media FeedLive Media Feed Entity
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
POST /2022/06/REST/Feeds/Media/ 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: 414Este es el cuerpo de la solicitud de ejemplo:
{
"id": 0,
"name": "Main Screen Menu",
"ttl": "00:05:00",
"physicalPath": null,
"fileSize": 0,
"fileHash": null,
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"content": [
{
"contentId": 12345,
"fileName": "Saturday Breakfast Menu.jpg",
"title": "Breakfast Menu",
"description": "Saturday Breakfast Menu (November 2023)",
"disabled": false,
"displayDuration": "00:00:15",
"validityStartDate": "2023-11-11T08:00:00Z",
"validityEndDate": "2023-11-11T12:00:00Z",
"customFields": {
"meal": "Breakfast"
}
}
],
"permissions": [],
"presentations": null
}______________________________________________________________
Cuerpo de la respuesta correcta
201: Devuelve la Entidad de Live Media FeedLive Media Feed Entity creada y referenciada por el Uri (proporcionado por el campo de encabezado Location) en la respuesta.
Ejemplo
{
"id": 23456789,
"name": "Main Screen Menu",
"ttl": "00:05:00",
"physicalPath": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/45ab34cb6a1827ad826562eb4e039d16",
"fileSize": 350,
"fileHash": "SHA1:ADD4E980482E239HCE4D6F9728999EBF838AB0CE",
"creationDate": "2023-11-17T22:57:18.2028077Z",
"lastModifiedDate": "2023-11-17T22:57:18.2028077Z",
"content": [
{
"contentId": 12345,
"fileName": "Saturday Breakfast Menu.jpg",
"title": "Breakfast Menu",
"description": "Saturday Breakfast Menu (November 2023)",
"disabled": false,
"displayDuration": "00:00:15",
"validityStartDate": "2023-11-11T08:00:00Z",
"validityEndDate": "2023-11-11T12:00:00Z",
"customFields": {
"meal": "Breakfast"
}
}
],
"permissions": [],
"presentations": []
}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 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
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
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 /
Elimina Live Media Feeds, especificados por un filtro, de una red. Esto permite eliminar varios Live Media Feeds a la vez.
Token de ámbito requerido
bsn.api.main.feeds.media.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 [Name] TERMINA CON '3'
DELETE /2022/06/REST/Feeds/Media/?filter=%5BName%5D%20ENDS%20WITH%20%273%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 Live Media Feeds afectados 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 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 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 /Count/
Devuelve el número de Live Media Feeds 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 Live Media Feeds en la red.
Token de ámbito requerido
bsn.api.main.feeds.media.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 están configurados de la siguiente manera:
- filtro está configurado en [Name] CONTIENE 'Oct'
GET /2022/06/REST/Feeds/Media/Count/?filter=%20%5BName%5D%20CONTAINS%20%27Oct%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: El número de Live Media Feeds 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á 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}/
Devuelve el Live Media Feed especificado
Token de alcance requerido
bsn.api.main.feeds.media.retrieve
______________________________________________________________
Segmento
- id int: Un identificador único para el Live Media Feed
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo están configurados de la siguiente manera:
- id está configurado 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/Feeds/Media/12345678/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 3 Jan 2024 20:33:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta exitosa con cuerpo
200: Devuelve la Entidad de Live Media FeedLive Media Feed Entity
Ejemplo
Este es un ejemplo de una respuesta de nivel 200:
{
"id": 12345678,
"name": "Oct2023_LMF_2",
"ttl": "00:01:00",
"physicalPath": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/1903005a2e7c4255f162ca068eb925b6",
"fileSize": 842,
"fileHash": "SHA1:7DED344483FB4D60E33987B0B792EDE2A4583180",
"creationDate": "2023-10-25T18:31:55.037Z",
"lastModifiedDate": "2024-01-03T20:33:35.093Z",
"content": [
{
"contentId": 911345,
"fileName": "ProfilePhoto.png",
"title": "ProfilePhoto.png",
"description": "",
"disabled": false,
"displayDuration": "00:00:06",
"validityStartDate": null,
"validityEndDate": null,
"customFields": {}
}
],
"permissions": [],
"presentations": []
}Respuesta correcta
304: El recurso no fue modificado 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 fue 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ó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
PUT /{id}/
Modifica el Live Media Feed especificado
Token de Scope requerido
bsn.api.main.feeds.media.update
______________________________________________________________
Segmento
- id int: Un identificador único para el Live Media Feed
______________________________________________________________
Cuerpo de la solicitud
- La Entidad de Live Media FeedLive Media Feed Entity
______________________________________________________________
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/Feeds/Media/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, 3 Jan 2024 20:33:34 GMT
Content-Type: application/json
Content-Length: 709Este es el cuerpo de la solicitud de ejemplo:
{
"id": 12345678,
"name": "Oct2023_LMF_2",
"ttl": "00:01:00",
"physicalPath": null,
"fileSize": 0,
"fileHash": null,
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"content": [
{
"contentId": 911345,
"fileName": "ProfilePhoto.png",
"title": "ProfilePhoto.png",
"description": "",
"disabled": false,
"displayDuration": "00:00:06",
"validityStartDate": null,
"validityEndDate": null,
"customFields": {
"customField1": ""
}
}
],
"permissions": [],
"presentations": null
}______________________________________________________________
Respuesta correcta
204: El Live Media Feed especificado ha sido 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 malformados 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 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")
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 el Live Media Feed especificado
Token de Scope requerido
bsn.api.main.feeds.media.delete
______________________________________________________________
Segmento
- id int: El identificador único del Live Media Feed que se va a eliminar
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 11475023
- 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/Feeds/Media/11475023/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Unmodified-Since: Wed, 3 Jan 2024 20:33:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta exitosa
204: El Live Media Feed 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 están malformados 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 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")
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 /{name}/
Devuelve el Live Media Feed especificado
Token de ámbito requerido
bsn.api.main.feeds.media.retrieve
______________________________________________________________
Segmento
- nombre string: El nombre del Live Media Feed
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- nombre se establece en Oct2023_LMF_2
- 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/Feeds/Media/Oct2023_LMF_2/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 3 Jan 2024 20:33:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta correcta con cuerpo
200: Devuelve la Entidad de Live Media FeedLive Media Feed Entity
Ejemplo
Este es un ejemplo de una respuesta de nivel 200:
{
"id": 12345678,
"name": "Oct2023_LMF_2",
"ttl": "00:01:00",
"physicalPath": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/1903005a2e7c4255f162ca068eb925b6",
"fileSize": 842,
"fileHash": "SHA1:7DEB144483FA3D60E33987B0B792EDE2A4583180",
"creationDate": "2023-10-25T18:31:55.037Z",
"lastModifiedDate": "2024-01-03T20:33:35.093Z",
"content": [
{
"contentId": 911345,
"fileName": "ProfilePhoto.png",
"title": "ProfilePhoto.png",
"description": "",
"disabled": false,
"displayDuration": "00:00:06",
"validityStartDate": null,
"validityEndDate": null,
"customFields": {}
}
],
"permissions": [],
"presentations": []
}Respuesta correcta
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 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
PUT /{name}/
Modifica el Live Media Feed especificado
Token de ámbito requerido
bsn.api.main.feeds.media.update
______________________________________________________________
Segmento
- nombre string: El nombre del Live Media Feed
______________________________________________________________
Cuerpo de la solicitud
- La Entidad de Live Media FeedLive Media Feed Entity
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en Oct2023_LMF_2
- 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/Feeds/Media/Oct2023_LMF_2/ 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, 3 Jan 2024 20:33:34 GMT
Content-Type: application/json
Content-Length: 709Este es el cuerpo de la solicitud de ejemplo:
{
"id": 12345678,
"name": "Oct2023_LMF_2",
"ttl": "00:01:00",
"physicalPath": null,
"fileSize": 0,
"fileHash": null,
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"content": [
{
"contentId": 911345,
"fileName": "ProfilePhoto.png",
"title": "ProfilePhoto.png",
"description": "",
"disabled": false,
"displayDuration": "00:00:06",
"validityStartDate": null,
"validityEndDate": null,
"customFields": {
"customField1": ""
}
}
],
"permissions": [],
"presentations": null
}______________________________________________________________
Respuesta correcta
204: El Live Media Feed especificado se ha actualizado en la red
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 está mal formado y, por lo tanto, no es válido, o se rechaza 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 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ó (según se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{name}/
Elimina el Live Media Feed especificado
Token de alcance requerido
bsn.api.main.feeds.media.delete
______________________________________________________________
Segmento
- nombre string: El nombre del Live Media Feed que se eliminará
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en Oct2023_LMF_2
- 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/Feeds/Media/Oct2023_LMF_2/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Unmodified-Since: Wed, 3 Jan 2024 20:33:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta correcta
204: La fuente de medios en vivo especificada ha sido eliminada
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ó (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 permisos operativos concedidos a 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/Feeds/Media/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á 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 es 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 un Live Media Feed determinado
Token de Scope requerido
bsn.api.main.feeds.media.retrieve
______________________________________________________________
Segmento
- id int: Un identificador único para el Live Media Feed
______________________________________________________________
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/Feeds/Media/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 PermisoPermission
Ejemplo
[
{
"entityId": 12345678,
"operationUID": "4871f4d5-f78b-4c41-ab27-26391c40001a",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-25T22:17:24.28Z"
},
{
"entityId": 12345678,
"operationUID": "cd97ae27-1335-4516-b8d8-f09411186df9",
"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á 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 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 /{id}/Permissions/
Agrega permisos a uno o más Live Media Feed con el id especificado.
Token de Scope requerido
bsn.api.main.feeds.media.update
______________________________________________________________
Segmento
- id int: Un identificador único para el Live Media Feed
______________________________________________________________
Cuerpo de la solicitud
- Una matriz de PermisoPermission entidades
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- id se establece en 12345678
POST /2022/06/REST/Feeds/Media/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: 328Este es el cuerpo de la solicitud de ejemplo:
[
{
"entityId": 12345678,
"operationUID": "4871f4d5-f78b-4c41-ab27-26391c40001a",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-25T22:17:24.28Z"
}
]______________________________________________________________
Respuesta correcta
204: Los permisos especificados se concedieron correctamente
Respuesta de error
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 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 del Live Media Feed especificado
Token de Scope requerido
bsn.api.main.feeds.media.update
______________________________________________________________
Segmento
- id int: Un identificador único para el Live Media Feed
______________________________________________________________
Cuerpo de la solicitud
- Una matriz de PermisoPermission entidades
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- id se establece en 12345678
DELETE /2022/06/REST/Feeds/Media/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: 328Este es el cuerpo de solicitud de ejemplo:
[
{
"entityId": 12345678,
"operationUID": "4871f4d5-f78b-4c41-ab27-26391c40001a",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-25T22:17:24.28Z"
}
]______________________________________________________________
Respuesta correcta
204: Los permisos especificados se eliminaron correctamente
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, 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 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 usted 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 un Live Media Feed determinado.
Token de Scope requerido
bsn.api.main.feeds.media.retrieve
______________________________________________________________
Segmento
- nombre string: El nombre del Live Media Feed
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- nombre se establece en Oct2023_LMF
GET /2022/06/REST/Feeds/Media/Oct2023_LMF/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": "4871f4d5-f78b-4c41-ab27-26391c40001a",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-25T22:17:24.28Z"
},
{
"entityId": 12345678,
"operationUID": "cd97ae27-1335-4516-b8d8-f09411186df9",
"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 varias 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 brinda 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")
5XX: Cualquier código 500 es un error interno del servidor
POST /{name}/Permissions/
Agrega permisos a Live Media Feed(s) con el nombre especificado.
Token de ámbito requerido
bsn.api.main.feeds.media.update
______________________________________________________________
Segmento
- nombre string: El nombre del Live Media Feed
______________________________________________________________
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:
- nombre se establece en Oct2023_LMF
POST /2022/06/REST/Feeds/Media/Oct2023_LMF/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: 328Este es el cuerpo de solicitud de ejemplo:
[
{
"entityId": 12345678,
"operationUID": "4871f4d5-f78b-4c41-ab27-26391c40001a",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-25T22:17:24.28Z"
}
]______________________________________________________________
Respuesta correcta
204: Los permisos especificados se otorgaron correctamente
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 brinda 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 lo especificado en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{name}/Permissions/
Elimina permisos del Live Media Feed especificado.
Token de ámbito requerido
bsn.api.main.feeds.media.update
______________________________________________________________
Segmento
- nombre string: El nombre del Live Media Feed
______________________________________________________________
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 Oct2023_LMF
DELETE /2022/06/REST/Feeds/Media/Oct2023_LMF/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: 328Este es el cuerpo de la solicitud de ejemplo:
[
{
"entityId": 12345678,
"operationUID": "4871f4d5-f78b-4c41-ab27-26391c40001a",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-10-25T22:17:24.28Z"
}
]______________________________________________________________
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 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 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