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

Last modified by Bimit Administrator on 02.10.2024, 09:47
From version 63.2
edited by Bimit Administrator
on 23.05.2023, 15:59
Change comment: There is no comment for this version
To version 73.5
edited by Bimit Administrator
on 21.06.2024, 13:01
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,31 +1,75 @@
1 1  Основной интерфейс для получения и работы с данными. В данном интерфейсе доступны следующие методы:
2 2  
3 -* [[getProject>>path:#_Toc1]] - взятие проекта на котором выполняется плагин
4 -* [[getProfile>>path:#_Toc2]] - получение данных о пользователе по его идентификатору Uuid
5 -* [[getProjectModels>>path:#_Toc3]] - взятие всех активных моделей проекта на котором выполняется плагин
6 -* [[getModelRevisions>>path:#_Toc4]] - взятие всех ревизий модели
7 -* [[getProjectTasks>>path:#_Toc5]] - получение списка всех задач проекта
8 -* [[getTaskComments>>path:#_Toc6]] - получение списка всех комментариев у задачи по идентификатору задача
9 -* [[getTaskAttachments>>path:#_Toc7]] - получение списка всех вложений к задаче по идентификатору задача
10 -* [[getElements>>path:#_Toc8]] - функция получения списка элементов с полной информацией
3 +* [[calculateDuty>>path:#_Toc66]] - получение номера дежурной группы
4 +* [[createCondition>>path:#_Toc19]] - функция создания условия поиска элементов
5 +* [[createCondition>>path:#_Toc40]] - функция создания условия поиска элементов по параметру поиска, оператору сравнения
6 +* [[createGroupElements>>path:#_Toc17]] - создание (объединение) элементов в группы с указанием цвета в формате HEX
7 +* [[getAmountDate>>path:#_Toc62]] - получение даты через указанное количество дней
8 +* [[getAttachmentDrawing>>path:#_Toc32]] - получение байтового массива с чертежом вложенного к задаче по названию чертежа
9 +* [[getAttachmentImage>>path:#_Toc31]] - получение изображения вложенного к задаче по названию изображения
10 +* [[getAvatar>>path:#_Toc33]] - получение байтового массива аватара по его имени
11 +* [[getCollisionsForReport>>path:#_Toc26]] - функция получения списка коллизий для отчета
12 +* [[getDate>>path:#_Toc63]] - получение даты из строки
13 +* [[getDateTime>>path:#_Toc64]] - получение даты и времени из строки
11 11  * [[getElement>>path:#_Toc9]] - функция получения полной информации о элементе
15 +* [[getElements>>path:#_Toc8]] - функция получения списка элементов с полной информацией
16 +* [[getEndDate>>path:#_Toc61]] - получение даты на конец следующего дня
17 +* [[getFilesDownloadLinks>>path:#_Toc27]] - получение списка ссылок на скачивание файлов, которые вложены в задачи проекта
18 +* [[getFirstEscalationTasks>>path:#_Toc58]] - получение списка просроченных задач
12 12  * [[getGeometryElement>>path:#_Toc10]] - функция получения полной информации о элементе и дополнительно параметры геометрии
13 -* [[getGeometryElements>>path:#_Toc11]] - функция получения списка элементов с полной информацией и дополнительно параметры геометрии, на вход ей можно подать: условие поиска, сложное условие поиска
14 -* [[getGeometryProject>>path:#_Toc12]] - взятие данных о проекта с добавленными данными по геометрии модели: границы и размеры границ по осям OX,OY,OZ
15 -* [[getGeometryModel>>path:#_Toc13]] - взятие данных о модели по ее идентификатору с добавленными данными по геометрии модели: границы и размеры границ по осям OX,OY,OZ
16 16  * [[getGeometryElementA>>path:#_Toc14]] - специфичная функция получения полной информации о элементе и дополнительно параметры геометрии для расчета коллизий (сторона А, если существует)
17 17  * [[getGeometryElementB>>path:#_Toc15]] - специфичная функция получения полной информации о элементе и дополнительно параметры геометрии для расчета коллизий (сторона B, если существует)
22 +* [[getGeometryElements>>path:#_Toc11]] - функция получения списка элементов с полной информацией и дополнительно параметры геометрии, на вход ей можно подать: условие поиска, сложное условие поиска
23 +* [[getGeometryModel>>path:#_Toc13]] - взятие данных о модели по ее идентификатору с добавленными данными по геометрии модели: границы и размеры границ по осям OX,OY,OZ
18 18  * [[getGeometryObject>>path:#_Toc22]] - функция получения координат элемента для формирования объемной модели или отрисовки на экране
25 +* [[getGeometryObjects>>path:#_Toc38]] - функция получения списка координат элементов для формирования объемной модели или отрисовки на экране
26 +* [[getGeometryProject>>path:#_Toc12]] - взятие данных о проекта с добавленными данными по геометрии модели: границы и размеры границ по осям OX,OY,OZ
27 +* [[getHtmlAvatar>>path:#_Toc34]] - получение аватара преобразованного к виду htlm строки (кода) по имени аватара
28 +* [[getHtmlDrawing>>path:#_Toc36]] - получение чертежа преобразованного к виду html строки (кода) по имени чертежа
29 +* [[getHtmlImage>>path:#_Toc35]] - получение изображения преобразованную к виду html строки (кода) по имени изображения
30 +* [[getMaintenanceTasks>>path:#_Toc55]] - получение списка задач ТО по списку идентификаторов
31 +* [[getModelCollisions>>path:#_Toc21]] - функция получения списка коллизий модели
32 +* [[getModelRevisions>>path:#_Toc4]] - взятие всех ревизий модели
33 +* [[getOrCreateTaskFromMaintenance>>path:#_Toc54]] - создание или получение задачи на запланированное ТО по идентификатору задачи
34 +* [[getOrgGroup>>path:#_Toc53]] - получение группы организации
35 +* [[getOrgGroups>>path:#_Toc52]] - получение списка групп организации
36 +* [[getParamsToTask>>path:#_Toc45]] - получение списка параметров для задачи по идентификатору задачи
37 +* [[getProcessStatuses>>path:#_Toc42]] - получение списка пользовательских статусов для активного рабочего пространства
38 +* [[getProfile>>path:#_Toc2]] - получение данных о пользователе по его идентификатору Uuid
39 +* [[getProject>>path:#_Toc1]] - взятие проекта на котором выполняется плагин
40 +* [[getProjectCollisions>>path:#_Toc20]] - функция получения списка коллизий проекта
41 +* [[getProjectModels>>path:#_Toc3]] - взятие всех активных моделей проекта на котором выполняется плагин
42 +* [[getProjectTasks>>path:#_Toc5]] - получение списка всех задач проекта
43 +* [[getSecondEscalationTasks>>path:#_Toc59]] - получить список задач второй эскалации
44 +* [[getStartDate>>path:#_Toc60]] - получение даты на начало следующего дня
45 +* [[getTaskAttachments>>path:#_Toc7]] - получение списка всех вложений к задаче по идентификатору задач
46 +* [[getTaskComments>>path:#_Toc6]] - получение списка всех комментариев у задачи по идентификатору задач
47 +* [[getTaskForm>>path:#_Toc29]] - получение списка данных формы задачи по идентификатору задачи
48 +* [[getTaskParams>>path:#_Toc46]] - получение списка параметров для всех задач рабочего пространства
49 +* [[getTaskWorkers>>path:#_Toc30]] - получение списка профилей у задачи по её идентификатору
50 +* [[initPluginTaskStatus>>path:#_Toc67]] - инициализация пользовательских статусов в проекте
51 +* [[registerProcessStatuses>>path:#_Toc41]] - регистрация списка пользовательских статусов для задач по списку статусов задач плагина
52 +* [[saveParamsToTask>>path:#_Toc43]] - сохранение списка пользовательских параметров к задаче, на вход ей можно подать: идентификатор задачи, параметры, показ задачи
53 +* [[saveParamsToTask>>path:#_Toc44]] - сохранение пользовательского параметра к задаче, на вход ей можно подать: идентификатор задачи, имя задачи, какое-то значение, показ задачи
54 +* [[saveTask>>path:#_Toc65]] - создание и/или сохранение задачи
55 +* [[setGroupResponderToTask>>path:#_Toc57]] - назначение группы организации как ответственного на задачу по идентификатору задачи, имени группы
56 +* [[setGroupWorkersToTask>>path:#_Toc56]] - назначение группы организации как работника на задачу по идентификатору задачи, списку титулов
57 +* [[setPluginStatusToTask>>path:#_Toc50]] - изменение пользовательского статуса задачи по идентификатору задачи, статусу
19 19  * [[showElements>>path:#_Toc16]] - функция отображения на экране списка элементов (выбор/подсветка на модели)
20 -* [[createGroupElements>>path:#_Toc17]] - создание (объединение) элементов в группы с указанием цвета в формате HEX
21 21  * [[showGroupElements>>path:#_Toc18]] - функция отображения/подсветки на экране ранее созданных групп элементов
22 -* [[createCondition>>path:#_Toc19]] - функция создания условия поиска элементов
23 -* [[getProjectCollisions>>path:#_Toc20]] - функция получения списка коллизий проекта
24 -* [[getModelCollisions>>path:#_Toc21]] - функция получения списка коллизий модели
25 -* [[Операторы сравнения>>path:#_Toc22]]
26 -* [[Параметры поиска>>path:#_Toc23]]
27 -* [[Статусы коллизий>>path:#_Toc24]]
60 +* [[deleteDutyShift>>path:#_Toc51]] - удаление назначенной группы к задаче, название которой содержит указанную строку
61 +* [[deleteParam>>path:#_Toc48]] - удаление параметра задачи по параметру идентификатора
62 +* [[deleteParams>>path:#_Toc49]] - удаление параметров
63 +* [[editParam>>path:#_Toc47]] - редактирование параметра задачи по идентификатору параметра, имени параметра, параметру
64 +* [[editTokenExpiredDate>>path:#_Toc28]] - позволяет изменить количество дней, через сколько токен для скачивания файлов станет недействительным
28 28  
66 +
67 +Справочники
68 +
69 +* [[Операторы сравнения>>path:#_Toc23]]
70 +* [[Параметры поиска>>path:#_Toc24]]
71 +* [[Статусы коллизий>>path:#_Toc25]]
72 +
29 29  ====== ======
30 30  
31 31  ====== ======
... ... @@ -1969,9 +1969,9 @@
1969 1969  **{{id name="_Toc19"/}}createCondition** - функция создания условия поиска элементов
1970 1970  )))
1971 1971  
1972 -* **bim.createCondition(параметр поиска, оператор сравнения,значение для поиска)**
1973 -* **bim.createCondition(параметр поиска по атрибуту, наименование атрибута, оператор сравнения,значение поиска атрибута)**
1974 -* **bim.createCondition(параметр поиска по атрибуту, наименование группы атрибутов,наименование атрибута, оператор сравнения,значение поиска атрибута)**
2016 +* **bim.createCondition([[параметр поиска>>path:#_Toc24]], [[операторы сравнения>>path:#_Toc23]] ,значение для поиска)**
2017 +* **bim.createCondition([[параметр поиска>>path:#_Toc24]] по атрибуту, наименование атрибута, [[операторы сравнения>>path:#_Toc23]],значение поиска атрибута)**
2018 +* **bim.createCondition([[параметр поиска>>path:#_Toc24]] по атрибуту, наименование группы атрибутов,наименование атрибута, [[операторы сравнения>>path:#_Toc23]],значение поиска атрибута)**
1975 1975  
1976 1976  **Примеры использования:**
1977 1977  
... ... @@ -2312,9 +2312,88 @@
2312 2312  {{/code}}
2313 2313  
2314 2314  
2359 +(% class="box infomessage" %)
2360 +(((
2361 +**{{id name="_Toc26"/}}getCollisionsForReport()** - функция получения списка коллизий для отчета.
2362 +)))
2315 2315  
2316 -**{{id name="_Toc22"/}}Операторы сравнения**
2364 +* **bim.getCollisionsForReport()**
2365 +[[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]] - список коллизий. Обязательное поле. Получить данный лист необходимо
2317 2317  
2367 +**Пример использования:**
2368 +
2369 +{{code language="java"}}
2370 +def collisionList = bim.getCollisionsForReport()
2371 + def param = [:]
2372 + param.add("pageSize", 3)
2373 + param.add("fontSize", 12)
2374 + file.collisionsToPdf(template, collisionList, param)
2375 +
2376 +{{/code}}
2377 +
2378 +
2379 +(% class="box infomessage" %)
2380 +(((
2381 +**{{id name="_Toc27"/}}getFilesDownloadLinks** - получение списка ссылок на скачивание файлов, которые вложены в задачи проекта
2382 +)))
2383 +
2384 +* **bim.getFilesDownloadLinks() - **Данный метод предназначен для получения списка ссылок на скачивания файлов из задач по проекту.
2385 +Ссылка действительна в течении одного дня. Изменить данное время можно командой editTokenExpiredDate (см. ниже). Данный метод рекомендуется использовать при формировании отчетов.
2386 +**Пример использования:**
2387 +
2388 +{{code language="java"}}
2389 +def tasks = bim.getProjectTasks()
2390 + def taskAttachments = []
2391 + for(def task : tasks) {
2392 + taskAttachments.push(bim.getTaskAttachments(task.uuid))
2393 + }
2394 +
2395 + def uuids = []
2396 + for (def attachments : taskAttachments) {
2397 + for (def attachment : attachments) {
2398 + if (attachment != null)
2399 + uuids.push(attachment.uuid)
2400 + }
2401 + }
2402 + def downloadLinks = bim.getFilesDownloadLinks(uuids)
2403 + console.info(downloadLinks) -> INFO [
2404 +6201ced9-b873-4a7d-8266-537f1566c543.docx,
2405 +687ac450-75e2-42f6-9fbe-7c608912c079.png
2406 +]
2407 +{{/code}}
2408 +
2409 +(% class="box infomessage" %)
2410 +(((
2411 +**{{id name="_Toc28"/}}editTokenExpiredDate** - позволяет изменить количество дней, через сколько токен для скачивания файлов станет недействительным
2412 +)))
2413 +
2414 +* **bim.editTokenExpiredDate()**
2415 +**Пример использования:**
2416 +
2417 +{{code language="java"}}
2418 +UUID uuid = UUID.fromString("94e8e236-510b-4325-8b3a-15e317924bb2")
2419 + bim.editTokenExpiredDate (uuid, 2)
2420 +
2421 +{{/code}}
2422 +
2423 +(% class="box infomessage" %)
2424 +(((
2425 +**{{id name="_Toc29"/}}getTaskForm** - получение списка данных формы задачи по идентификатору задачи
2426 +)))
2427 +
2428 +* **bim.getTaskForm(UUID taskUuid) **
2429 +
2430 +**Пример использования:**
2431 +
2432 +{{code language="java"}}{{/code}}
2433 +
2434 +
2435 +
2436 +СПРАВОЧНИКИ
2437 +
2438 +
2439 +**{{id name="_Toc23"/}}Операторы сравнения**
2440 +
2318 2318  (% cellspacing="0" style="border-collapse:collapse; border:none; width:850px" %)
2319 2319  |(% 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" %)Равно
2320 2320  |(% 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" %)Не равно
... ... @@ -2327,9 +2327,8 @@
2327 2327  |(% 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
2328 2328  |(% 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
2329 2329  
2453 +**{{id name="_Toc24"/}}Параметры поиска**
2330 2330  
2331 -**{{id name="_Toc23"/}}Параметры поиска**
2332 -
2333 2333  (% cellspacing="0" style="border-collapse:collapse; border:none; width:850px" %)
2334 2334  |(% 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" %)поиск по названию модели в структуре проекта
2335 2335  |(% 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" %)поиск по названию этажа
... ... @@ -2339,9 +2339,8 @@
2339 2339  |(% 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" %)поиск по значению атрибута
2340 2340  |(% 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”)
2341 2341  
2464 +**{{id name="_Toc25"/}}Статусы коллизий**
2342 2342  
2343 -**{{id name="_Toc24"/}}Статусы коллизий**
2344 -
2345 2345  (% cellspacing="0" style="border-collapse:collapse; border:none; width:850px" %)
2346 2346  |(% 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" %)запрос коллизий в статусе новые
2347 2347  |(% 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" %)коллизии в работе