Mavim Intelligent Xformation (предварительная версия)
Интеграция Mavim с Microsoft Power Platform обеспечивает простое взаимодействие между возможностями управления процессами и преобразованиями Mavim с экосистемой Power Platform. Пользователи могут разрабатывать пользовательские решения, выполнять расширенные оценки процессов и получать полезные сведения о отчетах. Это позволяет пользователям автоматизировать рабочие процессы, получать аналитические сведения о процессах и синхронизировать данные между Mavim и приложениями, такими как Azure DevOps, Teams, Dataverse, Entra, ServiceNow, Jira, Workday и т. д.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Класс | Регионы |
|---|---|---|
| Copilot Studio | Премиум | Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: - Azure для государственных организаций регионы - Azure регионы Китая - Министерство обороны США (DoD) |
| Power Apps | Премиум | Все регионы Power Apps кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премиум | Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Mavim servicedesk |
| URL | https://my.mavim.com |
| Эл. почта | servicedesk@mavim.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Mavim B.V |
| Веб-сайт | https://www.mavim.com/ |
| Политика конфиденциальности | https://trustcenter.mavim.com/ |
| Категории | Управление бизнесом; Сотрудничество |
| Веб-сайт | https://www.mavim.com/ |
| Политика конфиденциальности | https://trustcenter.mavim.com/ |
| Категории | Управление бизнесом; Сотрудничество |
| Веб-сайт | https://www.mavim.com/ |
| Политика конфиденциальности | https://trustcenter.mavim.com/ |
| Категории | Управление бизнесом; Сотрудничество |
| Веб-сайт | https://www.mavim.com/ |
| Политика конфиденциальности | https://trustcenter.mavim.com/ |
| Категории | Управление бизнесом; Сотрудничество |
Соединитель Power Platform Mavim
Обзор
Соединитель Power Platform Mavim обеспечивает простую интеграцию между возможностями управления процессами и преобразованиями Mavim и экосистемой Microsoft Power Platform. Этот соединитель позволяет пользователям автоматизировать рабочие процессы, получать доступ к аналитическим данным и синхронизировать данные между Mavim и приложениями, такими как Azure DevOps, Teams, Dataverse, Entra, ServiceNow, Jira, Workday и т. д.
Необходимые условия
Перед использованием этого соединителя убедитесь, что выполнены следующие предварительные требования:
-
Лицензирование.
- Вы должны приобрести лицензию на продукт Mavim Manager по крайней мере с одной профессиональной лицензией.
- Вы должны приобрести лицензию на продукт Mavim iMprove по крайней мере с одной профессиональной лицензией.
-
Доступ к базе данных:
- У вас должен быть доступ и необходимые разрешения для базы данных Mavim.
-
Корпоративные приложения:
Соединитель использует проверку подлинности OAuth. Необходимо установить не менее двух корпоративных приложений из коллекции Microsoft:
- Mavim Cloud Enterprise Platform
- Соединитель Power Platform Mavim
Аутентификация
Этот соединитель использует OAuth 2.0 для проверки подлинности. Убедитесь, что необходимые корпоративные приложения установлены и настроены в Azure Entra.
Возможности соединителя
- Получение, добавление, обновление и удаление данных процесса и раздела
- Получение подробных сведений о процессах и разделах, связанных с процессами
- Получение и обновление документации по процессам, диаграммам и описаниям
- Управление полями: добавление, обновление и удаление полей раздела или процесса, а также управление (добавление, обновление, удаление) связей между разделами или между разделами процессов
- Доступ к отчетам, журналам аудита и системным журналам и управлению ими
- Интеграция с внешними системами, такими как Dynamics 365, Infor, SAP и SharePoint
Ключевые операции
- Управление процессами и разделами: Получение сведений о процессах и разделах, добавление новых тем, обновление существующих тем и удаление тем или данных, связанных с процессом
- Документация по процессу: Получение и обновление документов процесса, диаграмм и описаний
- Управление полями: Добавление, обновление и удаление полей раздела или процесса; добавление, обновление и удаление связей разделов или между разделами процессов
- Отчеты: Доступ к структурированным и неструктурированным отчетам для разделов процесса
- Журналы аудита: Получение журналов аудита для разделов
- External Connections: Интеграция с Dynamics 365, Infor, SAP и SharePoint
Обработка ошибок
Соединитель возвращает стандартные коды состояния HTTP, чтобы указать успешность или сбой операции. Распространенные коды ошибок:
-
400 Bad Request: недопустимые входные или параметры -
401 Unauthorized: сбой проверки подлинности или отсутствие -
403 Forbidden: недостаточно разрешений -
404 Not Found: ресурс не найден -
500 Internal Server Error: непредвиденная ошибка сервера
Поддержка
Для поддержки обратитесь в службу обслуживания Mavim:
- Отправить по электронной почте:servicedesk@mavim.com
- Сайт:https://my.mavim.com
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Описание | Обязательный |
|---|---|---|---|
| Ключ лицензии Mavim Power Connector | securestring | Ключ лицензии Mavim Power Connector | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Восстановление удаленного раздела из корзины |
Восстанавливает раздел, указанный разделом topicId из корзины в репозитории, The topicId должен быть уникальным идентификатором (например, d0c123v456) |
| Вывод списка всех значков |
Возвращает пользовательские значки и системные значки из репозитория, указанного в репозитории. |
| Вывод списка всех наборов полей |
Возвращает все наборы полей из репозитория, указанного в репозитории. |
| Значок "Получить" |
Возвращает пользовательский значок или значок системы по значку из репозитория, указанного в репозитории. |
| Обновление значений полей |
Обновляет значения нескольких полей для раздела, указанного в файле topicId в репозитории, должен быть уникальным идентификатором (например, d0c123v456) |
| Обновление описания (только обычный текст) |
Обновляет описание темы, указанной в файле topicId в репозитории, должно быть уникальным идентификатором (например, d0c123v456) |
| Обновление раздела |
Обновление ресурса раздела, определяемого параметром topicId в репозитории, определяемом репозиторием, значение TopicId должно быть уникальным идентификатором (например, d0c123v456) |
| Обновление свойства связи |
Обновляет указанное свойство отношения TopicId и relationId должны быть уникальными идентификаторами (например, d0c123v456) |
| Перемещение раздела в новую позицию |
Перемещает раздел, указанный в topicId, в позицию, определяемую movePosition в репозитории, The topicId должен быть уникальным идентификатором (например, d0c123v456) |
| Перемещение раздела в новый родительский элемент |
Перемещает раздел, указанный разделом topicId, в новый родительский раздел в репозитории. Идентификатор темы должен быть уникальным идентификатором (например, d0c123v456) |
| Перечисление диаграмм раздела |
Возвращает все диаграммы, связанные с темой, указанной параметром TopicId в репозитории, должен быть уникальным идентификатором (например, d0c123v456) |
| Перечисление категорий связей |
Возвращает разделы категории связей, определяемые системой (Who, Where, WithWhat, When, WhereTo) из репозитория, указанного репозиториемId. |
| Перечисление определений версий |
Возвращает все определения версий из репозитория, указанного в репозитории. |
| Перечисление типов дочерних разделов |
Возвращает типы дочерних разделов, определяемых разделом topicType из репозитория, указанного в репозитории. |
| Перечисление характеристик по типу связи |
Возвращает характеристики для указанного типа связи из репозитория, указанного в репозитории. |
| Получение URL-адреса подключения Dynamics 365 |
Возвращает URL-адрес подключения Dynamics 365 для раздела и подключения Как topicId, так и d365ConnectionId, должен быть уникальным идентификатором (например, d0c123v456) |
| Получение URL-адреса подключения Infor |
Возвращает URL-адрес подключения Infor для раздела и подключения Как topicId, так и inforConnectionId должен быть уникальным идентификатором (например, d0c123v456) |
| Получение всех полей (неструктурированных) для раздела |
Возвращает список полей для раздела, указанного в файле topicId в репозитории, с необязательным настраиваемым разделителем для многозначных полей topicId должен быть уникальным идентификатором (например, d0c123v456). |
| Получение данных отчета для раздела (Неструктурированный) |
Возвращает неструктурированные данные отчета для topicId и reportId Оба должны быть уникальными идентификаторами (например, d0c123v456) Поддерживает выбор страниц и языка |
| Получение дочерних элементов раздела |
Извлекает непосредственные дочерние разделы для раздела, указанного в файле topicId в репозитории, должен быть уникальным идентификатором (например, d0c123v456) |
| Получение журналов аудита |
Возвращает журналы аудита для раздела, указанного topicId в репозитории, The topicId должен быть уникальным идентификатором (например, d0c123v456) Поддерживает фильтрацию по идентификатору журнала, диапазону и языку. |
| Получение корневого раздела |
Возвращает корневой ресурс раздела для репозитория, определяемого идентификатором репозитория. |
| Получение описания (только обычный текст) |
Возвращает описание раздела, указанного в topicId в репозитории, должен быть уникальным идентификатором (например, d0c123v456) Формат может быть обычным текстом или HTML |
| Получение отчетов для раздела |
Возвращает все отчеты для раздела, указанного в topicId в репозитории, должен быть уникальным идентификатором (например, d0c123v456) |
| Получение поля раздела |
Возвращает поле, указанное fieldId в наборе полей fieldsetId для раздела и репозитория topicId, fieldsetId и fieldId, должно быть уникальными идентификаторами (например, d0c123v456) |
| Получение пути раздела к корневому каталогу |
Извлекает путь из раздела, указанного параметром topicId, к корневому разделу в репозитории The topicId должен быть уникальным идентификатором (например, d0c123v456) |
| Получение раздела |
Извлекает ресурс раздела, указанный в файле TopicId в репозитории, должен быть уникальным идентификатором (например, d0c123v456) |
| Получение разделов, отфильтрованных по коду или типу |
Извлекает разделы, определяемые определенным кодом или типом в репозитории, указанным в репозитории, кодом является код раздела, а тип относится к типу раздела. Разбиение на страницы поддерживается с помощью страницы и ограничения |
| Получение разделов с указанными идентификаторами topid |
Извлекает несколько ресурсов раздела для предоставленных идентификаторов раздела в репозитории, определяемого идентификатором репозитория Каждый идентификатор раздела, должен быть уникальным идентификатором (например, d0c123v456) |
| Получение сведений о подключении SAP |
Возвращает сведения о подключении SAP для раздела и подключения как topicId, так и sapConnectionId должны быть уникальными идентификаторами (например, d0c123v456) |
| Получение связей |
Возвращает все отношения, связанные с разделом The topicId, должен быть уникальным идентификатором (например, d0c123v456) |
| Получение содержимого диаграммы |
Возвращает содержимое диаграммы для раздела и диаграммы, указанной параметром topicId и chartId в репозитории, как topicId, так и chartId, должны быть уникальными идентификаторами (например, d0c123v456) поддерживает управление кэшем с помощью параметра исходного запроса. |
| Получение характеристик связи |
Возвращает коллекцию характеристик для отношения, указанного реляционным Идентификатором в репозитории, должен быть уникальным идентификатором (например, d0c123v456) |
| Пустая корзина |
Удаляет все разделы из корзины в репозитории, указанном в репозитории, указанном в репозитории. |
| Раздел вставки |
Вставляет раздел как одноуровневый элемент или на другом уровне относительно ссылочного раздела: TopicId должен быть уникальным идентификатором (например, d0c123v456) |
| Создание дочернего раздела |
Создает раздел непосредственно под указанным справочным разделом в иерархии The topicId должен быть уникальным идентификатором (например, d0c123v456) Текст запроса должен содержать имя раздела, тип и значок. |
| Создание раздела с братом |
Создает раздел на том же иерархическом уровне, что и указанный ссылочный раздел: TopicId должен быть уникальным идентификатором (например, d0c123v456) Текст запроса должен содержать имя раздела, тип и значок. |
| Создание связи |
Создает отношение между двумя разделами с указанным типом The topicId должен быть уникальным идентификатором (например, d0c123v456) |
| Список значков по типу раздела |
Возвращает значки для указанного объекта topicType из репозитория, указанного в репозитории. |
| Список созданных версий |
Возвращает все созданные версии из репозитория, указанного в репозитории. |
| Типы разделов списка |
Возвращает все типы разделов, доступные в репозитории, указанном в репозитории с помощью репозиторияId |
| Удаление раздела |
Удаляет раздел из указанного репозитория. Идентификатор темы должен быть уникальным идентификатором (например, d0c123v456). Операция необратима |
| Удаление связи |
Удаляет отношение между двумя разделами TopicId и relationId должны быть уникальными идентификаторами (например, d0c123v456) |
| Шаблоны описания списка |
Возвращает шаблоны описания раздела из репозитория, указанного в репозитории. |
Восстановление удаленного раздела из корзины
Восстанавливает раздел, указанный разделом topicId из корзины в репозитории, The topicId должен быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
Возвращаемое значение
RestoredTopicInfo
- Тело
- RestoredTopicInfo
Вывод списка всех значков
Возвращает пользовательские значки и системные значки из репозитория, указанного в репозитории.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Исключить
|
exclude | string |
Исключить (исключить системные или настраиваемые значки ("система" или "custom")) |
|
|
С
|
with | string |
С помощью (включите дополнительные данные, например "содержимое") |
|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- response
- array of IconInfo
Вывод списка всех наборов полей
Возвращает все наборы полей из репозитория, указанного в репозитории.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- response
- array of FieldsetInfo
Значок "Получить"
Возвращает пользовательский значок или значок системы по значку из репозитория, указанного в репозитории.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор значка
|
iconId | True | string |
Идентификатор значка (уникальный идентификатор значка) |
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- Тело
- IconInfo
Обновление значений полей
Обновляет значения нескольких полей для раздела, указанного в файле topicId в репозитории, должен быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
|
|
Идентификатор набора полей
|
fieldsetId | string |
Идентификатор набора полей (идентификатор набора полей, к которому принадлежит поле.) |
|
|
Id
|
id | string |
Идентификатор (Идентификатор, который однозначно идентифицирует поле.) |
|
|
Ценность
|
value |
Значение (значение поля, указанное типом Mavim.Processes.Api.v2.Dtos.Fields.FieldInfo.Type Примеры использования: для текстового поля укажите строку в качестве значения. Пример: "Пример значения" для поля гиперссылки укажите строку URL-адреса в качестве значения. Пример: "https://www.mavim.com" Для числа или десятичного поля укажите число в качестве значения. Пример: 1 или 1.1 Для логического поля укажите значение true или false. Пример: true для поля даты укажите дату в формате ISO 8601 в виде значения. Пример: "2025-12-01" Для поля списка выберите запись из свойства параметров поля в качестве значения. Пример: { "Идентификатор элемента" : "Имя элемента" } Для поля связи укажите topicId как значение и структуру, как показано здесь. Пример: { "id": "d592626c381v0" } Для поля списка связей выберите topicId из свойства options поля в качестве значения и структуры, как показано здесь. Пример: { "id": "d592626c381v0" } Для поля файла укажите объект с именем файла и содержимым файла в кодировке Base64. Пример: { "name": "sample.txt", "content": "U2FtcGxlIGNvbnRlbnQ=" } Для многозначного текстового поля укажите массив строк в качестве значения. Пример: ["Запись 1", "Запись 2"] Для многозначного числа или десятичного поля укажите массив чисел в качестве значения. Пример: [1, 2] Для многозначного поля даты укажите массив отформатированных строк ISO 8601 в виде значения. Пример: ["2025-12-01", "2025-12-02"] Для многозначного поля гиперссылки укажите массив строк URL-адресов в качестве значения. Пример: ["https://www.mavim.com", "https://www.mavim.com/about"] Для поля связи с несколькими значениями укажите массив объектов отношений в качестве значения и укажите, следует ли добавлять или удалять или удалять элемент. Пример: [ { "id": "d592626c381v0", "isAdded": "false", "isUpdated": "false", "isDeleted": "false" }, //No, которые будут приняты для этого элемента { "id": "d592626c382v0", "isAdded": "false", "false", "isUpdated": "true", "isDeleted": "false" }, //Этот элемент будет обновлен предоставленным идентификатором. { "id": "d592626c383v0", "isAdded": "false", "isUpdated": "false", "isDeleted": "true" }, //Элемент будет удален. { "id": "d592626c384v0", "isAdded": "true", "isUpdated": "false", "isDeleted": "false" }, //Элемент будет добавлен. ] Для многозначного поля файла укажите массив объектов файлов в качестве значения и укажите, следует ли добавить или обновить или удалить элемент или нет действия. Пример: [ { "id": "d592626c381v0", "isAdded": "false", "isUpdated": "false", "isDeleted": "false" }, //No, которые будут приняты для этого элемента. Обратите внимание, что идентификатор однозначно идентифицирует существующий файл. { "id": "d592626c382v0", "name": "UpdatedFile.txt", "content": "U2FtcGxlIGNvbnRlbnQgMg=", "isAdded": "false", "isUpdated": "true", "isDeleted": "false" }, //Этот элемент будет обновлен предоставленным идентификатором. { "id": "d592626c383v0", "isAdded": "false", "isUpdated": "false", "isDeleted": "true" }, //Элемент будет удален. { "name": "sample.txt", "content": "U2FtcGxlIGNvbnRlbnQ=", "isAdded": "true", "isUpdated": "false", "isDeleted": "false" }, //Элемент будет добавлен. Идентификатор будет создан после обработки запроса. ]) |
||
|
Тип
|
type | string |
Тип (FieldType, указывающий тип данных в свойстве Data) |
Обновление описания (только обычный текст)
Обновляет описание темы, указанной в файле topicId в репозитории, должно быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
|
|
Описание
|
description | string |
Описание (описание раздела) |
Обновление раздела
Обновление ресурса раздела, определяемого параметром topicId в репозитории, определяемом репозиторием, значение TopicId должно быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
|
|
Имя
|
name | string |
Имя (имя темы.) |
|
|
Код
|
code | string |
Код (код раздела.) |
|
|
Номер заказа
|
orderNumber | integer |
Номер заказа (порядок раздела среди его братьев и сестер.) |
|
|
Тип
|
type | string |
Тип (тип раздела.) |
Обновление свойства связи
Обновляет указанное свойство отношения TopicId и relationId должны быть уникальными идентификаторами (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Идентификатор отношения
|
relationId | True | string |
Идентификатор отношения (уникальный идентификатор связи (например, d0c123v456)) |
|
Id
|
id | string |
Id (Идентификатор свойства Relation для связывания отношения с.) |
|
|
Имя
|
name | string |
Имя (представляет свойство обновляемого отношения.) |
Перемещение раздела в новую позицию
Перемещает раздел, указанный в topicId, в позицию, определяемую movePosition в репозитории, The topicId должен быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Перемещение позиции
|
movePosition | string |
Перемещение позиции (положение для перемещения темы в. Если не указано, позиция по умолчанию является верхней) |
Перемещение раздела в новый родительский элемент
Перемещает раздел, указанный разделом topicId, в новый родительский раздел в репозитории. Идентификатор темы должен быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (идентификатор базы данных, к которому принадлежит раздел) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Идентификатор родительского раздела
|
parentTopicId | True | string |
Идентификатор родительского раздела (возвращает или задает идентификатор родительского раздела) |
Перечисление диаграмм раздела
Возвращает все диаграммы, связанные с темой, указанной параметром TopicId в репозитории, должен быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Идентификатор репозитория
|
repositoryId | True | string |
Идентификатор репозитория (идентификатор базы данных, к которому принадлежит раздел) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- response
- array of Chart
Перечисление категорий связей
Возвращает разделы категории связей, определяемые системой (Who, Where, WithWhat, When, WhereTo) из репозитория, указанного репозиториемId.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- response
- array of Topic
Перечисление определений версий
Возвращает все определения версий из репозитория, указанного в репозитории.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- response
- array of VersionDefinition
Перечисление типов дочерних разделов
Возвращает типы дочерних разделов, определяемых разделом topicType из репозитория, указанного в репозитории.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Тип раздела
|
topicType | True | string |
Тип раздела (имя типа раздела) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- response
- array of TopicTypeInfo
Перечисление характеристик по типу связи
Возвращает характеристики для указанного типа связи из репозитория, указанного в репозитории.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Тип отношений
|
relationshipType | True | string |
Тип связи (тип связи) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- response
- array of RelationshipCharacteristic
Получение URL-адреса подключения Dynamics 365
Возвращает URL-адрес подключения Dynamics 365 для раздела и подключения Как topicId, так и d365ConnectionId, должен быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Идентификатор D365Connection
|
d365ConnectionId | True | string |
Идентификатор D365Connection (уникальный идентификатор подключения (например, d0c123v456)) |
|
Идентификатор репозитория
|
repositoryId | True | string |
Идентификатор репозитория (идентификатор базы данных, к которому принадлежит раздел) |
Возвращаемое значение
сведения о подключении Dynamics 365
- Тело
- D365ConnectionInfo
Получение URL-адреса подключения Infor
Возвращает URL-адрес подключения Infor для раздела и подключения Как topicId, так и inforConnectionId должен быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Идентификатор подключения Infor
|
inforConnectionId | True | string |
Идентификатор подключения Infor (уникальный идентификатор подключения (например, d0c123v456)) |
|
Идентификатор репозитория
|
repositoryId | True | string |
Идентификатор репозитория (идентификатор базы данных, к которому принадлежит раздел) |
Возвращаемое значение
Сведения о подключении infor
- Тело
- InforConnectionInfo
Получение всех полей (неструктурированных) для раздела
Возвращает список полей для раздела, указанного в файле topicId в репозитории, с необязательным настраиваемым разделителем для многозначных полей topicId должен быть уникальным идентификатором (например, d0c123v456).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Разделитель X
|
X-Separator | string |
Разделитель X (настраиваемый разделитель, используемый в качестве разделителя для разделения нескольких значений) |
|
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- response
- array of FieldData
Получение данных отчета для раздела (Неструктурированный)
Возвращает неструктурированные данные отчета для topicId и reportId Оба должны быть уникальными идентификаторами (например, d0c123v456) Поддерживает выбор страниц и языка
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Идентификатор отчета
|
reportId | True | string |
Идентификатор отчета (уникальный идентификатор отчета (например, d0c123v456)) |
|
Начать с
|
startFrom | integer |
Start From (Начальный индекс для записей (необязательно)) |
|
|
Длина страницы
|
pageLength | integer |
Длина страницы (число записей для получения (необязательно)) |
|
|
Язык данных
|
data-language | string |
Язык данных (языковой код для возвращаемого отчета (например, en, nl)) |
Возвращаемое значение
- Тело
- FlatReport
Получение дочерних элементов раздела
Извлекает непосредственные дочерние разделы для раздела, указанного в файле topicId в репозитории, должен быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор respository) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- response
- array of Topic
Получение журналов аудита
Возвращает журналы аудита для раздела, указанного topicId в репозитории, The topicId должен быть уникальным идентификатором (например, d0c123v456) Поддерживает фильтрацию по идентификатору журнала, диапазону и языку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (идентификатор базы данных, к которому принадлежит раздел) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Идентификатор журнала
|
logId | integer |
Идентификатор журнала (начальный идентификатор журнала для разбиения на страницы (необязательно)) |
|
|
Диапазон
|
range | integer |
Диапазон (количество записей журнала аудита для получения (необязательно)) |
|
|
Язык данных
|
data-language | string |
Язык данных (языковой код для возвращаемых журналов (например, en, nl)) |
Возвращаемое значение
- response
- array of AuditLog
Получение корневого раздела
Возвращает корневой ресурс раздела для репозитория, определяемого идентификатором репозитория.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
Представляет ресурс раздела в API Mavim
- Тело
- Topic
Получение описания (только обычный текст)
Возвращает описание раздела, указанного в topicId в репозитории, должен быть уникальным идентификатором (например, d0c123v456) Формат может быть обычным текстом или HTML
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Исходный материал
|
source | string |
Источник (поведение кэша элементов управления (необязательно)) |
|
|
Формат
|
format | string |
Формат (формат описания. Допустимые значения: Plain, Html) |
|
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- response
- binary
Получение отчетов для раздела
Возвращает все отчеты для раздела, указанного в topicId в репозитории, должен быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Язык данных
|
data-language | string |
Язык данных (языковой код для возвращаемых отчетов (например, en, nl)) |
Возвращаемое значение
- response
- array of LinkedReports
Получение поля раздела
Возвращает поле, указанное fieldId в наборе полей fieldsetId для раздела и репозитория topicId, fieldsetId и fieldId, должно быть уникальными идентификаторами (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Идентификатор набора полей
|
fieldsetId | True | string |
Идентификатор набора полей (уникальный идентификатор набора полей (например, d0c123v456)) |
|
Идентификатор поля
|
fieldId | True | string |
Идентификатор поля (уникальный идентификатор поля (например, d0c123v456)) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- Тело
- Field
Получение пути раздела к корневому каталогу
Извлекает путь из раздела, указанного параметром topicId, к корневому разделу в репозитории The topicId должен быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- Тело
- TopicPath
Получение раздела
Извлекает ресурс раздела, указанный в файле TopicId в репозитории, должен быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор respository) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
Представляет ресурс раздела в API Mavim
- Тело
- Topic
Получение разделов, отфильтрованных по коду или типу
Извлекает разделы, определяемые определенным кодом или типом в репозитории, указанным в репозитории, кодом является код раздела, а тип относится к типу раздела. Разбиение на страницы поддерживается с помощью страницы и ограничения
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код
|
code | string |
Код (код раздела) |
|
|
Тип
|
type | string |
Тип (тип раздела. См. раздел TopicType для допустимых значений) |
|
|
Страница
|
page | integer |
Страница (указывает, какая страница результатов для получения (начиная с 1)) |
|
|
Ограничение
|
limit | integer |
Ограничение (определяет максимальное количество элементов, возвращаемых на страницу) |
|
|
Идентификатор репозитория
|
repositoryId | True | string |
Идентификатор репозитория (идентификатор базы данных, к которому принадлежит раздел) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- response
- array of Topic
Получение разделов с указанными идентификаторами topid
Извлекает несколько ресурсов раздела для предоставленных идентификаторов раздела в репозитории, определяемого идентификатором репозитория Каждый идентификатор раздела, должен быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Включение разрешений
|
includePermissions | boolean |
Включение разрешений (включение дополнительных данных, например "разрешения") |
|
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
|
|
Ценности
|
values | array of string |
Значения (представляет список идентификаторов раздела.) |
Возвращаемое значение
- response
- array of Topic
Получение сведений о подключении SAP
Возвращает сведения о подключении SAP для раздела и подключения как topicId, так и sapConnectionId должны быть уникальными идентификаторами (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Идентификатор подключения Sap
|
sapConnectionId | True | string |
Идентификатор подключения Sap (уникальный идентификатор подключения (например, d0c123v456)) |
|
Идентификатор репозитория
|
repositoryId | True | string |
Идентификатор репозитория (идентификатор базы данных, к которому принадлежит раздел) |
Возвращаемое значение
Подключение SAP
- Тело
- SAPConnectionInfo
Получение связей
Возвращает все отношения, связанные с разделом The topicId, должен быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор respository) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
Возвращаемое значение
- response
- array of Relation
Получение содержимого диаграммы
Возвращает содержимое диаграммы для раздела и диаграммы, указанной параметром topicId и chartId в репозитории, как topicId, так и chartId, должны быть уникальными идентификаторами (например, d0c123v456) поддерживает управление кэшем с помощью параметра исходного запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела () |
|
Идентификатор диаграммы
|
chartId | True | string |
Идентификатор диаграммы () |
|
Исходный материал
|
source | string |
Источник (поведение кэша элементов управления (необязательно)) |
|
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- response
- binary
Получение характеристик связи
Возвращает коллекцию характеристик для отношения, указанного реляционным Идентификатором в репозитории, должен быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (идентификатор базы данных, к которому принадлежит раздел) |
|
Идентификатор отношения
|
relationId | True | string |
Идентификатор отношения (уникальный идентификатор связи (например, d0c123v456)) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- response
- array of RelationCharacteristic
Пустая корзина
Удаляет все разделы из корзины в репозитории, указанном в репозитории, указанном в репозитории.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Раздел вставки
Вставляет раздел как одноуровневый элемент или на другом уровне относительно ссылочного раздела: TopicId должен быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Позиция вставки
|
pastePosition | string |
Позиция вставки (положение для вставки раздела. Если не указано, позиция по умолчанию находится под) |
|
|
Идентификатор ссылочного раздела
|
referenceTopicId | string |
Идентификатор раздела ссылки (идентификатор темы, связанный с темой, к которой будет вставлен целевой раздел) |
|
|
Включение наборов полей
|
includeFieldsets | boolean |
Включение полей (определяет, следует ли копировать назначения наборов полей из исходного раздела) |
Возвращаемое значение
- response
- string
Создание дочернего раздела
Создает раздел непосредственно под указанным справочным разделом в иерархии The topicId должен быть уникальным идентификатором (например, d0c123v456) Текст запроса должен содержать имя раздела, тип и значок.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
|
|
Имя
|
name | True | string |
Имя (ссылается на имя создаваемого раздела.) |
|
Тип
|
type | string |
Тип (относится к типу, которому должен быть создан раздел.) |
|
|
Icon
|
icon | string |
Значок (ссылается на идентификатор ресурса значка, который должен быть задан для этого раздела.) |
|
|
Применение шаблона
|
applyTemplate | boolean |
Применить шаблон (указывает, хочет ли пользователь применить шаблон или нет для этого раздела.) |
Возвращаемое значение
Представляет идентификатор раздела.
- Тело
- TopicId
Создание раздела с братом
Создает раздел на том же иерархическом уровне, что и указанный ссылочный раздел: TopicId должен быть уникальным идентификатором (например, d0c123v456) Текст запроса должен содержать имя раздела, тип и значок.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор справочного раздела (например, d0c123v456)) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
|
|
Имя
|
name | True | string |
Имя (ссылается на имя создаваемого раздела.) |
|
Тип
|
type | string |
Тип (относится к типу, которому должен быть создан раздел.) |
|
|
Icon
|
icon | string |
Значок (ссылается на идентификатор ресурса значка, который должен быть задан для этого раздела.) |
|
|
Применение шаблона
|
applyTemplate | boolean |
Применить шаблон (указывает, хочет ли пользователь применить шаблон или нет для этого раздела.) |
Возвращаемое значение
Представляет идентификатор раздела.
- Тело
- TopicId
Создание связи
Создает отношение между двумя разделами с указанным типом The topicId должен быть уникальным идентификатором (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Идентификатор раздела
|
toTopicId | string |
Идентификатор раздела (раздел, к которому создается связь. Идентификатор темы должен быть уникальным идентификатором (например, d0c123v456)) |
|
|
Тип отношения
|
relationType | string |
Тип отношения (тип связи) |
|
|
Идентификатор характеристик
|
characteristicId | string |
Идентификатор характеристик (идентификатор характеристики связи) |
Возвращаемое значение
Представляет идентификатор связи.
- Тело
- RelationshipId
Список значков по типу раздела
Возвращает значки для указанного объекта topicType из репозитория, указанного в репозитории.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Тип раздела
|
topicType | True | string |
Тип раздела (тип раздела) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- response
- object
Список созданных версий
Возвращает все созданные версии из репозитория, указанного в репозитории.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- response
- array of CreatedVersion
Типы разделов списка
Возвращает все типы разделов, доступные в репозитории, указанном в репозитории с помощью репозиторияId
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- response
- object
Удаление раздела
Удаляет раздел из указанного репозитория. Идентификатор темы должен быть уникальным идентификатором (например, d0c123v456). Операция необратима
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
Удаление связи
Удаляет отношение между двумя разделами TopicId и relationId должны быть уникальными идентификаторами (например, d0c123v456)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Идентификатор раздела
|
topicId | True | string |
Идентификатор раздела (уникальный идентификатор раздела (например, d0c123v456)) |
|
Идентификатор отношения
|
relationId | True | string |
Идентификатор отношения (уникальный идентификатор связи (например, d0c123v456)) |
Шаблоны описания списка
Возвращает шаблоны описания раздела из репозитория, указанного в репозитории.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор репозитория
|
repositoryId | True | uuid |
Идентификатор репозитория (уникальный идентификатор репозитория) |
|
Тип раздела
|
topicType | string |
Тип раздела (имя типа раздела) |
|
|
Значок раздела
|
topicIcon | string |
Значок раздела (имя значка раздела) |
|
|
Язык данных
|
data-language | string |
Язык данных (язык данных для использования. По умолчанию используется английский (en), если он не указан.) |
Возвращаемое значение
- response
- array of DescriptionTemplate
Определения
ApprovalWorkflowInfo
Представляет параметры конфигурации утверждения, включая включение утверждения и диапазон времени, в течение которого можно обойти утверждение.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Включен рабочий процесс утверждения
|
isApprovalWorkflowEnabled | boolean | |
|
Обход из
|
bypassFrom | time | |
|
Обход
|
bypassTo | time |
Диаграмма
Представляет идентификатор диаграммы и имя
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Id
|
id | string |
Идентификатор (идентификатор диаграммы) |
|
Имя
|
name | string |
Имя (имя диаграммы) |
D365ConnectionInfo
сведения о подключении Dynamics 365
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
URL-адрес
|
url | string |
URL-адрес (URL-адрес подключения Dynamics 365.) |
Поле
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Id
|
id | string |
Идентификатор (Идентификатор, который однозначно идентифицирует поле.) |
|
Имя
|
name | string |
Имя (имя поля.) |
|
Тип
|
type | string |
Тип (целое число, представляющее тип значения, поддерживаемого в поле.) |
|
Ценность
|
value |
Значение (значение поля, указанное типом Mavim.Processes.Api.v2.Dtos.Fields.Field.Type) |
|
|
Заказ
|
order | integer |
Порядок (порядок поля в наборе полей.) |
|
Опции
|
options |
Параметры (Возвращает параметры, связанные со списком.) |
|
|
является обязательным
|
isRequired | boolean |
Является обязательным (логическое значение, указывающее, требуется ли значение) |
|
Только для чтения
|
isReadOnly | boolean |
Значение "Только чтение" (логическое значение, указывающее, является ли поле чтением) |
|
Имеет многострочный режим
|
isMultiLine | boolean |
Является многострочный (логическое значение, указывающее, является ли поле многостроным) |
|
Использование
|
usage | string |
Использование (возвращает или задает использование; применимо только для полей списка) |
|
Открытие расположения
|
openLocation | string |
Открытие расположения (содержит идентификатор раздела, который нужно развернуть на панели навигации дерева для выбора.) |
FieldData
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор поля
|
fieldId | string |
Идентификатор поля (идентификатор, который однозначно идентифицирует поле.) |
|
Идентификатор набора полей
|
fieldsetId | string |
Идентификатор набора полей (идентификатор набора полей, к которому принадлежит поле.) |
|
Идентификатор раздела
|
topicId | string |
Идентификатор раздела (идентификатор раздела, к которому принадлежит поле.) |
|
Тип
|
type | string |
Тип (целое число, представляющее тип значения, поддерживаемого в поле.) |
|
Ценность
|
value |
Значение (значение поля, указанное типом Mavim.Processes.Api.v2.Dtos.Fields.FieldData.Type) |
|
|
Строковый параметр
|
stringValue |
Строковое значение (строковое значение поля, указанное типом Mavim.Processes.Api.v2.Dtos.Fields.FieldData.Type) |
|
|
Имя набора полей
|
fieldsetName | string |
Имя набора полей (имя набора полей.) |
|
Имя
|
name | string |
Имя (имя поля.) |
|
Порядок набора полей
|
fieldsetOrder | integer |
Порядок набора полей (порядок набора полей относительно наборов полей в запрошенном разделе.) |
|
Заказ
|
order | integer |
Порядок (порядок поля в наборе полей.) |
|
Опции
|
options |
Параметры (Возвращает параметры, связанные со списком.) |
|
|
Обязательный
|
required | boolean |
Обязательный (логическое значение, указывающее, требуется ли значение) |
|
Только чтение
|
readOnly | boolean |
Только чтение (логическое значение, указывающее, является ли поле чтением) |
|
Имеет многострочный режим
|
isMultiLine | boolean |
Является многострочный (логическое значение, указывающее, является ли поле многостроным) |
|
Использование
|
usage | string |
Использование (возвращает или задает использование; применимо только для полей списка) |
|
Открытие расположения
|
openLocation | string |
Открытие расположения (содержит идентификатор раздела, который нужно развернуть на панели навигации дерева для выбора.) |
|
Разрешение набора полей
|
fieldsetPermission | string |
Разрешение набора полей (целое число, представляющее тип разрешения набора полей, к которому относится это поле.) |
FieldRelation
Представляет отношение поля
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Id
|
id | string |
Идентификатор (идентификатор связи) |
|
Имя
|
name | string |
Имя (имя категории связи) |
|
Icon
|
icon | string |
Значок (идентификатор ресурса значка) |
|
Идентификатор пользовательского значка
|
customIconId | string |
Пользовательский идентификатор значка (пользовательский идентификатор значка) |
InforConnectionInfo
Сведения о подключении infor
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
URL-адрес
|
url | string |
URL-адрес (URL-адрес подключения Infor.) |
Relation
Представляет отношение Mavim.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Id
|
id | string |
Идентификатор (уникальный идентификатор отношения) |
|
Тип раздела
|
isTypeOfTopic | boolean |
Тип раздела (указывает, является ли он типом раздела, а не сущностью, например report) |
|
Тип категории
|
categoryType | string |
Тип категории (тип категории, к которому относится это отношение.) |
|
Тип
|
type | string |
Тип (категория отношения, к которой относится отношение. (6 Ws)) |
|
Icon
|
icon | string |
Значок (идентификатор ресурса значка категории реляционной категории) |
|
характеристика
|
characteristic | RelationCharacteristic |
Представляет характеристику связи |
|
withTopic
|
withTopic | WithTopic |
Представляет элемент Relationship |
|
withParentTopic
|
withParentTopic | FieldRelation |
Представляет отношение поля |
|
Отношение поля
|
isFieldRelation | boolean |
Is Field Relation (Указывает, указана ли реляционная связь в поле раздела) |
RelationCharacteristic
Представляет характеристику связи
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Id
|
id | string |
Идентификатор (идентификатор характеристик) |
|
Имя
|
name | string |
Имя (имя характеристик) |
|
Icon
|
icon | string |
Значок (системный значок) |
|
Идентификатор пользовательского значка
|
customIconId | string |
Пользовательский идентификатор значка (пользовательский идентификатор значка) |
ИдентификаторОтношений
Представляет идентификатор связи.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ценность
|
value | string |
RestoredTopicInfo
RestoredTopicInfo
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор родительского раздела
|
parentTopicId | string | |
|
Номер заказа раздела
|
topicOrderNumber | integer |
SAPConnectionInfo
Подключение SAP
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Заголовок
|
title | string |
Заголовок (заголовок подключения SAP.) |
|
Система
|
system | string |
Система (система подключения SAP.) |
|
ИД транзакции
|
transactionId | string |
Идентификатор транзакции (Идентификатор транзакции подключения SAP.) |
|
Client
|
client | string |
Клиент (клиент подключения SAP.) |
|
Язык
|
language | string |
Язык (язык подключения SAP.) |
Тема
Представляет ресурс раздела в API Mavim
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Id
|
id | string |
Идентификатор (уникальный идентификатор раздела в формате dcv (например, d0c12v345)) |
|
Идентификатор родительского раздела
|
parentTopicId | string |
Идентификатор родительского раздела (уникальный идентификатор родительского раздела в формате dcv (например, d0c12v345)) |
|
Идентификатор исходного раздела
|
sourceTopicId | string |
Идентификатор исходного раздела (уникальный идентификатор исходного раздела в формате dcv (например, d0c12v345)) |
|
Идентификатор пользовательского значка
|
customIconId | string |
Пользовательский идентификатор значка (уникальный идентификатор для пользовательского значка, связанного с разделом, если таковой есть) |
|
Имя
|
name | string |
Имя (имя раздела) |
|
Тип
|
type | string |
Тип (тип раздела) |
|
Имеет детей
|
hasChildren | boolean |
Имеет дочерние темы (указывает, имеет ли раздел дочерние темы) |
|
Icon
|
icon | string |
Значок (значок, связанный с темой) |
|
Код
|
code | string |
Код (код раздела) |
|
Номер заказа
|
orderNumber | integer |
Порядковый номер (порядок раздела среди его братьев и сестер) |
|
Имеет диаграмму
|
hasChart | boolean |
Имеет диаграмму (указывает, имеет ли раздел связанную диаграмму) |
|
Описание
|
hasDescription | boolean |
Описание (указывает, имеет ли раздел описание) |
|
Имеет поля
|
hasFields | boolean |
Имеет поля (указывает, имеет ли раздел поля) |
|
Имеет отношения
|
hasRelations | boolean |
Имеет отношения (указывает, имеет ли тема отношения) |
|
Содержит отчет
|
hasReport | boolean |
Имеет отчет (указывает, имеет ли раздел связанный отчет) |
|
Содержит вложенные разделы
|
hasSubTopics | boolean |
Содержит вложенные разделы (указывает, имеет ли раздел подтопии) |
|
Имеет внешние ссылки
|
hasExternalLinks | boolean |
Имеет внешние ссылки (указывает, имеет ли раздел внешние ссылки) |
|
Находится в корзине
|
isInRecycleBin | boolean |
Находится в корзине (указывает, находится ли раздел в корзине) |
|
permissions
|
permissions | TopicPermissions |
Операции, поддерживаемые разделом. Также содержит полезные метаданные по теме. Например: доступен ли раздел только для чтения, можно ли удалить его и т. д. |
|
Тип разрешения раздела
|
topicPermissionType | string |
Тип разрешения раздела (уровень разрешений пользователя API для раздела. Возможные значения: None, View, Read, Write) |
|
approvalWorkflowInfo
|
approvalWorkflowInfo | ApprovalWorkflowInfo |
Представляет параметры конфигурации утверждения, включая включение утверждения и диапазон времени, в течение которого можно обойти утверждение. |
|
Тип версии
|
versionType | string |
Тип версии (тип версии раздела) |
|
значения по умолчанию
|
defaults | TopicDefaults |
Представляет параметры по умолчанию для создания дочерних и одноуровневых разделов |
|
Дата последней мутации
|
lastMutationDate | date-time |
Дата последней мутации (дата последней мутации) |
TopicDefaultIcon
Представляет значок по умолчанию для создания раздела
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Id
|
id | string |
Идентификатор (значок по умолчанию для создаваемого раздела.) |
|
Отображаемое имя
|
displayName | string |
Отображаемое имя (отображаемое имя значка по умолчанию) |
|
Идентификатор пользовательского значка
|
customIconId | string |
Пользовательский идентификатор значка (по умолчанию для создаваемого раздела, если для значка задано значение custom.) |
TopicDefaultOptions
Представляет параметры по умолчанию для создания раздела
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имеет системное имя
|
hasSystemName | boolean |
Имеет системное имя (возвращается, если название раздела является системным именем, которое не может быть изменено пользователем.) |
|
тип
|
type | TopicDefaultType |
Представляет тип по умолчанию для создания раздела |
|
icon
|
icon | TopicDefaultIcon |
Представляет значок по умолчанию для создания раздела |
TopicDefaultType
Представляет тип по умолчанию для создания раздела
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Id
|
id | string |
Идентификатор (тип по умолчанию для создаваемого раздела.) |
|
Отображаемое имя
|
displayName | string |
Отображаемое имя (отображаемое имя типа по умолчанию) |
|
Icon
|
icon | string |
Значок (значок типа по умолчанию) |
TopicDefaults
Представляет параметры по умолчанию для создания дочерних и одноуровневых разделов
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
child
|
child | TopicDefaultOptions |
Представляет параметры по умолчанию для создания раздела |
|
nextSibling
|
nextSibling | TopicDefaultOptions |
Представляет параметры по умолчанию для создания раздела |
TopicId
Представляет идентификатор раздела.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ценность
|
value | string |
TopicInfo
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор раздела
|
topicId | string |
Идентификатор раздела (идентификатор раздела) |
|
Заказ
|
order | integer |
Порядок (порядок раздела вдоль пути к корню) |
TopicPath
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Путь к идентификаторам корневого раздела
|
pathToRootTopicIds | array of TopicInfo |
Путь к идентификаторам корневого раздела (свойство ответа, состоящее из списка идентификаторов раздела, начиная с корневого каталога базы данных Mavim.) |
|
Путь к корневому разделу
|
pathToRootTopicDetails | array of Topic |
Путь к корневому разделу (перечисляет все данные раздела, упомянутые в пути, а также их непосредственные дочерние элементы.) |
ТемыPermissions
Операции, поддерживаемые разделом. Также содержит полезные метаданные по теме. Например: доступен ли раздел только для чтения, можно ли удалить его и т. д.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Только чтение раздела
|
isTopicReadOnly | boolean |
Только чтение раздела (возвращает, является ли раздел доступной только для чтения.) |
|
Только для чтения
|
isReadOnly | boolean |
Доступен только для чтения (возвращает значение, доступно ли раздел только для чтения для запрашивающего пользователя.) |
|
Может создать дочерний раздел
|
canCreateChildTopic | boolean |
Может создать дочерний раздел (возвращает, может ли раздел создать новые дочерние темы под собой.) |
|
Может создать раздел после
|
canCreateTopicAfter | boolean |
Может создать раздел после (возвращает, может ли раздел создать новый раздел с братом после себя.) |
|
Может изменяться
|
canEdit | boolean |
Может изменить (возвращает, можно ли изменить раздел) |
|
Может копировать
|
canCopy | boolean |
Может копировать (возвращает, можно ли скопировать раздел) |
|
Может удалить
|
canDelete | boolean |
Может удалить (возвращает, можно ли удалить раздел.) |
|
Может отменить удаление
|
canUndoDelete | boolean |
Может отменить удаление (возвращает, можно ли восстановить раздел из корзины.) |
WithTopic
Представляет элемент Relationship
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Id
|
id | string |
Идентификатор (идентификатор связи) |
|
Имя
|
name | string |
Имя (имя категории связи) |
|
Icon
|
icon | string |
Значок (идентификатор ресурса значка) |
|
Идентификатор пользовательского значка
|
customIconId | string |
Пользовательский идентификатор значка (пользовательский идентификатор значка) |
CreatedVersion
Представляет созданную версию
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор версии
|
versionId | string | |
|
Имя версии
|
versionName | string | |
|
Активные языки данных
|
activeDataLanguages | array of string |
DescriptionTemplate
Шаблон описания
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Переопределяется пользователем
|
userOverridable | boolean |
Переопределяется пользователем (указывает, может ли пользователь переопределить параметры шаблона.) |
|
Значок раздела
|
topicIcon | object |
Значок раздела (сведения о значке, связанные с шаблоном раздела.) |
|
Тип раздела
|
topicType | string |
Тип раздела (тип шаблона раздела.) |
|
Применение шаблона при создании
|
applyTemplateOnCreate | boolean |
Применение шаблона при создании (указывает, следует ли применять шаблон при создании нового раздела.) |
FieldsetInfo
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор набора полей
|
fieldsetId | string |
Идентификатор набора полей (идентификатор набора полей, к которому принадлежит поле.) |
|
Имя набора полей
|
fieldsetName | string |
Имя набора полей (имя набора полей.) |
Информация об иконке
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Тип
|
type | string |
СвязьCharacteristic
Представляет элемент Relationship
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Id
|
id | string |
Идентификатор (идентификатор характеристик) |
|
Имя
|
name | string |
Имя (имя характеристик) |
|
Icon
|
icon | string |
Значок (идентификатор ресурса значка) |
|
Идентификатор пользовательского значка
|
customIconId | string |
Пользовательский идентификатор значка (пользовательский идентификатор значка) |
TopicTypeInfo
Сведения о типе раздела
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор типа раздела
|
topicTypeId | uuid |
Идентификатор типа раздела (идентификатор типа раздела) |
|
Имя типа раздела
|
topicTypeName | string |
Имя типа раздела (имя типа раздела) |
|
Системный раздел
|
isSystemTopic | boolean |
Является системным разделом (указывает, является ли это типом системного раздела) |
|
Идентификатор значка
|
iconId | string |
Идентификатор значка (идентификатор значка) |
|
Тип раздела
|
topicType | string |
Тип раздела (тип раздела) |
VersionDefinition
Представляет определение версии
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Id
|
id | string |
Идентификатор (идентификатор определения версии) |
|
Имя
|
name | string |
Имя (имя определения версии) |
AuditLog
Ответ на журнал аудита
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Id
|
id | integer |
Идентификатор (идентификатор записи журнала) |
|
Идентификатор раздела
|
topicId | string |
Идентификатор раздела (идентификатор DCV раздела) |
|
Язык
|
language | string |
Язык (язык данных этой записи журнала аудита.) |
|
Тип события
|
eventType | string |
Тип события (тип события аудита. Это может указывать на изменение заголовка, обновление поля или изменение связи.) |
|
Отметка времени
|
timeStamp | date-time |
Метка времени (метка времени, когда произошло событие.) |
|
Изменено кем
|
changedBy | string |
Изменено (сообщение электронной почты пользователя, вносившего изменения.) |
|
Сведения
|
details | string |
Сведения (содержит разные значения на основе различных типов событий. Если тип события является полем, это свойство имеет имя поля. Если тип события является связью, это свойство имеет тип связи.) |
|
Дополнительные сведения
|
detailsExtra | string |
Дополнительные сведения (содержит различные значения на основе различных типов событий. Если тип события является полем, это свойство имеет имя набора полей. Для других типов событий это поле не используется по состоянию на данный момент.) |
|
Тип объекта
|
objectType | string |
Тип объекта (показывает тип объекта события) |
|
oldValue
|
oldValue | Changes | |
|
newValue
|
newValue | Changes | |
|
Все из журнала
|
allFromLog | boolean |
Все из журнала (указывает, извлекаются ли все имена сущностей из журнала аудита или некоторые извлекаются из последнего состояния, так как журнал аудита недоступен).) |
Изменения
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
parent
|
parent | Parent | |
|
relationshipDetails
|
relationshipDetails | RelationshipDetails | |
|
Имя раздела
|
topicName | string | |
|
Тип раздела
|
topicType | string | |
|
Значок раздела
|
topicIcon | string | |
|
Номер заказа
|
orderNumber | string | |
|
Сведения
|
details | string | |
|
Дополнительные сведения
|
detailsExtra | string | |
|
Ценности
|
values | array of string | |
|
Идентификатор отношения
|
relationId | string | |
|
Идентификатор раздела
|
fromTopicId | string | |
|
Имя раздела
|
fromTopicName | string | |
|
Идентификатор раздела
|
toTopicId | string | |
|
Имя раздела
|
toTopicName | string | |
|
Тип отношения
|
relationType | string |
FlatReport
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор неструктурированного отчета
|
flatReportId | integer | |
|
Идентификатор раздела
|
topicId | string | |
|
Заголовок
|
title | string | |
|
Общее число строк
|
totalRowCount | integer | |
|
содержимое
|
content | FlatReportContent |
FlatReportContent
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Rows
|
rows | array of object | |
|
items
|
rows | object |
LinkedReports
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор связанного отчета
|
linkedReportId | string | |
|
Имя связанного отчета
|
linkedReportName | string |
Родитель
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор раздела
|
topicId | string | |
|
Имя раздела
|
topicName | string |
СвязьDetails
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор раздела
|
topicId | string | |
|
Имя раздела
|
topicName | string | |
|
Тип раздела
|
topicType | string | |
|
Значок раздела
|
topicIcon | string | |
|
Номер заказа
|
orderNumber | string |
бинарный
Это базовый тип данных binary.
объект
Это тип object.
струна
Это базовый тип данных string.