Puntos finales de etiquetas (2022/06)
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 (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 (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