Grupos/Puntos de conexión etiquetados (2022/06)
Use estos endpoints para administrar grupos etiquetados en la red.
URL base para estos endpoints: https://api.bsn.cloud/2022/06/REST/Groups/Tagged
_________________________________________________________________________
GET /
Recupera una lista de grupos etiquetados en la red
Token de Scope requerido
bsn.api.main.groups.tagged.retrieve
______________________________________________________________
Parámetros de Query String
- filtro string opcional: Una expresiónexpresión para filtrar los resultados de búsqueda. El valor predeterminado es null.
- ordenar string opcional: Una expresión para ordenar los resultados de búsqueda. La expresión de ordenación especifica la entrada utilizada para ordenar y el orden de clasificación ascendente/descendente (ASC/DESC) (por ejemplo, "[Dispositivo].[Serie] ASC"). El valor predeterminado es null.
- marcador string opcional: Un valor que especifica qué página recuperar. Este valor es útil si la entrada isTruncated en el cuerpo de respuesta de la llamada GET anterior indica que el número de instancias de grupos etiquetados supera el pageSize. Este parámetro solo es requerido 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 etiquetados que pueden incluirse en el cuerpo de respuesta. Esto usa de forma predeterminada el tamaño máximo de página permitido (100).
______________________________________________________________
Cuerpo de respuesta exitosa
200: Devuelve una lista paginadalista paginada de instancias de Entidad de grupos etiquetados en una red. Esto devolverá no 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 ser devuelta 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 fue especificado
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 grupo etiquetado en una red
Token de Scope requerido
bsn.api.main.groups.tagged.create
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Cuerpo de la respuesta correcta
201: Devuelve la Entidad de grupos etiquetados creada y referenciada por el Uri (proporcionado por el campo de encabezado Location) en la respuesta.
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
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 etiquetados, especificados por un filtro, de una red. Esto permite eliminar varios grupos etiquetados a la vez.
Token de alcance requerido
bsn.api.main.groups.tagged.delete
______________________________________________________________
Parámetro de cadena de consulta
______________________________________________________________
Cuerpo de la respuesta correcta
200: Devuelve el número de grupos etiquetados 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á 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
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 grupos etiquetados 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 etiquetados en la red.
Token de alcance requerido
bsn.api.main.groups.tagged.retrieve
______________________________________________________________
Parámetro de cadena de consulta
______________________________________________________________
Cuerpo de la respuesta correcta
200: El número de grupos etiquetados se devuelve como un valor entero.
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{id}/
Devuelve el grupo etiquetado especificado
Token de alcance requerido
bsn.api.main.groups.tagged.retrieve
______________________________________________________________
Segmento
- id int: El identificador único del grupo etiquetado
______________________________________________________________
Respuesta correcta con cuerpo
200: Devuelve la Entidad de grupos etiquetados
Respuesta correcta
304: El recurso no se modificó desde el momento especificado en el encabezado “If-Modified-Since”
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
PUT /{id}/
Actualiza el grupo etiquetado especificado
Token de Scope requerido
bsn.api.main.groups.tagged.update
______________________________________________________________
Segmento
- id int: El identificador único del grupo etiquetado
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Respuesta correcta
204: El grupo etiquetado fue 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 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")
412: Error de 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
DELETE /{id}/
Elimina un grupo etiquetado especificado
Token de Scope requerido
bsn.api.main.groups.tagged.delete
______________________________________________________________
Segmento
- id int: El identificador único del grupo etiquetado
______________________________________________________________
Respuesta correcta
204: El grupo etiquetado fue 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 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
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 grupo etiquetado especificado
Token de Scope requerido
bsn.api.main.groups.tagged.retrieve
______________________________________________________________
Segmento
- nombre string: El nombre del grupo etiquetado
______________________________________________________________
Respuesta correcta con cuerpo
200: Devuelve la Entidad de grupos etiquetados
Respuesta correcta
304: El recurso no fue modificado desde el momento especificado en el encabezado “If-Modified-Since”
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
PUT /{name}/
Actualiza el grupo etiquetado especificado
Token de Scope requerido
bsn.api.main.groups.tagged.update
______________________________________________________________
Segmento
- nombre string: El nombre del grupo etiquetado
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Respuesta correcta
204: El grupo etiquetado fue 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ó (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
DELETE /{name}/
Elimina un grupo etiquetado especificado
Token de Scope requerido
bsn.api.main.groups.tagged.delete
______________________________________________________________
Segmento
- nombre string: El nombre del grupo etiquetado
______________________________________________________________
Respuesta correcta
204: El grupo etiquetado fue 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 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ó (según se especifica en el encabezado "Accept")
412: Falló la condición previa (el recurso cambió desde el momento especificado en el valor del encabezado “If-Unmodified-Since”)
5XX: Cualquier código 500 es un error interno del servidor
GET /Operations/
Devuelve permisos operativos otorgados a roles para operaciones de negocio específicas
Token de Scope requerido
bsn.api.main.groups.operations.retrieve
______________________________________________________________
Cuerpo de la respuesta correcta
200: Devuelve la Entidad de operaciones de negocioBusiness Operations Entity
Respuesta de error
300: No se pudo devolver la representación solicitada porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{id}/Permissions/
Incluye permisos de objeto para una instancia dada de grupo etiquetado.
Token de Scope requerido
bsn.api.main.groups.tagged.retrieve
______________________________________________________________
Segmento
- id int: El identificador único del grupo etiquetado
______________________________________________________________
Cuerpo de la respuesta exitosa
200: Devuelve un arreglo de entidades PermisoPermission
Respuesta de error
300: No se pudo devolver la representación solicitada porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
POST /{id}/Permissions/
Agrega permisos para un grupo etiquetado especificado
Token de Scope requerido
bsn.api.main.groups.tagged.update
______________________________________________________________
Segmento
- id int: El identificador único del grupo etiquetado
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Respuesta exitosa
204: Los permisos se agregaron correctamente a la instancia del grupo etiquetado especificado
Respuesta de error
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)
415: El servidor no puede aceptar la representación de datos que envió (según se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{id}/Permissions/
Elimina permisos para un grupo etiquetado especificado
Token de alcance requerido
bsn.api.main.groups.tagged.update
______________________________________________________________
Segmento
- id int: El identificador único para el grupo etiquetado
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Respuesta correcta
204: Los permisos especificados se eliminaron del grupo etiquetado
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 etiquetado determinada.
Token de alcance requerido
bsn.api.main.groups.tagged.retrieve
______________________________________________________________
Segmento
- nombre string: El nombre del grupo etiquetado
______________________________________________________________
Cuerpo de la respuesta correcta
200: Devuelve una matriz de entidades PermisoPermission Permission
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está malformada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque es válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
POST /{name}/Permissions/
Agrega permisos para un grupo etiquetado especificado
Token de Scope requerido
bsn.api.main.groups.tagged.update
______________________________________________________________
Segmento
- nombre string: El nombre del grupo etiquetado
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Respuesta exitosa
204: Los permisos se agregaron correctamente a la instancia del grupo etiquetado especificado
Respuesta de error
400: La solicitud o el cuerpo de la solicitud están malformados y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque es válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
415: El servidor no puede aceptar la representación de datos que envió (según se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{name}/Permissions/
Elimina permisos para un grupo etiquetado especificado
Token de Scope requerido
bsn.api.main.groups.tagged.update
______________________________________________________________
Segmento
- nombre string: El nombre del grupo etiquetado
______________________________________________________________
Cuerpo de la solicitud
______________________________________________________________
Respuesta correcta
204: Los permisos especificados se eliminaron del grupo etiquetado
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 es válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor