Grupos/Puntos de conexión etiquetados (2022/06)

22 min

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ón docid\ cot2dfqig9wykoya94hex 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 paginada docid 1gsmbtulb07tf6mcfqcxp de instancias de entidad de grupos etiquetados docid\ fay8gl0lx9mfz3fliop1y 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 la entidad de grupos etiquetados docid\ fay8gl0lx9mfz3fliop1y cuerpo de la respuesta correcta \201\ devuelve la entidad de grupos etiquetados docid\ fay8gl0lx9mfz3fliop1y 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 filtro \string\ \required \ una expresión docid\ cot2dfqig9wykoya94hex para filtrar resultados de búsqueda 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 filtro \string\ \opcional \ una expresión docid\ cot2dfqig9wykoya94hex para filtrar los resultados de búsqueda 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 docid\ fay8gl0lx9mfz3fliop1y 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 la entidad de grupos etiquetados docid\ fay8gl0lx9mfz3fliop1y 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 docid\ fay8gl0lx9mfz3fliop1y 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 la entidad de grupos etiquetados docid\ fay8gl0lx9mfz3fliop1y 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 negocio docid\ bb tauffplmvkrodv93i7 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 permiso docid\ hc70cptqcofqdzw2spaek 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 un arreglo de entidades permiso docid\ hc70cptqcofqdzw2spaek 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 una matriz de entidades permiso docid\ hc70cptqcofqdzw2spaek 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 permiso docid\ hc70cptqcofqdzw2spaek 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 una matriz de entidades permiso docid\ hc70cptqcofqdzw2spaek permission 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 una matriz de entidades de permiso docid\ hc70cptqcofqdzw2spaek permisos 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