ArcGIS Knowledge Studio можно интегрировать с другими приложениями, используя ссылки на Knowledge Studio. Например, вы можете создавать ссылки на приложения для запуска и открытия Knowledge Studio, а также для создания или обновления определенных ресурсов из другого приложения Esri, всплывающего окна веб-карты или обычной гиперссылки в электронном письме или на веб-сайте.
Параметр URL - это пара имя-значение. В каждом параметре имя и значение разделены знаком равенства (=).
Примечание:
В этом разделе значения, относящиеся непосредственно к URL-запросу, заключены в угловые скобки (<>). Например, в этом URL-адресе https://<YourPortal>/apps/knowledge-studio/main? значение <YourPortal> следует заменить на адрес вашего портала.
Общий доступ к ресурсам проекта Knowledge Studio
Вы можете опубликовать URL-адрес конкретного элемента ресурсов, сохраненного запроса или отношения в проекте Knowledge Studio. У каждой карты, диаграммы связей, карточки данных, сохраненного запроса, вида операционной панели и выбранной записи в виде графа знаний есть уникальный URL-адрес, по которому можно перейти к конкретному элементу ресурсов, элементу или отношению в проекте.
Для предоставления общего доступа к картам, диаграммам связей, сохраненным запросам и карточкам данных необходимо предварительно сохранить проект. Вы можете опубликовать URL-адрес конкретного элемента или отношения в любом проекте.
Базовый URL-адрес
Проект Knowledge Studio автоматически создает URL-адреса, которые можно использовать для предоставления общего доступа к определенному ресурсу, элементу или отношению в виде Графа знаний или к сохраненному запросу. Вы также можете использовать эти компоненты URL-адреса для создания URL-адресов с помощью Параметров URL-адреса для создания ресурсов, чтобы создавать новые ресурсы, добавлять элементы и отношения к существующим ресурсам или выполнять сохраненные запросы.
У URL-адресов проектов Knowledge Studio следующая структура:
Первая часть указывает на Knowledge Studio.
https://<YourPortal>/portal/apps/knowledge-studio/main?После знака вопроса (?) добавляется ID проекта Knowledge Studio. Если вы используете проект Knowledge Studio, сохраненный на портале, используется ID элемента портала. Если проект еще не сохранен, в качестве ID проекта используется ID элемента портала сервиса графа знаний, с которым вы работаете, до тех пор, пока проект не будет сохранен.
id=b1ce0d5b814c40ba8809fb3625f476dbID ресурсов
Все параметры, следующие за ID проекта, добавляются через символ амперсанд (&) и определяют, какой элемент ресурсов выбран, включая относящиеся к нему дополнительные параметры. Поскольку проект Knowledge Studio может содержать только один вид для каждого вида по умолчанию (операционная панель, запрос и граф знаний), то для этих видов используется именованный ID. Все остальные элементы ресурсов получают уникальный ID в проекте.
&selectedContentId=<contentID>| Элемент ресурса | ID ресурса |
|---|---|
Вид Графа знаний | dataExplorer |
Вид Запроса | queryViewer |
Вид Операционной панели | dashboard |
Карты и диаграммы связей | Генерируется проектом при добавлении или создании элемента ресурсов в формате cb4449dd-886c-4623-837b-7a5685a76fc7 |
Параметры, относящиеся к виду
Для вида Графа знаний и вида Запроса могут использоваться дополнительные параметры, обеспечивающие дополнительный контекст. После каждого параметра должен следовать знак равенства (=) и затем его значение.
| Элемент ресурса | Дополнительные параметры | Значения | Подробная информация |
|---|---|---|---|
Вид Графа знаний | selectedContentElement | Уникальный ID выбранного элемента или отношения. | Уникальный ID элемента или отношения в формате URL. Например, для ID вида {B1FF2B9A6-C146-4913-A364-BC81F66A025D} фигурные скобки ({}) должны быть закодированы: %7B1FF2B9A6-C146-4913-A364-BC81F66A025D%7D. |
| selectedContentInstruction | entity relationship | Указывает, относится ли ID к элементу или к отношению. | |
Вид Запроса | selectedContentElement | Уникальный ID для сохраненного запроса. | Добавляется только при выборе Сохраненного запроса в формате cb4449dd-886c-4623-837b-7a5685a76fc7. |
Пример адреса URL, ведущего к конкретному элементу в виде Графа знаний.
https://<YourPortal>/portal/apps/knowledge-studio/main?id=ddd37b4f73904c7ba073d9fed75dba6c&selectedContentId=dataExplorer&selectedContentElement=%7B29018C8F-A061-4889-B5BB-77714E4ACC3D%7D&selectedContentInstruction=entityПример адреса URL, ведущего к конкретному сохраненному запросу в виде Запроса. Предоставление общего доступа к сохраненным запросам таким способом возможно только в том случае, если проект был сохранен.
https://<YourPortal>/portal/apps/knowledge-studio/main?id=ddd37b4f73904c7ba073d9fed75dba6c&selectedContentId=queryViewer
&selectedContentElement=cb4449dd-886c-4623-837b-7a5685a76fc7Параметры URL-адреса для создания ресурсов
Вы можете указать для URL-адреса Knowledge Studio дополнительные параметры, чтобы создавать ресурсы в проекте Knowledge Studio из другого приложения Esri, всплывающего окна веб-карты или гиперссылки в письме или на сайте. С помощью параметров создания ресурсов можно выполнить следующие действия:
- Создание новых карт и диаграмм связей
- Добавление элементов и отношений к существующим картам и диаграммам связей
- Создание новых карт и диаграмм связей из шаблона
- Создание нового сохраненного запроса
- Запуск существующего сохраненного запроса с новыми параметрами
Базовый URL-адрес для использования параметров создания ресурсов:
https://<YourPortal>/portal/apps/knowledge-studio/studioApiContent?
После знака вопроса для всех операций создания ресурсов требуются следующие параметры:
| Параметр | Значение | Подробная информация |
|---|---|---|
| version | Номер версии ArcGIS Enterprise | |
| operation | createNew addToExisting executeQuery createQuery | Действие, которое вы хотите выполнить с помощью параметров URL-адреса. Можно создать новые ресурсы, добавить что-либо к существующим ресурсам или выполнить запросы. |
| id | ID элемента проекта Knowledge Studio или ID элемента сервиса Графа знаний | ID элемента портала для проекта Knowledge Studio или сервиса Графа знаний. Вы можете создавать новые ресурсы, используя элемент проекта Knowledge Studio или новый несохраненный проект, созданный из сервиса Графа знаний в виде элемента портала. Добавление к существующим ресурсам и запуск существующих запросов возможны только с проектом Knowledge Studio в качестве элемента портала. |
Для каждой операции потребуются дополнительные параметры, в зависимости от того, какое действие вы хотите выполнить.
URL-кодирование
При передаче параметра на операционную панель во время выполнения обязательно закодируйте его значение. Кодирование гарантирует, что недопустимые символы будут заменены на % со следующим после шестнадцатеричным эквивалентом. Чтобы включить несколько параметров, их необходимо разделять амперсандами (&).
Примечание:
Один из способов создания кодированных параметров — это использование ArcGIS Arcade. Функция UrlEncode позволяет вам задать набор пар «ключ/значение», отображающих каждый из параметров, и обеспечить подходящее кодирование URL.
Примечание:
Порядок параметров не имеет значения. Например, param=value¶m2=value2 и param=value¶m2=value2 выдадут одинаковый результат.
Создание новых элементов ресурсов
Вы можете создать новую карту или диаграмму связей с элементами и отношениями в проекте Knowledge Studio. Вы также можете создать новую карту или диаграмму связей, используя существующий элемент ресурсов того же типа в качестве шаблона. Новые ресурсы можно создавать как в существующем, так и в новом проекте.
Примечание:
Связанные элементы ресурсов портала нельзя использовать как шаблон для создания новых элементов ресурсов.
Чтобы создать новый элемент ресурсов в существующем проекте, укажите ID элемента проекта в параметре id. Чтобы создать карту или диаграмму связей в новом несохраненном проекте, укажите ID элемента сервиса графа знаний в параметре id. Для создания новых карт и диаграмм связей используются следующие параметры:
| Параметр | Значение | Подробная информация | |
|---|---|---|---|
| entityIds | Массив уникальных ID | Массив уникальных ID элементов, добавляемых к элементу ресурсов. | |
| relationshipIds | Массив уникальных ID | Массив уникальных ID отношений, добавляемых к элементу ресурсов. Если указаны только ID отношений, их начальные и целевые элементы будут добавлены автоматически. | |
| contentType | map linkChart | Тип элемента ресурсов, создаваемого в проекте | |
| properties | Объект linkChartProperties | Объект layoutType | Тип компоновки диаграммы связей, используемый для новой диаграммы связей. Подробнее о поддерживаемых типах компоновок см. в разделе Типы компоновок. |
Объект layoutSettings (дополнительно) | Настройки компоновки для органических или хронологических компоновок. Подробнее о настраиваемых параметрах см. в разделе Настройки компоновки. | ||
contentId (дополнительно) | ID ресурса проекта Knowledge Studio | ID элемента ресурсов, используемого в качестве шаблона. Если указан, то определение слоя элемента ресурсов будет использовано для создания нового элемента ресурсов. Элемент ресурсов, используемый как шаблон, должен быть того же типа, что и новый элемент ресурсов. | |
Пример объекта linkChartProperties, в котором указан только layoutType:
{ "linkChartProperties" : { "layoutType" : "force-directed" } }Пример объекта layoutSettings для географической компоновки. Настройки компоновки являются необязательными и поддерживаются только для органических и хронологических компоновок. Подробнее о дополнительных опциях настройки компоновки см. в разделе Настройки компоновки. Эти объекты необходимо закодировать, чтобы использовать их в качестве значения параметра URL.
{
"linkChartProperties":{
"layoutType":"geographic-organic-standard",
"layoutSettings":{
"organicLayoutSettings": {
"absoluteIdealEdgeLength": 5,
"computationBudgetTime": 2,
"autoRepulsionRadius": false,
"idealEdgeLengthType": "absolute-value"
"multiplicativeIdealEdgeLength": 1,
"repulsionRadiusMultiplier": 1
}
}
}
}Добавление к существующим элементам ресурса
Вы можете добавить элементы и отношения к существующей карте или диаграмме связей в проекте Knowledge Studio. Добавлять к существующим ресурсам можно только через элемент ресурса проекта Knowledge Studio.
| Параметр | Значение | Подробная информация |
|---|---|---|
| entityIds | Массив уникальных ID | Массив уникальных ID элементов, добавляемых к элементу ресурсов |
| relationshipIds | Массив уникальных ID | Массив уникальных ID отношений, добавляемых к элементу ресурсов. Если указаны только ID отношений, их начальные и целевые элементы будут добавлены автоматически |
| contentId | ID ресурса проекта Knowledge Studio | ID элемента ресурса Его можно найти в URL-адрес проекта Knowledge Studio, когда элемент ресурса открыт во вкладке. |
Создание новых запросов
Вы можете создавать и выполнять новые запросы в проекте Knowledge Studio. Новые ресурсы можно создать как в существующем, так и в новом проекте.
Чтобы создать новый запрос в существующем проекте, укажите ID элемента проекта в параметре id. Чтобы создать запрос в новом несохраненном проекте, укажите ID элемента сервиса графа знаний в параметре id. Для создания новых карт и диаграмм связей используются следующие параметры:
Для создания нового запроса можно использовать следующие свойства:
| Параметр | Значение | Подробная информация |
|---|---|---|
| properties | name | Имя нового сохраненного запроса, который нужно создать. |
| openCypherQuery | Запрос openCypher, который нужно выполнить. Подробнее о запросах openCypher. | |
| description (дополнительно) | Описание нового сохраненного запроса. | |
| provenanceBehavior (дополнительно) | Определяет, должны ли результаты запроса включать или исключать данные о происхождении. Если не задано, по умолчанию используется исключение. include exclude | |
| bindParameters (дополнительно) | Массив объектов для каждого параметра, используемого в запросе. Параметры являются необязательными, однако если параметр используется в запросе, необходимо указать информацию о нем в параметре bindParameter. Параметры URL-адреса для объектов перечислены в таблице ниже. Подробнее об использовании параметров в запросах |
Использование параметров в запросе не является обязательным, однако если параметр используется в запросе, необходимо указать информацию о нем в параметре URL bindParameter. bindParameter — это массив объектов для каждого параметра, используемого в запросе. Подробнее об опциях параметра привязки.
Параметры URL-адреса для объектов перечислены в таблице ниже:
| Параметр | Подробная информация | |
|---|---|---|
| title (дополнительно) | Заголовок параметра привязки | |
| parameterName | Имя параметра привязки, используемого в запросе openCypher. | |
| parameterType | Тип значения параметра привязки. Этот тип должен совпадать с типом свойства в запросе, где используется параметр. Типы перечислены ниже: esriBindParameterTypeString esriBindParameterTypeNumber esriBindParameterTypeDateTime esriBindParameterTypeDate esriBindParameterTypeTime esriBindParameterTypeTimestampOffset esriBindParameterTypeEntityId esriBindParameterTypeRelationshipId esriBindParameterTypeGeometry | |
| value | Значение параметра привязки. Это может быть одно значение типа, указанного в parameterType, или массив значений этого типа. | |
Пример структуры массива параметров привязки до кодирования:"bindParameters": [
{
"parameterName": "facilities",
"parameterType": "esriBindParameterTypeEntityId",
"value": ["2344","2342"]
}
]
};
Выполнение существующих запросов
Вы можете выполнять существующие сохраненные запросы в проекте Knowledge Studio. Если в запросе есть параметры, вы можете передать новые значения параметров через параметры URL-адреса. Выполнять существующие запросы можно только с помощью элемента ресурса проекта Knowledge Studio.
Для выполнения существующего запроса можно использовать следующие свойства:
| Параметр | Значение | Подробная информация |
|---|---|---|
| storedQueryId | ID сохраненного запроса проекта Knowledge Studio | ID сохраненного запроса. Его можно найти в URL-адрес проекта Knowledge Studio, когда сохраненный запрос выбран в виде Запроса. |
| properties | openCypherQuery | Запрос openCypher, который нужно выполнить. Подробнее о запросах openCypher. |
| description (дополнительно) | Описание нового сохраненного запроса. | |
| provenanceBehavior (дополнительно) | Определяет, должны ли результаты запроса включать или исключать данные о происхождении. Если не задано, по умолчанию используется исключение. include exclude | |
| bindParameters (дополнительно) | Массив объектов для каждого параметра, используемого в запросе. Параметры являются необязательными, однако если параметр используется в запросе, необходимо указать информацию о нем в параметре bindParameter. Параметры URL-адреса для объектов перечислены в таблице ниже. Подробнее об использовании параметров в запросах |
Использование параметров в запросе не является обязательным, однако если параметр используется в запросе, необходимо указать информацию о нем в параметре URL bindParameter. bindParameter — это массив объектов для каждого параметра, используемого в запросе. Подробнее об опциях параметра привязки.
Параметры URL-адреса для объектов перечислены в таблице ниже:
| Параметр | Подробная информация | |
|---|---|---|
| title (дополнительно) | Заголовок параметра привязки | |
| parameterName | Имя параметра привязки, используемого в запросе openCypher. | |
| parameterType | Тип значения параметра привязки. Этот тип должен совпадать с типом свойства в запросе, где используется параметр. Типы перечислены ниже: esriBindParameterTypeString esriBindParameterTypeNumber esriBindParameterTypeDateTime esriBindParameterTypeDate esriBindParameterTypeTime esriBindParameterTypeTimestampOffset esriBindParameterTypeEntityId esriBindParameterTypeRelationshipId esriBindParameterTypeGeometry | |
| value | Значение параметра привязки. Это может быть одно значение типа, указанного в parameterType, или массив значений этого типа. | |
Пример структуры массива параметров привязки до кодирования:"bindParameters": [
{
"parameterName": "facilities",
"parameterType": "esriBindParameterTypeEntityId",
"value": ["2344","2342"]
}
]
};