Utilisation du service GetWhereUsed
Le service GetWhereUsed vous révèle les relations d'une entité donnée dans ThingWorx. Elle vous permet de savoir où l'entité considérée ou ses caractéristiques, telles qu'un service ou une propriété, sont utilisées dans ThingWorx. Utilisez-la lorsque vous devez apporter des modifications à des entités et que vous souhaitez déterminer les effets que ces modifications auront dans votre modèle. Cette fonctionnalité est également disponible dans la vue de l'entité sur Composer. Pour plus d'informations, consultez la rubrique Référencé par.
 |
Le service GetWhereUsed est disponible dans ThingWorx 9.3 et versions ultérieures.
|
Paramètres
|
Paramètre
|
Type de base
|
Description
|
|---|---|---|
|
query
|
JSON
|
Filtre les résultats.
|
|
charType
|
STRING
|
Filtre les résultats sur toutes les utilisations des caractéristiques d'une entité. Les entrées possibles sont ALL, Property, Service/Event et LocalizationToken.
|
|
charName
|
STRING
|
Filtre les résultats sur toutes les utilisations d'une caractéristique spécifique d'une entité.
|
Exemple de filtre de requête
Avec le filtre ci-dessous pour GetWhereUsed, seules les applications composites ayant pour nom MashupA sont renvoyées.
{"filters":
{
"type": "And",
"filters": [
{
"type": "EQ",
"fieldName": "entityName",
"value": "MashupA"
}]}}
{
"type": "And",
"filters": [
{
"type": "EQ",
"fieldName": "entityName",
"value": "MashupA"
}]}}
Résultats de GetWhereUsed pour les différents types d'entité
Le tableau ci-après décrit les résultats renvoyés par le service avec les paramètres facultatifs charType et/ou charName. n/a indique une entrée vide. Les objets système ne font pas partie des résultats de GetWhereUsed.
|
|
Pour les lignes qui mentionnent "ALL ou Service/Event", la sélection de l'une de ces entrées pour charType générera la même sortie étant donné que cette entité n'a que des caractéristiques de service/événement.
|
|
Type d'entité
|
charType
|
charName
|
Résultat
|
|---|---|---|---|
|
Tous les types d'entité
|
n/a
|
n/a
|
Utilisations référencées de cette entité spécifique.
|
|
Authenticator
|
ALL ou Service/Event
|
n/a
|
Toutes les utilisations référencées des caractéristiques de cette entité d'authentificateur.
|
|
Authenticator
|
ALL ou Service/Event
|
NomService
|
Toutes les utilisations référencées de la caractéristique nommée NomService de cette entité d'authentificateur.
|
|
DirectoryService
|
ALL ou Service/Event
|
n/a
|
Toutes les utilisations référencées des caractéristiques de cette entité de service d'annuaire.
|
|
DirectoryService
|
ALL ou Service/Event
|
NomService
|
Toutes les utilisations référencées de la caractéristique nommée NomService de cette entité de service d'annuaire.
|
|
LocalizationTable
|
n/a
|
n/a
|
Utilisations référencées de la table de localisation.
|
|
LocalizationTable
|
ALL ou LocalizationToken
|
n/a
|
Utilisations référencées de tous les jetons de la table de localisation.
|
|
LocalizationTable
|
ALL ou LocalizationToken
|
NomJeton
|
Toutes les utilisations référencées du jeton spécifique NomJeton de la table de localisation.
|
|
NotificationDefinition
|
ALL ou Service/Event
|
n/a
|
Toutes les utilisations référencées des caractéristiques de cette entité de définition de notification.
|
|
NotificationDefinition
|
ALL ou Service/Event
|
NomService
|
Toutes les utilisations référencées de la caractéristique nommée NomService de cette entité de définition de notification.
|
|
Project
|
ALL ou Service/Event
|
n/a
|
Toutes les utilisations référencées des caractéristiques de cette entité de projet.
|
|
Project
|
ALL ou Service/Event
|
NomService
|
Toutes les utilisations référencées de la caractéristique nommée NomService de cette entité de projet.
|
|
Subsystem
|
ALL ou Service/Event
|
n/a
|
Toutes les utilisations référencées des caractéristiques de cette entité de sous-système.
|
|
Subsystem
|
ALL ou Service/Event
|
NomService
|
Toutes les utilisations référencées de la caractéristique nommée NomService de cette entité de sous-système.
|
|
Thing
|
ALL
|
n/a
|
Toutes les utilisations référencées des caractéristiques de cette entité d'objet.
|
|
Thing
|
ALL
|
NomService
|
Toutes les utilisations référencées de la caractéristique nommée NomService de cette entité d'objet.
|
|
Thing
|
Property
|
n/a
|
Toutes les utilisations référencées des propriétés de cette entité d'objet.
|
|
Thing
|
Service/Event
|
n/a
|
Toutes les utilisations référencées des services et événements de cette entité d'objet.
|
|
ThingGroup
|
ALL ou Service/Event
|
n/a
|
Toutes les utilisations référencées des caractéristiques de cette entité de groupe d'objets.
|
|
ThingGroup
|
ALL ou Service/Event
|
NomService
|
Toutes les utilisations référencées de la caractéristique nommée NomService de cette entité de groupe d'objets.
|
|
ThingShape
|
ALL
|
n/a
|
Toutes les utilisations référencées des caractéristiques de cette entité de forme d'objet.
|
|
ThingShape
|
ALL
|
NomService
|
Toutes les utilisations référencées de la caractéristique nommée NomService de cette entité de forme d'objet.
|
|
ThingShape
|
Property
|
n/a
|
Toutes les utilisations référencées des propriétés de cette entité de forme d'objet.
|
|
ThingShape
|
Service/Event
|
n/a
|
Toutes les utilisations référencées des services et événements de cette entité de forme d'objet.
|
|
ThingTemplate
|
ALL
|
n/a
|
Toutes les utilisations référencées des caractéristiques de cette entité de modèle d'objet.
|
|
ThingTemplate
|
ALL
|
NomService
|
Toutes les utilisations référencées de la caractéristique nommée NomService de cette entité de modèle d'objet.
|
|
ThingTemplate
|
Property
|
n/a
|
Toutes les utilisations référencées des propriétés de cette entité de modèle d'objet.
|
|
ThingTemplate
|
Service/Event
|
n/a
|
Toutes les utilisations référencées des services et événements de cette entité de modèle d'objet.
|
Les types d'entité suivants ne possèdent pas de caractéristiques et n'ont pas besoin d'entrées étant donné qu'ils ne peuvent renvoyer que des références à des utilisations directes de leur propre part.
• ApplicationKey
• Dashboard
• DataShape
• DataTagVocabulary
• Application composite
• MediaEntity
• Menu
• ModelTagVocabulary
• Réseau
• Organisation
• StateDefinition
• StyleDefinition
• StyleTheme
• User
• Groupes d'utilisateurs
Comportement des résultats
Le jeu de résultats peut sembler afficher des lignes dupliquées. Dans les captures d'écran ci-dessous, le service GetWhereUsed a été exécuté deux fois sur l'objet ThingA : une fois sans paramètres supplémentaires (première capture) et une fois avec characteristicType paramétré sur All (deuxième capture). Les deux résultats présentent une ligne similaire, soulignée en rouge dans les deux jeux, avec les mêmes informations dans les deux cas exception faite du contenu des colonnes du type de caractéristique et du nom de la caractéristique. Bien que ces lignes se recoupent, elles constituent deux références distinctes. Pour que ThingB puisse utiliser le nom de propriété de ThingA, il doit également utiliser ThingA. Dans la première capture d'écran, la ligne soulignée est ainsi une référence à ThingA dont ThingB fait usage. Dans la deuxième capture, la ligne soulignée est une référence au nom de propriété de ThingA dont ThingB fait usage.
Permissions
Un utilisateur non administrateur peut exécuter le service GetWhereUsed, mais pourra être dans l'impossibilité de visualiser tous les résultats s'il ne dispose pas des permissions voulues pour afficher certaines entités ou caractéristiques. Au besoin, un administrateur pourra consulter le Journal de sécurité pour identifier les 50 premières entités non visualisables par l'utilisateur non administrateur et modifier ses permissions en conséquence.