Использование сервиса GetWhereUsed
С помощью сервиса GetWhereUsed можно просматривать взаимосвязи сущностей в ThingWorx. Можно определить, где в ThingWorx используются сущность или ее характеристики, такие как сервис или свойство. Это может быть полезно, если необходимо внести изменения в сущности и знать, к каким последствиям приведут изменения в других местах модели. Эта функциональность также доступна в представлении сущностей в Composer. Дополнительные сведения см. в разделе Ссылаются из.
 |
Сервис GetWhereUsed доступен в ThingWorx 9.3 и более поздних версий.
|
Параметры
|
Параметр
|
Базовый тип
|
Описание
|
|---|---|---|
|
query
|
JSON
|
Фильтрует результаты.
|
|
charType
|
STRING
|
Фильтрует результаты для всех использований характеристик сущности. Возможные входные данные: ALL, Property, Service/Event и LocalizationToken
|
|
charName
|
STRING
|
Фильтрует результаты для всех использований конкретной характеристики сущности.
|
Пример фильтра запроса
Использование фильтра, приведенного ниже, для GetWhereUsed возвращает только мэшапы с именем MashupA.
{"filters":
{
"type": "And",
"filters": [
{
"type": "EQ",
"fieldName": "entityName",
"value": "MashupA"
}]}}
{
"type": "And",
"filters": [
{
"type": "EQ",
"fieldName": "entityName",
"value": "MashupA"
}]}}
Результаты GetWhereUsed для типов сущностей
В следующей таблице представлены результаты, возвращаемые при использовании необязательных параметров charType и/или charName. Н/Д указывает, что входные данные пусты. Системные объекты не являются частью результатов для GetWhereUsed.
|
|
Для строк, в которых упоминаются ALL или Service/Event, выбор любого из этих входных данных для charType приведет к тому же выходному результату, потому что эта сущность имеет только характеристики Service/Event.
|
|
Тип сущности
|
charType
|
charName
|
Результат
|
|---|---|---|---|
|
Все типы сущностей
|
Н/Д
|
Н/Д
|
Ссылка на использование этой конкретной сущности.
|
|
Аутентификатор
|
ALL или Service/Event
|
Н/Д
|
Ссылка на все использования характеристик этой сущности аутентификатора.
|
|
Аутентификатор
|
ALL или Service/Event
|
ServiceName
|
Ссылка на все использования характеристики с именем ServiceName в этой сущности аутентификатора.
|
|
DirectoryService
|
ALL или Service/Event
|
Н/Д
|
Ссылка на все использования характеристик в этой сущности DirectoryService.
|
|
DirectoryService
|
ALL или Service/Event
|
ServiceName
|
Ссылка на все использования характеристики с именем ServiceName в этой сущности DirectoryService.
|
|
LocalizationTable
|
Н/Д
|
Н/Д
|
Ссылка на использование таблицы локализации.
|
|
LocalizationTable
|
ALL или LocalizationToken
|
Н/Д
|
Ссылка на использование всех лексем в таблице локализации.
|
|
LocalizationTable
|
ALL или LocalizationToken
|
TokenName
|
Ссылка на все использования конкретной лексемы TokenName в таблице локализации.
|
|
NotificationDefinition
|
ALL или Service/Event
|
Н/Д
|
Ссылка на все использования характеристик в этой сущности NotificationDefinition.
|
|
NotificationDefinition
|
ALL или Service/Event
|
ServiceName
|
Ссылка на все использования характеристики с именем ServiceName в этой сущности NotificationDefinition.
|
|
Project
|
ALL или Service/Event
|
Н/Д
|
Ссылка на все использования характеристик в этой сущности Project.
|
|
Project
|
ALL или Service/Event
|
ServiceName
|
Ссылка на все использования характеристики с именем ServiceName в этой сущности Project.
|
|
Subsystem
|
ALL или Service/Event
|
Н/Д
|
Ссылка на все использования характеристик в этой сущности Subsystem.
|
|
Subsystem
|
ALL или Service/Event
|
ServiceName
|
Ссылка на все использования характеристики с именем ServiceName в этой сущности Subsystem.
|
|
Thing
|
ALL
|
Н/Д
|
Ссылка на все использования характеристик в этой сущности Thing.
|
|
Thing
|
ALL
|
ServiceName
|
Ссылка на все использования характеристики с именем ServiceName в этой сущности Thing.
|
|
Thing
|
Property
|
Н/Д
|
Ссылка на все использования свойств в этой сущности Thing.
|
|
Thing
|
Service/Event
|
Н/Д
|
Ссылка на все использования сервисов и событий в этой сущности Thing.
|
|
ThingGroup
|
ALL или Service/Event
|
Н/Д
|
Ссылка на все использования характеристик в этой сущности ThingGroup.
|
|
ThingGroup
|
ALL или Service/Event
|
ServiceName
|
Ссылка на все использования характеристики с именем ServiceName в этой сущности ThingGroup.
|
|
ThingShape
|
ALL
|
Н/Д
|
Ссылка на все использования характеристик в этой сущности ThingShape.
|
|
ThingShape
|
ALL
|
ServiceName
|
Ссылка на все использования характеристики с именем ServiceName в этой сущности ThingShape.
|
|
ThingShape
|
Property
|
Н/Д
|
Ссылка на все использования свойств в этой сущности ThingShape.
|
|
ThingShape
|
Service/Event
|
Н/Д
|
Ссылка на все использования сервисов и событий в этой сущности ThingShape.
|
|
thingTemplate
|
ALL
|
Н/Д
|
Ссылка на все использования характеристик в этой сущности ThingTemplate.
|
|
thingTemplate
|
ALL
|
ServiceName
|
Ссылка на все использования характеристики с именем ServiceName в этой сущности ThingTemplate.
|
|
thingTemplate
|
Property
|
Н/Д
|
Ссылка на все использования свойств в этой сущности ThingTemplate.
|
|
thingTemplate
|
Service/Event
|
Н/Д
|
Ссылка на все использования сервисов и событий в этой сущности ThingTemplate.
|
Следующие типы сущностей не имеют характеристик и не нуждаются во вводе, поскольку они могут возвращать только привязки для непосредственного использования.
• ApplicationKey
• Dashboard
• DataShape
• DataTagVocabulary
• Мэшап
• MediaEntity
• Меню
• ModelTagVocabulary
• Сеть
• Организация
• StateDefinition
• StyleDefinition
• StyleTheme
• Пользователь
• Группы пользователей
Поведение результата
Может показаться, что в наборе результатов имеются дублирующиеся строки. На приведенных ниже изображениях сервис GetWhereUsed был выполнен для вещи ThingA дважды: один раз без дополнительных входных данных (первое изображение) и один раз с опцией characteristicType, имеющей значение All (второе изображение). Подобная строка подчеркивается красным в обоих результатах, где столбцы совместно используют информацию, за исключением столбцов типа характеристики и наименования характеристики. Хотя строки содержат перекрывающиеся данные, они являются отдельными ссылками. Чтобы вещь ThingB использовала наименование свойства из вещи ThingA, она должна также использовать вещь ThingA. Поэтому в первом изображении подчеркнутая строка является ссылкой на вещь ThingA, которая используется в вещи ThingB. На втором изображении подчеркнутая строка является ссылкой на имя свойства вещи ThingA, которое используется в вещи ThingB.
Разрешения
Пользователь, не являющийся администратором, может выполнять сервис GetWhereUsed, но не сможет просматривать все результаты, если у него нет разрешений на просмотр определенных сущностей или характеристик. В этом случае администратор может просмотреть журнал безопасности, в котором отображаются первые 50 сущностей, которые не могут просматриваться пользователями, не являющимися администраторами, и соответственно изменить разрешения.