Feeds/Puntos finales de texto (2022/06)
Use estos endpoints para administrar Live Text Feeds en la red.
URL base para estos endpoints: https://api.bsn.cloud/2022/06/REST/Feeds/Text
_________________________________________________________________________
GET /
Devuelve una lista de Live Text Feeds en una red
Token de alcance requerido
bsn.api.main.feeds.text.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) (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 Text Feeds excede el valor de pageSize. Este parámetro solo es requerido si necesita más elementos en la lista paginada que el valor de pageSize (100).
- pageSize int opcional: El número máximo de Text Feeds que pueden incluirse en el cuerpo de respuesta. El valor predeterminado 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 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 [CreationDate] NO ESTÁ EN EL RANGO '2000-01-01' Y '2022-01-01'
- ordenar se establece en [FileSize] ASC
GET /2022/06/REST/Feeds/Text/?marker=ODUzLDcyMjE4MTI%3D&pageSize=1&filter=%5BCreationDate%5D%20IS%20NOT%20IN%20THE%20RANGE%20%272000-01-01%27%20AND%20%272022-01-01%27&sort=%5BFileSize%5D%20ASC 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 Text FeedEntidad de Live Text Feed en una red. Esto no devolverá más de 100 entidades junto con la información necesaria para devolver cualquier otra página restante.
Ejemplo
{
"items": [
{
"id": 1234567,
"name": "Menu Items",
"physicalPath": "https://bsncloud.s3.amazonaws.com/ContentCloud/Feeds/3ddd24eaf9b2307852636dc45269f242",
"fileSize": 1086,
"fileHash": "SHA1:A578287BFBBD89C1663100042GF2C057C273F43F",
"creationDate": "2023-03-09T16:30:26.383Z",
"lastModifiedDate": "2023-03-09T16:50:24.883Z",
"items": null,
"presentations": [
{
"id": 12345,
"name": "All Set Presentation",
"type": "Presentation",
"link": null
}
],
"permissions": []
}
],
"totalItemCount": 2,
"matchingItemCount": 2,
"pageSize": 1,
"nextMarker": "MTA4Niw3MjMwOTY3",
"prevMarker": "MTA4Niw3MjMwn1rT",
"isTruncated": false,
"sortExpression": "[FileSize] ASC",
"filterExpression": "[CreationDate] IS NOT IN THE RANGE '2000-01-01T00:00:00.000Z' AND '2022-01-01T00:00:00.000Z'"
}Respuesta de error
300: La representación solicitada no se pudo devolver 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 usted solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
POST /
Crea un feed de texto en vivo en una red
Token de alcance requerido
bsn.api.main.feeds.text.create
______________________________________________________________
Cuerpo de la solicitud
- La Entidad de feed de texto en vivoLive Text Feed Entity
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de ejemplo de la solicitud se establecen de la siguiente manera:
POST /2022/06/REST/Feeds/Text/ 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: 389Este es el cuerpo de solicitud de ejemplo:
{
"id": 0,
"name": "Breakfast Menu",
"physicalPath": null,
"fileSize": 0,
"fileHash": null,
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"items": [
{
"title": "Hamburger: $9.99",
"description": "Ground chuck, onion, Worcestershire sauce & seasonings.",
"validityStartDate": "2023-11-01T00:00:00Z",
"validityEndDate": "2023-12-01T00:00:00Z"
}
],
"presentations": null,
"permissions": []
}______________________________________________________________
Cuerpo de la respuesta exitosa
201: Devuelve la Entidad de feed de texto en vivoLive Text Feed Entity creada y referenciada por el Uri (proporcionado por el campo de encabezado Location) en la respuesta.
Ejemplo
{
"id": 2345678,
"name": "Price List",
"physicalPath": "https://bsncloud.s3.amazonaws.com/JaneDoeTesting/Feeds/d1df209dfa240a5e5e74657c76f46cf3",
"fileSize": 159,
"fileHash": "SHA1:5BE7EDB6A8FBHAA23894114C185CD8AFD9A8E279",
"creationDate": "2023-10-06T19:43:47.597Z",
"lastModifiedDate": "2023-10-06T19:43:47.597Z",
"items": [
{
"title": "Hamburger: $9.99",
"description": "Ground chuck, onion, Worcestershire sauce & seasonings.",
"validityStartDate": "2023-11-01T00:00:00Z",
"validityEndDate": "2023-12-01T00:00:00Z"
}
],
"presentations": [],
"permissions": []
}Respuesta de error
300: La representación solicitada no se pudo devolver 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ó (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 Text Feeds, especificados por un filtro, de una red. Esto permite eliminar varios Live Text Feeds a la vez.
Token de alcance requerido
bsn.api.main.feeds.text.delete
______________________________________________________________
Parámetro de cadena de consulta
- filtro string required: Una expresiónexpression 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] ES 'Lista de precios'
DELETE /2022/06/REST/Feeds/Text/?filter=%5BName%5D%20IS%20%27Price List%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 exitosa
200: Devuelve el número de feeds de texto en vivo afectados 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 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ó (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 feeds de texto en vivo 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 feeds de texto en vivo en la red.
Token de alcance requerido
bsn.api.main.feeds.text.retrieve
______________________________________________________________
Parámetro de cadena de consulta
- filtro string optional: Una expresiónexpression 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] CONTIENE 'Test'
GET /2022/06/REST/Feeds/Text/Count/?filter=%20%5BName%5D%20CONTAINS%20%27Test%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 correcta
200: El número de feeds de texto activos 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 usted solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{id}/
Devuelve los Live Text Feeds especificados
Token de alcance requerido
bsn.api.main.feeds.text.retrieve
______________________________________________________________
Segmento
- id int: Un identificador único para los Live Text Feeds
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 234567
- 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/Text/234567/ 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 Text FeedEntidad de Live Text Feed
Ejemplo
Este es un ejemplo de respuesta 200:
{
"id": 234567,
"name": "Test2",
"physicalPath": "https://bsncloud.s3.amazonaws.com/JohnDoeTesting/Feeds/f2a442416bd2c6876bf16a19f8d21457",
"fileSize": 161,
"fileHash": "SHA1:85F4B1A9F50C55631E8398EA68467B34EFF00E8C",
"creationDate": "2023-10-24T17:50:40.237Z",
"lastModifiedDate": "2024-01-03T20:33:35.093Z",
"items": [],
"presentations": [],
"permissions": []
}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 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 /{id}/
Modifica los Live Text Feeds especificados
Token de Scope requerido
bsn.api.main.feeds.text.update
______________________________________________________________
Segmento
- id int: Un identificador único para los Live Text Feeds
______________________________________________________________
Cuerpo de la solicitud
- La Entidad de Live Text FeedEntidad de Live Text Feed
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id está establecido en 12345
- 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/Text/12345/ 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: 398Este es el cuerpo de la solicitud de ejemplo:
{
"id": 0,
"name": "Breakfast Menu",
"physicalPath": null,
"fileSize": 0,
"fileHash": null,
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"items": [
{
"title": "Hamburger: $9.99",
"description": "Ground chuck, onion, Worcestershire sauce & seasonings.",
"validityStartDate": "2023-11-01T00:00:00Z",
"validityEndDate": "2023-12-01T00:00:00Z"
}
],
"presentations": null,
"permissions": []
}______________________________________________________________
Respuesta correcta
204: Los Live Text Feeds especificados se han actualizado
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
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")
412: Error de condición previa (el recurso/Live Text Feed 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ó (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{id}/
Elimina los Live Text Feeds especificados
Token de alcance requerido
bsn.api.main.feeds.text.delete
______________________________________________________________
Segmento
- id int: Un identificador único para los Live Text Feeds
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id está establecido en 12345
- El valor opcional del encabezado If-Unmodified-Since es igual al valor del encabezado Última modificación recuperado de la respuesta GET /id o GET /name.
DELETE /2022/06/REST/Feeds/Text/12345/ 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 Text 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 tienen un formato incorrecto y, por lo tanto, no son válidos, o son rechazados 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")
412: Error de 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 el Live Text Feed especificado
Token de alcance requerido
bsn.api.main.feeds.text.retrieve
______________________________________________________________
Segmento
- nombre string: El nombre del Live Text Feed
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- nombre se establece en Noticias
- 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/Text/NewsFeed/ 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 fuente de texto en vivoLive Text Feed Entity
Ejemplo
Este es un ejemplo de respuesta 200:
{
"id": 12345,
"name": "NewsFeed",
"physicalPath": "https://bsncloud.s3.amazonaws.com/JohnDoeTesting/Feeds/f8a442416bd2c6876bf16a19f8d21457",
"fileSize": 161,
"fileHash": "SHA1:85F4B1A9F50C45631E8398EA68497B34E0F00E8C",
"creationDate": "2023-10-24T17:50:40.237Z",
"lastModifiedDate": "2023-10-24T17:50:40.237Z",
"items": [],
"presentations": [],
"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ó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
PUT /{name}/
Modifica la Live Text Feed especificada
Token de ámbito requerido
bsn.api.main.feeds.text.update
______________________________________________________________
Segmento
- nombre string: El nombre de la Live Text Feed
______________________________________________________________
Cuerpo de la solicitud
- La Entidad de fuente de texto en vivoLive Text Feed Entity
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- nombre se establece en Noticias
- 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/Text/NewsFeed/ 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: 398Este es el cuerpo de solicitud de ejemplo:
{
"id": 0,
"name": "Breakfast Menu",
"physicalPath": null,
"fileSize": 0,
"fileHash": null,
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"items": [
{
"title": "Hamburger: $9.99",
"description": "Ground chuck, onion, Worcestershire sauce & seasonings.",
"validityStartDate": "2023-11-01T00:00:00Z",
"validityEndDate": "2023-12-01T00:00:00Z"
}
],
"presentations": null,
"permissions": []
}______________________________________________________________
Respuesta correcta
204: El Live Text Feed especificado ha sido actualizado
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: Falló la condición previa (la instancia del recurso/live text feed 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ó (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 Text Feed especificado
Token de alcance requerido
bsn.api.main.feeds.text.delete
______________________________________________________________
Segmento
- nombre string: El nombre del Live Text Feed
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- nombre se establece en Noticias
- 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/Text/NewsFeed/ 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: El Live Text Feed especificado ha sido eliminado
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ó (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”)
5XX: Cualquier código 500 es un error interno del servidor
GET /Operations/
Devuelve los permisos operativos otorgados a roles para operaciones de negocio específicas
Token de Scope 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/Text/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 de negocioBusiness 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, 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
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 /{id}/Permissions/
Incluye permisos de objeto para un Live Text Feed determinado
Token de Scope requerido
bsn.api.main.feeds.text.retrieve
______________________________________________________________
Segmento
- id int: Un identificador único para el Live Text Feed
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- id se establece en 4567890
GET /2022/06/REST/Feeds/Text/4567890/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 un arreglo de entidades PermisoPermission
Ejemplo
[
{
"entityId": 4567890,
"operationUID": "5ef4d2e0-3abc-4f3d-aa8f-d1bbddace601",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-27T18:48:11.05Z"
},
{
"entityId": 4567890,
"operationUID": "376563fa-72b4-471a-9d49-1f4de927dc20",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-27T18:48:11.057Z"
}
]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ó (como 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 Text Feed con el id especificado.
Token de Scope requerido
bsn.api.main.feeds.text.update
______________________________________________________________
Segmento
- id int: Un identificador único para Live Text 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 4567890
POST /2022/06/REST/Feeds/Text/4567890/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: 368Este es el cuerpo de la solicitud de ejemplo:
[
{
"entityId": 4567890,
"operationUID": "376563fa-72b4-471a-9d49-1f4de927dc20",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-27T18:48:11.057Z"
}
]______________________________________________________________
Respuesta correcta
204: Los permisos especificados se concedieron 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 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ó (como 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 Text Feed especificado
Token de alcance requerido
bsn.api.main.feeds.text.update
______________________________________________________________
Segmento
- id int: Un identificador único para Live Text 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 4567890
DELETE /2022/06/REST/Feeds/Text/4567890/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": 4567890,
"operationUID": "5ef4d2e0-3abc-4f3d-aa8f-d1bbddace601",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-27T18:48:11.05Z"
},
{
"entityId": 4567890,
"operationUID": "376563fa-72b4-471a-9d49-1f4de927dc20",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-27T18:48:11.057Z"
}
]______________________________________________________________
Respuesta correcta
204: Los permisos especificados se eliminaron correctamente
Respuesta de error
300: La representación solicitada no se pudo devolver 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ó (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 Text Feed determinado
Token de alcance requerido
bsn.api.main.feeds.text.retrieve
______________________________________________________________
Segmento
- nombre string: El nombre del Live Text Feed
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- nombre se establece en Noticias
GET /2022/06/REST/Feeds/Text/NewsFeed/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 respuesta correcta
200: Devuelve una matriz de entidades PermisoPermission
Ejemplo
[
{
"entityId": 4567890,
"operationUID": "5ef4d2e0-3abc-4f3d-aa8f-d1bbddace601",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-27T18:48:11.05Z"
},
{
"entityId": 4567890,
"operationUID": "376563fa-72b4-471a-9d49-1f4de927dc20",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-27T18:48:11.057Z"
}
]Respuesta de error
300: La representación solicitada no se pudo devolver 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
POST /{name}/Permissions/
Agrega permisos a Live Text Feed(s) con el nombre especificado.
Token de alcance requerido
bsn.api.main.feeds.text.update
______________________________________________________________
Segmento
- nombre string: El nombre del Live Text 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 Noticias
POST /2022/06/REST/Feeds/Text/NewsFeed/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: 368Este es el cuerpo de solicitud de ejemplo:
[
{
"entityId": 4567890,
"operationUID": "376563fa-72b4-471a-9d49-1f4de927dc20",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-27T18:48:11.057Z"
}
]______________________________________________________________
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 proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
415: La representación especificada de la entidad de permisos no es válida o no es compatible (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{name}/Permissions/
Elimina permisos del Live Text Feed especificado
Token de alcance requerido
bsn.api.main.feeds.text.update
______________________________________________________________
Segmento
- nombre string: El nombre del Live Text Feed
______________________________________________________________
Cuerpo de la solicitud
- Un arreglo 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 Noticias
DELETE /2022/06/REST/Feeds/Text/NewsFeed/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": 4567890,
"operationUID": "5ef4d2e0-3abc-4f3d-aa8f-d1bbddace601",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-27T18:48:11.05Z"
},
{
"entityId": 4567890,
"operationUID": "376563fa-72b4-471a-9d49-1f4de927dc20",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 10498
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-27T18:48:11.057Z"
}
]______________________________________________________________
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 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")
5XX: Cualquier código 500 es un error interno del servidor