Grupos/Puntos finales regulares (2022/06)
Use estos endpoints para administrar grupos en la red.
URL base para estos endpoints: https://api.bsn.cloud/2022/06/REST/Groups/Regular
_________________________________________________________________________
GET /
Recupera una lista de grupos en la red.
Token de alcance requerido
bsn.api.main.groups.regular.retrieve
______________________________________________________________
Parámetros de 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 la respuesta de la llamada GET anterior indica que el número de instancias de grupos excede el pageSize. Este parámetro solo es necesario si necesita más elementos en la lista paginada que el pageSize (100).
- pageSize int opcional: El número máximo de instancias de grupos que se pueden contener en el cuerpo de la 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 value is set to [PagedList].[NextMarker] property value from the previous BSN.cloud API response.
- pageSize se establece en 1
- filtro se establece en [CreationDate] ESTÁ EN EL RANGO '2020-07-01' Y '2023-08-01'
- ordenar se establece en [Nombre] ASC
GET /2022/06/REST/Groups/Regular/?marker=YXVkaW8tdGVzdCwyNjQ1Mjg%3D&pageSize=1&filter=%5BCreationDate%5D%20IS%20IN%20THE%20RANGE%20%272020-07-01%27%20AND%20%272023-08-01%27&sort=%5BName%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 la respuesta exitosa
200: Devuelve una lista paginadalista paginada de instancias de Entidad de grupos regulares en una red. Esto no devolverá más de 100 entidades junto con la información necesaria para devolver cualquier otra página restante.
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ó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
POST /
Crea un grupo en la red.
Token de alcance requerido
bsn.api.main.groups.regular.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/Groups/Regular/ 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: 1053Este es el cuerpo de la solicitud de ejemplo:
{
"id": 0,
"name": "NewGroup",
"creationDate": "0001-01-01T00:00:00.000Z",
"lastModifiedDate": "0001-01-01T00:00:00.000Z",
"autorun": null,
"hdX23Firmware": "",
"hdX23FirmwareId": -1,
"lsX23Firmware": "",
"lsX23FirmwareId": -1,
"hsX23Firmware": "",
"hsX23FirmwareId": -1,
"hoX23Firmware": "",
"hoX23FirmwareId": -1,
"xdX33Firmware": "",
"xdX33FirmwareId": -1,
"xtX43Firmware": "",
"xtX43FirmwareId": -1,
"xdX34_XTX44Firmware": "",
"xdX34_XTX44FirmwareId": -1,
"hdX4_HSX4_LSX4Firmware": "8.5.47",
"hdX4_HSX4_LSX4FirmwareId": -1,
"4KX42Firmware": "",
"4KX42FirmwareId": -1,
"enableSerialDebugging": false,
"enableSystemLogDebugging": false,
"enableStorageSpaceLimit": false,
"storageSpaceLimitUnits": "Percentage",
"publishedDataSizeLimit": 0,
"dynamicDataSizeLimit": 0,
"htmlDataSizeLimit": 0,
"htmlLocalStorageSizeLimit": 0,
"webDatabaseSizeLimit": 0,
"devicesCount": 0,
"devicesHealthStatus": null,
"devices": null,
"schedule": null,
"permissions": []
}______________________________________________________________
Cuerpo de la respuesta exitosa
201: Devuelve la Entidad de grupos regulares creada y referenciada por la Uri (proporcionada por el campo de encabezado Location) en la respuesta.
Ejemplo
{
"id": 123456,
"name": "NewGroup",
"creationDate": "2023-10-19T20:30:35.833Z",
"lastModifiedDate": "2023-10-19T20:30:35.833Z",
"autorun": null,
"hdX23Firmware": "",
"hdX23FirmwareId": -1,
"lsX23Firmware": "",
"lsX23FirmwareId": -1,
"hsX23Firmware": "",
"hsX23FirmwareId": -1,
"hoX23Firmware": "",
"hoX23FirmwareId": -1,
"xdX33Firmware": "",
"xdX33FirmwareId": -1,
"xtX43Firmware": "",
"xtX43FirmwareId": -1,
"xdX34_XTX44Firmware": "",
"xdX34_XTX44FirmwareId": -1,
"hdX4_HSX4_LSX4Firmware": "8.5.47",
"hdX4_HSX4_LSX4FirmwareId": 12345,
"auX5Firmware": "",
"auX5FirmwareId": -1,
"4KX42Firmware": "",
"4KX42FirmwareId": -1,
"xcX55Firmware": "",
"xcX55FirmwareId": -1,
"xtX45_XDX35_HDX25_LS4X5_HS1X5Firmware": "",
"xtX45_XDX35_HDX25_LS4X5_HS1X5FirmwareId": -1,
"enableSerialDebugging": false,
"enableSystemLogDebugging": false,
"enableStorageSpaceLimit": false,
"storageSpaceLimitUnits": "Percentage",
"publishedDataSizeLimit": 0,
"dynamicDataSizeLimit": 0,
"htmlDataSizeLimit": 0,
"htmlLocalStorageSizeLimit": 0,
"webDatabaseSizeLimit": 0,
"devicesCount": 0,
"devicesHealthStatus": {},
"devices": null,
"schedule": [],
"permissions": []
}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, 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
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 grupos, especificados por un filtro, de una red. Esto permite eliminar varios grupos a la vez.
Token de alcance requerido
bsn.api.main.groups.regular.delete
______________________________________________________________
Parámetro de cadena de consulta
- reassignmentGroupId int optional: El identificador de la instancia de grupo a la que deben reasignarse los dispositivos afectados. Si este valor es negativo, los dispositivos se reasignarán a la instancia de grupo predeterminada “Unassigned”. Si no existe una instancia de grupo con el Id [int] positivo especificado, el método devolverá un error descriptivo. El valor predeterminado es 0.
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- filtro se establece en [DevicesCount] ES 0
- reassignmentGroupId se establece en 12345
DELETE /2022/06/REST/Groups/Regular/?reassignmentGroupId=12345&filter=%5BDevicesCount%5D%20IS%200 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 grupos 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 están mal formados y, por lo tanto, son inválidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso es inválido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
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 /Count/
Devuelve el número de grupos 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 grupos en la red.
Token de Scope requerido
bsn.api.main.groups.regular.retrieve
______________________________________________________________
Parámetro de Query String
- 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 establecen de la siguiente manera:
- filtro se establece en [Name] CONTIENE 'test'
GET /2022/06/REST/Groups/Regular/Count/?filter=%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 exitosa
200: El número de grupos 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, 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 usted solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{id}/
Devuelve un grupo especificado
Token de Scope requerido
bsn.api.main.groups.regular.retrieve
______________________________________________________________
Segmento
- identificación int: El identificador único del grupo
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- identificación se establece en 12345
- El valor de encabezado opcional If-Modified-Since es igual al valor de encabezado Última modificación recuperado de la respuesta anterior de GET /id o GET /name
GET /2022/06/REST/Groups/Regular/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-Modified-Since: Wed, 20 Dec 2023 21:32:34 GMT______________________________________________________________
Respuesta correcta con cuerpo
200: Devuelve la Entidad de grupos regulares
Ejemplo
Este es un ejemplo de una respuesta de nivel 200:
{
"id": 12345,
"name": "ConferenceRoom",
"creationDate": "2023-12-11T22:24:51.347Z",
"lastModifiedDate": "2023-12-20T21:32:35.093Z",
"autorun": null,
"hdX23Firmware": "",
"hdX23FirmwareId": -1,
"lsX23Firmware": "",
"lsX23FirmwareId": -1,
"hsX23Firmware": "",
"hsX23FirmwareId": -1,
"hoX23Firmware": "",
"hoX23FirmwareId": -1,
"xdX33Firmware": "",
"xdX33FirmwareId": -1,
"xtX43Firmware": "",
"xtX43FirmwareId": -1,
"xdX34_XTX44Firmware": "",
"xdX34_XTX44FirmwareId": -1,
"hdX4_HSX4_LSX4Firmware": "",
"hdX4_HSX4_LSX4FirmwareId": -1,
"auX5Firmware": "",
"auX5FirmwareId": -1,
"4KX42Firmware": "",
"4KX42FirmwareId": -1,
"xcX55Firmware": "",
"xcX55FirmwareId": -1,
"xtX45_XDX35_HDX25_LS4X5_HS1X5Firmware": "",
"xtX45_XDX35_HDX25_LS4X5_HS1X5FirmwareId": -1,
"enableSerialDebugging": true,
"enableSystemLogDebugging": false,
"enableStorageSpaceLimit": false,
"storageSpaceLimitUnits": "Percentage",
"publishedDataSizeLimit": 0,
"dynamicDataSizeLimit": 0,
"htmlDataSizeLimit": 0,
"htmlLocalStorageSizeLimit": 0,
"webDatabaseSizeLimit": 0,
"devicesCount": 2,
"devicesHealthStatus": {
"normal": 1,
"error": 1
},
"devices": [
{
"id": 12345,
"serial": "XXXXXX000000"
},
{
"id": 67890,
"serial": "YYYYYY000000"
}
],
"schedule": [],
"permissions": []
}Respuesta correcta
304: El recurso no se modificó desde la hora especificada en el encabezado If-Modified-Since
Respuesta de error
300: No se pudo devolver la representación solicitada 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}/
Actualiza el grupo especificado
Token de alcance requerido
bsn.api.main.groups.regular.update
______________________________________________________________
Segmento
- identificación int: El identificador único del grupo
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- identificación se establece en 12345
- El valor del encabezado opcional If-Unmodified-Since es igual al valor del encabezado Última modificación recuperado de la respuesta de GET /id o GET /name.
PUT /2022/06/REST/Groups/Regular/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, 20 Dec 2023 21:32:34 GMT
Content-Type: application/json
Content-Length: 1785Este es el cuerpo de la solicitud de ejemplo:
{
"id": 0,
"name": "Default",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"autorun": null,
"hdX23Firmware": "",
"hdX23FirmwareId": -1,
"lsX23Firmware": "",
"lsX23FirmwareId": -1,
"hsX23Firmware": "",
"hsX23FirmwareId": -1,
"hoX23Firmware": "",
"hoX23FirmwareId": -1,
"xdX33Firmware": "",
"xdX33FirmwareId": -1,
"xtX43Firmware": "",
"xtX43FirmwareId": -1,
"xdX34_XTX44Firmware": "",
"xdX34_XTX44FirmwareId": -1,
"hdX4_HSX4_LSX4Firmware": "8.5.47",
"hdX4_HSX4_LSX4FirmwareId": -1,
"auX5Firmware": "",
"auX5FirmwareId": -1,
"4KX42Firmware": "",
"4KX42FirmwareId": -1,
"xcX55Firmware": "",
"xcX55FirmwareId": -1,
"xtX45_XDX35_HDX25_LS4X5_HS1X5Firmware": "",
"xtX45_XDX35_HDX25_LS4X5_HS1X5FirmwareId": -1,
"enableSerialDebugging": false,
"enableSystemLogDebugging": true,
"enableStorageSpaceLimit": false,
"storageSpaceLimitUnits": "Percentage",
"publishedDataSizeLimit": 0,
"dynamicDataSizeLimit": 0,
"htmlDataSizeLimit": 0,
"htmlLocalStorageSizeLimit": 0,
"webDatabaseSizeLimit": 0,
"devicesCount": 0,
"devicesHealthStatus": null,
"devices": null,
"schedule": null,
"permissions": []
}______________________________________________________________
Respuesta correcta
204: El grupo especificado se ha actualizado
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 empresariales
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
412: Falló la condición previa (el recurso/grupo 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
PATCH /{id}/
Aplica una secuencia de cambios a una entidad de grupo específica especificada por id. Consulte RFC 6902.
Token de alcance requerido
bsn.api.main.groups.regular.update
______________________________________________________________
Segmento
- identificación int: El identificador de la entidad de grupo, que es un recurso Uri
______________________________________________________________
Cuerpo de la solicitud
Estas propiedades son entradas en un array. Cada entrada debe tener estas tres propiedades:
- op string: El tipo de operación; en este caso siempre es "replace"
- ruta string: Una ruta Uri que hace referencia a la ubicación dentro del documento de destino donde se realizará la actualización
- valor object: Los valores de reemplazo para los parámetros que deben actualizarse. Esto puede ser un array.
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de ejemplo de la solicitud se establecen de la siguiente manera:
- identificación es 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.
PATCH /2022/06/REST/Groups/Regular/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, 20 Dec 2023 21:32:34 GMT
Content-Type: application/json-patch+json
Content-Length: 91Este es el cuerpo de solicitud de ejemplo:
[
{
"op": "replace",
"path": "/xdX34_XTX44Firmware/",
"value": "8.5.33"
}
]______________________________________________________________
Respuesta satisfactoria
204: Los parámetros se reemplazaron 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)
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ó (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{id}/
Elimina el grupo especificado
Token de alcance requerido
bsn.api.main.groups.regular.delete
______________________________________________________________
Segmento
- identificación int: El identificador único del grupo
______________________________________________________________
Parámetro de cadena de consulta
- reassignmentGroupId int opcional: El identificador de la instancia de grupo a la que se deben reasignar los dispositivos afectados. Si este valor es negativo, los dispositivos se reasignarán a la instancia de grupo predeterminada “Unassigned”. Si no existe una instancia de grupo con el Id [int] positivo especificado, el método devolverá un error descriptivo. El valor predeterminado es 0.
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- identificación se establece en 12345
- reassignmentGroupId se establece en 90
- 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/Groups/Regular/12345/?reassignmentGroupId=90 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______________________________________________________________
Respuesta correcta
204: El grupo especificado se ha eliminado de 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 tiene un formato incorrecto y, por lo tanto, no es válido, o se rechaza de acuerdo con las reglas empresariales
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (según se especifica en el encabezado "Accept")
412: Error de condición previa (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 /{name}/
Devuelve un grupo especificado
Token de alcance requerido
bsn.api.main.groups.regular.retrieve
______________________________________________________________
Segmento
- nombre string: El nombre del grupo
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- nombre está establecido en SalaDeConferencias
- 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/Groups/Regular/ConferenceRoom/ 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-Modified-Since: Wed, 20 Dec 2023 21:32:34 GMT______________________________________________________________
Respuesta correcta con cuerpo
200: Devuelve la Entidad de grupos regulares
Ejemplo
Este es un ejemplo de una respuesta de nivel 200:
{
"id": 456789,
"name": "ConferenceRoom",
"creationDate": "2023-12-11T22:24:51.347Z",
"lastModifiedDate": "2023-12-20T21:32:35.093Z",
"autorun": null,
"hdX23Firmware": "",
"hdX23FirmwareId": -1,
"lsX23Firmware": "",
"lsX23FirmwareId": -1,
"hsX23Firmware": "",
"hsX23FirmwareId": -1,
"hoX23Firmware": "",
"hoX23FirmwareId": -1,
"xdX33Firmware": "",
"xdX33FirmwareId": -1,
"xtX43Firmware": "",
"xtX43FirmwareId": -1,
"xdX34_XTX44Firmware": "",
"xdX34_XTX44FirmwareId": -1,
"hdX4_HSX4_LSX4Firmware": "",
"hdX4_HSX4_LSX4FirmwareId": -1,
"auX5Firmware": "",
"auX5FirmwareId": -1,
"4KX42Firmware": "",
"4KX42FirmwareId": -1,
"xcX55Firmware": "",
"xcX55FirmwareId": -1,
"xtX45_XDX35_HDX25_LS4X5_HS1X5Firmware": "",
"xtX45_XDX35_HDX25_LS4X5_HS1X5FirmwareId": -1,
"enableSerialDebugging": true,
"enableSystemLogDebugging": false,
"enableStorageSpaceLimit": false,
"storageSpaceLimitUnits": "Percentage",
"publishedDataSizeLimit": 0,
"dynamicDataSizeLimit": 0,
"htmlDataSizeLimit": 0,
"htmlLocalStorageSizeLimit": 0,
"webDatabaseSizeLimit": 0,
"devicesCount": 2,
"devicesHealthStatus": {
"normal": 1,
"error": 1
},
"devices": [
{
"id": 12345,
"serial": "XXXXXX000000"
},
{
"id": 67890,
"serial": "YYYYYY000000"
}
],
"schedule": [],
"permissions": []
}Respuesta correcta
304: El recurso no se modificó desde la hora especificada en el encabezado “If-Modified-Since”
Respuesta de error
300: No se 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
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}/
Actualiza un grupo especificado
Token de alcance requerido
bsn.api.main.groups.regular.update
______________________________________________________________
Segmento
- nombre string: El nombre del grupo
______________________________________________________________
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 Predeterminado
- El valor del encabezado opcional If-Unmodified-Since es igual al valor del encabezado Última modificación recuperado de la respuesta GET /id o GET /name.
PUT /2022/06/REST/Groups/Regular/Default/ 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: Content-Type: application/json-patch+json
Content-Length: 1785Este es el cuerpo de la solicitud de ejemplo:
{
"id": 0,
"name": "Default",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"autorun": null,
"hdX23Firmware": "",
"hdX23FirmwareId": -1,
"lsX23Firmware": "",
"lsX23FirmwareId": -1,
"hsX23Firmware": "",
"hsX23FirmwareId": -1,
"hoX23Firmware": "",
"hoX23FirmwareId": -1,
"xdX33Firmware": "",
"xdX33FirmwareId": -1,
"xtX43Firmware": "",
"xtX43FirmwareId": -1,
"xdX34_XTX44Firmware": "",
"xdX34_XTX44FirmwareId": -1,
"hdX4_HSX4_LSX4Firmware": "8.5.47",
"hdX4_HSX4_LSX4FirmwareId": -1,
"auX5Firmware": "",
"auX5FirmwareId": -1,
"4KX42Firmware": "",
"4KX42FirmwareId": -1,
"xcX55Firmware": "",
"xcX55FirmwareId": -1,
"xtX45_XDX35_HDX25_LS4X5_HS1X5Firmware": "",
"xtX45_XDX35_HDX25_LS4X5_HS1X5FirmwareId": -1,
"enableSerialDebugging": false,
"enableSystemLogDebugging": true,
"enableStorageSpaceLimit": false,
"storageSpaceLimitUnits": "Percentage",
"publishedDataSizeLimit": 0,
"dynamicDataSizeLimit": 0,
"htmlDataSizeLimit": 0,
"htmlLocalStorageSizeLimit": 0,
"webDatabaseSizeLimit": 0,
"devicesCount": 0,
"devicesHealthStatus": null,
"devices": null,
"schedule": null,
"permissions": []
}______________________________________________________________
Respuesta correcta
204: El grupo 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 están mal formados y, por lo tanto, son inválidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso es inválido o no se 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 usted solicitó (según se especifica en el encabezado "Accept")
412: Falló la condición previa (el recurso/grupo 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
PATCH /{name}/
Aplica una secuencia de cambios a una entidad de grupo específica especificada por nombre. Consulte RFC 6902.
Token de alcance requerido
bsn.api.main.groups.regular.update
______________________________________________________________
Segmento
- nombre string: El nombre de la entidad de grupo, que es un recurso Uri
______________________________________________________________
Cuerpo de la solicitud
Estas propiedades son entradas en una matriz. Cada entrada debe tener estas tres propiedades:
- op string: El tipo de operación; en este caso siempre es "replace"
- ruta string: Una ruta Uri que hace referencia a la ubicación dentro del documento de destino donde se realizará la actualización
- valor object: Los valores de reemplazo para los parámetros que deben actualizarse. Esto puede ser una matriz.
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- nombre es Predeterminado
- 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.
PATCH /2022/06/REST/Groups/Regular/Default/ 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-patch+json
Content-Length: 91Este es el cuerpo de la solicitud de ejemplo:
[
{
"op": "replace",
"path": "/xdX34_XTX44Firmware/",
"value": "8.5.33"
}
]______________________________________________________________
Respuesta correcta
204: Los parámetros se han reemplazado correctamente.
Respuesta de error
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 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)
412: Falló la precondición (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ó (según se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{name}/
Elimina un grupo especificado
Token de alcance requerido
bsn.api.main.groups.regular.delete
______________________________________________________________
Segmento
- nombre string: El nombre del grupo
______________________________________________________________
Parámetro de cadena de consulta
- reassignmentGroupId int opcional: El identificador de la instancia de grupo a la que se deben reasignar los dispositivos afectados. Si este valor es negativo, los dispositivos se reasignarán a la instancia de grupo predeterminada “Unassigned”. Si no existe una instancia de grupo con el Id positivo [int] especificado, el método devolverá un error descriptivo. El valor predeterminado es 0.
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- identificación está establecido en Predeterminado
- reassignmentGroupId está establecido en 90
- 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/Groups/Regular/Default/?reassignmentGroupId=90 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______________________________________________________________
Respuesta correcta
204: El grupo especificado se ha eliminado de la red
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque 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")
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 /{Id}/Schedule/
Devuelve una lista de Entidad de presentación programada en el grupo especificado
Token de alcance requerido
bsn.api.main.groups.regular.retrieve
______________________________________________________________
Segmento
- groupId int: El identificador único del grupo
______________________________________________________________
Parámetro de cadena de consulta
- marcador string optional: Un valor que especifica qué página recuperar. Este valor es útil si la entrada isTruncated en el cuerpo de la respuesta de la llamada GET anterior indica que el número de instancias de grupo excede el valor de pageSize.
- pageSize int optional: La cantidad máxima de instancias de grupo que pueden incluirse en el cuerpo de la respuesta.
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- groupId se establece en 12345
- pageSize se establece en 1
- marcador se establece en el valor de la propiedad [PagedList].[NextMarker] de la respuesta anterior de la API de BSN.cloud.
GET /2022/06/REST/Groups/Regular/12345/Schedule/?marker=Zy023g2B8&pageSize=1 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 de las presentaciones programadas del grupo especificado
Ejemplo
{
"items": [ {
"id": 2345678,
"presentationId": 123456,
"presentationName": "October2023Prez",
"isRecurrent": false,
"eventDate": "2023-11-03T00:00:00",
"startTime": "00:00:00",
"duration": "23:59:00",
"recurrenceStartDate": null,
"recurrenceEndDate": null,
"daysOfWeek": "None",
"creationDate": "2023-11-03T21:04:32.81Z",
"lastModifiedDate": "2023-11-03T21:04:32.81Z",
"expirationDate": "2023-11-04T11:59:00Z",
"interruptScheduling": false
}],
"totalItemCount": 3,
"matchingItemCount": 3,
"pageSize": 1,
"nextMarker": "GWpbWFcsw15NjI5MjN0",
"prevMarker": "GWpbWFcsw15NjI5hu8u",
"isTruncated": true,
"sortExpression": "[ScheduledPresentation].[ExpireDate] DESC",
"filterExpression": null
}Respuesta de error
300: No se pudo devolver la representación solicitada 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}/Schedule/
Agrega una presentación programada al grupo especificado
Token de alcance requerido
bsn.api.main.groups.regular.update
______________________________________________________________
Segmento
- groupId int: El identificador único del grupo
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de ejemplo de la solicitud se establecen de la siguiente manera:
- groupId se establece en 12345
POST /2022/06/REST/Groups/Regular/12345/Schedule/ 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: 419Este es el cuerpo de solicitud de ejemplo:
{
"id": 0,
"presentationId": 23456,
"presentationName": "October2023Prez",
"isRecurrent": false,
"eventDate": "2023-11-04T00:00:00",
"startTime": "00:00:00",
"duration": "23:59:00",
"recurrenceStartDate": null,
"recurrenceEndDate": null,
"daysOfWeek": "None",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"expirationDate": null,
"interruptScheduling": false
}______________________________________________________________
Cuerpo de respuesta correcta
201: Devuelve el nuevo recurso creado y referenciado por el Uri (proporcionado por el campo de encabezado Location) en la respuesta. La respuesta incluye la Entidad de presentación programada.
Ejemplo
{
"id": 1234567,
"presentationId": 23456,
"presentationName": "October2023Prez",
"isRecurrent": false,
"eventDate": "2023-11-04T00:00:00",
"startTime": "00:00:00",
"duration": "23:59:00",
"recurrenceStartDate": null,
"recurrenceEndDate": null,
"daysOfWeek": "None",
"creationDate": "2023-11-03T18:14:09.3506335Z",
"lastModifiedDate": "2023-11-03T18:14:09.3506335Z",
"expirationDate": "2023-11-05T11:59:00Z",
"interruptScheduling": false
}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 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")
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
GET /{name}/Schedule/
Devuelve una lista de la Entidad de presentación programada en el grupo especificado
Token de alcance requerido
bsn.api.main.groups.regular.retrieve
______________________________________________________________
Segmento
- groupName string: El nombre del grupo
______________________________________________________________
Parámetros de cadena de consulta
- marcador string opcional: Un valor que especifica qué página recuperar. Este valor es útil si la entrada isTruncated en el cuerpo de la respuesta de la llamada GET anterior indica que el número de instancias del grupo excede el pageSize.
- pageSize int opcional: El número máximo de instancias del grupo que pueden incluirse en el cuerpo de la respuesta.
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- groupName se establece en October2023Prez
- pageSize se establece en 1
- marcador se establece en el valor de la propiedad [PagedList].[NextMarker] de la respuesta anterior de la API de BSN.cloud.
GET /2022/06/REST/Groups/Regular/October2023Prez/Schedule/?marker=RGVmYXVsdMDkxNA&pageSize=1 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 lista de las presentaciones programadas del grupo especificado
Ejemplo
{
"items": [ {
"id": 2345678,
"presentationId": 123456,
"presentationName": "October2023Prez",
"isRecurrent": true,
"eventDate": null,
"startTime": "00:00:00",
"duration": "1.00:00:00",
"recurrenceStartDate": null,
"recurrenceEndDate": null,
"daysOfWeek": "EveryDay",
"creationDate": "2023-10-20T21:11:48.233Z",
"lastModifiedDate": "2023-10-20T21:11:48.233Z",
"expirationDate": null,
"interruptScheduling": false
}],
"totalItemCount": 3,
"matchingItemCount": 3,
"pageSize": 1,
"nextMarker": "GWpbWFcsw15NjI5MjN0",
"prevMarker": "GWpbWFcsw15NjI58901",
"isTruncated": true,
"sortExpression": "[ScheduledPresentation].[ExpireDate] DESC",
"filterExpression": null
}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
POST /{name}/Schedule/
Agrega una presentación programada al grupo especificado
Token de alcance requerido
bsn.api.main.groups.regular.update
______________________________________________________________
Segmento
- groupName string: El nombre del grupo
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- groupName se establece en October2023Prez
POST /2022/06/REST/Groups/Regular/October2023Prez/Schedule/ 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: 419Este es el cuerpo de la solicitud de ejemplo:
{
"id": 0,
"presentationId": 123456,
"presentationName": "October2023Prez",
"isRecurrent": false,
"eventDate": "2023-11-04T00:00:00",
"startTime": "00:00:00",
"duration": "23:59:00",
"recurrenceStartDate": null,
"recurrenceEndDate": null,
"daysOfWeek": "None",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"expirationDate": null,
"interruptScheduling": false
}______________________________________________________________
Cuerpo de la respuesta exitosa
201: Devuelve el nuevo recurso creado y referenciado por el Uri (proporcionado por el campo de encabezado Location) en la respuesta. La respuesta incluye la Entidad de presentación programada .
Ejemplo
{
"id": 2345678,
"presentationId": 23456,
"presentationName": "October2023Prez",
"isRecurrent": false,
"eventDate": "2023-11-04T00:00:00",
"startTime": "00:00:00",
"duration": "23:59:00",
"recurrenceStartDate": null,
"recurrenceEndDate": null,
"daysOfWeek": "None",
"creationDate": "2023-11-03T18:14:09.3506335Z",
"lastModifiedDate": "2023-11-03T18:14:09.3506335Z",
"expirationDate": "2023-11-05T11:59:00Z",
"interruptScheduling": false
}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")
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
GET /{id}/Schedule/{scheduledPresentationId}/
Devuelve la programación de la presentación especificada en el grupo especificado
Token de Scope requerido
bsn.api.main.groups.regular.retrieve
______________________________________________________________
Segmento
groupId int: El identificador único del grupo
scheduledPresentationId int: El identificador único de la presentación programada
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- groupId se establece en 12345
- scheduledPresentationId se establece en 234567
GET /2022/06/REST/Groups/Regular/12345/Schedule/234567/ 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 presentación programada
Ejemplo
{
"id": 234567,
"presentationId": 1234567,
"presentationName": "Default",
"isRecurrent": true,
"eventDate": null,
"startTime": "00:00:00",
"duration": "1.00:00:00",
"recurrenceStartDate": null,
"recurrenceEndDate": null,
"daysOfWeek": "EveryDay",
"creationDate": "2023-10-19T17:21:32.767Z",
"lastModifiedDate": "2023-10-19T17:21:32.767Z",
"expirationDate": null,
"interruptScheduling": false
}Respuesta de error
300: La representación solicitada no pudo devolverse 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 ofrece 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}/Schedule/{scheduledPresentationId}/
Actualiza la presentación programada especificada en el grupo especificado.
Token de ámbito requerido
bsn.api.main.groups.regular.update
______________________________________________________________
Segmento
- groupId int: El identificador único del grupo
- scheduledPresentationId int: El identificador único de la presentación programada
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- groupId se establece en 12345
- scheduledPresentationId se establece en 234567
PUT /2022/06/REST/Groups/Regular/12345/Schedule/234567/ 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: 443Este es el cuerpo de solicitud de ejemplo:
{
"id": 0,
"presentationId": 1234567,
"presentationName": "Default",
"isRecurrent": true,
"eventDate": null,
"startTime": "00:00:00",
"duration": "1.00:00:00",
"recurrenceStartDate": null,
"recurrenceEndDate": null,
"daysOfWeek": "EveryDay",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"expirationDate": null,
"interruptScheduling": false
}______________________________________________________________
Respuesta correcta
204: La presentación programada en el grupo especificado ha sido actualizada
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 es rechazado 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ó (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 /{id}/Schedule/{scheduledPresentationId}/
Elimina una presentación programada especificada del grupo especificado
Token de alcance requerido
bsn.api.main.groups.regular.update
______________________________________________________________
Segmento
- groupId int: El identificador único del grupo
- scheduledPresentationId int: El identificador único de la presentación programada
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- groupId se establece en 12345
- scheduledPresentationId se establece en 234567
DELETE /2022/06/REST/Groups/Regular/12345/Schedule/234567/ 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______________________________________________________________
Respuesta correcta
204: La presentación programada ha sido eliminada del grupo especificado
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 usted solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{name}/Schedule/{scheduledPresentationId}/
Devuelve la programación de la presentación especificada en el grupo especificado
Token de Scope requerido
bsn.api.main.groups.regular.retrieve
______________________________________________________________
Segmento
- groupName string: El nombre del grupo
- scheduledPresentationId int: El identificador único de la presentación programada
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- groupName se establece en Predeterminado
- scheduledPresentationId se establece en 234567
GET /2022/06/REST/Groups/Regular/Default/Schedule/234567/ 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 presentación programada.
Ejemplo
{
"id": 234567,
"presentationId": 987654,
"presentationName": "Default",
"isRecurrent": true,
"eventDate": null,
"startTime": "00:00:00",
"duration": "1.00:00:00",
"recurrenceStartDate": null,
"recurrenceEndDate": null,
"daysOfWeek": "EveryDay",
"creationDate": "2023-10-19T17:21:32.767Z",
"lastModifiedDate": "2023-10-19T17:21:32.767Z",
"expirationDate": null,
"interruptScheduling": false
}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}/Schedule/{scheduledPresentationId}/
Actualiza la presentación programada especificada en el grupo especificado.
Token de alcance requerido
bsn.api.main.groups.regular.update
______________________________________________________________
Segmento
- groupName string: El nombre del grupo
- scheduledPresentationId int: El identificador único de la presentación programada
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- groupName se establece en Predeterminado
- scheduledPresentationId se establece en 234567
PUT /2022/06/REST/Groups/Regular/Default/Schedule/234567/ 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: 443Este es el cuerpo de la solicitud de ejemplo:
{
"id": 0,
"presentationId": 987654,
"presentationName": "Default",
"isRecurrent": true,
"eventDate": null,
"startTime": "00:00:00",
"duration": "1.00:00:00",
"recurrenceStartDate": null,
"recurrenceEndDate": null,
"daysOfWeek": "EveryDay",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"expirationDate": null,
"interruptScheduling": false
}______________________________________________________________
Respuesta correcta
204: La presentación programada especificada se ha actualizado en el grupo especificado
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 usted solicitó (según se especifica en el encabezado "Accept")
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}/Schedule/{scheduledPresentationId}/
Elimina la presentación programada especificada del grupo especificado
Token de alcance requerido
bsn.api.main.groups.regular.update
______________________________________________________________
Segmento
- groupName string: El nombre del grupo
- scheduledPresentationId int: El identificador único de la presentación programada
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- groupName se establece en Predeterminado
- scheduledPresentationId se establece en 234567
DELETE /2022/06/REST/Groups/Regular/Default/Schedule/234567/ 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______________________________________________________________
Respuesta correcta
204: La presentación programada especificada se ha eliminado del grupo especificado
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á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 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ó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /Operations/
Devuelve los permisos operativos otorgados a roles para operaciones comerciales específicas
Token de ámbito requerido
bsn.api.main.groups.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/Groups/Regular/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 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 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ó (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 instancia de grupo determinada.
Token de alcance requerido
bsn.api.main.groups.regular.retrieve
______________________________________________________________
Segmento
- identificación int: El identificador único del grupo
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- identificación se establece en 56789
GET /2022/06/REST/Groups/Regular/56789/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": 56789,
"operationUID": "67b9b0ab-fb5f-36c4-d598-a71aa8998e4e",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 5432
},
"isFixed": true,
"isInherited": false,
"isAllowed": true,
"creationDate": "2020-06-01T17:13:32.927Z"
},
{
"entityId": 56789,
"operationUID": "d430853f-c05f-61b4-d137-0237a6984032",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-27T18:48:11.053Z"
}
]Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, 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
POST /{id}/Permissions/
Agrega permisos al grupo especificado
Token de Scope requerido
bsn.api.main.groups.regular.update
______________________________________________________________
Segmento
- identificación int: El identificador único del grupo
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- identificación se establece en 12345
POST /2022/06/REST/Groups/Regular/12345/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: 343Este es el cuerpo de la solicitud de ejemplo:
{
"entityId": 12345,
"operationUID": "67b9b0ab-fb5f-36c4-d598-a71aa8998e4e",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "0001-01-01T00:00:00"
}______________________________________________________________
Respuesta exitosa
204: Los permisos se agregaron correctamente al grupo
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ó (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 grupo especificado
Token de Scope requerido
bsn.api.main.groups.regular.update
______________________________________________________________
Segmento
- identificación int: El identificador único del grupo
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- identificación se establece en 56789
DELETE /2022/06/REST/Groups/Regular/56789/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: 604Este es el cuerpo de solicitud de ejemplo:
[
{
"entityId": 56789,
"operationUID": "d430853f-c05f-61b4-d137-0237a6984032",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-27T18:48:11.053Z"
}
]______________________________________________________________
Respuesta correcta
204: Los permisos especificados se han eliminado del grupo
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 solicitó (según 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 instancia de grupo determinada.
Token de Scope requerido
bsn.api.main.groups.regular.retrieve
______________________________________________________________
Segmento
- nombre string: El nombre del grupo
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- nombre se establece en Control de dispositivos
GET /2022/06/REST/Groups/Regular/Device Control/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": 12345,
"operationUID": "67b9b0ab-fb5f-36c4-d598-a71aa8998e4e",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 1234
},
"isFixed": true,
"isInherited": false,
"isAllowed": true,
"creationDate": "2020-06-01T17:13:32.927Z"
},
{
"entityId": 12345,
"operationUID": "d430853f-c05f-61b4-d137-0237a6984032",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-27T18:48:11.053Z"
}
]Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, es inválida
401: El token de acceso es invá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ó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
POST /{name}/Permissions/
Agrega permisos al grupo especificado
Token de Scope requerido
bsn.api.main.groups.regular.update
______________________________________________________________
Segmento
- nombre string: El nombre del grupo
______________________________________________________________
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 Control de dispositivos
POST /2022/06/REST/Groups/Regular/Device Control/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: 343Este es el cuerpo de solicitud de ejemplo:
{
"entityId": 56789,
"operationUID": "67b9b0ab-fb5f-36c4-d598-a71aa8998e4e",
"principal": {
"login": "[email protected]",
"type": "User",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "0001-01-01T00:00:00"
}______________________________________________________________
Respuesta exitosa
204: Los permisos se agregaron correctamente al grupo
Respuesta de error
400: La solicitud o el cuerpo de la solicitud está mal formado y, por lo tanto, es inválido, o es rechazado de acuerdo con las reglas de negocio
401: El token de acceso es invá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)
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 los permisos del grupo especificado
Token de alcance requerido
bsn.api.main.groups.regular.update
______________________________________________________________
Segmento
- nombre string: El nombre del grupo
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- nombre se establece en Control de dispositivos
DELETE /2022/06/REST/Groups/Regular/Device Control/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: 604Este es el cuerpo de la solicitud de ejemplo:
[
{
"entityId": 12345,
"operationUID": "d430853f-c05f-61b4-d137-0237a6984032",
"principal": {
"name": "Custom",
"isCustom": true,
"type": "Role",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-10-27T18:48:11.053Z"
}
]______________________________________________________________
Respuesta correcta
204: Los permisos especificados se han eliminado del grupo
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 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ó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor