Puntos finales de etiquetas (2022/06)

7 min

este endpoint le permite recuperar datos sobre etiquetas en la red los nombres de las etiquetas, así como todas las demás propiedades de entidad, no distinguen entre mayúsculas y minúsculas (pero los valores solo pueden diferir por mayúsculas y minúsculas) el servidor puede devolver propiedades de entidad y claves de etiqueta con una combinación de mayúsculas y minúsculas diferente a la especificada por el cliente en la solicitud url base para estos endpoints https //api bsn cloud/2022/06/rest/tags get /keys/ devuelve todos los nombres de etiquetas definidos en una red que coincidan con un patrón especificado token de alcance requerido bsn api main tags retrieve parámetro de cadena de consulta patrón \string\ \opcional \ introduzca un valor en este formato "{datatype} \[\[sys] ]\[{objecttype}] <{tagkey}>" si no se introduce este valor, se devolverán todas las etiquetas para todos los valores consulte las definiciones a continuación para obtener más orientación tipo de dato es uno de los tipos de datos compatibles estos tipos de datos compatibles son boolean, numeric, string, datetime, timespan, numeric array y string array, como se describe en esta página docid\ cot2dfqig9wykoya94hex (pero object no es compatible) este valor es opcional sys le permite distinguir entre una etiqueta del sistema (definida por sistema ) o una etiqueta personalizada (definida por cliente ) este valor es opcional tipodeobjeto es contenido o dispositivo tagkey puede omitirse o especificarse parcialmente con un carácter comodín como o ?, lo que le dará todas las claves de etiqueta que coincidan con esta expresión tenga en cuenta que /tag/keys/ es único en el ámbito de las entidades en el sentido de que algunos de los valores pueden omitirse o definirse parcialmente por ejemplo, \[contenido] \<m?dia> es una entrada válida ejemplo de solicitud los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera patrón se establece en \[contenido] get /2022/06/rest/tags/keys/?pattern=%5bcontent%5d 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 con cuerpo \200\ devuelve todos los nombres de etiquetas definidos en una red que coincidan con el patrón ejemplo \[ "string \[sys] \[content] \<contenttype>", "datetime \[sys] \[content] \<filelastmodifieddate>", "string \[sys] \[content] \<filename>", "number \[sys] \[content] \<filesize>", "number \[sys] \[content] \<id>", "string \[content] \<janedoe>", "string \[sys] \[content] \<physicalpath>", "string \[sys] \[content] \<thumbpath>", "datetime \[sys] \[content] \<uploaddate>", "string \[sys] \[content] \<virtualpath>" ] respuesta de error \300\ la representación solicitada no pudo devolverse porque es ambigua (hay varias representaciones solicitadas) \400\ la solicitud tiene un formato incorrecto y, por lo tanto, no es válida \401\ el token de acceso no es válido o no se especificó \403\ el token de acceso proporcionado, aunque válido, no 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 /values/ devuelve todos los valores de etiquetas definidos en una red que coincidan con un patrón especificado token de alcance requerido bsn api main tags retrieve parámetro de cadena de consulta patrón \string\ \opcional \ introduzca un valor en este formato "{datatype} \[\[sys] ]\[{objecttype}] <{tagvalues}>" si no se introduce este valor, se devolverán todas las etiquetas para todos los valores consulte las definiciones a continuación para obtener más orientación tipo de dato es uno de los tipos de datos compatibles estos tipos de datos compatibles son boolean, numeric, string, datetime, timespan, numeric array y string array, como se describe en esta página docid\ cot2dfqig9wykoya94hex (pero object no es compatible) este valor es opcional sys le permite distinguir entre una etiqueta del sistema (definida por sistema ) o una etiqueta personalizada (definida por cliente ) este valor es opcional tipodeobjeto es contenido o dispositivo valoresetiquetas puede omitirse o especificarse parcialmente con un carácter comodín como o ?, lo que le dará todos los valores de etiquetas que coincidan con esta expresión tenga en cuenta que /tag/values/ es único en el alcance de las entidades en el sentido de que algunos de los valores pueden omitirse o definirse parcialmente por ejemplo, \[contenido] \<m?dia> es una entrada válida ejemplo de solicitud los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera patrón se establece en \[sys] \[content] get /2022/06/rest/tags/values/?pattern=%5bsys%5d %5bcontent%5d 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 con cuerpo \200\ devuelve todos los valores de etiquetas definidos en una red que coincidan con el patrón ejemplo \[ "", "outside", "2024 01 01 00 00 00z", 12345 ] respuesta de error \300\ la representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas) \400\ la solicitud está mal formada y, por lo tanto, no es válida \401\ el token de acceso no es válido o no se especificó \403\ el token de acceso proporcionado, aunque válido, no proporciona acceso a este método \406\ el servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "accept") \5xx\ cualquier código 500 es un error interno del servidor