Changes for page Интерфейс bim

Last modified by Bimit Administrator on 02.10.2024, 09:47

From 60.6 to 61.1 From 73.4 to 73.5

From version 61.1

edited by Bimit Administrator
on 01.03.2022, 14:17

Change comment: There is no comment for this version

To version 73.4

edited by Bimit Administrator
on 21.06.2024, 12:52

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -1,28 +1,76 @@
  Основной интерфейс для получения и работы с данными. В данном интерфейсе доступны следующие методы:
--* [[getProject>>path:#_Toc1]] - взятие проекта на котором выполняется плагин
--* [[getProfile>>path:#_Toc2]] - получение данных о пользователе по его идентификатору Uuid
--* [[getProjectModels>>path:#_Toc3]] - взятие всех активных моделей проекта на котором выполняется плагин
--* [[getModelRevisions>>path:#_Toc4]] - взятие всех ревизий модели
--* [[getProjectTasks>>path:#_Toc5]] - получение списка всех задач проекта
--* [[getTaskComments>>path:#_Toc6]] - получение списка всех комментариев у задачи по идентификатору задача
--* [[getTaskAttachments>>path:#_Toc7]] - получение списка всех вложений к задаче по идентификатору задача
--* [[getElements>>path:#_Toc8]] - функция получения списка элементов с полной информацией
++* [[calculateDuty>>path:#_Toc66]] - получение номера дежурной группы
++* [[createCondition>>path:#_Toc19]] - функция создания условия поиска элементов
++* [[createCondition>>path:#_Toc40]] - функция создания условия поиска элементов по параметру поиска, оператору сравнения
++* [[createGroupElements>>path:#_Toc17]] - создание (объединение) элементов в группы с указанием цвета в формате HEX
++* [[getAmountDate>>path:#_Toc62]] - получение даты через указанное количество дней
++* [[getAttachmentDrawing>>path:#_Toc32]] - получение байтового массива с чертежом вложенного к задаче по названию чертежа
++* [[getAttachmentImage>>path:#_Toc31]] - получение изображения вложенного к задаче по названию изображения
++* [[getAvatar>>path:#_Toc33]] - получение байтового массива аватара по его имени
++* [[getCollisionsForReport>>path:#_Toc26]] - функция получения списка коллизий для отчета
++* [[getDate>>path:#_Toc63]] - получение даты из строки
++* [[getDateTime>>path:#_Toc64]] - получение даты и времени из строки
  * [[getElement>>path:#_Toc9]] - функция получения полной информации о элементе
++* [[getElements>>path:#_Toc8]] - функция получения списка элементов с полной информацией
++* [[getEndDate>>path:#_Toc61]] - получение даты на конец следующего дня
++* [[getFilesDownloadLinks>>path:#_Toc27]] - получение списка ссылок на скачивание файлов, которые вложены в задачи проекта
++* [[getFirstEscalationTasks>>path:#_Toc58]] - получение списка просроченных задач
  * [[getGeometryElement>>path:#_Toc10]] - функция получения полной информации о элементе и дополнительно параметры геометрии
--* [[getGeometryElements>>path:#_Toc11]] - функция получения списка элементов с полной информацией и дополнительно параметры геометрии, на вход ей можно подать: условие поиска, сложное условие поиска
--* [[getGeometryProject>>path:#_Toc12]] - взятие данных о проекта с добавленными данными по геометрии модели: границы и размеры границ по осям OX,OY,OZ
--* [[getGeometryModel>>path:#_Toc13]] - взятие данных о модели по ее идентификатору с добавленными данными по геометрии модели: границы и размеры границ по осям OX,OY,OZ
  * [[getGeometryElementA>>path:#_Toc14]] - специфичная функция получения полной информации о элементе и дополнительно параметры геометрии для расчета коллизий (сторона А, если существует)
  * [[getGeometryElementB>>path:#_Toc15]] - специфичная функция получения полной информации о элементе и дополнительно параметры геометрии для расчета коллизий (сторона B, если существует)
++* [[getGeometryElements>>path:#_Toc11]] - функция получения списка элементов с полной информацией и дополнительно параметры геометрии, на вход ей можно подать: условие поиска, сложное условие поиска
++* [[getGeometryModel>>path:#_Toc13]] - взятие данных о модели по ее идентификатору с добавленными данными по геометрии модели: границы и размеры границ по осям OX,OY,OZ
  * [[getGeometryObject>>path:#_Toc22]] - функция получения координат элемента для формирования объемной модели или отрисовки на экране
++* [[getGeometryObjects>>path:#_Toc38]] - функция получения списка координат элементов для формирования объемной модели или отрисовки на экране, на вход ей можно подать: условие поиска, сложное условие поиска
++* [[getGeometryObjects>>path:#_Toc39]] - функция получения списка координат элементов для формирования объемной модели или отрисовки на экране
++* [[getGeometryProject>>path:#_Toc12]] - взятие данных о проекта с добавленными данными по геометрии модели: границы и размеры границ по осям OX,OY,OZ
++* [[getHtmlAvatar>>path:#_Toc34]] - получение аватара преобразованного к виду htlm строки (кода) по имени аватара
++* [[getHtmlDrawing>>path:#_Toc36]] - получение чертежа преобразованного к виду html строки (кода) по имени чертежа
++* [[getHtmlImage>>path:#_Toc35]] - получение изображения преобразованную к виду html строки (кода) по имени изображения
++* [[getMaintenanceTasks>>path:#_Toc55]] - получение списка задач ТО по списку идентификаторов
++* [[getModelCollisions>>path:#_Toc21]] - функция получения списка коллизий модели
++* [[getModelRevisions>>path:#_Toc4]] - взятие всех ревизий модели
++* [[getOrCreateTaskFromMaintenance>>path:#_Toc54]] - создание или получение задачи на запланированное ТО по идентификатору задачи
++* [[getOrgGroup>>path:#_Toc53]] - получение группы организации
++* [[getOrgGroups>>path:#_Toc52]] - получение списка групп организации
++* [[getParamsToTask>>path:#_Toc45]] - получение списка параметров для задачи по идентификатору задачи
++* [[getProcessStatuses>>path:#_Toc42]] - получение списка пользовательских статусов для активного рабочего пространства
++* [[getProfile>>path:#_Toc2]] - получение данных о пользователе по его идентификатору Uuid
++* [[getProject>>path:#_Toc1]] - взятие проекта на котором выполняется плагин
++* [[getProjectCollisions>>path:#_Toc20]] - функция получения списка коллизий проекта
++* [[getProjectModels>>path:#_Toc3]] - взятие всех активных моделей проекта на котором выполняется плагин
++* [[getProjectTasks>>path:#_Toc5]] - получение списка всех задач проекта
++* [[getSecondEscalationTasks>>path:#_Toc59]] - получить список задач второй эскалации
++* [[getStartDate>>path:#_Toc60]] - получение даты на начало следующего дня
++* [[getTaskAttachments>>path:#_Toc7]] - получение списка всех вложений к задаче по идентификатору задач
++* [[getTaskComments>>path:#_Toc6]] - получение списка всех комментариев у задачи по идентификатору задач
++* [[getTaskForm>>path:#_Toc29]] - получение списка данных формы задачи по идентификатору задачи
++* [[getTaskParams>>path:#_Toc46]] - получение списка параметров для всех задач рабочего пространства
++* [[getTaskWorkers>>path:#_Toc30]] - получение списка профилей у задачи по её идентификатору
++* [[initPluginTaskStatus>>path:#_Toc67]] - инициализация пользовательских статусов в проекте
++* [[registerProcessStatuses>>path:#_Toc41]] - регистрация списка пользовательских статусов для задач по списку статусов задач плагина
++* [[saveParamsToTask>>path:#_Toc43]] - сохранение списка пользовательских параметров к задаче, на вход ей можно подать: идентификатор задачи, параметры, показ задачи
++* [[saveParamsToTask>>path:#_Toc44]] - сохранение пользовательского параметра к задаче, на вход ей можно подать: идентификатор задачи, имя задачи, какое-то значение, показ задачи
++* [[saveTask>>path:#_Toc65]] - создание и/или сохранение задачи
++* [[setGroupResponderToTask>>path:#_Toc57]] - назначение группы организации как ответственного на задачу по идентификатору задачи, имени группы
++* [[setGroupWorkersToTask>>path:#_Toc56]] - назначение группы организации как работника на задачу по идентификатору задачи, списку титулов
++* [[setPluginStatusToTask>>path:#_Toc50]] - изменение пользовательского статуса задачи по идентификатору задачи, статусу
  * [[showElements>>path:#_Toc16]] - функция отображения на экране списка элементов (выбор/подсветка на модели)
--* [[createGroupElements>>path:#_Toc17]] - создание (объединение) элементов в группы с указанием цвета в формате HEX
  * [[showGroupElements>>path:#_Toc18]] - функция отображения/подсветки на экране ранее созданных групп элементов
--* [[createCondition>>path:#_Toc19]] - функция создания условия поиска элементов
--* [[getProjectCollisions>>path:#_Toc20]] - функция получения списка коллизий проекта
--* [[getModelCollisions>>path:#_Toc21]] - функция получения списка коллизий модели
++* [[deleteDutyShift>>path:#_Toc51]] - удаление назначенной группы к задаче, название которой содержит указанную строку
++* [[deleteParam>>path:#_Toc48]] - удаление параметра задачи по параметру идентификатора
++* [[deleteParams>>path:#_Toc49]] - удаление параметров
++* [[editParam>>path:#_Toc47]] - редактирование параметра задачи по идентификатору параметра, имени параметра, параметру
++* [[editTokenExpiredDate>>path:#_Toc28]] - позволяет изменить количество дней, через сколько токен для скачивания файлов станет недействительным
++
++Справочники
++
++* [[Операторы сравнения>>path:#_Toc23]]
++* [[Параметры поиска>>path:#_Toc24]]
++* [[Статусы коллизий>>path:#_Toc25]]
++
  ======   ======
  ======   ======
@@ -1880,7 +1880,6 @@
  * **bim.getGeometryObject(Идентификатор элемента)**
--
  (% class="box infomessage" %)
  (((
  **{{id name="_Toc16"/}}showElements** - функция отображения на экране списка элементов (выбор/подсветка на модели)
@@ -1967,9 +1967,9 @@
  **{{id name="_Toc19"/}}createCondition** - функция создания условия поиска элементов
  )))
--* **bim.createCondition(параметр поиска, оператор сравнения,значение для поиска)**
--* **bim.createCondition(параметр поиска по атрибуту, наименование атрибута, оператор сравнения,значение поиска атрибута)**
--* **bim.createCondition(параметр поиска по атрибуту, наименование группы атрибутов,наименование атрибута, оператор сравнения,значение поиска атрибута)**
++* **bim.createCondition([[параметр поиска>>path:#_Toc24]], [[операторы сравнения>>path:#_Toc23]] ,значение для поиска)**
++* **bim.createCondition([[параметр поиска>>path:#_Toc24]] по атрибуту, наименование атрибута, [[операторы сравнения>>path:#_Toc23]],значение поиска атрибута)**
++* **bim.createCondition([[параметр поиска>>path:#_Toc24]] по атрибуту, наименование группы атрибутов,наименование атрибута, [[операторы сравнения>>path:#_Toc23]],значение поиска атрибута)**
  **Примеры использования:**
@@ -2309,4 +2309,116 @@
  }
  {{/code}}
--
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc26"/}}getCollisionsForReport()** - функция получения списка коллизий для отчета.
++)))
++
++* **bim.getCollisionsForReport()**
++[[list>>https://wiki.bimit.ru/bin/view/API/%D0%9F%D0%BB%D0%B0%D0%B3%D0%B8%D0%BD%20API/%D0%98%D0%BD%D1%82%D0%B5%D1%80%D1%84%D0%B5%D0%B9%D1%81%20file/#_Toc20]] - список коллизий. Обязательное поле. Получить данный лист необходимо
++
++**Пример использования:**
++
++{{code language="java"}}
++def collisionList = bim.getCollisionsForReport()
++ def param = [:]
++ param.add("pageSize", 3)
++ param.add("fontSize", 12)
++ file.collisionsToPdf(template, collisionList, param)
++
++{{/code}}
++
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc27"/}}getFilesDownloadLinks** - получение списка ссылок на скачивание файлов, которые вложены в задачи проекта
++)))
++
++* **bim.getFilesDownloadLinks() - **Данный метод предназначен для получения списка ссылок на скачивания файлов из задач по проекту.
++Ссылка действительна в течении одного дня. Изменить данное время можно командой editTokenExpiredDate (см. ниже). Данный метод рекомендуется использовать при формировании отчетов.
++**Пример использования:**
++
++{{code language="java"}}
++def tasks = bim.getProjectTasks()
++    def taskAttachments = []
++    for(def task : tasks) {
++        taskAttachments.push(bim.getTaskAttachments(task.uuid))
++    }
++
++    def uuids = []
++    for (def attachments : taskAttachments) {
++        for (def attachment : attachments) {
++            if (attachment != null)
++                uuids.push(attachment.uuid)
++        }
++    }
++    def downloadLinks = bim.getFilesDownloadLinks(uuids)
++    console.info(downloadLinks) ->  INFO [
++6201ced9-b873-4a7d-8266-537f1566c543.docx,
++687ac450-75e2-42f6-9fbe-7c608912c079.png
++]
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc28"/}}editTokenExpiredDate** - позволяет изменить количество дней, через сколько токен для скачивания файлов станет недействительным
++)))
++
++* **bim.editTokenExpiredDate()**
++**Пример использования:**
++
++{{code language="java"}}
++UUID uuid = UUID.fromString("94e8e236-510b-4325-8b3a-15e317924bb2")
++     bim.editTokenExpiredDate (uuid, 2)
++
++{{/code}}
++
++(% class="box infomessage" %)
++(((
++**{{id name="_Toc29"/}}getTaskForm** - получение списка данных формы задачи по идентификатору задачи
++)))
++
++* **bim.getTaskForm(UUID taskUuid) **
++
++**Пример использования:**
++
++{{code language="java"}}{{/code}}
++
++
++
++СПРАВОЧНИКИ
++
++
++**{{id name="_Toc23"/}}Операторы сравнения**
++
++(% cellspacing="0" style="border-collapse:collapse; border:none; width:850px" %)
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**eq**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)Равно
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**noteq**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)Не равно
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**cont**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)Содержит
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**notcont**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)Не содержит
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**gt**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)Больше
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**gteq**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)Больше или равно
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**lt**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)Меньше
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**lteq**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)Меньше или равно
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**ex**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)Имеет значение ex
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**notex**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)Не имеет значение notex
++
++**{{id name="_Toc24"/}}Параметры поиска**
++
++(% cellspacing="0" style="border-collapse:collapse; border:none; width:850px" %)
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**model**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)поиск по названию модели в структуре проекта
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**floor**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)поиск по названию этажа
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**class**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)поиск по названию ifc класса (ifc тип)
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**zone**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)поиск по названию зоны, объединяющей элементы
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**layer**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)поиск по названию слоя объединяющего элементы
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**attribute**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)поиск по значению атрибута
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**geometry**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)параметры поиска по значению рассчитанной геометрии, на текущий момент доступно только площадь(ключ атрибута =”area”) и объем(ключ атрибута =”volume”)
++
++**{{id name="_Toc25"/}}Статусы коллизий**
++
++(% cellspacing="0" style="border-collapse:collapse; border:none; width:850px" %)
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**NEW**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)запрос коллизий в статусе новые
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**WORK**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)коллизии в работе
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**SOLVED**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)решенные коллизии
++|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:363px" %)**ALLOWED**|(% style="border-color:#000000; border-style:solid; border-width:1px; padding:7px; vertical-align:top; width:485px" %)допустимые коллизии