Uso del servicio GetWhereUsed
El servicio GetWhereUsed permite ver las relaciones de una entidad en ThingWorx. Se puede determinar dónde se utiliza una entidad o sus características, como un servicio o una propiedad, en ThingWorx. Esto puede resultar útil si se deben realizar cambios en las entidades y se necesita saber qué efectos tendrán los cambios en otro lugar del modelo. Esta funcionalidad también está disponible en la vista de entidades en Composer, consulte Se hace referencia por para obtener más información.
 |
El servicio GetWhereUsed está disponible en ThingWorx 9.3 y versiones posteriores.
|
Parámetros
|
Parámetro
|
Tipo base
|
Descripción
|
|---|---|---|
|
query
|
JSON
|
Permite filtrar los resultados.
|
|
charType
|
STRING
|
Permite filtrar los resultados de todos los usos de las características de las entidades. Las entradas posibles son ALL, Property, Service/Event y LocalizationToken.
|
|
charName
|
STRING
|
Permite filtrar los resultados de todos los usos de una característica específica en una entidad.
|
Ejemplo de filtro de consulta
El uso del siguiente filtro para GetWhereUsed devuelve solo mashups con el nombre MashupA.
{"filters":
{
"type": "And",
"filters": [
{
"type": "EQ",
"fieldName": "entityName",
"value": "MashupA"
}]}}
{
"type": "And",
"filters": [
{
"type": "EQ",
"fieldName": "entityName",
"value": "MashupA"
}]}}
Resultados de GetWhereUsed para tipos de entidad
En la siguiente tabla se indican los resultados que se devuelven al utilizar los parámetros opcionales charType o charName. N/A indica que la entrada está vacía. Los objetos del sistema no forman parte de los resultados de GetWhereUsed.
|
|
Para las filas que mencionan "ALL o Service/Event", al seleccionar cualquiera de estas entradas para charType, se producirá la misma salida porque la entidad solo tiene características de Service/Event.
|
|
Tipo de entidad
|
charType
|
charName
|
Resultado
|
|---|---|---|---|
|
Todos los tipos de entidad
|
n/d
|
n/d
|
Referencia a usos de esa entidad específica.
|
|
Autenticador
|
ALL o Service/Event
|
n/d
|
Referencia a todos los usos de las características de la entidad Authenticator.
|
|
Autenticador
|
ALL o Service/Event
|
ServiceName
|
Permite hacer referencia a todos los usos de la característica con el nombre ServiceName de la entidad Authenticator.
|
|
DirectoryService
|
ALL o Service/Event
|
n/d
|
Referencia a todos los usos de las características de la entidad DirectoryService.
|
|
DirectoryService
|
ALL o Service/Event
|
ServiceName
|
Referencia a todos los usos de la característica con el nombre ServiceName en esa entidad DirectoryService.
|
|
LocalizationTable
|
n/d
|
n/d
|
Referencia a usos de la tabla de localización.
|
|
LocalizationTable
|
ALL o LocalizationToken
|
n/d
|
Referencia a los usos de todos los tokens de la tabla de localización.
|
|
LocalizationTable
|
ALL o LocalizationToken
|
TokenName
|
Referencia a todos los usos del token específico TokenName en la tabla de localización.
|
|
NotificationDefinition
|
ALL o Service/Event
|
n/d
|
Referencia a todos los usos de las características de la entidad NotificationDefinition.
|
|
NotificationDefinition
|
ALL o Service/Event
|
ServiceName
|
Referencia a todos los usos de la característica con el nombre ServiceName en esa entidad NotificationDefinition.
|
|
Proyecto
|
ALL o Service/Event
|
n/d
|
Referencia a todos los usos de las características en esa entidad Project.
|
|
Proyecto
|
ALL o Service/Event
|
ServiceName
|
Referencia a todos los usos de la característica con el nombre ServiceName en esa entidad Project.
|
|
Subsystem
|
ALL o Service/Event
|
n/d
|
Referencia a todos los usos de las características en esa entidad Subsystem.
|
|
Subsystem
|
ALL o Service/Event
|
ServiceName
|
Referencia a todos los usos de la característica con el nombre ServiceName en esa entidad Subsystem.
|
|
Cosa
|
ALL
|
n/d
|
Referencia a todos los usos de las características en esa entidad Thing.
|
|
Cosa
|
ALL
|
ServiceName
|
Referencia a todos los usos de la característica con el nombre ServiceName en esa entidad Thing.
|
|
Cosa
|
Propiedad
|
n/d
|
Referencia a todos los usos de propiedades de la entidad Thing.
|
|
Cosa
|
Service/Event
|
n/d
|
Referencia a todos los usos de servicios y eventos en esa entidad Thing.
|
|
ThingGroup
|
ALL o Service/Event
|
n/d
|
Referencia a todos los usos de las características en esa entidad ThingGroup.
|
|
ThingGroup
|
ALL o Service/Event
|
ServiceName
|
Referencia a todos los usos de la característica con el nombre ServiceName en esa entidad ThingGroup.
|
|
ThingShape
|
ALL
|
n/d
|
Referencia a todos los usos de las características en esa entidad ThingShape.
|
|
ThingShape
|
ALL
|
ServiceName
|
Referencia a todos los usos de la característica con el nombre ServiceName en esa entidad ThingShape.
|
|
ThingShape
|
Propiedad
|
n/d
|
Referencia a todos los usos de las propiedades en esa entidad ThingShape.
|
|
ThingShape
|
Service/Event
|
n/d
|
Referencia a todos los usos de servicios y eventos en esa entidad ThingShape.
|
|
ThingTemplate
|
ALL
|
n/d
|
Referencia a todos los usos de las características en esa entidad ThingTemplate.
|
|
ThingTemplate
|
ALL
|
ServiceName
|
Referencia a todos los usos de la característica con el nombre ServiceName en esa entidad ThingTemplate.
|
|
ThingTemplate
|
Propiedad
|
n/d
|
Referencia a todos los usos de las propiedades en esa entidad ThingTemplate.
|
|
ThingTemplate
|
Service/Event
|
n/d
|
Referencia a todos los usos de servicios y eventos en esa entidad ThingTemplate.
|
Los siguientes tipos de entidad no tienen características y no requieren entradas porque solo pueden devolver referencias a usos directos de sí mismos.
• ApplicationKey
• Dashboard
• DataShape
• DataTagVocabulary
• Mashup
• MediaEntity
• Menú
• ModelTagVocabulary
• Red
• Organización
• StateDefinition
• StyleDefinition
• StyleTheme
• Usuario
• Grupos de usuarios
Comportamiento del resultado
Puede parecer que haya filas duplicadas en el conjunto de resultados. En las siguientes imágenes, el servicio GetWhereUsed se ha ejecutado en ThingA dos veces: una vez sin entradas adicionales (primera imagen) y otra vez con characteristicType como All (segunda imagen). Una fila similar se subraya en rojo en ambos resultados, donde las columnas comparten información, a excepción de las columnas Tipo de característica y Nombre de característica. Aunque las filas contienen información solapada, se trata de referencias separadas. Para que ThingB utilice el nombre de propiedad de ThingA, también debe utilizar ThingA. Por lo tanto, en la primera imagen, la fila subrayada es una referencia a ThingA utilizada por ThingB. En la segunda imagen, la fila subrayada es una referencia al nombre de propiedad de ThingA que se utiliza por ThingB.
Permisos
Un usuario que no es administrador puede ejecutar el servicio GetWhereUsed, pero es posible que no pueda ver todos los resultados si no dispone de permisos para ver determinadas entidades o características. En este caso, un usuario administrador puede ver el registro de seguridad, en el que se muestran las primeras 50 entidades que el usuario no administrador no puede ver, y luego cambiar los permisos según corresponda.