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

Last modified by Bimit Administrator on 02.10.2024, 09:47
From version 73.6
edited by Bimit Administrator
on 21.06.2024, 13:07
Change comment: There is no comment for this version
To version 60.3
edited by Bimit Administrator
on 01.03.2022, 13:55
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,74 +1,27 @@
1 1  Основной интерфейс для получения и работы с данными. В данном интерфейсе доступны следующие методы:
2 2  
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]] - получение даты и времени из строки
14 -* [[getElement>>path:#_Toc9]] - функция получения полной информации о элементе
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]] - получение списка всех вложений к задаче по идентификатору задача
15 15  * [[getElements>>path:#_Toc8]] - функция получения списка элементов с полной информацией
16 -* [[getEndDate>>path:#_Toc61]] - получение даты на конец следующего дня
17 -* [[getFilesDownloadLinks>>path:#_Toc27]] - получение списка ссылок на скачивание файлов, которые вложены в задачи проекта
18 -* [[getFirstEscalationTasks>>path:#_Toc58]] - получение списка просроченных задач
11 +* [[getElement>>path:#_Toc9]] - функция получения полной информации о элементе
19 19  * [[getGeometryElement>>path:#_Toc10]] - функция получения полной информации о элементе и дополнительно параметры геометрии
20 -* [[getGeometryElementA>>path:#_Toc14]] - специфичная функция получения полной информации о элементе и дополнительно параметры геометрии для расчета коллизий (сторона А, если существует)
21 -* [[getGeometryElementB>>path:#_Toc15]] - специфичная функция получения полной информации о элементе и дополнительно параметры геометрии для расчета коллизий (сторона B, если существует)
22 22  * [[getGeometryElements>>path:#_Toc11]] - функция получения списка элементов с полной информацией и дополнительно параметры геометрии, на вход ей можно подать: условие поиска, сложное условие поиска
23 -* [[getGeometryModel>>path:#_Toc13]] - взятие данных о модели по ее идентификатору с добавленными данными по геометрии модели: границы и размеры границ по осям OX,OY,OZ
24 -* [[getGeometryObject>>path:#_Toc22]] - функция получения координат элемента для формирования объемной модели или отрисовки на экране
25 -* [[getGeometryObjects>>path:#_Toc38]] - функция получения списка координат элементов для формирования объемной модели или отрисовки на экране
26 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 -* [[saveTask>>path:#_Toc65]] - создание и/или сохранение задачи
54 -* [[setGroupResponderToTask>>path:#_Toc57]] - назначение группы организации как ответственного на задачу по идентификатору задачи, имени группы
55 -* [[setGroupWorkersToTask>>path:#_Toc56]] - назначение группы организации как работника на задачу по идентификатору задачи, списку титулов
56 -* [[setPluginStatusToTask>>path:#_Toc50]] - изменение пользовательского статуса задачи по идентификатору задачи, статусу
57 -* [[showElements>>path:#_Toc16]] - функция отображения на экране списка элементов (выбор/подсветка на модели)
15 +* [[getGeometryModel>>path:#_Toc13]] - взятие данных о модели по ее идентификатору с добавленными данными по геометрии модели: границы и размеры границ по осям OX,OY,OZ
16 +* [[getGeometryElementA>>path:#_Toc14]] - специфичная функция получения полной информации о элементе и дополнительно параметры геометрии для расчета коллизий (сторона А, если существует)
17 +* [[getGeometryElementB>>path:#_Toc15]] - специфичная функция получения полной информации о элементе и дополнительно параметры геометрии для расчета коллизий (сторона B, если существует)
18 +* [[showElements>>path:#_Toc16]] - функция получения списка элементов и их отображения на экране(выбор/подсветка на модели)
19 +* [[createGroupElements>>path:#_Toc17]] - создание (объединение) элементов в группы с указанием цвета в формате HEX
58 58  * [[showGroupElements>>path:#_Toc18]] - функция отображения/подсветки на экране ранее созданных групп элементов
59 -* [[deleteDutyShift>>path:#_Toc51]] - удаление назначенной группы к задаче, название которой содержит указанную строку
60 -* [[deleteParam>>path:#_Toc48]] - удаление параметра задачи по параметру идентификатора
61 -* [[deleteParams>>path:#_Toc49]] - удаление параметров
62 -* [[editParam>>path:#_Toc47]] - редактирование параметра задачи по идентификатору параметра, имени параметра, параметру
63 -* [[editTokenExpiredDate>>path:#_Toc28]] - позволяет изменить количество дней, через сколько токен для скачивания файлов станет недействительным
21 +* [[createCondition>>path:#_Toc19]] - функция создания условия поиска элементов
22 +* [[getProjectCollisions>>path:#_Toc20]] - функция получения списка коллизий проекта
23 +* [[getModelCollisions>>path:#_Toc21]] - функция получения списка коллизий модели
64 64  
65 -
66 -Справочники
67 -
68 -* [[Операторы сравнения>>path:#_Toc23]]
69 -* [[Параметры поиска>>path:#_Toc24]]
70 -* [[Статусы коллизий>>path:#_Toc25]]
71 -
72 72  ====== ======
73 73  
74 74  ====== ======
... ... @@ -913,25 +913,17 @@
913 913  )))
914 914  
915 915  * **bim.getElement(Идентификатор элемента)**
916 -* **bim.getElement(Идентификатор элемента как текст)**
917 917  
918 -**Примеры использования:**
870 +**Пример использования:**
919 919  
920 920  {{code language="java"}}
921 -def element = bim.getElement(UUID.fromString("e5a114d0-7de1-11ec-90d6-0242ac120003"))
873 +def element = bim.getElement(UUID.fromString("e5a114d0-7de1-11ec-90d6-0242ac120003")
922 922  def globalId = element.getGlobalId()
923 923  
924 924  // console.info(globalId) -> “INFO: 0Dtdg2chjBhhgnQ7zCqZkk”
925 925  {{/code}}
926 926  
927 -{{code language="java"}}
928 -def element = bim.getElement("e5a114d0-7de1-11ec-90d6-0242ac120003")
929 -def globalId = element.getGlobalId()
930 930  
931 -// console.info(globalId) -> “INFO: 0Dtdg2chjBhhgnQ7zCqZkk”
932 -{{/code}}
933 -
934 -
935 935  (% class="box infomessage" %)
936 936  (((
937 937  **{{id name="_Toc10"/}}getGeometryElement** - функция получения полной информации о элементе и дополнительно параметры геометрии
... ... @@ -1921,22 +1921,14 @@
1921 1921  
1922 1922  (% class="box infomessage" %)
1923 1923  (((
1924 -**{{id name="_Toc22"/}}bim.getGeometryObject(uuid) **- функция получения координат элемента для формирования объемной модели или отрисовки на экране
1869 +**{{id name="_Toc16"/}}showElements** - функция получения списка элементов и их отображения на экране(выбор/подсветка на модели)
1925 1925  )))
1926 1926  
1927 -* **bim.getGeometryObject(Идентификатор элемента)**
1928 -
1929 -(% class="box infomessage" %)
1930 -(((
1931 -**{{id name="_Toc16"/}}showElements** - функция отображения на экране списка элементов (выбор/подсветка на модели)
1932 -)))
1933 -
1934 1934  * **bim.showElements(Условие поиска)**
1935 1935  * **bim.showElements(список глобальных идентификаторов элементов)**
1936 1936  * **bim.showElements(список идентификаторов элементов)**
1937 1937  * **bim.showElements(список элементов)**
1938 -* **bim.showElements(элемент1,элемент2,...)**
1939 -* **bim.showElement(элемент) - показ одного элемента**
1876 +* **bim.showElements(el1,el2,...)**
1940 1940  
1941 1941  **Примеры использования:**
1942 1942  
... ... @@ -2012,9 +2012,9 @@
2012 2012  **{{id name="_Toc19"/}}createCondition** - функция создания условия поиска элементов
2013 2013  )))
2014 2014  
2015 -* **bim.createCondition([[параметр поиска>>path:#_Toc24]], [[операторы сравнения>>path:#_Toc23]] ,значение для поиска)**
2016 -* **bim.createCondition([[параметр поиска>>path:#_Toc24]] по атрибуту, наименование атрибута, [[операторы сравнения>>path:#_Toc23]],значение поиска атрибута)**
2017 -* **bim.createCondition([[параметр поиска>>path:#_Toc24]] по атрибуту, наименование группы атрибутов,наименование атрибута, [[операторы сравнения>>path:#_Toc23]],значение поиска атрибута)**
1952 +* **bim.createCondition(параметр поиска, оператор сравнения,значение для поиска)**
1953 +* **bim.createCondition(параметр поиска по атрибуту, наименование атрибута, оператор сравнения,значение поиска атрибута)**
1954 +* **bim.createCondition(параметр поиска по атрибуту, наименование группы атрибутов,наименование атрибута, оператор сравнения,значение поиска атрибута)**
2018 2018  
2019 2019  **Примеры использования:**
2020 2020  
... ... @@ -2354,116 +2354,4 @@
2354 2354  }
2355 2355  {{/code}}
2356 2356  
2357 -
2358 -(% class="box infomessage" %)
2359 -(((
2360 -**{{id name="_Toc26"/}}getCollisionsForReport()** - функция получения списка коллизий для отчета.
2361 -)))
2362 -
2363 -* **bim.getCollisionsForReport()**
2364 -[[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]] - список коллизий. Обязательное поле. Получить данный лист необходимо
2365 -
2366 -**Пример использования:**
2367 -
2368 -{{code language="java"}}
2369 -def collisionList = bim.getCollisionsForReport()
2370 - def param = [:]
2371 - param.add("pageSize", 3)
2372 - param.add("fontSize", 12)
2373 - file.collisionsToPdf(template, collisionList, param)
2374 -
2375 -{{/code}}
2376 -
2377 -
2378 -(% class="box infomessage" %)
2379 -(((
2380 -**{{id name="_Toc27"/}}getFilesDownloadLinks** - получение списка ссылок на скачивание файлов, которые вложены в задачи проекта
2381 -)))
2382 -
2383 -* **bim.getFilesDownloadLinks() - **Данный метод предназначен для получения списка ссылок на скачивания файлов из задач по проекту.
2384 -Ссылка действительна в течении одного дня. Изменить данное время можно командой editTokenExpiredDate (см. ниже). Данный метод рекомендуется использовать при формировании отчетов.
2385 -**Пример использования:**
2386 -
2387 -{{code language="java"}}
2388 -def tasks = bim.getProjectTasks()
2389 - def taskAttachments = []
2390 - for(def task : tasks) {
2391 - taskAttachments.push(bim.getTaskAttachments(task.uuid))
2392 - }
2393 -
2394 - def uuids = []
2395 - for (def attachments : taskAttachments) {
2396 - for (def attachment : attachments) {
2397 - if (attachment != null)
2398 - uuids.push(attachment.uuid)
2399 - }
2400 - }
2401 - def downloadLinks = bim.getFilesDownloadLinks(uuids)
2402 - console.info(downloadLinks) -> INFO [
2403 -6201ced9-b873-4a7d-8266-537f1566c543.docx,
2404 -687ac450-75e2-42f6-9fbe-7c608912c079.png
2405 -]
2406 -{{/code}}
2407 -
2408 -(% class="box infomessage" %)
2409 -(((
2410 -**{{id name="_Toc28"/}}editTokenExpiredDate** - позволяет изменить количество дней, через сколько токен для скачивания файлов станет недействительным
2411 -)))
2412 -
2413 -* **bim.editTokenExpiredDate()**
2414 -**Пример использования:**
2415 -
2416 -{{code language="java"}}
2417 -UUID uuid = UUID.fromString("94e8e236-510b-4325-8b3a-15e317924bb2")
2418 - bim.editTokenExpiredDate (uuid, 2)
2419 -
2420 -{{/code}}
2421 -
2422 -(% class="box infomessage" %)
2423 -(((
2424 -**{{id name="_Toc29"/}}getTaskForm** - получение списка данных формы задачи по идентификатору задачи
2425 -)))
2426 -
2427 -* **bim.getTaskForm(UUID taskUuid) **
2428 -
2429 -**Пример использования:**
2430 -
2431 -{{code language="java"}}{{/code}}
2432 -
2433 -
2434 -
2435 -СПРАВОЧНИКИ
2436 -
2437 -
2438 -**{{id name="_Toc23"/}}Операторы сравнения**
2439 -
2440 -(% cellspacing="0" style="border-collapse:collapse; border:none; width:850px" %)
2441 -|(% 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" %)Равно
2442 -|(% 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" %)Не равно
2443 -|(% 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" %)Содержит
2444 -|(% 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" %)Не содержит
2445 -|(% 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" %)Больше
2446 -|(% 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" %)Больше или равно
2447 -|(% 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" %)Меньше
2448 -|(% 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" %)Меньше или равно
2449 -|(% 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
2450 -|(% 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
2451 -
2452 -**{{id name="_Toc24"/}}Параметры поиска**
2453 -
2454 -(% cellspacing="0" style="border-collapse:collapse; border:none; width:850px" %)
2455 -|(% 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" %)поиск по названию модели в структуре проекта
2456 -|(% 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" %)поиск по названию этажа
2457 -|(% 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 тип)
2458 -|(% 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" %)поиск по названию зоны, объединяющей элементы
2459 -|(% 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" %)поиск по названию слоя объединяющего элементы
2460 -|(% 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" %)поиск по значению атрибута
2461 -|(% 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”)
2462 -
2463 -**{{id name="_Toc25"/}}Статусы коллизий**
2464 -
2465 -(% cellspacing="0" style="border-collapse:collapse; border:none; width:850px" %)
2466 -|(% 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" %)запрос коллизий в статусе новые
2467 -|(% 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" %)коллизии в работе
2468 -|(% 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" %)решенные коллизии
2469 -|(% 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" %)допустимые коллизии
2294 +